Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/csndsugui.py
blob: 8281b198948b7d573077c9f1031b18a4e1f24592 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
# sugar-aware GUI classes
# with boxes, sliders, spinbuttons, buttons, etc
#
# (c) Victor Lazzarini, 2006-08
#   
#    This library is free software; you can redistribute it
#    and/or modify it under the terms of the GNU Lesser General Public
#    License as published by the Free Software Foundation; either
#    version 2.1 of the License, or (at your option) any later version.
#
#    csndsugui is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU Lesser General Public License for more details.
#
#    You should have received a copy of the GNU Lesser General Public
#    License along with csndsugui; if not, write to the Free Software
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
#    02111-1307 USA
#
#    As a special exception, if other files instantiate templates or
#    use macros or inline functions from this file, this file does not
#    by itself cause the resulting executable or library to be covered
#    by the GNU Lesser General Public License. This exception does not
#    however invalidate any other reasons why the library or executable
#    file might be covered by the GNU Lesser General Public License.
#
#
#  version 0.1.2  18/03/08

import pygtk
pygtk.require('2.0')
from sugar.activity import activity
import gtk
import sys
import csnd
import math
import locale
import os
import sugar.logger
import time

class BasicGUI:
    """Basic GUI with boxes, sliders, spins, buttons etc
    using pygtk/sugar, from which GUI classes
    can be derived for Csound use."""
    
    def set_channel(self,name, val):
       """basic bus channel setting method,
       should be overriden for full-functionality."""
       print "channel:%s, value:%.1f" % (name,val)

    def set_filechannel(self,chan,name):
        """basic filename channel setting method
        should be overriden for full-functionality."""
        print "channel:%s, filename:%s" % (chan,name)

    
    def set_message(self, mess):
        """basic message setting method
        should be overriden for full-functionality."""
        print mess

    def get_slider_value(self,name):
        """returns the slider value
          name: slider name (which should also be the attached bus channel name"""
        for i in self.sliders:
          if i[1] == name:
           return i[2]
        return 0


    def get_button_value(self,name):
        """returns the button value (0 or 1)
        name: button name (which should also be the attached bus channel name)"""
        for i in self.buttons:
          if i[1] == name:
           return i[2]
        return 0   

    def get_slider(self,name):
        """returns the slider widget instance
           name: slider name"""
        for i in self.sliders:
          if i[1] == name:
           return i[0]
        return 0
   
    def get_button(self,name):
        """returns the button widget instance
           name: button name"""
        for i in self.sliders:
          if i[1] == name:
           return i[0]
        return 0
    
    def set_focus(self):
        """ called whenever the focus changes """
        print self.focus

    def focus_out(self, widget, event):
        if(self.focus):
           self.focus = False
           self.set_focus()

    def focus_in(self, widget, event):
        if(not self.focus):
            self.focus = True
            self.set_focus()

    def focus_back(self, widget, event):
        self.window.disconnect(self.fback)
        self.connect_focus()

    def buttcallback(self, widget, data=None):
      for i in self.buttons:
         if i[0] == widget:
          if i[2]: 
            i[2] = 0
            i[0].modify_bg(gtk.STATE_NORMAL, gtk.gdk.Color(0x0FFF,0,0x00FF, 2))
            i[0].modify_bg(gtk.STATE_PRELIGHT, gtk.gdk.Color(0xFFFF,0,0xFFFF, 2))
          else:
            i[2] = 1
            i[0].modify_bg(gtk.STATE_NORMAL, gtk.gdk.Color(0xFFFF,0,0, 1))
            i[0].modify_bg(gtk.STATE_PRELIGHT, gtk.gdk.Color(0xFFFF,0,0, 2))
          self.set_channel(i[1], i[2])  

    def mbuttcallback(self, widget, data=None):
      for i in self.mbuttons:
         if i[0] == widget:
          self.set_message(i[2])  

    def slidcallback(self,adj,widget):
      for i in self.sliders:
         if i[0] == widget:
          i[2] = adj.value
          if i[4]:                
            self.set_channel(i[1],i[2])           
            i[3].set_text("%f" % i[2])
            pass
          else:
            value = i[5]*pow(i[6]/i[5], i[2]/i[6])
            self.set_channel(i[1], value)
            i[3].set_text("%.3f" % value)
            pass
    
    def spincallback(self,adj,widget):
      for i in self.spins:
         if i[0] == widget:
          i[2] = adj.value
          self.set_channel(i[1],i[2])
    
    def filecallback(self,widget):           
        name = self.curfile[0].get_filename()        
        self.set_filechannel(self.curfile[2], name)
        for i in self.buttons:
         if i[0] == self.curfile[1]:
           i[2] = name
        self.filenames.update({self.curfile[2] : name})
        self.curfile[0].destroy()
        

    def destroy_chooser(self,widget):
        self.curfile[0].destroy()
        
        
    # internal callback
    def fbuttcallback(self, widget, data=None):
      self.focus_disconnect()
      self.fback = self.window.connect('focus_in_event', self.focus_back)
      for i in self.buttons:
         if i[0] == widget:
          chooser = gtk.FileSelection(i[1])
          self.curfile = (chooser, i[0], i[1])
          chooser.set_filename(self.data_path)
          chooser.ok_button.connect("clicked", self.filecallback)
          chooser.cancel_button.connect("clicked", self.destroy_chooser)
          chooser.show()

   
    def cbbutton(self,box,callback,title=""):
       """Creates a callbackbutton
          box: parent box
          callback: click callback
          title: if given, the button name
          returns the widget instance"""
       self.cbbutts = self.cbbutts + 1
       butt = gtk.Button(" %s " % title)
       box.pack_start(butt, False, False, 5)
       self.cbbuttons.append([butt,title,0])
       butt.connect("clicked", callback)
       butt.show()
       return butt

   
    def button(self,box, title="",label=""):
       """Creates a button (on/off)
           box: parent box
           title: if given, the button name,
             which will also be the bus channel
             name. Otherwise a default name is
             given, BN, where N is button number
             in order of creation.
           label: if given, an alternative button name,
             which will be displayed instead of title
           returns the widget instance"""
       self.butts = self.butts + 1
       if title == "":
         title = "B%d" % self.butts
       if label == "": name = title
       else: name = label
       butt = gtk.Button(" %s " % name)
       butt.modify_bg(gtk.STATE_ACTIVE, gtk.gdk.Color(0xFFFF,0,0, 1))
       butt.modify_bg(gtk.STATE_PRELIGHT, gtk.gdk.Color(0xFFFF,0,0xFFFF, 2))
       box.pack_start(butt, False, False, 5)
       self.buttons.append([butt,title,0])
       butt.connect("clicked", self.buttcallback)
       butt.show()
       return butt

    def mbutton(self,box,mess,title=""):
       """Creates a mbutton (for sending a message)
           box: parent box
           title: if given, the button name, otherwise a default name is
            given, BN, where N is button number
            in order of creation.
           mess: message to be sent when button is clicked
           returns the widget instance"""
       self.mbutts = self.mbutts + 1
       if title == "":
         title = "B%d" % self.mbutts
       butt = gtk.Button(title)
       butt.modify_bg(gtk.STATE_NORMAL, gtk.gdk.Color(0x0FFF,0,0x00FF, 1))
       butt.modify_bg(gtk.STATE_PRELIGHT, gtk.gdk.Color(0xFFFF,0xFFFF,0x0000, 2))
       box.pack_start(butt, False, False, 5)
       self.mbuttons.append([butt,title,mess])
       butt.connect("clicked", self.mbuttcallback)
       butt.show()
       return butt
  
    def box(self,vert=True, parent=None, padding=5):
       """creates a box 
           vert: True, creates a vertical box; horiz.
            otherwise
           parent: parent box, None if this is a toplevel box
           padding: box padding
           returns the widget instance"""
       if vert:
         box = gtk.VBox()
       else:
         box = gtk.HBox()
       if parent:
         parent.pack_start(box, False, False, padding)
       else:
         self.outbox.pack_start(box, False, False, padding)
       self.boxes.append(box)
       box.show()     
       return box

    def filechooser(self,box,title,label=""):
        """Creates a filechooser button
           title: button name, also file bus channel name
           box: parent box
           label: if given, alternative name, for display purposes only
             otherwise button will display its title."""
        if label == "": name = title
        else: name = label
        butt = gtk.Button(name)
        box.pack_start(butt, False, False, 5)
        self.buttons.append([butt,title,"0"])
        butt.connect("clicked", self.fbuttcallback)
        self.set_filechannel(title,"0")
        self.filenames.update({title:"0"})
        butt.show()
        return butt

    def slider(self,init, start, end, x, y, box, title="",vert=True,linear=True,dwid=100,label=""):
       """Creates a slider
           init: initial value
           start, end: start and end of slider range
           x, y: x and y sizes of slider
           box: parent box
           title: if given, the slider name,
            which will also be the bus channel
            name. Otherwise a default name is
            given, SN, where N is slider number
            in order of creation.
           vert: vertical slider (True), else horiz.
           linear: linear response (True), else exponential (zero or negative
            ranges are not allowed)
           dwid:  display width in pixels
           label: if given, the alternative slider name, for display only 
           returns the widget instance"""
       self.slids = self.slids + 1
       if title == "":
          title = "S%d" % self.slids
       a = end - start 
       if vert:
          step = a/y
          adj = gtk.Adjustment(init,start,end,step,step,0) 
          slider = gtk.VScale(adj)
          slider.set_inverted(True)
       else:
          step = a/x
          adj = gtk.Adjustment(init,start,end,step,step,0)
          slider = gtk.HScale(adj)
         
       slider.set_draw_value(False)
       if step < 1.0:
        slider.set_digits(3)
       elif step < 10:
        slider.set_digits(2)
       elif step < 100:
        slider.set_digits(1)
       else:
        slider.set_digits(0)
      
       entry = gtk.Entry(5) 
       if vert: entry.set_size_request(dwid,50)
       else: entry.set_size_request(dwid,50)
       entry.set_editable(False)
      
       if not linear:
         if (init <= 0) or (start <= 0) or (end <= 0):
            linear = True

       if not linear:
         pos = end*math.log(1,end/start)
         slider.set_range(pos, end)
         pos = end*math.log(init/start,end/start)
         slider.set_value(pos)
       
       if label == "": name = title
       else: name = label
       entry.set_text("%f" % init)
       label = gtk.Label(name)
       slider.set_size_request(x,y)
       box.pack_start(slider, False, False, 5)
       box.pack_start(entry, False, False, 2)
       box.pack_start(label, False, False, 2)
       self.sliders.append([slider,title,init,entry,linear,start,end])
       adj.connect("value_changed", self.slidcallback, slider)
       slider.show()
       entry.show()
       label.show()
       self.set_channel(title, init)
       return slider

    def spin(self,init, start, end, step, page, box, accel=0,title="",label=""):
       """Creates a spin button
          init: initial value
          start, end: start and end of slider range
          step, page: small and large step sizes
          box: parent box
          accel: acceleration or 'climb rate' (0.0-1.0)
          title: if given, the spin button name,
            which will also be the bus channel
            name. Otherwise a default name is
            given, SPN, where N is spin number
            in order of creation.
          label: if given, the alternative name for the widget, for display only.
          returns the widget instance"""
       self.spinbs = self.spinbs + 1
       if title == "":
          title = "SP%d" % self.spinbs
       adj = gtk.Adjustment(init,start,end,step,page,0) 
       spin = gtk.SpinButton(adj,accel)      
       if step < 1.0:
        spin.set_digits(3)
       elif step < 10:
        spin.set_digits(2)
       elif step < 100:
        spin.set_digits(1)
       else:
        spin.set_digits(0)

       if label == "": name = title
       else: name = label
       label = gtk.Label(name)
       box.pack_start(spin, False, False, 5)
       box.pack_start(label, False, False, 2)
       self.spins.append([spin,title,init])
       adj.connect("value_changed", self.spincallback, spin)
       spin.show()
       label.show()
       self.set_channel(title, init)
       return spin

    def text(self, name, box=None,colour=(0,0,0)): 
      """Creates a static text label
         name: text label
         box: parent box, None if text is to be placed toplevel
         colour: RGB values in a tuple (R,G,B)
         returns the widget instance"""
      label = gtk.Label(name)
      label.modify_fg(gtk.STATE_NORMAL, gtk.gdk.Color(colour[0],colour[1],colour[2], 0))
      if box:
       box.pack_start(label, False, False, 5)
      else:
       self.outbox.pack_start(label, False, False, 5)
      label.show()
      return label 

    def framebox(self, name, vert=True, parent=None, colour=(0,0,0), padding=5): 
      """Creates a frame box
         name: text label
         vert: vertical (True) box, else horiz.
         parent: parent box, if None, this is a toplevel box
         colour: RGB values in a tuple (R,G,B) 
         padding: padding space
         returns the box widget instance"""
      frame = gtk.Frame(name)
      frame.modify_bg(gtk.STATE_NORMAL, gtk.gdk.Color(colour[0],colour[1],colour[2], 0))
      frame.get_label_widget().modify_fg(gtk.STATE_NORMAL, gtk.gdk.Color(colour[0],colour[1],colour[2], 0))
      if parent:
        parent.pack_start(frame, False, False, padding)
      else:
        self.outbox.pack_start(frame, False, False, padding)
      if vert:
        box = gtk.VBox()
      else:
        box = gtk.HBox()
      frame.add(box)
      frame.show()
      box.show()
      return box
      
    def vsliderbank(self,items,init, start, end, x, y, box):
        """Creates a vertical slider bank 
             items: number of sliders
             init: initial value
             start, end: start and end of slider range
             x, y: x and y sizes of slider
             box: parent box"""
        slid = self.slids
        for i in range(slid, slid+items):
           cbox = self.box(parent=box)
           self.slider(init,start,end,x,y,cbox)

    def hsliderbank(self,items,init, start, end, x, y, box):
        """Creates a horizontal slider bank 
           items: number of sliders
           init: initial value
           start, end: start and end of slider range
           x, y: x and y sizes of slider
           box: parent box"""
        slid = self.slids
        for i in range(slid, slid+items):
           cbox = self.box(False,box)
           self.slider(init,start,end,x,y,cbox,"",False)

    def buttonbank(self,items, box):
        """Creates a button bank 
           items: number of sliders
           box: parent box."""
        start = self.butts
        for i in range(start, start+items):
           self.button(box)

    def delete_event(self, widget, event, data=None):
       return False

    def get_toolbox(self):
        """Returns the Activity toolbox"""
        return self.toolbox

    def channels_reinit(self):
       """ resets channel to current widget values"""
       for i in self.channel_widgets:
         for j in i:
           if(j[1] != "pause"):
             if(j[1] != "play"):
               if(j[1] != "reset"):
                self.set_channel(j[1],j[2])
                self.logger.debug(j[1])

    def nofocus(self):
       pass
   
    def focus_connect(self):
      if not self.connected:
       self.focus = True
       self.in_id = self.window.connect('focus_in_event', self.focus_in)
       self.out_id = self.window.connect('focus_out_event', self.focus_out)
       self.connected = True
 
    def focus_disconnect(self):
      if self.connected:
       self.window.disconnect(self.in_id)
       self.window.disconnect(self.out_id)
       self.connected = False

    def __init__(self,act,colour=(-1,-1,-1),vert=True,toolbox=None):
       """Constructor
         act:  activity object
         colour: bg colour RGB tuple (R,G, B)
         vert: True for vertical topmost arrangement, horiz. otherwise
         toolbox: activity toolbox object, if None (default) a
            standard toolbox will be supplied"""
       self.sliders = []
       self.slids = 0
       self.spins = []
       self.spinbs = 0
       self.buttons = []
       self.butts = 0
       self.cbbuttons = []
       self.cbbutts = 0
       self.mbuttons = []
       self.mbutts = 0
       self.boxes = []
       self.connected = False
       self.channel_widgets = [self.sliders, self.spins, self.buttons]
       self.filenames = dict()
       self.window = act
       if toolbox == None:
        self.toolbox = activity.ActivityToolbox(self.window)
       else: self.toolbox = toolbox
       self.window.set_toolbox(self.toolbox)
       self.toolbox.show()
       if colour[0] >= 0:
        self.window.modify_bg(gtk.STATE_NORMAL, gtk.gdk.Color(colour[0],colour[1],colour[2], 0))
        
        
       if vert: self.outbox = gtk.VBox()
       else: self.outbox = gtk.HBox()
       
       self.window.set_canvas(self.outbox)
       self.data_path = os.path.join(act.get_activity_root(),"data/")
       self.outbox.show()
       self.logger = sugar.logger.logging.getLogger('csndsugui')

       
 
