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