michael@0: ******************************************************************** michael@0: * * michael@0: * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. * michael@0: * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS * michael@0: * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE * michael@0: * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. * michael@0: * * michael@0: * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 * michael@0: * by the Xiph.org Foundation, http://www.xiph.org/ * michael@0: * * michael@0: ******************************************************************** michael@0: michael@0: Vorbis is a general purpose audio and music encoding format michael@0: contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond michael@0: MPEG audio layer 3. Unlike the MPEG sponsored formats (and other michael@0: proprietary formats such as RealAudio G2 and Windows' flavor of the michael@0: month), the Vorbis CODEC specification belongs to the public domain. michael@0: All the technical details are published and documented, and any michael@0: software entity may make full use of the format without license michael@0: fee, royalty or patent concerns. michael@0: michael@0: This package contains: michael@0: michael@0: * libvorbis, a BSD-style license software implementation of michael@0: the Vorbis specification by the Xiph.Org Foundation michael@0: (http://www.xiph.org/) michael@0: michael@0: * libvorbisfile, a BSD-style license convenience library michael@0: built on Vorbis designed to simplify common uses michael@0: michael@0: * libvorbisenc, a BSD-style license library that provides a simple, michael@0: programmatic encoding setup interface michael@0: michael@0: * example code making use of libogg, libvorbis, libvorbisfile and michael@0: libvorbisenc michael@0: michael@0: WHAT'S HERE: michael@0: michael@0: This source distribution includes libvorbis and an example michael@0: encoder/player to demonstrate use of libvorbis as well as michael@0: documentation on the Ogg Vorbis audio coding format. michael@0: michael@0: You'll need libogg (distributed separately) to compile this library. michael@0: A more comprehensive set of utilities is available in the vorbis-tools michael@0: package. michael@0: michael@0: Directory: michael@0: michael@0: ./lib The source for the libraries, a BSD-license implementation michael@0: of the public domain Ogg Vorbis audio encoding format. michael@0: michael@0: ./include Library API headers michael@0: michael@0: ./debian Rules/spec files for building Debian .deb packages michael@0: michael@0: ./doc Vorbis documentation michael@0: michael@0: ./examples Example code illustrating programmatic use of libvorbis, michael@0: libvorbisfile and libvorbisenc michael@0: michael@0: ./mac Codewarrior project files and build tweaks for MacOS. michael@0: michael@0: ./macosx Project files for MacOS X. michael@0: michael@0: ./win32 Win32 projects files and build automation michael@0: michael@0: ./vq Internal utilities for training/building new LSP/residue michael@0: and auxiliary codebooks. michael@0: michael@0: CONTACT: michael@0: michael@0: The Ogg homepage is located at 'http://www.xiph.org/ogg/'. michael@0: Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'. michael@0: Up to date technical documents, contact information, source code and michael@0: pre-built utilities may be found there. michael@0: michael@0: The user website for Ogg Vorbis software and audio is http://vorbis.com/ michael@0: michael@0: BUILDING FROM TRUNK: michael@0: michael@0: Development source is under subversion revision control at michael@0: https://svn.xiph.org/trunk/vorbis/. You will also need the michael@0: newest versions of autoconf, automake, libtool and pkg-config in michael@0: order to compile Vorbis from development source. A configure script michael@0: is provided for you in the source tarball distributions. michael@0: michael@0: [update or checkout latest source] michael@0: ./autogen.sh michael@0: make michael@0: michael@0: and as root if desired: michael@0: michael@0: make install michael@0: michael@0: This will install the Vorbis libraries (static and shared) into michael@0: /usr/local/lib, includes into /usr/local/include and API manpages michael@0: (once we write some) into /usr/local/man. michael@0: michael@0: Documentation building requires xsltproc and pdfxmltex. michael@0: michael@0: BUILDING FROM TARBALL DISTRIBUTIONS: michael@0: michael@0: ./configure michael@0: make michael@0: michael@0: and optionally (as root): michael@0: make install michael@0: michael@0: BUILDING RPMS: michael@0: michael@0: after normal configuring: michael@0: michael@0: make dist michael@0: rpm -ta libvorbis-.tar.gz michael@0: michael@0: BUILDING ON MACOS 9: michael@0: michael@0: Vorbis on MacOS 9 is built using Metroworks CodeWarrior. To build it, michael@0: first verify that the Ogg libraries are already built following the michael@0: instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp, michael@0: switch to the "Targets" pane, select everything, and make the project. michael@0: Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in michael@0: that order). In vorbis/mac/Output you will now have both debug and final michael@0: versions of Vorbis shared libraries to link your projects against. michael@0: michael@0: To build a project using Ogg Vorbis, add access paths to your michael@0: CodeWarrior project for the ogg/include, ogg/mac/Output, michael@0: vorbis/include, and vorbis/mac/Output folders. Be sure that michael@0: "interpret DOS and Unix paths" is turned on in your project; it can michael@0: be found in the "access paths" pane in your project settings. Now michael@0: simply add the shared libraries you need to your project (OggLib and michael@0: VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h" michael@0: wherever you need to access Ogg and Vorbis functionality. michael@0: