3 [![Travis Build Status](https://travis-ci.org/xiph/vorbis.png?branch=master)](https://travis-ci.org/xiph/vorbis)
4 [![Jenkins Build Status](https://mf4.xiph.org/jenkins/job/libvorbis/badge/icon)](https://mf4.xiph.org/jenkins/job/libvorbis/)
6 Vorbis is a general purpose audio and music encoding format
7 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
8 MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
9 proprietary formats such as RealAudio G2 and Windows' flavor of the
10 month), the Vorbis CODEC specification belongs to the public domain.
11 All the technical details are published and documented, and any
12 software entity may make full use of the format without license
13 fee, royalty or patent concerns.
15 This package contains:
17 - libvorbis, a BSD-style license software implementation of
18 the Vorbis specification by the Xiph.Org Foundation
19 (https://www.xiph.org/)
21 - libvorbisfile, a BSD-style license convenience library
22 built on Vorbis designed to simplify common uses
24 - libvorbisenc, a BSD-style license library that provides a simple,
25 programmatic encoding setup interface
27 - example code making use of libogg, libvorbis, libvorbisfile and
32 This source distribution includes libvorbis and an example
33 encoder/player to demonstrate use of libvorbis as well as
34 documentation on the Ogg Vorbis audio coding format.
36 You'll need libogg (distributed separately) to compile this library.
37 A more comprehensive set of utilities is available in the vorbis-tools
42 - `lib` The source for the libraries, a BSD-license implementation of the public domain Ogg Vorbis audio encoding format.
44 - `include` Library API headers
46 - `debian` Rules/spec files for building Debian .deb packages
48 - `doc` Vorbis documentation
50 - `examples` Example code illustrating programmatic use of libvorbis, libvorbisfile and libvorbisenc
52 - `macosx` Project files for MacOS X.
54 - `win32` Win32 projects files and build automation
56 - `vq` Internal utilities for training/building new LSP/residue and auxiliary codebooks.
60 The Ogg homepage is located at 'https://www.xiph.org/ogg/'.
61 Vorbis's homepage is located at 'https://www.xiph.org/vorbis/'.
62 Up to date technical documents, contact information, source code and
63 pre-built utilities may be found there.
65 The user website for Ogg Vorbis software and audio is http://vorbis.com/
69 #### Building from master ####
71 Development source is under git revision control at
72 https://git.xiph.org/vorbis.git. You will also need the
73 newest versions of autoconf, automake, libtool and pkg-config in
74 order to compile Vorbis from development source. A configure script
75 is provided for you in the source tarball distributions.
81 and as root if desired:
85 This will install the Vorbis libraries (static and shared) into
86 /usr/local/lib, includes into /usr/local/include and API manpages
87 (once we write some) into /usr/local/man.
89 Documentation building requires xsltproc and pdfxmltex.
91 #### Building from tarball distributions ####
96 and optionally (as root):
100 #### Building RPM packages ####
102 after normal configuring:
105 rpm -ta libvorbis-<version>.tar.gz
107 ## Building with CMake ##
109 Ogg supports building using [CMake](http://www.cmake.org/). CMake is a meta build system that generates native projects for each platform.
110 To generate projects just run cmake replacing `YOUR-PROJECT-GENERATOR` with a proper generator from a list [here](http://www.cmake.org/cmake/help/v3.2/manual/cmake-generators.7.html):
112 cmake -G YOUR-PROJECT-GENERATOR .
114 Note that by default cmake generates projects that will build static libraries.
115 To generate projects that will build dynamic library use `BUILD_SHARED_LIBS` option like this:
117 cmake -G YOUR-PROJECT-GENERATOR -DBUILD_SHARED_LIBS=1 .
119 After projects are generated use them as usual
121 #### Building on Windows ####
123 Use proper generator for your Visual Studio version like:
125 cmake -G "Visual Studio 12 2013" .
127 #### Building on Mac OS X ####
129 Use Xcode generator. To build framework run:
131 cmake -G Xcode -DBUILD_FRAMEWORK=1 .
133 #### Building on Linux ####
135 Use Makefile generator which is default one.
142 THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.
143 USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS
144 GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE
145 IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.
147 THE OggVorbis SOURCE CODE IS COPYRIGHT (C) 1994-2015
148 by the Xiph.Org Foundation https://www.xiph.org/