1 ********************************************************************
3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2011 *
9 * by the Xiph.Org Foundation http://www.xiph.org/ *
11 ********************************************************************
15 This source distribution includes libogg and nothing else. Other modules
16 (eg, the modules libvorbis, vorbis-tools for the Vorbis music codec,
17 libtheora for the Theora video codec) contain the codec libraries for
18 use with Ogg bitstreams.
22 ./src The source for libogg, a BSD-license inplementation of
23 the public domain Ogg bitstream format
25 ./include Library API headers
27 ./doc Ogg specification and libogg API documents
29 ./win32 Win32 projects and build automation
31 ./macosx Mac OS X project and build files
35 Ogg project codecs use the Ogg bitstream format to arrange the raw,
36 compressed bitstream into a more robust, useful form. For example,
37 the Ogg bitstream makes seeking, time stamping and error recovery
38 possible, as well as mixing several sepearate, concurrent media
39 streams into a single physical bitstream.
43 The Ogg homepage is located at 'https://www.xiph.org/ogg/'.
44 Up to date technical documents, contact information, source code and
45 pre-built utilities may be found there.
47 BUILDING FROM TARBALL DISTRIBUTIONS:
52 and optionally (as root):
55 This will install the Ogg libraries (static and shared) into
56 /usr/local/lib, includes into /usr/local/include and API
57 documentation into /usr/local/share/doc.
59 BUILDING FROM REPOSITORY SOURCE:
61 A standard svn build should consist of nothing more than:
66 and as root if desired :
72 Use the project file in the win32 directory. It should compile out of the box.
74 CROSS COMPILING FROM LINUX TO WIN32:
76 It is also possible to cross compile from Linux to windows using the MinGW
77 cross tools and even to run the test suite under Wine, the Linux/*nix
80 On Debian and Ubuntu systems, these cross compiler tools can be installed
83 sudo apt-get mingw32 mingw32-binutils mingw32-runtime wine
85 Once these tools are installed its possible to compile and test by
86 executing the following commands, or something similar depending on
89 ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc \
94 (Build instructions for Ogg codecs such as vorbis are similar and may
95 be found in those source modules' README files)
97 $Id: README 18096 2011-09-22 23:32:51Z giles $