Skip to content
OCaml bindings to lbvorbis.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
m4 @ 6cf2da7
src
.gitignore
.gitmodules
.travis.yml
CHANGES
COPYING
Makefile.in
README
bootstrap
configure.ac
vorbis.opam

README

OCaml-vorbis - OCaml bindings for the libvorbis
======================================================

Authors: Samuel Mimram <samuel.mimram@ens-lyon.org>
	Julien Cristau <julien.cristau@ens-lyon.org>
Email: savonet-users@lists.sourceforge.net
Homepage: http://savonet.sourceforge.net/

Copyright (c) 2003-2006 the Savonet Team.

based on code from:
oggenc/oggdec, (c) 2000-2002 Michael Smith <msmith@labyrinth.net.au>
ices2, (c) 2001 Michael Smith <msmith@labyrinth.net.au>
These are released under the GPL.

Dependencies
============
To build this library you need to have OCaml 3.07 and ocaml-ogg bindings, libvorbis
and libvorbisfile libraries.


Installation
============
To compile the program type:

./configure
make

You can set specific build options with the configure script, see:
./configure --help

Then, to install it, type as root:

make install


Usage
=====
Here are the typical workflows.

Encoding
--------
1. Vorbis.Encoder.create / Vorbis.Encoder.create_vbr: create an encoder
2. Ogg.Stream.create: create an ogg stream
3. Vorbis.Encoder.headerout: output the ogg header
4. Ogg.Stream.flush: flush the ogg stream to ensure that the header will be on
   its own page
5. Vorbis.Encoder.encode_buffer_float: encode data
6. Ogg.Stream.pagesout: get the resulting ogg pages
7. goto 5
8. Vorbis.Encoder.end_of_stream: indicate that it is the end of the stream
9. Ogg.Stream.pagesout: get the last pages


License
=======
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.



The version of this README is:
$Id$
You can’t perform that action at this time.