README

   1 ********************************************************************
   2 *                                                                  *
   3 * THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
   4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
   5 * THE GNU LESSER/LIBRARY PUBLIC LICENSE 2, WHICH IS INCLUDED WITH  *
   6 * THIS SOURCE.  PLEASE READ THESE TERMS DISTRIBUTING.              *
   7 *                                                                  *
   8 * THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-2000             *
   9 * by Monty <monty@xiph.org> and The XIPHOPHORUS Company            *
  10 * http://www.xiph.org/                                             *
  11 *                                                                  *
  12 ********************************************************************
  13
  14 NEW AND IMPORTANT:
  15
  16 If you're used to the source distribution from the first two beta
  17 relaeases, things are now rearranged a bit.  Specifically, the
  18 'vorbis' CVS module contains only the libvorbis and libvorbisfile
  19 libraries.  Because Ogg bitstreams are to be used by other Ogg codecs,
  20 Ogg framing and streaming functionality is now in libogg (the 'ogg'
  21 CVS module).  Vorbis utilities are in 'vorbis-tools' and various
  22 player plugins are in 'vorbis-plugins'.  For now, you'll need to check
  23 out these other modules seperately.
  24
  25 Secondly, the Ogg/Vorbis build systems now use automake.  Instead of
  26 './configure;make', the proper build sequence (in each module) is
  27 './autogen.sh;make'.
  28
  29 WHAT'S HERE:
  30
  31 This source distribution includes libvorbis and an example
  32 encoder/player to demonstrate use of libvorbis and documentation on
  33 the Ogg Vorbis audio coding format.
  34
  35 Directory:
  36
  37 ./lib           The source for libvorbis, an LGPLed inplementation of
  38                 the public domain OggSquish Vorbis audio encoding
  39                 format.
  40
  41 ./include       Library API headers and codebooks
  42
  43 ./debian        Rules/spec files for building Debian .deb packages
  44
  45 ./doc           Vorbis specification documents
  46
  47 ./examples      Example code illustrating programmatic use of libogg,
  48                 libvorbis, libvorbisfile and libvorbisenc
  49
  50 ./mac           Codewarrior project files and build tweaks for MacOS.
  51
  52
  53 ./vq            Internal utilities for training/building new LSP/residue
  54                 and auxiliary codebooks.
  55
  56 WHAT IS VORBIS:
  57
  58 Vorbis is a general purpose audio and music encoding format
  59 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
  60 MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
  61 proprietary formats such as RealAudio G2 and Windows' flavor of the
  62 month), the Vorbis CODEC specification belongs to the public domain.
  63 All the technical details are published and documented, and any
  64 software entity may make full use of the format without royalty or
  65 patent concerns.
  66
  67 This package contains:
  68
  69 .) libvorbis, an LGPLed software implementation of
  70 the Vorbis specification by the Xiphophorus company
  71 (http://www.xiph.org/)
  72
  73 .) libvorbisfile, an LGPLed convenience library
  74 built on Vorbis designed to simplify common uses and a number of GPL
  75 example programs
  76
  77 .) libvorbisenc, an LGPL library that provides a simple, programmatic
  78 encoding setup interface
  79
  80 .) example code making use of libogg, libvorbis, libvorbisfile and
  81 libvorbisenc
  82
  83 CONTACT:
  84
  85 The OggSquish homepage is located at 'http://www.xiph.org/ogg/'.
  86 Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
  87 Up to date technical documents, contact information, source code and
  88 pre-built utilities may be found there.
  89
  90 BUILD:
  91
  92 A standard build should consist of nothing more than:
  93
  94 ./autogen.sh
  95 make
  96
  97 and as root if desired :
  98
  99 make install
 100
 101 This will install the vorbis libraries (static and shared) into
 102 /usr/local/lib, includes into /usr/local/include and API manpages
 103 (once we write some) into /usr/local/man.
 104
 105 Monty <monty@xiph.org>
 106
 107 $Id: README,v 1.5 2000/10/12 03:12:36 xiphmont Exp $