jackaudio
/
headers
mirror of https://github.com/jackaudio/headers
1
0
Fork 0
Code Releases 2 Activity
JACK API headers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 Commits
2 Branches
519KB
Tree: 60ee937d19
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '60ee937d19'
${ noResults }
headers/transport.h

529 lines
20KB
Raw Blame History 

  1. /*

  2.     Copyright (C) 2002 Paul Davis

  3.     Copyright (C) 2003 Jack O'Quin

  4.     

  5.     This program is free software; you can redistribute it and/or modify

  6.     it under the terms of the GNU Lesser General Public License as published by

  7.     the Free Software Foundation; either version 2.1 of the License, or

  8.     (at your option) any later version.

  9.     

  10.     This program is distributed in the hope that it will be useful,

  11.     but WITHOUT ANY WARRANTY; without even the implied warranty of

  12.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  13.     GNU Lesser General Public License for more details.

  14.     

  15.     You should have received a copy of the GNU Lesser General Public License

  16.     along with this program; if not, write to the Free Software 

  17.     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

  18. 

  19. */

  20. 

  21. #ifndef __jack_transport_h__

  22. #define __jack_transport_h__

  23. 

  24. #ifdef __cplusplus

  25. extern "C" {

  26. #endif

  27. 

  28. #include <jack/types.h>

  29. #include <jack/weakmacros.h>

  30. 

  31. /**

  32.  * Transport states.

  33.  */

  34. typedef enum {

  35. 

  36. 	/* the order matters for binary compatibility */

  37. 	JackTransportStopped = 0,	/**< Transport halted */

  38. 	JackTransportRolling = 1,	/**< Transport playing */

  39. 	JackTransportLooping = 2,	/**< For OLD_TRANSPORT, now ignored */

  40. 	JackTransportStarting = 3	/**< Waiting for sync ready */

  41. 

  42. } jack_transport_state_t;

  43. 

  44. typedef uint64_t jack_unique_t;		/**< Unique ID (opaque) */

  45. 

  46. /**

  47.  * Optional struct jack_position_t fields.

  48.  */

  49. typedef enum {

  50. 

  51. 	JackPositionBBT =	  0x10,	/**< Bar, Beat, Tick */

  52. 	JackPositionTimecode =	  0x20,	/**< External timecode */

  53. 	JackBBTFrameOffset =      0x40,	/**< Frame offset of BBT information */

  54. 	JackAudioVideoRatio =     0x80, /**< audio frames per video frame */

  55. 	JackVideoFrameOffset =   0x100  /**< frame offset of first video frame */

  56. } jack_position_bits_t;

  57. 

  58. /** all valid position bits */

  59. #define JACK_POSITION_MASK (JackPositionBBT|JackPositionTimecode|JackBBTFrameOffset|JackAudioVideoRatio|JackVideoFrameOffset)

  60. #define EXTENDED_TIME_INFO

  61. 

  62. /**

  63.  * Struct for transport position information.

  64.  */

  65. typedef struct {

  66.     

  67.     /*@{*/

  68.     /** @name Server-set fields

  69.      * these cannot be set from clients; the server sets them */

  70.     jack_unique_t	unique_1;	/**< unique ID */

  71.     jack_time_t		usecs;		/**< microsecond timestamp that is guaranteed to be 

  72.                                              monotonic, but not neccessarily 

  73.                                              linear. 

  74. 

  75.                                              The absolute value is 

  76.                                              implementation-dependent (i.e. it

  77.                                              could be wall-clock, time since 

  78.                                              jack started, uptime, etc). */

  79.     jack_nframes_t	frame_rate;	/**< current frame rate, in frames per second */

  80.     /*}@*/

  81. 

  82.     /*@{*/

  83.     /** @name Mandatory fields 

  84.       */

  85.     jack_nframes_t	frame;		/**< frame number, always present/required. 

  86.                                              

  87.                                              This is the frame number on the 

  88.                                              transport timeline, which is not 

  89.                                              the same as what @ref 

  90.                                              jack_frame_time returns. */

  91.     jack_position_bits_t valid;		/**< which other fields are valid, as a

  92.                                              bitmask constructed from values in 

  93.                                              \ref jack_position_bits_t */

  94.     /*}@*/

  95. 

  96.     /*@{*/

  97.     /** @name JackPositionBBT fields 

  98.      * Bar:Beat.Tick-related information. 

  99.      *

  100.      * Applications that support 

  101.      * JackPositionBBT are encouraged to also fill the JackBBTFrameOffset

  102.      */

  103.     int32_t		bar;		/**< current bar 

  104. 

  105.                                              Should be >0: the first bar is 

  106.                                              bar '1'. */

  107.     int32_t		beat;		/**< current beat-within-bar 

  108. 

  109.                                              Should be >0 and <=beats_per_bar:

  110.                                              the first beat is beat '1'.

  111.                                              */

  112.     int32_t		tick;		/**< current tick-within-beat 

  113. 

  114.                                              Should be >0 and <=ticks_per_beat:

  115.                                              the first tick is tick '0'. */

  116.     double		bar_start_tick; /**< number of ticks that have elapsed 

  117.                                              between frame 0 and the first beat

  118.                                              of the current measure. */

  119. 

  120.     float		beats_per_bar;	/**< time signature "numerator" */

  121.     float		beat_type;	/**< time signature "denominator" */

  122.     double		ticks_per_beat; /**< number of ticks within a bar. 

  123. 

  124.                                              Usually a moderately large integer

  125.                                              with many denominators, such as 

  126.                                              1920.0 */

  127.     double		beats_per_minute; /**< BPM, quantized to block size. This

  128.                                              means when the tempo is not constant

  129.                                              within this block, the BPM value should

  130.                                              adapted to compensate for this. This

  131.                                              is different from most fields in this

  132.                                              struct, which specify the value at 

  133.                                              the beginning of the block rather 

  134.                                              than an average.*/

  135.     /*}@*/

  136. 

  137.     /*@{*/

  138.     /** @name JackPositionTimecode fields	

  139.      * EXPERIMENTAL: could change */

  140.     double		frame_time;	/**< current time in seconds */

  141.     double		next_time;	/**< next sequential frame_time

  142. 					     (unless repositioned) */

  143.     /*}@*/

  144.   

  145.     /*@{*/

  146.     /* JackBBTFrameOffset fields */

  147.     jack_nframes_t	bbt_offset;	/**< frame offset for the BBT fields

  148. 					     (the given bar, beat, and tick

  149. 					     values actually refer to a time

  150. 					     frame_offset frames before the

  151. 					     start of the cycle), should 

  152. 					     be assumed to be 0 if 

  153. 					     JackBBTFrameOffset is not 

  154. 					     set. If JackBBTFrameOffset is

  155. 					     set and this value is zero, the BBT

  156. 					     time refers to the first frame of this

  157. 					     cycle. If the value is positive,

  158. 					     the BBT time refers to a frame that

  159. 					     many frames before the start of the

  160. 					     cycle. */

  161.     /*}@*/

  162. 

  163.     /*@{*/

  164.     /* JACK video positional data

  165.      * EXPERIMENTAL: could change */

  166.     float               audio_frames_per_video_frame; /**< number of audio frames

  167. 					     per video frame. Should be assumed

  168. 					     zero if JackAudioVideoRatio is not

  169. 					     set. If JackAudioVideoRatio is set

  170. 					     and the value is zero, no video

  171. 					     data exists within the JACK graph */

  172. 

  173.     jack_nframes_t      video_offset;   /**< audio frame at which the first video

  174. 					     frame in this cycle occurs. Should

  175. 					     be assumed to be 0 if JackVideoFrameOffset

  176. 					     is not set. If JackVideoFrameOffset is

  177. 					     set, but the value is zero, there is

  178. 					     no video frame within this cycle. */

  179.     /*}@*/

  180. 

  181.     /*@{*/

  182.     /** @name Other fields */

  183.     /* For binary compatibility, new fields should be allocated from

  184.      * this padding area with new valid bits controlling access, so

  185.      * the existing structure size and offsets are preserved. */

  186.     int32_t		padding[7];

  187.     /*}@*/

  188. 

  189.     /* When (unique_1 == unique_2) the contents are consistent. */

  190.     jack_unique_t	unique_2;	/**< unique ID */

  191. 

  192. } POST_PACKED_STRUCTURE jack_position_t;

  193. 

  194. /**

  195.  * @defgroup TransportControl Transport and Timebase control

  196.  * @{

  197.  */

  198. 

  199. /**

  200.  * Called by the timebase master to release itself from that

  201.  * responsibility.

  202.  *

  203.  * If the timebase master releases the timebase or leaves the JACK

  204.  * graph for any reason, the JACK engine takes over at the start of

  205.  * the next process cycle.  The transport state does not change.  If

  206.  * rolling, it continues to play, with frame numbers as the only

  207.  * available position information.

  208.  *

  209.  * @see jack_set_timebase_callback

  210.  *

  211.  * @param client the JACK client structure.

  212.  *

  213.  * @return 0 on success, otherwise a non-zero error code.

  214.  */

  215. int  jack_release_timebase (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;

  216. 

  217. /**

  218.  * Prototype for the @a sync_callback defined by @ref slowsyncclients 

  219.  * "slow-sync clients". When the client is active, this callback is 

  220.  * invoked just before process() in the same thread.  This occurs once 

  221.  * after registration, then subsequently whenever some client requests 

  222.  * a new position, or the transport enters the ::JackTransportStarting 

  223.  * state.  This realtime function must not wait.

  224.  *

  225.  * The transport @a state will be:

  226.  *

  227.  *   - ::JackTransportStopped when a new position is requested;

  228.  *   - ::JackTransportStarting when the transport is waiting to start;

  229.  *   - ::JackTransportRolling when the timeout has expired, and the

  230.  *   position is now a moving target.

  231.  *

  232.  * @param state current transport state.

  233.  * @param pos new transport position.

  234.  * @param arg the argument supplied by jack_set_sync_callback().

  235.  *

  236.  * @return TRUE (non-zero) when ready to roll.

  237.  */ 

  238. typedef int  (*JackSyncCallback)(jack_transport_state_t state,

  239. 				 jack_position_t *pos,

  240. 				 void *arg);

  241. 

  242. /**

  243.  * Register (or unregister) as a @ref slowsyncclients "slow-sync client", that cannot

  244.  * respond immediately to transport position changes.

  245.  *

  246.  * The @a sync_callback will be invoked at the first available

  247.  * opportunity after its registration is complete.  If the client is

  248.  * currently active this will be the following process cycle,

  249.  * otherwise it will be the first cycle after calling jack_activate().

  250.  * After that, it runs according to the ::JackSyncCallback rules.

  251.  * Clients that don't set a @a sync_callback are assumed to be ready

  252.  * immediately any time the transport wants to start.

  253.  *

  254.  * @param client the JACK client structure.

  255.  * @param sync_callback is a realtime function that returns TRUE when

  256.  * the client is ready.  Setting @a sync_callback to NULL declares that

  257.  * this client no longer requires slow-sync processing.

  258.  * @param arg an argument for the @a sync_callback function.

  259.  *

  260.  * @return 0 on success, otherwise a non-zero error code.

  261.  */

  262. int  jack_set_sync_callback (jack_client_t *client,

  263. 			     JackSyncCallback sync_callback,

  264. 			     void *arg) JACK_OPTIONAL_WEAK_EXPORT;

  265. 

  266. /**

  267.  * Set the timeout value for @ref slowsyncclients "slow-sync clients".

  268.  *

  269.  * This timeout prevents unresponsive slow-sync clients from

  270.  * completely halting the transport mechanism.  The default is two

  271.  * seconds.  When the timeout expires, the transport starts rolling,

  272.  * even if some slow-sync clients are still unready.  The @a

  273.  * sync_callbacks of these clients continue being invoked, giving them

  274.  * a chance to catch up.

  275.  *

  276.  * @see jack_set_sync_callback

  277.  *

  278.  * @param client the JACK client structure.

  279.  * @param timeout is delay (in microseconds) before the timeout expires.

  280.  *

  281.  * @return 0 on success, otherwise a non-zero error code.

  282.  */

  283. int  jack_set_sync_timeout (jack_client_t *client,

  284. 			    jack_time_t timeout) JACK_OPTIONAL_WEAK_EXPORT;

  285. 

  286. /**

  287.  * Prototype for the @a timebase_callback used to provide extended

  288.  * position information.  Its output affects all of the following

  289.  * process cycle.  This realtime function must not wait.

  290.  *

  291.  * This function is called immediately after process() in the same

  292.  * thread whenever the transport is rolling, or when any client has

  293.  * requested a new position in the previous cycle.  The first cycle

  294.  * after jack_set_timebase_callback() is also treated as a new

  295.  * position, or the first cycle after jack_activate() if the client

  296.  * had been inactive.

  297.  *

  298.  * The timebase master may not use its @a pos argument to set @a

  299.  * pos->frame.  To change position, use jack_transport_reposition() or

  300.  * jack_transport_locate().  These functions are realtime-safe, the @a

  301.  * timebase_callback can call them directly.

  302.  *

  303.  * @param state current transport state.

  304.  * @param nframes number of frames in current period.

  305.  * @param pos address of the position structure for the next cycle; @a

  306.  * pos->frame will be its frame number.  If @a new_pos is FALSE, this

  307.  * structure contains extended position information from the current

  308.  * cycle.  If TRUE, it contains whatever was set by the requester.

  309.  * The @a timebase_callback's task is to update the extended

  310.  * information here.

  311.  * @param new_pos TRUE (non-zero) for a newly requested @a pos, or for

  312.  * the first cycle after the @a timebase_callback is defined.

  313.  * @param arg the argument supplied by jack_set_timebase_callback().

  314.  */ 

  315. typedef void (*JackTimebaseCallback)(jack_transport_state_t state,

  316. 				     jack_nframes_t nframes, 

  317. 				     jack_position_t *pos,

  318. 				     int new_pos,

  319. 				     void *arg);

  320. 

  321. /**

  322.  * Register as timebase master for the JACK subsystem.

  323.  *

  324.  * The timebase master registers a callback that updates extended

  325.  * position information such as beats or timecode whenever necessary.

  326.  * Without this extended information, there is no need for this

  327.  * function.

  328.  *

  329.  * There is never more than one master at a time.  When a new client

  330.  * takes over, the former @a timebase_callback is no longer called.

  331.  * Taking over the timebase may be done conditionally, so it fails if

  332.  * there was a master already.

  333.  *

  334.  * The method may be called whether the client has been activated or not.

  335.  *

  336.  * @param client the JACK client structure.

  337.  * @param conditional non-zero for a conditional request.

  338.  * @param timebase_callback is a realtime function that returns

  339.  * position information.

  340.  * @param arg an argument for the @a timebase_callback function.

  341.  *

  342.  * @return

  343.  *   - 0 on success;

  344.  *   - EBUSY if a conditional request fails because there was already a

  345.  *   timebase master;

  346.  *   - other non-zero error code.

  347.  */

  348. int  jack_set_timebase_callback (jack_client_t *client,

  349. 				 int conditional,

  350. 				 JackTimebaseCallback timebase_callback,

  351. 				 void *arg) JACK_OPTIONAL_WEAK_EXPORT;

  352. 

  353. /**

  354.  * Reposition the transport to a new frame number.

  355.  *

  356.  * May be called at any time by any client.  The new position takes

  357.  * effect in two process cycles.  If there are @ref slowsyncclients 

  358.  * "slow-sync clients" and the transport is already rolling, it will 

  359.  * enter the ::JackTransportStarting state and begin invoking their @a

  360.  * sync_callbacks until ready.  This function is realtime-safe.

  361.  *

  362.  * @see jack_transport_reposition, jack_set_sync_callback

  363.  * 

  364.  * @param client the JACK client structure.

  365.  * @param frame frame number of new transport position.

  366.  *

  367.  * @return 0 if valid request, non-zero otherwise.

  368.  */

  369. int  jack_transport_locate (jack_client_t *client,

  370. 			    jack_nframes_t frame) JACK_OPTIONAL_WEAK_EXPORT;

  371. 

  372. /**

  373.  * Query the current transport state and position.

  374.  *

  375.  * This function is realtime-safe, and can be called from any thread.

  376.  * If called from the process thread, @a pos corresponds to the first

  377.  * frame of the current cycle and the state returned is valid for the

  378.  * entire cycle.

  379.  *

  380.  * @param client the JACK client structure.

  381.  * @param pos pointer to structure for returning current transport

  382.  * position; @a pos->valid will show which fields contain valid data.

  383.  * If @a pos is NULL, do not return position information.

  384.  *

  385.  * @return Current transport state.

  386.  */

  387. jack_transport_state_t jack_transport_query (const jack_client_t *client,

  388. 					     jack_position_t *pos) JACK_OPTIONAL_WEAK_EXPORT;

  389. 

  390. /**

  391.  * Return an estimate of the current transport frame,

  392.  * including any time elapsed since the last transport

  393.  * positional update.

  394.  *

  395.  * @param client the JACK client structure

  396.  */

  397. jack_nframes_t jack_get_current_transport_frame (const jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;

  398. 						 

  399. /**

  400.  * Request a new transport position.

  401.  *

  402.  * May be called at any time by any client.  The new position takes

  403.  * effect in two process cycles.  If there are @ref slowsyncclients 

  404.  * "slow-sync clients" and the transport is already rolling, it will 

  405.  * enter the ::JackTransportStarting state and begin invoking their @a

  406.  * sync_callbacks until ready.  This function is realtime-safe.

  407.  *

  408.  * @see jack_transport_locate, jack_set_sync_callback

  409.  * 

  410.  * @param client the JACK client structure.

  411.  * @param pos requested new transport position. Fill pos->valid to specify 

  412.  *   which fields should be taken into account. If you mark a set of fields

  413.  *   as valid, you are expected to fill them all.

  414.  *

  415.  * @return 0 if valid request, EINVAL if position structure rejected.

  416.  */

  417. int  jack_transport_reposition (jack_client_t *client,

  418. 				const jack_position_t *pos) JACK_OPTIONAL_WEAK_EXPORT;

  419. 

  420. /**

  421.  * Start the JACK transport rolling.

  422.  *

  423.  * Any client can make this request at any time.  It takes effect no

  424.  * sooner than the next process cycle, perhaps later if there are

  425.  * @ref slowsyncclients "slow-sync clients".  This function is realtime-safe.

  426.  *

  427.  * @see jack_set_sync_callback

  428.  *

  429.  * @param client the JACK client structure.

  430.  */

  431. void jack_transport_start (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;

  432. 

  433. /**

  434.  * Stop the JACK transport.

  435.  *

  436.  * Any client can make this request at any time.  It takes effect on

  437.  * the next process cycle.  This function is realtime-safe.

  438.  *

  439.  * @param client the JACK client structure.

  440.  */

  441. void jack_transport_stop (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;

  442. 

  443. /*@}*/

  444. 

  445. /*********************************************************************

  446.  * The following interfaces are DEPRECATED.  They are only provided

  447.  * for compatibility with the earlier JACK transport implementation.

  448.  *********************************************************************/

  449. 

  450. /**

  451.  * Optional struct jack_transport_info_t fields.

  452.  *

  453.  * @see jack_position_bits_t.

  454.  */

  455. typedef enum {

  456. 

  457. 	JackTransportState =    0x1,	/**< Transport state */

  458. 	JackTransportPosition = 0x2,	/**< Frame number */

  459. 	JackTransportLoop =     0x4,	/**< Loop boundaries (ignored) */

  460. 	JackTransportSMPTE =    0x8,	/**< SMPTE (ignored) */

  461. 	JackTransportBBT =      0x10	/**< Bar, Beat, Tick */

  462. 

  463. } jack_transport_bits_t;

  464. 

  465. /**

  466.  * Deprecated struct for transport position information.

  467.  *

  468.  * @deprecated This is for compatibility with the earlier transport

  469.  * interface.  Use the jack_position_t struct, instead.

  470.  */

  471. typedef struct {

  472.     

  473.     /* these two cannot be set from clients: the server sets them */

  474. 

  475.     jack_nframes_t frame_rate;		/**< current frame rate (per second) */

  476.     jack_time_t    usecs;		/**< monotonic, free-rolling */

  477. 

  478.     jack_transport_bits_t  valid;	/**< which fields are legal to read */

  479.     jack_transport_state_t transport_state;         

  480.     jack_nframes_t         frame;

  481.     jack_nframes_t         loop_start;

  482.     jack_nframes_t         loop_end;

  483. 

  484.     long           smpte_offset;	/**< SMPTE offset (from frame 0) */

  485.     float          smpte_frame_rate;	/**< 29.97, 30, 24 etc. */

  486. 

  487.     int            bar;

  488.     int            beat;

  489.     int            tick;

  490.     double         bar_start_tick;            

  491. 

  492.     float          beats_per_bar;

  493.     float          beat_type;

  494.     double         ticks_per_beat;

  495.     double         beats_per_minute;

  496. 

  497. } jack_transport_info_t;

  498. 	

  499. /**

  500.  * Gets the current transport info structure (deprecated).

  501.  *

  502.  * @param client the JACK client structure.

  503.  * @param tinfo current transport info structure.  The "valid" field

  504.  * describes which fields contain valid data.

  505.  *

  506.  * @deprecated This is for compatibility with the earlier transport

  507.  * interface.  Use jack_transport_query(), instead.

  508.  *

  509.  * @pre Must be called from the process thread.

  510.  */

  511. void jack_get_transport_info (jack_client_t *client,

  512. 			      jack_transport_info_t *tinfo) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;

  513. 

  514. /**

  515.  * Set the transport info structure (deprecated).

  516.  *

  517.  * @deprecated This function still exists for compatibility with the

  518.  * earlier transport interface, but it does nothing.  Instead, define

  519.  * a ::JackTimebaseCallback.

  520.  */

  521. void jack_set_transport_info (jack_client_t *client,

  522. 			      jack_transport_info_t *tinfo) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;

  523. 

  524. #ifdef __cplusplus

  525. }

  526. #endif

  527. 

  528. #endif /* __jack_transport_h__ */