[xiph-commits] r16801 - in trunk/ao: doc include/ao

[xiphmont at svn.xiph.org]

Author: xiphmont
Date: 2010-01-24 08:52:06 -0800 (Sun, 24 Jan 2010)
New Revision: 16801

Modified:
   trunk/ao/doc/ao_device.html
   trunk/ao/include/ao/ao_private.h
Log:
continue API treaks for channel matrixing


Modified: trunk/ao/doc/ao_device.html
===================================================================
--- trunk/ao/doc/ao_device.html	2010-01-24 16:49:45 UTC (rev 16800)
+++ trunk/ao/doc/ao_device.html	2010-01-24 16:52:06 UTC (rev 16801)
@@ -17,59 +17,19 @@
 
 <p><i>declared in "ao/ao.h";</i></p>
 
-<p>This structure holds all of the data for an open device.
+<p>This structure holds all of the data for an open device.  
 
 <br><br>
 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>
         <td>
-<pre><b>typedef struct {
-  int  type; /* live output or file output? */
-  int  driver_id;
-  ao_functions *funcs;
-  FILE *file; /* File for output if this is a file driver */
-  int  client_byte_format;
-  int  machine_byte_format;
-  int  driver_byte_format;
-  char *swap_buffer;
-  int  swap_buffer_size; /* Bytes allocated to swap_buffer */
-  void *internal; /* Pointer to driver-specific data */
-} ao_device;</b></pre>
+<pre><b>typedef struct ao_device ao_device;</b></pre>
         </td>
 </tr>
 </table>
 
 <h3>Relevant Struct Members</h3>
-<dl>
-<dt><i>type</i></dt>
-<dd>The output type of the driver:
-<ul>
-<li>AO_TYPE_LIVE - Live output.</li>
-<li>AO_TYPE_FILE - File output.</li>
-</ul>
-</dd>
-<dt><i>driver_id</i></dt>
-<dd>The ID number for the driver used with this device.</dd>
-<dt><i>funcs</i></dt>
-<dd>Function table for the driver associated with this device.</dd>
-<dt><i>client_byte_format</i></dt>
-<dd>The byte format (use constants from 
-<a href="ao_sample_format.html">ao_sample_format</a>) of samples provided by
-the client to <a href="ao_sample_format.html">ao_play()</a>.
-</dd>
-<dt><i>machine_byte_format</i></dt>
-<dd>The native byte format of the computer.  Will be either
-<tt>AO_FMT_BIG</tt> or <tt>AO_FMT_LITTLE</tt>.
-</dd>
-<dt><i>driver_byte_format</i></dt>
-<dd>The byte format of samples requested by
-the driver.
-</dd>
-<dt><i>swap_buffer</i></dt>
-<dd>Scratch buffer used to swap the byte order of samples.  Only allocated
-if <tt>client_byte_format</tt> and <tt>driver_byte_format</tt> correspond to
-different byte orders, otherwise set to NULL</dd>
-</dl>
+None; the ao_device structure is opaque as of release 0.9.0.
 
 <br><br>
 <hr noshade>

Modified: trunk/ao/include/ao/ao_private.h
===================================================================
--- trunk/ao/include/ao/ao_private.h	2010-01-24 16:49:45 UTC (rev 16800)
+++ trunk/ao/include/ao/ao_private.h	2010-01-24 16:52:06 UTC (rev 16801)
@@ -73,7 +73,7 @@
 	int  driver_byte_format;
 	char *swap_buffer;
 	int  swap_buffer_size; /* Bytes allocated to swap_buffer */
-        int  *output_channels;
+        char *output_matrix;
         int  *permute_channels;
 	void *internal; /* Pointer to driver-specific data */
 };