seal 0.1.0

data/mpg123/doc/ROAD_TO_LGPL

@@ -0,0 +1,270 @@
+The License of mpg123
+=====================
+
+	by Thomas Orgis <thomas@orgis.org>
+
+1. Story: The Odyssey, The Decision
+-----------------------------------
+
+This is the 17th of July in the year 2006, after half a year of preparation and the contributor email campaign running for over 3 months, I'm going to draw a conclusion about the licensing of the mpg123 project.
+
+
+The license conditions of mpg123 have been subject to dispute and rejection by parts of the free software world in the past...
+We want to have it straight now.
+Michael doesn't have much freetime to maintain the code and bother with requests by companies wanting to use mpglib.
+So, he already decided to place mpglib under LGPL and mpg123 under GPL in the past.
+Now, after I applied for taking over maintainership we decided on placing as much code of the whole project as possible under LGPL to ease future code migration and merging between mpg123 and mpglib.
+
+That decision was followed by a lot of work to track down as many contributors to both Michael's development tree and my -thor one as possible to ask them for explicit LGPL support statements.
+I wrote to every Name/eMail address I could track down (including internet search for new addresses), regardless of the question if there indeed is some code left by that person.
+I asked them to utter any problem they may have with LGPL license as well as contacting me if there are _no_ issues.
+
+Of course, without having to ask again, supporters of LGPL are the initial author and the two current maintainers:
+
+	Michael Hipp
+	Nicholas J. Humfrey
+	Thomas Orgis
+
+Also, new stuff was included with explicit LGPL permission from
+
+	Adrian Bacon
+	Romain Dolbeau
+	Guillaume Outters
+
+Plus there is stuff pending with permission from
+
+	Zuxy Meng
+
+Now for the folks having made suggestions and contributions over the years...
+In the first round starting in March 2006 I wrote the initial mail to anyone I could get. That resulted in some positive responses - examples:
+
+	"I don't remember what I did, but LGPL is fine by me."
+
+	"No problem for me."
+
+	"Any code I may have contributed to the mpg123 project at any time in the
+past are hereby licensed to you under the GNU Lesser General Public"
+
+	"it's fine with me if mpg123 goes LGPL. 
+	However, my contribution to mpg123 was very minor, and I'm not even sure if 
+	any of my code is still in the current version."
+
+A good number of eMail addresses is just broken (years have passed...) and another good number of addresses are either totally unknown or not known to be good or bad since no response (not even bounce - thanks, spam!) came back in over 3 months.
+
+Some statistics for the first run: 86 total , 15 positive, 37 broken email, 34 unknown
+
+Positive:
+	Andreas Neuhaus
+	Chris Butler
+	Colin Watson
+	Daniel Kobras
+	Daniel O'Connor
+	Daniel Skarda
+	Erik B. Andersen
+	Helge Deller
+	Juergen Schoew
+	Martin Denn
+	Munechika SUMIKAWA
+	Oliver Fromme
+	Petr Stehlik
+	Robert Bihlmeyer
+	Samuel Audet
+	Shane Wegner
+	Stefan Bieschewski
+	Steven Schultz
+	Tillmann Steinbrecher
+	Tomas Oegren
+	Tommi Virtanen
+
+Then, an investigation of the code revealed a core of people having actually left traces in the code.
+Some more effort was put in tracking them down, with the partial success of having found some new, working email addresses and thus having some more positive responses .
+But also, it showed that the main number of people is not reachable anymore.
+
+Creators (of a whole file, driver...): 16 total, 5 positive, 2 broken email, 9 unknown
+
+Positive:
+	Andreas Neuhaus
+	Juergen Schoew
+	Oliver Fromme
+	Petr Stehlik
+	Samuel Audet
+
+Modders: 7 total, 1 positive, 2 broken mail, 4 unknown
+
+Positive:
+	Tomas Oegren
+
+
+That shows two things:
+
+	1. It's impossible to get a response from everyone having contributed in some way.
+	2. Everyone who I reached supports the license change to LGPL
+
+
+So, for the sake of getting a reasonable step forward, I'm going to close the case.
+There are three categories of code:
+
+1. written by Michael or some other contributor who explicitly supports LGPL
+
+	Clear case: LGPL
+
+2. contributed years ago without license notice
+
+	The grounded assumption of can be made that the contributor accepted Michael's conditions, esp. the part about the software being available without cost.
+	Furthermore they gave the code into Michael's hands or placed patches in the internet without any claims concerning commercial uses - wich were not covered by the old COPYING file.
+	Based on the assumption of acceptance for the mpg123 COPYING file and the included rule of Michael's decision for any further use, this code is to be placed under LGPL by Michael's decision.
+
+3. contributed with notice
+
+	Some code includes a note about it being GPL. Well, one has to respect that.
+
+
+That results in the bulk of mpg123 being LGPL and possibly some parts GPL only.
+
+
+2. The Inventory
+----------------
+
+I will now examine the files of the mpg123 svn trunk as of 17.07.2006 with their respective legal status:
+
+Stuff added by current maintainers, thus being LGPL:
+
+	scripts/debugdef.pl
+	AUTHORS
+	autogen.sh
+	configure.ac
+	Makefile.am
+	MakeLegacy.sh
+	src/audio_jack.c
+	src/audio_libao.c
+	src/Makefile.am
+	src/audio_alsa09.c
+	src/config.h.legacy
+	src/debug.h
+	src/layer3.h
+
+Non-Code files from Michael, maintainers or just trivial content (safely LGPL, then):
+
+	BENCHMARKING
+	BUGS
+	CHANGES
+	equalize.dat
+	INSTALL
+	mpg123.1
+	COPYING
+	TODO
+	README
+	README.3DNOW
+	README.cfa
+	README.new
+	README.remote
+	README.thor
+	README.WIN32
+	test.pl
+	BENCHMARKING.thor
+	CONTACT
+
+sources under LGPLv2.1:
+
+by Michael:
+
+	audio.c
+	audio_dummy.c
+	audio.h
+	audio_hp.c
+	audio_oss.c
+	audio_sun.c
+	common.c
+	common.h
+	dct64.c
+	dct64_i386.c
+	decode_2to1.c
+	decode_4to1.c
+	decode.c
+	decode_i386.c
+	decode_ntom.c
+	Makefile.legacy
+	equalizer.c 
+	getbits.c
+	getbits.h
+	huffman.h
+	l2tables.h
+	layer1.c
+	layer2.c
+	layer3.c
+	mpg123.c
+	mpg123.h
+	readers.c
+	system.c
+	tabinit.c
+	term.c
+	term.h
+
+by contributors:
+
+	audio_aix.c: Juergen Schoew, Tomas Oegren, Niklas Edmundsson
+	audio_alib.c: Erwan Ducroquet
+	audio_esd.c: Eric B. Mitchell
+	audio_macosx.c: Guillaume Outters
+	audio_mint.c: Petr Stehlik
+	audio_nas.c: Martin Denn
+	audio_os2.c: Samuel Audet
+	audio_sgi.c: Thomas Woerner
+	audio_win32.c: Tony Million 
+	buffer.c: Oliver Fromme
+	buffer.h: Daniel Kobras / Oliver Fromme
+	control_generic.c: Andreas Neuhaus, Michael Hipp, Thomas Orgis
+	dct36_3dnow.s: Syuuhei Kashiyama
+	dct64_3dnow.s: Syuuhei Kashiyama
+	dct64_altivec.c: Romain Dolbeau
+	dct64_i486.c: Fabrice Bellard
+	decode_3dnow.s: Syuuhei Kashiyama
+	decode_i486.c: Fabrice Bellard
+	decode_i586_dither.s: Stefan Bieschewski, Adrian Bacon
+	decode_i586.s: Stefan Bieschewski
+	decode_MMX.s: higway
+	dct64_MMX.s: higway
+	tabinit_MMX.s: higway
+	equalizer_3dnow.s: KIMURA Takuhiro
+	genre.h: Shane Wegner
+	getcpuflags.s: KIMURA Takuhiro
+	getlopt.c: Oliver Fromme
+	getlopt.h: Oliver Fromme
+	httpget.c: Oliver Fromme
+	wav.c: Samuel Audet
+	xfermem.c: Oliver Fromme
+	xfermem.h: Oliver Fromme
+	Makefile.win32: Michael Hipp / Tony Million
+
+GPLv2
+
+	audio_alsa.c: by Anders Semb Hermansen, Jaroslav Kysela, Ville Syrjala
+
+
+To be removed from distribution and thus not licensed in any special way:
+
+precompiled/
+tools/
+
+The mpglib source is not part of the core mpg123 distribution anymore - it's written by Michael, it's LGPL, it shall become a real library with own distribution and be married to mpg123 again.
+
+
+3. Conclusion
+-------------
+
+The decoder core Michael's work and under LGPL without question.
+Oliver Fromme is more of a co-author than "just" a project contributor, but he explicitly agreed to LGPL anyway.
+So, the core functionality is really safe without doubt.
+
+Contributors added mainly output drivers (perhaps coming from some freely available reference implementation) and CPU optimizations.
+Having explicit permission from a good deal of major contributors, the LGPL is quite comfortable here, too.
+I won't hide that there are explicit statements missing for MMX and 3DNow! optimizations (and the i486 opt, for that matter) due to unreachable authors.
+But I feel safe to make it LGPL there, too, because of the argument of them having given the code to Michael to incorporate it into mpg123 - without any own terms, implying that they agree to Michael's terms.
+
+There is one file left that carries an explicit GPL (_no_ LGPL) statement: the old alsa output. This file won't work on current Linux systems, anyway.
+Alsa is available through libao. There will probably be a new alsa output.
+So, even that one GPL exception may vanish in future, but I'll keep it for now as there may be someone who still has an alsa installation for that it works.
+
+For now that means mpg123 is LGPL with the exception of one file that is GPL only.
+
+End.

