Skip to content

Commit

Permalink
More documentation in jack.h
Browse files Browse the repository at this point in the history
git-svn-id: http://subversion.jackaudio.org/jack/jack2/trunk/jackmp@2115 0c269be4-1314-0410-8aa9-9f06e86f4224
  • Loading branch information
sletz committed Apr 2, 2008
1 parent 7e2d970 commit 3d97601
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions common/jack/jack.h
Expand Up @@ -189,7 +189,7 @@ extern "C"
* \bold THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED IN
* NEW JACK CLIENTS.
*
* It should be replace by use of @ jack_thread_wait and @ jack_cycle_wait functions.
* It should be replace by use of @ jack_cycle_wait and @ jack_cycle_signal functions.
*
*/
jack_nframes_t jack_thread_wait (jack_client_t*, int status);
Expand Down Expand Up @@ -469,13 +469,16 @@ extern "C"
* zero-filled. if there are multiple inbound connections, the data
* will be mixed appropriately.
*
* FOR OUTPUT PORTS ONLY
* ---------------------
* FOR OUTPUT PORTS ONLY : DEPRECATED in Jack 2.0 !!
* ---------------------------------------------------
* You may cache the value returned, but only between calls to
* your "blocksize" callback. For this reason alone, you should
* either never cache the return value or ensure you have
* a "blocksize" callback and be sure to invalidate the cached
* address from there.
*
* Caching output ports is DEPRECATED in Jack 2.0, due to some new optimization (like "pipelining").
* Port buffers have to be retrieved in each callback for proper functionning.
*/
void * jack_port_get_buffer (jack_port_t *, jack_nframes_t);

Expand Down

1 comment on commit 3d97601

@sletz
Copy link
Member

@sletz sletz commented on 3d97601 Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pipelining idea was experimental and was never merged. So I guess the initial property (= OUTPUT PORTS can be cached) still holds.

Please sign in to comment.