data/carla-single

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3
   4 # Script to start carla plugin bridges
   5 # Copyright (C) 2015-2018 Filipe Coelho <falktx@falktx.com>
   6 #
   7 # This program is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU General Public License as
   9 # published by the Free Software Foundation; either version 2 of
  10 # the License, or any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # For a full copy of the GNU General Public License see the doc/GPL.txt file.
  18
  19 # --------------------------------------------------------------------------------------------------------
  20 # Imports
  21
  22 import os
  23 import sys
  24
  25 # --------------------------------------------------------------------------------------------------------
  26 # Setup
  27
  28 INSTALL_PREFIX = "X-PREFIX-X"
  29
  30 CARLA_LIBDIR = os.path.join(INSTALL_PREFIX, "lib", "carla")
  31 CARLA_RESDIR = os.path.join(INSTALL_PREFIX, "share", "carla", "resources")
  32
  33 # --------------------------------------------------------------------------------------------------------
  34 # Check for enough arguments
  35
  36 usageMsg = """\
  37 usage: %s [arch (optional)] [format] [filename/uri] [label (optional)] [uniqueId (optional)]
  38
  39 Possible archs:
  40   - native (default)
  41   - linux32
  42   - linux64
  43   - win32
  44   - win64
  45
  46 Possible formats:
  47   - internal
  48   - ladspa
  49   - dssi
  50   - lv2
  51   - vst|vst2
  52   - vst3
  53   - clap
  54   - jsfx
  55   - sf2
  56   - sfz
  57
  58 Examples:
  59 $ %s internal midisplit
  60 $ %s dssi /usr/lib/dssi/whysynth.so
  61 $ %s lv2 http://calf.sourceforge.net/plugins/Compressor
  62 $ %s native vst /usr/lib/vst/TAL-NoiseMaker.so
  63 $ %s win32 vst \"~/.wine/drive_c/Program Files (x86)/VstPlugins/Kontakt 5.dll\"
  64 $ CARLA_BRIDGE_PLUGIN_BINARY_TYPE=win64 %s vst \"~/.wine/drive_c/Program Files/Common Files/VST2/Sytrus VSTi.dll\"
  65
  66 Format can be skipped for internal and lv2 plugins (auto-detected), like this:
  67 $ %s midipattern
  68 $ %s http://synthv1.sourceforge.net/lv2""" % ((sys.argv[0],)*9)
  69
  70 def printUsageAndQuit():
  71     print(usageMsg)
  72     sys.exit(0)
  73
  74 if len(sys.argv) < 2:
  75     printUsageAndQuit()
  76
  77 # --------------------------------------------------------------------------------------------------------
  78 # Initialize variables to null
  79
  80 ARCH     = os.getenv("CARLA_BRIDGE_PLUGIN_BINARY_TYPE", "native")
  81 TESTING  = os.getenv("CARLA_BRIDGE_TESTING", None)
  82 FORMAT   = "none"
  83 FILENAME = ""
  84 LABEL    = ""
  85 UNIQUEID = 0
  86
  87 # --------------------------------------------------------------------------------------------------------
  88 # Set arch
  89
  90 arg = 1
  91
  92 if sys.argv[arg] in ("native", "posix32", "posix64", "linux32", "linux64", "mac32", "mac64", "win32", "win64"):
  93     ARCH = sys.argv[arg].replace("linux", "posix").replace("mac", "posix")
  94     arg += 1
  95
  96 if len(sys.argv) == arg:
  97     printUsageAndQuit()
  98
  99 # --------------------------------------------------------------------------------------------------------
 100 # Set format
 101
 102 if sys.argv[arg] in ("internal", "ladspa", "dssi", "lv2", "vst", "vst2", "vst3", "au", "clap", "jsfx", "sf2", "sfz"):
 103     FORMAT = sys.argv[arg]
 104     arg += 1
 105
 106     if FORMAT == "vst":
 107         FORMAT = "vst2"
 108
 109 elif len(sys.argv) == arg+1:
 110     FORMAT = "lv2" if ":" in sys.argv[arg] else "internal"
 111
 112 else:
 113     print("Invalid format")
 114     sys.exit(1)
 115
 116 if len(sys.argv) == arg:
 117     printUsageAndQuit()
 118
 119 # --------------------------------------------------------------------------------------------------------
 120 # Set filename/uri
 121
 122 if FORMAT in ("internal", "lv2"):
 123     LABEL = sys.argv[arg]
 124     arg += 1
 125
 126 else:
 127     FILENAME = os.path.expanduser(sys.argv[arg])
 128     arg += 1
 129
 130 # --------------------------------------------------------------------------------------------------------
 131 # Set label (optional)
 132
 133 if len(sys.argv) > arg:
 134     if FORMAT == "internal":
 135         print("label/uri already set, ignoring 2nd label")
 136     elif FORMAT == "lv2":
 137         newpwd = sys.argv[arg]
 138         if os.path.exists(newpwd):
 139             print("using path hack for lv2 plugin")
 140             os.chdir(newpwd)
 141     else:
 142         LABEL = sys.argv[arg]
 143     arg += 1
 144
 145 # --------------------------------------------------------------------------------------------------------
 146 # Set uniqueId (optional)
 147
 148 if len(sys.argv) > arg:
 149     if FORMAT in ("internal", "dssi", "lv2", "au", "sf2", "sfz"):
 150         print("uniqueId is not used in this format, ignored")
 151     else:
 152         try:
 153             UNIQUEID = int(sys.argv[arg])
 154         except:
 155             print("uniqueId must be a number")
 156             sys.exit(1)
 157     arg += 1
 158
 159 # --------------------------------------------------------------------------------------------------------
 160 # Others?
 161
 162 if len(sys.argv) > arg:
 163     print("Got too many arguments, ignoring past uniqueId")
 164
 165 # --------------------------------------------------------------------------------------------------------
 166 # Set bridge binary
 167
 168 BRIDGE = os.path.join(CARLA_LIBDIR, "carla-bridge-" + ARCH)
 169
 170 if ARCH in ("win32", "win64") or TESTING in ("win32", "win64"):
 171     BRIDGE = BRIDGE + ".exe"
 172
 173 # --------------------------------------------------------------------------------------------------------
 174 # Check for existing carla folder
 175
 176 if not os.path.exists(CARLA_LIBDIR):
 177     print("Carla library folder does not exist, is Carla installed?")
 178     sys.exit(2)
 179
 180 if not os.path.exists(CARLA_RESDIR):
 181     print("Carla resource folder does not exist, is Carla installed?")
 182     sys.exit(2)
 183
 184 # --------------------------------------------------------------------------------------------------------
 185 # Check for existing arch binary
 186
 187 if not os.path.exists(BRIDGE):
 188     print("Carla plugin bridge (%s) for the requested arch (%s) does not exist" % (os.path.basename(BRIDGE), ARCH,))
 189     sys.exit(2)
 190
 191 # --------------------------------------------------------------------------------------------------------
 192 # Final checks
 193
 194 if ARCH not in ("native", "posix32", "posix64", "win32", "win64"):
 195     print("Invalid arch")
 196     sys.exit(1)
 197
 198 if FORMAT not in ("internal", "ladspa", "dssi", "lv2", "vst2", "vst3", "au", "clap", "jsfx", "sf2", "sfz"):
 199     print("Invalid format")
 200     sys.exit(1)
 201
 202 if FILENAME and not os.path.exists(FILENAME):
 203     print("Requested filename does not exist")
 204     sys.exit(1)
 205
 206 # --------------------------------------------------------------------------------------------------------
 207 # Setup environment
 208
 209 LADSPA_PATH = os.getenv("LADSPA_PATH")
 210 DSSI_PATH   = os.getenv("DSSI_PATH")
 211 LV2_PATH    = os.getenv("LV2_PATH")
 212 VST2_PATH   = os.getenv("VST_PATH")
 213 VST3_PATH   = os.getenv("VST3_PATH")
 214 CLAP_PATH   = os.getenv("CLAP_PATH")
 215 SF2_PATH    = os.getenv("SF2_PATH")
 216 SFZ_PATH    = os.getenv("SFZ_PATH")
 217
 218 if LADSPA_PATH is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_LADSPA"] = LADSPA_PATH
 219 if DSSI_PATH   is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_DSSI"]   = DSSI_PATH
 220 if LV2_PATH    is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_LV2"]    = LV2_PATH
 221 if VST2_PATH   is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_VST2"]   = VST2_PATH
 222 if VST3_PATH   is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_VST3"]   = VST3_PATH
 223 if CLAP_PATH   is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_CLAP"]   = CLAP_PATH
 224 if SF2_PATH    is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_SF2"]    = SF2_PATH
 225 if SFZ_PATH    is not None: os.environ["ENGINE_OPTION_PLUGIN_PATH_SFZ"]    = SFZ_PATH
 226
 227 os.environ["ENGINE_OPTION_PATH_BINARIES"]  = CARLA_LIBDIR
 228 os.environ["ENGINE_OPTION_PATH_RESOURCES"] = CARLA_RESDIR
 229
 230 # --------------------------------------------------------------------------------------------------------
 231
 232 CARLA_CLIENT_NAME = os.getenv("CARLA_CLIENT_NAME")
 233 LADISH_APP_NAME   = os.getenv("LADISH_APP_NAME")
 234
 235 if CARLA_CLIENT_NAME is not None:
 236     os.environ["CARLA_CLIENT_NAME"] = CARLA_CLIENT_NAME
 237 elif LADISH_APP_NAME is not None:
 238     os.environ["CARLA_CLIENT_NAME"] = LADISH_APP_NAME
 239 else:
 240     os.environ["CARLA_CLIENT_NAME"] = "(none)"
 241
 242 # --------------------------------------------------------------------------------------------------------
 243 # Exec
 244
 245 command = []
 246
 247 if os.getenv("CARLA_BRIDGE_PLUGIN_BINARY_TYPE") is not None:
 248     BRIDGE = os.path.join(CARLA_LIBDIR, "carla-bridge-native")
 249 elif ARCH == "win32" or TESTING == "win32":
 250     command.append("wine")
 251 elif ARCH == "win64" or TESTING == "win64":
 252     command.append("wine64")
 253
 254 command.append(BRIDGE)
 255 command.append(FORMAT)
 256 command.append(FILENAME or "(none)")
 257 command.append(LABEL or "(none)")
 258 command.append(str(UNIQUEID))
 259
 260 print(command)
 261 os.execvp(command[0], command)
 262
 263 # --------------------------------------------------------------------------------------------------------