Collection of tools useful for audio production
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.

358 lines
17KB

  1. /*
  2. * JackBridge
  3. * Copyright (C) 2013 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * Permission to use, copy, modify, and/or distribute this software for any purpose with
  6. * or without fee is hereby granted, provided that the above copyright notice and this
  7. * permission notice appear in all copies.
  8. *
  9. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
  10. * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
  11. * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  12. * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
  13. * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15. */
  16. #ifndef JACKBRIDGE_HPP_INCLUDED
  17. #define JACKBRIDGE_HPP_INCLUDED
  18. #include "JackBridgeDefines.hpp"
  19. #ifdef JACKBRIDGE_DIRECT
  20. # include <jack/jack.h>
  21. # include <jack/midiport.h>
  22. # include <jack/transport.h>
  23. # include <jack/custom.h>
  24. #else
  25. #include <cstddef>
  26. #ifdef JACKBRIDGE_PROPER_CPP11_SUPPORT
  27. # include <cstdint>
  28. #else
  29. # include <stdint.h>
  30. #endif
  31. #ifndef POST_PACKED_STRUCTURE
  32. # ifdef __GNUC__
  33. /* POST_PACKED_STRUCTURE needs to be a macro which
  34. expands into a compiler directive. The directive must
  35. tell the compiler to arrange the preceding structure
  36. declaration so that it is packed on byte-boundaries rather
  37. than use the natural alignment of the processor and/or
  38. compiler.
  39. */
  40. #define PRE_PACKED_STRUCTURE
  41. #define POST_PACKED_STRUCTURE __attribute__((__packed__))
  42. # else
  43. #ifdef _MSC_VER
  44. #define PRE_PACKED_STRUCTURE1 __pragma(pack(push,1))
  45. #define PRE_PACKED_STRUCTURE PRE_PACKED_STRUCTURE1
  46. /* PRE_PACKED_STRUCTURE needs to be a macro which
  47. expands into a compiler directive. The directive must
  48. tell the compiler to arrange the following structure
  49. declaration so that it is packed on byte-boundaries rather
  50. than use the natural alignment of the processor and/or
  51. compiler.
  52. */
  53. #define POST_PACKED_STRUCTURE ;__pragma(pack(pop))
  54. /* and POST_PACKED_STRUCTURE needs to be a macro which
  55. restores the packing to its previous setting */
  56. #else
  57. #define PRE_PACKED_STRUCTURE
  58. #define POST_PACKED_STRUCTURE
  59. #endif // _MSC_VER
  60. # endif // __GNUC__
  61. #endif
  62. #define JACK_DEFAULT_AUDIO_TYPE "32 bit float mono audio"
  63. #define JACK_DEFAULT_MIDI_TYPE "8 bit raw midi"
  64. #define JACK_HAS_CUSTOM_DATA_API 1
  65. #define JACK_HAS_PORT_IS_CONTROL_VOLTAGE_FLAG 1
  66. #define JackOpenOptions (JackSessionID|JackServerName|JackNoStartServer|JackUseExactName)
  67. #define JackLoadOptions (JackLoadInit|JackLoadName|JackUseExactName)
  68. #define JACK_POSITION_MASK (JackPositionBBT|JackPositionTimecode)
  69. #define EXTENDED_TIME_INFO
  70. enum JackOptions {
  71. JackNullOption = 0x00,
  72. JackNoStartServer = 0x01,
  73. JackUseExactName = 0x02,
  74. JackServerName = 0x04,
  75. JackLoadName = 0x08,
  76. JackLoadInit = 0x10,
  77. JackSessionID = 0x20
  78. };
  79. enum JackStatus {
  80. JackFailure = 0x0001,
  81. JackInvalidOption = 0x0002,
  82. JackNameNotUnique = 0x0004,
  83. JackServerStarted = 0x0008,
  84. JackServerFailed = 0x0010,
  85. JackServerError = 0x0020,
  86. JackNoSuchClient = 0x0040,
  87. JackLoadFailure = 0x0080,
  88. JackInitFailure = 0x0100,
  89. JackShmFailure = 0x0200,
  90. JackVersionError = 0x0400,
  91. JackBackendError = 0x0800,
  92. JackClientZombie = 0x1000
  93. };
  94. enum JackLatencyCallbackMode {
  95. JackCaptureLatency,
  96. JackPlaybackLatency
  97. };
  98. enum JackPortFlags {
  99. JackPortIsInput = 0x01,
  100. JackPortIsOutput = 0x02,
  101. JackPortIsPhysical = 0x04,
  102. JackPortCanMonitor = 0x08,
  103. JackPortIsTerminal = 0x10,
  104. JackPortIsControlVoltage = 0x100
  105. };
  106. enum JackTransportState {
  107. JackTransportStopped = 0,
  108. JackTransportRolling = 1,
  109. JackTransportLooping = 2,
  110. JackTransportStarting = 3,
  111. JackTransportNetStarting = 4
  112. };
  113. enum JackPositionBits {
  114. JackPositionBBT = 0x010,
  115. JackPositionTimecode = 0x020,
  116. JackBBTFrameOffset = 0x040,
  117. JackAudioVideoRatio = 0x080,
  118. JackVideoFrameOffset = 0x100
  119. };
  120. enum JackSessionEventType {
  121. JackSessionSave = 1,
  122. JackSessionSaveAndQuit = 2,
  123. JackSessionSaveTemplate = 3
  124. };
  125. enum JackSessionFlags {
  126. JackSessionSaveError = 0x1,
  127. JackSessionNeedTerminal = 0x2
  128. };
  129. enum JackCustomChange {
  130. JackCustomRemoved,
  131. JackCustomAdded,
  132. JackCustomReplaced
  133. };
  134. typedef uint32_t jack_nframes_t;
  135. typedef uint32_t jack_port_id_t;
  136. typedef uint64_t jack_time_t;
  137. typedef uint64_t jack_unique_t;
  138. typedef unsigned char jack_midi_data_t;
  139. typedef float jack_default_audio_sample_t;
  140. typedef enum JackOptions jack_options_t;
  141. typedef enum JackStatus jack_status_t;
  142. typedef enum JackLatencyCallbackMode jack_latency_callback_mode_t;
  143. typedef enum JackTransportState jack_transport_state_t;
  144. typedef enum JackPositionBits jack_position_bits_t;
  145. typedef enum JackSessionEventType jack_session_event_type_t;
  146. typedef enum JackSessionFlags jack_session_flags_t;
  147. typedef enum JackCustomChange jack_custom_change_t;
  148. struct _jack_midi_event {
  149. jack_nframes_t time;
  150. size_t size;
  151. jack_midi_data_t* buffer;
  152. };
  153. PRE_PACKED_STRUCTURE
  154. struct _jack_latency_range {
  155. jack_nframes_t min;
  156. jack_nframes_t max;
  157. } POST_PACKED_STRUCTURE;
  158. PRE_PACKED_STRUCTURE
  159. struct _jack_position {
  160. jack_unique_t unique_1;
  161. jack_time_t usecs;
  162. jack_nframes_t frame_rate;
  163. jack_nframes_t frame;
  164. jack_position_bits_t valid;
  165. int32_t bar;
  166. int32_t beat;
  167. int32_t tick;
  168. double bar_start_tick;
  169. float beats_per_bar;
  170. float beat_type;
  171. double ticks_per_beat;
  172. double beats_per_minute;
  173. double frame_time;
  174. double next_time;
  175. jack_nframes_t bbt_offset;
  176. float audio_frames_per_video_frame;
  177. jack_nframes_t video_offset;
  178. int32_t padding[7];
  179. jack_unique_t unique_2;
  180. } POST_PACKED_STRUCTURE;
  181. struct _jack_session_event {
  182. jack_session_event_type_t type;
  183. const char* session_dir;
  184. const char* client_uuid;
  185. char* command_line;
  186. jack_session_flags_t flags;
  187. uint32_t future;
  188. };
  189. struct _jack_session_command_t {
  190. const char* uuid;
  191. const char* client_name;
  192. const char* command;
  193. jack_session_flags_t flags;
  194. };
  195. typedef struct _jack_port jack_port_t;
  196. typedef struct _jack_client jack_client_t;
  197. typedef struct _jack_midi_event jack_midi_event_t;
  198. typedef struct _jack_latency_range jack_latency_range_t;
  199. typedef struct _jack_position jack_position_t;
  200. typedef struct _jack_session_event jack_session_event_t;
  201. typedef struct _jack_session_command_t jack_session_command_t;
  202. typedef void (*JackLatencyCallback)(jack_latency_callback_mode_t mode, void* arg);
  203. typedef int (*JackProcessCallback)(jack_nframes_t nframes, void* arg);
  204. typedef void (*JackThreadInitCallback)(void* arg);
  205. typedef int (*JackGraphOrderCallback)(void* arg);
  206. typedef int (*JackXRunCallback)(void* arg);
  207. typedef int (*JackBufferSizeCallback)(jack_nframes_t nframes, void* arg);
  208. typedef int (*JackSampleRateCallback)(jack_nframes_t nframes, void* arg);
  209. typedef void (*JackPortRegistrationCallback)(jack_port_id_t port, int register_, void* arg);
  210. typedef void (*JackClientRegistrationCallback)(const char* name, int register_, void* arg);
  211. typedef int (*JackClientRenameCallback)(const char* old_name, const char* new_name, void* arg);
  212. typedef void (*JackPortConnectCallback)(jack_port_id_t a, jack_port_id_t b, int connect, void* arg);
  213. typedef int (*JackPortRenameCallback)(jack_port_id_t port, const char* old_name, const char* new_name, void* arg);
  214. typedef void (*JackFreewheelCallback)(int starting, void* arg);
  215. typedef void (*JackShutdownCallback)(void* arg);
  216. typedef void (*JackInfoShutdownCallback)(jack_status_t code, const char* reason, void* arg);
  217. typedef int (*JackSyncCallback)(jack_transport_state_t state, jack_position_t* pos, void* arg);
  218. typedef void (*JackTimebaseCallback)(jack_transport_state_t state, jack_nframes_t nframes, jack_position_t* pos, int new_pos, void* arg);
  219. typedef void (*JackSessionCallback)(jack_session_event_t* event, void* arg);
  220. typedef void (*JackCustomDataAppearanceCallback)(const char* client_name, const char* key, jack_custom_change_t change, void* arg);
  221. #endif // ! JACKBRIDGE_DIRECT
  222. JACKBRIDGE_EXPORT void jackbridge_get_version(int* major_ptr, int* minor_ptr, int* micro_ptr, int* proto_ptr);
  223. JACKBRIDGE_EXPORT const char* jackbridge_get_version_string();
  224. JACKBRIDGE_EXPORT jack_client_t* jackbridge_client_open(const char* client_name, jack_options_t options, jack_status_t* status, ...);
  225. JACKBRIDGE_EXPORT const char* jackbridge_client_rename(jack_client_t* client, const char* new_name);
  226. JACKBRIDGE_EXPORT bool jackbridge_client_close(jack_client_t* client);
  227. JACKBRIDGE_EXPORT int jackbridge_client_name_size();
  228. JACKBRIDGE_EXPORT char* jackbridge_get_client_name(jack_client_t* client);
  229. JACKBRIDGE_EXPORT bool jackbridge_activate(jack_client_t* client);
  230. JACKBRIDGE_EXPORT bool jackbridge_deactivate(jack_client_t* client);
  231. JACKBRIDGE_EXPORT int jackbridge_get_client_pid(const char* name);
  232. JACKBRIDGE_EXPORT bool jackbridge_is_realtime(jack_client_t* client);
  233. JACKBRIDGE_EXPORT bool jackbridge_set_thread_init_callback(jack_client_t* client, JackThreadInitCallback thread_init_callback, void* arg);
  234. JACKBRIDGE_EXPORT void jackbridge_on_shutdown(jack_client_t* client, JackShutdownCallback shutdown_callback, void* arg);
  235. JACKBRIDGE_EXPORT void jackbridge_on_info_shutdown(jack_client_t* client, JackInfoShutdownCallback shutdown_callback, void* arg);
  236. JACKBRIDGE_EXPORT bool jackbridge_set_process_callback(jack_client_t* client, JackProcessCallback process_callback, void* arg);
  237. JACKBRIDGE_EXPORT bool jackbridge_set_freewheel_callback(jack_client_t* client, JackFreewheelCallback freewheel_callback, void* arg);
  238. JACKBRIDGE_EXPORT bool jackbridge_set_buffer_size_callback(jack_client_t* client, JackBufferSizeCallback bufsize_callback, void* arg);
  239. JACKBRIDGE_EXPORT bool jackbridge_set_sample_rate_callback(jack_client_t* client, JackSampleRateCallback srate_callback, void* arg);
  240. JACKBRIDGE_EXPORT bool jackbridge_set_client_registration_callback(jack_client_t* client, JackClientRegistrationCallback registration_callback, void* arg);
  241. JACKBRIDGE_EXPORT bool jackbridge_set_client_rename_callback(jack_client_t* client, JackClientRenameCallback rename_callback, void* arg);
  242. JACKBRIDGE_EXPORT bool jackbridge_set_port_registration_callback(jack_client_t* client, JackPortRegistrationCallback registration_callback, void* arg);
  243. JACKBRIDGE_EXPORT bool jackbridge_set_port_connect_callback(jack_client_t* client, JackPortConnectCallback connect_callback, void* arg);
  244. JACKBRIDGE_EXPORT bool jackbridge_set_port_rename_callback(jack_client_t* client, JackPortRenameCallback rename_callback, void* arg);
  245. JACKBRIDGE_EXPORT bool jackbridge_set_graph_order_callback(jack_client_t* client, JackGraphOrderCallback graph_callback, void* arg);
  246. JACKBRIDGE_EXPORT bool jackbridge_set_xrun_callback(jack_client_t* client, JackXRunCallback xrun_callback, void* arg);
  247. JACKBRIDGE_EXPORT bool jackbridge_set_latency_callback(jack_client_t* client, JackLatencyCallback latency_callback, void* arg);
  248. JACKBRIDGE_EXPORT bool jackbridge_set_freewheel(jack_client_t* client, bool onoff);
  249. JACKBRIDGE_EXPORT bool jackbridge_set_buffer_size(jack_client_t* client, jack_nframes_t nframes);
  250. JACKBRIDGE_EXPORT jack_nframes_t jackbridge_get_sample_rate(jack_client_t* client);
  251. JACKBRIDGE_EXPORT jack_nframes_t jackbridge_get_buffer_size(jack_client_t* client);
  252. JACKBRIDGE_EXPORT float jackbridge_cpu_load(jack_client_t* client);
  253. JACKBRIDGE_EXPORT jack_port_t* jackbridge_port_register(jack_client_t* client, const char* port_name, const char* port_type, unsigned long flags, unsigned long buffer_size);
  254. JACKBRIDGE_EXPORT bool jackbridge_port_unregister(jack_client_t* client, jack_port_t* port);
  255. JACKBRIDGE_EXPORT void* jackbridge_port_get_buffer(jack_port_t* port, jack_nframes_t nframes);
  256. JACKBRIDGE_EXPORT const char* jackbridge_port_name(const jack_port_t* port);
  257. JACKBRIDGE_EXPORT const char* jackbridge_port_short_name(const jack_port_t* port);
  258. JACKBRIDGE_EXPORT int jackbridge_port_flags(const jack_port_t* port);
  259. JACKBRIDGE_EXPORT const char* jackbridge_port_type(const jack_port_t* port);
  260. JACKBRIDGE_EXPORT bool jackbridge_port_is_mine(const jack_client_t* client, const jack_port_t* port);
  261. JACKBRIDGE_EXPORT bool jackbridge_port_connected(const jack_port_t* port);
  262. JACKBRIDGE_EXPORT bool jackbridge_port_connected_to(const jack_port_t* port, const char* port_name);
  263. JACKBRIDGE_EXPORT const char** jackbridge_port_get_connections(const jack_port_t* port);
  264. JACKBRIDGE_EXPORT const char** jackbridge_port_get_all_connections(const jack_client_t* client, const jack_port_t* port);
  265. JACKBRIDGE_EXPORT bool jackbridge_port_set_name(jack_port_t* port, const char* port_name);
  266. JACKBRIDGE_EXPORT bool jackbridge_port_set_alias(jack_port_t* port, const char* alias);
  267. JACKBRIDGE_EXPORT bool jackbridge_port_unset_alias(jack_port_t* port, const char* alias);
  268. JACKBRIDGE_EXPORT int jackbridge_port_get_aliases(const jack_port_t* port, char* const aliases[2]);
  269. JACKBRIDGE_EXPORT bool jackbridge_port_request_monitor(jack_port_t* port, bool onoff);
  270. JACKBRIDGE_EXPORT bool jackbridge_port_request_monitor_by_name(jack_client_t* client, const char* port_name, bool onoff);
  271. JACKBRIDGE_EXPORT bool jackbridge_port_ensure_monitor(jack_port_t* port, bool onoff);
  272. JACKBRIDGE_EXPORT bool jackbridge_port_monitoring_input(jack_port_t* port);
  273. JACKBRIDGE_EXPORT bool jackbridge_connect(jack_client_t* client, const char* source_port, const char* destination_port);
  274. JACKBRIDGE_EXPORT bool jackbridge_disconnect(jack_client_t* client, const char* source_port, const char* destination_port);
  275. JACKBRIDGE_EXPORT bool jackbridge_port_disconnect(jack_client_t* client, jack_port_t* port);
  276. JACKBRIDGE_EXPORT int jackbridge_port_name_size();
  277. JACKBRIDGE_EXPORT int jackbridge_port_type_size();
  278. JACKBRIDGE_EXPORT size_t jackbridge_port_type_get_buffer_size(jack_client_t* client, const char* port_type);
  279. JACKBRIDGE_EXPORT void jackbridge_port_get_latency_range(jack_port_t* port, jack_latency_callback_mode_t mode, jack_latency_range_t* range);
  280. JACKBRIDGE_EXPORT void jackbridge_port_set_latency_range(jack_port_t* port, jack_latency_callback_mode_t mode, jack_latency_range_t* range);
  281. JACKBRIDGE_EXPORT bool jackbridge_recompute_total_latencies(jack_client_t* client);
  282. JACKBRIDGE_EXPORT const char** jackbridge_get_ports(jack_client_t* client, const char* port_name_pattern, const char* type_name_pattern, unsigned long flags);
  283. JACKBRIDGE_EXPORT jack_port_t* jackbridge_port_by_name(jack_client_t* client, const char* port_name);
  284. JACKBRIDGE_EXPORT jack_port_t* jackbridge_port_by_id(jack_client_t* client, jack_port_id_t port_id);
  285. JACKBRIDGE_EXPORT void jackbridge_free(void* ptr);
  286. JACKBRIDGE_EXPORT uint32_t jackbridge_midi_get_event_count(void* port_buffer);
  287. JACKBRIDGE_EXPORT bool jackbridge_midi_event_get(jack_midi_event_t* event, void* port_buffer, uint32_t event_index);
  288. JACKBRIDGE_EXPORT void jackbridge_midi_clear_buffer(void* port_buffer);
  289. JACKBRIDGE_EXPORT bool jackbridge_midi_event_write(void* port_buffer, jack_nframes_t time, const jack_midi_data_t* data, size_t data_size);
  290. JACKBRIDGE_EXPORT jack_midi_data_t* jackbridge_midi_event_reserve(void* port_buffer, jack_nframes_t time, size_t data_size);
  291. JACKBRIDGE_EXPORT bool jackbridge_release_timebase(jack_client_t* client);
  292. JACKBRIDGE_EXPORT bool jackbridge_set_sync_callback(jack_client_t* client, JackSyncCallback sync_callback, void* arg);
  293. JACKBRIDGE_EXPORT bool jackbridge_set_sync_timeout(jack_client_t* client, jack_time_t timeout);
  294. JACKBRIDGE_EXPORT bool jackbridge_set_timebase_callback(jack_client_t* client, bool conditional, JackTimebaseCallback timebase_callback, void* arg);
  295. JACKBRIDGE_EXPORT bool jackbridge_transport_locate(jack_client_t* client, jack_nframes_t frame);
  296. JACKBRIDGE_EXPORT jack_transport_state_t jackbridge_transport_query(const jack_client_t* client, jack_position_t* pos);
  297. JACKBRIDGE_EXPORT jack_nframes_t jackbridge_get_current_transport_frame(const jack_client_t* client);
  298. JACKBRIDGE_EXPORT bool jackbridge_transport_reposition(jack_client_t* client, const jack_position_t* pos);
  299. JACKBRIDGE_EXPORT void jackbridge_transport_start(jack_client_t* client);
  300. JACKBRIDGE_EXPORT void jackbridge_transport_stop(jack_client_t* client);
  301. JACKBRIDGE_EXPORT bool jackbridge_custom_publish_data(jack_client_t* client, const char* key, const void* data, size_t size);
  302. JACKBRIDGE_EXPORT bool jackbridge_custom_get_data(jack_client_t* client, const char* client_name, const char* key, void** data, size_t* size);
  303. JACKBRIDGE_EXPORT bool jackbridge_custom_unpublish_data(jack_client_t* client, const char* key);
  304. JACKBRIDGE_EXPORT bool jackbridge_custom_set_data_appearance_callback(jack_client_t* client, JackCustomDataAppearanceCallback callback, void* arg);
  305. JACKBRIDGE_EXPORT const char** jackbridge_custom_get_keys(jack_client_t* client, const char* client_name);
  306. #endif // JACKBRIDGE_HPP_INCLUDED