X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README;h=d4abf566686afe3cf19792f0921fdf9dbdb5d4c7;hb=572db8fa8aafe8aed0a18266e0c086da5cfe1948;hp=571f574e540874db036d141cc1a0c6c3ee298b72;hpb=b565197aa051f50b6191912868447c0510ecb288;p=platform%2Fupstream%2Flibvorbis.git diff --git a/README b/README index 571f574..d4abf56 100644 --- a/README +++ b/README @@ -1,70 +1,115 @@ ******************************************************************** * * -* THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE. * -* USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY * -* THE GNU 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-1999 * -* by Monty and The XIPHOPHORUS Company * -* http://www.xiph.org/ * +* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2015 * +* by the Xiph.org Foundation, http://www.xiph.org/ * * * ******************************************************************** +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: + +* libvorbis, a BSD-style license software implementation of + the Vorbis specification by the Xiph.Org Foundation + (http://www.xiph.org/) + +* libvorbisfile, a BSD-style license convenience library + built on Vorbis designed to simplify common uses + +* 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, a full-featured example -encoder/player to demonstrate use of libvorbis and documentation on -the Ogg Vorbis audio coding format. +This source distribution includes libvorbis and an example +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 libvorbis, a GPLed inplementation of - the public domain OggSquish Vorbis audio encoding - format. +./lib The source for the libraries, a BSD-license implementation + of the public domain Ogg Vorbis audio encoding format. -./cmdline A full-featured command line encoder/decoder/player - utility ('vorbis') that demonstrates programmatic use - of libvorbis. +./include Library API headers -./docs Vorbis specification documents +./debian Rules/spec files for building Debian .deb packages -WHAT IS VORBIS: +./doc Vorbis documentation -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. +./examples Example code illustrating programmatic use of libvorbis, + libvorbisfile and libvorbisenc -This package contains libvorbis, a GPLed software implementation of -the Vorbis specification by the Xiphophorus company (http://www.xiph.org/). +./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. CONTACT: -The OggSquish homepage is located at 'http://www.xiph.org/ogg/'. -Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'. +The Ogg homepage is located at 'http://www.xiph.org/ogg/'. +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. -BUILD: +The user website for Ogg Vorbis software and audio is http://vorbis.com/ + +BUILDING FROM TRUNK: + +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 + +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 -A standard build should consist of nothing more than: +and optionally (as root): + make install -./configure -./make +BUILDING RPMS: -and as root if desired : +after normal configuring: -./make install + make dist + rpm -ta libvorbis-.tar.gz -This will install the ogg vorbis commandline encoder/player ('ogg') -into /usr/local/bin, the ogg player and libvorbis manpages into -/usr/local/man/ and libvorbis.a into /usr/local/lib. -Monty , -$Id: README,v 1.2 2000/04/29 18:02:36 pjones Exp $