class CsoundGUI(BasicGUI):
     """A class inheriting from BasicGUI containing a Csound instance and a performance 
     thread instance."""  

     def set_channel(self,name,val):
      """overrides the base method.
         sets the bus channel value, called by the widget callbacks
         channel names 'play', 'pause' and
         'reset' are reserved for these respective uses"""
      if not self.ready:
       if name == "play":
         self.play()
       elif name == "pause":
         self.pause()
       elif name == "reset":
         self.reset()     
       self.csound.SetChannel(name,val)
      else:
       BasicGUI.set_channel(self,name,val)

     def set_filechannel(self,chan,name):
      """overrides the base method, setting the channel string"""
      if not self.ready:
       self.csound.SetChannel(chan,name)
      else:
       BasicGUI.set_filechannel(self,chan,name)
      
     def set_message(self, mess):
        """overrides the base method, sends a score message"""
        self.perf.InputMessage(mess) 

     def set_focus(self): 
         """overrides the base class method, resetting/recompiling Csound"""
         if self.focus:
            self.compile()
            self.channels_reinit()
            if self.replay and not self.on:
             self.play()
             self.logger.debug("focus_off and playing")
         else:
            self.replay = self.on
            self.logger.debug("focus_out and stopping")
            self.reset()    

     def play(self):
         """Starts a performance. """
         if not self.on:
          if self.paused: return
          self.on = True
          self.perf.Play()
         else:
          self.on = False
          self.perf.Pause()

     def pause(self):
         """Pauses a performance. """
         if self.on: 
          self.on = False
          self.paused = True
          self.perf.Pause()
         elif self.paused:
          self.on = True
          self.paused = False
          self.perf.Play()

     def csd(self, name):
         """Sets the source CSD and compiles it.
             name: CSD filename
             returns zero if successful"""
         path = activity.get_bundle_path()
         if self.ready:
           res = self.csound.Compile("%s/%s" % (path,name))
         if not res: 
          self.ready = False
          self.focus_connect()
         self.path = path
         self.name = name
         return res

     def recompile(self):
         """Recompiles the set CSD.
            returns zero if successful"""
         if not self.ready and self.name !=  "0":
            self.perf.Stop()
            self.perf.Join()
            self.on = False
            self.paused = False
            self.perf = csnd.CsoundPerformanceThread(self.csound)
            if self.arglist != None:
             res = self.csound.Compile(self.arglist.argc(),self.arglist.argv())
            else:
             res = self.csound.Compile("%s/%s" % (self.path,self.name))
            if(res): self.ready = True
            return res

     def compile(self,name=None,args=[]):
         """Compiles Csound code.
            name: CSD filename if given
            args: list of arguments (as strings)
            returns 0 if successful , non-zero if not."""
         if self.ready:
          if args != []:
           self.arglist = csnd.CsoundArgVList()
          self.path = activity.get_bundle_path()
          if name != None: self.name = name
          elif self.name == "0": return -1
          if self.arglist != None:
            if name != None:
             self.arglist.Append("csound")
             self.arglist.Append("%s/%s" % (self.path,self.name))
             for i in args: 
              self.arglist.Append(i)
            res = self.csound.Compile(self.arglist.argc(),self.arglist.argv())
          else: res = self.csound.Compile("%s/%s" % (self.path,self.name))
          if not res:
            self.ready = False
            self.focus_connect()
          else:
            self.arglist = None
          return res
            
     def reset(self):
         """Resets Csound, ready for a new CSD"""
         if not self.ready:
            self.perf.Stop()
            self.perf.Join()
            self.on = False
            self.paused = False
            self.perf = csnd.CsoundPerformanceThread(self.csound)
            self.ready = True

     def close(self, event):  
         self.reset()
         sys.exit(0)

     def __init__(self,act,colour=(-1,-1,-1),vert=True):
         """constructor
            act:  activity object
            colour: bg colour RGB tuple (R,G, B)
            vert: True for vertical topmost arrangement, horiz. otherwise."""
         locale.setlocale(locale.LC_NUMERIC, 'C')
         self.csound  = csnd.Csound()
         self.perf = csnd.CsoundPerformanceThread(self.csound)
         BasicGUI.__init__(self,act,colour,vert)
         self.ready = True
         self.on = False
         self.paused = False
         self.name = "0"
         self.arglist = None
         self.replay = False