Audio plugin host https://kx.studio/carla
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.

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