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.

carla_backend.py 98KB

11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
11 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
11 years ago
10 years ago
11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
11 years ago
11 years ago
10 years ago
11 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
10 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
10 years ago
10 years ago
10 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. # Carla Backend code
  4. # Copyright (C) 2011-2014 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. from abc import ABCMeta, abstractmethod
  20. from ctypes import *
  21. from platform import architecture
  22. from sys import platform, maxsize
  23. # ------------------------------------------------------------------------------------------------------------
  24. # 64bit check
  25. kIs64bit = bool(architecture()[0] == "64bit" and maxsize > 2**32)
  26. # ------------------------------------------------------------------------------------------------------------
  27. # Define custom types
  28. c_enum = c_int
  29. c_uintptr = c_uint64 if kIs64bit else c_uint32
  30. # ------------------------------------------------------------------------------------------------------------
  31. # Set Platform
  32. if platform == "darwin":
  33. HAIKU = False
  34. LINUX = False
  35. MACOS = True
  36. WINDOWS = False
  37. elif "haiku" in platform:
  38. HAIKU = True
  39. LINUX = False
  40. MACOS = False
  41. WINDOWS = False
  42. elif "linux" in platform:
  43. HAIKU = False
  44. LINUX = True
  45. MACOS = False
  46. WINDOWS = False
  47. elif platform in ("win32", "win64", "cygwin"):
  48. HAIKU = False
  49. LINUX = False
  50. MACOS = False
  51. WINDOWS = True
  52. else:
  53. HAIKU = False
  54. LINUX = False
  55. MACOS = False
  56. WINDOWS = False
  57. # ------------------------------------------------------------------------------------------------------------
  58. # Convert a ctypes c_char_p into a python string
  59. def charPtrToString(charPtr):
  60. if not charPtr:
  61. return ""
  62. if isinstance(charPtr, str):
  63. return charPtr
  64. return charPtr.decode("utf-8", errors="ignore")
  65. # ------------------------------------------------------------------------------------------------------------
  66. # Convert a ctypes POINTER(c_char_p) into a python string list
  67. def charPtrPtrToStringList(charPtrPtr):
  68. if not charPtrPtr:
  69. return []
  70. i = 0
  71. charPtr = charPtrPtr[0]
  72. strList = []
  73. while charPtr:
  74. strList.append(charPtr.decode("utf-8", errors="ignore"))
  75. i += 1
  76. charPtr = charPtrPtr[i]
  77. return strList
  78. # ------------------------------------------------------------------------------------------------------------
  79. # Convert a ctypes POINTER(c_<num>) into a python number list
  80. def numPtrToList(numPtr):
  81. if not numPtr:
  82. return []
  83. i = 0
  84. num = numPtr[0] #.value
  85. numList = []
  86. while num not in (0, 0.0):
  87. numList.append(num)
  88. i += 1
  89. num = numPtr[i] #.value
  90. return numList
  91. # ------------------------------------------------------------------------------------------------------------
  92. # Convert a ctypes value into a python one
  93. c_int_types = (c_int, c_int8, c_int16, c_int32, c_int64, c_uint, c_uint8, c_uint16, c_uint32, c_uint64, c_long, c_longlong)
  94. c_float_types = (c_float, c_double, c_longdouble)
  95. c_intp_types = tuple(POINTER(i) for i in c_int_types)
  96. c_floatp_types = tuple(POINTER(i) for i in c_float_types)
  97. def toPythonType(value, attr):
  98. if isinstance(value, (bool, int, float)):
  99. return value
  100. if isinstance(value, bytes):
  101. return charPtrToString(value)
  102. if isinstance(value, c_intp_types) or isinstance(value, c_floatp_types):
  103. return numPtrToList(value)
  104. if isinstance(value, POINTER(c_char_p)):
  105. return charPtrPtrToStringList(value)
  106. print("..............", attr, ".....................", value, ":", type(value))
  107. return value
  108. # ------------------------------------------------------------------------------------------------------------
  109. # Convert a ctypes struct into a python dict
  110. def structToDict(struct):
  111. return dict((attr, toPythonType(getattr(struct, attr), attr)) for attr, value in struct._fields_)
  112. # ------------------------------------------------------------------------------------------------------------
  113. # Carla Backend API (base definitions)
  114. # Maximum default number of loadable plugins.
  115. MAX_DEFAULT_PLUGINS = 99
  116. # Maximum number of loadable plugins in rack mode.
  117. MAX_RACK_PLUGINS = 16
  118. # Maximum number of loadable plugins in patchbay mode.
  119. MAX_PATCHBAY_PLUGINS = 255
  120. # Maximum default number of parameters allowed.
  121. # @see ENGINE_OPTION_MAX_PARAMETERS
  122. MAX_DEFAULT_PARAMETERS = 200
  123. # ------------------------------------------------------------------------------------------------------------
  124. # Engine Driver Device Hints
  125. # Various engine driver device hints.
  126. # @see carla_get_engine_driver_device_info()
  127. # Engine driver device has custom control-panel.
  128. ENGINE_DRIVER_DEVICE_HAS_CONTROL_PANEL = 0x1
  129. # Engine driver device can use a triple-buffer (3 number of periods instead of the usual 2).
  130. # @see ENGINE_OPTION_AUDIO_NUM_PERIODS
  131. ENGINE_DRIVER_DEVICE_CAN_TRIPLE_BUFFER = 0x2
  132. # Engine driver device can change buffer-size on the fly.
  133. # @see ENGINE_OPTION_AUDIO_BUFFER_SIZE
  134. ENGINE_DRIVER_DEVICE_VARIABLE_BUFFER_SIZE = 0x4
  135. # Engine driver device can change sample-rate on the fly.
  136. # @see ENGINE_OPTION_AUDIO_SAMPLE_RATE
  137. ENGINE_DRIVER_DEVICE_VARIABLE_SAMPLE_RATE = 0x8
  138. # ------------------------------------------------------------------------------------------------------------
  139. # Plugin Hints
  140. # Various plugin hints.
  141. # @see carla_get_plugin_info()
  142. # Plugin is a bridge.
  143. # This hint is required because "bridge" itself is not a plugin type.
  144. PLUGIN_IS_BRIDGE = 0x001
  145. # Plugin is hard real-time safe.
  146. PLUGIN_IS_RTSAFE = 0x002
  147. # Plugin is a synth (produces sound).
  148. PLUGIN_IS_SYNTH = 0x004
  149. # Plugin has its own custom UI.
  150. # @see carla_show_custom_ui()
  151. PLUGIN_HAS_CUSTOM_UI = 0x008
  152. # Plugin can use internal Dry/Wet control.
  153. PLUGIN_CAN_DRYWET = 0x010
  154. # Plugin can use internal Volume control.
  155. PLUGIN_CAN_VOLUME = 0x020
  156. # Plugin can use internal (Stereo) Balance controls.
  157. PLUGIN_CAN_BALANCE = 0x040
  158. # Plugin can use internal (Mono) Panning control.
  159. PLUGIN_CAN_PANNING = 0x080
  160. # Plugin needs a constant, fixed-size audio buffer.
  161. PLUGIN_NEEDS_FIXED_BUFFERS = 0x100
  162. # Plugin needs to receive all UI events in the main thread.
  163. PLUGIN_NEEDS_UI_MAIN_THREAD = 0x200
  164. # ------------------------------------------------------------------------------------------------------------
  165. # Plugin Options
  166. # Various plugin options.
  167. # @see carla_get_plugin_info() and carla_set_option()
  168. # Use constant/fixed-size audio buffers.
  169. PLUGIN_OPTION_FIXED_BUFFERS = 0x001
  170. # Force mono plugin as stereo.
  171. PLUGIN_OPTION_FORCE_STEREO = 0x002
  172. # Map MIDI programs to plugin programs.
  173. PLUGIN_OPTION_MAP_PROGRAM_CHANGES = 0x004
  174. # Use chunks to save and restore data instead of parameter values.
  175. PLUGIN_OPTION_USE_CHUNKS = 0x008
  176. # Send MIDI control change events.
  177. PLUGIN_OPTION_SEND_CONTROL_CHANGES = 0x010
  178. # Send MIDI channel pressure events.
  179. PLUGIN_OPTION_SEND_CHANNEL_PRESSURE = 0x020
  180. # Send MIDI note after-touch events.
  181. PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH = 0x040
  182. # Send MIDI pitch-bend events.
  183. PLUGIN_OPTION_SEND_PITCHBEND = 0x080
  184. # Send MIDI all-sounds/notes-off events, single note-offs otherwise.
  185. PLUGIN_OPTION_SEND_ALL_SOUND_OFF = 0x100
  186. # Send MIDI bank/program changes.
  187. # @note: This option conflicts with PLUGIN_OPTION_MAP_PROGRAM_CHANGES and cannot be used at the same time.
  188. PLUGIN_OPTION_SEND_PROGRAM_CHANGES = 0x200
  189. # ------------------------------------------------------------------------------------------------------------
  190. # Parameter Hints
  191. # Various parameter hints.
  192. # @see CarlaPlugin::getParameterData() and carla_get_parameter_data()
  193. # Parameter value is boolean.
  194. PARAMETER_IS_BOOLEAN = 0x001
  195. # Parameter value is integer.
  196. PARAMETER_IS_INTEGER = 0x002
  197. # Parameter value is logarithmic.
  198. PARAMETER_IS_LOGARITHMIC = 0x004
  199. # Parameter is enabled.
  200. # It can be viewed, changed and stored.
  201. PARAMETER_IS_ENABLED = 0x010
  202. # Parameter is automable (real-time safe).
  203. PARAMETER_IS_AUTOMABLE = 0x020
  204. # Parameter is read-only.
  205. # It cannot be changed.
  206. PARAMETER_IS_READ_ONLY = 0x040
  207. # Parameter needs sample rate to work.
  208. # Value and ranges are multiplied by sample rate on usage and divided by sample rate on save.
  209. PARAMETER_USES_SAMPLERATE = 0x100
  210. # Parameter uses scale points to define internal values in a meaningful way.
  211. PARAMETER_USES_SCALEPOINTS = 0x200
  212. # Parameter uses custom text for displaying its value.
  213. # @see carla_get_parameter_text()
  214. PARAMETER_USES_CUSTOM_TEXT = 0x400
  215. # ------------------------------------------------------------------------------------------------------------
  216. # Patchbay Port Hints
  217. # Various patchbay port hints.
  218. # Patchbay port is input.
  219. # When this hint is not set, port is assumed to be output.
  220. PATCHBAY_PORT_IS_INPUT = 0x1
  221. # Patchbay port is of Audio type.
  222. PATCHBAY_PORT_TYPE_AUDIO = 0x2
  223. # Patchbay port is of CV type (Control Voltage).
  224. PATCHBAY_PORT_TYPE_CV = 0x4
  225. # Patchbay port is of MIDI type.
  226. PATCHBAY_PORT_TYPE_MIDI = 0x8
  227. # ------------------------------------------------------------------------------------------------------------
  228. # Custom Data Types
  229. # These types define how the value in the CustomData struct is stored.
  230. # @see CustomData.type
  231. # Boolean string type URI.
  232. # Only "true" and "false" are valid values.
  233. CUSTOM_DATA_TYPE_BOOLEAN = "http://kxstudio.sf.net/ns/carla/boolean"
  234. # Chunk type URI.
  235. CUSTOM_DATA_TYPE_CHUNK = "http://kxstudio.sf.net/ns/carla/chunk"
  236. # Property type URI.
  237. CUSTOM_DATA_TYPE_PROPERTY = "http://kxstudio.sf.net/ns/carla/property"
  238. # String type URI.
  239. CUSTOM_DATA_TYPE_STRING = "http://kxstudio.sf.net/ns/carla/string"
  240. # ------------------------------------------------------------------------------------------------------------
  241. # Custom Data Keys
  242. # Pre-defined keys used internally in Carla.
  243. # @see CustomData.key
  244. # Plugin options key.
  245. CUSTOM_DATA_KEY_PLUGIN_OPTIONS = "CarlaPluginOptions"
  246. # UI position key.
  247. CUSTOM_DATA_KEY_UI_POSITION = "CarlaUiPosition"
  248. # UI size key.
  249. CUSTOM_DATA_KEY_UI_SIZE = "CarlaUiSize"
  250. # UI visible key.
  251. CUSTOM_DATA_KEY_UI_VISIBLE = "CarlaUiVisible"
  252. # ------------------------------------------------------------------------------------------------------------
  253. # Binary Type
  254. # The binary type of a plugin.
  255. # Null binary type.
  256. BINARY_NONE = 0
  257. # POSIX 32bit binary.
  258. BINARY_POSIX32 = 1
  259. # POSIX 64bit binary.
  260. BINARY_POSIX64 = 2
  261. # Windows 32bit binary.
  262. BINARY_WIN32 = 3
  263. # Windows 64bit binary.
  264. BINARY_WIN64 = 4
  265. # Other binary type.
  266. BINARY_OTHER = 5
  267. # ------------------------------------------------------------------------------------------------------------
  268. # Plugin Type
  269. # Plugin type.
  270. # Some files are handled as if they were plugins.
  271. # Null plugin type.
  272. PLUGIN_NONE = 0
  273. # Internal plugin.
  274. PLUGIN_INTERNAL = 1
  275. # LADSPA plugin.
  276. PLUGIN_LADSPA = 2
  277. # DSSI plugin.
  278. PLUGIN_DSSI = 3
  279. # LV2 plugin.
  280. PLUGIN_LV2 = 4
  281. # VST2 plugin.
  282. PLUGIN_VST2 = 5
  283. # VST3 plugin.
  284. PLUGIN_VST3 = 6
  285. # AU plugin.
  286. # @note MacOS only
  287. PLUGIN_AU = 7
  288. # GIG file.
  289. PLUGIN_GIG = 8
  290. # SF2 file (SoundFont).
  291. PLUGIN_SF2 = 9
  292. # SFZ file.
  293. PLUGIN_SFZ = 10
  294. # ------------------------------------------------------------------------------------------------------------
  295. # Plugin Category
  296. # Plugin category, which describes the functionality of a plugin.
  297. # Null plugin category.
  298. PLUGIN_CATEGORY_NONE = 0
  299. # A synthesizer or generator.
  300. PLUGIN_CATEGORY_SYNTH = 1
  301. # A delay or reverb.
  302. PLUGIN_CATEGORY_DELAY = 2
  303. # An equalizer.
  304. PLUGIN_CATEGORY_EQ = 3
  305. # A filter.
  306. PLUGIN_CATEGORY_FILTER = 4
  307. # A distortion plugin.
  308. PLUGIN_CATEGORY_DISTORTION = 5
  309. # A 'dynamic' plugin (amplifier, compressor, gate, etc).
  310. PLUGIN_CATEGORY_DYNAMICS = 6
  311. # A 'modulator' plugin (chorus, flanger, phaser, etc).
  312. PLUGIN_CATEGORY_MODULATOR = 7
  313. # An 'utility' plugin (analyzer, converter, mixer, etc).
  314. PLUGIN_CATEGORY_UTILITY = 8
  315. # Miscellaneous plugin (used to check if the plugin has a category).
  316. PLUGIN_CATEGORY_OTHER = 9
  317. # ------------------------------------------------------------------------------------------------------------
  318. # Parameter Type
  319. # Plugin parameter type.
  320. # Null parameter type.
  321. PARAMETER_UNKNOWN = 0
  322. # Input parameter.
  323. PARAMETER_INPUT = 1
  324. # Ouput parameter.
  325. PARAMETER_OUTPUT = 2
  326. # ------------------------------------------------------------------------------------------------------------
  327. # Internal Parameter Index
  328. # Special parameters used internally in Carla.
  329. # Plugins do not know about their existence.
  330. # Null parameter.
  331. PARAMETER_NULL = -1
  332. # Active parameter, boolean type.
  333. # Default is 'false'.
  334. PARAMETER_ACTIVE = -2
  335. # Dry/Wet parameter.
  336. # Range 0.0...1.0; default is 1.0.
  337. PARAMETER_DRYWET = -3
  338. # Volume parameter.
  339. # Range 0.0...1.27; default is 1.0.
  340. PARAMETER_VOLUME = -4
  341. # Stereo Balance-Left parameter.
  342. # Range -1.0...1.0; default is -1.0.
  343. PARAMETER_BALANCE_LEFT = -5
  344. # Stereo Balance-Right parameter.
  345. # Range -1.0...1.0; default is 1.0.
  346. PARAMETER_BALANCE_RIGHT = -6
  347. # Mono Panning parameter.
  348. # Range -1.0...1.0; default is 0.0.
  349. PARAMETER_PANNING = -7
  350. # MIDI Control channel, integer type.
  351. # Range -1...15 (-1 = off).
  352. PARAMETER_CTRL_CHANNEL = -8
  353. # Max value, defined only for convenience.
  354. PARAMETER_MAX = -9
  355. # ------------------------------------------------------------------------------------------------------------
  356. # Engine Callback Opcode
  357. # Engine callback opcodes.
  358. # Front-ends must never block indefinitely during a callback.
  359. # @see EngineCallbackFunc and carla_set_engine_callback()
  360. # Debug.
  361. # This opcode is undefined and used only for testing purposes.
  362. ENGINE_CALLBACK_DEBUG = 0
  363. # A plugin has been added.
  364. # @a pluginId Plugin Id
  365. # @a valueStr Plugin name
  366. ENGINE_CALLBACK_PLUGIN_ADDED = 1
  367. # A plugin has been removed.
  368. # @a pluginId Plugin Id
  369. ENGINE_CALLBACK_PLUGIN_REMOVED = 2
  370. # A plugin has been renamed.
  371. # @a pluginId Plugin Id
  372. # @a valueStr New plugin name
  373. ENGINE_CALLBACK_PLUGIN_RENAMED = 3
  374. # A plugin has become unavailable.
  375. # @a pluginId Plugin Id
  376. # @a valueStr Related error string
  377. ENGINE_CALLBACK_PLUGIN_UNAVAILABLE = 4
  378. # A parameter value has changed.
  379. # @a pluginId Plugin Id
  380. # @a value1 Parameter index
  381. # @a value3 New parameter value
  382. ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED = 5
  383. # A parameter default has changed.
  384. # @a pluginId Plugin Id
  385. # @a value1 Parameter index
  386. # @a value3 New default value
  387. ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED = 6
  388. # A parameter's MIDI CC has changed.
  389. # @a pluginId Plugin Id
  390. # @a value1 Parameter index
  391. # @a value2 New MIDI CC
  392. ENGINE_CALLBACK_PARAMETER_MIDI_CC_CHANGED = 7
  393. # A parameter's MIDI channel has changed.
  394. # @a pluginId Plugin Id
  395. # @a value1 Parameter index
  396. # @a value2 New MIDI channel
  397. ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED = 8
  398. # A plugin option has changed.
  399. # @a pluginId Plugin Id
  400. # @a value1 Option
  401. # @a value2 New on/off state (1 for on, 0 for off)
  402. # @see PluginOptions
  403. ENGINE_CALLBACK_OPTION_CHANGED = 9
  404. # The current program of a plugin has changed.
  405. # @a pluginId Plugin Id
  406. # @a value1 New program index
  407. ENGINE_CALLBACK_PROGRAM_CHANGED = 10
  408. # The current MIDI program of a plugin has changed.
  409. # @a pluginId Plugin Id
  410. # @a value1 New MIDI program index
  411. ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED = 11
  412. # A plugin's custom UI state has changed.
  413. # @a pluginId Plugin Id
  414. # @a value1 New state, as follows:
  415. # 0: UI is now hidden
  416. # 1: UI is now visible
  417. # -1: UI has crashed and should not be shown again
  418. ENGINE_CALLBACK_UI_STATE_CHANGED = 12
  419. # A note has been pressed.
  420. # @a pluginId Plugin Id
  421. # @a value1 Channel
  422. # @a value2 Note
  423. # @a value3 Velocity
  424. ENGINE_CALLBACK_NOTE_ON = 13
  425. # A note has been released.
  426. # @a pluginId Plugin Id
  427. # @a value1 Channel
  428. # @a value2 Note
  429. ENGINE_CALLBACK_NOTE_OFF = 14
  430. # A plugin needs update.
  431. # @a pluginId Plugin Id
  432. ENGINE_CALLBACK_UPDATE = 15
  433. # A plugin's data/information has changed.
  434. # @a pluginId Plugin Id
  435. ENGINE_CALLBACK_RELOAD_INFO = 16
  436. # A plugin's parameters have changed.
  437. # @a pluginId Plugin Id
  438. ENGINE_CALLBACK_RELOAD_PARAMETERS = 17
  439. # A plugin's programs have changed.
  440. # @a pluginId Plugin Id
  441. ENGINE_CALLBACK_RELOAD_PROGRAMS = 18
  442. # A plugin state has changed.
  443. # @a pluginId Plugin Id
  444. ENGINE_CALLBACK_RELOAD_ALL = 19
  445. # A patchbay client has been added.
  446. # @a pluginId Client Id
  447. # @a value1 Client icon
  448. # @a value2 Plugin Id (-1 if not a plugin)
  449. # @a valueStr Client name
  450. # @see PatchbayIcon
  451. ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED = 20
  452. # A patchbay client has been removed.
  453. # @a pluginId Client Id
  454. ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED = 21
  455. # A patchbay client has been renamed.
  456. # @a pluginId Client Id
  457. # @a valueStr New client name
  458. ENGINE_CALLBACK_PATCHBAY_CLIENT_RENAMED = 22
  459. # A patchbay client data has changed.
  460. # @a pluginId Client Id
  461. # @a value1 New icon
  462. # @a value2 New plugin Id (-1 if not a plugin)
  463. # @see PatchbayIcon
  464. ENGINE_CALLBACK_PATCHBAY_CLIENT_DATA_CHANGED = 23
  465. # A patchbay port has been added.
  466. # @a pluginId Client Id
  467. # @a value1 Port Id
  468. # @a value2 Port hints
  469. # @a valueStr Port name
  470. # @see PatchbayPortHints
  471. ENGINE_CALLBACK_PATCHBAY_PORT_ADDED = 24
  472. # A patchbay port has been removed.
  473. # @a pluginId Client Id
  474. # @a value1 Port Id
  475. ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED = 25
  476. # A patchbay port has been renamed.
  477. # @a pluginId Client Id
  478. # @a value1 Port Id
  479. # @a valueStr New port name
  480. ENGINE_CALLBACK_PATCHBAY_PORT_RENAMED = 26
  481. # A patchbay connection has been added.
  482. # @a pluginId Connection Id
  483. # @a valueStr Out group, port plus in group and port, in "og:op:ig:ip" syntax.
  484. ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED = 27
  485. # A patchbay connection has been removed.
  486. # @a pluginId Connection Id
  487. ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED = 28
  488. # Engine started.
  489. # @a value1 Process mode
  490. # @a value2 Transport mode
  491. # @a valuestr Engine driver
  492. # @see EngineProcessMode
  493. # @see EngineTransportMode
  494. ENGINE_CALLBACK_ENGINE_STARTED = 29
  495. # Engine stopped.
  496. ENGINE_CALLBACK_ENGINE_STOPPED = 30
  497. # Engine process mode has changed.
  498. # @a value1 New process mode
  499. # @see EngineProcessMode
  500. ENGINE_CALLBACK_PROCESS_MODE_CHANGED = 31
  501. # Engine transport mode has changed.
  502. # @a value1 New transport mode
  503. # @see EngineTransportMode
  504. ENGINE_CALLBACK_TRANSPORT_MODE_CHANGED = 32
  505. # Engine buffer-size changed.
  506. # @a value1 New buffer size
  507. ENGINE_CALLBACK_BUFFER_SIZE_CHANGED = 33
  508. # Engine sample-rate changed.
  509. # @a value3 New sample rate
  510. ENGINE_CALLBACK_SAMPLE_RATE_CHANGED = 34
  511. # NSM callback.
  512. # (Work in progress, values are not defined yet)
  513. ENGINE_CALLBACK_NSM = 35
  514. # Idle frontend.
  515. # This is used by the engine during long operations that might block the frontend,
  516. # giving it the possibility to idle while the operation is still in place.
  517. ENGINE_CALLBACK_IDLE = 36
  518. # Show a message as information.
  519. # @a valueStr The message
  520. ENGINE_CALLBACK_INFO = 37
  521. # Show a message as an error.
  522. # @a valueStr The message
  523. ENGINE_CALLBACK_ERROR = 38
  524. # The engine has crashed or malfunctioned and will no longer work.
  525. ENGINE_CALLBACK_QUIT = 39
  526. # ------------------------------------------------------------------------------------------------------------
  527. # Engine Option
  528. # Engine options.
  529. # @see carla_set_engine_option()
  530. # Debug.
  531. # This option is undefined and used only for testing purposes.
  532. ENGINE_OPTION_DEBUG = 0
  533. # Set the engine processing mode.
  534. # Default is ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS on Linux and ENGINE_PROCESS_MODE_CONTINUOUS_RACK for all other OSes.
  535. # @see EngineProcessMode
  536. ENGINE_OPTION_PROCESS_MODE = 1
  537. # Set the engine transport mode.
  538. # Default is ENGINE_TRANSPORT_MODE_JACK on Linux and ENGINE_TRANSPORT_MODE_INTERNAL for all other OSes.
  539. # @see EngineTransportMode
  540. ENGINE_OPTION_TRANSPORT_MODE = 2
  541. # Force mono plugins as stereo, by running 2 instances at the same time.
  542. # Default is false, but always true when process mode is ENGINE_PROCESS_MODE_CONTINUOUS_RACK.
  543. # @note Not supported by all plugins
  544. # @see PLUGIN_OPTION_FORCE_STEREO
  545. ENGINE_OPTION_FORCE_STEREO = 3
  546. # Use plugin bridges whenever possible.
  547. # Default is no, EXPERIMENTAL.
  548. ENGINE_OPTION_PREFER_PLUGIN_BRIDGES = 4
  549. # Use UI bridges whenever possible, otherwise UIs will be directly handled in the main backend thread.
  550. # Default is yes.
  551. ENGINE_OPTION_PREFER_UI_BRIDGES = 5
  552. # Make custom plugin UIs always-on-top.
  553. # Default is yes.
  554. ENGINE_OPTION_UIS_ALWAYS_ON_TOP = 6
  555. # Maximum number of parameters allowed.
  556. # Default is MAX_DEFAULT_PARAMETERS.
  557. ENGINE_OPTION_MAX_PARAMETERS = 7
  558. # Timeout value for how much to wait for UI bridges to respond, in milliseconds.
  559. # Default is 4000 (4 seconds).
  560. ENGINE_OPTION_UI_BRIDGES_TIMEOUT = 8
  561. # Number of audio periods.
  562. # Default is 2.
  563. ENGINE_OPTION_AUDIO_NUM_PERIODS = 9
  564. # Audio buffer size.
  565. # Default is 512.
  566. ENGINE_OPTION_AUDIO_BUFFER_SIZE = 10
  567. # Audio sample rate.
  568. # Default is 44100.
  569. ENGINE_OPTION_AUDIO_SAMPLE_RATE = 11
  570. # Audio device (within a driver).
  571. # Default unset.
  572. ENGINE_OPTION_AUDIO_DEVICE = 12
  573. # Set path used for a specific plugin type.
  574. # Uses value as the plugin format, valueStr as actual path.
  575. # @see PluginType
  576. ENGINE_OPTION_PLUGIN_PATH = 13
  577. # Set path to the binary files.
  578. # Default unset.
  579. # @note Must be set for plugin and UI bridges to work
  580. ENGINE_OPTION_PATH_BINARIES = 14
  581. # Set path to the resource files.
  582. # Default unset.
  583. # @note Must be set for some internal plugins to work
  584. ENGINE_OPTION_PATH_RESOURCES = 15
  585. # Prevent bad plugin and UI behaviour.
  586. # @note: Linux only
  587. ENGINE_OPTION_PREVENT_BAD_BEHAVIOUR = 16
  588. # Set frontend winId, used to define as parent window for plugin UIs.
  589. ENGINE_OPTION_FRONTEND_WIN_ID = 17
  590. # ------------------------------------------------------------------------------------------------------------
  591. # Engine Process Mode
  592. # Engine process mode.
  593. # @see ENGINE_OPTION_PROCESS_MODE
  594. # Single client mode.
  595. # Inputs and outputs are added dynamically as needed by plugins.
  596. ENGINE_PROCESS_MODE_SINGLE_CLIENT = 0
  597. # Multiple client mode.
  598. # It has 1 master client + 1 client per plugin.
  599. ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS = 1
  600. # Single client, 'rack' mode.
  601. # Processes plugins in order of Id, with forced stereo always on.
  602. ENGINE_PROCESS_MODE_CONTINUOUS_RACK = 2
  603. # Single client, 'patchbay' mode.
  604. ENGINE_PROCESS_MODE_PATCHBAY = 3
  605. # Special mode, used in plugin-bridges only.
  606. ENGINE_PROCESS_MODE_BRIDGE = 4
  607. # ------------------------------------------------------------------------------------------------------------
  608. # Engine Transport Mode
  609. # Engine transport mode.
  610. # @see ENGINE_OPTION_TRANSPORT_MODE
  611. # Internal transport mode.
  612. ENGINE_TRANSPORT_MODE_INTERNAL = 0
  613. # Transport from JACK.
  614. # Only available if driver name is "JACK".
  615. ENGINE_TRANSPORT_MODE_JACK = 1
  616. # Transport from host, used when Carla is a plugin.
  617. ENGINE_TRANSPORT_MODE_PLUGIN = 2
  618. # Special mode, used in plugin-bridges only.
  619. ENGINE_TRANSPORT_MODE_BRIDGE = 3
  620. # ------------------------------------------------------------------------------------------------------------
  621. # File Callback Opcode
  622. # File callback opcodes.
  623. # Front-ends must always block-wait for user input.
  624. # @see FileCallbackFunc and carla_set_file_callback()
  625. # Debug.
  626. # This opcode is undefined and used only for testing purposes.
  627. FILE_CALLBACK_DEBUG = 0
  628. # Open file or folder.
  629. FILE_CALLBACK_OPEN = 1
  630. # Save file or folder.
  631. FILE_CALLBACK_SAVE = 2
  632. # ------------------------------------------------------------------------------------------------------------
  633. # Patchbay Icon
  634. # The icon of a patchbay client/group.
  635. # Generic application icon.
  636. # Used for all non-plugin clients that don't have a specific icon.
  637. PATCHBAY_ICON_APPLICATION = 0
  638. # Plugin icon.
  639. # Used for all plugin clients that don't have a specific icon.
  640. PATCHBAY_ICON_PLUGIN = 1
  641. # Hardware icon.
  642. # Used for hardware (audio or MIDI) clients.
  643. PATCHBAY_ICON_HARDWARE = 2
  644. # Carla icon.
  645. # Used for the main app.
  646. PATCHBAY_ICON_CARLA = 3
  647. # DISTRHO icon.
  648. # Used for DISTRHO based plugins.
  649. PATCHBAY_ICON_DISTRHO = 4
  650. # File icon.
  651. # Used for file type plugins (like GIG and SF2).
  652. PATCHBAY_ICON_FILE = 5
  653. # ------------------------------------------------------------------------------------------------------------
  654. # Carla Backend API (C stuff)
  655. # Engine callback function.
  656. # Front-ends must never block indefinitely during a callback.
  657. # @see EngineCallbackOpcode and carla_set_engine_callback()
  658. EngineCallbackFunc = CFUNCTYPE(None, c_void_p, c_enum, c_uint, c_int, c_int, c_float, c_char_p)
  659. # File callback function.
  660. # @see FileCallbackOpcode
  661. FileCallbackFunc = CFUNCTYPE(c_char_p, c_void_p, c_enum, c_bool, c_char_p, c_char_p)
  662. # Parameter data.
  663. class ParameterData(Structure):
  664. _fields_ = [
  665. # This parameter type.
  666. ("type", c_enum),
  667. # This parameter hints.
  668. # @see ParameterHints
  669. ("hints", c_uint),
  670. # Index as seen by Carla.
  671. ("index", c_int32),
  672. # Real index as seen by plugins.
  673. ("rindex", c_int32),
  674. # Currently mapped MIDI CC.
  675. # A value lower than 0 means invalid or unused.
  676. # Maximum allowed value is 119 (0x77).
  677. ("midiCC", c_int16),
  678. # Currently mapped MIDI channel.
  679. # Counts from 0 to 15.
  680. ("midiChannel", c_uint8)
  681. ]
  682. # Parameter ranges.
  683. class ParameterRanges(Structure):
  684. _fields_ = [
  685. # Default value.
  686. ("def", c_float),
  687. # Minimum value.
  688. ("min", c_float),
  689. # Maximum value.
  690. ("max", c_float),
  691. # Regular, single step value.
  692. ("step", c_float),
  693. # Small step value.
  694. ("stepSmall", c_float),
  695. # Large step value.
  696. ("stepLarge", c_float)
  697. ]
  698. # MIDI Program data.
  699. class MidiProgramData(Structure):
  700. _fields_ = [
  701. # MIDI bank.
  702. ("bank", c_uint32),
  703. # MIDI program.
  704. ("program", c_uint32),
  705. # MIDI program name.
  706. ("name", c_char_p)
  707. ]
  708. # Custom data, used for saving key:value 'dictionaries'.
  709. class CustomData(Structure):
  710. _fields_ = [
  711. # Value type, in URI form.
  712. # @see CustomDataTypes
  713. ("type", c_char_p),
  714. # Key.
  715. # @see CustomDataKeys
  716. ("key", c_char_p),
  717. # Value.
  718. ("value", c_char_p)
  719. ]
  720. # Engine driver device information.
  721. class EngineDriverDeviceInfo(Structure):
  722. _fields_ = [
  723. # This driver device hints.
  724. # @see EngineDriverHints
  725. ("hints", c_uint),
  726. # Available buffer sizes.
  727. # Terminated with 0.
  728. ("bufferSizes", POINTER(c_uint32)),
  729. # Available sample rates.
  730. # Terminated with 0.0.
  731. ("sampleRates", POINTER(c_double))
  732. ]
  733. # ------------------------------------------------------------------------------------------------------------
  734. # Carla Backend API (Python compatible stuff)
  735. # @see ParameterData
  736. PyParameterData = {
  737. 'type': PARAMETER_UNKNOWN,
  738. 'hints': 0x0,
  739. 'index': PARAMETER_NULL,
  740. 'rindex': -1,
  741. 'midiCC': -1,
  742. 'midiChannel': 0
  743. }
  744. # @see ParameterRanges
  745. PyParameterRanges = {
  746. 'def': 0.0,
  747. 'min': 0.0,
  748. 'max': 1.0,
  749. 'step': 0.01,
  750. 'stepSmall': 0.0001,
  751. 'stepLarge': 0.1
  752. }
  753. # @see MidiProgramData
  754. PyMidiProgramData = {
  755. 'bank': 0,
  756. 'program': 0,
  757. 'name': None
  758. }
  759. # @see CustomData
  760. PyCustomData = {
  761. 'type': None,
  762. 'key': None,
  763. 'value': None
  764. }
  765. # @see EngineDriverDeviceInfo
  766. PyEngineDriverDeviceInfo = {
  767. 'hints': 0x0,
  768. 'bufferSizes': [],
  769. 'sampleRates': []
  770. }
  771. # ------------------------------------------------------------------------------------------------------------
  772. # Carla Host API (C stuff)
  773. # Information about a loaded plugin.
  774. # @see carla_get_plugin_info()
  775. class CarlaPluginInfo(Structure):
  776. _fields_ = [
  777. # Plugin type.
  778. ("type", c_enum),
  779. # Plugin category.
  780. ("category", c_enum),
  781. # Plugin hints.
  782. # @see PluginHints
  783. ("hints", c_uint),
  784. # Plugin options available for the user to change.
  785. # @see PluginOptions
  786. ("optionsAvailable", c_uint),
  787. # Plugin options currently enabled.
  788. # Some options are enabled but not available, which means they will always be on.
  789. # @see PluginOptions
  790. ("optionsEnabled", c_uint),
  791. # Plugin filename.
  792. # This can be the plugin binary or resource file.
  793. ("filename", c_char_p),
  794. # Plugin name.
  795. # This name is unique within a Carla instance.
  796. # @see carla_get_real_plugin_name()
  797. ("name", c_char_p),
  798. # Plugin label or URI.
  799. ("label", c_char_p),
  800. # Plugin author/maker.
  801. ("maker", c_char_p),
  802. # Plugin copyright/license.
  803. ("copyright", c_char_p),
  804. # Icon name for this plugin, in lowercase.
  805. # Default is "plugin".
  806. ("iconName", c_char_p),
  807. # Plugin unique Id.
  808. # This Id is dependant on the plugin type and may sometimes be 0.
  809. ("uniqueId", c_int64)
  810. ]
  811. # Port count information, used for Audio and MIDI ports and parameters.
  812. # @see carla_get_audio_port_count_info()
  813. # @see carla_get_midi_port_count_info()
  814. # @see carla_get_parameter_count_info()
  815. class CarlaPortCountInfo(Structure):
  816. _fields_ = [
  817. # Number of inputs.
  818. ("ins", c_uint32),
  819. # Number of outputs.
  820. ("outs", c_uint32)
  821. ]
  822. # Parameter information.
  823. # @see carla_get_parameter_info()
  824. class CarlaParameterInfo(Structure):
  825. _fields_ = [
  826. # Parameter name.
  827. ("name", c_char_p),
  828. # Parameter symbol.
  829. ("symbol", c_char_p),
  830. # Parameter unit.
  831. ("unit", c_char_p),
  832. # Number of scale points.
  833. # @see CarlaScalePointInfo
  834. ("scalePointCount", c_uint32)
  835. ]
  836. # Parameter scale point information.
  837. # @see carla_get_parameter_scalepoint_info()
  838. class CarlaScalePointInfo(Structure):
  839. _fields_ = [
  840. # Scale point value.
  841. ("value", c_float),
  842. # Scale point label.
  843. ("label", c_char_p)
  844. ]
  845. # Transport information.
  846. # @see carla_get_transport_info()
  847. class CarlaTransportInfo(Structure):
  848. _fields_ = [
  849. # Wherever transport is playing.
  850. ("playing", c_bool),
  851. # Current transport frame.
  852. ("frame", c_uint64),
  853. # Bar
  854. ("bar", c_int32),
  855. # Beat
  856. ("beat", c_int32),
  857. # Tick
  858. ("tick", c_int32),
  859. # Beats per minute.
  860. ("bpm", c_double)
  861. ]
  862. # ------------------------------------------------------------------------------------------------------------
  863. # Carla Host API (Python compatible stuff)
  864. # @see CarlaPluginInfo
  865. PyCarlaPluginInfo = {
  866. 'type': PLUGIN_NONE,
  867. 'category': PLUGIN_CATEGORY_NONE,
  868. 'hints': 0x0,
  869. 'optionsAvailable': 0x0,
  870. 'optionsEnabled': 0x0,
  871. 'filename': "",
  872. 'name': "",
  873. 'label': "",
  874. 'maker': "",
  875. 'copyright': "",
  876. 'iconName': "",
  877. 'uniqueId': 0
  878. }
  879. # @see CarlaPortCountInfo
  880. PyCarlaPortCountInfo = {
  881. 'ins': 0,
  882. 'outs': 0
  883. }
  884. # @see CarlaParameterInfo
  885. PyCarlaParameterInfo = {
  886. 'name': "",
  887. 'symbol': "",
  888. 'unit': "",
  889. 'scalePointCount': 0,
  890. }
  891. # @see CarlaScalePointInfo
  892. PyCarlaScalePointInfo = {
  893. 'value': 0.0,
  894. 'label': ""
  895. }
  896. # @see CarlaTransportInfo
  897. PyCarlaTransportInfo = {
  898. "playing": False,
  899. "frame": 0,
  900. "bar": 0,
  901. "beat": 0,
  902. "tick": 0,
  903. "bpm": 0.0
  904. }
  905. # ------------------------------------------------------------------------------------------------------------
  906. # Set BINARY_NATIVE
  907. if HAIKU or LINUX or MACOS:
  908. BINARY_NATIVE = BINARY_POSIX64 if kIs64bit else BINARY_POSIX32
  909. elif WINDOWS:
  910. BINARY_NATIVE = BINARY_WIN64 if kIs64bit else BINARY_WIN32
  911. else:
  912. BINARY_NATIVE = BINARY_OTHER
  913. # ------------------------------------------------------------------------------------------------------------
  914. # Carla Host object (Meta)
  915. class CarlaHostMeta(object):
  916. #class CarlaHostMeta(object, metaclass=ABCMeta):
  917. def __init__(self):
  918. object.__init__(self)
  919. # info about this host object
  920. self.isControl = False
  921. self.isPlugin = False
  922. self.nsmOK = False
  923. # settings
  924. self.processMode = ENGINE_PROCESS_MODE_CONTINUOUS_RACK
  925. self.transportMode = ENGINE_TRANSPORT_MODE_INTERNAL
  926. self.nextProcessMode = ENGINE_PROCESS_MODE_CONTINUOUS_RACK
  927. self.processModeForced = False
  928. # settings
  929. self.forceStereo = False
  930. self.preferPluginBridges = False
  931. self.preferUIBridges = False
  932. self.preventBadBehaviour = False
  933. self.uisAlwaysOnTop = False
  934. self.maxParameters = 0
  935. self.uiBridgesTimeout = 0
  936. # settings
  937. self.pathBinaries = ""
  938. self.pathResources = ""
  939. # Get how many engine drivers are available.
  940. @abstractmethod
  941. def get_engine_driver_count(self):
  942. raise NotImplementedError
  943. # Get an engine driver name.
  944. # @param index Driver index
  945. @abstractmethod
  946. def get_engine_driver_name(self, index):
  947. raise NotImplementedError
  948. # Get the device names of an engine driver.
  949. # @param index Driver index
  950. @abstractmethod
  951. def get_engine_driver_device_names(self, index):
  952. raise NotImplementedError
  953. # Get information about a device driver.
  954. # @param index Driver index
  955. # @param name Device name
  956. @abstractmethod
  957. def get_engine_driver_device_info(self, index, name):
  958. raise NotImplementedError
  959. # Initialize the engine.
  960. # Make sure to call carla_engine_idle() at regular intervals afterwards.
  961. # @param driverName Driver to use
  962. # @param clientName Engine master client name
  963. @abstractmethod
  964. def engine_init(self, driverName, clientName):
  965. raise NotImplementedError
  966. # Close the engine.
  967. # This function always closes the engine even if it returns false.
  968. # In other words, even when something goes wrong when closing the engine it still be closed nonetheless.
  969. @abstractmethod
  970. def engine_close(self):
  971. raise NotImplementedError
  972. # Idle the engine.
  973. # Do not call this if the engine is not running.
  974. @abstractmethod
  975. def engine_idle(self):
  976. raise NotImplementedError
  977. # Check if the engine is running.
  978. @abstractmethod
  979. def is_engine_running(self):
  980. raise NotImplementedError
  981. # Tell the engine it's about to close.
  982. # This is used to prevent the engine thread(s) from reactivating.
  983. @abstractmethod
  984. def set_engine_about_to_close(self):
  985. raise NotImplementedError
  986. # Set the engine callback function.
  987. # @param func Callback function
  988. @abstractmethod
  989. def set_engine_callback(self, func):
  990. raise NotImplementedError
  991. # Set an engine option.
  992. # @param option Option
  993. # @param value Value as number
  994. # @param valueStr Value as string
  995. @abstractmethod
  996. def set_engine_option(self, option, value, valueStr):
  997. raise NotImplementedError
  998. # Set the file callback function.
  999. # @param func Callback function
  1000. # @param ptr Callback pointer
  1001. @abstractmethod
  1002. def set_file_callback(self, func):
  1003. raise NotImplementedError
  1004. # Load a file of any type.
  1005. # This will try to load a generic file as a plugin,
  1006. # either by direct handling (GIG, SF2 and SFZ) or by using an internal plugin (like Audio and MIDI).
  1007. # @see carla_get_supported_file_extensions()
  1008. @abstractmethod
  1009. def load_file(self, filename):
  1010. raise NotImplementedError
  1011. # Load a Carla project file.
  1012. # @note Currently loaded plugins are not removed; call carla_remove_all_plugins() first if needed.
  1013. @abstractmethod
  1014. def load_project(self, filename):
  1015. raise NotImplementedError
  1016. # Save current project to a file.
  1017. @abstractmethod
  1018. def save_project(self, filename):
  1019. raise NotImplementedError
  1020. # Connect two patchbay ports.
  1021. # @param groupIdA Output group
  1022. # @param portIdA Output port
  1023. # @param groupIdB Input group
  1024. # @param portIdB Input port
  1025. # @see ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED
  1026. @abstractmethod
  1027. def patchbay_connect(self, groupIdA, portIdA, groupIdB, portIdB):
  1028. raise NotImplementedError
  1029. # Disconnect two patchbay ports.
  1030. # @param connectionId Connection Id
  1031. # @see ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED
  1032. @abstractmethod
  1033. def patchbay_disconnect(self, connectionId):
  1034. raise NotImplementedError
  1035. # Force the engine to resend all patchbay clients, ports and connections again.
  1036. # @param external Wherever to show external/hardware ports instead of internal ones.
  1037. # Only valid in patchbay engine mode, other modes will ignore this.
  1038. @abstractmethod
  1039. def patchbay_refresh(self, external):
  1040. raise NotImplementedError
  1041. # Start playback of the engine transport.
  1042. @abstractmethod
  1043. def transport_play(self):
  1044. raise NotImplementedError
  1045. # Pause the engine transport.
  1046. @abstractmethod
  1047. def transport_pause(self):
  1048. raise NotImplementedError
  1049. # Relocate the engine transport to a specific frame.
  1050. @abstractmethod
  1051. def transport_relocate(self, frame):
  1052. raise NotImplementedError
  1053. # Get the current transport frame.
  1054. @abstractmethod
  1055. def get_current_transport_frame(self):
  1056. raise NotImplementedError
  1057. # Get the engine transport information.
  1058. @abstractmethod
  1059. def get_transport_info(self):
  1060. raise NotImplementedError
  1061. # Current number of plugins loaded.
  1062. @abstractmethod
  1063. def get_current_plugin_count(self):
  1064. raise NotImplementedError
  1065. # Maximum number of loadable plugins allowed.
  1066. # Returns 0 if engine is not started.
  1067. @abstractmethod
  1068. def get_max_plugin_number(self):
  1069. raise NotImplementedError
  1070. # Add a new plugin.
  1071. # If you don't know the binary type use the BINARY_NATIVE macro.
  1072. # @param btype Binary type
  1073. # @param ptype Plugin type
  1074. # @param filename Filename, if applicable
  1075. # @param name Name of the plugin, can be NULL
  1076. # @param label Plugin label, if applicable
  1077. # @param uniqueId Plugin unique Id, if applicable
  1078. # @param extraPtr Extra pointer, defined per plugin type
  1079. # @param options Initial plugin options
  1080. @abstractmethod
  1081. def add_plugin(self, btype, ptype, filename, name, label, uniqueId, extraPtr, options):
  1082. raise NotImplementedError
  1083. # Remove a plugin.
  1084. # @param pluginId Plugin to remove.
  1085. @abstractmethod
  1086. def remove_plugin(self, pluginId):
  1087. raise NotImplementedError
  1088. # Remove all plugins.
  1089. @abstractmethod
  1090. def remove_all_plugins(self):
  1091. raise NotImplementedError
  1092. # Rename a plugin.
  1093. # Returns the new name, or NULL if the operation failed.
  1094. # @param pluginId Plugin to rename
  1095. # @param newName New plugin name
  1096. @abstractmethod
  1097. def rename_plugin(self, pluginId, newName):
  1098. raise NotImplementedError
  1099. # Clone a plugin.
  1100. # @param pluginId Plugin to clone
  1101. @abstractmethod
  1102. def clone_plugin(self, pluginId):
  1103. raise NotImplementedError
  1104. # Prepare replace of a plugin.
  1105. # The next call to carla_add_plugin() will use this id, replacing the current plugin.
  1106. # @param pluginId Plugin to replace
  1107. # @note This function requires carla_add_plugin() to be called afterwards *as soon as possible*.
  1108. @abstractmethod
  1109. def replace_plugin(self, pluginId):
  1110. raise NotImplementedError
  1111. # Switch two plugins positions.
  1112. # @param pluginIdA Plugin A
  1113. # @param pluginIdB Plugin B
  1114. @abstractmethod
  1115. def switch_plugins(self, pluginIdA, pluginIdB):
  1116. raise NotImplementedError
  1117. # Load a plugin state.
  1118. # @param pluginId Plugin
  1119. # @param filename Path to plugin state
  1120. # @see carla_save_plugin_state()
  1121. @abstractmethod
  1122. def load_plugin_state(self, pluginId, filename):
  1123. raise NotImplementedError
  1124. # Save a plugin state.
  1125. # @param pluginId Plugin
  1126. # @param filename Path to plugin state
  1127. # @see carla_load_plugin_state()
  1128. @abstractmethod
  1129. def save_plugin_state(self, pluginId, filename):
  1130. raise NotImplementedError
  1131. # Get information from a plugin.
  1132. # @param pluginId Plugin
  1133. @abstractmethod
  1134. def get_plugin_info(self, pluginId):
  1135. raise NotImplementedError
  1136. # Get audio port count information from a plugin.
  1137. # @param pluginId Plugin
  1138. @abstractmethod
  1139. def get_audio_port_count_info(self, pluginId):
  1140. raise NotImplementedError
  1141. # Get MIDI port count information from a plugin.
  1142. # @param pluginId Plugin
  1143. @abstractmethod
  1144. def get_midi_port_count_info(self, pluginId):
  1145. raise NotImplementedError
  1146. # Get parameter count information from a plugin.
  1147. # @param pluginId Plugin
  1148. @abstractmethod
  1149. def get_parameter_count_info(self, pluginId):
  1150. raise NotImplementedError
  1151. # Get parameter information from a plugin.
  1152. # @param pluginId Plugin
  1153. # @param parameterId Parameter index
  1154. # @see carla_get_parameter_count()
  1155. @abstractmethod
  1156. def get_parameter_info(self, pluginId, parameterId):
  1157. raise NotImplementedError
  1158. # Get parameter scale point information from a plugin.
  1159. # @param pluginId Plugin
  1160. # @param parameterId Parameter index
  1161. # @param scalePointId Parameter scale-point index
  1162. # @see CarlaParameterInfo::scalePointCount
  1163. @abstractmethod
  1164. def get_parameter_scalepoint_info(self, pluginId, parameterId, scalePointId):
  1165. raise NotImplementedError
  1166. # Get a plugin's parameter data.
  1167. # @param pluginId Plugin
  1168. # @param parameterId Parameter index
  1169. # @see carla_get_parameter_count()
  1170. @abstractmethod
  1171. def get_parameter_data(self, pluginId, parameterId):
  1172. raise NotImplementedError
  1173. # Get a plugin's parameter ranges.
  1174. # @param pluginId Plugin
  1175. # @param parameterId Parameter index
  1176. # @see carla_get_parameter_count()
  1177. @abstractmethod
  1178. def get_parameter_ranges(self, pluginId, parameterId):
  1179. raise NotImplementedError
  1180. # Get a plugin's MIDI program data.
  1181. # @param pluginId Plugin
  1182. # @param midiProgramId MIDI Program index
  1183. # @see carla_get_midi_program_count()
  1184. @abstractmethod
  1185. def get_midi_program_data(self, pluginId, midiProgramId):
  1186. raise NotImplementedError
  1187. # Get a plugin's custom data.
  1188. # @param pluginId Plugin
  1189. # @param customDataId Custom data index
  1190. # @see carla_get_custom_data_count()
  1191. @abstractmethod
  1192. def get_custom_data(self, pluginId, customDataId):
  1193. raise NotImplementedError
  1194. # Get a plugin's chunk data.
  1195. # @param pluginId Plugin
  1196. # @see PLUGIN_OPTION_USE_CHUNKS
  1197. @abstractmethod
  1198. def get_chunk_data(self, pluginId):
  1199. raise NotImplementedError
  1200. # Get how many parameters a plugin has.
  1201. # @param pluginId Plugin
  1202. @abstractmethod
  1203. def get_parameter_count(self, pluginId):
  1204. raise NotImplementedError
  1205. # Get how many programs a plugin has.
  1206. # @param pluginId Plugin
  1207. # @see carla_get_program_name()
  1208. @abstractmethod
  1209. def get_program_count(self, pluginId):
  1210. raise NotImplementedError
  1211. # Get how many MIDI programs a plugin has.
  1212. # @param pluginId Plugin
  1213. # @see carla_get_midi_program_name() and carla_get_midi_program_data()
  1214. @abstractmethod
  1215. def get_midi_program_count(self, pluginId):
  1216. raise NotImplementedError
  1217. # Get how many custom data sets a plugin has.
  1218. # @param pluginId Plugin
  1219. # @see carla_get_custom_data()
  1220. @abstractmethod
  1221. def get_custom_data_count(self, pluginId):
  1222. raise NotImplementedError
  1223. # Get a plugin's parameter text (custom display of internal values).
  1224. # @param pluginId Plugin
  1225. # @param parameterId Parameter index
  1226. # @see PARAMETER_USES_CUSTOM_TEXT
  1227. @abstractmethod
  1228. def get_parameter_text(self, pluginId, parameterId):
  1229. raise NotImplementedError
  1230. # Get a plugin's program name.
  1231. # @param pluginId Plugin
  1232. # @param programId Program index
  1233. # @see carla_get_program_count()
  1234. @abstractmethod
  1235. def get_program_name(self, pluginId, programId):
  1236. raise NotImplementedError
  1237. # Get a plugin's MIDI program name.
  1238. # @param pluginId Plugin
  1239. # @param midiProgramId MIDI Program index
  1240. # @see carla_get_midi_program_count()
  1241. @abstractmethod
  1242. def get_midi_program_name(self, pluginId, midiProgramId):
  1243. raise NotImplementedError
  1244. # Get a plugin's real name.
  1245. # This is the name the plugin uses to identify itself; may not be unique.
  1246. # @param pluginId Plugin
  1247. @abstractmethod
  1248. def get_real_plugin_name(self, pluginId):
  1249. raise NotImplementedError
  1250. # Get a plugin's program index.
  1251. # @param pluginId Plugin
  1252. @abstractmethod
  1253. def get_current_program_index(self, pluginId):
  1254. raise NotImplementedError
  1255. # Get a plugin's midi program index.
  1256. # @param pluginId Plugin
  1257. @abstractmethod
  1258. def get_current_midi_program_index(self, pluginId):
  1259. raise NotImplementedError
  1260. # Get a plugin's default parameter value.
  1261. # @param pluginId Plugin
  1262. # @param parameterId Parameter index
  1263. @abstractmethod
  1264. def get_default_parameter_value(self, pluginId, parameterId):
  1265. raise NotImplementedError
  1266. # Get a plugin's current parameter value.
  1267. # @param pluginId Plugin
  1268. # @param parameterId Parameter index
  1269. @abstractmethod
  1270. def get_current_parameter_value(self, pluginId, parameterId):
  1271. raise NotImplementedError
  1272. # Get a plugin's internal parameter value.
  1273. # @param pluginId Plugin
  1274. # @param parameterId Parameter index, maybe be negative
  1275. # @see InternalParameterIndex
  1276. @abstractmethod
  1277. def get_internal_parameter_value(self, pluginId, parameterId):
  1278. raise NotImplementedError
  1279. # Get a plugin's input peak value.
  1280. # @param pluginId Plugin
  1281. # @param isLeft Wherever to get the left/mono value, otherwise right.
  1282. @abstractmethod
  1283. def get_input_peak_value(self, pluginId, isLeft):
  1284. raise NotImplementedError
  1285. # Get a plugin's output peak value.
  1286. # @param pluginId Plugin
  1287. # @param isLeft Wherever to get the left/mono value, otherwise right.
  1288. @abstractmethod
  1289. def get_output_peak_value(self, pluginId, isLeft):
  1290. raise NotImplementedError
  1291. # Enable a plugin's option.
  1292. # @param pluginId Plugin
  1293. # @param option An option from PluginOptions
  1294. # @param yesNo New enabled state
  1295. @abstractmethod
  1296. def set_option(self, pluginId, option, yesNo):
  1297. raise NotImplementedError
  1298. # Enable or disable a plugin.
  1299. # @param pluginId Plugin
  1300. # @param onOff New active state
  1301. @abstractmethod
  1302. def set_active(self, pluginId, onOff):
  1303. raise NotImplementedError
  1304. # Change a plugin's internal dry/wet.
  1305. # @param pluginId Plugin
  1306. # @param value New dry/wet value
  1307. @abstractmethod
  1308. def set_drywet(self, pluginId, value):
  1309. raise NotImplementedError
  1310. # Change a plugin's internal volume.
  1311. # @param pluginId Plugin
  1312. # @param value New volume
  1313. @abstractmethod
  1314. def set_volume(self, pluginId, value):
  1315. raise NotImplementedError
  1316. # Change a plugin's internal stereo balance, left channel.
  1317. # @param pluginId Plugin
  1318. # @param value New value
  1319. @abstractmethod
  1320. def set_balance_left(self, pluginId, value):
  1321. raise NotImplementedError
  1322. # Change a plugin's internal stereo balance, right channel.
  1323. # @param pluginId Plugin
  1324. # @param value New value
  1325. @abstractmethod
  1326. def set_balance_right(self, pluginId, value):
  1327. raise NotImplementedError
  1328. # Change a plugin's internal mono panning value.
  1329. # @param pluginId Plugin
  1330. # @param value New value
  1331. @abstractmethod
  1332. def set_panning(self, pluginId, value):
  1333. raise NotImplementedError
  1334. # Change a plugin's internal control channel.
  1335. # @param pluginId Plugin
  1336. # @param channel New channel
  1337. @abstractmethod
  1338. def set_ctrl_channel(self, pluginId, channel):
  1339. raise NotImplementedError
  1340. # Change a plugin's parameter value.
  1341. # @param pluginId Plugin
  1342. # @param parameterId Parameter index
  1343. # @param value New value
  1344. @abstractmethod
  1345. def set_parameter_value(self, pluginId, parameterId, value):
  1346. raise NotImplementedError
  1347. # Change a plugin's parameter MIDI cc.
  1348. # @param pluginId Plugin
  1349. # @param parameterId Parameter index
  1350. # @param cc New MIDI cc
  1351. @abstractmethod
  1352. def set_parameter_midi_channel(self, pluginId, parameterId, channel):
  1353. raise NotImplementedError
  1354. # Change a plugin's parameter MIDI channel.
  1355. # @param pluginId Plugin
  1356. # @param parameterId Parameter index
  1357. # @param channel New MIDI channel
  1358. @abstractmethod
  1359. def set_parameter_midi_cc(self, pluginId, parameterId, cc):
  1360. raise NotImplementedError
  1361. # Change a plugin's current program.
  1362. # @param pluginId Plugin
  1363. # @param programId New program
  1364. @abstractmethod
  1365. def set_program(self, pluginId, programId):
  1366. raise NotImplementedError
  1367. # Change a plugin's current MIDI program.
  1368. # @param pluginId Plugin
  1369. # @param midiProgramId New value
  1370. @abstractmethod
  1371. def set_midi_program(self, pluginId, midiProgramId):
  1372. raise NotImplementedError
  1373. # Set a plugin's custom data set.
  1374. # @param pluginId Plugin
  1375. # @param type Type
  1376. # @param key Key
  1377. # @param value New value
  1378. # @see CustomDataTypes and CustomDataKeys
  1379. @abstractmethod
  1380. def set_custom_data(self, pluginId, type_, key, value):
  1381. raise NotImplementedError
  1382. # Set a plugin's chunk data.
  1383. # @param pluginId Plugin
  1384. # @param chunkData New chunk data
  1385. # @see PLUGIN_OPTION_USE_CHUNKS and carla_get_chunk_data()
  1386. @abstractmethod
  1387. def set_chunk_data(self, pluginId, chunkData):
  1388. raise NotImplementedError
  1389. # Tell a plugin to prepare for save.
  1390. # This should be called before saving custom data sets.
  1391. # @param pluginId Plugin
  1392. @abstractmethod
  1393. def prepare_for_save(self, pluginId):
  1394. raise NotImplementedError
  1395. # Reset all plugin's parameters.
  1396. # @param pluginId Plugin
  1397. @abstractmethod
  1398. def reset_parameters(self, pluginId):
  1399. raise NotImplementedError
  1400. # Randomize all plugin's parameters.
  1401. # @param pluginId Plugin
  1402. @abstractmethod
  1403. def randomize_parameters(self, pluginId):
  1404. raise NotImplementedError
  1405. # Send a single note of a plugin.
  1406. # If velocity is 0, note-off is sent; note-on otherwise.
  1407. # @param pluginId Plugin
  1408. # @param channel Note channel
  1409. # @param note Note pitch
  1410. # @param velocity Note velocity
  1411. @abstractmethod
  1412. def send_midi_note(self, pluginId, channel, note, velocity):
  1413. raise NotImplementedError
  1414. # Tell a plugin to show its own custom UI.
  1415. # @param pluginId Plugin
  1416. # @param yesNo New UI state, visible or not
  1417. # @see PLUGIN_HAS_CUSTOM_UI
  1418. @abstractmethod
  1419. def show_custom_ui(self, pluginId, yesNo):
  1420. raise NotImplementedError
  1421. # Get the current engine buffer size.
  1422. @abstractmethod
  1423. def get_buffer_size(self):
  1424. raise NotImplementedError
  1425. # Get the current engine sample rate.
  1426. @abstractmethod
  1427. def get_sample_rate(self):
  1428. raise NotImplementedError
  1429. # Get the last error.
  1430. @abstractmethod
  1431. def get_last_error(self):
  1432. raise NotImplementedError
  1433. # Get the current engine OSC URL (TCP).
  1434. @abstractmethod
  1435. def get_host_osc_url_tcp(self):
  1436. raise NotImplementedError
  1437. # Get the current engine OSC URL (UDP).
  1438. @abstractmethod
  1439. def get_host_osc_url_udp(self):
  1440. raise NotImplementedError
  1441. # ------------------------------------------------------------------------------------------------------------
  1442. # Carla Host object (dummy/null, does nothing)
  1443. class CarlaHostNull(CarlaHostMeta):
  1444. def __init__(self):
  1445. CarlaHostMeta.__init__(self)
  1446. self.fEngineCallback = None
  1447. self.fEngineRunning = False
  1448. def get_engine_driver_count(self):
  1449. return 0
  1450. def get_engine_driver_name(self, index):
  1451. return ""
  1452. def get_engine_driver_device_names(self, index):
  1453. return []
  1454. def get_engine_driver_device_info(self, index, name):
  1455. return PyEngineDriverDeviceInfo
  1456. def engine_init(self, driverName, clientName):
  1457. self.fEngineRunning = True
  1458. if self.fEngineCallback is not None:
  1459. self.fEngineCallback(None, ENGINE_CALLBACK_ENGINE_STARTED, 0, self.processMode, self.transportMode, 0.0, driverName)
  1460. return True
  1461. def engine_close(self):
  1462. self.fEngineRunning = False
  1463. if self.fEngineCallback is not None:
  1464. self.fEngineCallback(None, ENGINE_CALLBACK_ENGINE_STOPPED, 0, 0, 0, 0.0, "")
  1465. return True
  1466. def engine_idle(self):
  1467. return
  1468. def is_engine_running(self):
  1469. return False
  1470. def set_engine_about_to_close(self):
  1471. return
  1472. def set_engine_callback(self, func):
  1473. self.fEngineCallback = func
  1474. def set_engine_option(self, option, value, valueStr):
  1475. return
  1476. def set_file_callback(self, func):
  1477. return
  1478. def load_file(self, filename):
  1479. return False
  1480. def load_project(self, filename):
  1481. return False
  1482. def save_project(self, filename):
  1483. return False
  1484. def patchbay_connect(self, groupIdA, portIdA, groupIdB, portIdB):
  1485. return False
  1486. def patchbay_disconnect(self, connectionId):
  1487. return False
  1488. def patchbay_refresh(self, external):
  1489. return False
  1490. def transport_play(self):
  1491. return
  1492. def transport_pause(self):
  1493. return
  1494. def transport_relocate(self, frame):
  1495. return
  1496. def get_current_transport_frame(self):
  1497. return 0
  1498. def get_transport_info(self):
  1499. return PyCarlaTransportInfo
  1500. def get_current_plugin_count(self):
  1501. return 0
  1502. def get_max_plugin_number(self):
  1503. return 0
  1504. def add_plugin(self, btype, ptype, filename, name, label, uniqueId, extraPtr, options):
  1505. return False
  1506. def remove_plugin(self, pluginId):
  1507. return False
  1508. def remove_all_plugins(self):
  1509. return False
  1510. def rename_plugin(self, pluginId, newName):
  1511. return ""
  1512. def clone_plugin(self, pluginId):
  1513. return False
  1514. def replace_plugin(self, pluginId):
  1515. return False
  1516. def switch_plugins(self, pluginIdA, pluginIdB):
  1517. return False
  1518. def load_plugin_state(self, pluginId, filename):
  1519. return False
  1520. def save_plugin_state(self, pluginId, filename):
  1521. return False
  1522. def get_plugin_info(self, pluginId):
  1523. return PyCarlaPluginInfo
  1524. def get_audio_port_count_info(self, pluginId):
  1525. return PyCarlaPortCountInfo
  1526. def get_midi_port_count_info(self, pluginId):
  1527. return PyCarlaPortCountInfo
  1528. def get_parameter_count_info(self, pluginId):
  1529. return PyCarlaPortCountInfo
  1530. def get_parameter_info(self, pluginId, parameterId):
  1531. return PyCarlaParameterInfo
  1532. def get_parameter_scalepoint_info(self, pluginId, parameterId, scalePointId):
  1533. return PyCarlaScalePointInfo
  1534. def get_parameter_data(self, pluginId, parameterId):
  1535. return PyParameterData
  1536. def get_parameter_ranges(self, pluginId, parameterId):
  1537. return PyParameterRanges
  1538. def get_midi_program_data(self, pluginId, midiProgramId):
  1539. return PyMidiProgramData
  1540. def get_custom_data(self, pluginId, customDataId):
  1541. return PyCustomData
  1542. def get_chunk_data(self, pluginId):
  1543. return ""
  1544. def get_parameter_count(self, pluginId):
  1545. return 0
  1546. def get_program_count(self, pluginId):
  1547. return 0
  1548. def get_midi_program_count(self, pluginId):
  1549. return 0
  1550. def get_custom_data_count(self, pluginId):
  1551. return 0
  1552. def get_parameter_text(self, pluginId, parameterId):
  1553. return ""
  1554. def get_program_name(self, pluginId, programId):
  1555. return ""
  1556. def get_midi_program_name(self, pluginId, midiProgramId):
  1557. return ""
  1558. def get_real_plugin_name(self, pluginId):
  1559. return ""
  1560. def get_current_program_index(self, pluginId):
  1561. return 0
  1562. def get_current_midi_program_index(self, pluginId):
  1563. return 0
  1564. def get_default_parameter_value(self, pluginId, parameterId):
  1565. return 0.0
  1566. def get_current_parameter_value(self, pluginId, parameterId):
  1567. return 0.0
  1568. def get_internal_parameter_value(self, pluginId, parameterId):
  1569. return 0.0
  1570. def get_input_peak_value(self, pluginId, isLeft):
  1571. return 0.0
  1572. def get_output_peak_value(self, pluginId, isLeft):
  1573. return 0.0
  1574. def set_option(self, pluginId, option, yesNo):
  1575. return
  1576. def set_active(self, pluginId, onOff):
  1577. return
  1578. def set_drywet(self, pluginId, value):
  1579. return
  1580. def set_volume(self, pluginId, value):
  1581. return
  1582. def set_balance_left(self, pluginId, value):
  1583. return
  1584. def set_balance_right(self, pluginId, value):
  1585. return
  1586. def set_panning(self, pluginId, value):
  1587. return
  1588. def set_ctrl_channel(self, pluginId, channel):
  1589. return
  1590. def set_parameter_value(self, pluginId, parameterId, value):
  1591. return
  1592. def set_parameter_midi_channel(self, pluginId, parameterId, channel):
  1593. return
  1594. def set_parameter_midi_cc(self, pluginId, parameterId, cc):
  1595. return
  1596. def set_program(self, pluginId, programId):
  1597. return
  1598. def set_midi_program(self, pluginId, midiProgramId):
  1599. return
  1600. def set_custom_data(self, pluginId, type_, key, value):
  1601. return
  1602. def set_chunk_data(self, pluginId, chunkData):
  1603. return
  1604. def prepare_for_save(self, pluginId):
  1605. return
  1606. def reset_parameters(self, pluginId):
  1607. return
  1608. def randomize_parameters(self, pluginId):
  1609. return
  1610. def send_midi_note(self, pluginId, channel, note, velocity):
  1611. return
  1612. def show_custom_ui(self, pluginId, yesNo):
  1613. return
  1614. def get_buffer_size(self):
  1615. return 0
  1616. def get_sample_rate(self):
  1617. return 0.0
  1618. def get_last_error(self):
  1619. return ""
  1620. def get_host_osc_url_tcp(self):
  1621. return ""
  1622. def get_host_osc_url_udp(self):
  1623. return ""
  1624. # ------------------------------------------------------------------------------------------------------------
  1625. # Carla Host object using a DLL
  1626. class CarlaHostDLL(CarlaHostMeta):
  1627. def __init__(self, libName):
  1628. CarlaHostMeta.__init__(self)
  1629. # info about this host object
  1630. self.isPlugin = False
  1631. self.lib = cdll.LoadLibrary(libName)
  1632. self.lib.carla_get_engine_driver_count.argtypes = None
  1633. self.lib.carla_get_engine_driver_count.restype = c_uint
  1634. self.lib.carla_get_engine_driver_name.argtypes = [c_uint]
  1635. self.lib.carla_get_engine_driver_name.restype = c_char_p
  1636. self.lib.carla_get_engine_driver_device_names.argtypes = [c_uint]
  1637. self.lib.carla_get_engine_driver_device_names.restype = POINTER(c_char_p)
  1638. self.lib.carla_get_engine_driver_device_info.argtypes = [c_uint, c_char_p]
  1639. self.lib.carla_get_engine_driver_device_info.restype = POINTER(EngineDriverDeviceInfo)
  1640. self.lib.carla_engine_init.argtypes = [c_char_p, c_char_p]
  1641. self.lib.carla_engine_init.restype = c_bool
  1642. self.lib.carla_engine_close.argtypes = None
  1643. self.lib.carla_engine_close.restype = c_bool
  1644. self.lib.carla_engine_idle.argtypes = None
  1645. self.lib.carla_engine_idle.restype = None
  1646. self.lib.carla_is_engine_running.argtypes = None
  1647. self.lib.carla_is_engine_running.restype = c_bool
  1648. self.lib.carla_set_engine_about_to_close.argtypes = None
  1649. self.lib.carla_set_engine_about_to_close.restype = None
  1650. self.lib.carla_set_engine_callback.argtypes = [EngineCallbackFunc, c_void_p]
  1651. self.lib.carla_set_engine_callback.restype = None
  1652. self.lib.carla_set_engine_option.argtypes = [c_enum, c_int, c_char_p]
  1653. self.lib.carla_set_engine_option.restype = None
  1654. self.lib.carla_set_file_callback.argtypes = [FileCallbackFunc, c_void_p]
  1655. self.lib.carla_set_file_callback.restype = None
  1656. self.lib.carla_load_file.argtypes = [c_char_p]
  1657. self.lib.carla_load_file.restype = c_bool
  1658. self.lib.carla_load_project.argtypes = [c_char_p]
  1659. self.lib.carla_load_project.restype = c_bool
  1660. self.lib.carla_save_project.argtypes = [c_char_p]
  1661. self.lib.carla_save_project.restype = c_bool
  1662. self.lib.carla_patchbay_connect.argtypes = [c_uint, c_uint, c_uint, c_uint]
  1663. self.lib.carla_patchbay_connect.restype = c_bool
  1664. self.lib.carla_patchbay_disconnect.argtypes = [c_uint]
  1665. self.lib.carla_patchbay_disconnect.restype = c_bool
  1666. self.lib.carla_patchbay_refresh.argtypes = [c_bool]
  1667. self.lib.carla_patchbay_refresh.restype = c_bool
  1668. self.lib.carla_transport_play.argtypes = None
  1669. self.lib.carla_transport_play.restype = None
  1670. self.lib.carla_transport_pause.argtypes = None
  1671. self.lib.carla_transport_pause.restype = None
  1672. self.lib.carla_transport_relocate.argtypes = [c_uint64]
  1673. self.lib.carla_transport_relocate.restype = None
  1674. self.lib.carla_get_current_transport_frame.argtypes = None
  1675. self.lib.carla_get_current_transport_frame.restype = c_uint64
  1676. self.lib.carla_get_transport_info.argtypes = None
  1677. self.lib.carla_get_transport_info.restype = POINTER(CarlaTransportInfo)
  1678. self.lib.carla_get_current_plugin_count.argtypes = None
  1679. self.lib.carla_get_current_plugin_count.restype = c_uint32
  1680. self.lib.carla_get_max_plugin_number.argtypes = None
  1681. self.lib.carla_get_max_plugin_number.restype = c_uint32
  1682. self.lib.carla_add_plugin.argtypes = [c_enum, c_enum, c_char_p, c_char_p, c_char_p, c_int64, c_void_p, c_uint]
  1683. self.lib.carla_add_plugin.restype = c_bool
  1684. self.lib.carla_remove_plugin.argtypes = [c_uint]
  1685. self.lib.carla_remove_plugin.restype = c_bool
  1686. self.lib.carla_remove_all_plugins.argtypes = None
  1687. self.lib.carla_remove_all_plugins.restype = c_bool
  1688. self.lib.carla_rename_plugin.argtypes = [c_uint, c_char_p]
  1689. self.lib.carla_rename_plugin.restype = c_char_p
  1690. self.lib.carla_clone_plugin.argtypes = [c_uint]
  1691. self.lib.carla_clone_plugin.restype = c_bool
  1692. self.lib.carla_replace_plugin.argtypes = [c_uint]
  1693. self.lib.carla_replace_plugin.restype = c_bool
  1694. self.lib.carla_switch_plugins.argtypes = [c_uint, c_uint]
  1695. self.lib.carla_switch_plugins.restype = c_bool
  1696. self.lib.carla_load_plugin_state.argtypes = [c_uint, c_char_p]
  1697. self.lib.carla_load_plugin_state.restype = c_bool
  1698. self.lib.carla_save_plugin_state.argtypes = [c_uint, c_char_p]
  1699. self.lib.carla_save_plugin_state.restype = c_bool
  1700. self.lib.carla_get_plugin_info.argtypes = [c_uint]
  1701. self.lib.carla_get_plugin_info.restype = POINTER(CarlaPluginInfo)
  1702. self.lib.carla_get_audio_port_count_info.argtypes = [c_uint]
  1703. self.lib.carla_get_audio_port_count_info.restype = POINTER(CarlaPortCountInfo)
  1704. self.lib.carla_get_midi_port_count_info.argtypes = [c_uint]
  1705. self.lib.carla_get_midi_port_count_info.restype = POINTER(CarlaPortCountInfo)
  1706. self.lib.carla_get_parameter_count_info.argtypes = [c_uint]
  1707. self.lib.carla_get_parameter_count_info.restype = POINTER(CarlaPortCountInfo)
  1708. self.lib.carla_get_parameter_info.argtypes = [c_uint, c_uint32]
  1709. self.lib.carla_get_parameter_info.restype = POINTER(CarlaParameterInfo)
  1710. self.lib.carla_get_parameter_scalepoint_info.argtypes = [c_uint, c_uint32, c_uint32]
  1711. self.lib.carla_get_parameter_scalepoint_info.restype = POINTER(CarlaScalePointInfo)
  1712. self.lib.carla_get_parameter_data.argtypes = [c_uint, c_uint32]
  1713. self.lib.carla_get_parameter_data.restype = POINTER(ParameterData)
  1714. self.lib.carla_get_parameter_ranges.argtypes = [c_uint, c_uint32]
  1715. self.lib.carla_get_parameter_ranges.restype = POINTER(ParameterRanges)
  1716. self.lib.carla_get_midi_program_data.argtypes = [c_uint, c_uint32]
  1717. self.lib.carla_get_midi_program_data.restype = POINTER(MidiProgramData)
  1718. self.lib.carla_get_custom_data.argtypes = [c_uint, c_uint32]
  1719. self.lib.carla_get_custom_data.restype = POINTER(CustomData)
  1720. self.lib.carla_get_chunk_data.argtypes = [c_uint]
  1721. self.lib.carla_get_chunk_data.restype = c_char_p
  1722. self.lib.carla_get_parameter_count.argtypes = [c_uint]
  1723. self.lib.carla_get_parameter_count.restype = c_uint32
  1724. self.lib.carla_get_program_count.argtypes = [c_uint]
  1725. self.lib.carla_get_program_count.restype = c_uint32
  1726. self.lib.carla_get_midi_program_count.argtypes = [c_uint]
  1727. self.lib.carla_get_midi_program_count.restype = c_uint32
  1728. self.lib.carla_get_custom_data_count.argtypes = [c_uint]
  1729. self.lib.carla_get_custom_data_count.restype = c_uint32
  1730. self.lib.carla_get_parameter_text.argtypes = [c_uint, c_uint32]
  1731. self.lib.carla_get_parameter_text.restype = c_char_p
  1732. self.lib.carla_get_program_name.argtypes = [c_uint, c_uint32]
  1733. self.lib.carla_get_program_name.restype = c_char_p
  1734. self.lib.carla_get_midi_program_name.argtypes = [c_uint, c_uint32]
  1735. self.lib.carla_get_midi_program_name.restype = c_char_p
  1736. self.lib.carla_get_real_plugin_name.argtypes = [c_uint]
  1737. self.lib.carla_get_real_plugin_name.restype = c_char_p
  1738. self.lib.carla_get_current_program_index.argtypes = [c_uint]
  1739. self.lib.carla_get_current_program_index.restype = c_int32
  1740. self.lib.carla_get_current_midi_program_index.argtypes = [c_uint]
  1741. self.lib.carla_get_current_midi_program_index.restype = c_int32
  1742. self.lib.carla_get_default_parameter_value.argtypes = [c_uint, c_uint32]
  1743. self.lib.carla_get_default_parameter_value.restype = c_float
  1744. self.lib.carla_get_current_parameter_value.argtypes = [c_uint, c_uint32]
  1745. self.lib.carla_get_current_parameter_value.restype = c_float
  1746. self.lib.carla_get_internal_parameter_value.argtypes = [c_uint, c_int32]
  1747. self.lib.carla_get_internal_parameter_value.restype = c_float
  1748. self.lib.carla_get_input_peak_value.argtypes = [c_uint, c_bool]
  1749. self.lib.carla_get_input_peak_value.restype = c_float
  1750. self.lib.carla_get_output_peak_value.argtypes = [c_uint, c_bool]
  1751. self.lib.carla_get_output_peak_value.restype = c_float
  1752. self.lib.carla_set_option.argtypes = [c_uint, c_uint, c_bool]
  1753. self.lib.carla_set_option.restype = None
  1754. self.lib.carla_set_active.argtypes = [c_uint, c_bool]
  1755. self.lib.carla_set_active.restype = None
  1756. self.lib.carla_set_drywet.argtypes = [c_uint, c_float]
  1757. self.lib.carla_set_drywet.restype = None
  1758. self.lib.carla_set_volume.argtypes = [c_uint, c_float]
  1759. self.lib.carla_set_volume.restype = None
  1760. self.lib.carla_set_balance_left.argtypes = [c_uint, c_float]
  1761. self.lib.carla_set_balance_left.restype = None
  1762. self.lib.carla_set_balance_right.argtypes = [c_uint, c_float]
  1763. self.lib.carla_set_balance_right.restype = None
  1764. self.lib.carla_set_panning.argtypes = [c_uint, c_float]
  1765. self.lib.carla_set_panning.restype = None
  1766. self.lib.carla_set_ctrl_channel.argtypes = [c_uint, c_int8]
  1767. self.lib.carla_set_ctrl_channel.restype = None
  1768. self.lib.carla_set_parameter_value.argtypes = [c_uint, c_uint32, c_float]
  1769. self.lib.carla_set_parameter_value.restype = None
  1770. self.lib.carla_set_parameter_midi_channel.argtypes = [c_uint, c_uint32, c_uint8]
  1771. self.lib.carla_set_parameter_midi_channel.restype = None
  1772. self.lib.carla_set_parameter_midi_cc.argtypes = [c_uint, c_uint32, c_int16]
  1773. self.lib.carla_set_parameter_midi_cc.restype = None
  1774. self.lib.carla_set_program.argtypes = [c_uint, c_uint32]
  1775. self.lib.carla_set_program.restype = None
  1776. self.lib.carla_set_midi_program.argtypes = [c_uint, c_uint32]
  1777. self.lib.carla_set_midi_program.restype = None
  1778. self.lib.carla_set_custom_data.argtypes = [c_uint, c_char_p, c_char_p, c_char_p]
  1779. self.lib.carla_set_custom_data.restype = None
  1780. self.lib.carla_set_chunk_data.argtypes = [c_uint, c_char_p]
  1781. self.lib.carla_set_chunk_data.restype = None
  1782. self.lib.carla_prepare_for_save.argtypes = [c_uint]
  1783. self.lib.carla_prepare_for_save.restype = None
  1784. self.lib.carla_reset_parameters.argtypes = [c_uint]
  1785. self.lib.carla_reset_parameters.restype = None
  1786. self.lib.carla_randomize_parameters.argtypes = [c_uint]
  1787. self.lib.carla_randomize_parameters.restype = None
  1788. self.lib.carla_send_midi_note.argtypes = [c_uint, c_uint8, c_uint8, c_uint8]
  1789. self.lib.carla_send_midi_note.restype = None
  1790. self.lib.carla_show_custom_ui.argtypes = [c_uint, c_bool]
  1791. self.lib.carla_show_custom_ui.restype = None
  1792. self.lib.carla_get_buffer_size.argtypes = None
  1793. self.lib.carla_get_buffer_size.restype = c_uint32
  1794. self.lib.carla_get_sample_rate.argtypes = None
  1795. self.lib.carla_get_sample_rate.restype = c_double
  1796. self.lib.carla_get_last_error.argtypes = None
  1797. self.lib.carla_get_last_error.restype = c_char_p
  1798. self.lib.carla_get_host_osc_url_tcp.argtypes = None
  1799. self.lib.carla_get_host_osc_url_tcp.restype = c_char_p
  1800. self.lib.carla_get_host_osc_url_udp.argtypes = None
  1801. self.lib.carla_get_host_osc_url_udp.restype = c_char_p
  1802. self.lib.carla_nsm_init.argtypes = [c_int, c_char_p]
  1803. self.lib.carla_nsm_init.restype = c_bool
  1804. self.lib.carla_nsm_ready.argtypes = [c_int]
  1805. self.lib.carla_nsm_ready.restype = None
  1806. # --------------------------------------------------------------------------------------------------------
  1807. def get_engine_driver_count(self):
  1808. return int(self.lib.carla_get_engine_driver_count())
  1809. def get_engine_driver_name(self, index):
  1810. return charPtrToString(self.lib.carla_get_engine_driver_name(index))
  1811. def get_engine_driver_device_names(self, index):
  1812. return charPtrPtrToStringList(self.lib.carla_get_engine_driver_device_names(index))
  1813. def get_engine_driver_device_info(self, index, name):
  1814. return structToDict(self.lib.carla_get_engine_driver_device_info(index, name.encode("utf-8")).contents)
  1815. def engine_init(self, driverName, clientName):
  1816. return bool(self.lib.carla_engine_init(driverName.encode("utf-8"), clientName.encode("utf-8")))
  1817. def engine_close(self):
  1818. return bool(self.lib.carla_engine_close())
  1819. def engine_idle(self):
  1820. self.lib.carla_engine_idle()
  1821. def is_engine_running(self):
  1822. return bool(self.lib.carla_is_engine_running())
  1823. def set_engine_about_to_close(self):
  1824. self.lib.carla_set_engine_about_to_close()
  1825. def set_engine_callback(self, func):
  1826. self._engineCallback = EngineCallbackFunc(func)
  1827. self.lib.carla_set_engine_callback(self._engineCallback, None)
  1828. def set_engine_option(self, option, value, valueStr):
  1829. self.lib.carla_set_engine_option(option, value, valueStr.encode("utf-8"))
  1830. def set_file_callback(self, func):
  1831. self._fileCallback = FileCallbackFunc(func)
  1832. self.lib.carla_set_file_callback(self._fileCallback, None)
  1833. def load_file(self, filename):
  1834. return bool(self.lib.carla_load_file(filename.encode("utf-8")))
  1835. def load_project(self, filename):
  1836. return bool(self.lib.carla_load_project(filename.encode("utf-8")))
  1837. def save_project(self, filename):
  1838. return bool(self.lib.carla_save_project(filename.encode("utf-8")))
  1839. def patchbay_connect(self, groupIdA, portIdA, groupIdB, portIdB):
  1840. return bool(self.lib.carla_patchbay_connect(groupIdA, portIdA, groupIdB, portIdB))
  1841. def patchbay_disconnect(self, connectionId):
  1842. return bool(self.lib.carla_patchbay_disconnect(connectionId))
  1843. def patchbay_refresh(self, external):
  1844. return bool(self.lib.carla_patchbay_refresh(external))
  1845. def transport_play(self):
  1846. self.lib.carla_transport_play()
  1847. def transport_pause(self):
  1848. self.lib.carla_transport_pause()
  1849. def transport_relocate(self, frame):
  1850. self.lib.carla_transport_relocate(frame)
  1851. def get_current_transport_frame(self):
  1852. return int(self.lib.carla_get_current_transport_frame())
  1853. def get_transport_info(self):
  1854. return structToDict(self.lib.carla_get_transport_info().contents)
  1855. def get_current_plugin_count(self):
  1856. return int(self.lib.carla_get_current_plugin_count())
  1857. def get_max_plugin_number(self):
  1858. return int(self.lib.carla_get_max_plugin_number())
  1859. def add_plugin(self, btype, ptype, filename, name, label, uniqueId, extraPtr, options):
  1860. cfilename = filename.encode("utf-8") if filename else None
  1861. cname = name.encode("utf-8") if name else None
  1862. clabel = label.encode("utf-8") if label else None
  1863. return bool(self.lib.carla_add_plugin(btype, ptype, cfilename, cname, clabel, uniqueId, cast(extraPtr, c_void_p), options))
  1864. def remove_plugin(self, pluginId):
  1865. return bool(self.lib.carla_remove_plugin(pluginId))
  1866. def remove_all_plugins(self):
  1867. return bool(self.lib.carla_remove_all_plugins())
  1868. def rename_plugin(self, pluginId, newName):
  1869. return charPtrToString(self.lib.carla_rename_plugin(pluginId, newName.encode("utf-8")))
  1870. def clone_plugin(self, pluginId):
  1871. return bool(self.lib.carla_clone_plugin(pluginId))
  1872. def replace_plugin(self, pluginId):
  1873. return bool(self.lib.carla_replace_plugin(pluginId))
  1874. def switch_plugins(self, pluginIdA, pluginIdB):
  1875. return bool(self.lib.carla_switch_plugins(pluginIdA, pluginIdB))
  1876. def load_plugin_state(self, pluginId, filename):
  1877. return bool(self.lib.carla_load_plugin_state(pluginId, filename.encode("utf-8")))
  1878. def save_plugin_state(self, pluginId, filename):
  1879. return bool(self.lib.carla_save_plugin_state(pluginId, filename.encode("utf-8")))
  1880. def get_plugin_info(self, pluginId):
  1881. return structToDict(self.lib.carla_get_plugin_info(pluginId).contents)
  1882. def get_audio_port_count_info(self, pluginId):
  1883. return structToDict(self.lib.carla_get_audio_port_count_info(pluginId).contents)
  1884. def get_midi_port_count_info(self, pluginId):
  1885. return structToDict(self.lib.carla_get_midi_port_count_info(pluginId).contents)
  1886. def get_parameter_count_info(self, pluginId):
  1887. return structToDict(self.lib.carla_get_parameter_count_info(pluginId).contents)
  1888. def get_parameter_info(self, pluginId, parameterId):
  1889. return structToDict(self.lib.carla_get_parameter_info(pluginId, parameterId).contents)
  1890. def get_parameter_scalepoint_info(self, pluginId, parameterId, scalePointId):
  1891. return structToDict(self.lib.carla_get_parameter_scalepoint_info(pluginId, parameterId, scalePointId).contents)
  1892. def get_parameter_data(self, pluginId, parameterId):
  1893. return structToDict(self.lib.carla_get_parameter_data(pluginId, parameterId).contents)
  1894. def get_parameter_ranges(self, pluginId, parameterId):
  1895. return structToDict(self.lib.carla_get_parameter_ranges(pluginId, parameterId).contents)
  1896. def get_midi_program_data(self, pluginId, midiProgramId):
  1897. return structToDict(self.lib.carla_get_midi_program_data(pluginId, midiProgramId).contents)
  1898. def get_custom_data(self, pluginId, customDataId):
  1899. return structToDict(self.lib.carla_get_custom_data(pluginId, customDataId).contents)
  1900. def get_chunk_data(self, pluginId):
  1901. return charPtrToString(self.lib.carla_get_chunk_data(pluginId))
  1902. def get_parameter_count(self, pluginId):
  1903. return int(self.lib.carla_get_parameter_count(pluginId))
  1904. def get_program_count(self, pluginId):
  1905. return int(self.lib.carla_get_program_count(pluginId))
  1906. def get_midi_program_count(self, pluginId):
  1907. return int(self.lib.carla_get_midi_program_count(pluginId))
  1908. def get_custom_data_count(self, pluginId):
  1909. return int(self.lib.carla_get_custom_data_count(pluginId))
  1910. def get_parameter_text(self, pluginId, parameterId):
  1911. return charPtrToString(self.lib.carla_get_parameter_text(pluginId, parameterId))
  1912. def get_program_name(self, pluginId, programId):
  1913. return charPtrToString(self.lib.carla_get_program_name(pluginId, programId))
  1914. def get_midi_program_name(self, pluginId, midiProgramId):
  1915. return charPtrToString(self.lib.carla_get_midi_program_name(pluginId, midiProgramId))
  1916. def get_real_plugin_name(self, pluginId):
  1917. return charPtrToString(self.lib.carla_get_real_plugin_name(pluginId))
  1918. def get_current_program_index(self, pluginId):
  1919. return int(self.lib.carla_get_current_program_index(pluginId))
  1920. def get_current_midi_program_index(self, pluginId):
  1921. return int(self.lib.carla_get_current_midi_program_index(pluginId))
  1922. def get_default_parameter_value(self, pluginId, parameterId):
  1923. return float(self.lib.carla_get_default_parameter_value(pluginId, parameterId))
  1924. def get_current_parameter_value(self, pluginId, parameterId):
  1925. return float(self.lib.carla_get_current_parameter_value(pluginId, parameterId))
  1926. def get_internal_parameter_value(self, pluginId, parameterId):
  1927. return float(self.lib.carla_get_internal_parameter_value(pluginId, parameterId))
  1928. def get_input_peak_value(self, pluginId, isLeft):
  1929. return float(self.lib.carla_get_input_peak_value(pluginId, isLeft))
  1930. def get_output_peak_value(self, pluginId, isLeft):
  1931. return float(self.lib.carla_get_output_peak_value(pluginId, isLeft))
  1932. def set_option(self, pluginId, option, yesNo):
  1933. self.lib.carla_set_option(pluginId, option, yesNo)
  1934. def set_active(self, pluginId, onOff):
  1935. self.lib.carla_set_active(pluginId, onOff)
  1936. def set_drywet(self, pluginId, value):
  1937. self.lib.carla_set_drywet(pluginId, value)
  1938. def set_volume(self, pluginId, value):
  1939. self.lib.carla_set_volume(pluginId, value)
  1940. def set_balance_left(self, pluginId, value):
  1941. self.lib.carla_set_balance_left(pluginId, value)
  1942. def set_balance_right(self, pluginId, value):
  1943. self.lib.carla_set_balance_right(pluginId, value)
  1944. def set_panning(self, pluginId, value):
  1945. self.lib.carla_set_panning(pluginId, value)
  1946. def set_ctrl_channel(self, pluginId, channel):
  1947. self.lib.carla_set_ctrl_channel(pluginId, channel)
  1948. def set_parameter_value(self, pluginId, parameterId, value):
  1949. self.lib.carla_set_parameter_value(pluginId, parameterId, value)
  1950. def set_parameter_midi_channel(self, pluginId, parameterId, channel):
  1951. self.lib.carla_set_parameter_midi_channel(pluginId, parameterId, channel)
  1952. def set_parameter_midi_cc(self, pluginId, parameterId, cc):
  1953. self.lib.carla_set_parameter_midi_cc(pluginId, parameterId, cc)
  1954. def set_program(self, pluginId, programId):
  1955. self.lib.carla_set_program(pluginId, programId)
  1956. def set_midi_program(self, pluginId, midiProgramId):
  1957. self.lib.carla_set_midi_program(pluginId, midiProgramId)
  1958. def set_custom_data(self, pluginId, type_, key, value):
  1959. self.lib.carla_set_custom_data(pluginId, type_.encode("utf-8"), key.encode("utf-8"), value.encode("utf-8"))
  1960. def set_chunk_data(self, pluginId, chunkData):
  1961. self.lib.carla_set_chunk_data(pluginId, chunkData.encode("utf-8"))
  1962. def prepare_for_save(self, pluginId):
  1963. self.lib.carla_prepare_for_save(pluginId)
  1964. def reset_parameters(self, pluginId):
  1965. self.lib.carla_reset_parameters(pluginId)
  1966. def randomize_parameters(self, pluginId):
  1967. self.lib.carla_randomize_parameters(pluginId)
  1968. def send_midi_note(self, pluginId, channel, note, velocity):
  1969. self.lib.carla_send_midi_note(pluginId, channel, note, velocity)
  1970. def show_custom_ui(self, pluginId, yesNo):
  1971. self.lib.carla_show_custom_ui(pluginId, yesNo)
  1972. def get_buffer_size(self):
  1973. return int(self.lib.carla_get_buffer_size())
  1974. def get_sample_rate(self):
  1975. return float(self.lib.carla_get_sample_rate())
  1976. def get_last_error(self):
  1977. return charPtrToString(self.lib.carla_get_last_error())
  1978. def get_host_osc_url_tcp(self):
  1979. return charPtrToString(self.lib.carla_get_host_osc_url_tcp())
  1980. def get_host_osc_url_udp(self):
  1981. return charPtrToString(self.lib.carla_get_host_osc_url_udp())
  1982. def nsm_init(self, pid, executableName):
  1983. return bool(self.lib.carla_nsm_init(pid, executableName.encode("utf-8")))
  1984. def nsm_ready(self, action):
  1985. self.lib.carla_nsm_ready(action)
  1986. # ------------------------------------------------------------------------------------------------------------
  1987. # Helper object for CarlaHostPlugin
  1988. class PluginStoreInfo(object):
  1989. __slots__ = [
  1990. 'pluginInfo',
  1991. 'pluginRealName',
  1992. 'internalValues',
  1993. 'audioCountInfo',
  1994. 'midiCountInfo',
  1995. 'parameterCount',
  1996. 'parameterCountInfo',
  1997. 'parameterInfo',
  1998. 'parameterData',
  1999. 'parameterRanges',
  2000. 'parameterValues',
  2001. 'programCount',
  2002. 'programCurrent',
  2003. 'programNames',
  2004. 'midiProgramCount',
  2005. 'midiProgramCurrent',
  2006. 'midiProgramData',
  2007. 'customDataCount',
  2008. 'customData',
  2009. 'peaks'
  2010. ]
  2011. # ------------------------------------------------------------------------------------------------------------
  2012. # Carla Host object for plugins (using pipes)
  2013. class CarlaHostPlugin(CarlaHostMeta):
  2014. #class CarlaHostPlugin(CarlaHostMeta, metaclass=ABCMeta):
  2015. def __init__(self):
  2016. CarlaHostMeta.__init__(self)
  2017. # info about this host object
  2018. self.isPlugin = True
  2019. self.processModeForced = True
  2020. # text data to return when requested
  2021. self.fMaxPluginNumber = 0
  2022. self.fLastError = ""
  2023. # plugin info
  2024. self.fPluginsInfo = []
  2025. # transport info
  2026. self.fTransportInfo = {
  2027. "playing": False,
  2028. "frame": 0,
  2029. "bar": 0,
  2030. "beat": 0,
  2031. "tick": 0,
  2032. "bpm": 0.0
  2033. }
  2034. # some other vars
  2035. self.fBufferSize = 0
  2036. self.fSampleRate = 0.0
  2037. # --------------------------------------------------------------------------------------------------------
  2038. # Needs to be reimplemented
  2039. @abstractmethod
  2040. def sendMsg(self, lines):
  2041. raise NotImplementedError
  2042. # internal, sets error if sendMsg failed
  2043. def sendMsgAndSetError(self, lines):
  2044. if self.sendMsg(lines):
  2045. return True
  2046. self.fLastError = "Communication error with backend"
  2047. return False
  2048. # --------------------------------------------------------------------------------------------------------
  2049. def get_engine_driver_count(self):
  2050. return 1
  2051. def get_engine_driver_name(self, index):
  2052. return "Plugin"
  2053. def get_engine_driver_device_names(self, index):
  2054. return []
  2055. def get_engine_driver_device_info(self, index, name):
  2056. return PyEngineDriverDeviceInfo
  2057. def set_engine_callback(self, func):
  2058. return # TODO
  2059. def set_engine_option(self, option, value, valueStr):
  2060. self.sendMsg(["set_engine_option", option, int(value), valueStr])
  2061. def set_file_callback(self, func):
  2062. return # TODO
  2063. def load_file(self, filename):
  2064. return self.sendMsgAndSetError(["load_file", filename])
  2065. def load_project(self, filename):
  2066. return self.sendMsgAndSetError(["load_project", filename])
  2067. def save_project(self, filename):
  2068. return self.sendMsgAndSetError(["save_project", filename])
  2069. def patchbay_connect(self, groupIdA, portIdA, groupIdB, portIdB):
  2070. return self.sendMsgAndSetError(["patchbay_connect", groupIdA, portIdA, groupIdB, portIdB])
  2071. def patchbay_disconnect(self, connectionId):
  2072. return self.sendMsgAndSetError(["patchbay_disconnect", connectionId])
  2073. def patchbay_refresh(self, external):
  2074. # don't send external param, never used in plugins
  2075. return self.sendMsgAndSetError(["patchbay_refresh"])
  2076. def transport_play(self):
  2077. self.sendMsg(["transport_play"])
  2078. def transport_pause(self):
  2079. self.sendMsg(["transport_pause"])
  2080. def transport_relocate(self, frame):
  2081. self.sendMsg(["transport_relocate"])
  2082. def get_current_transport_frame(self):
  2083. return self.fTransportInfo['frame']
  2084. def get_transport_info(self):
  2085. return self.fTransportInfo
  2086. def get_current_plugin_count(self):
  2087. return len(self.fPluginsInfo)
  2088. def get_max_plugin_number(self):
  2089. return self.fMaxPluginNumber
  2090. def add_plugin(self, btype, ptype, filename, name, label, uniqueId, extraPtr, options):
  2091. return self.sendMsgAndSetError(["add_plugin", btype, ptype, filename, name, label, uniqueId, options])
  2092. def remove_plugin(self, pluginId):
  2093. return self.sendMsgAndSetError(["remove_plugin", pluginId])
  2094. def remove_all_plugins(self):
  2095. return self.sendMsgAndSetError(["remove_all_plugins"])
  2096. def rename_plugin(self, pluginId, newName):
  2097. if self.sendMsg(["rename_plugin", pluginId, newName]):
  2098. return newName
  2099. self.fLastError = "Communication error with backend"
  2100. return ""
  2101. def clone_plugin(self, pluginId):
  2102. return self.sendMsgAndSetError(["clone_plugin", pluginId])
  2103. def replace_plugin(self, pluginId):
  2104. return self.sendMsgAndSetError(["replace_plugin", pluginId])
  2105. def switch_plugins(self, pluginIdA, pluginIdB):
  2106. return self.sendMsgAndSetError(["switch_plugins", pluginIdA, pluginIdB])
  2107. def load_plugin_state(self, pluginId, filename):
  2108. return self.sendMsgAndSetError(["load_plugin_state", pluginId, filename])
  2109. def save_plugin_state(self, pluginId, filename):
  2110. return self.sendMsgAndSetError(["save_plugin_state", pluginId, filename])
  2111. def get_plugin_info(self, pluginId):
  2112. return self.fPluginsInfo[pluginId].pluginInfo
  2113. def get_audio_port_count_info(self, pluginId):
  2114. return self.fPluginsInfo[pluginId].audioCountInfo
  2115. def get_midi_port_count_info(self, pluginId):
  2116. return self.fPluginsInfo[pluginId].midiCountInfo
  2117. def get_parameter_count_info(self, pluginId):
  2118. return self.fPluginsInfo[pluginId].parameterCountInfo
  2119. def get_parameter_info(self, pluginId, parameterId):
  2120. return self.fPluginsInfo[pluginId].parameterInfo[parameterId]
  2121. def get_parameter_scalepoint_info(self, pluginId, parameterId, scalePointId):
  2122. return PyCarlaScalePointInfo
  2123. def get_parameter_data(self, pluginId, parameterId):
  2124. return self.fPluginsInfo[pluginId].parameterData[parameterId]
  2125. def get_parameter_ranges(self, pluginId, parameterId):
  2126. return self.fPluginsInfo[pluginId].parameterRanges[parameterId]
  2127. def get_midi_program_data(self, pluginId, midiProgramId):
  2128. return self.fPluginsInfo[pluginId].midiProgramData[midiProgramId]
  2129. def get_custom_data(self, pluginId, customDataId):
  2130. return self.fPluginsInfo[pluginId].customData[customDataId]
  2131. def get_chunk_data(self, pluginId):
  2132. return ""
  2133. def get_parameter_count(self, pluginId):
  2134. return self.fPluginsInfo[pluginId].parameterCount
  2135. def get_program_count(self, pluginId):
  2136. return self.fPluginsInfo[pluginId].programCount
  2137. def get_midi_program_count(self, pluginId):
  2138. return self.fPluginsInfo[pluginId].midiProgramCount
  2139. def get_custom_data_count(self, pluginId):
  2140. return self.fPluginsInfo[pluginId].customDataCount
  2141. def get_parameter_text(self, pluginId, parameterId):
  2142. return ""
  2143. def get_program_name(self, pluginId, programId):
  2144. return self.fPluginsInfo[pluginId].programNames[programId]
  2145. def get_midi_program_name(self, pluginId, midiProgramId):
  2146. return self.fPluginsInfo[pluginId].midiProgramData[midiProgramId]['label']
  2147. def get_real_plugin_name(self, pluginId):
  2148. return self.fPluginsInfo[pluginId].pluginRealName
  2149. def get_current_program_index(self, pluginId):
  2150. return self.fPluginsInfo[pluginId].programCurrent
  2151. def get_current_midi_program_index(self, pluginId):
  2152. return self.fPluginsInfo[pluginId].midiProgramCurrent
  2153. def get_default_parameter_value(self, pluginId, parameterId):
  2154. return self.fPluginsInfo[pluginId].parameterRanges[parameterId]['def']
  2155. def get_current_parameter_value(self, pluginId, parameterId):
  2156. return self.fPluginsInfo[pluginId].parameterValues[parameterId]
  2157. def get_internal_parameter_value(self, pluginId, parameterId):
  2158. if parameterId == PARAMETER_NULL or parameterId <= PARAMETER_MAX:
  2159. return 0.0
  2160. if parameterId < 0:
  2161. return self.fPluginsInfo[pluginId].internalValues[abs(parameterId)-2]
  2162. return self.fPluginsInfo[pluginId].parameterValues[parameterId]
  2163. def get_input_peak_value(self, pluginId, isLeft):
  2164. return self.fPluginsInfo[pluginId].peaks[0 if isLeft else 1]
  2165. def get_output_peak_value(self, pluginId, isLeft):
  2166. return self.fPluginsInfo[pluginId].peaks[2 if isLeft else 3]
  2167. def set_option(self, pluginId, option, yesNo):
  2168. self.sendMsg(["set_option", pluginId, option, yesNo])
  2169. def set_active(self, pluginId, onOff):
  2170. self.sendMsg(["set_active", pluginId, onOff])
  2171. self.fPluginsInfo[pluginId].internalValues[0] = 1.0 if onOff else 0.0
  2172. def set_drywet(self, pluginId, value):
  2173. self.sendMsg(["set_drywet", pluginId, value])
  2174. self.fPluginsInfo[pluginId].internalValues[1] = value
  2175. def set_volume(self, pluginId, value):
  2176. self.sendMsg(["set_volume", pluginId, value])
  2177. self.fPluginsInfo[pluginId].internalValues[2] = value
  2178. def set_balance_left(self, pluginId, value):
  2179. self.sendMsg(["set_balance_left", pluginId, value])
  2180. self.fPluginsInfo[pluginId].internalValues[3] = value
  2181. def set_balance_right(self, pluginId, value):
  2182. self.sendMsg(["set_balance_right", pluginId, value])
  2183. self.fPluginsInfo[pluginId].internalValues[4] = value
  2184. def set_panning(self, pluginId, value):
  2185. self.sendMsg(["set_panning", pluginId, value])
  2186. self.fPluginsInfo[pluginId].internalValues[5] = value
  2187. def set_ctrl_channel(self, pluginId, channel):
  2188. self.sendMsg(["set_ctrl_channel", pluginId, channel])
  2189. self.fPluginsInfo[pluginId].internalValues[6] = float(channel)
  2190. def set_parameter_value(self, pluginId, parameterId, value):
  2191. self.sendMsg(["set_parameter_value", pluginId, parameterId, value])
  2192. self.fPluginsInfo[pluginId].parameterValues[parameterId] = value
  2193. def set_parameter_midi_channel(self, pluginId, parameterId, channel):
  2194. self.sendMsg(["set_parameter_midi_channel", pluginId, parameterId, channel])
  2195. self.fPluginsInfo[pluginId].parameterData[parameterId]['midiCC'] = channel
  2196. def set_parameter_midi_cc(self, pluginId, parameterId, cc):
  2197. self.sendMsg(["set_parameter_midi_cc", pluginId, parameterId, cc])
  2198. self.fPluginsInfo[pluginId].parameterData[parameterId]['midiCC'] = cc
  2199. def set_program(self, pluginId, programId):
  2200. self.sendMsg(["set_program", pluginId, programId])
  2201. self.fPluginsInfo[pluginId].programCurrent = programId
  2202. def set_midi_program(self, pluginId, midiProgramId):
  2203. self.sendMsg(["set_midi_program", pluginId, midiProgramId])
  2204. self.fPluginsInfo[pluginId].midiProgramCurrent = midiProgramId
  2205. def set_custom_data(self, pluginId, type_, key, value):
  2206. self.sendMsg(["set_custom_data", pluginId, type_, key, value])
  2207. for cdata in self.fPluginsInfo[pluginId].customData:
  2208. if cdata['type'] != type_:
  2209. continue
  2210. if cdata['key'] != key:
  2211. continue
  2212. cdata['value'] = value
  2213. break
  2214. def set_chunk_data(self, pluginId, chunkData):
  2215. self.sendMsg(["set_chunk_data", pluginId, chunkData])
  2216. def prepare_for_save(self, pluginId):
  2217. self.sendMsg(["prepare_for_save", pluginId])
  2218. def reset_parameters(self, pluginId):
  2219. self.sendMsg(["reset_parameters", pluginId])
  2220. def randomize_parameters(self, pluginId):
  2221. self.sendMsg(["randomize_parameters", pluginId])
  2222. def send_midi_note(self, pluginId, channel, note, velocity):
  2223. self.sendMsg(["send_midi_note", pluginId, channel, note, velocity])
  2224. def show_custom_ui(self, pluginId, yesNo):
  2225. self.sendMsg(["show_custom_ui", pluginId, yesNo])
  2226. def get_buffer_size(self):
  2227. return self.fBufferSize
  2228. def get_sample_rate(self):
  2229. return self.fSampleRate
  2230. def get_last_error(self):
  2231. return self.fLastError
  2232. def get_host_osc_url_tcp(self):
  2233. return ""
  2234. def get_host_osc_url_udp(self):
  2235. return ""
  2236. # --------------------------------------------------------------------------------------------------------
  2237. def _set_transport(self, playing, frame, bar, beat, tick, bpm):
  2238. self.fTransportInfo = {
  2239. "playing": playing,
  2240. "frame": frame,
  2241. "bar": bar,
  2242. "beat": beat,
  2243. "tick": tick,
  2244. "bpm": bpm
  2245. }
  2246. def _add(self, pluginId):
  2247. if len(self.fPluginsInfo) != pluginId:
  2248. return
  2249. info = PluginStoreInfo()
  2250. info.pluginInfo = PyCarlaPluginInfo
  2251. info.pluginRealName = ""
  2252. info.internalValues = [0.0, 1.0, 1.0, -1.0, 1.0, 0.0, -1.0]
  2253. info.audioCountInfo = PyCarlaPortCountInfo
  2254. info.midiCountInfo = PyCarlaPortCountInfo
  2255. info.parameterCount = 0
  2256. info.parameterCountInfo = PyCarlaPortCountInfo
  2257. info.parameterInfo = []
  2258. info.parameterData = []
  2259. info.parameterRanges = []
  2260. info.parameterValues = []
  2261. info.programCount = 0
  2262. info.programCurrent = -1
  2263. info.programNames = []
  2264. info.midiProgramCount = 0
  2265. info.midiProgramCurrent = -1
  2266. info.midiProgramData = []
  2267. info.customDataCount = 0
  2268. info.customData = []
  2269. info.peaks = [0.0, 0.0, 0.0, 0.0]
  2270. self.fPluginsInfo.append(info)
  2271. def _set_pluginInfo(self, pluginId, info):
  2272. self.fPluginsInfo[pluginId].pluginInfo = info
  2273. def _set_pluginName(self, pluginId, name):
  2274. self.fPluginsInfo[pluginId].pluginInfo['name'] = name
  2275. def _set_pluginRealName(self, pluginId, realName):
  2276. self.fPluginsInfo[pluginId].pluginRealName = realName
  2277. def _set_internalValue(self, pluginId, paramIndex, value):
  2278. if pluginId < len(self.fPluginsInfo) and PARAMETER_NULL > paramIndex > PARAMETER_MAX:
  2279. self.fPluginsInfo[pluginId].internalValues[abs(paramIndex)-2] = float(value)
  2280. def _set_audioCountInfo(self, pluginId, info):
  2281. self.fPluginsInfo[pluginId].audioCountInfo = info
  2282. def _set_midiCountInfo(self, pluginId, info):
  2283. self.fPluginsInfo[pluginId].midiCountInfo = info
  2284. def _set_parameterCountInfo(self, pluginId, count, info):
  2285. self.fPluginsInfo[pluginId].parameterCount = count
  2286. self.fPluginsInfo[pluginId].parameterCountInfo = info
  2287. # clear
  2288. self.fPluginsInfo[pluginId].parameterInfo = []
  2289. self.fPluginsInfo[pluginId].parameterData = []
  2290. self.fPluginsInfo[pluginId].parameterRanges = []
  2291. self.fPluginsInfo[pluginId].parameterValues = []
  2292. # add placeholders
  2293. for x in range(count):
  2294. self.fPluginsInfo[pluginId].parameterInfo.append(PyCarlaParameterInfo)
  2295. self.fPluginsInfo[pluginId].parameterData.append(PyParameterData)
  2296. self.fPluginsInfo[pluginId].parameterRanges.append(PyParameterRanges)
  2297. self.fPluginsInfo[pluginId].parameterValues.append(0.0)
  2298. def _set_programCount(self, pluginId, count):
  2299. self.fPluginsInfo[pluginId].programCount = count
  2300. # clear
  2301. self.fPluginsInfo[pluginId].programNames = []
  2302. # add placeholders
  2303. for x in range(count):
  2304. self.fPluginsInfo[pluginId].programNames.append("")
  2305. def _set_midiProgramCount(self, pluginId, count):
  2306. self.fPluginsInfo[pluginId].midiProgramCount = count
  2307. # clear
  2308. self.fPluginsInfo[pluginId].midiProgramData = []
  2309. # add placeholders
  2310. for x in range(count):
  2311. self.fPluginsInfo[pluginId].midiProgramData.append(PyMidiProgramData)
  2312. def _set_customDataCount(self, pluginId, count):
  2313. self.fPluginsInfo[pluginId].customDataCount = count
  2314. # clear
  2315. self.fPluginsInfo[pluginId].customData = []
  2316. # add placeholders
  2317. for x in range(count):
  2318. self.fPluginsInfo[pluginId].customData.append(PyCustomData)
  2319. def _set_parameterInfo(self, pluginId, paramIndex, info):
  2320. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2321. self.fPluginsInfo[pluginId].parameterInfo[paramIndex] = info
  2322. def _set_parameterData(self, pluginId, paramIndex, data):
  2323. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2324. self.fPluginsInfo[pluginId].parameterData[paramIndex] = data
  2325. def _set_parameterRanges(self, pluginId, paramIndex, ranges):
  2326. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2327. self.fPluginsInfo[pluginId].parameterRanges[paramIndex] = ranges
  2328. def _set_parameterValue(self, pluginId, paramIndex, value):
  2329. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2330. self.fPluginsInfo[pluginId].parameterValues[paramIndex] = value
  2331. def _set_parameterDefault(self, pluginId, paramIndex, value):
  2332. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2333. self.fPluginsInfo[pluginId].parameterRanges[paramIndex]['def'] = value
  2334. def _set_parameterMidiChannel(self, pluginId, paramIndex, channel):
  2335. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2336. self.fPluginsInfo[pluginId].parameterData[paramIndex]['midiChannel'] = channel
  2337. def _set_parameterMidiCC(self, pluginId, paramIndex, cc):
  2338. if pluginId < len(self.fPluginsInfo) and paramIndex < self.fPluginsInfo[pluginId].parameterCount:
  2339. self.fPluginsInfo[pluginId].parameterData[paramIndex]['midiCC'] = cc
  2340. def _set_currentProgram(self, pluginId, pIndex):
  2341. self.fPluginsInfo[pluginId].programCurrent = pIndex
  2342. def _set_currentMidiProgram(self, pluginId, mpIndex):
  2343. self.fPluginsInfo[pluginId].midiProgramCurrent = mpIndex
  2344. def _set_programName(self, pluginId, pIndex, name):
  2345. if pIndex < self.fPluginsInfo[pluginId].programCount:
  2346. self.fPluginsInfo[pluginId].programNames[pIndex] = name
  2347. def _set_midiProgramData(self, pluginId, mpIndex, data):
  2348. if mpIndex < self.fPluginsInfo[pluginId].midiProgramCount:
  2349. self.fPluginsInfo[pluginId].midiProgramData[mpIndex] = data
  2350. def _set_customData(self, pluginId, cdIndex, data):
  2351. if cdIndex < self.fPluginsInfo[pluginId].customDataCount:
  2352. self.fPluginsInfo[pluginId].customData[cdIndex] = data
  2353. def _set_peaks(self, pluginId, in1, in2, out1, out2):
  2354. self.fPluginsInfo[pluginId].peaks = [in1, in2, out1, out2]
  2355. # ------------------------------------------------------------------------------------------------------------