enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[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         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, _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         if (!controllable->is_toggle()) {
284                 if (control_additional == msg->note_number) {
285                         controllable->set_value (midi_to_control (msg->velocity), Controllable::NoGroup);
286                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2  %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
287                 }
288         } else {
289                 if (control_additional == msg->note_number) {
290                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
291                         controllable->set_value (new_value, Controllable::NoGroup);
292                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2  %3\n", (int) msg->note_number, (float) new_value, current_uri()));
293                 }
294         }
295
296         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
297 }
298
299 void
300 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
301 {
302         if (!controllable) {
303                 if (lookup_controllable ()) {
304                         return;
305                 }
306         }
307
308         assert (controllable);
309
310         if (controllable->touching()) {
311                 return; // to prevent feedback fights when e.g. dragging a UI slider
312         }
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::NoGroup);
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::NoGroup);
347                                                 } else {
348                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
349                                                 }
350                                                 break;
351                                         case Enc_R:
352                                                 if (msg->value > 0x40) {
353                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
354                                                 } else {
355                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::NoGroup);
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::NoGroup);
361                                                 } else {
362                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
363                                                 }
364                                                 break;
365                                         case Enc_B:
366                                                 if (msg->value > 0x40) {
367                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
368                                                 } else {
369                                                         controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::NoGroup);
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::NoGroup);
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         if (msg == control_additional) {
415
416                 if (!controllable->is_toggle()) {
417                         controllable->set_value (1.0, Controllable::NoGroup);
418                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0  %3\n", (int) msg, current_uri() ));
419                 } else  {
420                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
421                         controllable->set_value (new_value, Controllable::NoGroup);
422                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2  %3\n", (int) msg, (float) new_value, current_uri()));
423                 }
424         }
425
426         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
427 }
428
429 void
430 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
431 {
432         if (!controllable) {
433                 if (lookup_controllable ()) {
434                         return;
435                 }
436         }
437
438         if (!controllable->is_toggle()) {
439                 controllable->set_value (midi_to_control (pb), Controllable::NoGroup);
440                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2  %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
441         } else {
442                 if (pb > 8065.0f) {
443                         controllable->set_value (1, Controllable::NoGroup);
444                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1  %2\n", (int) control_channel, current_uri()));
445                 } else {
446                         controllable->set_value (0, Controllable::NoGroup);
447                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0  %2\n", (int) control_channel, current_uri()));
448                 }
449         }
450
451         last_value = control_to_midi (controllable->get_value ());
452 }
453
454 void
455 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
456 {
457         /* we only respond to channel messages */
458
459         if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
460                 return;
461         }
462
463         _surface->check_used_event(msg[0], msg[1]);
464         bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
465
466         if (controllable) {
467                 controllable->LearningFinished ();
468         }
469 }
470
471 void
472 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
473 {
474         if (control_rpn == rpn) {
475                 if (controllable) {
476                         controllable->set_value (val, Controllable::NoGroup);
477                 }
478         }
479 }
480
481 void
482 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
483 {
484         if (control_nrpn == nrpn) {
485                 if (controllable) {
486                         controllable->set_value (val, Controllable::NoGroup);
487                 }
488         }
489 }
490
491 void
492 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
493 {
494         if (control_rpn == rpn) {
495                 if (controllable) {
496                         /* XXX how to increment/decrement ? */
497                         // controllable->set_value (val);
498                 }
499         }
500 }
501
502 void
503 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
504 {
505         if (control_nrpn == nrpn) {
506                 if (controllable) {
507                         /* XXX how to increment/decrement ? */
508                         // controllable->set_value (val);
509                 }
510         }
511 }
512
513 void
514 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
515 {
516         int chn_i = chn;
517         drop_external_control ();
518         control_rpn = rpn;
519         control_channel = chn;
520         _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
521 }
522
523 void
524 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
525 {
526         int chn_i = chn;
527         drop_external_control ();
528         control_nrpn = nrpn;
529         control_channel = chn;
530         _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
531 }
532
533 void
534 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
535 {
536         int chn_i = chn;
537         drop_external_control ();
538         control_nrpn = nrpn;
539         control_channel = chn;
540         _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
541 }
542
543 void
544 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
545 {
546         int chn_i = chn;
547         drop_external_control ();
548         control_rpn = rpn;
549         control_channel = chn;
550         _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
551 }
552
553 void
554 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
555 {
556         char buf[64];
557
558         drop_external_control ();
559
560         control_type = ev;
561         control_channel = chn;
562         control_additional = additional;
563
564         int chn_i = chn;
565         switch (ev) {
566         case MIDI::off:
567                 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
568
569                 /* if this is a togglee, connect to noteOn as well,
570                    and we'll toggle back and forth between the two.
571                 */
572
573                 if (_momentary) {
574                         _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
575                 }
576
577                 _control_description = "MIDI control: NoteOff";
578                 break;
579
580         case MIDI::on:
581                 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
582                 if (_momentary) {
583                         _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
584                 }
585                 _control_description = "MIDI control: NoteOn";
586                 break;
587
588         case MIDI::controller:
589                 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
590                 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
591                 _control_description = buf;
592                 break;
593
594         case MIDI::program:
595                 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
596                 _control_description = "MIDI control: ProgramChange";
597                 break;
598
599         case MIDI::pitchbend:
600                 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
601                 _control_description = "MIDI control: Pitchbend";
602                 break;
603
604         default:
605                 break;
606         }
607         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
608 }
609
610 MIDI::byte*
611 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
612 {
613         if (!controllable || !feedback) {
614                 return buf;
615         }
616
617         float val = controllable->get_value ();
618
619         /* Note that when sending RPN/NPRN we do two things:
620          *
621          * always send MSB first, then LSB
622          * null/reset the parameter ID after sending.
623          *
624          * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
625          */
626
627         if (control_rpn >= 0) {
628                 if (bufsize < 13) {
629                         return buf;
630                 }
631                 int rpn_val = (int) lrintf (val * 16384.0);
632                 if (last_value == rpn_val) {
633                         return buf;
634                 }
635                 *buf++ = (0xb0) | control_channel;
636                 *buf++ = 0x62;
637                 *buf++ = (int) ((control_rpn) >> 7);
638                 *buf++ = 0x63;
639                 *buf++ = (int) (control_rpn & 0x7f);
640                 *buf++ = 0x06;
641                 *buf++ = (int) (rpn_val >> 7);
642                 *buf++ = 0x26;
643                 *buf++ = (int) (rpn_val & 0x7f);
644                 *buf++ = 0x62;
645                 *buf++ = 0x7f;
646                 *buf++ = 0x63;
647                 *buf++ = 0x7f;
648                 bufsize -= 13;
649                 last_value = rpn_val;
650                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
651                 return buf;
652         }
653
654         if (control_nrpn >= 0) {
655                 int rpn_val = (int) lrintf (val * 16384.0);
656                 if (last_value == rpn_val) {
657                         return buf;
658                 }
659                 *buf++ = (0xb0) | control_channel;
660                 *buf++ = 0x64;
661                 *buf++ = (int) ((control_rpn) >> 7);
662                 *buf++ = 0x65;
663                 *buf++ = (int) (control_rpn & 0x7f);
664                 *buf++ = 0x06;
665                 *buf++ = (int) (rpn_val >> 7);
666                 *buf++ = 0x26;
667                 *buf++ = (int) (rpn_val & 0x7f);
668                 *buf++ = 0x64;
669                 *buf++ = 0x7f;
670                 *buf++ = 0x65;
671                 *buf++ = 0x7f;
672                 last_value = rpn_val;
673                 bufsize -= 13;
674                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
675                 return buf;
676         }
677
678         if (control_type == none || bufsize <= 2) {
679                 return buf;
680         }
681
682         int const gm = control_to_midi (val);
683
684         if (gm == last_value) {
685                 return buf;
686         }
687
688         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
689
690         *buf++ = (0xF0 & control_type) | (0xF & control_channel);
691         int ev_size = 3;
692         switch (control_type) {
693         case MIDI::pitchbend:
694                 *buf++ = int (gm) & 127;
695                 *buf++ = (int (gm) >> 7) & 127;
696                 break;
697         case MIDI::program:
698                 *buf++ = control_additional; /* program number */
699                 ev_size = 2;
700                 break;
701         default:
702                 *buf++ = control_additional; /* controller number */
703                 *buf++ = gm;
704                 break;
705         }
706         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)));
707
708         last_value = gm;
709         bufsize -= ev_size;
710
711         return buf;
712 }
713
714 int
715 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
716 {
717         const XMLProperty* prop;
718         int xx;
719
720         if ((prop = node.property ("event")) != 0) {
721                 sscanf (prop->value().c_str(), "0x%x", &xx);
722                 control_type = (MIDI::eventType) xx;
723         } else {
724                 return -1;
725         }
726
727         if ((prop = node.property ("channel")) != 0) {
728                 sscanf (prop->value().c_str(), "%d", &xx);
729                 control_channel = (MIDI::channel_t) xx;
730         } else {
731                 return -1;
732         }
733
734         if ((prop = node.property ("additional")) != 0) {
735                 sscanf (prop->value().c_str(), "0x%x", &xx);
736                 control_additional = (MIDI::byte) xx;
737         } else {
738                 return -1;
739         }
740
741         if ((prop = node.property ("feedback")) != 0) {
742                 feedback = (prop->value() == "yes");
743         } else {
744                 feedback = true; // default
745         }
746
747         bind_midi (control_channel, control_type, control_additional);
748
749         return 0;
750 }
751
752 XMLNode&
753 MIDIControllable::get_state ()
754 {
755         char buf[32];
756
757         XMLNode* node = new XMLNode ("MIDIControllable");
758
759         if (_current_uri.empty()) {
760                 node->add_property ("id", controllable->id().to_s());
761         } else {
762                 node->add_property ("uri", _current_uri);
763         }
764
765         if (controllable) {
766                 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
767                 node->add_property ("event", buf);
768                 snprintf (buf, sizeof(buf), "%d", (int) control_channel);
769                 node->add_property ("channel", buf);
770                 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
771                 node->add_property ("additional", buf);
772                 node->add_property ("feedback", (feedback ? "yes" : "no"));
773         }
774
775         return *node;
776 }
777
778 /** @return the maximum value for a control value transmitted
779  *  using a given MIDI::eventType.
780  */
781 int
782 MIDIControllable::max_value_for_type () const
783 {
784         /* XXX: this is not complete */
785
786         if (control_type == MIDI::pitchbend) {
787                 return 16383;
788         }
789
790         return 127;
791 }