data/mpg123/doc/THANKS

@@ -0,0 +1,13 @@
+There are authors who write code and there are people who point us to what code to write, show us our errors and generally are trying hard to compensate the time the developers spent coding and not actually using the software.
+These people are very valuable, indeed - let's thank our
+
+Testers (alphapetical):
+
+- Gabor Z. Papp
+- "Gates Fan"
+- JonY
+- Serge Simon and the R.O.M. 106.5 FM Team (http://www.rom.lu/)
+   who motivated the --loop and --timeout modes and furthermore supported the maintainer with a donation on sf.net and a real bottle of wine from Luxembourg!
+- Willy Tarreau
+
+Heck, let's thank all of you who contributed bug reports, suggestions... those who took mpg123 source and compiled it on uncommon platforms.

data/mpg123/doc/TODO

@@ -0,0 +1,63 @@
+We badly need:
+ - header reorganization (lots of stuff don't belong to mpg123.h)
+ - integer type safety - STOP using ints where size_t or at least long would be appropriate (expecially stream readers)
+ - sprintf -> snprintf (maybe with switch to support ancient libc; or replacement by us)
+ - rewrite httpget.c; that thing has been a can of bugs for years and I understand why when I look at it (way too many cooks)
+ - really parse ID3V2 tags instead of skipping; done for RVA values... using the string info (just?) needs some Unicode/Locale handling
+ - check support for fixed point arithmentic; generic_nofpu seems wo work generally, but resampling does not sound nice
+
+From Nicholas: 
+ - Seperate out MPEG Audio decoder (only) into seperate library
+ - Allow choice of audio output at runtime, rather than compile time
+ - Choose processor optimization at runtime, rather than compile time?
+ 
+From Michael (some time after/around pre-0.59s):
+
+- add CRC check.
+- add 'free format stream' support.
+- optimize layer2.c:
+   step_two: fraction as pointer .. 
+   process first channel 0 than channel 1
+   copy channel 0 to channel 1 for: i >= jsbound
+- better frame reader .. especially for layer 3 - DONE by a good deal by Thomas
+- MPEG system stream decoder
+- check again layer1 !! (Layer-1 support not heavily tested ..)
+  Problems with Layer1 fl7 reference stream
+- Write a special (optimized) 'single channel' decode.
+- optimized dct64 for down sampling modes
+- native audio support for AIX and DEC
+- update manpage
+- optimizations for downsampling modes on layer2 and layer1
+
+MORE TODO: (partially done)
+---------------------------
+
+A few notes on how mpg123 tries to select a 'good' 
+audio encoding and frequency. (not full implemented yet!!)
+
+- mpg123 tries to set the settings you specify on the command line
+  in the order of its appearence (exclusiv .. no fallback then)
+  (-r <rate>, --mono, --stereo, --8bit, etc )
+
+- after this, mpg123 tries to set 
+    1. the number of channels (or fallback to mono if stereo isn't possible)
+    2. the audioformat to 16 bit (or fallback to 8bit)
+    3. the "best" frequency: (in this order)
+        - the exact stream frequency or fallback to
+        - 2:1 frequency or fallback to
+        - 4:1 frequency or try the
+        - nearest frequency lower than the frequency of your stream
+       mpg123 automagically converts the rate. 
+
+So, if you think (or even know), that your hardware supports a higher
+frequency only with eg. mono,8bit you must force mpg123 to play mono 
+and 8bit. ("--8bit -m") etc....
+
+If you wanna a constant format eg to output the data to stdout you 
+must explicit force it with eg: '-r 44100 --stereo'
+Else the format will be the format of the mpeg stream.
+
+       
+
+
+

data/mpg123/doc/doxy_examples.c

@@ -0,0 +1,21 @@
+/** \defgroup mpg123_examples example programs using libmpg123
+	@{ */
+
+/** \file mpg123_to_wav.c A simple MPEG audio to WAV converter using libmpg123 (read) and libsndfile (write).
+    ...an excersize on two simple APIs. */
+
+/** \file mpglib.c Example program mimicking the old mpglib test program.
+	It takes an MPEG bitstream from standard input and writes raw audio to standard output.
+	This is an use case of the mpg123_decode() in and out function in the feeder mode, quite close to classic mpglib usage and thus a template to convert from that to libmpg123.
+*/
+
+/** \file scan.c Example program that examines the exact length of an MPEG file.
+    It opens a list of files and does mpg123_scan() on each and reporting the mpg123_length() before and after that. */
+
+/** \file id3dump.c Parse ID3 info and print to standard output. */
+
+/** \file extract_frames.c Parse stream and extract only the valid MPEG frames to standard output. */
+
+/** \file feedseek.c Fuzzy feeder seeking. */
+
+/* @} */

data/mpg123/doc/doxygen.conf

@@ -0,0 +1,41 @@
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+
+PROJECT_NAME			= "libmpg123"
+OUTPUT_DIRECTORY		= .
+CREATE_SUBDIRS			= NO
+OUTPUT_LANGUAGE			= English
+FULL_PATH_NAMES			= NO
+
+INPUT					= doxy_examples.c examples/mpg123_to_wav.c examples/mpglib.c examples/scan.c examples/feedseek.c examples/id3dump.c ../src/libmpg123/mpg123.h
+OPTIMIZE_OUTPUT_FOR_C	= YES
+EXTRACT_ALL				= NO
+HIDE_UNDOC_MEMBERS		= NO
+QUIET					= YES
+WARNINGS				= YES
+SOURCE_BROWSER = YES
+
+GENERATE_HTML			= YES
+HTML_OUTPUT				= html
+DISABLE_INDEX			= YES
+SORT_MEMBER_DOCS		= NO
+SORT_BRIEF_DOCS			= NO
+ENUM_VALUES_PER_LINE	= 2
+
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+PREDEFINED             = EXPORT=
+
+GENERATE_HTML			= YES
+GENERATE_LATEX			= NO
+GENERATE_RTF			= NO
+GENERATE_MAN			= YES
+MAN_LINKS				= YES
+GENERATE_XML			= NO
+
+HTML_HEADER = doxyhead.xhtml
+HTML_FILE_EXTENSION = .shtml

data/mpg123/doc/doxyhead.xhtml

@@ -0,0 +1,12 @@
+<!--#include virtual="../header.html" -->
+<title>$title</title>
+<link href="/doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<!--#include virtual="../linkbar.html" -->
+<div style="padding:1em;">
+	<strong>Note:</strong>
+	This API doc is automatically generated from the current development version that you can get via Subversion or as a daily snapshot from <a href="http://mpg123.org/snapshot">http://mpg123.org/snapshot</a>.
+	There may be differences (additions) compared to the latest stable release. See <a href="http://mpg123.org/cgi-bin/viewvc.cgi/trunk/NEWS.libmpg123?view=markup">NEWS.libmpg123</a> and the overall <a href="http://mpg123.org/cgi-bin/viewvc.cgi/trunk/NEWS?view=markup">NEWS</a> file on libmpg123 versions and important changes between them.<br />
+	Let me emphasize that the policy for libmpg123 is to always stay backwards compatible -- only <em>additions</em> are planned (and it's not yet planned to change the plans;-).
+</div>

data/mpg123/doc/examples/dump_seekindex.c

@@ -0,0 +1,41 @@
+/*
+	dump_seekindex: Scan a mpeg file and dump its seek index.
+
+	copyright 2010 by the mpg123 project - free software under the terms of the LGPL 2.1
+	see COPYING and AUTHORS files in distribution or http://mpg123.org
+	initially written by Patrick Dehne
+*/
+
+#include <mpg123.h>
+#include <stdio.h>
+
+int main(int argc, char **argv)
+{
+	mpg123_handle *m;
+	off_t* offsets;
+	off_t step;
+	size_t fill, i;
+
+	if(argc != 2)
+	{
+		fprintf(stderr, "\nI will dump the frame index of an MPEG audio file.\n");
+		fprintf(stderr, "\nUsage: %s <mpeg audio file>\n\n", argv[0]);
+		return -1;
+	}
+	mpg123_init();
+	m = mpg123_new(NULL, NULL);
+	mpg123_param(m, MPG123_RESYNC_LIMIT, -1, 0);
+	mpg123_param(m, MPG123_INDEX_SIZE, -1, 0);
+	mpg123_open(m, argv[1]);
+	mpg123_scan(m);
+
+	mpg123_index(m, &offsets, &step, &fill);
+	for(i=0; i<fill;i++) {
+		printf("Frame number %d: file offset %d\n", i * step, offsets[i]);
+	}
+
+	mpg123_close(m);
+	mpg123_delete(m);
+	mpg123_exit();
+	return 0;
+}