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