summaryrefslogtreecommitdiff
path: root/doc/diff.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/diff.html')
-rw-r--r--doc/diff.html67
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/diff.html b/doc/diff.html
new file mode 100644
index 0000000..ae0b908
--- /dev/null
+++ b/doc/diff.html
@@ -0,0 +1,67 @@
+<html>
+
+<head>
+<title>Tremor - Vorbisfile Differences</title>
+<link rel=stylesheet href="style.css" type="text/css">
+</head>
+
+<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
+<table border=0 width=100%>
+<tr>
+<td><p class=tiny>Tremor documentation</p></td>
+<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
+</tr>
+</table>
+
+<h1>Tremor / Vorbisfile API Differences</h1>
+
+<p>
+
+The Tremor libvorbisidec library exposes an API intended to be as
+similar as possible to the familiar 'vorbisfile' library included with
+the open source Vorbis reference libraries distributed for free by
+Xiph.org. Differences are summarized below.<p>
+
+<h2>OggVorbis_File structure</h2>
+
+The <tt>bittrack</tt> and <tt>samptrack</tt> fields in the <a
+href="OggVorbis_File.html">OggVorbis_File</a> structure are changed to
+64 bit integers in Tremor, from doubles in vorbisfile.
+
+<h2>Time-related seek and tell function calls</h2>
+
+The <a href="ov_time_total.html">ov_time_total()</a> and <a
+href="ov_time_tell.html">ov_time_tell()</a> functions return milliseconds as
+64 bit integers in Tremor. In vorbisfile, these functions returned
+seconds as doubles.<p>
+
+In Tremor, the <a href="ov_time_seek.html">ov_time_seek()</a> and <a
+href="ov_time_seek_page.html">ov_time_seek_page()</a> calls take
+seeking positions in milliseconds as 64 bit integers, rather than in
+seconds as doubles as in Vorbisfile.<p>
+
+<h2>Reading decoded data</h2>
+
+Tremor <a href="ov_read.html">ov_read()</a> always returns data as
+signed 16 bit interleaved PCM in host byte order. As such, it does not
+take arguments to request specific signedness, byte order or bit depth
+as in Vorbisfile.<p>
+
+Tremor does not implement <tt>ov_read_float()</tt>.<p>
+
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
+</tr><tr>
+<td><p class=tiny>Tremor documentation</p></td>
+<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
+</tr>
+</table>
+
+</body>
+
+</html>