README

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