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