Sat Aug 4 19:35:35 PDT 2001

volsung     01/08/04 19:35:35

  Modified:    .        CHANGES README TODO
               doc      ao_append_option.html ao_close.html
                        ao_default_driver_id.html ao_device.html
                        ao_driver_id.html ao_driver_info.html
                        ao_driver_info_list.html ao_free_options.html
                        ao_info.html ao_initialize.html ao_open_file.html
                        ao_open_live.html ao_option.html ao_play.html
                        ao_plugin_close.html ao_plugin_device_clear.html
                        ao_plugin_device_init.html
                        ao_plugin_driver_info.html ao_plugin_open.html
                        ao_plugin_play.html ao_plugin_set_option.html
                        ao_plugin_test.html ao_sample_format.html
                        ao_shutdown.html config.html drivers.html
                        index.html libao-api.html overview.html
                        plugin-api.html plugin-overview.html
  Log:
  Documentation update.

Revision  Changes    Path
1.4       +8 -0      ao/CHANGES

Index: CHANGES
===================================================================
RCS file: /usr/local/cvsroot/ao/CHANGES,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4

--- CHANGES	2000/12/17 20:28:33	1.3
+++ CHANGES	2001/08/05 02:35:29	1.4
@@ -1,3 +1,11 @@
+0.8.0 - August 2000
+- Major API rewrite.  Old apps and plugins will not work with this library!
+- Default driver detection now works.
+- /etc/libao.conf and ~/.libao config files now supported
+
+0.7.0 - June 2000
+- minor build fixes for different platforms
+
 0.6.0 - December 2000
 - slight api modification with ao_append_option()
 - fixed an option leak

1.4       +4 -6      ao/README

Index: README
===================================================================
RCS file: /usr/local/cvsroot/ao/README,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- README	2000/12/17 20:28:33	1.3
+++ README	2001/08/05 02:35:29	1.4
@@ -1,4 +1,4 @@
-libao - A Cross-platform Audio Library, Version 0.6.0
+libao - A Cross-platform Audio Library, Version 0.8.0
 
 Originally Copyright (C) Aaron Holtzman - May 1999
 Changes Copyright (C) Stan Seibert - July 2000
@@ -44,12 +44,10 @@
 libao library, severely hacked it up in order to make the build
 process simpler and support multiple live-playback devices.  (The
 original code allowed one live playback driver, the wav driver, and a
-null driver to be compiled into the library.)  
+null driver to be compiled into the library.)  Jack Moffitt got it
+supporting dynamically loaded plugins so that binary versions of libao
+could be provided.  The API was revised after version 0.7.0.
 
-Then Jack Moffitt got it supporting dynamicly loaded plugins so that 
-binary versions of libao could be provided.
-
 This code is being maintained by Stan Seibert (indigo at aztec.asu.edu) 
 and various other individuals.  Please DO NOT annoy Aaron Holtzman about 
 bugs, features, comments, etc. regarding this code.
-

1.3       +7 -1      ao/TODO

Index: TODO
===================================================================
RCS file: /usr/local/cvsroot/ao/TODO,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TODO	2000/10/31 07:08:40	1.2
+++ TODO	2001/08/05 02:35:29	1.3
@@ -2,5 +2,11 @@
 
 - make the plugins dynamically loadable (done)
 - make a ao-config liek gtk-config instead of ao_libs.inc (done)
-- any ideas?
+- extend the configuration files to allow default options for
+  each driver
+- Sample rate conversion on the fly to support sound cards that have few
+  sample rate options (like the i810 audio device, which only does 48000)
+- Actually test the IRIX plugin.  :)
+- Test the macosx plugin
+
 

1.3       +2 -2      ao/doc/ao_append_option.html

Index: ao_append_option.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_append_option.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_append_option.html	2001/08/04 02:56:08	1.2
+++ ao_append_option.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -59,7 +59,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_close.html

Index: ao_close.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_close.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_close.html	2001/08/04 02:56:08	1.2
+++ ao_close.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -54,7 +54,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_default_driver_id.html

