1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/media/libvorbis/README Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,134 @@
1.4 +********************************************************************
1.5 +* *
1.6 +* THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
1.7 +* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
1.8 +* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
1.9 +* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
1.10 +* *
1.11 +* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
1.12 +* by the Xiph.org Foundation, http://www.xiph.org/ *
1.13 +* *
1.14 +********************************************************************
1.15 +
1.16 +Vorbis is a general purpose audio and music encoding format
1.17 +contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
1.18 +MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
1.19 +proprietary formats such as RealAudio G2 and Windows' flavor of the
1.20 +month), the Vorbis CODEC specification belongs to the public domain.
1.21 +All the technical details are published and documented, and any
1.22 +software entity may make full use of the format without license
1.23 +fee, royalty or patent concerns.
1.24 +
1.25 +This package contains:
1.26 +
1.27 +* libvorbis, a BSD-style license software implementation of
1.28 + the Vorbis specification by the Xiph.Org Foundation
1.29 + (http://www.xiph.org/)
1.30 +
1.31 +* libvorbisfile, a BSD-style license convenience library
1.32 + built on Vorbis designed to simplify common uses
1.33 +
1.34 +* libvorbisenc, a BSD-style license library that provides a simple,
1.35 + programmatic encoding setup interface
1.36 +
1.37 +* example code making use of libogg, libvorbis, libvorbisfile and
1.38 + libvorbisenc
1.39 +
1.40 +WHAT'S HERE:
1.41 +
1.42 +This source distribution includes libvorbis and an example
1.43 +encoder/player to demonstrate use of libvorbis as well as
1.44 +documentation on the Ogg Vorbis audio coding format.
1.45 +
1.46 +You'll need libogg (distributed separately) to compile this library.
1.47 +A more comprehensive set of utilities is available in the vorbis-tools
1.48 +package.
1.49 +
1.50 +Directory:
1.51 +
1.52 +./lib The source for the libraries, a BSD-license implementation
1.53 + of the public domain Ogg Vorbis audio encoding format.
1.54 +
1.55 +./include Library API headers
1.56 +
1.57 +./debian Rules/spec files for building Debian .deb packages
1.58 +
1.59 +./doc Vorbis documentation
1.60 +
1.61 +./examples Example code illustrating programmatic use of libvorbis,
1.62 + libvorbisfile and libvorbisenc
1.63 +
1.64 +./mac Codewarrior project files and build tweaks for MacOS.
1.65 +
1.66 +./macosx Project files for MacOS X.
1.67 +
1.68 +./win32 Win32 projects files and build automation
1.69 +
1.70 +./vq Internal utilities for training/building new LSP/residue
1.71 + and auxiliary codebooks.
1.72 +
1.73 +CONTACT:
1.74 +
1.75 +The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
1.76 +Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'.
1.77 +Up to date technical documents, contact information, source code and
1.78 +pre-built utilities may be found there.
1.79 +
1.80 +The user website for Ogg Vorbis software and audio is http://vorbis.com/
1.81 +
1.82 +BUILDING FROM TRUNK:
1.83 +
1.84 +Development source is under subversion revision control at
1.85 +https://svn.xiph.org/trunk/vorbis/. You will also need the
1.86 +newest versions of autoconf, automake, libtool and pkg-config in
1.87 +order to compile Vorbis from development source. A configure script
1.88 +is provided for you in the source tarball distributions.
1.89 +
1.90 + [update or checkout latest source]
1.91 + ./autogen.sh
1.92 + make
1.93 +
1.94 +and as root if desired:
1.95 +
1.96 + make install
1.97 +
1.98 +This will install the Vorbis libraries (static and shared) into
1.99 +/usr/local/lib, includes into /usr/local/include and API manpages
1.100 +(once we write some) into /usr/local/man.
1.101 +
1.102 +Documentation building requires xsltproc and pdfxmltex.
1.103 +
1.104 +BUILDING FROM TARBALL DISTRIBUTIONS:
1.105 +
1.106 + ./configure
1.107 + make
1.108 +
1.109 +and optionally (as root):
1.110 + make install
1.111 +
1.112 +BUILDING RPMS:
1.113 +
1.114 +after normal configuring:
1.115 +
1.116 + make dist
1.117 + rpm -ta libvorbis-<version>.tar.gz
1.118 +
1.119 +BUILDING ON MACOS 9:
1.120 +
1.121 +Vorbis on MacOS 9 is built using Metroworks CodeWarrior. To build it,
1.122 +first verify that the Ogg libraries are already built following the
1.123 +instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp,
1.124 +switch to the "Targets" pane, select everything, and make the project.
1.125 +Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
1.126 +that order). In vorbis/mac/Output you will now have both debug and final
1.127 +versions of Vorbis shared libraries to link your projects against.
1.128 +
1.129 +To build a project using Ogg Vorbis, add access paths to your
1.130 +CodeWarrior project for the ogg/include, ogg/mac/Output,
1.131 +vorbis/include, and vorbis/mac/Output folders. Be sure that
1.132 +"interpret DOS and Unix paths" is turned on in your project; it can
1.133 +be found in the "access paths" pane in your project settings. Now
1.134 +simply add the shared libraries you need to your project (OggLib and
1.135 +VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
1.136 +wherever you need to access Ogg and Vorbis functionality.
1.137 +
