[xiph-commits] r3689 - in liboggplay/trunk: . release_notes

silvia at svn.annodex.net silvia at svn.annodex.net
Tue Aug 5 05:09:38 PDT 2008


Author: silvia
Date: 2008-08-05 05:09:38 -0700 (Tue, 05 Aug 2008)
New Revision: 3689

Added:
   liboggplay/trunk/AUTHORS
   liboggplay/trunk/COPYING
   liboggplay/trunk/ChangeLog
   liboggplay/trunk/INSTALL
   liboggplay/trunk/release_notes/
   liboggplay/trunk/release_notes/liboggplay-0.0.1.txt
Modified:
   liboggplay/trunk/README
   liboggplay/trunk/configure.ac
Log:
prepared for 0.0.1 release - runs make distcheck successfully on the mac

Added: liboggplay/trunk/AUTHORS
===================================================================
--- liboggplay/trunk/AUTHORS	                        (rev 0)
+++ liboggplay/trunk/AUTHORS	2008-08-05 12:09:38 UTC (rev 3689)
@@ -0,0 +1,21 @@
+Shane Stephens (shans) <shans at annodex.net>
+        - Design, general implementation
+
+Conrad Parker (kfish) <conrad at metadecks.org>
+        - Design, bug fixes
+
+Marcin Lubonski <marcin at it.uts.edu.au>
+        - Port to windows
+
+Michael Martin (tahn) <myk.martin at gmail.com>
+        - Port to Max OS X
+
+Jan Gerber (j^) <jan.gerber at gmail.com>
+Ralph Giles <giles at xiph.org>
+        - Bug fixes
+
+Silvia Pfeiffer (ginger) <silvia at annodex.net>
+        - First release, minor bug fixes
+
+John Ferlito (johnf) <johnf at inodes.org>
+        - Bug fixes, Debian packaging
\ No newline at end of file

Added: liboggplay/trunk/COPYING
===================================================================
--- liboggplay/trunk/COPYING	                        (rev 0)
+++ liboggplay/trunk/COPYING	2008-08-05 12:09:38 UTC (rev 3689)
@@ -0,0 +1,29 @@
+   Copyright (C) 2003 CSIRO Australia
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions
+   are met:
+   
+   - Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+   
+   - Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+   
+   - Neither the name of the CSIRO nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+   
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
+   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

Added: liboggplay/trunk/ChangeLog
===================================================================
--- liboggplay/trunk/ChangeLog	                        (rev 0)
+++ liboggplay/trunk/ChangeLog	2008-08-05 12:09:38 UTC (rev 3689)
@@ -0,0 +1,3 @@
+2008-08-05  Silvia Pfeiffer <silvia at annodex dot net>
+
+	* Preparing for first release 0.0.1