Index: ao_default_driver_id.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_default_driver_id.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_default_driver_id.html	2001/08/04 02:56:08	1.2
+++ ao_default_driver_id.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -53,7 +53,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_device.html

Index: ao_device.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_device.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_device.html	2001/08/04 02:56:08	1.2
+++ ao_device.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -79,7 +79,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_driver_id.html

Index: ao_driver_id.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_driver_id.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_driver_id.html	2001/08/04 02:56:08	1.2
+++ ao_driver_id.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -54,7 +54,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_driver_info.html

Index: ao_driver_info.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_driver_info.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_driver_info.html	2001/08/04 02:56:08	1.2
+++ ao_driver_info.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -57,7 +57,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_driver_info_list.html

Index: ao_driver_info_list.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_driver_info_list.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_driver_info_list.html	2001/08/04 02:56:08	1.2
+++ ao_driver_info_list.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -53,7 +53,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_free_options.html

Index: ao_free_options.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_free_options.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_free_options.html	2001/08/04 02:56:08	1.2
+++ ao_free_options.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -46,7 +46,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_info.html

Index: ao_info.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_info.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_info.html	2001/08/04 02:56:08	1.2
+++ ao_info.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -84,7 +84,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_initialize.html

Index: ao_initialize.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_initialize.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_initialize.html	2001/08/04 02:56:08	1.2
+++ ao_initialize.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -49,7 +49,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_open_file.html

Index: ao_open_file.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_open_file.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_open_file.html	2001/08/04 02:56:08	1.2
+++ ao_open_file.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -90,7 +90,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_open_live.html

Index: ao_open_live.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_open_live.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_open_live.html	2001/08/04 02:56:08	1.2
+++ ao_open_live.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -76,7 +76,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_option.html

Index: ao_option.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_option.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_option.html	2001/08/04 02:56:08	1.2
+++ ao_option.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -50,7 +50,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_play.html

Index: ao_play.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_play.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_play.html	2001/08/04 02:56:08	1.2
+++ ao_play.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -58,7 +58,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_close.html

Index: ao_plugin_close.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_close.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_close.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_close.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -52,7 +52,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_device_clear.html

Index: ao_plugin_device_clear.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_device_clear.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_device_clear.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_device_clear.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -44,7 +44,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_device_init.html

Index: ao_plugin_device_init.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_device_init.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_device_init.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_device_init.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -58,7 +58,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_driver_info.html

Index: ao_plugin_driver_info.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_driver_info.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_driver_info.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_driver_info.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -45,7 +45,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_open.html

Index: ao_plugin_open.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_open.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_open.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_open.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -62,7 +62,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_play.html

Index: ao_plugin_play.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_play.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_play.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_play.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -61,7 +61,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_set_option.html

Index: ao_plugin_set_option.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_set_option.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_set_option.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_set_option.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -64,7 +64,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_plugin_test.html

Index: ao_plugin_test.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_plugin_test.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_plugin_test.html	2001/08/04 02:56:08	1.2
+++ ao_plugin_test.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -50,7 +50,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_sample_format.html

Index: ao_sample_format.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_sample_format.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_sample_format.html	2001/08/04 02:56:08	1.2
+++ ao_sample_format.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -53,7 +53,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/ao_shutdown.html

Index: ao_shutdown.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/ao_shutdown.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ao_shutdown.html	2001/08/04 02:56:08	1.2
+++ ao_shutdown.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -46,7 +46,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/config.html

Index: config.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/config.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- config.html	2001/08/04 02:56:08	1.2
+++ config.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -47,7 +47,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.4       +2 -2      ao/doc/drivers.html

Index: drivers.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/drivers.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- drivers.html	2001/08/04 22:43:37	1.3
+++ drivers.html	2001/08/05 02:35:30	1.4
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -200,7 +200,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.4       +3 -3      ao/doc/index.html

