Changeset 71 for pa_proposals/trunk

Show
Ignore:
Timestamp:
09/18/03 13:23:38 (5 years ago)
Author:
rossbencina
Message:

updated alsa status from Arve Knudsen

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • pa_proposals/trunk/status.html

    r70 r71  
    2727 
    2828<P><A href="http://www.portaudio.com/">PortAudio Home Page</A></P> 
    29 <P>Updated: September 18, 2003 </P> 
     29<P>Updated: September 19, 2003 </P> 
    3030 
    3131<H2>Background</H2> 
    3232 
    3333<P> 
    34 For some years PortAudio development proceeded incrementally - fixing bugs and adding features. Around the time of the original V18 release in 2001 a big list of requested features existed, and there were many implementations of the PortAudio API, some with more cut-and-paste commonality than code sharing. Due to a combination of forces, most notably the desire to support multiple Host APIs in a single PortAudio build, it was decided to develop a new unified common infrastructure (support library) with which to implement V19. At that time the feature requests were developed into a set of change proposals which describe the new (Version 2.0) PortAudio API documented in portaudio.h. The proposals have been stable for some time (close to a year) and are available on the <a href="index.html">proposals page</a>. The common infrastructure is now largely implemented in the v19-devel CVS branch, and the version 2.0 API is well documented, and available as part of the v19-devel doxygen generated documentation available <a href="http://www.portaudio.com/docs/v19-doxydocs/">here</a>. 
     34For some years PortAudio development proceeded incrementally - bugs were fixed, new implementations were created and a few features were added. Around the time of the original V18 release in 2001 a big list of requested features existed, and there were many separate implementations of the PortAudio API, some with more cut-and-paste commonality than code sharing. Due to a combination of forces, most notably the desire to support multiple Host APIs in a single PortAudio build, it was decided to develop a new unified common infrastructure (support library) with which to implement V19. At that time the feature requests were developed into a set of <a href="index.html">enhancement proposals</a> which describe the new (Version 2.0) PortAudio API now documented in V19's <a href="http://www.portaudio.com/docs/v19-doxydocs/portaudio_8h.html">portaudio.h</a>. The proposals have been stable for some time (close to a year). The common infrastructure is now largely implemented in the <a href="http://www.portaudio.com/usingcvs.html">v19-devel CVS branch</a>, and the version 2.0 API is well documented, and available as part of the <a href="http://www.portaudio.com/docs/v19-doxydocs/">doxygen generated documentation</a>. 
    3535</P> 
    3636 
    37 <P> Although each proposal is relatively small when taken in isolation, the overall scale of required changes from V18 to V19 is substantial. The new common infrastructure imposes a new interface for implementations. This new interface increases reliability and consistency and reduces development effort, but require considerable refactoring (some would say redevelopment) of existing PortAudio implementations relative to the V18 code base.  
     37<P> Although each proposal is relatively small when taken in isolation, the overall scale of required changes from V18 to V19 is substantial. The new common infrastructure imposes a new interface for implementations. This new interface increases reliability and consistency and reduces development effort, but requires considerable refactoring (some would say redevelopment) of existing PortAudio implementations relative to the V18 code base.  
    3838</P>  
    3939<P> 
    40 At the time of writing, a substantial portion of V19 functionality has been implemented for Windows (MME, DirectSound, and ASIO) and for Linux (ALSA, OSS, and JACK) however no work has commenced on the other platforms which are well supported by V18 the Macintosh (SoundManager, CoreAudio) SGI (AL). 
     40At the time of writing, a substantial portion of V19 functionality has been implemented for Windows (MME, DirectSound, and ASIO) and for Linux (ALSA, OSS, and JACK) however no work has commenced on the other platforms which are well supported by V18: the Macintosh (SoundManager, CoreAudio) and SGI (AL). 
    4141</P> 
    4242 <P> 
    43 The amount of development work required to move from V18 release to V19 release has proven to be a significant impediment to completing the V19 release. In hindsight it may have been preferable to plan an incremental change schedule for migrating implementations from V18 to the new version 2.0 API. However hindsight is of little benefit to us now, and we need a plan to finalise the V19 release, the remainder of this document is part of that plan. 
     43The amount of development required to move from V18 release to V19 release has proven to be a significant obstacle to completing the V19 release. In hindsight it may have been preferable to plan an incremental change schedule for migrating implementations from V18 to the new version 2.0 API. However hindsight is of little benefit to us now, and we need a plan to finalise the V19 release, the remainder of this document is part of that plan. 
    4444</P> 
    4545  
    46 <H2>Goals and Status Reporting</H2> 
     46 
     47<H2>Implementation Status</H2> 
    4748 
    4849<P> 
    49 The list below attempts to clearly document the status of the current V19 development effort, in order to assist planning the V19 release. The original development status table was expressed in terms of the change proposals, some of which included multiple features. In some cases features were spread accross multiple change proposals. This new status table attempts to break the status down into finer grained features whose status can be easily verified. Developers are requested to report status to Ross Bencina (rossb@audiomulch.com), and to suggest new feature items. All unfinished features listed here, as well as other unfinished tasks should be listed as doxygen @todo items in the source code so that we can more easily track development status. 
     50The lists below attempt to clearly document the status of the current V19 development effort, in order to assist planning the V19 release. The original development status table was expressed in terms of the enhancement proposals, some of which included multiple features. In some cases features were spread accross multiple proposals. This new status table attempts to break the status down into finer grained features whose status can be easily verified. Developers are requested to report status to Ross Bencina (rossb@audiomulch.com), and to suggest new items for pending features not listed here. All unfinished features listed here, as well as other unfinished tasks should be listed as doxygen @todo items in the source code so that we can more easily track development status with the doxygen <a href="http://www.portaudio.com/docs/v19-doxydocs/todo.html">todo list</a>. 
    5051</P> 
    5152 
    52  
    53 <H2>Implementation Status</H2> 
    54 <p> 
    55 Items marked <span class="done">green</span> have been implemented for that platform, <span class="unknown">yellow</span> are unknown, and <span class="not_done">red</span> are not implemented. 
     53<p> 
     54Items marked <span class="done">green</span> have been implemented, <span class="unknown">yellow</span> are unknown, and <span class="not_done">red</span> are not implemented. 
    5655</p> 
    5756 
    … …  
    131130 
    132131<p> 
    133 The list below describe API features which must be implemented by each implementation. In most cases the implementation status of these features will only effect clients who make use of these features, they do not effect the funtioning of other aspects of the API. 
     132The list below describe API features which must be implemented by each implementation. In most cases the implementation status of these features will only effect clients who make use of these features, they do not effect the functioning of other aspects of the API. 
    134133</p> 
    135134 
    … …  
    321320<span class="unknown">ds</span> 
    322321<span class="unknown">asio</span> 
    323 <span class="unknown">alsa</span> 
     322<span class="done">alsa</span> 
    324323<span class="unknown">jack</span> 
    325324<span class="unknown">oss</span> 
    … …  
    332331<span class="unknown">ds</span> 
    333332<span class="unknown">asio</span> 
    334 <span class="unknown">alsa</span> 
     333<span class="not_done">alsa</span> 
    335334<span class="unknown">jack</span> 
    336335<span class="unknown">oss</span> 
    … …  
    365364<span class="done">ds</span> 
    366365<span class="done">asio</span> 
    367 <span class="unknown">alsa</span> 
     366<span class="done">alsa</span> 
    368367<span class="unknown">jack</span> 
    369368<span class="unknown">oss</span> 
    … …  
    376375<span class="not_done">ds</span> 
    377376<span class="done">asio</span> 
    378 <span class="unknown">alsa</span> 
     377<span class="done">alsa</span> 
    379378<span class="unknown">jack</span> 
    380379<span class="unknown">oss</span> 
    … …  
    387386<span class="unknown">ds</span> 
    388387<span class="done">asio</span> 
    389 <span class="unknown">alsa</span> 
     388<span class="done">alsa</span> 
    390389<span class="unknown">jack</span> 
    391390<span class="unknown">oss</span> 
    … …  
    398397<span class="unknown">ds</span> 
    399398<span class="done">asio</span> 
    400 <span class="unknown">alsa</span> 
     399<span class="done">alsa</span> 
    401400<span class="unknown">jack</span> 
    402401<span class="unknown">oss</span> 
    … …  
    409408<span class="done">ds</span> 
    410409<span class="done">asio</span> 
    411 <span class="unknown">alsa</span> 
    412 <span class="unknown">jack</span> 
    413 <span class="unknown">oss</span> 
    414 <span class="not_done">mac_sm</span> 
    415 <span class="not_done">mac_core</span> 
    416 <span class="not_done">sgi</span> 
    417  
    418 <li>implement Pa_GetStreamTime() (see <a href="015-ImproveCallbackTimestampInfo.html">proposal 015</a>) **NOTE change proposal says stream time increases while stream is open, not just while running, not sure if alsa implementation observes this.<br>  
     410<span class="done">alsa</span> 
     411<span class="unknown">jack</span> 
     412<span class="unknown">oss</span> 
     413<span class="not_done">mac_sm</span> 
     414<span class="not_done">mac_core</span> 
     415<span class="not_done">sgi</span> 
     416 
     417<li>implement Pa_GetStreamTime() (see <a href="015-ImproveCallbackTimestampInfo.html">proposal 015</a>) **NOTE enhancement proposal says stream time increases while stream is open, not just while running, not sure if alsa implementation observes this.<br>  
    419418<span class="done">wmme</span> 
    420419<span class="done">ds</span> 
    … …  
    443442<span class="done">ds</span> 
    444443<span class="done">asio</span> 
    445 <span class="unknown">alsa</span> 
     444<span class="not_done">alsa</span> 
    446445<span class="not_done">jack</span> 
    447446<span class="unknown">oss</span> 
    … …  
    505504 
    506505<p> 
    507 The above status report needs to be taken in the context of the V18 release, the features it implemented (and didn't implement), and the quality and consistency of its implementations. For example many features listed above were not part of the V18 API, some were not consistently implemented accross platforms on V18, and some bug-like items were also present in V18. It remains to be decided whether every item above must be marked complete before V19 is released. One option we are considering is to release V19 as soon as it can do everything V18 could do. 
     506The above status report needs to be taken in the context of the V18 release, the features it implemented (and didn't implement), and the quality and consistency of its implementations. For example many features listed above were not part of the V18 API, some were not consistently implemented accross all platforms, and some of the bug-like items were also present in V18. It remains to be decided whether every item above must be marked complete before V19 is released. One option we are considering is to release V19 as soon as it can do everything V18 could do. 
    508507</p> 
    509508 
    … …  
    511510 
    512511<p> 
    513 There are many ways in which you can help with V19 development. To begin with, simply try using it - the more people that are using PortAudio V19, the more quickly we can find and fix problems. Read <a href="http://www.portaudio.com/docs/v19-doxydocs/">the documentation</a> and let us know if anything is confusing or unclear. Try compiling and running the tests which are known to work (see pa_tests/README.txt). Let us know about any problems you encounter. If you want to help out with development there are a number of simple tasks that you could work on, for example: write one of the missing sample converters in pa_converters.c, fix an existing test (see pa_tests/README.txt), or writing a new test. If you know something about one of the host APIs that we already support, why not review our code to see if we could be doing something better. There's also the <a href="http://www.portaudio.com/docs/v19-doxydocs/todo.html">todo list</a>. We're looking for developers to port the Macintosh and SGI versions from V18 to V19 - there's a template for new implementations in pa_skeleton.c and you can look to the existing MME, DirectSound, ASIO, ALSA and JACK implementations for guidance. It's always a good idea to in check with existing developers on the <a href="http://www.portaudio.com/contacts.html">mailing list</a> before beginning any large tasks. 
     512There are many ways in which you can help with V19 development. To begin with, simply try using it - the more people that use PortAudio V19, the more quickly we can find and fix problems. Read <a href="http://www.portaudio.com/docs/v19-doxydocs/">the documentation</a> and let us know if anything is confusing or unclear. Try compiling and running the tests which are known to work (see pa_tests/README.txt). Let us know about any problems you encounter. If you want to help out with development there are a number of simple tasks that you can work on, for example: write one of the missing sample converters in pa_converters.c, fix an existing test (see pa_tests/README.txt), or write a new test. If you know something about one of the host APIs that we already support, review our code to see if we could be doing something better. There's also the <a href="http://www.portaudio.com/docs/v19-doxydocs/todo.html">todo list</a>. We're looking for developers to port the Macintosh and SGI versions from V18 to V19 - there's a template for new implementations in pa_skeleton.c and you can look to the existing MME, DirectSound, ASIO, ALSA and JACK implementations for guidance. It's always a good idea to in check with existing developers on the <a href="http://www.portaudio.com/contacts.html">mailing list</a> before beginning a large task. 
    514513</p> 
    515514