Tree [95439d] svn-tags/vorbis-1.0.0beta4 / vorbis /
 History



File Date Author Commit
 debian 2001-02-26 calc calc [f1a88b] Debian more additions
 doc 2001-02-10 xiphmont xiphmont [adb78a]
 examples 2001-02-26 xiphmont xiphmont [edfbe4]
 include 2001-02-26 xiphmont xiphmont [edfbe4]
 lib 2001-02-26 xiphmont xiphmont [4fe744]
 mac 2000-11-22 xiphmont xiphmont [dbd056]
 vq 2001-02-26 xiphmont xiphmont [edfbe4]
 win32 2001-02-19 jack jack [416bf4] updated the win32 build system and corrected so...
 .cvsignore 2001-02-26 jack jack [877ecc] updated cvsignore
 AUTHORS 2000-11-08 jack jack [016c36] versioning and doc updates
 COPYING 2001-02-26 xiphmont xiphmont [edfbe4]
 Makefile.am 2000-11-18 jack jack [fa6eff] made vq for new build system
 README 2000-11-22 xiphmont xiphmont [9a7c19]
 acinclude.m4 2000-11-06 xiphmont xiphmont [e21d19]
 autogen.sh 2000-10-31 giles giles [fab3c7] propagating configure cleanups
 configure.in 2001-02-26 xiphmont xiphmont [edfbe4]
 libvorbis.spec 2001-02-26 xiphmont xiphmont [edfbe4]
 todo.txt 2000-07-12 xiphmont xiphmont [03a516]
 vorbis.m4 2000-11-06 xiphmont xiphmont [e21d19]

Read Me

********************************************************************
*                                                                  *
* 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.              *
*                                                                  *
* THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-2000             *
* by Monty <monty@xiph.org> and The XIPHOPHORUS Company            *
* http://www.xiph.org/                                             *
*                                                                  *
********************************************************************

NEW AND IMPORTANT:

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.)

Secondly, the Ogg/Vorbis build systems now use automake.  Instead of
'./configure; make', the proper build sequence (in each module) is
'./autogen.sh; make'.

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.

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.

Directory:

./lib  		The source for the libraries, an LGPLed inplementation of 
		the public domain Ogg Vorbis audio encoding
		format.

./include       Library API headers

./debian        Rules/spec files for building Debian .deb packages

./doc           Vorbis documentation

./examples	Example code illustrating programmatic use of libvorbis, 
		libvorbisfile and libvorbisenc

./mac 		Codewarrior project files and build tweaks for MacOS.

./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/'.
Up to date technical documents, contact information, source code and
pre-built utilities may be found there.

BUILDING FROM CVS:

./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.

BUILDING FROM TARBALL DISTRIBUTIONS:

./configure
make

and optionally (as root):
make install

BUILDING RPMS:

after normal configuring:

make dist
rpm -ta libvorbis-<version>.tar.gz

BUILDING ON MACOS 9:

Vorbis on MacOS 9 is built using CodeWarrior 5.3.  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).  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 acces Ogg and Vorbis functionality.


$Id: README,v 1.8 2000/11/22 06:22:18 xiphmont Exp $

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks