[xiph-cvs] cvs commit: vorbis-tools/oggenc/man oggenc.1

Jack Moffitt jack at xiph.org
Sun Sep 10 23:21:17 PDT 2000



jack        00/09/10 23:21:17

  Added:       .        Makefile.am autogen.sh configure.in
               oggenc   Makefile.am
               oggenc/man oggenc.1
  Removed:     oggenc   oggenc.1
  Log:
  cleaned up a bit, started on teh build system

Revision  Changes    Path
1.1                  vorbis-tools/Makefile.am

Index: Makefile.am
===================================================================
## Process this file with automake to produce Makefile.in

AUTOMAKE_OPTIONS = foreign dist-zip

SUBDIRS = oggenc

EXTRA_DIST = README

debug:
        $(MAKE) all CFLAGS="@DEBUG@"

profile:
        $(MAKE) all CFLAGS="@PROFILE@"

1.1                  vorbis-tools/autogen.sh

Index: autogen.sh
===================================================================
#!/bin/sh
# Run this to generate all the initial makefiles, etc.
# (basically ripped directly from enlightenment's autogen.sh)

rcdir=`dirname $0`
test -z "$srcdir" && srcdir=.

cd "$srcdir"
DIE=0

(autoconf --version) < /dev/null > /dev/null 2>&1 || {
        echo
        echo "You must have autoconf installed to compile vorbis-tools."
        echo "Download the appropriate package for your distribution,"
        echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/"
        DIE=1
}

(automake --version) < /dev/null > /dev/null 2>&1 || {
        echo
        echo "You must have automake installed to compile vorbis-tools."
        echo "Get ftp://ftp.gnu.org/pub/gnu/automake-1.3.tar.gz"
        echo "(or a newer version if it is available)"
        DIE=1
}

if test "$DIE" -eq 1; then
        exit 1
fi

if test -z "$*"; then
        echo "I am going to run ./configure with no arguments - if you wish "
        echo "to pass any to it, please specify them on the $0 command line."
fi

echo "Generating configuration files for vorbis-tools, please wait...."

echo "  aclocal $ACLOCAL_FLAGS"
aclocal $ACLOCAL_FLAGS
echo "  autoheader"
autoheader
echo "  automake --add-missing"
automake --add-missing 
echo "  autoconf"
autoconf

$srcdir/configure "$@" && echo

1.1                  vorbis-tools/configure.in

Index: configure.in
===================================================================
dnl Process this file with autoconf to produce a configure script

dnl ------------------------------------------------
dnl Initialization
dnl ------------------------------------------------

AC_INIT(oggenc/encode.c)
AM_INIT_AUTOMAKE(vorbis-tools,1.0.0)

dnl --------------------------------------------------  
dnl Check for programs
dnl --------------------------------------------------  

dnl save $CFLAGS since AC_PROG_CC likes to insert "-g -O2"
dnl if $CFLAGS is blank
cflags_save="$CFLAGS"
AC_PROG_CC
CFLAGS="$cflags_save"

AM_PROG_LIBTOOL

dnl --------------------------------------------------  
dnl Additional arguments
dnl --------------------------------------------------  

AC_ARG_WITH(ogg, [  --with-ogg=DIR          Set where the Ogg library is located]) 
AC_ARG_WITH(vorbis, [  --with-vorbis=DIR          Set where the Vorbis library is located]) 

dnl --------------------------------------------------
dnl Set build flags based on environment
dnl --------------------------------------------------

AC_CANONICAL_HOST

dnl --------------------------------------------------
dnl Check for headers
dnl --------------------------------------------------

dnl none

dnl --------------------------------------------------
dnl Check for typedefs, structures, etc
dnl --------------------------------------------------

dnl none

dnl --------------------------------------------------
dnl Check for libraries
dnl --------------------------------------------------

dnl Check for libogg
if test -n $with_ogg; then
        CFLAGS="$CFLAGS -I$with_ogg/include -L$with_ogg/lib"
fi 
AC_CHECK_LIB(ogg, oggpack_read, LIBS="$LIBS -logg", AC_MSG_ERROR([You must have libogg to compile vorbis!!!]))

dnl Check for libvorbis
if test -n $with_vorbis; then
        CFLAGS="$CFLAGS -I$with_vorbis/include -L$with_vorbis/lib"
fi
AC_CHECK_LIB(vorbis, vorbis_info_init, LIBS="$LIBS -lvorbis", AC_MSG_ERROR([You must have libvorbis to compile vorbis-tools!!!]))

dnl --------------------------------------------------
dnl Check for library functions
dnl --------------------------------------------------

dnl none

dnl --------------------------------------------------
dnl Do substitutions
dnl --------------------------------------------------

AC_SUBST(LIBS)
AC_SUBST(DEBUG)
AC_SUBST(PROFILE)
AC_SUBST(CC)

