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.

907 lines
32KB

  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. # Common Carla code
  4. # Copyright (C) 2011-2023 Filipe Coelho <falktx@falktx.com>
  5. #
  6. # This program is free software; you can redistribute it and/or
  7. # modify it under the terms of the GNU General Public License as
  8. # published by the Free Software Foundation; either version 2 of
  9. # the License, or any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU General Public License for more details.
  15. #
  16. # For a full copy of the GNU General Public License see the doc/GPL.txt file.
  17. # ------------------------------------------------------------------------------------------------------------
  18. # Imports (Global)
  19. import os
  20. import sys
  21. from math import fmod
  22. # ------------------------------------------------------------------------------------------------------------
  23. # Imports (Signal)
  24. from signal import signal, SIGINT, SIGTERM
  25. try:
  26. from signal import SIGUSR1
  27. haveSIGUSR1 = True
  28. except:
  29. haveSIGUSR1 = False
  30. # ------------------------------------------------------------------------------------------------------------
  31. # Imports (PyQt5)
  32. from PyQt5.Qt import PYQT_VERSION_STR
  33. from PyQt5.QtCore import qFatal, QT_VERSION, QT_VERSION_STR, qWarning, QDir, QSettings
  34. from PyQt5.QtGui import QIcon
  35. from PyQt5.QtWidgets import QFileDialog, QMessageBox
  36. # ------------------------------------------------------------------------------------------------------------
  37. # Imports (Custom)
  38. from carla_backend import (
  39. kIs64bit, HAIKU, LINUX, MACOS, WINDOWS,
  40. MAX_DEFAULT_PARAMETERS,
  41. ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS,
  42. ENGINE_PROCESS_MODE_PATCHBAY,
  43. ENGINE_TRANSPORT_MODE_INTERNAL,
  44. ENGINE_TRANSPORT_MODE_JACK
  45. )
  46. # ------------------------------------------------------------------------------------------------------------
  47. # Config
  48. # These will be modified during install
  49. X_LIBDIR_X = None
  50. X_DATADIR_X = None
  51. # ------------------------------------------------------------------------------------------------------------
  52. # Platform specific stuff
  53. if WINDOWS:
  54. WINDIR = os.getenv("WINDIR")
  55. # ------------------------------------------------------------------------------------------------------------
  56. # Set Version
  57. VERSION = "2.5.3"
  58. # ------------------------------------------------------------------------------------------------------------
  59. # Set TMP
  60. envTMP = os.getenv("TMP")
  61. if envTMP is None:
  62. if WINDOWS:
  63. qWarning("TMP variable not set")
  64. TMP = QDir.tempPath()
  65. else:
  66. TMP = envTMP
  67. if not os.path.exists(TMP):
  68. qWarning("TMP does not exist")
  69. TMP = "/"
  70. del envTMP
  71. # ------------------------------------------------------------------------------------------------------------
  72. # Set HOME
  73. envHOME = os.getenv("HOME")
  74. if envHOME is None:
  75. if LINUX or MACOS:
  76. qWarning("HOME variable not set")
  77. HOME = QDir.toNativeSeparators(QDir.homePath())
  78. else:
  79. HOME = envHOME
  80. if not os.path.exists(HOME):
  81. qWarning("HOME does not exist")
  82. HOME = TMP
  83. del envHOME
  84. # ------------------------------------------------------------------------------------------------------------
  85. # Set PATH
  86. envPATH = os.getenv("PATH")
  87. if envPATH is None:
  88. qWarning("PATH variable not set")
  89. if MACOS:
  90. PATH = ("/opt/local/bin", "/usr/local/bin", "/usr/bin", "/bin")
  91. elif WINDOWS:
  92. PATH = (os.path.join(WINDIR, "system32"), WINDIR)
  93. else:
  94. PATH = ("/usr/local/bin", "/usr/bin", "/bin")
  95. else:
  96. PATH = envPATH.split(os.pathsep)
  97. del envPATH
  98. # ------------------------------------------------------------------------------------------------------------
  99. # Static MIDI CC list
  100. MIDI_CC_LIST = (
  101. "01 [0x01] Modulation",
  102. "02 [0x02] Breath",
  103. "04 [0x04] Foot",
  104. "05 [0x05] Portamento",
  105. "07 [0x07] Volume",
  106. "08 [0x08] Balance",
  107. "10 [0x0A] Pan",
  108. "11 [0x0B] Expression",
  109. "12 [0x0C] FX Control 1",
  110. "13 [0x0D] FX Control 2",
  111. "16 [0x10] General Purpose 1",
  112. "17 [0x11] General Purpose 2",
  113. "18 [0x12] General Purpose 3",
  114. "19 [0x13] General Purpose 4",
  115. "70 [0x46] Control 1 [Variation]",
  116. "71 [0x47] Control 2 [Timbre]",
  117. "72 [0x48] Control 3 [Release]",
  118. "73 [0x49] Control 4 [Attack]",
  119. "74 [0x4A] Control 5 [Brightness]",
  120. "75 [0x4B] Control 6 [Decay]",
  121. "76 [0x4C] Control 7 [Vib Rate]",
  122. "77 [0x4D] Control 8 [Vib Depth]",
  123. "78 [0x4E] Control 9 [Vib Delay]",
  124. "79 [0x4F] Control 10 [Undefined]",
  125. "80 [0x50] General Purpose 5",
  126. "81 [0x51] General Purpose 6",
  127. "82 [0x52] General Purpose 7",
  128. "83 [0x53] General Purpose 8",
  129. "84 [0x54] Portamento Control",
  130. "91 [0x5B] FX 1 Depth [Reverb]",
  131. "92 [0x5C] FX 2 Depth [Tremolo]",
  132. "93 [0x5D] FX 3 Depth [Chorus]",
  133. "94 [0x5E] FX 4 Depth [Detune]",
  134. "95 [0x5F] FX 5 Depth [Phaser]"
  135. )
  136. MAX_MIDI_CC_LIST_ITEM = 95
  137. # ------------------------------------------------------------------------------------------------------------
  138. # PatchCanvas defines
  139. CANVAS_ANTIALIASING_SMALL = 1
  140. CANVAS_EYECANDY_SMALL = 1
  141. # ------------------------------------------------------------------------------------------------------------
  142. # Carla Settings keys
  143. CARLA_KEY_MAIN_PROJECT_FOLDER = "Main/ProjectFolder" # str
  144. CARLA_KEY_MAIN_USE_PRO_THEME = "Main/UseProTheme" # bool
  145. CARLA_KEY_MAIN_PRO_THEME_COLOR = "Main/ProThemeColor" # str
  146. CARLA_KEY_MAIN_REFRESH_INTERVAL = "Main/RefreshInterval" # int
  147. CARLA_KEY_MAIN_CONFIRM_EXIT = "Main/ConfirmExit" # bool
  148. CARLA_KEY_MAIN_CLASSIC_SKIN = "Main/ClassicSkin" # bool
  149. CARLA_KEY_MAIN_SHOW_LOGS = "Main/ShowLogs" # bool
  150. CARLA_KEY_MAIN_SYSTEM_ICONS = "Main/SystemIcons" # bool
  151. CARLA_KEY_MAIN_EXPERIMENTAL = "Main/Experimental" # bool
  152. CARLA_KEY_CANVAS_THEME = "Canvas/Theme" # str
  153. CARLA_KEY_CANVAS_SIZE = "Canvas/Size" # str "NxN"
  154. CARLA_KEY_CANVAS_USE_BEZIER_LINES = "Canvas/UseBezierLines" # bool
  155. CARLA_KEY_CANVAS_AUTO_HIDE_GROUPS = "Canvas/AutoHideGroups" # bool
  156. CARLA_KEY_CANVAS_AUTO_SELECT_ITEMS = "Canvas/AutoSelectItems" # bool
  157. CARLA_KEY_CANVAS_EYE_CANDY = "Canvas/EyeCandy2" # bool
  158. CARLA_KEY_CANVAS_FANCY_EYE_CANDY = "Canvas/FancyEyeCandy" # bool
  159. CARLA_KEY_CANVAS_USE_OPENGL = "Canvas/UseOpenGL" # bool
  160. CARLA_KEY_CANVAS_ANTIALIASING = "Canvas/Antialiasing" # enum
  161. CARLA_KEY_CANVAS_HQ_ANTIALIASING = "Canvas/HQAntialiasing" # bool
  162. CARLA_KEY_CANVAS_INLINE_DISPLAYS = "Canvas/InlineDisplays" # bool
  163. CARLA_KEY_CANVAS_FULL_REPAINTS = "Canvas/FullRepaints" # bool
  164. CARLA_KEY_ENGINE_DRIVER_PREFIX = "Engine/Driver-"
  165. CARLA_KEY_ENGINE_AUDIO_DRIVER = "Engine/AudioDriver" # str
  166. CARLA_KEY_ENGINE_PROCESS_MODE = "Engine/ProcessMode" # enum
  167. CARLA_KEY_ENGINE_TRANSPORT_MODE = "Engine/TransportMode" # enum
  168. CARLA_KEY_ENGINE_TRANSPORT_EXTRA = "Engine/TransportExtra" # str
  169. CARLA_KEY_ENGINE_FORCE_STEREO = "Engine/ForceStereo" # bool
  170. CARLA_KEY_ENGINE_PREFER_PLUGIN_BRIDGES = "Engine/PreferPluginBridges" # bool
  171. CARLA_KEY_ENGINE_PREFER_UI_BRIDGES = "Engine/PreferUiBridges" # bool
  172. CARLA_KEY_ENGINE_MANAGE_UIS = "Engine/ManageUIs" # bool
  173. CARLA_KEY_ENGINE_UIS_ALWAYS_ON_TOP = "Engine/UIsAlwaysOnTop" # bool
  174. CARLA_KEY_ENGINE_MAX_PARAMETERS = "Engine/MaxParameters" # int
  175. CARLA_KEY_ENGINE_RESET_XRUNS = "Engine/ResetXruns" # bool
  176. CARLA_KEY_ENGINE_UI_BRIDGES_TIMEOUT = "Engine/UiBridgesTimeout" # int
  177. CARLA_KEY_OSC_ENABLED = "OSC/Enabled"
  178. CARLA_KEY_OSC_TCP_PORT_ENABLED = "OSC/TCPEnabled"
  179. CARLA_KEY_OSC_TCP_PORT_NUMBER = "OSC/TCPNumber"
  180. CARLA_KEY_OSC_TCP_PORT_RANDOM = "OSC/TCPRandom"
  181. CARLA_KEY_OSC_UDP_PORT_ENABLED = "OSC/UDPEnabled"
  182. CARLA_KEY_OSC_UDP_PORT_NUMBER = "OSC/UDPNumber"
  183. CARLA_KEY_OSC_UDP_PORT_RANDOM = "OSC/UDPRandom"
  184. CARLA_KEY_PATHS_AUDIO = "Paths/Audio"
  185. CARLA_KEY_PATHS_MIDI = "Paths/MIDI"
  186. CARLA_KEY_PATHS_LADSPA = "Paths/LADSPA"
  187. CARLA_KEY_PATHS_DSSI = "Paths/DSSI"
  188. CARLA_KEY_PATHS_LV2 = "Paths/LV2"
  189. CARLA_KEY_PATHS_VST2 = "Paths/VST2"
  190. CARLA_KEY_PATHS_VST3 = "Paths/VST3"
  191. CARLA_KEY_PATHS_SF2 = "Paths/SF2"
  192. CARLA_KEY_PATHS_SFZ = "Paths/SFZ"
  193. CARLA_KEY_PATHS_JSFX = "Paths/JSFX"
  194. CARLA_KEY_WINE_EXECUTABLE = "Wine/Executable" # str
  195. CARLA_KEY_WINE_AUTO_PREFIX = "Wine/AutoPrefix" # bool
  196. CARLA_KEY_WINE_FALLBACK_PREFIX = "Wine/FallbackPrefix" # str
  197. CARLA_KEY_WINE_RT_PRIO_ENABLED = "Wine/RtPrioEnabled" # bool
  198. CARLA_KEY_WINE_BASE_RT_PRIO = "Wine/BaseRtPrio" # int
  199. CARLA_KEY_WINE_SERVER_RT_PRIO = "Wine/ServerRtPrio" # int
  200. CARLA_KEY_EXPERIMENTAL_PLUGIN_BRIDGES = "Experimental/PluginBridges" # bool
  201. CARLA_KEY_EXPERIMENTAL_WINE_BRIDGES = "Experimental/WineBridges" # bool
  202. CARLA_KEY_EXPERIMENTAL_JACK_APPS = "Experimental/JackApplications" # bool
  203. CARLA_KEY_EXPERIMENTAL_EXPORT_LV2 = "Experimental/ExportLV2" # bool
  204. CARLA_KEY_EXPERIMENTAL_PREVENT_BAD_BEHAVIOUR = "Experimental/PreventBadBehaviour" # bool
  205. CARLA_KEY_EXPERIMENTAL_LOAD_LIB_GLOBAL = "Experimental/LoadLibGlobal" # bool
  206. # if pro theme is on and color is black
  207. CARLA_KEY_CUSTOM_PAINTING = "UseCustomPainting" # bool
  208. # ------------------------------------------------------------------------------------------------------------
  209. # Carla Settings defaults
  210. # Main
  211. CARLA_DEFAULT_MAIN_PROJECT_FOLDER = HOME
  212. CARLA_DEFAULT_MAIN_USE_PRO_THEME = True
  213. CARLA_DEFAULT_MAIN_PRO_THEME_COLOR = "Black"
  214. CARLA_DEFAULT_MAIN_REFRESH_INTERVAL = 20
  215. CARLA_DEFAULT_MAIN_CONFIRM_EXIT = True
  216. CARLA_DEFAULT_MAIN_CLASSIC_SKIN = False
  217. CARLA_DEFAULT_MAIN_SHOW_LOGS = bool(not WINDOWS)
  218. CARLA_DEFAULT_MAIN_SYSTEM_ICONS = False
  219. CARLA_DEFAULT_MAIN_EXPERIMENTAL = False
  220. # Canvas
  221. CARLA_DEFAULT_CANVAS_THEME = "Modern Dark"
  222. CARLA_DEFAULT_CANVAS_SIZE = "3100x2400"
  223. CARLA_DEFAULT_CANVAS_SIZE_WIDTH = 3100
  224. CARLA_DEFAULT_CANVAS_SIZE_HEIGHT = 2400
  225. CARLA_DEFAULT_CANVAS_USE_BEZIER_LINES = True
  226. CARLA_DEFAULT_CANVAS_AUTO_HIDE_GROUPS = True
  227. CARLA_DEFAULT_CANVAS_AUTO_SELECT_ITEMS = False
  228. CARLA_DEFAULT_CANVAS_EYE_CANDY = True
  229. CARLA_DEFAULT_CANVAS_FANCY_EYE_CANDY = False
  230. CARLA_DEFAULT_CANVAS_USE_OPENGL = False
  231. CARLA_DEFAULT_CANVAS_ANTIALIASING = CANVAS_ANTIALIASING_SMALL
  232. CARLA_DEFAULT_CANVAS_HQ_ANTIALIASING = False
  233. CARLA_DEFAULT_CANVAS_INLINE_DISPLAYS = False
  234. CARLA_DEFAULT_CANVAS_FULL_REPAINTS = False
  235. # Engine
  236. CARLA_DEFAULT_FORCE_STEREO = False
  237. CARLA_DEFAULT_PREFER_PLUGIN_BRIDGES = False
  238. CARLA_DEFAULT_PREFER_UI_BRIDGES = True
  239. CARLA_DEFAULT_MANAGE_UIS = True
  240. CARLA_DEFAULT_UIS_ALWAYS_ON_TOP = False
  241. CARLA_DEFAULT_MAX_PARAMETERS = MAX_DEFAULT_PARAMETERS
  242. CARLA_DEFAULT_RESET_XRUNS = False
  243. CARLA_DEFAULT_UI_BRIDGES_TIMEOUT = 4000
  244. CARLA_DEFAULT_AUDIO_BUFFER_SIZE = 512
  245. CARLA_DEFAULT_AUDIO_SAMPLE_RATE = 44100
  246. CARLA_DEFAULT_AUDIO_TRIPLE_BUFFER = False
  247. if HAIKU:
  248. CARLA_DEFAULT_AUDIO_DRIVER = "SDL"
  249. elif MACOS:
  250. CARLA_DEFAULT_AUDIO_DRIVER = "CoreAudio"
  251. elif WINDOWS:
  252. CARLA_DEFAULT_AUDIO_DRIVER = "Windows Audio"
  253. elif os.path.exists("/usr/bin/jackd") or os.path.exists("/usr/bin/jackdbus") or os.path.exists("/usr/bin/pw-jack"):
  254. CARLA_DEFAULT_AUDIO_DRIVER = "JACK"
  255. else:
  256. CARLA_DEFAULT_AUDIO_DRIVER = "PulseAudio"
  257. if CARLA_DEFAULT_AUDIO_DRIVER == "JACK":
  258. CARLA_DEFAULT_PROCESS_MODE = ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS
  259. CARLA_DEFAULT_TRANSPORT_MODE = ENGINE_TRANSPORT_MODE_JACK
  260. else:
  261. CARLA_DEFAULT_PROCESS_MODE = ENGINE_PROCESS_MODE_PATCHBAY
  262. CARLA_DEFAULT_TRANSPORT_MODE = ENGINE_TRANSPORT_MODE_INTERNAL
  263. # OSC
  264. CARLA_DEFAULT_OSC_ENABLED = not (MACOS or WINDOWS)
  265. CARLA_DEFAULT_OSC_TCP_PORT_ENABLED = True
  266. CARLA_DEFAULT_OSC_TCP_PORT_NUMBER = 22752
  267. CARLA_DEFAULT_OSC_TCP_PORT_RANDOM = False
  268. CARLA_DEFAULT_OSC_UDP_PORT_ENABLED = True
  269. CARLA_DEFAULT_OSC_UDP_PORT_NUMBER = 22752
  270. CARLA_DEFAULT_OSC_UDP_PORT_RANDOM = False
  271. # Wine
  272. CARLA_DEFAULT_WINE_EXECUTABLE = "wine"
  273. CARLA_DEFAULT_WINE_AUTO_PREFIX = True
  274. CARLA_DEFAULT_WINE_FALLBACK_PREFIX = os.path.expanduser("~/.wine")
  275. CARLA_DEFAULT_WINE_RT_PRIO_ENABLED = True
  276. CARLA_DEFAULT_WINE_BASE_RT_PRIO = 15
  277. CARLA_DEFAULT_WINE_SERVER_RT_PRIO = 10
  278. # Experimental
  279. CARLA_DEFAULT_EXPERIMENTAL_PLUGIN_BRIDGES = False
  280. CARLA_DEFAULT_EXPERIMENTAL_WINE_BRIDGES = False
  281. CARLA_DEFAULT_EXPERIMENTAL_JACK_APPS = False
  282. CARLA_DEFAULT_EXPERIMENTAL_LV2_EXPORT = False
  283. CARLA_DEFAULT_EXPERIMENTAL_PREVENT_BAD_BEHAVIOUR = False
  284. CARLA_DEFAULT_EXPERIMENTAL_LOAD_LIB_GLOBAL = False
  285. # ------------------------------------------------------------------------------------------------------------
  286. # Default File Folders
  287. CARLA_DEFAULT_FILE_PATH_AUDIO = []
  288. CARLA_DEFAULT_FILE_PATH_MIDI = []
  289. # ------------------------------------------------------------------------------------------------------------
  290. # Default Plugin Folders (get)
  291. DEFAULT_LADSPA_PATH = ""
  292. DEFAULT_DSSI_PATH = ""
  293. DEFAULT_LV2_PATH = ""
  294. DEFAULT_VST2_PATH = ""
  295. DEFAULT_VST3_PATH = ""
  296. DEFAULT_SF2_PATH = ""
  297. DEFAULT_SFZ_PATH = ""
  298. DEFAULT_JSFX_PATH = ""
  299. if WINDOWS:
  300. splitter = ";"
  301. APPDATA = os.getenv("APPDATA")
  302. LOCALAPPDATA = os.getenv("LOCALAPPDATA", APPDATA)
  303. PROGRAMFILES = os.getenv("PROGRAMFILES")
  304. PROGRAMFILESx86 = os.getenv("PROGRAMFILES(x86)")
  305. COMMONPROGRAMFILES = os.getenv("COMMONPROGRAMFILES")
  306. COMMONPROGRAMFILESx86 = os.getenv("COMMONPROGRAMFILES(x86)")
  307. # Small integrity tests
  308. if not APPDATA:
  309. qFatal("APPDATA variable not set, cannot continue")
  310. sys.exit(1)
  311. if not PROGRAMFILES:
  312. qFatal("PROGRAMFILES variable not set, cannot continue")
  313. sys.exit(1)
  314. if not COMMONPROGRAMFILES:
  315. qFatal("COMMONPROGRAMFILES variable not set, cannot continue")
  316. sys.exit(1)
  317. DEFAULT_LADSPA_PATH = APPDATA + "\\LADSPA"
  318. DEFAULT_LADSPA_PATH += ";" + PROGRAMFILES + "\\LADSPA"
  319. DEFAULT_DSSI_PATH = APPDATA + "\\DSSI"
  320. DEFAULT_DSSI_PATH += ";" + PROGRAMFILES + "\\DSSI"
  321. DEFAULT_LV2_PATH = APPDATA + "\\LV2"
  322. DEFAULT_LV2_PATH += ";" + COMMONPROGRAMFILES + "\\LV2"
  323. DEFAULT_VST2_PATH = PROGRAMFILES + "\\VstPlugins"
  324. DEFAULT_VST2_PATH += ";" + PROGRAMFILES + "\\Steinberg\\VstPlugins"
  325. DEFAULT_JSFX_PATH = APPDATA + "\\REAPER\\Effects"
  326. #DEFAULT_JSFX_PATH += ";" + PROGRAMFILES + "\\REAPER\\InstallData\\Effects"
  327. if kIs64bit:
  328. DEFAULT_VST2_PATH += ";" + COMMONPROGRAMFILES + "\\VST2"
  329. DEFAULT_VST3_PATH = COMMONPROGRAMFILES + "\\VST3"
  330. DEFAULT_VST3_PATH += ";" + LOCALAPPDATA + "\\Programs\\Common\\VST3"
  331. DEFAULT_SF2_PATH = APPDATA + "\\SF2"
  332. DEFAULT_SFZ_PATH = APPDATA + "\\SFZ"
  333. if PROGRAMFILESx86:
  334. DEFAULT_LADSPA_PATH += ";" + PROGRAMFILESx86 + "\\LADSPA"
  335. DEFAULT_DSSI_PATH += ";" + PROGRAMFILESx86 + "\\DSSI"
  336. DEFAULT_VST2_PATH += ";" + PROGRAMFILESx86 + "\\VstPlugins"
  337. DEFAULT_VST2_PATH += ";" + PROGRAMFILESx86 + "\\Steinberg\\VstPlugins"
  338. #DEFAULT_JSFX_PATH += ";" + PROGRAMFILESx86 + "\\REAPER\\InstallData\\Effects"
  339. if COMMONPROGRAMFILESx86:
  340. DEFAULT_VST3_PATH += COMMONPROGRAMFILESx86 + "\\VST3"
  341. elif HAIKU:
  342. splitter = ":"
  343. DEFAULT_LADSPA_PATH = HOME + "/.ladspa"
  344. DEFAULT_LADSPA_PATH += ":/system/add-ons/media/ladspaplugins"
  345. DEFAULT_LADSPA_PATH += ":/system/lib/ladspa"
  346. DEFAULT_DSSI_PATH = HOME + "/.dssi"
  347. DEFAULT_DSSI_PATH += ":/system/add-ons/media/dssiplugins"
  348. DEFAULT_DSSI_PATH += ":/system/lib/dssi"
  349. DEFAULT_LV2_PATH = HOME + "/.lv2"
  350. DEFAULT_LV2_PATH += ":/system/add-ons/media/lv2plugins"
  351. DEFAULT_VST2_PATH = HOME + "/.vst"
  352. DEFAULT_VST2_PATH += ":/system/add-ons/media/vstplugins"
  353. DEFAULT_VST3_PATH = HOME + "/.vst3"
  354. DEFAULT_VST3_PATH += ":/system/add-ons/media/vst3plugins"
  355. elif MACOS:
  356. splitter = ":"
  357. DEFAULT_LADSPA_PATH = HOME + "/Library/Audio/Plug-Ins/LADSPA"
  358. DEFAULT_LADSPA_PATH += ":/Library/Audio/Plug-Ins/LADSPA"
  359. DEFAULT_DSSI_PATH = HOME + "/Library/Audio/Plug-Ins/DSSI"
  360. DEFAULT_DSSI_PATH += ":/Library/Audio/Plug-Ins/DSSI"
  361. DEFAULT_LV2_PATH = HOME + "/Library/Audio/Plug-Ins/LV2"
  362. DEFAULT_LV2_PATH += ":/Library/Audio/Plug-Ins/LV2"
  363. DEFAULT_VST2_PATH = HOME + "/Library/Audio/Plug-Ins/VST"
  364. DEFAULT_VST2_PATH += ":/Library/Audio/Plug-Ins/VST"
  365. DEFAULT_VST3_PATH = HOME + "/Library/Audio/Plug-Ins/VST3"
  366. DEFAULT_VST3_PATH += ":/Library/Audio/Plug-Ins/VST3"
  367. DEFAULT_JSFX_PATH = HOME + "/Library/Application Support/REAPER/Effects"
  368. #DEFAULT_JSFX_PATH += ":/Applications/REAPER.app/Contents/InstallFiles/Effects"
  369. else:
  370. CONFIG_HOME = os.getenv("XDG_CONFIG_HOME", HOME + "/.config")
  371. splitter = ":"
  372. DEFAULT_LADSPA_PATH = HOME + "/.ladspa"
  373. DEFAULT_LADSPA_PATH += ":/usr/lib/ladspa"
  374. DEFAULT_LADSPA_PATH += ":/usr/local/lib/ladspa"
  375. DEFAULT_DSSI_PATH = HOME + "/.dssi"
  376. DEFAULT_DSSI_PATH += ":/usr/lib/dssi"
  377. DEFAULT_DSSI_PATH += ":/usr/local/lib/dssi"
  378. DEFAULT_LV2_PATH = HOME + "/.lv2"
  379. DEFAULT_LV2_PATH += ":/usr/lib/lv2"
  380. DEFAULT_LV2_PATH += ":/usr/local/lib/lv2"
  381. DEFAULT_VST2_PATH = HOME + "/.vst"
  382. DEFAULT_VST2_PATH += ":/usr/lib/vst"
  383. DEFAULT_VST2_PATH += ":/usr/local/lib/vst"
  384. DEFAULT_VST2_PATH += HOME + "/.lxvst"
  385. DEFAULT_VST2_PATH += ":/usr/lib/lxvst"
  386. DEFAULT_VST2_PATH += ":/usr/local/lib/lxvst"
  387. DEFAULT_VST3_PATH = HOME + "/.vst3"
  388. DEFAULT_VST3_PATH += ":/usr/lib/vst3"
  389. DEFAULT_VST3_PATH += ":/usr/local/lib/vst3"
  390. DEFAULT_SF2_PATH = HOME + "/.sounds/sf2"
  391. DEFAULT_SF2_PATH += ":" + HOME + "/.sounds/sf3"
  392. DEFAULT_SF2_PATH += ":/usr/share/sounds/sf2"
  393. DEFAULT_SF2_PATH += ":/usr/share/sounds/sf3"
  394. DEFAULT_SF2_PATH += ":/usr/share/soundfonts"
  395. DEFAULT_SFZ_PATH = HOME + "/.sounds/sfz"
  396. DEFAULT_SFZ_PATH += ":/usr/share/sounds/sfz"
  397. DEFAULT_JSFX_PATH = CONFIG_HOME + "/REAPER/Effects"
  398. #DEFAULT_JSFX_PATH += ":" + "/opt/REAPER/InstallData/Effects"
  399. if not WINDOWS:
  400. winePrefix = os.getenv("WINEPREFIX")
  401. if not winePrefix:
  402. winePrefix = HOME + "/.wine"
  403. if os.path.exists(winePrefix):
  404. DEFAULT_VST2_PATH += ":" + winePrefix + "/drive_c/Program Files/VstPlugins"
  405. DEFAULT_VST3_PATH += ":" + winePrefix + "/drive_c/Program Files/Common Files/VST3"
  406. if kIs64bit and os.path.exists(winePrefix + "/drive_c/Program Files (x86)"):
  407. DEFAULT_VST2_PATH += ":" + winePrefix + "/drive_c/Program Files (x86)/VstPlugins"
  408. DEFAULT_VST3_PATH += ":" + winePrefix + "/drive_c/Program Files (x86)/Common Files/VST3"
  409. del winePrefix
  410. # ------------------------------------------------------------------------------------------------------------
  411. # Default Plugin Folders (set)
  412. readEnvVars = True
  413. if WINDOWS:
  414. # Check if running Wine. If yes, ignore env vars
  415. # pylint: disable=import-error
  416. from winreg import ConnectRegistry, OpenKey, CloseKey, HKEY_CURRENT_USER
  417. # pylint: enable=import-error
  418. _reg = ConnectRegistry(None, HKEY_CURRENT_USER)
  419. try:
  420. _key = OpenKey(_reg, r"SOFTWARE\Wine")
  421. CloseKey(_key)
  422. del _key
  423. readEnvVars = False
  424. except:
  425. pass
  426. CloseKey(_reg)
  427. del _reg
  428. if readEnvVars:
  429. CARLA_DEFAULT_LADSPA_PATH = os.getenv("LADSPA_PATH", DEFAULT_LADSPA_PATH).split(splitter)
  430. CARLA_DEFAULT_DSSI_PATH = os.getenv("DSSI_PATH", DEFAULT_DSSI_PATH).split(splitter)
  431. CARLA_DEFAULT_LV2_PATH = os.getenv("LV2_PATH", DEFAULT_LV2_PATH).split(splitter)
  432. CARLA_DEFAULT_VST2_PATH = os.getenv("VST_PATH", DEFAULT_VST2_PATH).split(splitter)
  433. CARLA_DEFAULT_VST3_PATH = os.getenv("VST3_PATH", DEFAULT_VST3_PATH).split(splitter)
  434. CARLA_DEFAULT_SF2_PATH = os.getenv("SF2_PATH", DEFAULT_SF2_PATH).split(splitter)
  435. CARLA_DEFAULT_SFZ_PATH = os.getenv("SFZ_PATH", DEFAULT_SFZ_PATH).split(splitter)
  436. CARLA_DEFAULT_JSFX_PATH = os.getenv("JSFX_PATH", DEFAULT_JSFX_PATH).split(splitter)
  437. else:
  438. CARLA_DEFAULT_LADSPA_PATH = DEFAULT_LADSPA_PATH.split(splitter)
  439. CARLA_DEFAULT_DSSI_PATH = DEFAULT_DSSI_PATH.split(splitter)
  440. CARLA_DEFAULT_LV2_PATH = DEFAULT_LV2_PATH.split(splitter)
  441. CARLA_DEFAULT_VST2_PATH = DEFAULT_VST2_PATH.split(splitter)
  442. CARLA_DEFAULT_VST3_PATH = DEFAULT_VST3_PATH.split(splitter)
  443. CARLA_DEFAULT_SF2_PATH = DEFAULT_SF2_PATH.split(splitter)
  444. CARLA_DEFAULT_SFZ_PATH = DEFAULT_SFZ_PATH.split(splitter)
  445. CARLA_DEFAULT_JSFX_PATH = DEFAULT_JSFX_PATH.split(splitter)
  446. # ------------------------------------------------------------------------------------------------------------
  447. # Default Plugin Folders (cleanup)
  448. del DEFAULT_LADSPA_PATH
  449. del DEFAULT_DSSI_PATH
  450. del DEFAULT_LV2_PATH
  451. del DEFAULT_VST2_PATH
  452. del DEFAULT_VST3_PATH
  453. del DEFAULT_SF2_PATH
  454. del DEFAULT_SFZ_PATH
  455. # ------------------------------------------------------------------------------------------------------------
  456. # Global Carla object
  457. class CarlaObject():
  458. def __init__(self):
  459. self.cnprefix = "" # Client name prefix
  460. self.gui = None # Host Window
  461. self.nogui = False # Skip UI
  462. self.term = False # Terminated by OS signal
  463. self.utils = None # Utils object
  464. gCarla = CarlaObject()
  465. # ------------------------------------------------------------------------------------------------------------
  466. # Set CWD
  467. CWD = sys.path[0]
  468. if not CWD:
  469. CWD = os.path.dirname(sys.argv[0])
  470. # make it work with cxfreeze
  471. if os.path.isfile(CWD):
  472. CWD = os.path.dirname(CWD)
  473. if CWD.endswith("/lib"):
  474. CWD = CWD.rsplit("/lib",1)[0]
  475. CXFREEZE = True
  476. if not WINDOWS:
  477. os.environ['CARLA_MAGIC_FILE'] = os.path.join(CWD, "magic.mgc")
  478. else:
  479. CXFREEZE = False
  480. # ------------------------------------------------------------------------------------------------------------
  481. # Set DLL_EXTENSION
  482. if WINDOWS:
  483. DLL_EXTENSION = "dll"
  484. elif MACOS:
  485. DLL_EXTENSION = "dylib"
  486. else:
  487. DLL_EXTENSION = "so"
  488. # ------------------------------------------------------------------------------------------------------------
  489. # Find decimal points for a parameter, using step and stepSmall
  490. def countDecimalPoints(step, stepSmall):
  491. if stepSmall >= 1.0:
  492. return 0
  493. if step >= 1.0:
  494. return 2
  495. count = 0
  496. value = fmod(abs(step), 1)
  497. while 0.0001 < value < 0.999 and count < 6:
  498. value = fmod(value*10, 1)
  499. count += 1
  500. return count
  501. # ------------------------------------------------------------------------------------------------------------
  502. # Check if a value is a number (float support)
  503. def isNumber(value):
  504. try:
  505. float(value)
  506. return True
  507. except:
  508. return False
  509. # ------------------------------------------------------------------------------------------------------------
  510. # Convert a value to a list
  511. def toList(value):
  512. if value is None:
  513. return []
  514. if not isinstance(value, list):
  515. return [value]
  516. return value
  517. # ------------------------------------------------------------------------------------------------------------
  518. # Get Icon from user theme, using our own as backup (Oxygen)
  519. def getIcon(icon, size, qrcformat):
  520. return QIcon.fromTheme(icon, QIcon(":/%ix%i/%s.%s" % (size, size, icon, qrcformat)))
  521. # ------------------------------------------------------------------------------------------------------------
  522. # Handle some basic command-line arguments shared between all carla variants
  523. def handleInitialCommandLineArguments(file):
  524. initName = os.path.basename(file) if (file is not None and os.path.dirname(file) in PATH) else sys.argv[0]
  525. libPrefix = None
  526. readPrefixNext = False
  527. for arg in sys.argv[1:]:
  528. if arg.startswith("--with-appname="):
  529. initName = os.path.basename(arg.replace("--with-appname=", ""))
  530. elif arg.startswith("--with-libprefix="):
  531. libPrefix = arg.replace("--with-libprefix=", "")
  532. elif arg.startswith("--osc-gui="):
  533. gCarla.nogui = int(arg.replace("--osc-gui=", ""))
  534. elif arg.startswith("--cnprefix="):
  535. gCarla.cnprefix = arg.replace("--cnprefix=", "")
  536. elif arg == "--cnprefix":
  537. readPrefixNext = True
  538. elif arg == "--gdb":
  539. pass
  540. elif arg in ("-n", "--n", "-no-gui", "--no-gui", "-nogui", "--nogui"):
  541. gCarla.nogui = True
  542. elif MACOS and arg.startswith("-psn_"):
  543. pass
  544. elif arg in ("-h", "--h", "-help", "--help"):
  545. print("Usage: %s [OPTION]... [FILE|URL]" % initName)
  546. print("")
  547. print(" where FILE can be a Carla project or preset file to be loaded, or URL if using Carla-Control")
  548. print("")
  549. print(" and OPTION can be one or more of the following:")
  550. print("")
  551. print(" --cnprefix\t Set a prefix for client names in multi-client mode.")
  552. if isinstance(gCarla.nogui, bool):
  553. if X_LIBDIR_X is not None:
  554. print(" --gdb \t Run Carla inside gdb.")
  555. print(" -n,--no-gui \t Run Carla headless, don't show UI.")
  556. print("")
  557. print(" -h,--help \t Print this help text and exit.")
  558. print(" -v,--version \t Print version information and exit.")
  559. print("")
  560. if not isinstance(gCarla.nogui, bool):
  561. print("NOTE: when using %s the FILE is only valid the first time the backend is started" % initName)
  562. sys.exit(1)
  563. sys.exit(0)
  564. elif arg in ("-v", "--v", "-version", "--version"):
  565. pathBinaries, pathResources = getPaths(libPrefix)
  566. print("Using Carla version %s" % VERSION)
  567. print(" Python version: %s" % sys.version.split(" ",1)[0])
  568. print(" Qt version: %s" % QT_VERSION_STR)
  569. print(" PyQt version: %s" % PYQT_VERSION_STR)
  570. print(" Binary dir: %s" % pathBinaries)
  571. print(" Resources dir: %s" % pathResources)
  572. sys.exit(1 if gCarla.nogui else 0)
  573. elif readPrefixNext:
  574. readPrefixNext = False
  575. gCarla.cnprefix = arg
  576. if gCarla.nogui and not isinstance(gCarla.nogui, bool):
  577. if os.fork():
  578. # pylint: disable=protected-access
  579. os._exit(0)
  580. # pylint: enable=protected-access
  581. else:
  582. os.setsid()
  583. return (initName, libPrefix)
  584. # ------------------------------------------------------------------------------------------------------------
  585. # Get initial project file (as passed in the command-line parameters)
  586. def getInitialProjectFile(skipExistCheck = False):
  587. # NOTE: PyQt mishandles unicode characters, we directly use sys.argv instead of qApp->arguments()
  588. # see https://riverbankcomputing.com/pipermail/pyqt/2015-January/035395.html
  589. args = sys.argv[1:]
  590. readPrefixNext = False
  591. for arg in args:
  592. if readPrefixNext:
  593. readPrefixNext = False
  594. continue
  595. if arg.startswith("--cnprefix="):
  596. continue
  597. if arg.startswith("--osc-gui="):
  598. continue
  599. if arg.startswith("--with-appname="):
  600. continue
  601. if arg.startswith("--with-libprefix="):
  602. continue
  603. if arg == "--cnprefix":
  604. readPrefixNext = True
  605. continue
  606. if arg in ("-n", "--n", "-no-gui", "--no-gui", "-nogui", "--nogui", "--gdb"):
  607. continue
  608. if MACOS and arg.startswith("-psn_"):
  609. continue
  610. arg = os.path.expanduser(arg)
  611. if skipExistCheck or os.path.exists(arg):
  612. return arg
  613. return None
  614. # ------------------------------------------------------------------------------------------------------------
  615. # Get paths (binaries, resources)
  616. def getPaths(libPrefix = None):
  617. CWDl = CWD.lower()
  618. # adjust for special distros
  619. libdir = os.path.basename(os.path.normpath(X_LIBDIR_X)) if X_LIBDIR_X else "lib"
  620. datadir = os.path.basename(os.path.normpath(X_DATADIR_X)) if X_DATADIR_X else "share"
  621. # standalone, installed system-wide linux
  622. if libPrefix is not None:
  623. pathBinaries = os.path.join(libPrefix, libdir, "carla")
  624. pathResources = os.path.join(libPrefix, datadir, "carla", "resources")
  625. # standalone, local source
  626. elif CWDl.endswith("frontend"):
  627. pathBinaries = os.path.abspath(os.path.join(CWD, "..", "..", "bin"))
  628. pathResources = os.path.join(pathBinaries, "resources")
  629. # plugin
  630. elif CWDl.endswith("resources"):
  631. # installed system-wide linux
  632. if CWDl.endswith("/share/carla/resources"):
  633. pathBinaries = os.path.abspath(os.path.join(CWD, "..", "..", "..", libdir, "carla"))
  634. pathResources = CWD
  635. # local source
  636. elif CWDl.endswith("native-plugins%sresources" % os.sep):
  637. pathBinaries = os.path.abspath(os.path.join(CWD, "..", "..", "..", "bin"))
  638. pathResources = CWD
  639. # other
  640. else:
  641. pathBinaries = os.path.abspath(os.path.join(CWD, ".."))
  642. pathResources = CWD
  643. # everything else
  644. else:
  645. pathBinaries = CWD
  646. pathResources = os.path.join(pathBinaries, "resources")
  647. return (pathBinaries, pathResources)
  648. # ------------------------------------------------------------------------------------------------------------
  649. # Signal handler
  650. # TODO move to carla_host.py or something
  651. def signalHandler(sig, frame):
  652. if sig in (SIGINT, SIGTERM):
  653. gCarla.term = True
  654. if gCarla.gui is not None:
  655. gCarla.gui.SIGTERM.emit()
  656. elif haveSIGUSR1 and sig == SIGUSR1:
  657. if gCarla.gui is not None:
  658. gCarla.gui.SIGUSR1.emit()
  659. def setUpSignals():
  660. signal(SIGINT, signalHandler)
  661. signal(SIGTERM, signalHandler)
  662. if not haveSIGUSR1:
  663. return
  664. signal(SIGUSR1, signalHandler)
  665. # ------------------------------------------------------------------------------------------------------------
  666. # QLineEdit and QPushButton combo
  667. def getAndSetPath(parent, lineEdit):
  668. newPath = QFileDialog.getExistingDirectory(parent, parent.tr("Set Path"), lineEdit.text(), QFileDialog.ShowDirsOnly)
  669. if newPath:
  670. lineEdit.setText(newPath)
  671. return newPath
  672. # ------------------------------------------------------------------------------------------------------------
  673. # Backwards-compatible horizontalAdvance/width call, depending on Qt version
  674. def fontMetricsHorizontalAdvance(fontMetrics, string):
  675. if QT_VERSION >= 0x50b00:
  676. return fontMetrics.horizontalAdvance(string)
  677. return fontMetrics.width(string)
  678. # ------------------------------------------------------------------------------------------------------------
  679. # Custom QMessageBox which resizes itself to fit text
  680. class QMessageBoxWithBetterWidth(QMessageBox):
  681. def __init__(self, parent):
  682. QMessageBox.__init__(self, parent)
  683. def showEvent(self, event):
  684. fontMetrics = self.fontMetrics()
  685. lines = self.text().strip().split("\n") + self.informativeText().strip().split("\n")
  686. if lines:
  687. width = 0
  688. for line in lines:
  689. width = max(fontMetricsHorizontalAdvance(fontMetrics, line), width)
  690. self.layout().setColumnMinimumWidth(2, width + 12)
  691. QMessageBox.showEvent(self, event)
  692. # ------------------------------------------------------------------------------------------------------------
  693. # Safer QSettings class, which does not throw if type mismatches
  694. class QSafeSettings(QSettings):
  695. def value(self, key, defaultValue, valueType):
  696. if not isinstance(defaultValue, valueType):
  697. print("QSafeSettings.value() - defaultValue type mismatch for key", key)
  698. try:
  699. return QSettings.value(self, key, defaultValue, valueType)
  700. except:
  701. return defaultValue
  702. # ------------------------------------------------------------------------------------------------------------
  703. # Custom MessageBox
  704. # pylint: disable=too-many-arguments
  705. def CustomMessageBox(parent, icon, title, text,
  706. extraText="",
  707. buttons=QMessageBox.Yes|QMessageBox.No,
  708. defButton=QMessageBox.No):
  709. msgBox = QMessageBoxWithBetterWidth(parent)
  710. msgBox.setIcon(icon)
  711. msgBox.setWindowTitle(title)
  712. msgBox.setText(text)
  713. msgBox.setInformativeText(extraText)
  714. msgBox.setStandardButtons(buttons)
  715. msgBox.setDefaultButton(defButton)
  716. return msgBox.exec_()
  717. # pylint: enable=too-many-arguments
  718. # ------------------------------------------------------------------------------------------------------------