libogg-1.0/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-2002             *
   9 * by the Xiph.Org Foundation http://www.xiph.org/                  *
  10 *                                                                  *
  11 ********************************************************************
  12
  13 WHAT'S HERE:
  14
  15 This source distribution includes libogg and nothing else.  Other modules
  16 (eg, the modules vorbis, vorbis-tools and vorbis-plugins for the Vorbis
  17 codec) contain the codec libraries for use with Ogg bitstreams.
  18
  19 Directory:
  20
  21 ./src           The source for libogg, a BSD-license inplementation of
  22                 the public domain Ogg bitstream format
  23
  24 ./include       Library API headers and codebooks
  25
  26 ./debian        Rules/spec files for building Debian .deb packages
  27
  28 ./doc           Ogg specification documents
  29
  30 ./win32         Win32 projects and build automation
  31
  32 ./mac           MacOS 9 projects and build automation
  33
  34 WHAT IS OGG?:
  35
  36 Ogg project codecs use the Ogg bitstream format to arrange the raw,
  37 compressed bitstream into a more robust, useful form.  For example,
  38 the Ogg bitstream makes seeking, time stamping and error recovery
  39 possible, as well as mixing several sepearate, concurrent media
  40 streams into a single physical bitstream.
  41
  42 CONTACT:
  43
  44 The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
  45 Up to date technical documents, contact information, source code and
  46 pre-built utilities may be found there.
  47
  48 BUILDING FROM CVS:
  49
  50 A standard cvs build should consist of nothing more than:
  51
  52 ./autogen.sh
  53 make
  54
  55 and as root if desired :
  56
  57 make install
  58
  59 This will install the Ogg libraries (static and shared) into
  60 /usr/local/lib, includes into /usr/local/include and API manpages
  61 (once we write some) into /usr/local/man.
  62
  63 BUILDING FROM TARBALL DISTRIBUTIONS:
  64
  65 ./configure
  66 make
  67
  68 and optionally (as root):
  69 make install
  70
  71 BUILDING RPMS:
  72
  73 RPMs may be built by:
  74
  75 make dist
  76 rpm -ta libogg-<version>.tar.gz
  77
  78 BUILDING ON WIN32:
  79
  80 Use the project file in the win32 directory.  It should compile out of the box.
  81 You can also run one of the batch files from the commandline.
  82
  83 E.g.: build_ogg_dynamic
  84
  85 BUILDING ON MACOS 9:
  86
  87 Ogg on MacOS 9 is built using CodeWarrior 5.3.  To build it, first
  88 open ogg/mac/libogg.mcp, switch to the "Targets" pane, select
  89 everything, and make the project.  In ogg/mac/Output you will now have
  90 both debug and final versions of Ogg shared libraries to link your
  91 projects against.
  92
  93 To build a project using Ogg, add access paths to your CodeWarrior
  94 project for the ogg/include and ogg/mac/Output folders.  Be sure that
  95 "interpret DOS and Unix paths" is turned on in your project; it can be
  96 found in the "access paths" pane in your project settings.  Now simply
  97 add the shared libraries you need to your project (OggLib at least)
  98 and #include "ogg/ogg.h" wherever you need to acces Ogg functionality.
  99
 100 (Build instructions for Ogg codecs such as vorbis are similar and may
 101 be found in those source modules' README files)
 102
 103 $Id: README,v 1.10 2002/07/11 09:09:06 xiphmont Exp $