README 3.5 KB

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