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.

563 lines
16KB

  1. /*
  2. * Carla Backend utils
  3. * Copyright (C) 2011-2013 Filipe Coelho <falktx@falktx.com>
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License as
  7. * published by the Free Software Foundation; either version 2 of
  8. * the License, or 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 General Public License for more details.
  14. *
  15. * For a full copy of the GNU General Public License see the GPL.txt file
  16. */
  17. #ifndef __CARLA_BACKEND_UTILS_HPP__
  18. #define __CARLA_BACKEND_UTILS_HPP__
  19. #include "CarlaBackend.hpp"
  20. #include "CarlaString.hpp"
  21. CARLA_BACKEND_START_NAMESPACE
  22. // -------------------------------------------------
  23. static inline
  24. const char* PluginOption2Str(const unsigned int& option)
  25. {
  26. switch (option)
  27. {
  28. case PLUGIN_OPTION_FIXED_BUFFER:
  29. return "PLUGIN_OPTION_FIXED_BUFFER";
  30. case PLUGIN_OPTION_FORCE_STEREO:
  31. return "PLUGIN_OPTION_FORCE_STEREO";
  32. case PLUGIN_OPTION_MAP_PROGRAM_CHANGES:
  33. return "PLUGIN_OPTION_MAP_PROGRAM_CHANGES";
  34. case PLUGIN_OPTION_USE_CHUNKS:
  35. return "PLUGIN_OPTION_USE_CHUNKS";
  36. case PLUGIN_OPTION_SEND_CONTROL_CHANGES:
  37. return "PLUGIN_OPTION_SEND_CONTROL_CHANGES";
  38. case PLUGIN_OPTION_SEND_CHANNEL_PRESSURE:
  39. return "PLUGIN_OPTION_SEND_CHANNEL_PRESSURE";
  40. case PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH:
  41. return "PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH";
  42. case PLUGIN_OPTION_SEND_PITCHBEND:
  43. return "PLUGIN_OPTION_SEND_PITCHBEND";
  44. case PLUGIN_OPTION_SEND_ALL_SOUND_OFF:
  45. return "PLUGIN_OPTION_SEND_ALL_SOUND_OFF";
  46. }
  47. carla_stderr("CarlaBackend::PluginOption2Str(%i) - invalid type", option);
  48. return nullptr;
  49. }
  50. // -------------------------------------------------
  51. static inline
  52. const char* BinaryType2Str(const BinaryType& type)
  53. {
  54. switch (type)
  55. {
  56. case BINARY_NONE:
  57. return "BINARY_NONE";
  58. case BINARY_POSIX32:
  59. return "BINARY_POSIX32";
  60. case BINARY_POSIX64:
  61. return "BINARY_POSIX64";
  62. case BINARY_WIN32:
  63. return "BINARY_WIN32";
  64. case BINARY_WIN64:
  65. return "BINARY_WIN64";
  66. case BINARY_OTHER:
  67. return "BINARY_OTHER";
  68. }
  69. carla_stderr("CarlaBackend::BinaryType2Str(%i) - invalid type", type);
  70. return nullptr;
  71. }
  72. static inline
  73. const char* PluginType2Str(const PluginType& type)
  74. {
  75. switch (type)
  76. {
  77. case PLUGIN_NONE:
  78. return "PLUGIN_NONE";
  79. case PLUGIN_INTERNAL:
  80. return "PLUGIN_INTERNAL";
  81. case PLUGIN_LADSPA:
  82. return "PLUGIN_LADSPA";
  83. case PLUGIN_DSSI:
  84. return "PLUGIN_DSSI";
  85. case PLUGIN_LV2:
  86. return "PLUGIN_LV2";
  87. case PLUGIN_VST:
  88. return "PLUGIN_VST";
  89. case PLUGIN_VST3:
  90. return "PLUGIN_VST3";
  91. case PLUGIN_GIG:
  92. return "PLUGIN_GIG";
  93. case PLUGIN_SF2:
  94. return "PLUGIN_SF2";
  95. case PLUGIN_SFZ:
  96. return "PLUGIN_SFZ";
  97. }
  98. carla_stderr("CarlaBackend::PluginType2Str(%i) - invalid type", type);
  99. return nullptr;
  100. }
  101. static inline
  102. const char* PluginCategory2Str(const PluginCategory& category)
  103. {
  104. switch (category)
  105. {
  106. case PLUGIN_CATEGORY_NONE:
  107. return "PLUGIN_CATEGORY_NONE";
  108. case PLUGIN_CATEGORY_SYNTH:
  109. return "PLUGIN_CATEGORY_SYNTH";
  110. case PLUGIN_CATEGORY_DELAY:
  111. return "PLUGIN_CATEGORY_DELAY";
  112. case PLUGIN_CATEGORY_EQ:
  113. return "PLUGIN_CATEGORY_EQ";
  114. case PLUGIN_CATEGORY_FILTER:
  115. return "PLUGIN_CATEGORY_FILTER";
  116. case PLUGIN_CATEGORY_DYNAMICS:
  117. return "PLUGIN_CATEGORY_DYNAMICS";
  118. case PLUGIN_CATEGORY_MODULATOR:
  119. return "PLUGIN_CATEGORY_MODULATOR";
  120. case PLUGIN_CATEGORY_UTILITY:
  121. return "PLUGIN_CATEGORY_UTILITY";
  122. case PLUGIN_CATEGORY_OTHER:
  123. return "PLUGIN_CATEGORY_OTHER";
  124. }
  125. carla_stderr("CarlaBackend::PluginCategory2Str(%i) - invalid category", category);
  126. return nullptr;
  127. }
  128. static inline
  129. const char* ParameterType2Str(const ParameterType& type)
  130. {
  131. switch (type)
  132. {
  133. case PARAMETER_UNKNOWN:
  134. return "PARAMETER_UNKNOWN";
  135. case PARAMETER_INPUT:
  136. return "PARAMETER_INPUT";
  137. case PARAMETER_OUTPUT:
  138. return "PARAMETER_OUTPUT";
  139. case PARAMETER_LATENCY:
  140. return "PARAMETER_LATENCY";
  141. case PARAMETER_SAMPLE_RATE:
  142. return "PARAMETER_SAMPLE_RATE";
  143. #ifdef WANT_LV2
  144. case PARAMETER_LV2_FREEWHEEL:
  145. return "PARAMETER_LV2_FREEWHEEL";
  146. case PARAMETER_LV2_TIME:
  147. return "PARAMETER_LV2_TIME";
  148. #endif
  149. }
  150. carla_stderr("CarlaBackend::ParameterType2Str(%i) - invalid type", type);
  151. return nullptr;
  152. }
  153. static inline
  154. const char* InternalParametersIndex2Str(const InternalParametersIndex& index)
  155. {
  156. switch (index)
  157. {
  158. case PARAMETER_NULL:
  159. return "PARAMETER_NULL";
  160. case PARAMETER_ACTIVE:
  161. return "PARAMETER_ACTIVE";
  162. case PARAMETER_DRYWET:
  163. return "PARAMETER_DRYWET";
  164. case PARAMETER_VOLUME:
  165. return "PARAMETER_VOLUME";
  166. case PARAMETER_BALANCE_LEFT:
  167. return "PARAMETER_BALANCE_LEFT";
  168. case PARAMETER_BALANCE_RIGHT:
  169. return "PARAMETER_BALANCE_RIGHT";
  170. case PARAMETER_PANNING:
  171. return "PARAMETER_PANNING";
  172. case PARAMETER_CTRL_CHANNEL:
  173. return "PARAMETER_CTRL_CHANNEL";
  174. case PARAMETER_MAX:
  175. return "PARAMETER_MAX";
  176. }
  177. carla_stderr("CarlaBackend::InternalParametersIndex2Str(%i) - invalid index", index);
  178. return nullptr;
  179. }
  180. static inline
  181. const char* OptionsType2Str(const OptionsType& type)
  182. {
  183. switch (type)
  184. {
  185. case OPTION_PROCESS_NAME:
  186. return "OPTION_PROCESS_NAME";
  187. case OPTION_PROCESS_MODE:
  188. return "OPTION_PROCESS_MODE";
  189. case OPTION_TRANSPORT_MODE:
  190. return "OPTION_TRANSPORT_MODE";
  191. case OPTION_FORCE_STEREO:
  192. return "OPTION_FORCE_STEREO";
  193. case OPTION_PREFER_PLUGIN_BRIDGES:
  194. return "OPTION_PREFER_PLUGIN_BRIDGES";
  195. case OPTION_PREFER_UI_BRIDGES:
  196. return "OPTION_PREFER_UI_BRIDGES";
  197. #ifdef WANT_DSSI
  198. case OPTION_USE_DSSI_VST_CHUNKS:
  199. return "OPTION_USE_DSSI_VST_CHUNKS";
  200. #endif
  201. case OPTION_MAX_PARAMETERS:
  202. return "OPTION_MAX_PARAMETERS";
  203. case OPTION_OSC_UI_TIMEOUT:
  204. return "OPTION_OSC_UI_TIMEOUT";
  205. case OPTION_PREFERRED_BUFFER_SIZE:
  206. return "OPTION_PREFERRED_BUFFER_SIZE";
  207. case OPTION_PREFERRED_SAMPLE_RATE:
  208. return "OPTION_PREFERRED_SAMPLE_RATE";
  209. #ifndef BUILD_BRIDGE
  210. case OPTION_PATH_BRIDGE_NATIVE:
  211. return "OPTION_PATH_BRIDGE_NATIVE";
  212. case OPTION_PATH_BRIDGE_POSIX32:
  213. return "OPTION_PATH_BRIDGE_POSIX32";
  214. case OPTION_PATH_BRIDGE_POSIX64:
  215. return "OPTION_PATH_BRIDGE_POSIX64";
  216. case OPTION_PATH_BRIDGE_WIN32:
  217. return "OPTION_PATH_BRIDGE_WIN32";
  218. case OPTION_PATH_BRIDGE_WIN64:
  219. return "OPTION_PATH_BRIDGE_WIN64";
  220. #endif
  221. #ifdef WANT_LV2
  222. case OPTION_PATH_BRIDGE_LV2_GTK2:
  223. return "OPTION_PATH_BRIDGE_LV2_GTK2";
  224. case OPTION_PATH_BRIDGE_LV2_GTK3:
  225. return "OPTION_PATH_BRIDGE_LV2_GTK3";
  226. case OPTION_PATH_BRIDGE_LV2_QT4:
  227. return "OPTION_PATH_BRIDGE_LV2_QT4";
  228. case OPTION_PATH_BRIDGE_LV2_QT5:
  229. return "OPTION_PATH_BRIDGE_LV2_QT5";
  230. case OPTION_PATH_BRIDGE_LV2_COCOA:
  231. return "OPTION_PATH_BRIDGE_LV2_COCOA";
  232. case OPTION_PATH_BRIDGE_LV2_WINDOWS:
  233. return "OPTION_PATH_BRIDGE_LV2_WINDOWS";
  234. case OPTION_PATH_BRIDGE_LV2_X11:
  235. return "OPTION_PATH_BRIDGE_LV2_X11";
  236. #endif
  237. #ifdef WANT_VST
  238. case OPTION_PATH_BRIDGE_VST_COCOA:
  239. return "OPTION_PATH_BRIDGE_VST_COCOA";
  240. case OPTION_PATH_BRIDGE_VST_HWND:
  241. return "OPTION_PATH_BRIDGE_VST_HWND";
  242. case OPTION_PATH_BRIDGE_VST_X11:
  243. return "OPTION_PATH_BRIDGE_VST_X11";
  244. #endif
  245. }
  246. carla_stderr("CarlaBackend::OptionsType2Str(%i) - invalid type", type);
  247. return nullptr;
  248. }
  249. static inline
  250. const char* CallbackType2Str(const CallbackType& type)
  251. {
  252. switch (type)
  253. {
  254. case CALLBACK_DEBUG:
  255. return "CALLBACK_DEBUG";
  256. case CALLBACK_PLUGIN_ADDED:
  257. return "CALLBACK_PLUGIN_ADDED";
  258. case CALLBACK_PLUGIN_REMOVED:
  259. return "CALLBACK_PLUGIN_REMOVED";
  260. case CALLBACK_PLUGIN_RENAMED:
  261. return "CALLBACK_PLUGIN_RENAMED";
  262. case CALLBACK_PARAMETER_VALUE_CHANGED:
  263. return "CALLBACK_PARAMETER_VALUE_CHANGED";
  264. case CALLBACK_PARAMETER_DEFAULT_CHANGED:
  265. return "CALLBACK_PARAMETER_DEFAULT_CHANGED";
  266. case CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED:
  267. return "CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED";
  268. case CALLBACK_PARAMETER_MIDI_CC_CHANGED:
  269. return "CALLBACK_PARAMETER_MIDI_CC_CHANGED";
  270. case CALLBACK_PROGRAM_CHANGED:
  271. return "CALLBACK_PROGRAM_CHANGED";
  272. case CALLBACK_MIDI_PROGRAM_CHANGED:
  273. return "CALLBACK_MIDI_PROGRAM_CHANGED";
  274. case CALLBACK_NOTE_ON:
  275. return "CALLBACK_NOTE_ON";
  276. case CALLBACK_NOTE_OFF:
  277. return "CALLBACK_NOTE_OFF";
  278. case CALLBACK_SHOW_GUI:
  279. return "CALLBACK_SHOW_GUI";
  280. case CALLBACK_UPDATE:
  281. return "CALLBACK_UPDATE";
  282. case CALLBACK_PATCHBAY_CLIENT_ADDED:
  283. return "CALLBACK_PATCHBAY_CLIENT_ADDED";
  284. case CALLBACK_PATCHBAY_CLIENT_REMOVED:
  285. return "CALLBACK_PATCHBAY_CLIENT_REMOVED";
  286. case CALLBACK_PATCHBAY_CLIENT_RENAMED:
  287. return "CALLBACK_PATCHBAY_CLIENT_RENAMED";
  288. case CALLBACK_PATCHBAY_PORT_ADDED:
  289. return "CALLBACK_PATCHBAY_PORT_ADDED";
  290. case CALLBACK_PATCHBAY_PORT_REMOVED:
  291. return "CALLBACK_PATCHBAY_PORT_REMOVED";
  292. case CALLBACK_PATCHBAY_PORT_RENAMED:
  293. return "CALLBACK_PATCHBAY_PORT_RENAMED";
  294. case CALLBACK_PATCHBAY_CONNECTION_ADDED:
  295. return "CALLBACK_PATCHBAY_CONNECTION_ADDED";
  296. case CALLBACK_PATCHBAY_CONNECTION_REMOVED:
  297. return "CALLBACK_PATCHBAY_CONNECTION_REMOVED";
  298. case CALLBACK_RELOAD_INFO:
  299. return "CALLBACK_RELOAD_INFO";
  300. case CALLBACK_RELOAD_PARAMETERS:
  301. return "CALLBACK_RELOAD_PARAMETERS";
  302. case CALLBACK_RELOAD_PROGRAMS:
  303. return "CALLBACK_RELOAD_PROGRAMS";
  304. case CALLBACK_RELOAD_ALL:
  305. return "CALLBACK_RELOAD_ALL";
  306. case CALLBACK_BUFFER_SIZE_CHANGED:
  307. return "CALLBACK_BUFFER_SIZE_CHANGED";
  308. case CALLBACK_SAMPLE_RATE_CHANGED:
  309. return "CALLBACK_SAMPLE_RATE_CHANGED";
  310. case CALLBACK_NSM_ANNOUNCE:
  311. return "CALLBACK_NSM_ANNOUNCE";
  312. case CALLBACK_NSM_OPEN:
  313. return "CALLBACK_NSM_OPEN";
  314. case CALLBACK_NSM_SAVE:
  315. return "CALLBACK_NSM_SAVE";
  316. case CALLBACK_ERROR:
  317. return "CALLBACK_ERROR";
  318. case CALLBACK_QUIT:
  319. return "CALLBACK_QUIT";
  320. }
  321. carla_stderr("CarlaBackend::CallbackType2Str(%i) - invalid type", type);
  322. return nullptr;
  323. }
  324. static inline
  325. const char* ProcessMode2Str(const ProcessMode& mode)
  326. {
  327. switch (mode)
  328. {
  329. case PROCESS_MODE_SINGLE_CLIENT:
  330. return "PROCESS_MODE_SINGLE_CLIENT";
  331. case PROCESS_MODE_MULTIPLE_CLIENTS:
  332. return "PROCESS_MODE_MULTIPLE_CLIENTS";
  333. case PROCESS_MODE_CONTINUOUS_RACK:
  334. return "PROCESS_MODE_CONTINUOUS_RACK";
  335. case PROCESS_MODE_PATCHBAY:
  336. return "PROCESS_MODE_PATCHBAY";
  337. case PROCESS_MODE_BRIDGE:
  338. return "PROCESS_MODE_BRIDGE";
  339. }
  340. carla_stderr("CarlaBackend::ProcessMode2Str(%i) - invalid type", mode);
  341. return nullptr;
  342. }
  343. static inline
  344. const char* TransportMode2Str(const TransportMode& mode)
  345. {
  346. switch (mode)
  347. {
  348. case TRANSPORT_MODE_INTERNAL:
  349. return "TRANSPORT_MODE_INTERNAL";
  350. case TRANSPORT_MODE_JACK:
  351. return "TRANSPORT_MODE_JACK";
  352. case TRANSPORT_MODE_BRIDGE:
  353. return "TRANSPORT_MODE_BRIDGE";
  354. }
  355. carla_stderr("CarlaBackend::TransportMode2Str(%i) - invalid type", mode);
  356. return nullptr;
  357. }
  358. // -------------------------------------------------
  359. static inline
  360. uintptr_t getAddressFromPointer(void* ptr)
  361. {
  362. CARLA_ASSERT(ptr != nullptr);
  363. uintptr_t* addr = (uintptr_t*)&ptr;
  364. return *addr;
  365. }
  366. static inline
  367. void* getPointerFromAddress(uintptr_t& addr)
  368. {
  369. CARLA_ASSERT(addr != 0);
  370. uintptr_t** const ptr = (uintptr_t**)&addr;
  371. return *ptr;
  372. }
  373. // -------------------------------------------------
  374. static inline
  375. const char* getPluginTypeAsString(const PluginType& type)
  376. {
  377. carla_debug("CarlaBackend::getPluginTypeAsString(%s)", PluginType2Str(type));
  378. switch (type)
  379. {
  380. case PLUGIN_NONE:
  381. return "NONE";
  382. case PLUGIN_INTERNAL:
  383. return "INTERNAL";
  384. case PLUGIN_LADSPA:
  385. return "LADSPA";
  386. case PLUGIN_DSSI:
  387. return "DSSI";
  388. case PLUGIN_LV2:
  389. return "LV2";
  390. case PLUGIN_VST:
  391. return "VST";
  392. case PLUGIN_VST3:
  393. return "VST3";
  394. case PLUGIN_GIG:
  395. return "GIG";
  396. case PLUGIN_SF2:
  397. return "SF2";
  398. case PLUGIN_SFZ:
  399. return "SFZ";
  400. }
  401. carla_stderr("CarlaBackend::getPluginTypeAsString(%i) - invalid type", type);
  402. return "NONE";
  403. }
  404. static inline
  405. PluginType getPluginTypeFromString(const char* const stype)
  406. {
  407. CARLA_ASSERT(stype != nullptr);
  408. carla_debug("CarlaBackend::getPluginTypeFromString(%s)", stype);
  409. if (stype == nullptr)
  410. {
  411. carla_stderr("CarlaBackend::getPluginTypeFromString() - null string type");
  412. return PLUGIN_NONE;
  413. }
  414. if (std::strcmp(stype, "NONE") == 0)
  415. return PLUGIN_NONE;
  416. if (std::strcmp(stype, "INTERNAL") == 0 || std::strcmp(stype, "Internal") == 0)
  417. return PLUGIN_INTERNAL;
  418. if (std::strcmp(stype, "LADSPA") == 0)
  419. return PLUGIN_LADSPA;
  420. if (std::strcmp(stype, "DSSI") == 0)
  421. return PLUGIN_DSSI;
  422. if (std::strcmp(stype, "LV2") == 0)
  423. return PLUGIN_LV2;
  424. if (std::strcmp(stype, "VST") == 0)
  425. return PLUGIN_VST;
  426. if (std::strcmp(stype, "VST3") == 0)
  427. return PLUGIN_VST3;
  428. if (std::strcmp(stype, "GIG") == 0)
  429. return PLUGIN_GIG;
  430. if (std::strcmp(stype, "SF2") == 0)
  431. return PLUGIN_SF2;
  432. if (std::strcmp(stype, "SFZ") == 0)
  433. return PLUGIN_SFZ;
  434. carla_stderr("CarlaBackend::getPluginTypeFromString(%s) - invalid string type", stype);
  435. return PLUGIN_NONE;
  436. }
  437. // -------------------------------------------------
  438. static inline
  439. PluginCategory getPluginCategoryFromName(const char* const name)
  440. {
  441. CARLA_ASSERT(name != nullptr);
  442. carla_debug("CarlaBackend::getPluginCategoryFromName(\"%s\")", name);
  443. if (name == nullptr)
  444. {
  445. carla_stderr("CarlaBackend::getPluginCategoryFromName() - null name");
  446. return PLUGIN_CATEGORY_NONE;
  447. }
  448. CarlaString sname(name);
  449. if (sname.isEmpty())
  450. return PLUGIN_CATEGORY_NONE;
  451. sname.toLower();
  452. // generic tags first
  453. if (sname.contains("delay"))
  454. return PLUGIN_CATEGORY_DELAY;
  455. if (sname.contains("reverb"))
  456. return PLUGIN_CATEGORY_DELAY;
  457. // filter
  458. if (sname.contains("filter"))
  459. return PLUGIN_CATEGORY_FILTER;
  460. // dynamics
  461. if (sname.contains("dynamics"))
  462. return PLUGIN_CATEGORY_DYNAMICS;
  463. if (sname.contains("amplifier"))
  464. return PLUGIN_CATEGORY_DYNAMICS;
  465. if (sname.contains("compressor"))
  466. return PLUGIN_CATEGORY_DYNAMICS;
  467. if (sname.contains("enhancer"))
  468. return PLUGIN_CATEGORY_DYNAMICS;
  469. if (sname.contains("exciter"))
  470. return PLUGIN_CATEGORY_DYNAMICS;
  471. if (sname.contains("gate"))
  472. return PLUGIN_CATEGORY_DYNAMICS;
  473. if (sname.contains("limiter"))
  474. return PLUGIN_CATEGORY_DYNAMICS;
  475. // modulator
  476. if (sname.contains("modulator"))
  477. return PLUGIN_CATEGORY_MODULATOR;
  478. if (sname.contains("chorus"))
  479. return PLUGIN_CATEGORY_MODULATOR;
  480. if (sname.contains("flanger"))
  481. return PLUGIN_CATEGORY_MODULATOR;
  482. if (sname.contains("phaser"))
  483. return PLUGIN_CATEGORY_MODULATOR;
  484. if (sname.contains("saturator"))
  485. return PLUGIN_CATEGORY_MODULATOR;
  486. // utility
  487. if (sname.contains("utility"))
  488. return PLUGIN_CATEGORY_UTILITY;
  489. if (sname.contains("analyzer"))
  490. return PLUGIN_CATEGORY_UTILITY;
  491. if (sname.contains("converter"))
  492. return PLUGIN_CATEGORY_UTILITY;
  493. if (sname.contains("deesser"))
  494. return PLUGIN_CATEGORY_UTILITY;
  495. if (sname.contains("mixer"))
  496. return PLUGIN_CATEGORY_UTILITY;
  497. // common tags
  498. if (sname.contains("verb"))
  499. return PLUGIN_CATEGORY_DELAY;
  500. if (sname.contains("eq"))
  501. return PLUGIN_CATEGORY_EQ;
  502. if (sname.contains("tool"))
  503. return PLUGIN_CATEGORY_UTILITY;
  504. return PLUGIN_CATEGORY_NONE;
  505. }
  506. CARLA_BACKEND_END_NAMESPACE
  507. #endif // __CARLA_BACKEND_UTILS_HPP__