annotate src/libogg-1.3.0/README @ 169:223a55898ab9 tip default

Add null config files
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 02 Mar 2020 14:03:47 +0000
parents 98c1576536ae
children
rev   line source
cannam@86 1 ********************************************************************
cannam@86 2 * *
cannam@86 3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
cannam@86 4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
cannam@86 5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
cannam@86 6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
cannam@86 7 * *
cannam@86 8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2011 *
cannam@86 9 * by the Xiph.Org Foundation http://www.xiph.org/ *
cannam@86 10 * *
cannam@86 11 ********************************************************************
cannam@86 12
cannam@86 13 = WHAT'S HERE =
cannam@86 14
cannam@86 15 This source distribution includes libogg and nothing else. Other modules
cannam@86 16 (eg, the modules libvorbis, vorbis-tools for the Vorbis music codec,
cannam@86 17 libtheora for the Theora video codec) contain the codec libraries for
cannam@86 18 use with Ogg bitstreams.
cannam@86 19
cannam@86 20 Directory:
cannam@86 21
cannam@86 22 ./src The source for libogg, a BSD-license inplementation of
cannam@86 23 the public domain Ogg bitstream format
cannam@86 24
cannam@86 25 ./include Library API headers
cannam@86 26
cannam@86 27 ./doc Ogg specification and libogg API documents
cannam@86 28
cannam@86 29 ./win32 Win32 projects and build automation
cannam@86 30
cannam@86 31 ./macosx Mac OS X project and build files
cannam@86 32
cannam@86 33 = WHAT IS OGG? =
cannam@86 34
cannam@86 35 Ogg project codecs use the Ogg bitstream format to arrange the raw,
cannam@86 36 compressed bitstream into a more robust, useful form. For example,
cannam@86 37 the Ogg bitstream makes seeking, time stamping and error recovery
cannam@86 38 possible, as well as mixing several sepearate, concurrent media
cannam@86 39 streams into a single physical bitstream.
cannam@86 40
cannam@86 41 = CONTACT =
cannam@86 42
cannam@86 43 The Ogg homepage is located at 'https://www.xiph.org/ogg/'.
cannam@86 44 Up to date technical documents, contact information, source code and
cannam@86 45 pre-built utilities may be found there.
cannam@86 46
cannam@86 47 BUILDING FROM TARBALL DISTRIBUTIONS:
cannam@86 48
cannam@86 49 ./configure
cannam@86 50 make
cannam@86 51
cannam@86 52 and optionally (as root):
cannam@86 53 make install
cannam@86 54
cannam@86 55 This will install the Ogg libraries (static and shared) into
cannam@86 56 /usr/local/lib, includes into /usr/local/include and API
cannam@86 57 documentation into /usr/local/share/doc.
cannam@86 58
cannam@86 59 BUILDING FROM REPOSITORY SOURCE:
cannam@86 60
cannam@86 61 A standard svn build should consist of nothing more than:
cannam@86 62
cannam@86 63 ./autogen.sh
cannam@86 64 make
cannam@86 65
cannam@86 66 and as root if desired :
cannam@86 67
cannam@86 68 make install
cannam@86 69
cannam@86 70 BUILDING ON WIN32:
cannam@86 71
cannam@86 72 Use the project file in the win32 directory. It should compile out of the box.
cannam@86 73
cannam@86 74 CROSS COMPILING FROM LINUX TO WIN32:
cannam@86 75
cannam@86 76 It is also possible to cross compile from Linux to windows using the MinGW
cannam@86 77 cross tools and even to run the test suite under Wine, the Linux/*nix
cannam@86 78 windows emulator.
cannam@86 79
cannam@86 80 On Debian and Ubuntu systems, these cross compiler tools can be installed
cannam@86 81 by doing:
cannam@86 82
cannam@86 83 sudo apt-get mingw32 mingw32-binutils mingw32-runtime wine
cannam@86 84
cannam@86 85 Once these tools are installed its possible to compile and test by
cannam@86 86 executing the following commands, or something similar depending on
cannam@86 87 your system:
cannam@86 88
cannam@86 89 ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc \
cannam@86 90 --build=i586-linux
cannam@86 91 make
cannam@86 92 make check
cannam@86 93
cannam@86 94 (Build instructions for Ogg codecs such as vorbis are similar and may
cannam@86 95 be found in those source modules' README files)
cannam@86 96
cannam@86 97 $Id: README 18048 2011-08-04 17:36:32Z giles $