Added: liboggplay/trunk/INSTALL
===================================================================
--- liboggplay/trunk/INSTALL	                        (rev 0)
+++ liboggplay/trunk/INSTALL	2008-08-05 12:09:38 UTC (rev 3689)
@@ -0,0 +1,182 @@
+Basic Installation
+==================
+
+   These are generic installation instructions.
+
+   The `configure' shell script attempts to guess correct values for
+various system-dependent variables used during compilation.  It uses
+those values to create a `Makefile' in each directory of the package.
+It may also create one or more `.h' files containing system-dependent
+definitions.  Finally, it creates a shell script `config.status' that
+you can run in the future to recreate the current configuration, a file
+`config.cache' that saves the results of its tests to speed up
+reconfiguring, and a file `config.log' containing compiler output
+(useful mainly for debugging `configure').
+
+   If you need to do unusual things to compile the package, please try
+to figure out how `configure' could check whether to do them, and mail
+diffs or instructions to the address given in the `README' so they can
+be considered for the next release.  If at some point `config.cache'
+contains results you don't want to keep, you may remove or edit it.
+
+   The file `configure.in' is used to create `configure' by a program
+called `autoconf'.  You only need `configure.in' if you want to change
+it or regenerate `configure' using a newer version of `autoconf'.
+
+The simplest way to compile this package is:
+
+  1. `cd' to the directory containing the package's source code and type
+     `./configure' to configure the package for your system.  If you're
+     using `csh' on an old version of System V, you might need to type
+     `sh ./configure' instead to prevent `csh' from trying to execute
+     `configure' itself.
+
+     Running `configure' takes awhile.  While running, it prints some
+     messages telling which features it is checking for.
+
+  2. Type `make' to compile the package.
+
+  3. Optionally, type `make check' to run any self-tests that come with
+     the package.
+
+  4. Type `make install' to install the programs and any data files and
+     documentation.
+
+  5. You can remove the program binaries and object files from the
+     source code directory by typing `make clean'.  To also remove the
+     files that `configure' created (so you can compile the package for
+     a different kind of computer), type `make distclean'.  There is
+     also a `make maintainer-clean' target, but that is intended mainly
+     for the package's developers.  If you use it, you may have to get
+     all sorts of other programs in order to regenerate files that came
+     with the distribution.
+
+Compilers and Options
+=====================
+
+   Some systems require unusual options for compilation or linking that
+the `configure' script does not know about.  You can give `configure'
+initial values for variables by setting them in the environment.  Using
+a Bourne-compatible shell, you can do that on the command line like
+this:
+     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
+
+Or on systems that have the `env' program, you can do it like this:
+     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+
+Compiling For Multiple Architectures
+====================================
+
+   You can compile the package for more than one kind of computer at the
+same time, by placing the object files for each architecture in their
+own directory.  To do this, you must use a version of `make' that
+supports the `VPATH' variable, such as GNU `make'.  `cd' to the
+directory where you want the object files and executables to go and run
+the `configure' script.  `configure' automatically checks for the
+source code in the directory that `configure' is in and in `..'.
+
+   If you have to use a `make' that does not supports the `VPATH'
+variable, you have to compile the package for one architecture at a time
+in the source code directory.  After you have installed the package for
+one architecture, use `make distclean' before reconfiguring for another
+architecture.
+
+Installation Names
+==================
+
+   By default, `make install' will install the package's files in
+`/usr/local/bin', `/usr/local/man', etc.  You can specify an
+installation prefix other than `/usr/local' by giving `configure' the
+option `--prefix=PATH'.
+
+   You can specify separate installation prefixes for
+architecture-specific files and architecture-independent files.  If you
+give `configure' the option `--exec-prefix=PATH', the package will use
+PATH as the prefix for installing programs and libraries.
+Documentation and other data files will still use the regular prefix.
+
+   In addition, if you use an unusual directory layout you can give
+options like `--bindir=PATH' to specify different values for particular
+kinds of files.  Run `configure --help' for a list of the directories
+you can set and what kinds of files go in them.
+
+   If the package supports it, you can cause programs to be installed
+with an extra prefix or suffix on their names by giving `configure' the
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+
+Optional Features
+=================
+
+   Some packages pay attention to `--enable-FEATURE' options to
+`configure', where FEATURE indicates an optional part of the package.
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE
+is something like `gnu-as' or `x' (for the X Window System).  The
+`README' should mention any `--enable-' and `--with-' options that the
+package recognizes.
+
+   For packages that use the X Window System, `configure' can usually
+find the X include and library files automatically, but if it doesn't,
+you can use the `configure' options `--x-includes=DIR' and
+`--x-libraries=DIR' to specify their locations.
+
+Specifying the System Type
+==========================
+
+   There may be some features `configure' can not figure out
+automatically, but needs to determine by the type of host the package
+will run on.  Usually `configure' can figure that out, but if it prints
+a message saying it can not guess the host type, give it the
+`--host=TYPE' option.  TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name with three fields:
+     CPU-COMPANY-SYSTEM
+
+See the file `config.sub' for the possible values of each field.  If
+`config.sub' isn't included in this package, then this package doesn't
+need to know the host type.
+
+   If you are building compiler tools for cross-compiling, you can also
+use the `--target=TYPE' option to select the type of system they will
+produce code for and the `--build=TYPE' option to select the type of
+system on which you are compiling the package.
+
+Sharing Defaults
+================
+
+   If you want to set default values for `configure' scripts to share,
+you can create a site shell script called `config.site' that gives
+default values for variables like `CC', `cache_file', and `prefix'.
+`configure' looks for `PREFIX/share/config.site' if it exists, then
+`PREFIX/etc/config.site' if it exists.  Or, you can set the
+`CONFIG_SITE' environment variable to the location of the site script.
+A warning: not all `configure' scripts look for a site script.
+
+Operation Controls
+==================
+
+   `configure' recognizes the following options to control how it
+operates.
+
+`--cache-file=FILE'
+     Use and save the results of the tests in FILE instead of
+     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
+     debugging `configure'.
+
+`--help'
+     Print a summary of the options to `configure', and exit.
+
+`--quiet'
+`--silent'
+`-q'
+     Do not print messages saying which checks are being made.  To
+     suppress all normal output, redirect it to `/dev/null' (any error
+     messages will still be shown).
+
+`--srcdir=DIR'
+     Look for the package's source code in directory DIR.  Usually
+     `configure' can determine that directory automatically.
+
+`--version'
+     Print the version of Autoconf used to generate the `configure'
+     script, and exit.
+
+`configure' also accepts some other, not widely useful, options.

Modified: liboggplay/trunk/README
===================================================================
--- liboggplay/trunk/README	2008-08-05 11:48:07 UTC (rev 3688)
+++ liboggplay/trunk/README	2008-08-05 12:09:38 UTC (rev 3689)
@@ -14,8 +14,12 @@
 
 For the core library (liboggplay), you need
 
-  * libogg, libvorbis, libspeex -- from http://www.xiph.org/
+  * libogg, libvorbis, libtheora, optionally libspeex -- from http://www.xiph.org/
 
+    svn co http://svn.xiph.org/trunk/ogg/ ogg
+    svn co http://svn.xiph.org/trunk/vorbis/ vorbis
+    svn co http://svn.xiph.org/trunk/theora/ theora
+
   * liboggz and libfishsound -- from svn.annodex.net:
 
     svn co http://svn.annodex.net/liboggz/trunk liboggz
@@ -28,15 +32,15 @@
 See the README files associated with these libraries for installation
 instructions.
 
-To build src/tests/glut-player, you need:
+To build src/examples/glut-player, you need:
   * The core liboggplay dependencies (listed above)
   * GLUT -- see http://www.opengl.org/resources/libraries/
 
-To build src/tests/dump-all-streams, you need:
+To build src/examples/dump-all-streams, you need:
   * The core liboggplay dependencies (listed above)
   * libsndfile -- from http://www.mega-nerd.com/libsndfile/
 
-To build src/tests/dump-first-frame, you need:
+To build src/tools/oggplay-dump-first-frame, you need:
   * The core liboggplay dependencies (listed above)
   * Imlib2 -- from your distribution or from 
               http://sourceforge.net/project/showfiles.php?group_id=2&package_id=11130

Modified: liboggplay/trunk/configure.ac
===================================================================
--- liboggplay/trunk/configure.ac	2008-08-05 11:48:07 UTC (rev 3688)
+++ liboggplay/trunk/configure.ac	2008-08-05 12:09:38 UTC (rev 3689)
@@ -6,7 +6,7 @@
 
 AC_CANONICAL_TARGET
 
-AM_INIT_AUTOMAKE(liboggplay, 0.0.1.svn)
+AM_INIT_AUTOMAKE(liboggplay, 0.0.1)
 AM_CONFIG_HEADER(config.h)
 
 SHARED_VERSION_INFO="1:0:0"

Added: liboggplay/trunk/release_notes/liboggplay-0.0.1.txt
===================================================================
--- liboggplay/trunk/release_notes/liboggplay-0.0.1.txt	                        (rev 0)
+++ liboggplay/trunk/release_notes/liboggplay-0.0.1.txt	2008-08-05 12:09:38 UTC (rev 3689)
@@ -0,0 +1,64 @@
+OggPlay 0.0.1 Release
+---------------------
+
+liboggplay is a C library providing a simple programming interface for reading,
+decoding and playing back Ogg files and streams. Ogg is an interleaving data
+container developed by Monty at Xiph.Org, originally to support the Ogg Vorbis
+audio format.
+
+This release is available as a source tarball at:
+
+http://www.annodex.net/software/liboggplay/download/liboggplay-0.0.1.tar.gz
+
+This is an initial release.
+
+The library is already in use by Mozilla to provide in-built support for
+Ogg Theora in the HTML5 <video> tag.
+
+About Oggplay
+-------------
+
+Oggplay comprises liboggplay and the command-line tool oggplay-info.
+
+What is liboggplay designed to do?
+
+There are several layers to a typical ogg playing application:
+(1) Parsing of the ogg container format (handled by libogg and made usable by 
+    liboggz) and routing of packets
+(2) Decoding of individual ogg packets (handled by libtheora, libvorbis, 
+    libfishsound, libcmml, etc. depending on contents)
+(3) Maintenance of synchronisation between individual raw data streams
+(4) Presentation of raw data to the user (via the screen / sound card / etc.)
+
+liboggplay handles the first 3 layers for you, leaving just the actual 
+presentation for the application writer.
+
+Full documentation of the liboggplay API, customization and installation,
+and mux and demux examples can be read online at:
+
+    http://www.annodex.net/software/liboggplay/doc/liboggplay.txt
+
+Tools
+-----
+
+The Oggplay source tarball also contains the following command-line tools,
+which are useful for debugging and testing Ogg bitstreams:
+
+	* oggplay-info: Reads all tracks in a Ogg file, prints the total number
+	  of frames of the Theora track and prints some decoding analysis info
+	  per track.
+	
+License
+-------
+
+Oggplay is Free Software, available under a BSD style license.
+
+More information is available online at the Oggplay homepage:
+
+    http://www.annodex.net/software/liboggplay/
+
+enjoy :)
+
+--
+The Annodex Team
+http://www.annodex.net/



More information about the commits mailing list