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.
3002 Commits
16 Branches
14GB
Tree: f8222c5128
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f8222c5128'
${ noResults }
Carla/source/native-plugins/resources/carla-plugin

538 lines
20KB
Raw Blame History 

  1. #!/usr/bin/env python3

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

  3. 

  4. # Carla plugin host (plugin UI)

  5. # Copyright (C) 2013-2014 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 GPL.txt file

  18. 

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

  20. # Imports (Custom Stuff)

  21. 

  22. from carla_host import *

  23. from externalui import ExternalUI

  24. 

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

  26. # Host Plugin object

  27. 

  28. class PluginHost(CarlaHostQtPlugin):

  29.     def __init__(self):

  30.         CarlaHostQtPlugin.__init__(self)

  31. 

  32.         if False:

  33.             # kdevelop likes this :)

  34.             self.fExternalUI = ExternalUI()

  35. 

  36.         # ---------------------------------------------------------------

  37. 

  38.         self.fExternalUI = None

  39. 

  40.     # -------------------------------------------------------------------

  41. 

  42.     def setExternalUI(self, extUI):

  43.         self.fExternalUI = extUI

  44. 

  45.     def sendMsg(self, lines):

  46.         if self.fExternalUI is None:

  47.             return False

  48. 

  49.         self.fExternalUI.send(lines)

  50.         return True

  51. 

  52.     # -------------------------------------------------------------------

  53. 

  54.     def engine_init(self, driverName, clientName):

  55.         return True

  56. 

  57.     def engine_close(self):

  58.         return True

  59. 

  60.     def engine_idle(self):

  61.         self.fExternalUI.idleExternalUI()

  62. 

  63.     def is_engine_running(self):

  64.         return self.fExternalUI.isRunning()

  65. 

  66.     def set_engine_about_to_close(self):

  67.         return

  68. 

  69. # ------------------------------------------------------------------------------------------------------------

  70. # Main Window

  71. 

  72. class CarlaMiniW(ExternalUI, HostWindow):

  73.     def __init__(self, host, parent=None):

  74.         ExternalUI.__init__(self)

  75.         HostWindow.__init__(self, host, sys.argv[0].lower().endswith("/carla-plugin-patchbay"), parent)

  76.         self.host = host

  77. 

  78.         if False:

  79.             # kdevelop likes this :)

  80.             host = PluginHost()

  81.             self.host = host

  82. 

  83.         host.setExternalUI(self)

  84. 

  85.         self.fFirstInit = True

  86. 

  87.         self.setWindowTitle(self.fUiName)

  88.         self.ready()

  89. 

  90.     # -------------------------------------------------------------------

  91.     # ExternalUI Callbacks

  92. 

  93.     def uiShow(self):

  94.         if self.parent() is not None:

  95.             return

  96.         self.show()

  97. 

  98.     def uiFocus(self):

  99.         if self.parent() is not None:

  100.             return

  101. 

  102.         self.setWindowState((self.windowState() & ~Qt.WindowMinimized) | Qt.WindowActive)

  103.         self.show()

  104. 

  105.         self.raise_()

  106.         self.activateWindow()

  107. 

  108.     def uiHide(self):

  109.         if self.parent() is not None:

  110.             return

  111.         self.hide()

  112. 

  113.     def uiQuit(self):

  114.         self.closeExternalUI()

  115.         self.close()

  116. 

  117.         if self != gui:

  118.             gui.close()

  119. 

  120.         app.quit()

  121. 

  122.     def uiTitleChanged(self, uiTitle):

  123.         self.setWindowTitle(uiTitle)

  124. 

  125.     # -------------------------------------------------------------------

  126.     # Qt events

  127. 

  128.     def closeEvent(self, event):

  129.         self.closeExternalUI()

  130.         HostWindow.closeEvent(self, event)

  131. 

  132.         # there might be other qt windows open which will block carla-plugin from quitting

  133.         app.quit()

  134. 

  135.     # -------------------------------------------------------------------

  136.     # Custom callback

  137. 

  138.     def msgCallback(self, msg):

  139.         try:

  140.             self.msgCallback2(msg)

  141.         except:

  142.             print("msgCallback error, skipped for", msg)

  143. 

  144.     def msgCallback2(self, msg):

  145.         msg = charPtrToString(msg)

  146. 

  147.         #if not msg:

  148.             #return

  149. 

  150.         if msg.startswith("PEAKS_"):

  151.             pluginId = int(msg.replace("PEAKS_", ""))

  152.             in1, in2, out1, out2 = [float(i) for i in self.readlineblock().split(":")]

  153.             self.host._set_peaks(pluginId, in1, in2, out1, out2)

  154. 

  155.         elif msg.startswith("PARAMVAL_"):

  156.             pluginId, paramId = [int(i) for i in msg.replace("PARAMVAL_", "").split(":")]

  157.             paramValue = float(self.readlineblock())

  158.             if paramId < 0:

  159.                 self.host._set_internalValue(pluginId, paramId, paramValue)

  160.             else:

  161.                 self.host._set_parameterValue(pluginId, paramId, paramValue)

  162. 

  163.         elif msg.startswith("ENGINE_CALLBACK_"):

  164.             action   = int(msg.replace("ENGINE_CALLBACK_", ""))

  165.             pluginId = int(self.readlineblock())

  166.             value1   = int(self.readlineblock())

  167.             value2   = int(self.readlineblock())

  168.             value3   = float(self.readlineblock())

  169.             valueStr = self.readlineblock().replace("\r", "\n")

  170. 

  171.             if action == ENGINE_CALLBACK_PLUGIN_RENAMED:

  172.                 self.host._set_pluginName(pluginId, valueStr)

  173.             elif action == ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED:

  174.                 if value1 < 0:

  175.                     self.host._set_internalValue(pluginId, value1, value3)

  176.                 else:

  177.                     self.host._set_parameterValue(pluginId, value1, value3)

  178.             elif action == ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED:

  179.                 self.host._set_parameterDefault(pluginId, value1, value3)

  180.             elif action == ENGINE_CALLBACK_PARAMETER_MIDI_CC_CHANGED:

  181.                 self.host._set_parameterMidiCC(pluginId, value1, value2)

  182.             elif action == ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED:

  183.                 self.host._set_parameterMidiChannel(pluginId, value1, value2)

  184.             elif action == ENGINE_CALLBACK_PROGRAM_CHANGED:

  185.                 self.host._set_currentProgram(pluginId, value1)

  186.             elif action == ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED:

  187.                 self.host._set_currentMidiProgram(pluginId, value1)

  188. 

  189.             engineCallback(self.host, action, pluginId, value1, value2, value3, valueStr)

  190. 

  191.         elif msg.startswith("ENGINE_OPTION_"):

  192.             option = int(msg.replace("ENGINE_OPTION_", ""))

  193.             forced = bool(self.readlineblock() == "true")

  194.             value  = self.readlineblock()

  195. 

  196.             if self.fFirstInit and not forced:

  197.                 return

  198. 

  199.             if option == ENGINE_OPTION_PROCESS_MODE:

  200.                 self.host.processMode = int(value)

  201.             elif option == ENGINE_OPTION_TRANSPORT_MODE:

  202.                 self.host.transportMode = int(value)

  203.             elif option == ENGINE_OPTION_FORCE_STEREO:

  204.                 self.host.forceStereo = bool(value == "true")

  205.             elif option == ENGINE_OPTION_PREFER_PLUGIN_BRIDGES:

  206.                 self.host.preferPluginBridges = bool(value == "true")

  207.             elif option == ENGINE_OPTION_PREFER_UI_BRIDGES:

  208.                 self.host.preferUIBridges = bool(value == "true")

  209.             elif option == ENGINE_OPTION_UIS_ALWAYS_ON_TOP:

  210.                 self.host.uisAlwaysOnTop = bool(value == "true")

  211.             elif option == ENGINE_OPTION_MAX_PARAMETERS:

  212.                 self.host.maxParameters = int(value)

  213.             elif option == ENGINE_OPTION_UI_BRIDGES_TIMEOUT:

  214.                 self.host.uiBridgesTimeout = int(value)

  215.             elif option == ENGINE_OPTION_PATH_BINARIES:

  216.                 self.host.pathBinaries = value

  217.             elif option == ENGINE_OPTION_PATH_RESOURCES:

  218.                 self.host.pathResources = value

  219. 

  220.         elif msg.startswith("PLUGIN_INFO_"):

  221.             pluginId = int(msg.replace("PLUGIN_INFO_", ""))

  222.             self.host._add(pluginId)

  223. 

  224.             type_, category, hints, uniqueId, optsAvail, optsEnabled = [int(i) for i in self.readlineblock().split(":")]

  225.             filename  = self.readlineblock().replace("\r", "\n")

  226.             name      = self.readlineblock().replace("\r", "\n")

  227.             iconName  = self.readlineblock().replace("\r", "\n")

  228.             realName  = self.readlineblock().replace("\r", "\n")

  229.             label     = self.readlineblock().replace("\r", "\n")

  230.             maker     = self.readlineblock().replace("\r", "\n")

  231.             copyright = self.readlineblock().replace("\r", "\n")

  232. 

  233.             pinfo = {

  234.                 'type': type_,

  235.                 'category': category,

  236.                 'hints': hints,

  237.                 'optionsAvailable': optsAvail,

  238.                 'optionsEnabled': optsEnabled,

  239.                 'filename': filename,

  240.                 'name':  name,

  241.                 'label': label,

  242.                 'maker': maker,

  243.                 'copyright': copyright,

  244.                 'iconName': iconName,

  245.                 'patchbayClientId': 0,

  246.                 'uniqueId': uniqueId

  247.             }

  248.             self.host._set_pluginInfo(pluginId, pinfo)

  249.             self.host._set_pluginRealName(pluginId, realName)

  250. 

  251.         elif msg.startswith("AUDIO_COUNT_"):

  252.             pluginId, ins, outs = [int(i) for i in msg.replace("AUDIO_COUNT_", "").split(":")]

  253.             self.host._set_audioCountInfo(pluginId, {'ins': ins, 'outs': outs})

  254. 

  255.         elif msg.startswith("MIDI_COUNT_"):

  256.             pluginId, ins, outs = [int(i) for i in msg.replace("MIDI_COUNT_", "").split(":")]

  257.             self.host._set_midiCountInfo(pluginId, {'ins': ins, 'outs': outs})

  258. 

  259.         elif msg.startswith("PARAMETER_COUNT_"):

  260.             pluginId, ins, outs, count = [int(i) for i in msg.replace("PARAMETER_COUNT_", "").split(":")]

  261.             self.host._set_parameterCountInfo(pluginId, count, {'ins': ins, 'outs': outs})

  262. 

  263.         elif msg.startswith("PARAMETER_DATA_"):

  264.             pluginId, paramId = [int(i) for i in msg.replace("PARAMETER_DATA_", "").split(":")]

  265.             paramType, paramHints, midiChannel, midiCC = [int(i) for i in self.readlineblock().split(":")]

  266.             paramName = self.readlineblock().replace("\r", "\n")

  267.             paramUnit = self.readlineblock().replace("\r", "\n")

  268. 

  269.             paramInfo = {

  270.                 'name': paramName,

  271.                 'symbol': "",

  272.                 'unit': paramUnit,

  273.                 'scalePointCount': 0,

  274.             }

  275.             self.host._set_parameterInfo(pluginId, paramId, paramInfo)

  276. 

  277.             paramData = {

  278.                 'type': paramType,

  279.                 'hints': paramHints,

  280.                 'index': paramId,

  281.                 'rindex': -1,

  282.                 'midiCC': midiCC,

  283.                 'midiChannel': midiChannel

  284.             }

  285.             self.host._set_parameterData(pluginId, paramId, paramData)

  286. 

  287.         elif msg.startswith("PARAMETER_RANGES_"):

  288.             pluginId, paramId = [int(i) for i in msg.replace("PARAMETER_RANGES_", "").split(":")]

  289.             def_, min_, max_, step, stepSmall, stepLarge = [float(i) for i in self.readlineblock().split(":")]

  290. 

  291.             paramRanges = {

  292.                 'def': def_,

  293.                 'min': min_,

  294.                 'max': max_,

  295.                 'step': step,

  296.                 'stepSmall': stepSmall,

  297.                 'stepLarge': stepLarge

  298.             }

  299.             self.host._set_parameterRanges(pluginId, paramId, paramRanges)

  300. 

  301.         elif msg.startswith("PROGRAM_COUNT_"):

  302.             pluginId, count, current = [int(i) for i in msg.replace("PROGRAM_COUNT_", "").split(":")]

  303.             self.host._set_programCount(pluginId, count)

  304.             self.host._set_currentProgram(pluginId, current)

  305. 

  306.         elif msg.startswith("PROGRAM_NAME_"):

  307.             pluginId, progId = [int(i) for i in msg.replace("PROGRAM_NAME_", "").split(":")]

  308.             progName = self.readlineblock().replace("\r", "\n")

  309.             self.host._set_programName(pluginId, progId, progName)

  310. 

  311.         elif msg.startswith("MIDI_PROGRAM_COUNT_"):

  312.             pluginId, count, current = [int(i) for i in msg.replace("MIDI_PROGRAM_COUNT_", "").split(":")]

  313.             self.host._set_midiProgramCount(pluginId, count)

  314.             self.host._set_currentMidiProgram(pluginId, current)

  315. 

  316.         elif msg.startswith("MIDI_PROGRAM_DATA_"):

  317.             pluginId, midiProgId = [int(i) for i in msg.replace("MIDI_PROGRAM_DATA_", "").split(":")]

  318.             bank, program = [int(i) for i in self.readlineblock().split(":")]

  319.             name = self.readlineblock().replace("\r", "\n")

  320.             self.host._set_midiProgramData(pluginId, midiProgId, {'bank': bank, 'program': program, 'name': name})

  321. 

  322.         elif msg.startswith("CUSTOM_DATA_COUNT_"):

  323.             pluginId, count = [int(i) for i in msg.replace("CUSTOM_DATA_COUNT_", "").split(":")]

  324.             self.host._set_customDataCount(pluginId, count)

  325. 

  326.         elif msg.startswith("CUSTOM_DATA_"):

  327.             pluginId, customDataId = [int(i) for i in msg.replace("CUSTOM_DATA_", "").split(":")]

  328. 

  329.             type_ = self.readlineblock().replace("\r", "\n")

  330.             key   = self.readlineblock().replace("\r", "\n")

  331.             value = self.readlineblock().replace("\r", "\n")

  332.             self.host._set_customData(pluginId, customDataId, {'type': type_, 'key': key, 'value': value})

  333. 

  334.         elif msg == "osc-urls":

  335.             tcp = self.readlineblock().replace("\r", "\n")

  336.             udp = self.readlineblock().replace("\r", "\n")

  337.             self.host.fOscTCP = tcp

  338.             self.host.fOscUDP = udp

  339. 

  340.         elif msg == "max-plugin-number":

  341.             maxnum = int(self.readlineblock())

  342.             self.host.fMaxPluginNumber = maxnum

  343. 

  344.         elif msg == "buffer-size":

  345.             bufsize = int(self.readlineblock())

  346.             self.host.fBufferSize = bufsize

  347. 

  348.         elif msg == "sample-rate":

  349.             srate = float(self.readlineblock())

  350.             self.host.fSampleRate = srate

  351. 

  352.         elif msg == "transport":

  353.             playing = bool(self.readlineblock() == "true")

  354.             frame, bar, beat, tick = [int(i) for i in self.readlineblock().split(":")]

  355.             bpm = float(self.readlineblock())

  356.             self.host._set_transport(playing, frame, bar, beat, tick, bpm)

  357. 

  358.         elif msg == "error":

  359.             error = self.readlineblock().replace("\r", "\n")

  360.             engineCallback(self.host, ENGINE_CALLBACK_ERROR, 0, 0, 0, 0.0, error)

  361. 

  362.         elif msg == "show":

  363.             self.fFirstInit = False

  364.             self.uiShow()

  365. 

  366.         elif msg == "focus":

  367.             self.uiFocus()

  368. 

  369.         elif msg == "hide":

  370.             self.uiHide()

  371. 

  372.         elif msg == "quit":

  373.             self.fQuitReceived = True

  374.             self.uiQuit()

  375. 

  376.         elif msg == "uiTitle":

  377.             uiTitle = self.readlineblock().replace("\r", "\n")

  378.             self.uiTitleChanged(uiTitle)

  379. 

  380.         else:

  381.             print("unknown message: \"" + msg + "\"")

  382. 

  383. # ------------------------------------------------------------------------------------------------------------

  384. # Embed plugin UI

  385. 

  386. if LINUX and not config_UseQt5:

  387.     from PyQt4.QtGui import QHBoxLayout, QKeySequence, QX11EmbedWidget

  388. 

  389.     class CarlaEmbedW(QX11EmbedWidget):

  390.         def __init__(self, host, winId):

  391.             QX11EmbedWidget.__init__(self)

  392.             self.host = host

  393. 

  394.             self.fWinId = winId

  395. 

  396.             self.fLayout = QVBoxLayout(self)

  397.             self.fLayout.setContentsMargins(0, 0, 0, 0)

  398.             self.fLayout.setSpacing(0)

  399.             self.setLayout(self.fLayout)

  400. 

  401.             self.gui = CarlaMiniW(host, self)

  402.             self.gui.hide()

  403. 

  404.             self.gui.ui.act_file_quit.setEnabled(False)

  405.             self.gui.ui.act_file_quit.setVisible(False)

  406. 

  407.             self.fShortcutActions = []

  408.             self.addShortcutActions(self.gui.ui.menu_File.actions())

  409.             self.addShortcutActions(self.gui.ui.menu_Plugin.actions())

  410.             self.addShortcutActions(self.gui.ui.menu_PluginMacros.actions())

  411.             self.addShortcutActions(self.gui.ui.menu_Settings.actions())

  412.             self.addShortcutActions(self.gui.ui.menu_Help.actions())

  413. 

  414.             if self.host.processMode == ENGINE_PROCESS_MODE_PATCHBAY:

  415.                 self.addShortcutActions(self.gui.ui.menu_Canvas.actions())

  416.                 self.addShortcutActions(self.gui.ui.menu_Canvas_Zoom.actions())

  417. 

  418.             self.addWidget(self.gui.ui.menubar)

  419.             self.addLine()

  420.             self.addWidget(self.gui.ui.toolBar)

  421. 

  422.             if self.host.processMode == ENGINE_PROCESS_MODE_PATCHBAY:

  423.                 self.addLine()

  424. 

  425.             self.addWidget(self.gui.centralWidget())

  426. 

  427.             self.setFixedSize(740, 512)

  428.             self.embedInto(winId)

  429.             self.show()

  430. 

  431.         def addShortcutActions(self, actions):

  432.             for action in actions:

  433.                 if not action.shortcut().isEmpty():

  434.                     self.fShortcutActions.append(action)

  435. 

  436.         def addWidget(self, widget):

  437.             widget.setParent(self)

  438.             self.fLayout.addWidget(widget)

  439. 

  440.         def addLine(self):

  441.             line = QFrame(self)

  442.             line.setFrameShadow(QFrame.Sunken)

  443.             line.setFrameShape(QFrame.HLine)

  444.             line.setLineWidth(0)

  445.             line.setMidLineWidth(1)

  446.             self.fLayout.addWidget(line)

  447. 

  448.         def keyPressEvent(self, event):

  449.             modifiers    = event.modifiers()

  450.             modifiersStr = ""

  451. 

  452.             if modifiers & Qt.ShiftModifier:

  453.                 modifiersStr += "Shift+"

  454.             if modifiers & Qt.ControlModifier:

  455.                 modifiersStr += "Ctrl+"

  456.             if modifiers & Qt.AltModifier:

  457.                 modifiersStr += "Alt+"

  458.             if modifiers & Qt.MetaModifier:

  459.                 modifiersStr += "Meta+"

  460. 

  461.             keyStr = QKeySequence(event.key()).toString()

  462.             keySeq = QKeySequence(modifiersStr + keyStr)

  463. 

  464.             for action in self.fShortcutActions:

  465.                 if not action.isEnabled():

  466.                     continue

  467.                 if keySeq.matches(action.shortcut()) != QKeySequence.ExactMatch:

  468.                     continue

  469.                 event.accept()

  470.                 action.trigger()

  471.                 return

  472. 

  473.             QX11EmbedWidget.keyPressEvent(self, event)

  474. 

  475.         def showEvent(self, event):

  476.             QX11EmbedWidget.showEvent(self, event)

  477. 

  478.             # set our gui as parent for all plugins UIs

  479.             winIdStr = "%x" % self.fWinId

  480.             self.host.set_engine_option(ENGINE_OPTION_FRONTEND_WIN_ID, 0, winIdStr)

  481. 

  482.         def hideEvent(self, event):

  483.             # disable parent

  484.             self.host.set_engine_option(ENGINE_OPTION_FRONTEND_WIN_ID, 0, "0")

  485. 

  486.             QX11EmbedWidget.hideEvent(self, event)

  487. 

  488.         def closeEvent(self, event):

  489.             self.gui.close()

  490.             self.gui.closeExternalUI()

  491.             QX11EmbedWidget.closeEvent(self, event)

  492. 

  493.             # there might be other qt windows open which will block carla-plugin from quitting

  494.             app.quit()

  495. 

  496. # ------------------------------------------------------------------------------------------------------------

  497. # Main

  498. 

  499. if __name__ == '__main__':

  500.     # -------------------------------------------------------------

  501.     # App initialization

  502. 

  503.     app = CarlaApplication("Carla2-Plugin")

  504. 

  505.     # -------------------------------------------------------------

  506.     # Set-up custom signal handling

  507. 

  508.     setUpSignals()

  509. 

  510.     # -------------------------------------------------------------

  511.     # Init host backend

  512. 

  513.     host = initHost("Carla-Plugin", None, False, True, True, PluginHost)

  514.     host.processMode       = ENGINE_PROCESS_MODE_PATCHBAY if sys.argv[0].lower().endswith("/carla-plugin-patchbay") else ENGINE_PROCESS_MODE_CONTINUOUS_RACK

  515.     host.processModeForced = True

  516.     host.nextProcessMode   = host.processMode

  517.     loadHostSettings(host)

  518. 

  519.     # -------------------------------------------------------------

  520.     # Create GUI

  521. 

  522.     try:

  523.         winId = int(os.getenv("CARLA_PLUGIN_EMBED_WINID"))

  524.     except:

  525.         winId = 0

  526. 

  527.     gCarla.utils.setenv("CARLA_PLUGIN_EMBED_WINID", "0")

  528. 

  529.     if LINUX and winId != 0 and not config_UseQt5:

  530.         gui = CarlaEmbedW(host, winId)

  531.     else:

  532.         gui = CarlaMiniW(host)

  533. 

  534.     # -------------------------------------------------------------

  535.     # App-Loop

  536. 

  537.     app.exit_exec()