From 3d97601d30f045003de10fff318f0e2adeaae667 Mon Sep 17 00:00:00 2001 From: sletz Date: Wed, 2 Apr 2008 15:19:57 +0000 Subject: [PATCH] More documentation in jack.h git-svn-id: http://subversion.jackaudio.org/jack/jack2/trunk/jackmp@2115 0c269be4-1314-0410-8aa9-9f06e86f4224 --- common/jack/jack.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/common/jack/jack.h b/common/jack/jack.h index b657b9e5..678eeab8 100644 --- a/common/jack/jack.h +++ b/common/jack/jack.h @@ -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); @@ -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);