media/libvorbis/README@b8a032363ba2 (annotated)
media/libvorbis/README
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| 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-2007 * |
| michael@0 | 9 | * by the Xiph.org Foundation, http://www.xiph.org/ * |
| michael@0 | 10 | * * |
| michael@0 | 11 | ******************************************************************** |
| michael@0 | 12 | |
| michael@0 | 13 | Vorbis is a general purpose audio and music encoding format |
| michael@0 | 14 | contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond |
| michael@0 | 15 | MPEG audio layer 3. Unlike the MPEG sponsored formats (and other |
| michael@0 | 16 | proprietary formats such as RealAudio G2 and Windows' flavor of the |
| michael@0 | 17 | month), the Vorbis CODEC specification belongs to the public domain. |
| michael@0 | 18 | All the technical details are published and documented, and any |
| michael@0 | 19 | software entity may make full use of the format without license |
| michael@0 | 20 | fee, royalty or patent concerns. |
| michael@0 | 21 | |
| michael@0 | 22 | This package contains: |
| michael@0 | 23 | |
| michael@0 | 24 | * libvorbis, a BSD-style license software implementation of |
| michael@0 | 25 | the Vorbis specification by the Xiph.Org Foundation |
| michael@0 | 26 | (http://www.xiph.org/) |
| michael@0 | 27 | |
| michael@0 | 28 | * libvorbisfile, a BSD-style license convenience library |
| michael@0 | 29 | built on Vorbis designed to simplify common uses |
| michael@0 | 30 | |
| michael@0 | 31 | * libvorbisenc, a BSD-style license library that provides a simple, |
| michael@0 | 32 | programmatic encoding setup interface |
| michael@0 | 33 | |
| michael@0 | 34 | * example code making use of libogg, libvorbis, libvorbisfile and |
| michael@0 | 35 | libvorbisenc |
| michael@0 | 36 | |
| michael@0 | 37 | WHAT'S HERE: |
| michael@0 | 38 | |
| michael@0 | 39 | This source distribution includes libvorbis and an example |
| michael@0 | 40 | encoder/player to demonstrate use of libvorbis as well as |
| michael@0 | 41 | documentation on the Ogg Vorbis audio coding format. |
| michael@0 | 42 | |
| michael@0 | 43 | You'll need libogg (distributed separately) to compile this library. |
| michael@0 | 44 | A more comprehensive set of utilities is available in the vorbis-tools |
| michael@0 | 45 | package. |
| michael@0 | 46 | |
| michael@0 | 47 | Directory: |
| michael@0 | 48 | |
| michael@0 | 49 | ./lib The source for the libraries, a BSD-license implementation |
| michael@0 | 50 | of the public domain Ogg Vorbis audio encoding format. |
| michael@0 | 51 | |
| michael@0 | 52 | ./include Library API headers |
| michael@0 | 53 | |
| michael@0 | 54 | ./debian Rules/spec files for building Debian .deb packages |
| michael@0 | 55 | |
| michael@0 | 56 | ./doc Vorbis documentation |
| michael@0 | 57 | |
| michael@0 | 58 | ./examples Example code illustrating programmatic use of libvorbis, |
| michael@0 | 59 | libvorbisfile and libvorbisenc |
| michael@0 | 60 | |
| michael@0 | 61 | ./mac Codewarrior project files and build tweaks for MacOS. |
| michael@0 | 62 | |
| michael@0 | 63 | ./macosx Project files for MacOS X. |
| michael@0 | 64 | |
| michael@0 | 65 | ./win32 Win32 projects files and build automation |
| michael@0 | 66 | |
| michael@0 | 67 | ./vq Internal utilities for training/building new LSP/residue |
| michael@0 | 68 | and auxiliary codebooks. |
| michael@0 | 69 | |
| michael@0 | 70 | CONTACT: |
| michael@0 | 71 | |
| michael@0 | 72 | The Ogg homepage is located at 'http://www.xiph.org/ogg/'. |
| michael@0 | 73 | Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'. |
| michael@0 | 74 | Up to date technical documents, contact information, source code and |
| michael@0 | 75 | pre-built utilities may be found there. |
| michael@0 | 76 | |
| michael@0 | 77 | The user website for Ogg Vorbis software and audio is http://vorbis.com/ |
| michael@0 | 78 | |
| michael@0 | 79 | BUILDING FROM TRUNK: |
| michael@0 | 80 | |
| michael@0 | 81 | Development source is under subversion revision control at |
| michael@0 | 82 | https://svn.xiph.org/trunk/vorbis/. You will also need the |
| michael@0 | 83 | newest versions of autoconf, automake, libtool and pkg-config in |
| michael@0 | 84 | order to compile Vorbis from development source. A configure script |
| michael@0 | 85 | is provided for you in the source tarball distributions. |
| michael@0 | 86 | |
| michael@0 | 87 | [update or checkout latest source] |
| michael@0 | 88 | ./autogen.sh |
| michael@0 | 89 | make |
| michael@0 | 90 | |
| michael@0 | 91 | and as root if desired: |
| michael@0 | 92 | |
| michael@0 | 93 | make install |
| michael@0 | 94 | |
| michael@0 | 95 | This will install the Vorbis libraries (static and shared) into |
| michael@0 | 96 | /usr/local/lib, includes into /usr/local/include and API manpages |
| michael@0 | 97 | (once we write some) into /usr/local/man. |
| michael@0 | 98 | |
| michael@0 | 99 | Documentation building requires xsltproc and pdfxmltex. |
| michael@0 | 100 | |
| michael@0 | 101 | BUILDING FROM TARBALL DISTRIBUTIONS: |
| michael@0 | 102 | |
| michael@0 | 103 | ./configure |
| michael@0 | 104 | make |
| michael@0 | 105 | |
| michael@0 | 106 | and optionally (as root): |
| michael@0 | 107 | make install |
| michael@0 | 108 | |
| michael@0 | 109 | BUILDING RPMS: |
| michael@0 | 110 | |
| michael@0 | 111 | after normal configuring: |
| michael@0 | 112 | |
| michael@0 | 113 | make dist |
| michael@0 | 114 | rpm -ta libvorbis-<version>.tar.gz |
| michael@0 | 115 | |
| michael@0 | 116 | BUILDING ON MACOS 9: |
| michael@0 | 117 | |
| michael@0 | 118 | Vorbis on MacOS 9 is built using Metroworks CodeWarrior. To build it, |
| michael@0 | 119 | first verify that the Ogg libraries are already built following the |
| michael@0 | 120 | instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp, |
| michael@0 | 121 | switch to the "Targets" pane, select everything, and make the project. |
| michael@0 | 122 | Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in |
| michael@0 | 123 | that order). In vorbis/mac/Output you will now have both debug and final |
| michael@0 | 124 | versions of Vorbis shared libraries to link your projects against. |
| michael@0 | 125 | |
| michael@0 | 126 | To build a project using Ogg Vorbis, add access paths to your |
| michael@0 | 127 | CodeWarrior project for the ogg/include, ogg/mac/Output, |
| michael@0 | 128 | vorbis/include, and vorbis/mac/Output folders. Be sure that |
| michael@0 | 129 | "interpret DOS and Unix paths" is turned on in your project; it can |
| michael@0 | 130 | be found in the "access paths" pane in your project settings. Now |
| michael@0 | 131 | simply add the shared libraries you need to your project (OggLib and |
| michael@0 | 132 | VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h" |
| michael@0 | 133 | wherever you need to access Ogg and Vorbis functionality. |
| michael@0 | 134 |
