jack_mixer.py

   1 #!/usr/bin/env python
   2 # -*- coding: UTF-8 -*-
   3 #
   4 # This file is part of jack_mixer
   5 #
   6 # Copyright (C) 2006-2009 Nedko Arnaudov <nedko@arnaudov.name>
   7 # Copyright (C) 2009 Frederic Peters <fpeters@0d.be>
   8 #
   9 # This program is free software; you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; version 2 of the License
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  21
  22 from optparse import OptionParser
  23
  24 import gtk
  25 import gobject
  26 import sys
  27 import os
  28
  29 try:
  30     import lash
  31 except:
  32     lash = None
  33     print >> sys.stderr, "Cannot load LASH python bindings, you want them unless you enjoy manual jack plumbing each time you use this app"
  34
  35 # temporary change Python modules lookup path to look into installation
  36 # directory ($prefix/share/jack_mixer/)
  37 old_path = sys.path
  38 sys.path.insert(0, os.path.join(os.path.dirname(sys.argv[0]), '..', 'share', 'jack_mixer'))
  39
  40 import jack_mixer_c
  41 import scale
  42 from channel import *
  43
  44 import gui
  45 from preferences import PreferencesDialog
  46
  47 from serialization_xml import XmlSerialization
  48 from serialization import SerializedObject, Serializator
  49
  50 # restore Python modules lookup path
  51 sys.path = old_path
  52
  53 class JackMixer(SerializedObject):
  54
  55     # scales suitable as meter scales
  56     meter_scales = [scale.IEC268(), scale.Linear70dB(), scale.IEC268Minimalistic()]
  57
  58     # scales suitable as volume slider scales
  59     slider_scales = [scale.Linear30dB(), scale.Linear70dB()]
  60
  61     # name of settngs file that is currently open
  62     current_filename = None
  63
  64     def __init__(self, name, lash_client):
  65         self.mixer = jack_mixer_c.Mixer(name)
  66         if not self.mixer:
  67             return
  68         self.monitor_channel = self.mixer.add_output_channel("Monitor", True, True)
  69
  70         if lash_client:
  71             # Send our client name to server
  72             lash_event = lash.lash_event_new_with_type(lash.LASH_Client_Name)
  73             lash.lash_event_set_string(lash_event, name)
  74             lash.lash_send_event(lash_client, lash_event)
  75
  76             lash.lash_jack_client_name(lash_client, name)
  77
  78         gtk.window_set_default_icon_name('jack_mixer')
  79
  80         self.window = gtk.Window(gtk.WINDOW_TOPLEVEL)
  81         self.window.set_title(name)
  82
  83         self.gui_factory = gui.Factory(self.window, self.meter_scales, self.slider_scales)
  84
  85         self.vbox_top = gtk.VBox()
  86         self.window.add(self.vbox_top)
  87
  88         self.menubar = gtk.MenuBar()
  89         self.vbox_top.pack_start(self.menubar, False)
  90
  91         mixer_menu_item = gtk.MenuItem("_Mixer")
  92         self.menubar.append(mixer_menu_item)
  93         edit_menu_item = gtk.MenuItem('_Edit')
  94         self.menubar.append(edit_menu_item)
  95         help_menu_item = gtk.MenuItem('_Help')
  96         self.menubar.append(help_menu_item)
  97
  98         self.window.set_default_size(120, 300)
  99
 100         mixer_menu = gtk.Menu()
 101         mixer_menu_item.set_submenu(mixer_menu)
 102
 103         add_input_channel = gtk.ImageMenuItem('New _Input Channel')
 104         mixer_menu.append(add_input_channel)
 105         add_input_channel.connect("activate", self.on_add_input_channel)
 106
 107         add_output_channel = gtk.ImageMenuItem('New _Output Channel')
 108         mixer_menu.append(add_output_channel)
 109         add_output_channel.connect("activate", self.on_add_output_channel)
 110
 111         if lash_client is None:
 112             mixer_menu.append(gtk.SeparatorMenuItem())
 113             open = gtk.ImageMenuItem(gtk.STOCK_OPEN)
 114             mixer_menu.append(open)
 115             open.connect('activate', self.on_open_cb)
 116             save = gtk.ImageMenuItem(gtk.STOCK_SAVE)
 117             mixer_menu.append(save)
 118             save.connect('activate', self.on_save_cb)
 119             save_as = gtk.ImageMenuItem(gtk.STOCK_SAVE_AS)
 120             mixer_menu.append(save_as)
 121             save_as.connect('activate', self.on_save_as_cb)
 122
 123         mixer_menu.append(gtk.SeparatorMenuItem())
 124
 125         quit = gtk.ImageMenuItem(gtk.STOCK_QUIT)
 126         mixer_menu.append(quit)
 127         quit.connect('activate', self.on_quit_cb)
 128
 129         edit_menu = gtk.Menu()
 130         edit_menu_item.set_submenu(edit_menu)
 131
 132         self.channel_remove_menu_item = gtk.ImageMenuItem(gtk.STOCK_REMOVE)
 133         edit_menu.append(self.channel_remove_menu_item)
 134         self.channel_remove_menu = gtk.Menu()
 135         self.channel_remove_menu_item.set_submenu(self.channel_remove_menu)
 136
 137         channel_remove_all_menu_item = gtk.ImageMenuItem(gtk.STOCK_CLEAR)
 138         edit_menu.append(channel_remove_all_menu_item)
 139         channel_remove_all_menu_item.connect("activate", self.on_channels_clear)
 140
 141         edit_menu.append(gtk.SeparatorMenuItem())
 142
 143         preferences = gtk.ImageMenuItem(gtk.STOCK_PREFERENCES)
 144         preferences.connect('activate', self.on_preferences_cb)
 145         edit_menu.append(preferences)
 146
 147         help_menu = gtk.Menu()
 148         help_menu_item.set_submenu(help_menu)
 149
 150         about = gtk.ImageMenuItem(gtk.STOCK_ABOUT)
 151         help_menu.append(about)
 152         about.connect("activate", self.on_about)
 153
 154         self.hbox_top = gtk.HBox()
 155         self.vbox_top.pack_start(self.hbox_top, True)
 156
 157         self.scrolled_window = gtk.ScrolledWindow()
 158         self.hbox_top.pack_start(self.scrolled_window, True)
 159
 160         self.hbox_inputs = gtk.HBox()
 161         self.hbox_inputs.set_spacing(0)
 162         self.hbox_inputs.set_border_width(0)
 163         self.hbox_top.set_spacing(0)
 164         self.hbox_top.set_border_width(0)
 165         self.channels = []
 166         self.output_channels = []
 167
 168         self.scrolled_window.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 169         self.scrolled_window.add_with_viewport(self.hbox_inputs)
 170
 171         self.main_mix = MainMixChannel(self)
 172         self.hbox_outputs = gtk.HBox()
 173         self.hbox_outputs.set_spacing(0)
 174         self.hbox_outputs.set_border_width(0)
 175         frame = gtk.Frame()
 176         frame.add(self.main_mix)
 177         self.hbox_outputs.pack_start(frame, False)
 178         self.hbox_top.pack_start(self.hbox_outputs, False)
 179
 180         self.window.connect("destroy", gtk.main_quit)
 181
 182         gobject.timeout_add(80, self.read_meters)
 183         self.lash_client = lash_client
 184
 185         if lash_client:
 186             gobject.timeout_add(1000, self.lash_check_events)
 187
 188     def cleanup(self):
 189         print "Cleaning jack_mixer"
 190         if not self.mixer:
 191             return
 192
 193         for channel in self.channels:
 194             channel.unrealize()
 195
 196     def on_open_cb(self, *args):
 197         dlg = gtk.FileChooserDialog(title='Open', parent=self.window,
 198                         action=gtk.FILE_CHOOSER_ACTION_OPEN,
 199                         buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
 200                                  gtk.STOCK_OPEN, gtk.RESPONSE_OK))
 201         dlg.set_default_response(gtk.RESPONSE_OK)
 202         if dlg.run() == gtk.RESPONSE_OK:
 203             filename = dlg.get_filename()
 204             try:
 205                 f = file(filename, 'r')
 206                 self.load_from_xml(f)
 207             except:
 208                 err = gtk.MessageDialog(self.window,
 209                             gtk.DIALOG_MODAL,
 210                             gtk.MESSAGE_ERROR,
 211                             gtk.BUTTONS_OK,
 212                             "Failed loading settings.")
 213                 err.run()
 214                 err.destroy()
 215             else:
 216                 self.current_filename = filename
 217             finally:
 218                 f.close()
 219         dlg.destroy()
 220
 221     def on_save_cb(self, *args):
 222         if not self.current_filename:
 223             return self.on_save_as_cb()
 224         f = file(self.current_filename, 'w')
 225         self.save_to_xml(f)
 226         f.close()
 227
 228     def on_save_as_cb(self, *args):
 229         dlg = gtk.FileChooserDialog(title='Save', parent=self.window,
 230                         action=gtk.FILE_CHOOSER_ACTION_SAVE,
 231                         buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
 232                                  gtk.STOCK_SAVE, gtk.RESPONSE_OK))
 233         dlg.set_default_response(gtk.RESPONSE_OK)
 234         if dlg.run() == gtk.RESPONSE_OK:
 235             self.current_filename = dlg.get_filename()
 236             self.on_save_cb()
 237         dlg.destroy()
 238
 239     def on_quit_cb(self, *args):
 240         gtk.main_quit()
 241
 242     preferences_dialog = None
 243     def on_preferences_cb(self, widget):
 244         if not self.preferences_dialog:
 245             self.preferences_dialog = PreferencesDialog(self)
 246         self.preferences_dialog.show()
 247         self.preferences_dialog.present()
 248
 249     def on_add_input_channel(self, widget):
 250         dialog = NewChannelDialog(app=self)
 251         dialog.set_transient_for(self.window)
 252         dialog.show()
 253         ret = dialog.run()
 254         dialog.hide()
 255
 256         if ret == gtk.RESPONSE_OK:
 257             result = dialog.get_result()
 258             channel = self.add_channel(**result)
 259             self.window.show_all()
 260
 261     def on_add_output_channel(self, widget):
 262         dialog = NewOutputChannelDialog(app=self)
 263         dialog.set_transient_for(self.window)
 264         dialog.show()
 265         ret = dialog.run()
 266         dialog.hide()
 267
 268         if ret == gtk.RESPONSE_OK:
 269             result = dialog.get_result()
 270             channel = self.add_output_channel(**result)
 271             self.window.show_all()
 272
 273     def on_remove_channel(self, widget, channel):
 274         print 'Removing channel "%s"' % channel.channel_name
 275         self.channel_remove_menu.remove(widget)
 276         if self.monitored_channel is channel:
 277             channel.monitor_button.set_active(False)
 278         for i in range(len(self.channels)):
 279             if self.channels[i] is channel:
 280                 channel.unrealize()
 281                 del self.channels[i]
 282                 self.hbox_inputs.remove(channel.parent)
 283                 break
 284         if len(self.channels) == 0:
 285             self.channel_remove_menu_item.set_sensitive(False)
 286
 287     def on_channels_clear(self, widget):
 288         for channel in self.channels:
 289             channel.unrealize()
 290             self.hbox_inputs.remove(channel.parent)
 291         self.channels = []
 292         self.channel_remove_menu = gtk.Menu()
 293         self.channel_remove_menu_item.set_submenu(self.channel_remove_menu)
 294         self.channel_remove_menu_item.set_sensitive(False)
 295
 296     def add_channel(self, name, stereo, volume_cc, balance_cc):
 297         try:
 298             channel = InputChannel(self, name, stereo)
 299             self.add_channel_precreated(channel)
 300         except Exception:
 301             err = gtk.MessageDialog(self.window,
 302                             gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT,
 303                             gtk.MESSAGE_ERROR,
 304                             gtk.BUTTONS_OK,
 305                             "Channel creation failed")
 306             err.run()
 307             err.destroy()
 308             return
 309         if volume_cc:
 310             channel.channel.volume_midi_cc = int(volume_cc)
 311         if balance_cc:
 312             channel.channel.balance_midi_cc = int(balance_cc)
 313         if not (volume_cc or balance_cc):
 314             channel.channel.autoset_midi_cc()
 315         return channel
 316
 317     def add_channel_precreated(self, channel):
 318         frame = gtk.Frame()
 319         frame.add(channel)
 320         self.hbox_inputs.pack_start(frame, False)
 321         channel.realize()
 322         channel_remove_menu_item = gtk.MenuItem(channel.channel_name)
 323         self.channel_remove_menu.append(channel_remove_menu_item)
 324         channel_remove_menu_item.connect("activate", self.on_remove_channel, channel)
 325         self.channel_remove_menu_item.set_sensitive(True)
 326         self.channels.append(channel)
 327
 328         for outputchannel in self.output_channels:
 329             channel.add_control_group(outputchannel)
 330
 331     def read_meters(self):
 332         for channel in self.channels:
 333             channel.read_meter()
 334         self.main_mix.read_meter()
 335         for channel in self.output_channels:
 336             channel.read_meter()
 337         return True
 338
 339     def add_output_channel(self, name, stereo, volume_cc, balance_cc, display_solo_buttons):
 340         try:
 341             channel = OutputChannel(self, name, stereo)
 342             channel.display_solo_buttons = display_solo_buttons
 343             self.add_output_channel_precreated(channel)
 344         except Exception:
 345             err = gtk.MessageDialog(self.window,
 346                             gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT,
 347                             gtk.MESSAGE_ERROR,
 348                             gtk.BUTTONS_OK,
 349                             "Channel creation failed")
 350             err.run()
 351             err.destroy()
 352             return
 353         if volume_cc:
 354             channel.channel.volume_midi_cc = int(volume_cc)
 355         if balance_cc:
 356             channel.channel.balance_midi_cc = int(balance_cc)
 357         return channel
 358
 359     def add_output_channel_precreated(self, channel):
 360         frame = gtk.Frame()
 361         frame.add(channel)
 362         self.hbox_outputs.pack_start(frame, False)
 363         channel.realize()
 364         # XXX: handle deletion of output channels
 365         #channel_remove_menu_item = gtk.MenuItem(channel.channel_name)
 366         #self.channel_remove_menu.append(channel_remove_menu_item)
 367         #channel_remove_menu_item.connect("activate", self.on_remove_channel, channel, channel_remove_menu_item)
 368         #self.channel_remove_menu_item.set_sensitive(True)
 369         self.output_channels.append(channel)
 370
 371     _monitored_channel = None
 372     def get_monitored_channel(self):
 373         return self._monitored_channel
 374
 375     def set_monitored_channel(self, channel):
 376         if self._monitored_channel:
 377             if channel.channel.name == self._monitored_channel.channel.name:
 378                 return
 379         self._monitored_channel = channel
 380         if type(channel) is InputChannel:
 381             # reset all solo/mute settings
 382             for in_channel in self.channels:
 383                 self.monitor_channel.set_solo(in_channel.channel, False)
 384                 self.monitor_channel.set_muted(in_channel.channel, False)
 385             self.monitor_channel.set_solo(channel.channel, True)
 386             self.monitor_channel.prefader = True
 387         else:
 388             self.monitor_channel.prefader = False
 389         self.update_monitor(channel)
 390     monitored_channel = property(get_monitored_channel, set_monitored_channel)
 391
 392     def update_monitor(self, channel):
 393         if self.monitored_channel is not channel:
 394             return
 395         self.monitor_channel.volume = channel.channel.volume
 396         self.monitor_channel.balance = channel.channel.balance
 397         if type(self.monitored_channel) is OutputChannel:
 398             # sync solo/muted channels
 399             for input_channel in self.channels:
 400                 self.monitor_channel.set_solo(input_channel.channel,
 401                                 channel.channel.is_solo(input_channel.channel))
 402                 self.monitor_channel.set_muted(input_channel.channel,
 403                                 channel.channel.is_muted(input_channel.channel))
 404         elif type(self.monitored_channel) is MainMixChannel:
 405             # sync solo/muted channels
 406             for input_channel in self.channels:
 407                 self.monitor_channel.set_solo(input_channel.channel,
 408                                 input_channel.channel.solo)
 409                 self.monitor_channel.set_muted(input_channel.channel,
 410                                 input_channel.channel.mute)
 411
 412     def get_input_channel_by_name(self, name):
 413         for input_channel in self.channels:
 414             if input_channel.channel.name == name:
 415                 return input_channel
 416         return None
 417
 418     def on_about(self, *args):
 419         about = gtk.AboutDialog()
 420         about.set_name('jack_mixer')
 421         about.set_copyright('Copyright © 2006-2009\nNedko Arnaudov, Frederic Peters')
 422         about.set_license('''\
 423 jack_mixer is free software; you can redistribute it and/or modify it
 424 under the terms of the GNU General Public License as published by the
 425 Free Software Foundation; either version 2 of the License, or (at your
 426 option) any later version.
 427
 428 jack_mixer is distributed in the hope that it will be useful, but
 429 WITHOUT ANY WARRANTY; without even the implied warranty of
 430 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 431 General Public License for more details.
 432
 433 You should have received a copy of the GNU General Public License along
 434 with jack_mixer; if not, write to the Free Software Foundation, Inc., 51
 435 Franklin Street, Fifth Floor, Boston, MA 02110-130159 USA''')
 436         about.set_authors(['Nedko Arnaudov <nedko@arnaudov.name>',
 437                            'Frederic Peters <fpeters@0d.be>'])
 438         about.set_logo_icon_name('jack_mixer')
 439         about.set_website('http://home.gna.org/jackmixer/')
 440
 441         about.run()
 442         about.destroy()
 443
 444     def lash_check_events(self):
 445         while lash.lash_get_pending_event_count(self.lash_client):
 446             event = lash.lash_get_event(self.lash_client)
 447
 448             #print repr(event)
 449
 450             event_type = lash.lash_event_get_type(event)
 451             if event_type == lash.LASH_Quit:
 452                 print "jack_mixer: LASH ordered quit."
 453                 gtk.main_quit()
 454                 return False
 455             elif event_type == lash.LASH_Save_File:
 456                 directory = lash.lash_event_get_string(event)
 457                 print "jack_mixer: LASH ordered to save data in directory %s" % directory
 458                 filename = directory + os.sep + "jack_mixer.xml"
 459                 f = file(filename, "w")
 460                 self.save_to_xml(f)
 461                 f.close()
 462                 lash.lash_send_event(self.lash_client, event) # we crash with double free
 463             elif event_type == lash.LASH_Restore_File:
 464                 directory = lash.lash_event_get_string(event)
 465                 print "jack_mixer: LASH ordered to restore data from directory %s" % directory
 466                 filename = directory + os.sep + "jack_mixer.xml"
 467                 f = file(filename, "r")
 468                 self.load_from_xml(f, silence_errors=True)
 469                 f.close()
 470                 lash.lash_send_event(self.lash_client, event)
 471             else:
 472                 print "jack_mixer: Got unhandled LASH event, type " + str(event_type)
 473                 return True
 474
 475             #lash.lash_event_destroy(event)
 476
 477         return True
 478
 479     def save_to_xml(self, file):
 480         #print "Saving to XML..."
 481         b = XmlSerialization()
 482         s = Serializator()
 483         s.serialize(self, b)
 484         b.save(file)
 485
 486     def load_from_xml(self, file, silence_errors=False):
 487         #print "Loading from XML..."
 488         self.on_channels_clear(None)
 489         self.unserialized_channels = []
 490         b = XmlSerialization()
 491         try:
 492             b.load(file)
 493         except:
 494             if silence_errors:
 495                 return
 496             raise
 497         s = Serializator()
 498         s.unserialize(self, b)
 499         for channel in self.unserialized_channels:
 500             if isinstance(channel, InputChannel):
 501                 self.add_channel_precreated(channel)
 502         for channel in self.unserialized_channels:
 503             if isinstance(channel, OutputChannel):
 504                 self.add_output_channel_precreated(channel)
 505         del self.unserialized_channels
 506         self.window.show_all()
 507
 508     def serialize(self, object_backend):
 509         object_backend.add_property('geometry',
 510                         '%sx%s' % (self.window.allocation.width, self.window.allocation.height))
 511
 512     def unserialize_property(self, name, value):
 513         if name == 'geometry':
 514             width, height = value.split('x')
 515             self.window.resize(int(width), int(height))
 516             return True
 517
 518     def unserialize_child(self, name):
 519         if name == main_mix_serialization_name():
 520             return self.main_mix
 521
 522         if name == input_channel_serialization_name():
 523             channel = InputChannel(self, "", True)
 524             self.unserialized_channels.append(channel)
 525             return channel
 526
 527         if name == output_channel_serialization_name():
 528             channel = OutputChannel(self, "", True)
 529             self.unserialized_channels.append(channel)
 530             return channel
 531
 532     def serialization_get_childs(self):
 533         '''Get child objects tha required and support serialization'''
 534         childs = self.channels[:] + self.output_channels[:]
 535         childs.append(self.main_mix)
 536         return childs
 537
 538     def serialization_name(self):
 539         return "jack_mixer"
 540
 541     def main(self):
 542         self.main_mix.realize()
 543         self.main_mix.set_monitored()
 544
 545         if not self.mixer:
 546             return
 547
 548         self.window.show_all()
 549
 550         gtk.main()
 551
 552         #f = file("/dev/stdout", "w")
 553         #self.save_to_xml(f)
 554         #f.close
 555
 556 def help():
 557     print "Usage: %s [mixer_name]" % sys.argv[0]
 558
 559 def main():
 560     if lash:                        # If LASH python bindings are available
 561         # sys.argv is modified by this call
 562         lash_client = lash.init(sys.argv, "jack_mixer", lash.LASH_Config_File)
 563     else:
 564         lash_client = None
 565
 566     parser = OptionParser()
 567     parser.add_option('-c', '--config', dest='config')
 568     options, args = parser.parse_args()
 569
 570     # Yeah , this sounds stupid, we connected earlier, but we dont want to show this if we got --help option
 571     # This issue should be fixed in pylash, there is a reason for having two functions for initialization after all
 572     if lash_client:
 573         print "Successfully connected to LASH server at " +  lash.lash_get_server_name(lash_client)
 574
 575     if len(args) == 1:
 576         name = args[0]
 577     else:
 578         name = None
 579
 580     if not name:
 581         name = "jack_mixer-%u" % os.getpid()
 582
 583     gtk.gdk.threads_init()
 584     try:
 585         mixer = JackMixer(name, lash_client)
 586     except Exception, e:
 587         err = gtk.MessageDialog(None,
 588                             gtk.DIALOG_MODAL,
 589                             gtk.MESSAGE_ERROR,
 590                             gtk.BUTTONS_OK,
 591                             "Mixer creation failed (%s)" % str(e))
 592         err.run()
 593         err.destroy()
 594         sys.exit(1)
 595
 596     if options.config:
 597         f = file(options.config)
 598         mixer.current_filename = options.config
 599         try:
 600             mixer.load_from_xml(f)
 601         except:
 602             err = gtk.MessageDialog(mixer.window,
 603                             gtk.DIALOG_MODAL,
 604                             gtk.MESSAGE_ERROR,
 605                             gtk.BUTTONS_OK,
 606                             "Failed loading settings.")
 607             err.run()
 608             err.destroy()
 609         mixer.window.set_default_size(60*(1+len(mixer.channels)+len(mixer.output_channels)), 300)
 610         f.close()
 611
 612     mixer.main()
 613
 614     mixer.cleanup()
 615
 616 if __name__ == "__main__":
 617     main()