Index: index.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/index.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.html	2001/08/04 02:56:08	1.3
+++ index.html	2001/08/05 02:35:30	1.4
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -32,7 +32,7 @@
 <a href="ao_example.c">example code</a><br>
 <a href="config.html">configuration files</a><br>
 <a href="libao-api.html">libao api reference</a><br>
-<a href="plugin-overview.html">plugin overview</a><br>
+<a href="plugin-overview.html">plugin writer's overview</a><br>
 <a href="plugin-api.html">plugin api reference</a><br>
 
 <br><br>
@@ -43,7 +43,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/libao-api.html

Index: libao-api.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/libao-api.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- libao-api.html	2001/08/04 02:56:08	1.2
+++ libao-api.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -51,7 +51,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +2 -2      ao/doc/overview.html

Index: overview.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/overview.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- overview.html	2001/08/04 02:56:08	1.2
+++ overview.html	2001/08/05 02:35:30	1.3
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
@@ -100,7 +100,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +3 -3      ao/doc/plugin-api.html

Index: plugin-api.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/plugin-api.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- plugin-api.html	2001/08/04 02:56:08	1.2
+++ plugin-api.html	2001/08/05 02:35:30	1.3
@@ -9,11 +9,11 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
-<h1>Plugin API</h1>
+<h1>libao Plugin API</h1>
 
 <p>
 <a href="ao_plugin_test.html">ao_plugin_test()</a><br>
@@ -33,7 +33,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

1.3       +131 -8    ao/doc/plugin-overview.html

Index: plugin-overview.html
===================================================================
RCS file: /usr/local/cvsroot/ao/doc/plugin-overview.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- plugin-overview.html	2001/08/04 02:56:08	1.2
+++ plugin-overview.html	2001/08/05 02:35:30	1.3
@@ -9,24 +9,147 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 
-<h1>libao Plugin Overview</h1>
+<h1>libao Plugin Writer's Overview</h1>
 
 <p>
 Plugins are drivers that are loaded dynamically when libao is first
 initialized by the client application.  Drivers that are operating
-system dependent, like the <tt>oss</tt> and <tt>sun</tt> drivers, or that
-depend on external libraries, like the <tt>esd</tt> driver, must be
-implemented as plugins in order to keep binary packagers happy.
+system dependent, like the <tt>oss</tt> and <tt>sun</tt> drivers, or
+that depend on external libraries, like the <tt>esd</tt> driver, must
+be implemented as plugins in order to keep binary packagers happy.
+There are also statically linked drivers, which are written in a
+nearly identical way, but won't be covered here.  In nearly all cases,
+a dynamically loadable plugin is the preferred way to write a driver,
+and the required way if the driver depends upon any external
+libraries.
+</p>
 
+<h2>Life Cycle</h2>
+
+<p>
+The life cycle of a plugin is:
+<ul>
+<li>When libao is first <a href="ao_initialize.html">initialized</a>,
+it loads all of the plugins from disk.
+
+<li>Libao then <a href="ao_plugin_test.html">tests</a> each plugin to
+see if can be used as the default driver.
+
+<li>When the user opens a device, libao will:
+
+  <ul>
+
+  <li>Call <a
+  href="ao_plugin_device_init.html">ao_plugin_device_init()</a> to
+  allow the plugin to allocate and initialize any private data
+  structures it will use.
+
+  <li>Call <a
+  href="ao_plugin_set_option.html">ao_plugin_set_option()</a> for each
+  parameter passed to the library by the client application.
+
+  <li>Call <a href="ao_plugin_open.html">ao_plugin_open.html</a> to
+  open the device for playback.
+  
+  </ul>
+
+<li>Each time the client app calls <a
+href="ao_play.html">ao_play()</a>, the library will reorder the byte
+format (little-endian vs. big-endian) to match the format requested by
+the plugin.  The library will then call <a href="ao_plugin_play.html">ao_plugin_play()</a> for the block of audio data.
+
+<li>When the client app closes the audio device, the library calls <a
+href="ao_plugin_close.html">ao_plugin_close()</a> to close the device,
+followed by a call to <a
+href="ao_plugin_clear.html">ao_plugin_device_clear()</a> to deallocate
+the private data structures.
+
+<li>When the library is <a href="ao_shutdown.html">shutdown</a>, the
+plugin will be unloaded from memory.
+
+</ul>
+
+In case of errors, <a
+href="ao_plugin_device_clear.html">ao_plugin_device_clear()</a> will
+always be called if <a
+href="ao_plugin_device_init.html">ao_plugin_device_init()</a> executed
+successfully.  Similarly, <a
+href="ao_plugin_close.html">ao_plugin_close()</a> will always be
+called if <a href="ao_plugin_open.html">ao_plugin_open()</a> executed
+successfully.
+</p>
+
+<h2>Creating a New Plugin</h2>
+
 <p>
