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