media/libogg/README@925c144e1f1f (annotated)
media/libogg/README
Fri, 16 Jan 2015 18:13:44 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 16 Jan 2015 18:13:44 +0100
- branch
- TOR_BUG_9701
- changeset 14
- 925c144e1f1f
- permissions
- -rw-r--r--
Integrate suggestion from review to improve consistency with existing code.
| michael@0 | 1 | ******************************************************************** |
| michael@0 | 2 | * * |
| michael@0 | 3 | * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. * |
| michael@0 | 4 | * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS * |
| michael@0 | 5 | * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE * |
| michael@0 | 6 | * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. * |
| michael@0 | 7 | * * |
| michael@0 | 8 | * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2011 * |
| michael@0 | 9 | * by the Xiph.Org Foundation http://www.xiph.org/ * |
| michael@0 | 10 | * * |
| michael@0 | 11 | ******************************************************************** |
| michael@0 | 12 | |
| michael@0 | 13 | = WHAT'S HERE = |
| michael@0 | 14 | |
| michael@0 | 15 | This source distribution includes libogg and nothing else. Other modules |
| michael@0 | 16 | (eg, the modules libvorbis, vorbis-tools for the Vorbis music codec, |
| michael@0 | 17 | libtheora for the Theora video codec) contain the codec libraries for |
| michael@0 | 18 | use with Ogg bitstreams. |
| michael@0 | 19 | |
| michael@0 | 20 | Directory: |
| michael@0 | 21 | |
| michael@0 | 22 | ./src The source for libogg, a BSD-license inplementation of |
| michael@0 | 23 | the public domain Ogg bitstream format |
| michael@0 | 24 | |
| michael@0 | 25 | ./include Library API headers |
| michael@0 | 26 | |
| michael@0 | 27 | ./doc Ogg specification and libogg API documents |
| michael@0 | 28 | |
| michael@0 | 29 | ./win32 Win32 projects and build automation |
| michael@0 | 30 | |
| michael@0 | 31 | ./macosx Mac OS X project and build files |
| michael@0 | 32 | |
| michael@0 | 33 | = WHAT IS OGG? = |
| michael@0 | 34 | |
| michael@0 | 35 | Ogg project codecs use the Ogg bitstream format to arrange the raw, |
| michael@0 | 36 | compressed bitstream into a more robust, useful form. For example, |
| michael@0 | 37 | the Ogg bitstream makes seeking, time stamping and error recovery |
| michael@0 | 38 | possible, as well as mixing several sepearate, concurrent media |
| michael@0 | 39 | streams into a single physical bitstream. |
| michael@0 | 40 | |
| michael@0 | 41 | = CONTACT = |
| michael@0 | 42 | |
| michael@0 | 43 | The Ogg homepage is located at 'https://www.xiph.org/ogg/'. |
| michael@0 | 44 | Up to date technical documents, contact information, source code and |
| michael@0 | 45 | pre-built utilities may be found there. |
| michael@0 | 46 | |
| michael@0 | 47 | BUILDING FROM TARBALL DISTRIBUTIONS: |
| michael@0 | 48 | |
| michael@0 | 49 | ./configure |
| michael@0 | 50 | make |
| michael@0 | 51 | |
| michael@0 | 52 | and optionally (as root): |
| michael@0 | 53 | make install |
| michael@0 | 54 | |
| michael@0 | 55 | This will install the Ogg libraries (static and shared) into |
| michael@0 | 56 | /usr/local/lib, includes into /usr/local/include and API |
| michael@0 | 57 | documentation into /usr/local/share/doc. |
| michael@0 | 58 | |
| michael@0 | 59 | BUILDING FROM REPOSITORY SOURCE: |
| michael@0 | 60 | |
| michael@0 | 61 | A standard svn build should consist of nothing more than: |
| michael@0 | 62 | |
| michael@0 | 63 | ./autogen.sh |
| michael@0 | 64 | make |
| michael@0 | 65 | |
| michael@0 | 66 | and as root if desired : |
| michael@0 | 67 | |
| michael@0 | 68 | make install |
| michael@0 | 69 | |
| michael@0 | 70 | BUILDING ON WIN32: |
| michael@0 | 71 | |
| michael@0 | 72 | Use the project file in the win32 directory. It should compile out of the box. |
| michael@0 | 73 | |
| michael@0 | 74 | CROSS COMPILING FROM LINUX TO WIN32: |
| michael@0 | 75 | |
| michael@0 | 76 | It is also possible to cross compile from Linux to windows using the MinGW |
| michael@0 | 77 | cross tools and even to run the test suite under Wine, the Linux/*nix |
| michael@0 | 78 | windows emulator. |
| michael@0 | 79 | |
| michael@0 | 80 | On Debian and Ubuntu systems, these cross compiler tools can be installed |
| michael@0 | 81 | by doing: |
| michael@0 | 82 | |
| michael@0 | 83 | sudo apt-get mingw32 mingw32-binutils mingw32-runtime wine |
| michael@0 | 84 | |
| michael@0 | 85 | Once these tools are installed its possible to compile and test by |
| michael@0 | 86 | executing the following commands, or something similar depending on |
| michael@0 | 87 | your system: |
| michael@0 | 88 | |
| michael@0 | 89 | ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc \ |
| michael@0 | 90 | --build=i586-linux |
| michael@0 | 91 | make |
| michael@0 | 92 | make check |
| michael@0 | 93 | |
| michael@0 | 94 | (Build instructions for Ogg codecs such as vorbis are similar and may |
| michael@0 | 95 | be found in those source modules' README files) |
| michael@0 | 96 | |
| michael@0 | 97 | $Id: README 18096 2011-09-22 23:32:51Z giles $ |