AC_OUTPUT(Makefile oggenc/Makefile)

1.1                  vorbis-tools/oggenc/Makefile.am

Index: Makefile.am
===================================================================
## Process this file with automake to produce Makefile.in

AUTOMAKE_OPTIONS = foreign

bin_PROGRAMS = oggenc

oggenc_SOURCES = oggenc.c audio.c encode.c oe_unix.c\
                audio.h encode.h platform.h @GETOPT@

debug:
        $(MAKE) all CFLAGS="@DEBUG@"

profile:
        $(MAKE) all CFLAGS="@PROFILE@"

1.1                  vorbis-tools/oggenc/man/oggenc.1

Index: oggenc.1
===================================================================
.\" Process this file with
.\" groff -man -Tascii oggenc.1
.\"
.TH oggenc 1 "August 13, 2000" "" "Vorbis Tools"

.SH NAME
oggenc \- encode audio into the Ogg Vorbis format

.SH SYNOPSIS
.B oggenc
[
.B -hrq
]
[
.B -m
.I mode 
]
[
.B -o
.I output_file
]
[
.B -n
.I pattern
]
[
.B -c
.I extra_comment
]
[
.B -a
.I artist
]
[
.B -t
.I title
]
[
.B -l
.I album
]
.I input_files \fR...

.SH DESCRIPTION
.B oggenc
reads audio data in either raw or WAV format and encodes it into an
Ogg Vorbis stream.  If the input file "-" is specified, audio data is
read from
.I stdin
and the Vorbis stream is written to
.I stdout
unless the 
.B -o
option is used to redirect the output.  By default, disk files are
output to Ogg Vorbis files of the same name, with the extension
changed to ".ogg".  This naming convention can be overridden by the
.B -o
option (in the case of one file) or the
.B -n
option (in the case of several files).

.SH OPTIONS
.IP "-h, --help"
Show command help.
.IP "-r, --raw"
Assume input data is raw 44.1 kHz, 16 bit, little-endian audio data with no
header information.
.IP "-q, --quiet"
Quiet mode.  No messages are displayed.
.IP "-m n, --mode=n"
Sets encoding mode to n (n should be between 1 and 6, higher numbers give higher bitrates)
.IP "-o output_file, --output=output_file"
Write the Ogg Vorbis stream to
.I output_file (only valid if a single input file is specified)

.IP "-n pattern, --names=pattern"
Produce filenames as this string, with %a, %t, %l replaced by artist,
title, album respectively (see below for specifying these). Also, %%
gives a literal %.

.IP "-c comment, --comment comment"
Add the string 
.I comment
as an extra comment.  This may be used multiple times, and all 
instances will be added to each of the input files specified.

.IP "-a artist, --artist artist"
Set the artist comment field in the comments to
.I artist.

.IP "-t title, --title title"
Set the track title comment field to
.I title.

.IP "-l album, --album album"
Set the album comment field to
.I album.
.PP

Note that the \fB-a\fR, \fB-t\fR, and \fB-l\fR options can be given
multiple times.  They will be applied, one to each file, in the order
given.  If there are fewer album, title, or artist comments given than
there are input files,
.B oggenc
will reuse the final one for the remaining files, and issue a warning
in the case of repeated titles.

.SH EXAMPLES

Simplest version. Produces output as somefile.ogg:
.RS
oggenc somefile.wav
.RE
.PP

Specifying an output filename:
.RS
oggenc somefile.wav -o out.ogg
.RE
.PP

Specifying a high-quality mode (approx 256 kbps):
.RS
oggenc infile.wav -m 5 out.ogg
.RE
.PP

Adding some info about the track:
.RS
oggenc somefile.wav -t "The track title" -a "artist who performed this" -l
"name of album" -c 
"OTHERFIELD=contents of some other field not explictly supported"
.RE
.PP

This encodes the three files, each with the
same artist/album tag, but with different title tags on each one. The
string given as an argument to -n is used to generate filenames, as shown
in the section above. This example gives filenames 
like "The Tea Party - Touch.ogg":
.RS
oggenc -m 4 -a "The Tea Party" -l "Triptych" -t "Touch" track01.wav -t
"Underground" track02.wav -t "Great Big Lie" track03.wav -n "%a - %t.ogg"
.RE
.PP

Encoding from stdin, to stdout (you can also use the various tagging
options, like -t, -a, -l, etc.):
.RS
oggenc -
.RE
.PP

.SH AUTHORS

.TP
Program Author:
.br
Michael Smith <msmith at labyrinth.net.au>

.TP
Manpage Author:
.br
Stan Seibert <indigo at aztec.asu.edu>

.SH SEE ALSO

.BR ogg123 (1)

--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.



More information about the commits mailing list