change Controllable::set_value() API to include grouped control consideration.
[ardour.git] / libs / surfaces / generic_midi / midicontrollable.cc
1 /*
2     Copyright (C) 1998-2006 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <stdint.h>
21 #include <cmath>
22 #include <climits>
23 #include <iostream>
24
25 #include "pbd/error.h"
26 #include "pbd/controllable_descriptor.h"
27 #include "pbd/xml++.h"
28 #include "pbd/stacktrace.h"
29 #include "pbd/compose.h"
30
31 #include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
32 #include "midi++/port.h"
33 #include "midi++/channel.h"
34
35 #include "ardour/async_midi_port.h"
36 #include "ardour/automation_control.h"
37 #include "ardour/midi_ui.h"
38 #include "ardour/utils.h"
39 #include "ardour/debug.h"
40
41 #include "midicontrollable.h"
42 #include "generic_midi_control_protocol.h"
43
44 using namespace std;
45 using namespace MIDI;
46 using namespace PBD;
47 using namespace ARDOUR;
48
49 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, bool m)
50         : _surface (s)
51         , controllable (0)
52         , _descriptor (0)
53         , _parser (p)
54         , _momentary (m)
55 {
56         _learned = false; /* from URI */
57         _encoder = No_enc;
58         setting = false;
59         last_value = 0; // got a better idea ?
60         last_controllable_value = 0.0f;
61         control_type = none;
62         control_rpn = -1;
63         control_nrpn = -1;
64         _control_description = "MIDI Control: none";
65         control_additional = (MIDI::byte) -1;
66         feedback = true; // for now
67 }
68
69 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, Controllable& c, bool m)
70         : _surface (s)
71         , _descriptor (0)
72         , _parser (p)
73         , _momentary (m)
74 {
75         set_controllable (&c);
76
77         _learned = true; /* from controllable */
78         _encoder = No_enc;
79         setting = false;
80         last_value = 0; // got a better idea ?
81         last_controllable_value = 0.0f;
82         control_type = none;
83         control_rpn = -1;
84         control_nrpn = -1;
85         _control_description = "MIDI Control: none";
86         control_additional = (MIDI::byte) -1;
87         feedback = true; // for now
88 }
89
90 MIDIControllable::~MIDIControllable ()
91 {
92         drop_external_control ();
93 }
94
95 int
96 MIDIControllable::init (const std::string& s)
97 {
98         _current_uri = s;
99         delete _descriptor;
100         _descriptor = new ControllableDescriptor;
101         return _descriptor->set (s);
102 }
103
104 void
105 MIDIControllable::midi_forget ()
106 {
107         /* stop listening for incoming messages, but retain
108            our existing event + type information.
109         */
110
111         midi_sense_connection[0].disconnect ();
112         midi_sense_connection[1].disconnect ();
113         midi_learn_connection.disconnect ();
114 }
115
116 void
117 MIDIControllable::drop_external_control ()
118 {
119         midi_forget ();
120         control_rpn = -1;
121         control_nrpn = -1;
122         control_type = none;
123         control_additional = (MIDI::byte) -1;
124 }
125
126 void
127 MIDIControllable::set_controllable (Controllable* c)
128 {
129         if (c == controllable) {
130                 return;
131         }
132
133         controllable_death_connection.disconnect ();
134
135         controllable = c;
136
137         if (controllable) {
138                 last_controllable_value = controllable->get_value();
139         } else {
140                 last_controllable_value = 0.0f; // is there a better value?
141         }
142
143         if (controllable) {
144                 controllable->Destroyed.connect (controllable_death_connection, MISSING_INVALIDATOR,
145                                                  boost::bind (&MIDIControllable::drop_controllable, this),
146                                                  MidiControlUI::instance());
147         }
148 }
149
150 void
151 MIDIControllable::midi_rebind (channel_t c)
152 {
153         if (c >= 0) {
154                 bind_midi (c, control_type, control_additional);
155         } else {
156                 midi_forget ();
157         }
158 }
159
160 void
161 MIDIControllable::learn_about_external_control ()
162 {
163         drop_external_control ();
164         _parser.any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
165 }
166
167 void
168 MIDIControllable::stop_learning ()
169 {
170         midi_learn_connection.disconnect ();
171 }
172
173 int
174 MIDIControllable::control_to_midi (float val)
175 {
176         if (controllable->is_gain_like()) {
177                 return gain_to_slider_position (val) * max_value_for_type ();
178         }
179
180         float control_min = controllable->lower ();
181         float control_max = controllable->upper ();
182         float control_range = control_max - control_min;
183
184         if (controllable->is_toggle()) {
185                 if (val >= (control_min + (control_range/2.0f))) {
186                         return max_value_for_type();
187                 } else {
188                         return 0;
189                 }
190         } else {
191                 AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
192                 if (actl) {
193                         control_min = actl->internal_to_interface(control_min);
194                         control_max = actl->internal_to_interface(control_max);
195                         control_range = control_max - control_min;
196                         val = actl->internal_to_interface(val);
197                 }
198         }
199         // fiddle value of max so value doesn't jump from 125 to 127 for 1.0
200         // otherwise decrement won't work.
201         return (val - control_min) / control_range * (max_value_for_type () - 1);
202 }
203
204 float
205 MIDIControllable::midi_to_control (int val)
206 {
207         /* fiddle with MIDI value so that we get an odd number of integer steps
208                 and can thus represent "middle" precisely as 0.5. this maps to
209                 the range 0..+1.0 (0 to 126)
210         */
211
212         float fv = (val == 0 ? 0 : float (val - 1) / (max_value_for_type() - 1));
213
214         if (controllable->is_gain_like()) {
215                 return controllable->interface_to_internal (fv);
216         }
217         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Raw value %1 float %2\n", val, fv));
218
219         float control_min = controllable->lower ();
220         float control_max = controllable->upper ();
221         float control_range = control_max - control_min;
222         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Min %1 Max %2 Range %3\n", control_min, control_max, control_range));
223
224         AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
225         if (actl) {
226                 if (fv == 0.f) return control_min;
227                 if (fv == 1.f) return control_max;
228                 control_min = actl->internal_to_interface(control_min);
229                 control_max = actl->internal_to_interface(control_max);
230                 control_range = control_max - control_min;
231                 return actl->interface_to_internal((fv * control_range) + control_min);
232         }
233         return (fv * control_range) + control_min;
234 }
235
236 void
237 MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb)
238 {
239         midi_sense_note (p, tb, true);
240 }
241
242 void
243 MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
244 {
245         midi_sense_note (p, tb, false);
246 }
247
248 int
249 MIDIControllable::lookup_controllable()
250 {
251         if (!_descriptor) {
252                 return -1;
253         }
254
255         boost::shared_ptr<Controllable> c = _surface->lookup_controllable (*_descriptor);
256
257         if (!c) {
258                 return -1;
259         }
260
261         set_controllable (c.get ());
262
263         return 0;
264 }
265
266 void
267 MIDIControllable::drop_controllable ()
268 {
269         set_controllable (0);
270 }
271
272 void
273 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
274 {
275         if (!controllable) {
276                 if (lookup_controllable()) {
277                         return;
278                 }
279         }
280
281         if (!controllable->is_toggle()) {
282                 if (control_additional == msg->note_number) {
283                         controllable->set_value (midi_to_control (msg->velocity), Controllable::NoGroup);
284                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2  %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
285                 }
286         } else {
287                 if (control_additional == msg->note_number) {
288                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
289                         controllable->set_value (new_value, Controllable::NoGroup);
290                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2  %3\n", (int) msg->note_number, (float) new_value, current_uri()));
291                 }
292         }
293
294         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
295 }
296
297 void
298 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
299 {
300         if (!controllable) {
301                 if (lookup_controllable ()) {
302                         return;
303                 }
304         }
305
306         assert (controllable);
307
308         if (controllable->touching()) {
309                 return; // to prevent feedback fights when e.g. dragging a UI slider
310         }
311
312         if (control_additional == msg->controller_number) {
313
314                 if (!controllable->is_toggle()) {
315                         if (get_encoder() == No_enc) {
316                                 float new_value = msg->value;
317                                 float max_value = max(last_controllable_value, new_value);
318                                 float min_value = min(last_controllable_value, new_value);
319                                 float range = max_value - min_value;
320                                 float threshold = (float) _surface->threshold ();
321
322                                 bool const in_sync = (
323                                         range < threshold &&
324                                         controllable->get_value() <= midi_to_control(max_value) &&
325                                         controllable->get_value() >= midi_to_control(min_value)
326                                         );
327
328                                 /* If the surface is not motorised, we try to prevent jumps when
329                                    the MIDI controller and controllable are out of sync.
330                                    There might be a better way of doing this.
331                                 */
332
333                                 if (in_sync || _surface->motorised ()) {
334                                         controllable->set_value (midi_to_control (new_value), Controllable::NoGroup);
335                                 }
336                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2  %3\n", (int) msg->controller_number, (float) midi_to_control(new_value), current_uri() ));
337
338                                 last_controllable_value = new_value;
339                         } else {
340                                 int offset = (msg->value & 0x3f);
341                                 switch (get_encoder()) {
342                                         case Enc_L:
343                                                 if (msg->value > 0x40) {
344                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::NoGroup);
345                                                 } else {
346                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
347                                                 }
348                                                 break;
349                                         case Enc_R:
350                                                 if (msg->value > 0x40) {
351                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
352                                                 } else {
353                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::NoGroup);
354                                                 }
355                                                 break;
356                                         case Enc_2:
357                                                 if (msg->value > 0x40) {
358                                                         controllable->set_value (midi_to_control (last_value - (0x7f - msg->value) + 1), Controllable::NoGroup);
359                                                 } else {
360                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
361                                                 }
362                                                 break;
363                                         case Enc_B:
364                                                 if (msg->value > 0x40) {
365                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
366                                                 } else {
367                                                         controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::NoGroup);
368                                                 }
369                                                 break;
370                                         default:
371                                                 break;
372                                 }
373                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2  %3\n", (int) msg->controller_number, (int) last_value, current_uri() ));
374
375                         }
376                 } else {
377                         if (msg->value > 64.0f) {
378                                 controllable->set_value (1, Controllable::NoGroup);
379                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 1  %2\n", (int) msg->controller_number, current_uri()));
380                         } else {
381                                 controllable->set_value (0, Controllable::NoGroup);
382                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 0  %2\n", (int) msg->controller_number, current_uri()));
383                         }
384                 }
385
386                 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
387         }
388 }
389
390 void
391 MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
392 {
393         if (!controllable) {
394                 if (lookup_controllable ()) {
395                         return;
396                 }
397         }
398         if (msg == control_additional) {
399
400                 if (!controllable->is_toggle()) {
401                         controllable->set_value (1.0, Controllable::NoGroup);
402                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0  %3\n", (int) msg, current_uri() ));
403                 } else  {
404                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
405                         controllable->set_value (new_value, Controllable::NoGroup);
406                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2  %3\n", (int) msg, (float) new_value, current_uri()));
407                 }
408         }
409
410         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
411 }
412
413 void
414 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
415 {
416         if (!controllable) {
417                 if (lookup_controllable ()) {
418                         return;
419                 }
420         }
421
422         if (!controllable->is_toggle()) {
423                 controllable->set_value (midi_to_control (pb), Controllable::NoGroup);
424                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2  %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
425         } else {
426                 if (pb > 8065.0f) {
427                         controllable->set_value (1, Controllable::NoGroup);
428                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1  %2\n", (int) control_channel, current_uri()));
429                 } else {
430                         controllable->set_value (0, Controllable::NoGroup);
431                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0  %2\n", (int) control_channel, current_uri()));
432                 }
433         }
434
435         last_value = control_to_midi (controllable->get_value ());
436 }
437
438 void
439 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
440 {
441         /* we only respond to channel messages */
442
443         if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
444                 return;
445         }
446
447         _surface->check_used_event(msg[0], msg[1]);
448         bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
449
450         if (controllable) {
451                 controllable->LearningFinished ();
452         }
453 }
454
455 void
456 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
457 {
458         if (control_rpn == rpn) {
459                 if (controllable) {
460                         controllable->set_value (val, Controllable::NoGroup);
461                 }
462         }
463 }
464
465 void
466 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
467 {
468         if (control_nrpn == nrpn) {
469                 if (controllable) {
470                         controllable->set_value (val, Controllable::NoGroup);
471                 }
472         }
473 }
474
475 void
476 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
477 {
478         if (control_rpn == rpn) {
479                 if (controllable) {
480                         /* XXX how to increment/decrement ? */
481                         // controllable->set_value (val);
482                 }
483         }
484 }
485
486 void
487 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
488 {
489         if (control_nrpn == nrpn) {
490                 if (controllable) {
491                         /* XXX how to increment/decrement ? */
492                         // controllable->set_value (val);
493                 }
494         }
495 }
496
497 void
498 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
499 {
500         int chn_i = chn;
501         drop_external_control ();
502         control_rpn = rpn;
503         control_channel = chn;
504         _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
505 }
506
507 void
508 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
509 {
510         int chn_i = chn;
511         drop_external_control ();
512         control_nrpn = nrpn;
513         control_channel = chn;
514         _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
515 }
516
517 void
518 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
519 {
520         int chn_i = chn;
521         drop_external_control ();
522         control_nrpn = nrpn;
523         control_channel = chn;
524         _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
525 }
526
527 void
528 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
529 {
530         int chn_i = chn;
531         drop_external_control ();
532         control_rpn = rpn;
533         control_channel = chn;
534         _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
535 }
536
537 void
538 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
539 {
540         char buf[64];
541
542         drop_external_control ();
543
544         control_type = ev;
545         control_channel = chn;
546         control_additional = additional;
547
548         int chn_i = chn;
549         switch (ev) {
550         case MIDI::off:
551                 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
552
553                 /* if this is a togglee, connect to noteOn as well,
554                    and we'll toggle back and forth between the two.
555                 */
556
557                 if (_momentary) {
558                         _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
559                 }
560
561                 _control_description = "MIDI control: NoteOff";
562                 break;
563
564         case MIDI::on:
565                 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
566                 if (_momentary) {
567                         _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
568                 }
569                 _control_description = "MIDI control: NoteOn";
570                 break;
571
572         case MIDI::controller:
573                 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
574                 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
575                 _control_description = buf;
576                 break;
577
578         case MIDI::program:
579                 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
580                 _control_description = "MIDI control: ProgramChange";
581                 break;
582
583         case MIDI::pitchbend:
584                 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
585                 _control_description = "MIDI control: Pitchbend";
586                 break;
587
588         default:
589                 break;
590         }
591         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
592 }
593
594 MIDI::byte*
595 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
596 {
597         if (!controllable || !feedback) {
598                 return buf;
599         }
600
601         float val = controllable->get_value ();
602
603         /* Note that when sending RPN/NPRN we do two things:
604          *
605          * always send MSB first, then LSB
606          * null/reset the parameter ID after sending.
607          *
608          * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
609          */
610
611         if (control_rpn >= 0) {
612                 if (bufsize < 13) {
613                         return buf;
614                 }
615                 int rpn_val = (int) lrintf (val * 16384.0);
616                 if (last_value == rpn_val) {
617                         return buf;
618                 }
619                 *buf++ = (0xb0) | control_channel;
620                 *buf++ = 0x62;
621                 *buf++ = (int) ((control_rpn) >> 7);
622                 *buf++ = 0x63;
623                 *buf++ = (int) (control_rpn & 0x7f);
624                 *buf++ = 0x06;
625                 *buf++ = (int) (rpn_val >> 7);
626                 *buf++ = 0x26;
627                 *buf++ = (int) (rpn_val & 0x7f);
628                 *buf++ = 0x62;
629                 *buf++ = 0x7f;
630                 *buf++ = 0x63;
631                 *buf++ = 0x7f;
632                 bufsize -= 13;
633                 last_value = rpn_val;
634                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
635                 return buf;
636         }
637
638         if (control_nrpn >= 0) {
639                 int rpn_val = (int) lrintf (val * 16384.0);
640                 if (last_value == rpn_val) {
641                         return buf;
642                 }
643                 *buf++ = (0xb0) | control_channel;
644                 *buf++ = 0x64;
645                 *buf++ = (int) ((control_rpn) >> 7);
646                 *buf++ = 0x65;
647                 *buf++ = (int) (control_rpn & 0x7f);
648                 *buf++ = 0x06;
649                 *buf++ = (int) (rpn_val >> 7);
650                 *buf++ = 0x26;
651                 *buf++ = (int) (rpn_val & 0x7f);
652                 *buf++ = 0x64;
653                 *buf++ = 0x7f;
654                 *buf++ = 0x65;
655                 *buf++ = 0x7f;
656                 last_value = rpn_val;
657                 bufsize -= 13;
658                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
659                 return buf;
660         }
661
662         if (control_type == none || bufsize <= 2) {
663                 return buf;
664         }
665
666         int const gm = control_to_midi (val);
667
668         if (gm == last_value) {
669                 return buf;
670         }
671
672         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
673
674         *buf++ = (0xF0 & control_type) | (0xF & control_channel);
675         int ev_size = 3;
676         switch (control_type) {
677         case MIDI::pitchbend:
678                 *buf++ = int (gm) & 127;
679                 *buf++ = (int (gm) >> 7) & 127;
680                 break;
681         case MIDI::program:
682                 *buf++ = control_additional; /* program number */
683                 ev_size = 2;
684                 break;
685         default:
686                 *buf++ = control_additional; /* controller number */
687                 *buf++ = gm;
688                 break;
689         }
690         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: Type %1 Channel %2 Bytes %3 %4\n", (int) control_type, (int) control_channel , (int) *(buf - 2), (int) *(buf - 1)));
691
692         last_value = gm;
693         bufsize -= ev_size;
694
695         return buf;
696 }
697
698 int
699 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
700 {
701         const XMLProperty* prop;
702         int xx;
703
704         if ((prop = node.property ("event")) != 0) {
705                 sscanf (prop->value().c_str(), "0x%x", &xx);
706                 control_type = (MIDI::eventType) xx;
707         } else {
708                 return -1;
709         }
710
711         if ((prop = node.property ("channel")) != 0) {
712                 sscanf (prop->value().c_str(), "%d", &xx);
713                 control_channel = (MIDI::channel_t) xx;
714         } else {
715                 return -1;
716         }
717
718         if ((prop = node.property ("additional")) != 0) {
719                 sscanf (prop->value().c_str(), "0x%x", &xx);
720                 control_additional = (MIDI::byte) xx;
721         } else {
722                 return -1;
723         }
724
725         if ((prop = node.property ("feedback")) != 0) {
726                 feedback = (prop->value() == "yes");
727         } else {
728                 feedback = true; // default
729         }
730
731         bind_midi (control_channel, control_type, control_additional);
732
733         return 0;
734 }
735
736 XMLNode&
737 MIDIControllable::get_state ()
738 {
739         char buf[32];
740
741         XMLNode* node = new XMLNode ("MIDIControllable");
742
743         if (_current_uri.empty()) {
744                 node->add_property ("id", controllable->id().to_s());
745         } else {
746                 node->add_property ("uri", _current_uri);
747         }
748
749         if (controllable) {
750                 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
751                 node->add_property ("event", buf);
752                 snprintf (buf, sizeof(buf), "%d", (int) control_channel);
753                 node->add_property ("channel", buf);
754                 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
755                 node->add_property ("additional", buf);
756                 node->add_property ("feedback", (feedback ? "yes" : "no"));
757         }
758
759         return *node;
760 }
761
762 /** @return the maximum value for a control value transmitted
763  *  using a given MIDI::eventType.
764  */
765 int
766 MIDIControllable::max_value_for_type () const
767 {
768         /* XXX: this is not complete */
769
770         if (control_type == MIDI::pitchbend) {
771                 return 16383;
772         }
773
774         return 127;
775 }