example-clients/jack_control

   1 #!/usr/bin/env python
   2
   3 name_base = 'org.jackaudio'
   4 control_interface_name = name_base + '.JackControl'
   5 configure_interface_name = name_base + '.Configure'
   6 service_name = name_base + '.service'
   7
   8 import sys
   9 import os
  10 from traceback import print_exc
  11
  12 import dbus
  13
  14 def bool_convert(str_value):
  15     if str_value.lower() == "false":
  16         return False
  17
  18     if str_value.lower() == "off":
  19         return False
  20
  21     if str_value.lower() == "no":
  22         return False
  23
  24     if str_value == "0":
  25         return False
  26
  27     if str_value.lower() == "(null)":
  28         return False
  29
  30     return bool(str_value)
  31
  32 def dbus_type_to_python_type(dbus_value):
  33     if type(dbus_value) == dbus.Boolean:
  34         return bool(dbus_value)
  35     if type(dbus_value) == dbus.Int32 or type(dbus_value) == dbus.UInt32:
  36         return int(dbus_value)
  37     return dbus_value
  38
  39 def python_type_to_jackdbus_type(value, type_char):
  40     type_char = str(type_char)
  41
  42     if type_char == "b":
  43         return bool_convert(value);
  44     elif type_char == "y":
  45         return dbus.Byte(value);
  46     elif type_char == "i":
  47         return dbus.Int32(value)
  48     elif type_char == "u":
  49         return dbus.UInt32(value)
  50
  51     return value
  52
  53 def dbus_type_to_type_string(dbus_value):
  54     if type(dbus_value) == dbus.Boolean:
  55         return "bool"
  56     if type(dbus_value) == dbus.Int32:
  57         return "sint"
  58     if type(dbus_value) == dbus.UInt32:
  59         return "uint"
  60     if type(dbus_value) == dbus.Byte:
  61         return "char"
  62     if type(dbus_value) == dbus.String:
  63         return "str"
  64
  65     return None                         # throw exception here?
  66
  67 def dbus_typesig_to_type_string(type_char):
  68     type_char = str(type_char)
  69     if type_char == 'i':
  70         return "sint"
  71     if type_char == 'u':
  72         return "uint"
  73     if type_char == 'y':
  74         return "char"
  75     if type_char == 's':
  76         return "str"
  77     if type_char == 'b':
  78         return "bool"
  79
  80     print 'shit'
  81     return None                         # throw exception here?
  82
  83 def get_parameters(iface, path):
  84     params = iface.GetParametersInfo(path)
  85
  86     #print params
  87     for param in params:
  88         typestr = dbus_typesig_to_type_string(param[0])
  89         name = param[1]
  90         #print name
  91         descr = param[2]
  92         #print descr
  93         isset, default, value = iface.GetParameterValue(path + [name])
  94         #print typestr
  95         if bool(isset):
  96             isset = "set"
  97         else:
  98             isset = "notset"
  99         value = dbus_type_to_python_type(value)
 100         default = dbus_type_to_python_type(default)
 101
 102         print "%20s: %s (%s:%s:%s:%s)" %(name, descr, typestr, isset, default, value)
 103
 104 def main():
 105     if len(sys.argv) == 1:
 106         print "Usage: %s [command] [command] ..." % os.path.basename(sys.argv[0])
 107         print "Commands:"
 108         print "    exit                       - exit jack dbus service (stops jack server if currently running)"
 109         print "    status                     - check whether jack server is started, return value is 0 if running and 1 otherwise"
 110         print "    start                      - start jack server if not currently started"
 111         print "    stop                       - stop jack server if currently started"
 112         print "    sm                         - switch master to currently selected driver"
 113         print "    dl                         - get list of available drivers"
 114         print "    dg                         - get currently selected driver"
 115         print "    ds <driver>                - select driver"
 116         print "    dp                         - get parameters of currently selected driver"
 117         print "    dpd <param>                - get long description for driver parameter"
 118         print "    dps <param> <value>        - set driver parameter"
 119         print "    asd <driver>               - add slave driver"
 120         print "    rsd <driver>               - remove slave driver"
 121         print "    il                         - get list of available internals"
 122         print "    ip <name>                  - get parameters of given internal"
 123         print "    ipd <name> <param>         - get long description for internal parameter"
 124         print "    ips <name> <param> <value> - set internal parameter"
 125         print "    iload <name>               - load internal"
 126         print "    iunload <name>             - unload internal"
 127         print "    ep                         - get engine parameters"
 128         print "    epd <param>                - get long description for engine parameter"
 129         print "    eps <param> <value>        - set engine parameter"
 130         sys.exit(0)
 131
 132     bus = dbus.SessionBus()
 133
 134     controller = bus.get_object(service_name, "/org/jackaudio/Controller")
 135     control_iface = dbus.Interface(controller, control_interface_name)
 136     configure_iface = dbus.Interface(controller, configure_interface_name)
 137
 138     # check arguments
 139     index = 1
 140     while index < len(sys.argv):
 141         arg = sys.argv[index]
 142         index += 1
 143         try:
 144             if arg == "exit":
 145                 print "--- exit"
 146                 control_iface.Exit()
 147             elif arg == "status":
 148                 print "--- status"
 149                 if control_iface.IsStarted():
 150                     print "started"
 151                     sys.exit(0)
 152                 else:
 153                     print "stopped"
 154                     sys.exit(1)
 155             elif arg == 'start':
 156                 print "--- start"
 157                 control_iface.StartServer()
 158             elif arg == 'stop':
 159                 print "--- stop"
 160                 control_iface.StopServer()
 161             elif arg == 'sm':
 162                 print "--- switch master driver"
 163                 control_iface.SwitchMaster()
 164             elif arg == 'ism':
 165                 if control_iface.IsManuallyActivated():
 166                     print "Manually activated"
 167                 else:
 168                     print "Automatically activated"
 169             elif arg == 'dl':
 170                 print "--- drivers list"
 171                 is_range, is_strict, is_fake_values, values = configure_iface.GetParameterConstraint(['engine', 'driver'])
 172                 for value in values:
 173                     print value[1]
 174             elif arg == 'dg':
 175                 print "--- get selected driver"
 176                 isset, default, value = configure_iface.GetParameterValue(['engine', 'driver'])
 177                 print value
 178             elif arg == 'ds':
 179                 if index >= len(sys.argv):
 180                     print "driver select command requires driver name argument"
 181                     sys.exit()
 182
 183                 arg = sys.argv[index]
 184                 index += 1
 185
 186                 print "--- driver select \"%s\"" % arg
 187                 configure_iface.SetParameterValue(['engine', 'driver'], dbus.String(arg))
 188             elif arg == 'dp':
 189                 print "--- get driver parameters (type:isset:default:value)"
 190                 get_parameters(configure_iface, ['driver'])
 191             elif arg == 'dpd':
 192                 if index >= len(sys.argv):
 193                     print "get driver parameter long description command requires parameter name argument"
 194                     sys.exit()
 195
 196                 param = sys.argv[index]
 197                 index += 1
 198
 199                 print "--- get driver parameter description (%s)" % param
 200                 type_char, name, short_descr, long_descr = configure_iface.GetParameterInfo(['driver', param])
 201                 print long_descr,
 202             elif arg == 'dps':
 203                 if index + 1 >= len(sys.argv):
 204                     print "driver parameter set command requires parameter name and value arguments"
 205                     sys.exit()
 206
 207                 param = sys.argv[index]
 208                 index += 1
 209                 value = sys.argv[index]
 210                 index += 1
 211
 212                 print "--- driver param set \"%s\" -> \"%s\"" % (param, value)
 213
 214                 type_char, name, short_descr, long_descr = configure_iface.GetParameterInfo(['driver', param])
 215                 configure_iface.SetParameterValue(['driver', param], python_type_to_jackdbus_type(value, type_char))
 216             elif arg == 'ep':
 217                 print "--- get engine parameters (type:isset:default:value)"
 218                 get_parameters(configure_iface, ['engine'])
 219             elif arg == 'epd':
 220                 if index >= len(sys.argv):
 221                     print "get engine parameter long description command requires parameter name argument"
 222                     sys.exit()
 223
 224                 param_name = sys.argv[index]
 225                 index += 1
 226
 227                 print "--- get engine parameter description (%s)" % param_name
 228
 229                 type_char, name, short_descr, long_descr = configure_iface.GetParameterInfo(['engine', param_name])
 230                 print long_descr,
 231             elif arg == 'eps':
 232                 if index + 1 >= len(sys.argv):
 233                     print "engine parameter set command requires parameter name and value arguments"
 234                     sys.exit()
 235
 236                 param = sys.argv[index]
 237                 index += 1
 238                 value = sys.argv[index]
 239                 index += 1
 240
 241                 print "--- engine param set \"%s\" -> \"%s\"" % (param, value)
 242
 243                 type_char, name, short_descr, long_descr = configure_iface.GetParameterInfo(['engine', param])
 244                 configure_iface.SetParameterValue(['engine', param], python_type_to_jackdbus_type(value, type_char))
 245             elif arg == 'il':
 246                 print "--- internals list"
 247                 is_leaf, internals = configure_iface.ReadContainer(['internals'])
 248                 for internal in internals:
 249                     print internal
 250             elif arg == 'ip':
 251                 print "--- get internal parameters (type:isset:default:value)"
 252
 253                 if index >= len(sys.argv):
 254                     print "internal parameters command requires internal name argument"
 255                     sys.exit()
 256
 257                 internal_name = sys.argv[index]
 258                 index += 1
 259
 260                 get_parameters(configure_iface, ['internals', internal_name])
 261             elif arg == 'ipd':
 262                 if index + 1 >= len(sys.argv):
 263                     print "get internal parameter long description command requires internal and parameter name arguments"
 264                     sys.exit()
 265
 266                 name = sys.argv[index]
 267                 index += 1
 268                 param = sys.argv[index]
 269                 index += 1
 270
 271                 print "--- get internal parameter description (%s)" % param
 272                 type_char, name, short_descr, long_descr = configure_iface.GetParameterInfo(['internals', name, param])
 273                 print long_descr
 274             elif arg == 'ips':
 275                 if index + 2 >= len(sys.argv):
 276                     print "get internal parameter long description command requires internal, parameter name and value arguments"
 277                     sys.exit()
 278
 279                 internal_name = sys.argv[index]
 280                 index += 1
 281                 param = sys.argv[index]
 282                 index += 1
 283                 value = sys.argv[index]
 284                 index += 1
 285
 286                 print "--- internal param set \"%s\" -> \"%s\"" % (param, value)
 287
 288                 type_char, name, short_descr, long_descr = configure_iface.GetParameterInfo(['internals', internal_name, param])
 289                 configure_iface.SetParameterValue(['internals', internal_name, param], python_type_to_jackdbus_type(value, type_char))
 290             elif arg == 'iload':
 291                 print "--- load internal"
 292
 293                 if index >= len(sys.argv):
 294                     print "load internal command requires internal name argument"
 295                     sys.exit()
 296
 297                 name = sys.argv[index]
 298                 index += 1
 299                 result = control_iface.LoadInternal(name)
 300             elif arg == 'iunload':
 301                 print "--- unload internal"
 302
 303                 if index >= len(sys.argv):
 304                     print "unload internal command requires internal name argument"
 305                     sys.exit()
 306
 307                 name = sys.argv[index]
 308                 index += 1
 309                 result = control_iface.UnloadInternal(name)
 310             elif arg == 'asd':
 311                 print "--- add slave driver"
 312
 313                 if index >= len(sys.argv):
 314                     print "add slave driver command requires driver name argument"
 315                     sys.exit()
 316
 317                 name = sys.argv[index]
 318                 index += 1
 319                 result = control_iface.AddSlaveDriver(name)
 320             elif arg == 'rsd':
 321                 print "--- remove slave driver"
 322
 323                 if index >= len(sys.argv):
 324                     print "remove slave driver command requires driver name argument"
 325                     sys.exit()
 326
 327                 name = sys.argv[index]
 328                 index += 1
 329                 result = control_iface.RemoveSlaveDriver(name)
 330             else:
 331                 print "Unknown command '%s'" % arg
 332         except dbus.DBusException, e:
 333             print "DBus exception: %s" % str(e)
 334
 335 if __name__ == '__main__':
 336     main()