X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README;h=3e969e0ceb8ba8a2589f5188172553748fb71d2c;hb=6253d5acef0bdc2f0505da227f30db7f87d739a0;hp=8a028d96b9e7a3694700f12f44df6aadee5d303f;hpb=2c30f77396a401a546e996d968749f5ccdeb7792;p=platform%2Fupstream%2Flibvorbis.git diff --git a/README b/README index 8a028d9..3e969e0 100644 --- a/README +++ b/README @@ -1,47 +1,53 @@ ******************************************************************** * * -* THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE. * -* USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY * -* THE GNU LESSER/LIBRARY PUBLIC LICENSE 2, WHICH IS INCLUDED WITH * -* THIS SOURCE. PLEASE READ THESE TERMS DISTRIBUTING. * +* THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. * +* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS * +* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE * +* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. * * * -* THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-2000 * -* by Monty and The XIPHOPHORUS Company * -* http://www.xiph.org/ * +* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 * +* by the Xiph.org Foundation, http://www.xiph.org/ * * * ******************************************************************** -NEW AND IMPORTANT: +Vorbis is a general purpose audio and music encoding format +contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond +MPEG audio layer 3. Unlike the MPEG sponsored formats (and other +proprietary formats such as RealAudio G2 and Windows' flavor of the +month), the Vorbis CODEC specification belongs to the public domain. +All the technical details are published and documented, and any +software entity may make full use of the format without license +fee, royalty or patent concerns. + +This package contains: -If you're used to the source distribution from the first two beta -relaeases, things are now rearranged a bit. Specifically, the -'vorbis' CVS module contains only the libvorbis, libvorbisfile, and -libvorbisenc libraries. Because Ogg bitstreams are to be used by other -Ogg codecs, Ogg framing and streaming functionality is now in libogg -(the 'ogg' CVS module). Vorbis utilities are in 'vorbis-tools' and various -player plugins are in 'vorbis-plugins'. For now, you'll need to check -out these other modules seperately. (Note: the xmms plugin is in the xmms -CVS tree in xmms/Input/vorbis.) +* libvorbis, a BSD-style license software implementation of + the Vorbis specification by the Xiph.Org Foundation + (http://www.xiph.org/) -Secondly, the Ogg/Vorbis build systems now use automake. Instead of -'./configure; make', the proper build sequence (in each module) is -'./autogen.sh; make'. +* libvorbisfile, a BSD-style license convenience library + built on Vorbis designed to simplify common uses -You will also need the newest versions of autoconf, automake, and libtool -in order to compile vorbis from CVS. configure scripts are provided for you -in tarball distributions. +* libvorbisenc, a BSD-style license library that provides a simple, + programmatic encoding setup interface + +* example code making use of libogg, libvorbis, libvorbisfile and + libvorbisenc WHAT'S HERE: This source distribution includes libvorbis and an example -encoder/player to demonstrate use of libvorbis and documentation on -the Ogg Vorbis audio coding format. +encoder/player to demonstrate use of libvorbis as well as +documentation on the Ogg Vorbis audio coding format. + +You'll need libogg (distributed separately) to compile this library. +A more comprehensive set of utilities is available in the vorbis-tools +package. Directory: -./lib The source for the libraries, an LGPLed inplementation of - the public domain Ogg Vorbis audio encoding - format. +./lib The source for the libraries, a BSD-license implementation + of the public domain Ogg Vorbis audio encoding format. ./include Library API headers @@ -54,71 +60,75 @@ Directory: ./mac Codewarrior project files and build tweaks for MacOS. +./macosx Project files for MacOS X. + ./win32 Win32 projects files and build automation ./vq Internal utilities for training/building new LSP/residue and auxiliary codebooks. -WHAT IS VORBIS: - -Vorbis is a general purpose audio and music encoding format -contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond -MPEG audio layer 3. Unlike the MPEG sponsored formats (and other -proprietary formats such as RealAudio G2 and Windows' flavor of the -month), the Vorbis CODEC specification belongs to the public domain. -All the technical details are published and documented, and any -software entity may make full use of the format without royalty or -patent concerns. - -This package contains: - -.) libvorbis, an LGPLed software implementation of -the Vorbis specification by the Xiphophorus company -(http://www.xiph.org/) - -.) libvorbisfile, an LGPLed convenience library -built on Vorbis designed to simplify common uses and a number of GPL -example programs - -.) libvorbisenc, an LGPL library that provides a simple, programmatic -encoding setup interface - -.) example code making use of libogg, libvorbis, libvorbisfile and -libvorbisenc - CONTACT: The Ogg homepage is located at 'http://www.xiph.org/ogg/'. -Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'. +Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'. Up to date technical documents, contact information, source code and pre-built utilities may be found there. -BUILDING FROM CVS: +The user website for Ogg Vorbis software and audio is http://vorbis.com/ + +BUILDING FROM TRUNK: -./autogen.sh -make +Development source is under subversion revision control at +https://svn.xiph.org/trunk/vorbis/. You will also need the +newest versions of autoconf, automake, libtool and pkg-config in +order to compile Vorbis from development source. A configure script +is provided for you in the source tarball distributions. + + [update or checkout latest source] + ./autogen.sh + make and as root if desired: -make install + make install -This will install the vorbis libraries (static and shared) into +This will install the Vorbis libraries (static and shared) into /usr/local/lib, includes into /usr/local/include and API manpages (once we write some) into /usr/local/man. +Documentation building requires xsltproc and pdfxmltex. + BUILDING FROM TARBALL DISTRIBUTIONS: -./configure -make + ./configure + make and optionally (as root): -make install + make install BUILDING RPMS: after normal configuring: -make dist -rpm -ta libvorbis-.tar.gz + make dist + rpm -ta libvorbis-.tar.gz + +BUILDING ON MACOS 9: + +Vorbis on MacOS 9 is built using Metroworks CodeWarrior. To build it, +first verify that the Ogg libraries are already built following the +instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp, +switch to the "Targets" pane, select everything, and make the project. +Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in +that order). In vorbis/mac/Output you will now have both debug and final +versions of Vorbis shared libraries to link your projects against. + +To build a project using Ogg Vorbis, add access paths to your +CodeWarrior project for the ogg/include, ogg/mac/Output, +vorbis/include, and vorbis/mac/Output folders. Be sure that +"interpret DOS and Unix paths" is turned on in your project; it can +be found in the "access paths" pane in your project settings. Now +simply add the shared libraries you need to your project (OggLib and +VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h" +wherever you need to access Ogg and Vorbis functionality. -$Id: README,v 1.7 2000/11/08 08:45:30 jack Exp $