README 2.8 KB
Newer Older
Jack Moffitt's avatar
Jack Moffitt committed
1
WHAT'S HERE:
Jack Moffitt's avatar
Jack Moffitt committed
2

3 4 5
This source distribution includes the vorbis-tools and nothing else.
The audio codec libraries for use with Ogg bitstreams are contained in
other modules: vorbis, speex and flac.
Jack Moffitt's avatar
Jack Moffitt committed
6

7

8 9 10 11 12
DIRECTORIES:

debian/		debian packaging stuff
include/	header files shared between the tools
intl/		GNU gettext library from gettext-0.10.40 (for i18n support)
13
ogg123/		an ogg vorbis command line audio player
14
oggenc/		the ogg vorbis encoder
Stan Seibert's avatar
Stan Seibert committed
15
oggdec/		a simple, portable command line decoder (to wav and raw)
16
ogginfo/	provides information (tags, bitrate, length, etc.) about
17 18 19 20 21 22 23
		an ogg vorbis file
po/		translations for non-English languages
share/		code shared between the tools
vcut/		cuts an ogg vorbis file into two parts at a particular point
vorbiscomment/	edits the comments in an ogg vorbis file
win32/		Win32 build stuff

24

25 26 27
DEPENDENCIES:

All of the tools require libogg and libvorbis to be installed (along
Stan Seibert's avatar
Stan Seibert committed
28
with the header files).  Additionally, ogg123 requires libao, libcurl,
29
and a POSIX-compatible thread library.  Ogg123 can optionally compiled
30 31 32
to use libFLAC, and libspeex.  Oggenc can be optionally compiled with
libFLAC, and libkate.  The libraries libogg, libvorbis, and libao are
all available at
33 34 35 36 37
  http://www.vorbis.com/download.psp

The libcurl library is packaged with most Linux distributions.  The
source code can also be downloaded from:
  http://curl.haxx.se/libcurl/
Jack Moffitt's avatar
Jack Moffitt committed
38

39 40 41 42 43 44
FLAC is available at:
  http://flac.sourceforge.net

Speex is available at:
  http://www.speex.org/

45 46 47
libkate is available at:
  http://libkate.googlecode.com/

48

Jack Moffitt's avatar
Jack Moffitt committed
49
CONTACT:
Jack Moffitt's avatar
Jack Moffitt committed
50

Stan Seibert's avatar
Stan Seibert committed
51 52
The Ogg Vorbis homepage is located at 'http://www.vorbis.com'. Up to
date technical documents, contact information, source code and
Jack Moffitt's avatar
Jack Moffitt committed
53
pre-built utilities may be found there.
Jack Moffitt's avatar
Jack Moffitt committed
54

55 56 57
Developer information is available from http://www.xiph.org/. Check
there for bug reporting information, mailing lists and other resources.

58

59
BUILDING FROM SUBVERSION (see the file HACKING for details):
Jack Moffitt's avatar
Jack Moffitt committed
60

Jack Moffitt's avatar
Jack Moffitt committed
61 62
./autogen.sh
make 
Jack Moffitt's avatar
Jack Moffitt committed
63

Jack Moffitt's avatar
Jack Moffitt committed
64
and as root if desired :
Jack Moffitt's avatar
Jack Moffitt committed
65

Jack Moffitt's avatar
Jack Moffitt committed
66
make install
Jack Moffitt's avatar
Jack Moffitt committed
67

68 69
This will install the tools into /usr/local/bin and manpages into
/usr/local/man.
Jack Moffitt's avatar
Jack Moffitt committed
70

71

Jack Moffitt's avatar
Jack Moffitt committed
72 73 74 75 76 77 78 79 80
BUILDING FROM TARBALL DISTRIBUTIONS:

./configure
make

and as root if desired :

make install

Jack Moffitt's avatar
Jack Moffitt committed
81
BUILDING RPMS:
Jack Moffitt's avatar
Jack Moffitt committed
82

Jack Moffitt's avatar
Jack Moffitt committed
83
RPMs may be built by:
Jack Moffitt's avatar
Jack Moffitt committed
84

Jack Moffitt's avatar
Jack Moffitt committed
85 86
after autogen.sh or configure

Jack Moffitt's avatar
Jack Moffitt committed
87 88
make dist
rpm -ta vorbis-tools-<version>.tar.gz
89 90 91 92 93 94 95 96 97 98 99 100 101 102


KNOWN BUGS:

#1321
  First noticed in non-English versions of the application, ogg123 has a major
  bug when it comes to status messages in the shell: any output bigger than
  the console's width will break and start spamming that message infinitely
  until the console is resized.

  Different attempts to fix this bug have ended up causing bigger problems,
  leading to the conclusion that it simply can't be fixed without a large
  re-write of the application, which will not happen any time soon.  If you
  come across this issue, please augment your terminal window size.