falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 42 Activity
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.
4987 Commits
16 Branches
3.6GB
Tree: 062c43e4c0
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '062c43e4c0'
${ noResults }
Carla/source/frontend/carla_utils.py

379 lines
13KB
Raw Blame History 

  1. #!/usr/bin/env python3

  2. # -*- coding: utf-8 -*-

  3. 

  4. # Carla Backend utils

  5. # Copyright (C) 2011-2018 Filipe Coelho <falktx@falktx.com>

  6. #

  7. # This program is free software; you can redistribute it and/or

  8. # modify it under the terms of the GNU General Public License as

  9. # published by the Free Software Foundation; either version 2 of

  10. # the License, or any later version.

  11. #

  12. # This program is distributed in the hope that it will be useful,

  13. # but WITHOUT ANY WARRANTY; without even the implied warranty of

  14. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

  15. # GNU General Public License for more details.

  16. #

  17. # For a full copy of the GNU General Public License see the doc/GPL.txt file.

  18. 

  19. # ------------------------------------------------------------------------------------------------------------

  20. # Imports (Global)

  21. 

  22. from os import environ

  23. from sys import argv

  24. 

  25. # ------------------------------------------------------------------------------------------------------------

  26. # Imports (Custom)

  27. 

  28. from carla_backend import *

  29. 

  30. # ------------------------------------------------------------------------------------------------------------

  31. 

  32. def getPluginTypeAsString(ptype):

  33.     if ptype == PLUGIN_NONE:

  34.         return "NONE"

  35.     if ptype == PLUGIN_INTERNAL:

  36.         return "Internal"

  37.     if ptype == PLUGIN_LADSPA:

  38.         return "LADSPA"

  39.     if ptype == PLUGIN_DSSI:

  40.         return "DSSI"

  41.     if ptype == PLUGIN_LV2:

  42.         return "LV2"

  43.     if ptype == PLUGIN_VST2:

  44.         return "VST2"

  45.     if ptype == PLUGIN_VST3:

  46.         return "VST3"

  47.     if ptype == PLUGIN_AU:

  48.         return "AU"

  49.     if ptype == PLUGIN_SF2:

  50.         return "SF2"

  51.     if ptype == PLUGIN_SFZ:

  52.         return "SFZ"

  53.     if ptype == PLUGIN_JACK:

  54.         return "JACK"

  55. 

  56.     print("getPluginTypeAsString(%i) - invalid type" % ptype);

  57.     return "Unknown"

  58. 

  59. def getPluginTypeFromString(stype):

  60.     if not stype:

  61.         return PLUGIN_NONE

  62. 

  63.     stype = stype.lower()

  64. 

  65.     if stype == "none":

  66.         return PLUGIN_NONE

  67.     if stype in ("internal", "native"):

  68.         return PLUGIN_INTERNAL

  69.     if stype == "ladspa":

  70.         return PLUGIN_LADSPA

  71.     if stype == "dssi":

  72.         return PLUGIN_DSSI

  73.     if stype == "lv2":

  74.         return PLUGIN_LV2

  75.     if stype in ("vst2", "vst"):

  76.         return PLUGIN_VST2

  77.     if stype == "vst3":

  78.         return PLUGIN_VST3

  79.     if stype in ("au", "audiounit"):

  80.         return PLUGIN_AU

  81.     if stype == "sf2":

  82.         return PLUGIN_SF2

  83.     if stype == "sfz":

  84.         return PLUGIN_SFZ

  85.     if stype == "jack":

  86.         return PLUGIN_JACK

  87. 

  88.     print("getPluginTypeFromString(\"%s\") - invalid string type" % stype)

  89.     return PLUGIN_NONE

  90. 

  91. # ------------------------------------------------------------------------------------------------------------

  92. # Carla Utils API (C stuff)

  93. 

  94. CarlaPipeClientHandle = c_void_p

  95. CarlaPipeCallbackFunc = CFUNCTYPE(None, c_void_p, c_char_p)

  96. 

  97. # Information about an internal Carla plugin.

  98. # @see carla_get_cached_plugin_info()

  99. class CarlaCachedPluginInfo(Structure):

  100.     _fields_ = [

  101.         # Wherever the data in this struct is valid.

  102.         # For performance reasons, plugins are only checked on request,

  103.         #  and as such, the count vs number of really valid plugins might not match.

  104.         # Use this field to skip on plugins which cannot be loaded in Carla.

  105.         ("valid", c_bool),

  106. 

  107.         # Plugin category.

  108.         ("category", c_enum),

  109. 

  110.         # Plugin hints.

  111.         # @see PluginHints

  112.         ("hints", c_uint),

  113. 

  114.         # Number of audio inputs.

  115.         ("audioIns", c_uint32),

  116. 

  117.         # Number of audio outputs.

  118.         ("audioOuts", c_uint32),

  119. 

  120.         # Number of MIDI inputs.

  121.         ("midiIns", c_uint32),

  122. 

  123.         # Number of MIDI outputs.

  124.         ("midiOuts", c_uint32),

  125. 

  126.         # Number of input parameters.

  127.         ("parameterIns", c_uint32),

  128. 

  129.         # Number of output parameters.

  130.         ("parameterOuts", c_uint32),

  131. 

  132.         # Plugin name.

  133.         ("name", c_char_p),

  134. 

  135.         # Plugin label.

  136.         ("label", c_char_p),

  137. 

  138.         # Plugin author/maker.

  139.         ("maker", c_char_p),

  140. 

  141.         # Plugin copyright/license.

  142.         ("copyright", c_char_p)

  143.     ]

  144. 

  145. # ------------------------------------------------------------------------------------------------------------

  146. # Carla Utils API (Python compatible stuff)

  147. 

  148. # @see CarlaCachedPluginInfo

  149. PyCarlaCachedPluginInfo = {

  150.     'valid': False,

  151.     'category': PLUGIN_CATEGORY_NONE,

  152.     'hints': 0x0,

  153.     'audioIns': 0,

  154.     'audioOuts': 0,

  155.     'midiIns': 0,

  156.     'midiOuts': 0,

  157.     'parameterIns': 0,

  158.     'parameterOuts': 0,

  159.     'name':  "",

  160.     'label': "",

  161.     'maker': "",

  162.     'copyright': ""

  163. }

  164. 

  165. # ------------------------------------------------------------------------------------------------------------

  166. # Carla Utils object using a DLL

  167. 

  168. class CarlaUtils(object):

  169.     def __init__(self, filename):

  170.         object.__init__(self)

  171. 

  172.         self.lib = cdll.LoadLibrary(filename)

  173.         #self.lib = CDLL(filename, RTLD_GLOBAL)

  174. 

  175.         self.lib.carla_get_complete_license_text.argtypes = None

  176.         self.lib.carla_get_complete_license_text.restype = c_char_p

  177. 

  178.         self.lib.carla_get_juce_version.argtypes = None

  179.         self.lib.carla_get_juce_version.restype = c_char_p

  180. 

  181.         self.lib.carla_get_supported_file_extensions.argtypes = None

  182.         self.lib.carla_get_supported_file_extensions.restype = POINTER(c_char_p)

  183. 

  184.         self.lib.carla_get_supported_features.argtypes = None

  185.         self.lib.carla_get_supported_features.restype = POINTER(c_char_p)

  186. 

  187.         self.lib.carla_get_cached_plugin_count.argtypes = [c_enum, c_char_p]

  188.         self.lib.carla_get_cached_plugin_count.restype = c_uint

  189. 

  190.         self.lib.carla_get_cached_plugin_info.argtypes = [c_enum, c_uint]

  191.         self.lib.carla_get_cached_plugin_info.restype = POINTER(CarlaCachedPluginInfo)

  192. 

  193.         self.lib.carla_fflush.argtypes = [c_bool]

  194.         self.lib.carla_fflush.restype = None

  195. 

  196.         self.lib.carla_fputs.argtypes = [c_bool, c_char_p]

  197.         self.lib.carla_fputs.restype = None

  198. 

  199.         self.lib.carla_set_process_name.argtypes = [c_char_p]

  200.         self.lib.carla_set_process_name.restype = None

  201. 

  202.         self.lib.carla_pipe_client_new.argtypes = [POINTER(c_char_p), CarlaPipeCallbackFunc, c_void_p]

  203.         self.lib.carla_pipe_client_new.restype = CarlaPipeClientHandle

  204. 

  205.         self.lib.carla_pipe_client_idle.argtypes = [CarlaPipeClientHandle]

  206.         self.lib.carla_pipe_client_idle.restype = c_char_p

  207. 

  208.         self.lib.carla_pipe_client_is_running.argtypes = [CarlaPipeClientHandle]

  209.         self.lib.carla_pipe_client_is_running.restype = c_bool

  210. 

  211.         self.lib.carla_pipe_client_lock.argtypes = [CarlaPipeClientHandle]

  212.         self.lib.carla_pipe_client_lock.restype = None

  213. 

  214.         self.lib.carla_pipe_client_unlock.argtypes = [CarlaPipeClientHandle]

  215.         self.lib.carla_pipe_client_unlock.restype = None

  216. 

  217.         self.lib.carla_pipe_client_readlineblock.argtypes = [CarlaPipeClientHandle, c_uint]

  218.         self.lib.carla_pipe_client_readlineblock.restype = c_char_p

  219. 

  220.         self.lib.carla_pipe_client_write_msg.argtypes = [CarlaPipeClientHandle, c_char_p]

  221.         self.lib.carla_pipe_client_write_msg.restype = c_bool

  222. 

  223.         self.lib.carla_pipe_client_write_and_fix_msg.argtypes = [CarlaPipeClientHandle, c_char_p]

  224.         self.lib.carla_pipe_client_write_and_fix_msg.restype = c_bool

  225. 

  226.         self.lib.carla_pipe_client_flush.argtypes = [CarlaPipeClientHandle]

  227.         self.lib.carla_pipe_client_flush.restype = c_bool

  228. 

  229.         self.lib.carla_pipe_client_flush_and_unlock.argtypes = [CarlaPipeClientHandle]

  230.         self.lib.carla_pipe_client_flush_and_unlock.restype = c_bool

  231. 

  232.         self.lib.carla_pipe_client_destroy.argtypes = [CarlaPipeClientHandle]

  233.         self.lib.carla_pipe_client_destroy.restype = None

  234. 

  235.         self.lib.carla_cocoa_get_window.argtypes = [c_uintptr]

  236.         self.lib.carla_cocoa_get_window.restype = c_int

  237. 

  238.         self.lib.carla_x11_reparent_window.argtypes = [c_uintptr, c_uintptr]

  239.         self.lib.carla_x11_reparent_window.restype = None

  240. 

  241.         self.lib.carla_x11_move_window.argtypes = [c_uintptr, c_int, c_int]

  242.         self.lib.carla_x11_move_window.restype = None

  243. 

  244.         self.lib.carla_x11_get_window_pos.argtypes = [c_uintptr]

  245.         self.lib.carla_x11_get_window_pos.restype = POINTER(c_int)

  246. 

  247.         # use _putenv on windows

  248.         if not WINDOWS:

  249.             self.msvcrt = None

  250.             return

  251. 

  252.         self.msvcrt = cdll.msvcrt

  253.         self.msvcrt._putenv.argtypes = [c_char_p]

  254.         self.msvcrt._putenv.restype = None

  255. 

  256.     # --------------------------------------------------------------------------------------------------------

  257. 

  258.     # set environment variable

  259.     def setenv(self, key, value):

  260.         environ[key] = value

  261. 

  262.         if WINDOWS:

  263.             keyvalue = "%s=%s" % (key, value)

  264.             self.msvcrt._putenv(keyvalue.encode("utf-8"))

  265. 

  266.     # unset environment variable

  267.     def unsetenv(self, key):

  268.         if environ.get(key) is not None:

  269.             environ.pop(key)

  270. 

  271.         if WINDOWS:

  272.             keyrm = "%s=" % key

  273.             self.msvcrt._putenv(keyrm.encode("utf-8"))

  274. 

  275.     # --------------------------------------------------------------------------------------------------------

  276. 

  277.     # Get the complete license text of used third-party code and features.

  278.     # Returned string is in basic html format.

  279.     def get_complete_license_text(self):

  280.         return charPtrToString(self.lib.carla_get_complete_license_text())

  281. 

  282.     # Get the juce version used in the current Carla build.

  283.     def get_juce_version(self):

  284.         return charPtrToString(self.lib.carla_get_juce_version())

  285. 

  286.     # Get the list of supported file extensions in carla_load_file().

  287.     def get_supported_file_extensions(self):

  288.         return charPtrPtrToStringList(self.lib.carla_get_supported_file_extensions())

  289. 

  290.     # Get the list of supported features in the current Carla build.

  291.     def get_supported_features(self):

  292.         return charPtrPtrToStringList(self.lib.carla_get_supported_features())

  293. 

  294.     # Get how many internal plugins are available.

  295.     # Internal and LV2 plugin formats are cached and need to be discovered via this function.

  296.     # Do not call this for any other plugin formats.

  297.     def get_cached_plugin_count(self, ptype, pluginPath):

  298.         return int(self.lib.carla_get_cached_plugin_count(ptype, pluginPath.encode("utf-8")))

  299. 

  300.     # Get information about a cached plugin.

  301.     def get_cached_plugin_info(self, ptype, index):

  302.         return structToDict(self.lib.carla_get_cached_plugin_info(ptype, index).contents)

  303. 

  304.     def fflush(self, err):

  305.         self.lib.carla_fflush(err)

  306. 

  307.     def fputs(self, err, string):

  308.         self.lib.carla_fputs(err, string.encode("utf-8"))

  309. 

  310.     def set_process_name(self, name):

  311.         self.lib.carla_set_process_name(name.encode("utf-8"))

  312. 

  313.     def pipe_client_new(self, func):

  314.         argc      = len(argv)

  315.         cagrvtype = c_char_p * argc

  316.         cargv     = cagrvtype()

  317. 

  318.         for i in range(argc):

  319.             cargv[i] = c_char_p(argv[i].encode("utf-8"))

  320. 

  321.         self._pipeClientFunc = func

  322.         self._pipeClientCallback = CarlaPipeCallbackFunc(func)

  323.         return self.lib.carla_pipe_client_new(cargv, self._pipeClientCallback, None)

  324. 

  325.     def pipe_client_idle(self, handle):

  326.         while True:

  327.             try:

  328.                 msg = self.lib.carla_pipe_client_idle(handle)

  329.             except OSError as e:

  330.                 print("pipe_client_idle", e)

  331.                 return

  332. 

  333.             if not msg:

  334.                 break

  335. 

  336.             self._pipeClientFunc(None, msg.decode("utf-8", errors="ignore"))

  337. 

  338.     def pipe_client_is_running(self, handle):

  339.         return bool(self.lib.carla_pipe_client_is_running(handle))

  340. 

  341.     def pipe_client_lock(self, handle):

  342.         self.lib.carla_pipe_client_lock(handle)

  343. 

  344.     def pipe_client_unlock(self, handle):

  345.         self.lib.carla_pipe_client_unlock(handle)

  346. 

  347.     def pipe_client_readlineblock(self, handle, timeout):

  348.         return charPtrToString(self.lib.carla_pipe_client_readlineblock(handle, timeout))

  349. 

  350.     def pipe_client_write_msg(self, handle, msg):

  351.         return bool(self.lib.carla_pipe_client_write_msg(handle, msg.encode("utf-8")))

  352. 

  353.     def pipe_client_write_and_fix_msg(self, handle, msg):

  354.         return bool(self.lib.carla_pipe_client_write_and_fix_msg(handle, msg.encode("utf-8")))

  355. 

  356.     def pipe_client_flush(self, handle):

  357.         return bool(self.lib.carla_pipe_client_flush(handle))

  358. 

  359.     def pipe_client_flush_and_unlock(self, handle):

  360.         return bool(self.lib.carla_pipe_client_flush_and_unlock(handle))

  361. 

  362.     def pipe_client_destroy(self, handle):

  363.         self.lib.carla_pipe_client_destroy(handle)

  364. 

  365.     def cocoa_get_window(self, winId):

  366.         return self.lib.carla_cocoa_get_window(winId)

  367. 

  368.     def x11_reparent_window(self, winId1, winId2):

  369.         self.lib.carla_x11_reparent_window(winId1, winId2)

  370. 

  371.     def x11_move_window(self, winId, x, y):

  372.         self.lib.carla_x11_move_window(winId, x, y)

  373. 

  374.     def x11_get_window_pos(self, winId):

  375.         data = self.lib.carla_x11_get_window_pos(winId)

  376.         return tuple(int(data[i]) for i in range(4))

  377. 

  378. # ------------------------------------------------------------------------------------------------------------