OSC: add feedback for /monitor/mute,dim,mono
[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/xml++.h"
27 #include "pbd/stacktrace.h"
28 #include "pbd/compose.h"
29
30 #include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
31 #include "midi++/port.h"
32 #include "midi++/channel.h"
33
34 #include "ardour/async_midi_port.h"
35 #include "ardour/automation_control.h"
36 #include "ardour/controllable_descriptor.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 }
67
68 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, Controllable& c, bool m)
69         : _surface (s)
70         , _descriptor (0)
71         , _parser (p)
72         , _momentary (m)
73 {
74         set_controllable (&c);
75
76         _learned = true; /* from controllable */
77         _encoder = No_enc;
78         setting = false;
79         last_value = 0; // got a better idea ?
80         last_controllable_value = 0.0f;
81         control_type = none;
82         control_rpn = -1;
83         control_nrpn = -1;
84         _control_description = "MIDI Control: none";
85         control_additional = (MIDI::byte) -1;
86 }
87
88 MIDIControllable::~MIDIControllable ()
89 {
90         drop_external_control ();
91         delete _descriptor;
92         _descriptor = 0;
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, _1),
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 (Controllable* c)
268 {
269         if (c == controllable) {
270                 set_controllable (0);
271         }
272 }
273
274 void
275 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
276 {
277         if (!controllable) {
278                 if (lookup_controllable()) {
279                         return;
280                 }
281         }
282
283         _surface->maybe_start_touch (controllable);
284
285         if (!controllable->is_toggle()) {
286                 if (control_additional == msg->note_number) {
287                         controllable->set_value (midi_to_control (msg->velocity), Controllable::UseGroup);
288                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2  %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
289                 }
290         } else {
291                 if (control_additional == msg->note_number) {
292                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
293                         controllable->set_value (new_value, Controllable::UseGroup);
294                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2  %3\n", (int) msg->note_number, (float) new_value, current_uri()));
295                 }
296         }
297
298         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
299 }
300
301 void
302 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
303 {
304         if (!controllable) {
305                 if (lookup_controllable ()) {
306                         return;
307                 }
308         }
309
310         assert (controllable);
311
312         _surface->maybe_start_touch (controllable);
313
314         if (control_additional == msg->controller_number) {
315
316                 if (!controllable->is_toggle()) {
317                         if (get_encoder() == No_enc) {
318                                 float new_value = msg->value;
319                                 float max_value = max(last_controllable_value, new_value);
320                                 float min_value = min(last_controllable_value, new_value);
321                                 float range = max_value - min_value;
322                                 float threshold = (float) _surface->threshold ();
323
324                                 bool const in_sync = (
325                                         range < threshold &&
326                                         controllable->get_value() <= midi_to_control(max_value) &&
327                                         controllable->get_value() >= midi_to_control(min_value)
328                                         );
329
330                                 /* If the surface is not motorised, we try to prevent jumps when
331                                    the MIDI controller and controllable are out of sync.
332                                    There might be a better way of doing this.
333                                 */
334
335                                 if (in_sync || _surface->motorised ()) {
336                                         controllable->set_value (midi_to_control (new_value), Controllable::UseGroup);
337                                 }
338                                 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() ));
339
340                                 last_controllable_value = new_value;
341                         } else {
342                                 int offset = (msg->value & 0x3f);
343                                 switch (get_encoder()) {
344                                         case Enc_L:
345                                                 if (msg->value > 0x40) {
346                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::UseGroup);
347                                                 } else {
348                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
349                                                 }
350                                                 break;
351                                         case Enc_R:
352                                                 if (msg->value > 0x40) {
353                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
354                                                 } else {
355                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::UseGroup);
356                                                 }
357                                                 break;
358                                         case Enc_2:
359                                                 if (msg->value > 0x40) {
360                                                         controllable->set_value (midi_to_control (last_value - (0x7f - msg->value) + 1), Controllable::UseGroup);
361                                                 } else {
362                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
363                                                 }
364                                                 break;
365                                         case Enc_B:
366                                                 if (msg->value > 0x40) {
367                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
368                                                 } else {
369                                                         controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::UseGroup);
370                                                 }
371                                                 break;
372                                         default:
373                                                 break;
374                                 }
375                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2  %3\n", (int) msg->controller_number, (int) last_value, current_uri() ));
376
377                         }
378                 } else {
379
380                         /* toggle control: make the toggle flip only if the
381                          * incoming control value exceeds 0.5 (0x40), so that
382                          * the typical button which sends "CC N=0x7f" on press
383                          * and "CC N=0x0" on release can be used to drive
384                          * toggles on press.
385                          *
386                          * No other arrangement really makes sense for a toggle
387                          * controllable. Acting on the press+release makes the
388                          * action momentary, which is almost never
389                          * desirable. If the physical button only sends a
390                          * message on press (or release), then it will be
391                          * expected to send a controller value >= 0.5
392                          * (0x40). It is hard to imagine why anyone would make
393                          * a MIDI controller button that sent 0x0 when pressed.
394                          */
395
396                         if (msg->value >= 0x40) {
397                                 controllable->set_value (controllable->get_value() >= 0.5 ? 0.0 : 1.0, Controllable::UseGroup);
398                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 1  %2\n", (int) msg->controller_number, current_uri()));
399                         }
400                 }
401
402                 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
403         }
404 }
405
406 void
407 MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
408 {
409         if (!controllable) {
410                 if (lookup_controllable ()) {
411                         return;
412                 }
413         }
414
415         _surface->maybe_start_touch (controllable);
416
417         if (msg == control_additional) {
418
419                 if (!controllable->is_toggle()) {
420                         controllable->set_value (1.0, Controllable::UseGroup);
421                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0  %3\n", (int) msg, current_uri() ));
422                 } else  {
423                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
424                         controllable->set_value (new_value, Controllable::UseGroup);
425                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2  %3\n", (int) msg, (float) new_value, current_uri()));
426                 }
427         }
428
429         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
430 }
431
432 void
433 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
434 {
435         if (!controllable) {
436                 if (lookup_controllable ()) {
437                         return;
438                 }
439         }
440
441         _surface->maybe_start_touch (controllable);
442
443         if (!controllable->is_toggle()) {
444                 controllable->set_value (midi_to_control (pb), Controllable::UseGroup);
445                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2  %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
446         } else {
447                 if (pb > 8065.0f) {
448                         controllable->set_value (1, Controllable::UseGroup);
449                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1  %2\n", (int) control_channel, current_uri()));
450                 } else {
451                         controllable->set_value (0, Controllable::UseGroup);
452                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0  %2\n", (int) control_channel, current_uri()));
453                 }
454         }
455
456         last_value = control_to_midi (controllable->get_value ());
457 }
458
459 void
460 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
461 {
462         /* we only respond to channel messages */
463
464         if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
465                 return;
466         }
467
468         _surface->check_used_event(msg[0], msg[1]);
469         bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
470
471         if (controllable) {
472                 controllable->LearningFinished ();
473         }
474 }
475
476 void
477 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
478 {
479         if (control_rpn == rpn) {
480                 if (controllable) {
481                         controllable->set_value (val, Controllable::UseGroup);
482                 }
483         }
484 }
485
486 void
487 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
488 {
489         if (control_nrpn == nrpn) {
490                 if (controllable) {
491                         controllable->set_value (val, Controllable::UseGroup);
492                 }
493         }
494 }
495
496 void
497 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
498 {
499         if (control_rpn == rpn) {
500                 if (controllable) {
501                         /* XXX how to increment/decrement ? */
502                         // controllable->set_value (val);
503                 }
504         }
505 }
506
507 void
508 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
509 {
510         if (control_nrpn == nrpn) {
511                 if (controllable) {
512                         /* XXX how to increment/decrement ? */
513                         // controllable->set_value (val);
514                 }
515         }
516 }
517
518 void
519 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
520 {
521         int chn_i = chn;
522         drop_external_control ();
523         control_rpn = rpn;
524         control_channel = chn;
525         _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
526 }
527
528 void
529 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
530 {
531         int chn_i = chn;
532         drop_external_control ();
533         control_nrpn = nrpn;
534         control_channel = chn;
535         _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
536 }
537
538 void
539 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
540 {
541         int chn_i = chn;
542         drop_external_control ();
543         control_nrpn = nrpn;
544         control_channel = chn;
545         _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
546 }
547
548 void
549 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
550 {
551         int chn_i = chn;
552         drop_external_control ();
553         control_rpn = rpn;
554         control_channel = chn;
555         _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
556 }
557
558 void
559 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
560 {
561         char buf[64];
562
563         drop_external_control ();
564
565         control_type = ev;
566         control_channel = chn;
567         control_additional = additional;
568
569         int chn_i = chn;
570         switch (ev) {
571         case MIDI::off:
572                 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
573
574                 /* if this is a togglee, connect to noteOn as well,
575                    and we'll toggle back and forth between the two.
576                 */
577
578                 if (_momentary) {
579                         _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
580                 }
581
582                 _control_description = "MIDI control: NoteOff";
583                 break;
584
585         case MIDI::on:
586                 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
587                 if (_momentary) {
588                         _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
589                 }
590                 _control_description = "MIDI control: NoteOn";
591                 break;
592
593         case MIDI::controller:
594                 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
595                 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
596                 _control_description = buf;
597                 break;
598
599         case MIDI::program:
600                 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
601                 _control_description = "MIDI control: ProgramChange";
602                 break;
603
604         case MIDI::pitchbend:
605                 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
606                 _control_description = "MIDI control: Pitchbend";
607                 break;
608
609         default:
610                 break;
611         }
612         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
613 }
614
615 MIDI::byte*
616 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
617 {
618         if (!controllable || !_surface->get_feedback ()) {
619                 return buf;
620         }
621
622         float val = controllable->get_value ();
623
624         /* Note that when sending RPN/NPRN we do two things:
625          *
626          * always send MSB first, then LSB
627          * null/reset the parameter ID after sending.
628          *
629          * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
630          */
631
632         if (control_rpn >= 0) {
633                 if (bufsize < 13) {
634                         return buf;
635                 }
636                 int rpn_val = (int) lrintf (val * 16384.0);
637                 if (last_value == rpn_val) {
638                         return buf;
639                 }
640                 *buf++ = (0xb0) | control_channel;
641                 *buf++ = 0x62;
642                 *buf++ = (int) ((control_rpn) >> 7);
643                 *buf++ = 0x63;
644                 *buf++ = (int) (control_rpn & 0x7f);
645                 *buf++ = 0x06;
646                 *buf++ = (int) (rpn_val >> 7);
647                 *buf++ = 0x26;
648                 *buf++ = (int) (rpn_val & 0x7f);
649                 *buf++ = 0x62;
650                 *buf++ = 0x7f;
651                 *buf++ = 0x63;
652                 *buf++ = 0x7f;
653                 bufsize -= 13;
654                 last_value = rpn_val;
655                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
656                 return buf;
657         }
658
659         if (control_nrpn >= 0) {
660                 int rpn_val = (int) lrintf (val * 16384.0);
661                 if (last_value == rpn_val) {
662                         return buf;
663                 }
664                 *buf++ = (0xb0) | control_channel;
665                 *buf++ = 0x64;
666                 *buf++ = (int) ((control_rpn) >> 7);
667                 *buf++ = 0x65;
668                 *buf++ = (int) (control_rpn & 0x7f);
669                 *buf++ = 0x06;
670                 *buf++ = (int) (rpn_val >> 7);
671                 *buf++ = 0x26;
672                 *buf++ = (int) (rpn_val & 0x7f);
673                 *buf++ = 0x64;
674                 *buf++ = 0x7f;
675                 *buf++ = 0x65;
676                 *buf++ = 0x7f;
677                 last_value = rpn_val;
678                 bufsize -= 13;
679                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
680                 return buf;
681         }
682
683         if (control_type == none || bufsize <= 2) {
684                 return buf;
685         }
686
687         int const gm = control_to_midi (val);
688
689         if (gm == last_value) {
690                 return buf;
691         }
692
693         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
694
695         *buf++ = (0xF0 & control_type) | (0xF & control_channel);
696         int ev_size = 3;
697         switch (control_type) {
698         case MIDI::pitchbend:
699                 *buf++ = int (gm) & 127;
700                 *buf++ = (int (gm) >> 7) & 127;
701                 break;
702         case MIDI::program:
703                 *buf++ = control_additional; /* program number */
704                 ev_size = 2;
705                 break;
706         default:
707                 *buf++ = control_additional; /* controller number */
708                 *buf++ = gm;
709                 break;
710         }
711         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)));
712
713         last_value = gm;
714         bufsize -= ev_size;
715
716         return buf;
717 }
718
719 int
720 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
721 {
722         const XMLProperty* prop;
723         int xx;
724
725         if ((prop = node.property ("event")) != 0) {
726                 sscanf (prop->value().c_str(), "0x%x", &xx);
727                 control_type = (MIDI::eventType) xx;
728         } else {
729                 return -1;
730         }
731
732         if ((prop = node.property ("channel")) != 0) {
733                 sscanf (prop->value().c_str(), "%d", &xx);
734                 control_channel = (MIDI::channel_t) xx;
735         } else {
736                 return -1;
737         }
738
739         if ((prop = node.property ("additional")) != 0) {
740                 sscanf (prop->value().c_str(), "0x%x", &xx);
741                 control_additional = (MIDI::byte) xx;
742         } else {
743                 return -1;
744         }
745
746         bind_midi (control_channel, control_type, control_additional);
747
748         return 0;
749 }
750
751 XMLNode&
752 MIDIControllable::get_state ()
753 {
754         char buf[32];
755
756         XMLNode* node = new XMLNode ("MIDIControllable");
757
758         if (_current_uri.empty()) {
759                 node->add_property ("id", controllable->id().to_s());
760         } else {
761                 node->add_property ("uri", _current_uri);
762         }
763
764         if (controllable) {
765                 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
766                 node->add_property ("event", buf);
767                 snprintf (buf, sizeof(buf), "%d", (int) control_channel);
768                 node->add_property ("channel", buf);
769                 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
770                 node->add_property ("additional", buf);
771         }
772
773         return *node;
774 }
775
776 /** @return the maximum value for a control value transmitted
777  *  using a given MIDI::eventType.
778  */
779 int
780 MIDIControllable::max_value_for_type () const
781 {
782         /* XXX: this is not complete */
783
784         if (control_type == MIDI::pitchbend) {
785                 return 16383;
786         }
787
788         return 127;
789 }