[xiph-cvs] cvs commit: positron/doc pai.html database.html neuros.html sai.html
Stan Seibert
volsung at xiph.org
Mon May 26 07:08:44 PDT 2003
volsung 03/05/26 10:08:44
Modified: doc database.html neuros.html sai.html
Added: doc pai.html
Log:
Even more docs.
Revision Changes Path
1.4 +6 -16 positron/doc/database.html
Index: database.html
===================================================================
RCS file: /usr/local/cvsroot/positron/doc/database.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- database.html 26 May 2003 05:03:57 -0000 1.3
+++ database.html 26 May 2003 14:08:44 -0000 1.4
@@ -1,11 +1,6 @@
<html>
<head>
- <style type="text/css">
- table.fielddef, table.fielddef td,
- table.fielddef th{border: 2px black solid; border-collapse: collapse;}
- td.nodata {background-color: rgb(80%, 80%, 80%)}
- h4 {margin-top: 3em}
- </style>
+ <link rel="stylesheet" type="text/css" href="style.css" />
<title>Positron Documentation: Working with the Database</title>
</head>
@@ -140,8 +135,7 @@
primary field (also a null-terminated string).
</p>
-<a name="audio"/>
-<h4>audio</h4>
+<h4 id="audio">audio</h4>
<table class="fielddef">
<tr><th>#</th><th>Name</th><th>Type</th><th width="70%">Description</th></tr>
@@ -157,8 +151,7 @@
<tr><td>8</td><td>Path</td><td>sz</td><td>Path to track on Neuros filesystem. Follows path conventions specified in the Overview. </td></tr>
</table>
-<a name="pcaudio"/>
-<h4>pcaudio</h4>
+<h4 id="pcaudio">pcaudio</h4>
<table class="fielddef">
<tr><th>#</th><th>Name</th><th>Type</th><th width="70%">Description</th></tr>
@@ -174,8 +167,7 @@
<tr><td>8</td><td>Path</td><td>sz</td><td>Path to track on host PC filesystem.</td></tr>
</table>
-<a name="unidedhisi">
-<h4>unidedhisi</h4>
+<h4 id="unidedhisi">unidedhisi</h4>
<table class="fielddef">
<tr><th>#</th><th>Name</th><th>Type</th><th width="70%">Description</th></tr>
@@ -185,8 +177,7 @@
conventions specified in the Overview. </td></tr>
</table>
-<a name="idedhisi">
-<h4>idedhisi</h4>
+<h4 id="idedhisi">idedhisi</h4>
<table class="fielddef">
<tr><th>#</th><th>Name</th><th>Type</th><th width="70%">Description</th></tr>
@@ -204,8 +195,7 @@
conventions specified in the Overview. </td></tr>
</table>
-<a name="failedhisi">
-<h4>failedhisi</h4>
+<h4 id="failedhisi">failedhisi</h4>
<p>Field definitions are the same as unidedhisi.</p>
<p><p>1.5 +9 -9 positron/doc/neuros.html
Index: neuros.html
===================================================================
RCS file: /usr/local/cvsroot/positron/doc/neuros.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- neuros.html 26 May 2003 04:43:34 -0000 1.4
+++ neuros.html 26 May 2003 14:08:44 -0000 1.5
@@ -79,15 +79,15 @@
<p>
Because the Neuros appears as a standard external hard drive when
attached to the host computer, any type of file can be stored on it,
-regardless of whether it is a recognized audio file format or not.
-Rather than spend extra time dynamically generating a list of
-available music files, a database of music files is maintained on the
-device. Only those files listed in the database will be made
-available for playback. The database also provides the ability to
-index files based upon the contents of various fields in the database,
-like artist or genre. It is the job of the synchronization program
-running on the host computer to update the database to reflect changes
-in the list of files available for playback.
+regardless of whether it is a recognized audio file format. Rather
+than spend extra time dynamically generating a list of available music
+files, a database of music files is maintained on the device. Only
+those files listed in the database will be made available for
+playback. The database also provides the ability to index files based
+upon the contents of various fields in the database, like artist or
+genre. It is the job of the synchronization program running on the
+host computer to update the database to reflect changes in the list of
+files available for playback.
</p>
<p>
<p><p>1.2 +11 -10 positron/doc/sai.html
Index: sai.html
===================================================================
RCS file: /usr/local/cvsroot/positron/doc/sai.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sai.html 26 May 2003 04:43:34 -0000 1.1
+++ sai.html 26 May 2003 14:08:44 -0000 1.2
@@ -1,5 +1,6 @@
<html>
<head>
+ <link rel="stylesheet" type="text/css" href="style.css" />
<title>Positron Documentation: SAI File Format</title>
</head>
<body>
@@ -17,26 +18,26 @@
A record in a SAI file consists of a pointer to a MDB record, and to
its associated PAI module (if applicable). The pointer to the PAI
module does not point to the start of the module, however, but to the
-location of the <emph>first entry within the module</emph>. See the
+location of the <em id="caveat">first entry within the module</em>. See the
<a href="pai.html">PAI file format</a> for more information.
</p>
-<table>
+<table class="fielddef">
<tr><th>Word Offset</th><th>Size (words)</th><th>Description</th></tr>
-<tr><td>0</td><td>2</td><td>Signature, "0x05181971"</td><tr>
-<tr><td>2</td><td>2</td><td>Reserved (zero by default)</td><tr>
-<tr><td>4</td><td>1</td><td>Number of entries (N)</td><tr>
-<tr><td>5</td><td>3</td><td>Reserved (zero by default) </td><tr>
-<tr><td>8</td><td>4</td><td>0x00000000, 0x00000000 (looks like an empty record)</td><tr>
+<tr><td>0</td><td>2</td><td>Signature, "0x05181971"</td></tr>
+<tr><td>2</td><td>2</td><td>Reserved (zero by default)</td></tr>
+<tr><td>4</td><td>1</td><td>Number of entries (N)</td></tr>
+<tr><td>5</td><td>3</td><td>Reserved (zero by default) </td></tr>
+<tr><td>8</td><td>4</td><td>0x00000000, 0x00000000 (looks like an empty record)</td></tr>
<tr><td>12</td><td>2</td><td>MDB pointer for record 0</td></tr>
<tr><td>14</td><td>2</td><td>PAI pointer for record 0</td></tr>
<tr><td>...</td><td>...</td><td>...</td></tr>
<tr><td>12+4*i</td><td>2</td><td>MDB pointer for record i</td></tr>
<tr><td>14+4*i</td><td>2</td><td>PAI pointer for record i</td></tr>
<tr><td>...</td><td>...</td><td>...</td></tr>
-<tr><td>12+4*N</td><td>2</td><td>MDB pointer for record N</td></tr>
-<tr><td>14+4*N</td><td>2</td><td>PAI pointer for record N</td></tr>
-<tr><td>12+4(N+1)</td><td>4</td><td>0x00000000, 0x00000000 (looks like an empty record)</td></tr>
+<tr><td>12+4*(N-1)</td><td>2</td><td>MDB pointer for record N</td></tr>
+<tr><td>14+4*(N-1)</td><td>2</td><td>PAI pointer for record N</td></tr>
+<tr><td>12+4*N</td><td>4</td><td>0x00000000, 0x00000000 (looks like an empty record)</td></tr>
</table>
</body>
<p><p>1.1 positron/doc/pai.html
Index: pai.html
===================================================================
<html>
<head>
<link rel="stylesheet" type="text/css" href="style.css" />
<title>Positron Documentation: PAI File Format</title>
</head>
<body>
<h1>PAI File Format</h1>
<p>
This document explains the format of the PAI files. PAI files are
used in child databases to index the parent database. Each child
database has a PAI file containing one module for each record, deleted
or not. The module contains an entry for each record in the parent
database that has an access key corresponding to the record in the
child database. For example, the "Rock" record in the Genre child
database has an associated PAI module, which contains entries for each
song in the parent database in the "Rock" genre. This allows the
Neuros to quickly display all of the tracks in a particular category
quickly.
</p>
<p>
A record in a SAI file consists of a pointer to a MDB record, and to
its associated PAI module (if applicable). The pointer to the PAI
module does not point to the start of the module, however, but to the
location of the <emph>first entry within the module</emph>. See the
<a href="pai.html">PAI file format</a> for more information.
</p>
<table class="fielddef">
<tr><th>Word Offset</th><th>Size (words)</th><th>Description</th></tr>
<tr><td>0</td><td>2</td><td>Signature, "0x01162002"</td></tr>
<tr><td>2</td><td>6</td><td>Reserved (zero by default)</td></tr>
<tr><td>8</td><td>...</td><td>Module #1</td></tr>
<tr><td>...</td><td>...</td><td>...</td></tr>
<tr><td>...</td><td>...</td><td>Module #N</td></tr>
</table>
<h2>PAI Module</h2>
<table class="fielddef">
<tr><th>Word Offset</th><th>Size (words)</th><th>Description</th></tr>
<tr><td>0</td><td>1</td><td>Size of this module in words (including this one).
Note that the length of a PAI module must be multiple of 32 words. (M)</td></tr>
<tr><td>1</td><td>1</td><td>
16-bit flag describing the state of the module
<ul>
<li>Bit 0 = 0 if module contains at least one valid entry, 1 if module is empty</li>
<li>Bits 1-15 = Reserved (0 by default)
</u>
</td><tr>
<tr><td>2</td><td>1</td><td>Total number of entries (N)</td></tr>
<tr><td>3</td><td>3</td><td>Reserved (0 by default)</td></tr>
<tr><td>6</td><td>2</td><td>Pointer to beginning of a MDB record. (Note: the
PAI pointer in the SAI record associated with
this whole module points to this word.)</td></tr>
<tr><td>...</td><td>...</td><td>...</td></tr>
<tr><td>6+2*(N-1)</td><td>2</td><td>Pointer to beginning of a MDB record.</td></tr>
<tr><td>...</td><td>...</td><td>Empty entries are marked with zeros</td></tr>
<tr><td>M-2</td><td>2</td><td>Zeros, to mark the end of the module</td></tr>
</table>
</body>
</html>
<p><p>--- >8 ----
List archives: http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body. No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.
More information about the commits
mailing list