-In order to make a new plugin, follow these steps:
+In order to write a new plugin, follow these steps:
 <ul>
-<li>To be filled in.
+
+<li>Decide upon a new short name for your plugin.  It should be less
+than 8 characters and contain only alphanumeric characters
+(underscores are okay, but discouraged).
+
+<li>Make a new directory in the src/plugins directory with the short name of your plugin.
+
+<li>Copy the contents of one of the other plugin directories into your
+directory.  The Sun driver is a good example of a driver that uses
+system devices for output, and the ALSA driver is a good example of a
+plugin that uses an external library.  Rename the source file to ao_shortname.c, where "shortname" is the short name of your plugin.
+
+<li>Edit the <a href="ao_info.html">ao_info</a> structure.
+
+<li>Implement the all of the methods defined in the <a
+href="plugin-api.html">plugin API</a>.
+
+<li>Edit the files ("shortname" is as described above): configure.in,
+src/plugins/Makefile.am, src/plugins/shortname/Makefile.am.  There
+should be a an configure option to disable your plugin.  Look at the
+existing configure.in file for examples of how to do this.
+
+<li>Test it thoroughly!  :)
+
+<li>Send a tarball of the src/plugin/shortname directory (only this
+directory, please!) and a cvs diff -u of the changes you have made to
+the <a href="mailto:vorbis-dev at xiph.org">vorbis-dev</a> list and we'll
+take a look at it for inclusion.
+
+</ul>
+</p>
+
+<h2>API Implementation Tips</h2>
+
+<p>
+<ul>
+
+<li>Remember to close any devices/connections you openned in <a
+href="ao_plugin_test.html">ao_plugin_test()</a>.  <li>Although you
+should try to allocate all of your data structures in <a
+href="ao_plugin_device_init.html">ao_plugin_device_init()</a>, there
+are cases where you won't be able to allocate memory until <a
+href="ao_plugin_open.html">ao_plugin_open()</a> is called.  That is
+acceptable, but the rule is that you must deallocate memory in <a
+href="ao_plugin_close.html">ao_plugin_close()</a> that was allocated
+in <a href="ao_plugin_open.html">ao_plugin_open()</a> and deallocate
+memory in <a
+href="ao_plugin_device_clear.html">ao_plugin_device_clear()</a> that
+was allocated in <a
+href="ao_plugin_device_init.html">ao_plugin_device_init()</a>.
+
+<li>Don't forget to set device->driver_byte_format in <a
+href="ao_plugin_open.html">ao_plugin_open()</a> to the byte ordering
+your plugin needs.  The libao core will reorder the bytes for you if
+it necessary.
+
+<li>Read the <a href="drivers.html">driver documentation</a> to see
+what priority you should set for your plugin in the <a
+href="ao_info.html">ao_info</a> structure.
+
 </ul>
+</p>
 
 <br><br>
 <hr noshade>
@@ -36,7 +159,7 @@
 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:indigo at aztec.asu.edu">indigo at aztec.asu.edu</a></p></td>
 </tr><tr>
 <td><p class=tiny>libao documentation</p></td>
-<td align=right><p class=tiny>libao version 0.90 - 20010528</p></td>
+<td align=right><p class=tiny>libao version 0.8.0 - 20010804</p></td>
 </tr>
 </table>
 

--- >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.

