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, libvorbisfile, and
  19 libvorbisenc libraries.  Because Ogg bitstreams are to be used by other
  20 Ogg codecs, Ogg framing and streaming functionality is now in libogg
  21 (the 'ogg' 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. (Note: the xmms plugin is in the xmms
  24 CVS tree in xmms/Input/vorbis.)
  25
  26 Secondly, the Ogg/Vorbis build systems now use automake.  Instead of
  27 './configure; make', the proper build sequence (in each module) is
  28 './autogen.sh; make'.
  29
  30 You will also need the newest versions of autoconf, automake, and libtool
  31 in order to compile vorbis from CVS.  configure scripts are provided for you
  32 in tarball distributions.
  33
  34 WHAT'S HERE:
  35
  36 This source distribution includes libvorbis and an example
  37 encoder/player to demonstrate use of libvorbis and documentation on
  38 the Ogg Vorbis audio coding format.
  39
  40 Directory:
  41
  42 ./lib           The source for the libraries, an LGPLed inplementation of
  43                 the public domain Ogg Vorbis audio encoding
  44                 format.
  45
  46 ./include       Library API headers
  47
  48 ./debian        Rules/spec files for building Debian .deb packages
  49
  50 ./doc           Vorbis documentation
  51
  52 ./examples      Example code illustrating programmatic use of libvorbis,
  53                 libvorbisfile and libvorbisenc
  54
  55 ./mac           Codewarrior project files and build tweaks for MacOS.
  56
  57 ./win32         Win32 projects files and build automation
  58
  59 ./vq            Internal utilities for training/building new LSP/residue
  60                 and auxiliary codebooks.
  61
  62 WHAT IS VORBIS:
  63
  64 Vorbis is a general purpose audio and music encoding format
  65 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
  66 MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
  67 proprietary formats such as RealAudio G2 and Windows' flavor of the
  68 month), the Vorbis CODEC specification belongs to the public domain.
  69 All the technical details are published and documented, and any
  70 software entity may make full use of the format without royalty or
  71 patent concerns.
  72
  73 This package contains:
  74
  75 .) libvorbis, an LGPLed software implementation of
  76 the Vorbis specification by the Xiphophorus company
  77 (http://www.xiph.org/)
  78
  79 .) libvorbisfile, an LGPLed convenience library
  80 built on Vorbis designed to simplify common uses and a number of GPL
  81 example programs
  82
  83 .) libvorbisenc, an LGPL library that provides a simple, programmatic
  84 encoding setup interface
  85
  86 .) example code making use of libogg, libvorbis, libvorbisfile and
  87 libvorbisenc
  88
  89 CONTACT:
  90
  91 The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
  92 Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
  93 Up to date technical documents, contact information, source code and
  94 pre-built utilities may be found there.
  95
  96 BUILDING FROM CVS:
  97
  98 ./autogen.sh
  99 make
 100
 101 and as root if desired:
 102
 103 make install
 104
 105 This will install the vorbis libraries (static and shared) into
 106 /usr/local/lib, includes into /usr/local/include and API manpages
 107 (once we write some) into /usr/local/man.
 108
 109 BUILDING FROM TARBALL DISTRIBUTIONS:
 110
 111 ./configure
 112 make
 113
 114 and optionally (as root):
 115 make install
 116
 117 BUILDING RPMS:
 118
 119 after normal configuring:
 120
 121 make dist
 122 rpm -ta libvorbis-<version>.tar.gz
 123
 124 BUILDING ON MACOS 9:
 125
 126 Vorbis on MacOS 9 is built using CodeWarrior 5.3.  To build it, first
 127 verify that the Ogg libraries are already built following the
 128 instructions in the Ogg module README.  Open vorbis/mac/libvorbis.mcp,
 129 switch to the "Targets" pane, select everything, and make the project.
 130 Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
 131 that order).  vorbis/mac/Output you will now have both debug and final
 132 versions of Vorbis shared libraries to link your projects against.
 133
 134 To build a project using Ogg Vorbis, add access paths to your
 135 CodeWarrior project for the ogg/include, ogg/mac/Output,
 136 vorbis/include, and vorbis/mac/Output folders.  Be sure that
 137 "interpret DOS and Unix paths" is turned on in your project; it can
 138 be found in the "access paths" pane in your project settings.  Now
 139 simply add the shared libraries you need to your project (OggLib and
 140 VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
 141 wherever you need to acces Ogg and Vorbis functionality.
 142
 143
 144 $Id: README,v 1.8 2000/11/22 06:22:18 xiphmont Exp $