annotate src/libvorbis-1.3.3/README @ 79:91c729825bca pa_catalina

Update build for AUDIO_COMPONENT_FIX
author Chris Cannam
date Wed, 30 Oct 2019 12:40:34 +0000
parents 05aa0afa9217
children
rev   line source
Chris@1 1 ********************************************************************
Chris@1 2 * *
Chris@1 3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
Chris@1 4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
Chris@1 5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
Chris@1 6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
Chris@1 7 * *
Chris@1 8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
Chris@1 9 * by the Xiph.org Foundation, http://www.xiph.org/ *
Chris@1 10 * *
Chris@1 11 ********************************************************************
Chris@1 12
Chris@1 13 Vorbis is a general purpose audio and music encoding format
Chris@1 14 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
Chris@1 15 MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
Chris@1 16 proprietary formats such as RealAudio G2 and Windows' flavor of the
Chris@1 17 month), the Vorbis CODEC specification belongs to the public domain.
Chris@1 18 All the technical details are published and documented, and any
Chris@1 19 software entity may make full use of the format without license
Chris@1 20 fee, royalty or patent concerns.
Chris@1 21
Chris@1 22 This package contains:
Chris@1 23
Chris@1 24 * libvorbis, a BSD-style license software implementation of
Chris@1 25 the Vorbis specification by the Xiph.Org Foundation
Chris@1 26 (http://www.xiph.org/)
Chris@1 27
Chris@1 28 * libvorbisfile, a BSD-style license convenience library
Chris@1 29 built on Vorbis designed to simplify common uses
Chris@1 30
Chris@1 31 * libvorbisenc, a BSD-style license library that provides a simple,
Chris@1 32 programmatic encoding setup interface
Chris@1 33
Chris@1 34 * example code making use of libogg, libvorbis, libvorbisfile and
Chris@1 35 libvorbisenc
Chris@1 36
Chris@1 37 WHAT'S HERE:
Chris@1 38
Chris@1 39 This source distribution includes libvorbis and an example
Chris@1 40 encoder/player to demonstrate use of libvorbis as well as
Chris@1 41 documentation on the Ogg Vorbis audio coding format.
Chris@1 42
Chris@1 43 You'll need libogg (distributed separately) to compile this library.
Chris@1 44 A more comprehensive set of utilities is available in the vorbis-tools
Chris@1 45 package.
Chris@1 46
Chris@1 47 Directory:
Chris@1 48
Chris@1 49 ./lib The source for the libraries, a BSD-license implementation
Chris@1 50 of the public domain Ogg Vorbis audio encoding format.
Chris@1 51
Chris@1 52 ./include Library API headers
Chris@1 53
Chris@1 54 ./debian Rules/spec files for building Debian .deb packages
Chris@1 55
Chris@1 56 ./doc Vorbis documentation
Chris@1 57
Chris@1 58 ./examples Example code illustrating programmatic use of libvorbis,
Chris@1 59 libvorbisfile and libvorbisenc
Chris@1 60
Chris@1 61 ./mac Codewarrior project files and build tweaks for MacOS.
Chris@1 62
Chris@1 63 ./macosx Project files for MacOS X.
Chris@1 64
Chris@1 65 ./win32 Win32 projects files and build automation
Chris@1 66
Chris@1 67 ./vq Internal utilities for training/building new LSP/residue
Chris@1 68 and auxiliary codebooks.
Chris@1 69
Chris@1 70 CONTACT:
Chris@1 71
Chris@1 72 The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
Chris@1 73 Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'.
Chris@1 74 Up to date technical documents, contact information, source code and
Chris@1 75 pre-built utilities may be found there.
Chris@1 76
Chris@1 77 The user website for Ogg Vorbis software and audio is http://vorbis.com/
Chris@1 78
Chris@1 79 BUILDING FROM TRUNK:
Chris@1 80
Chris@1 81 Development source is under subversion revision control at
Chris@1 82 https://svn.xiph.org/trunk/vorbis/. You will also need the
Chris@1 83 newest versions of autoconf, automake, libtool and pkg-config in
Chris@1 84 order to compile Vorbis from development source. A configure script
Chris@1 85 is provided for you in the source tarball distributions.
Chris@1 86
Chris@1 87 [update or checkout latest source]
Chris@1 88 ./autogen.sh
Chris@1 89 make
Chris@1 90
Chris@1 91 and as root if desired:
Chris@1 92
Chris@1 93 make install
Chris@1 94
Chris@1 95 This will install the Vorbis libraries (static and shared) into
Chris@1 96 /usr/local/lib, includes into /usr/local/include and API manpages
Chris@1 97 (once we write some) into /usr/local/man.
Chris@1 98
Chris@1 99 Documentation building requires xsltproc and pdfxmltex.
Chris@1 100
Chris@1 101 BUILDING FROM TARBALL DISTRIBUTIONS:
Chris@1 102
Chris@1 103 ./configure
Chris@1 104 make
Chris@1 105
Chris@1 106 and optionally (as root):
Chris@1 107 make install
Chris@1 108
Chris@1 109 BUILDING RPMS:
Chris@1 110
Chris@1 111 after normal configuring:
Chris@1 112
Chris@1 113 make dist
Chris@1 114 rpm -ta libvorbis-<version>.tar.gz
Chris@1 115
Chris@1 116 BUILDING ON MACOS 9:
Chris@1 117
Chris@1 118 Vorbis on MacOS 9 is built using Metroworks CodeWarrior. To build it,
Chris@1 119 first verify that the Ogg libraries are already built following the
Chris@1 120 instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp,
Chris@1 121 switch to the "Targets" pane, select everything, and make the project.
Chris@1 122 Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
Chris@1 123 that order). In vorbis/mac/Output you will now have both debug and final
Chris@1 124 versions of Vorbis shared libraries to link your projects against.
Chris@1 125
Chris@1 126 To build a project using Ogg Vorbis, add access paths to your
Chris@1 127 CodeWarrior project for the ogg/include, ogg/mac/Output,
Chris@1 128 vorbis/include, and vorbis/mac/Output folders. Be sure that
Chris@1 129 "interpret DOS and Unix paths" is turned on in your project; it can
Chris@1 130 be found in the "access paths" pane in your project settings. Now
Chris@1 131 simply add the shared libraries you need to your project (OggLib and
Chris@1 132 VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
Chris@1 133 wherever you need to access Ogg and Vorbis functionality.
Chris@1 134