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.

521 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 doc/GPL.txt file.
  16. */
  17. #ifndef CARLA_BACKEND_UTILS_HPP_INCLUDED
  18. #define CARLA_BACKEND_UTILS_HPP_INCLUDED
  19. #include "CarlaBackend.h"
  20. #include "CarlaHost.h"
  21. #include "CarlaString.hpp"
  22. CARLA_BACKEND_START_NAMESPACE
  23. // -----------------------------------------------------------------------
  24. static inline
  25. const char* PluginOption2Str(const unsigned int option)
  26. {
  27. switch (option)
  28. {
  29. case PLUGIN_OPTION_FIXED_BUFFERS:
  30. return "PLUGIN_OPTION_FIXED_BUFFERS";
  31. case PLUGIN_OPTION_FORCE_STEREO:
  32. return "PLUGIN_OPTION_FORCE_STEREO";
  33. case PLUGIN_OPTION_MAP_PROGRAM_CHANGES:
  34. return "PLUGIN_OPTION_MAP_PROGRAM_CHANGES";
  35. case PLUGIN_OPTION_USE_CHUNKS:
  36. return "PLUGIN_OPTION_USE_CHUNKS";
  37. case PLUGIN_OPTION_SEND_CONTROL_CHANGES:
  38. return "PLUGIN_OPTION_SEND_CONTROL_CHANGES";
  39. case PLUGIN_OPTION_SEND_CHANNEL_PRESSURE:
  40. return "PLUGIN_OPTION_SEND_CHANNEL_PRESSURE";
  41. case PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH:
  42. return "PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH";
  43. case PLUGIN_OPTION_SEND_PITCHBEND:
  44. return "PLUGIN_OPTION_SEND_PITCHBEND";
  45. case PLUGIN_OPTION_SEND_ALL_SOUND_OFF:
  46. return "PLUGIN_OPTION_SEND_ALL_SOUND_OFF";
  47. }
  48. carla_stderr("CarlaBackend::PluginOption2Str(%i) - invalid option", option);
  49. return nullptr;
  50. }
  51. // -----------------------------------------------------------------------
  52. static inline
  53. const char* BinaryType2Str(const BinaryType type)
  54. {
  55. switch (type)
  56. {
  57. case BINARY_NONE:
  58. return "BINARY_NONE";
  59. case BINARY_POSIX32:
  60. return "BINARY_POSIX32";
  61. case BINARY_POSIX64:
  62. return "BINARY_POSIX64";
  63. case BINARY_WIN32:
  64. return "BINARY_WIN32";
  65. case BINARY_WIN64:
  66. return "BINARY_WIN64";
  67. case BINARY_OTHER:
  68. return "BINARY_OTHER";
  69. }
  70. carla_stderr("CarlaBackend::BinaryType2Str(%i) - invalid type", type);
  71. return nullptr;
  72. }
  73. static inline
  74. const char* PluginType2Str(const PluginType type)
  75. {
  76. switch (type)
  77. {
  78. case PLUGIN_NONE:
  79. return "PLUGIN_NONE";
  80. case PLUGIN_INTERNAL:
  81. return "PLUGIN_INTERNAL";
  82. case PLUGIN_LADSPA:
  83. return "PLUGIN_LADSPA";
  84. case PLUGIN_DSSI:
  85. return "PLUGIN_DSSI";
  86. case PLUGIN_LV2:
  87. return "PLUGIN_LV2";
  88. case PLUGIN_VST:
  89. return "PLUGIN_VST";
  90. case PLUGIN_AU:
  91. return "PLUGIN_AU";
  92. case PLUGIN_CSOUND:
  93. return "PLUGIN_CSOUND";
  94. case PLUGIN_GIG:
  95. return "PLUGIN_GIG";
  96. case PLUGIN_SF2:
  97. return "PLUGIN_SF2";
  98. case PLUGIN_SFZ:
  99. return "PLUGIN_SFZ";
  100. }
  101. carla_stderr("CarlaBackend::PluginType2Str(%i) - invalid type", type);
  102. return nullptr;
  103. }
  104. static inline
  105. const char* PluginCategory2Str(const PluginCategory category)
  106. {
  107. switch (category)
  108. {
  109. case PLUGIN_CATEGORY_NONE:
  110. return "PLUGIN_CATEGORY_NONE";
  111. case PLUGIN_CATEGORY_SYNTH:
  112. return "PLUGIN_CATEGORY_SYNTH";
  113. case PLUGIN_CATEGORY_DELAY:
  114. return "PLUGIN_CATEGORY_DELAY";
  115. case PLUGIN_CATEGORY_EQ:
  116. return "PLUGIN_CATEGORY_EQ";
  117. case PLUGIN_CATEGORY_FILTER:
  118. return "PLUGIN_CATEGORY_FILTER";
  119. case PLUGIN_CATEGORY_DISTORTION:
  120. return "PLUGIN_CATEGORY_DISTORTION";
  121. case PLUGIN_CATEGORY_DYNAMICS:
  122. return "PLUGIN_CATEGORY_DYNAMICS";
  123. case PLUGIN_CATEGORY_MODULATOR:
  124. return "PLUGIN_CATEGORY_MODULATOR";
  125. case PLUGIN_CATEGORY_UTILITY:
  126. return "PLUGIN_CATEGORY_UTILITY";
  127. case PLUGIN_CATEGORY_OTHER:
  128. return "PLUGIN_CATEGORY_OTHER";
  129. }
  130. carla_stderr("CarlaBackend::PluginCategory2Str(%i) - invalid category", category);
  131. return nullptr;
  132. }
  133. static inline
  134. const char* InternalParameterIndex2Str(const InternalParameterIndex index)
  135. {
  136. switch (index)
  137. {
  138. case PARAMETER_NULL:
  139. return "PARAMETER_NULL";
  140. case PARAMETER_ACTIVE:
  141. return "PARAMETER_ACTIVE";
  142. case PARAMETER_DRYWET:
  143. return "PARAMETER_DRYWET";
  144. case PARAMETER_VOLUME:
  145. return "PARAMETER_VOLUME";
  146. case PARAMETER_BALANCE_LEFT:
  147. return "PARAMETER_BALANCE_LEFT";
  148. case PARAMETER_BALANCE_RIGHT:
  149. return "PARAMETER_BALANCE_RIGHT";
  150. case PARAMETER_PANNING:
  151. return "PARAMETER_PANNING";
  152. case PARAMETER_CTRL_CHANNEL:
  153. return "PARAMETER_CTRL_CHANNEL";
  154. case PARAMETER_MAX:
  155. return "PARAMETER_MAX";
  156. }
  157. carla_stderr("CarlaBackend::InternalParameterIndex2Str(%i) - invalid index", index);
  158. return nullptr;
  159. }
  160. static inline
  161. const char* EngineCallbackOpcode2Str(const EngineCallbackOpcode opcode)
  162. {
  163. switch (opcode)
  164. {
  165. case ENGINE_CALLBACK_DEBUG:
  166. return "ENGINE_CALLBACK_DEBUG";
  167. case ENGINE_CALLBACK_PLUGIN_ADDED:
  168. return "ENGINE_CALLBACK_PLUGIN_ADDED";
  169. case ENGINE_CALLBACK_PLUGIN_REMOVED:
  170. return "ENGINE_CALLBACK_PLUGIN_REMOVED";
  171. case ENGINE_CALLBACK_PLUGIN_RENAMED:
  172. return "ENGINE_CALLBACK_PLUGIN_RENAMED";
  173. case ENGINE_CALLBACK_PLUGIN_UNAVAILABLE:
  174. return "ENGINE_CALLBACK_PLUGIN_UNAVAILABLE";
  175. case ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED:
  176. return "ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED";
  177. case ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED:
  178. return "ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED";
  179. case ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED:
  180. return "ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED";
  181. case ENGINE_CALLBACK_PARAMETER_MIDI_CC_CHANGED:
  182. return "ENGINE_CALLBACK_PARAMETER_MIDI_CC_CHANGED";
  183. case ENGINE_CALLBACK_PROGRAM_CHANGED:
  184. return "ENGINE_CALLBACK_PROGRAM_CHANGED";
  185. case ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED:
  186. return "ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED";
  187. case ENGINE_CALLBACK_UI_STATE_CHANGED:
  188. return "ENGINE_CALLBACK_UI_STATE_CHANGED";
  189. case ENGINE_CALLBACK_NOTE_ON:
  190. return "ENGINE_CALLBACK_NOTE_ON";
  191. case ENGINE_CALLBACK_NOTE_OFF:
  192. return "ENGINE_CALLBACK_NOTE_OFF";
  193. case ENGINE_CALLBACK_UPDATE:
  194. return "ENGINE_CALLBACK_UPDATE";
  195. case ENGINE_CALLBACK_RELOAD_INFO:
  196. return "ENGINE_CALLBACK_RELOAD_INFO";
  197. case ENGINE_CALLBACK_RELOAD_PARAMETERS:
  198. return "ENGINE_CALLBACK_RELOAD_PARAMETERS";
  199. case ENGINE_CALLBACK_RELOAD_PROGRAMS:
  200. return "ENGINE_CALLBACK_RELOAD_PROGRAMS";
  201. case ENGINE_CALLBACK_RELOAD_ALL:
  202. return "ENGINE_CALLBACK_RELOAD_ALL";
  203. case ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED:
  204. return "ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED";
  205. case ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED:
  206. return "ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED";
  207. case ENGINE_CALLBACK_PATCHBAY_CLIENT_RENAMED:
  208. return "ENGINE_CALLBACK_PATCHBAY_CLIENT_RENAMED";
  209. case ENGINE_CALLBACK_PATCHBAY_CLIENT_ICON_CHANGED:
  210. return "ENGINE_CALLBACK_PATCHBAY_CLIENT_ICON_CHANGED";
  211. case ENGINE_CALLBACK_PATCHBAY_PORT_ADDED:
  212. return "ENGINE_CALLBACK_PATCHBAY_PORT_ADDED";
  213. case ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED:
  214. return "ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED";
  215. case ENGINE_CALLBACK_PATCHBAY_PORT_RENAMED:
  216. return "ENGINE_CALLBACK_PATCHBAY_PORT_RENAMED";
  217. case ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED:
  218. return "ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED";
  219. case ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED:
  220. return "ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED";
  221. case ENGINE_CALLBACK_ENGINE_STARTED:
  222. return "ENGINE_CALLBACK_ENGINE_STARTED";
  223. case ENGINE_CALLBACK_ENGINE_STOPPED:
  224. return "ENGINE_CALLBACK_ENGINE_STOPPED";
  225. case ENGINE_CALLBACK_PROCESS_MODE_CHANGED:
  226. return "ENGINE_CALLBACK_PROCESS_MODE_CHANGED";
  227. case ENGINE_CALLBACK_TRANSPORT_MODE_CHANGED:
  228. return "ENGINE_CALLBACK_TRANSPORT_MODE_CHANGED";
  229. case ENGINE_CALLBACK_BUFFER_SIZE_CHANGED:
  230. return "ENGINE_CALLBACK_BUFFER_SIZE_CHANGED";
  231. case ENGINE_CALLBACK_SAMPLE_RATE_CHANGED:
  232. return "ENGINE_CALLBACK_SAMPLE_RATE_CHANGED";
  233. case ENGINE_CALLBACK_INFO:
  234. return "ENGINE_CALLBACK_INFO";
  235. case ENGINE_CALLBACK_ERROR:
  236. return "ENGINE_CALLBACK_ERROR";
  237. case ENGINE_CALLBACK_QUIT:
  238. return "ENGINE_CALLBACK_QUIT";
  239. }
  240. carla_stderr("CarlaBackend::EngineCallbackOpcode2Str(%i) - invalid opcode", opcode);
  241. return nullptr;
  242. }
  243. static inline
  244. const char* EngineOption2Str(const EngineOption option)
  245. {
  246. switch (option)
  247. {
  248. case ENGINE_OPTION_DEBUG:
  249. return "ENGINE_OPTION_DEBUG";
  250. case ENGINE_OPTION_PROCESS_MODE:
  251. return "ENGINE_OPTION_PROCESS_MODE";
  252. case ENGINE_OPTION_TRANSPORT_MODE:
  253. return "ENGINE_OPTION_TRANSPORT_MODE";
  254. case ENGINE_OPTION_FORCE_STEREO:
  255. return "ENGINE_OPTION_FORCE_STEREO";
  256. case ENGINE_OPTION_PREFER_PLUGIN_BRIDGES:
  257. return "ENGINE_OPTION_PREFER_PLUGIN_BRIDGES";
  258. case ENGINE_OPTION_PREFER_UI_BRIDGES:
  259. return "ENGINE_OPTION_PREFER_UI_BRIDGES";
  260. case ENGINE_OPTION_UIS_ALWAYS_ON_TOP:
  261. return "ENGINE_OPTION_UIS_ALWAYS_ON_TOP";
  262. case ENGINE_OPTION_MAX_PARAMETERS:
  263. return "ENGINE_OPTION_MAX_PARAMETERS";
  264. case ENGINE_OPTION_UI_BRIDGES_TIMEOUT:
  265. return "ENGINE_OPTION_UI_BRIDGES_TIMEOUT";
  266. case ENGINE_OPTION_AUDIO_NUM_PERIODS:
  267. return "ENGINE_OPTION_AUDIO_NUM_PERIODS";
  268. case ENGINE_OPTION_AUDIO_BUFFER_SIZE:
  269. return "ENGINE_OPTION_AUDIO_BUFFER_SIZE";
  270. case ENGINE_OPTION_AUDIO_SAMPLE_RATE:
  271. return "ENGINE_OPTION_AUDIO_SAMPLE_RATE";
  272. case ENGINE_OPTION_AUDIO_DEVICE:
  273. return "ENGINE_OPTION_AUDIO_DEVICE";
  274. case ENGINE_OPTION_PATH_BINARIES:
  275. return "ENGINE_OPTION_PATH_BINARIES";
  276. case ENGINE_OPTION_PATH_RESOURCES:
  277. return "ENGINE_OPTION_PATH_RESOURCES";
  278. }
  279. carla_stderr("CarlaBackend::EngineOption2Str(%i) - invalid option", option);
  280. return nullptr;
  281. }
  282. static inline
  283. const char* EngineProcessMode2Str(const EngineProcessMode mode)
  284. {
  285. switch (mode)
  286. {
  287. case ENGINE_PROCESS_MODE_SINGLE_CLIENT:
  288. return "ENGINE_PROCESS_MODE_SINGLE_CLIENT";
  289. case ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS:
  290. return "ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS";
  291. case ENGINE_PROCESS_MODE_CONTINUOUS_RACK:
  292. return "ENGINE_PROCESS_MODE_CONTINUOUS_RACK";
  293. case ENGINE_PROCESS_MODE_PATCHBAY:
  294. return "ENGINE_PROCESS_MODE_PATCHBAY";
  295. case ENGINE_PROCESS_MODE_BRIDGE:
  296. return "ENGINE_PROCESS_MODE_BRIDGE";
  297. }
  298. carla_stderr("CarlaBackend::EngineProcessMode2Str(%i) - invalid mode", mode);
  299. return nullptr;
  300. }
  301. static inline
  302. const char* EngineTransportMode2Str(const EngineTransportMode mode)
  303. {
  304. switch (mode)
  305. {
  306. case ENGINE_TRANSPORT_MODE_INTERNAL:
  307. return "ENGINE_TRANSPORT_MODE_INTERNAL";
  308. case ENGINE_TRANSPORT_MODE_JACK:
  309. return "ENGINE_TRANSPORT_MODE_JACK";
  310. case ENGINE_TRANSPORT_MODE_PLUGIN:
  311. return "ENGINE_TRANSPORT_MODE_PLUGIN";
  312. case ENGINE_TRANSPORT_MODE_BRIDGE:
  313. return "ENGINE_TRANSPORT_MODE_BRIDGE";
  314. }
  315. carla_stderr("CarlaBackend::EngineTransportMode2Str(%i) - invalid mode", mode);
  316. return nullptr;
  317. }
  318. // -----------------------------------------------------------------------
  319. static inline
  320. const char* FileCallbackOpcode2Str(const FileCallbackOpcode opcode)
  321. {
  322. switch (opcode)
  323. {
  324. case FILE_CALLBACK_DEBUG:
  325. return "FILE_CALLBACK_DEBUG";
  326. case FILE_CALLBACK_OPEN:
  327. return "FILE_CALLBACK_OPEN";
  328. case FILE_CALLBACK_SAVE:
  329. return "FILE_CALLBACK_SAVE";
  330. }
  331. carla_stderr("CarlaBackend::FileCallbackOpcode2Str(%i) - invalid opcode", opcode);
  332. return nullptr;
  333. }
  334. // -----------------------------------------------------------------------
  335. static inline
  336. const char* getPluginTypeAsString(const PluginType type)
  337. {
  338. carla_debug("CarlaBackend::getPluginTypeAsString(%i:%s)", type, PluginType2Str(type));
  339. switch (type)
  340. {
  341. case PLUGIN_NONE:
  342. return "NONE";
  343. case PLUGIN_INTERNAL:
  344. return "INTERNAL";
  345. case PLUGIN_LADSPA:
  346. return "LADSPA";
  347. case PLUGIN_DSSI:
  348. return "DSSI";
  349. case PLUGIN_LV2:
  350. return "LV2";
  351. case PLUGIN_VST:
  352. return "VST";
  353. case PLUGIN_AU:
  354. return "AU";
  355. case PLUGIN_CSOUND:
  356. return "CSOUND";
  357. case PLUGIN_GIG:
  358. return "GIG";
  359. case PLUGIN_SF2:
  360. return "SF2";
  361. case PLUGIN_SFZ:
  362. return "SFZ";
  363. }
  364. carla_stderr("CarlaBackend::getPluginTypeAsString(%i) - invalid type", type);
  365. return "NONE";
  366. }
  367. static inline
  368. PluginType getPluginTypeFromString(const char* const ctype)
  369. {
  370. CARLA_SAFE_ASSERT_RETURN(ctype != nullptr && ctype[0] != '\0', PLUGIN_NONE);
  371. carla_debug("CarlaBackend::getPluginTypeFromString(\"%s\")", ctype);
  372. CarlaString stype(ctype);
  373. stype.toLower();
  374. if (stype.isEmpty() || stype == "none")
  375. return PLUGIN_NONE;
  376. if (stype == "internal")
  377. return PLUGIN_INTERNAL;
  378. if (stype == "ladspa")
  379. return PLUGIN_LADSPA;
  380. if (stype == "dssi")
  381. return PLUGIN_DSSI;
  382. if (stype == "lv2")
  383. return PLUGIN_LV2;
  384. if (stype == "vst")
  385. return PLUGIN_VST;
  386. if (stype == "au")
  387. return PLUGIN_AU;
  388. if (stype == "csound")
  389. return PLUGIN_CSOUND;
  390. if (stype == "gig")
  391. return PLUGIN_GIG;
  392. if (stype == "sf2")
  393. return PLUGIN_SF2;
  394. if (stype == "sfz")
  395. return PLUGIN_SFZ;
  396. carla_stderr("CarlaBackend::getPluginTypeFromString(\"%s\") - invalid string type", ctype);
  397. return PLUGIN_NONE;
  398. }
  399. // -----------------------------------------------------------------------
  400. static inline
  401. PluginCategory getPluginCategoryFromName(const char* const name)
  402. {
  403. CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0', PLUGIN_CATEGORY_NONE);
  404. carla_debug("CarlaBackend::getPluginCategoryFromName(\"%s\")", name);
  405. CarlaString sname(name);
  406. if (sname.isEmpty())
  407. return PLUGIN_CATEGORY_NONE;
  408. sname.toLower();
  409. // generic tags first
  410. if (sname.contains("delay"))
  411. return PLUGIN_CATEGORY_DELAY;
  412. if (sname.contains("reverb"))
  413. return PLUGIN_CATEGORY_DELAY;
  414. // filter
  415. if (sname.contains("filter"))
  416. return PLUGIN_CATEGORY_FILTER;
  417. // distortion
  418. if (sname.contains("distortion"))
  419. return PLUGIN_CATEGORY_DISTORTION;
  420. // dynamics
  421. if (sname.contains("dynamics"))
  422. return PLUGIN_CATEGORY_DYNAMICS;
  423. if (sname.contains("amplifier"))
  424. return PLUGIN_CATEGORY_DYNAMICS;
  425. if (sname.contains("compressor"))
  426. return PLUGIN_CATEGORY_DYNAMICS;
  427. if (sname.contains("enhancer"))
  428. return PLUGIN_CATEGORY_DYNAMICS;
  429. if (sname.contains("exciter"))
  430. return PLUGIN_CATEGORY_DYNAMICS;
  431. if (sname.contains("gate"))
  432. return PLUGIN_CATEGORY_DYNAMICS;
  433. if (sname.contains("limiter"))
  434. return PLUGIN_CATEGORY_DYNAMICS;
  435. // modulator
  436. if (sname.contains("modulator"))
  437. return PLUGIN_CATEGORY_MODULATOR;
  438. if (sname.contains("chorus"))
  439. return PLUGIN_CATEGORY_MODULATOR;
  440. if (sname.contains("flanger"))
  441. return PLUGIN_CATEGORY_MODULATOR;
  442. if (sname.contains("phaser"))
  443. return PLUGIN_CATEGORY_MODULATOR;
  444. if (sname.contains("saturator"))
  445. return PLUGIN_CATEGORY_MODULATOR;
  446. // utility
  447. if (sname.contains("utility"))
  448. return PLUGIN_CATEGORY_UTILITY;
  449. if (sname.contains("analyzer"))
  450. return PLUGIN_CATEGORY_UTILITY;
  451. if (sname.contains("converter"))
  452. return PLUGIN_CATEGORY_UTILITY;
  453. if (sname.contains("deesser"))
  454. return PLUGIN_CATEGORY_UTILITY;
  455. if (sname.contains("mixer"))
  456. return PLUGIN_CATEGORY_UTILITY;
  457. // common tags
  458. if (sname.contains("verb"))
  459. return PLUGIN_CATEGORY_DELAY;
  460. if (sname.contains("eq"))
  461. return PLUGIN_CATEGORY_EQ;
  462. if (sname.contains("tool"))
  463. return PLUGIN_CATEGORY_UTILITY;
  464. return PLUGIN_CATEGORY_NONE;
  465. }
  466. // -----------------------------------------------------------------------
  467. CARLA_BACKEND_END_NAMESPACE
  468. #endif // CARLA_BACKEND_UTILS_HPP_INCLUDED