2 Copyright (C) 2000 Paul Barton-Davis
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.
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.
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.
24 #include "timecode/time.h"
25 #include "pbd/error.h"
26 #include "midi++/mmc.h"
27 #include "midi++/port.h"
28 #include "midi++/jack_midi_port.h"
29 #include "midi++/parser.h"
30 #include "midi++/manager.h"
36 static std::map<int,string> mmc_cmd_map;
37 static void build_mmc_cmd_map ()
39 pair<int,string> newpair;
42 newpair.second = "Stop";
43 mmc_cmd_map.insert (newpair);
46 newpair.second = "Play";
47 mmc_cmd_map.insert (newpair);
50 newpair.second = "DeferredPlay";
51 mmc_cmd_map.insert (newpair);
54 newpair.second = "FastForward";
55 mmc_cmd_map.insert (newpair);
58 newpair.second = "Rewind";
59 mmc_cmd_map.insert (newpair);
62 newpair.second = "RecordStrobe";
63 mmc_cmd_map.insert (newpair);
66 newpair.second = "RecordExit";
67 mmc_cmd_map.insert (newpair);
70 newpair.second = "RecordPause";
71 mmc_cmd_map.insert (newpair);
74 newpair.second = "Pause";
75 mmc_cmd_map.insert (newpair);
78 newpair.second = "Eject";
79 mmc_cmd_map.insert (newpair);
82 newpair.second = "Chase";
83 mmc_cmd_map.insert (newpair);
86 newpair.second = "CommandErrorReset";
87 mmc_cmd_map.insert (newpair);
90 newpair.second = "MmcReset";
91 mmc_cmd_map.insert (newpair);
94 newpair.second = "Illegal Mackie Jog Start";
95 mmc_cmd_map.insert (newpair);
98 newpair.second = "Illegal Mackie Jog Stop";
99 mmc_cmd_map.insert (newpair);
101 newpair.first = 0x40;
102 newpair.second = "Write";
103 mmc_cmd_map.insert (newpair);
105 newpair.first = 0x41;
106 newpair.second = "MaskedWrite";
107 mmc_cmd_map.insert (newpair);
109 newpair.first = 0x42;
110 newpair.second = "Read";
111 mmc_cmd_map.insert (newpair);
113 newpair.first = 0x43;
114 newpair.second = "Update";
115 mmc_cmd_map.insert (newpair);
117 newpair.first = 0x44;
118 newpair.second = "Locate";
119 mmc_cmd_map.insert (newpair);
121 newpair.first = 0x45;
122 newpair.second = "VariablePlay";
123 mmc_cmd_map.insert (newpair);
125 newpair.first = 0x46;
126 newpair.second = "Search";
127 mmc_cmd_map.insert (newpair);
129 newpair.first = 0x47;
130 newpair.second = "Shuttle";
131 mmc_cmd_map.insert (newpair);
133 newpair.first = 0x48;
134 newpair.second = "Step";
135 mmc_cmd_map.insert (newpair);
137 newpair.first = 0x49;
138 newpair.second = "AssignSystemMaster";
139 mmc_cmd_map.insert (newpair);
141 newpair.first = 0x4A;
142 newpair.second = "GeneratorCommand";
143 mmc_cmd_map.insert (newpair);
145 newpair.first = 0x4B;
146 newpair.second = "MtcCommand";
147 mmc_cmd_map.insert (newpair);
149 newpair.first = 0x4C;
150 newpair.second = "Move";
151 mmc_cmd_map.insert (newpair);
153 newpair.first = 0x4D;
154 newpair.second = "Add";
155 mmc_cmd_map.insert (newpair);
157 newpair.first = 0x4E;
158 newpair.second = "Subtract";
159 mmc_cmd_map.insert (newpair);
161 newpair.first = 0x4F;
162 newpair.second = "DropFrameAdjust";
163 mmc_cmd_map.insert (newpair);
165 newpair.first = 0x50;
166 newpair.second = "Procedure";
167 mmc_cmd_map.insert (newpair);
169 newpair.first = 0x51;
170 newpair.second = "Event";
171 mmc_cmd_map.insert (newpair);
173 newpair.first = 0x52;
174 newpair.second = "Group";
175 mmc_cmd_map.insert (newpair);
177 newpair.first = 0x53;
178 newpair.second = "CommandSegment";
179 mmc_cmd_map.insert (newpair);
181 newpair.first = 0x54;
182 newpair.second = "DeferredVariablePlay";
183 mmc_cmd_map.insert (newpair);
185 newpair.first = 0x55;
186 newpair.second = "RecordStrobeVariable";
187 mmc_cmd_map.insert (newpair);
189 newpair.first = 0x7C;
190 newpair.second = "Wait";
191 mmc_cmd_map.insert (newpair);
193 newpair.first = 0x7F;
194 newpair.second = "Resume";
195 mmc_cmd_map.insert (newpair);
199 MachineControl::MachineControl (Manager* m, jack_client_t* jack)
201 build_mmc_cmd_map ();
203 _receive_device_id = 0x7f;
204 _send_device_id = 0x7f;
206 _input_port = m->add_port (new JackMIDIPort ("MMC in", Port::IsInput, jack));
207 _output_port = m->add_port (new JackMIDIPort ("MMC out", Port::IsOutput, jack));
209 _input_port->parser()->mmc.connect_same_thread (port_connections, boost::bind (&MachineControl::process_mmc_message, this, _1, _2, _3));
210 _input_port->parser()->start.connect_same_thread (port_connections, boost::bind (&MachineControl::spp_start, this));
211 _input_port->parser()->contineu.connect_same_thread (port_connections, boost::bind (&MachineControl::spp_continue, this));
212 _input_port->parser()->stop.connect_same_thread (port_connections, boost::bind (&MachineControl::spp_stop, this));
216 MachineControl::set_receive_device_id (byte id)
218 _receive_device_id = id & 0x7f;
222 MachineControl::set_send_device_id (byte id)
224 _send_device_id = id & 0x7f;
228 MachineControl::is_mmc (byte *sysex_buf, size_t len)
230 if (len < 4 || len > 48) {
234 if (sysex_buf[1] != 0x7f) {
238 if (sysex_buf[3] != 0x6 && /* MMC Command */
239 sysex_buf[3] != 0x7) { /* MMC Response */
247 MachineControl::process_mmc_message (Parser &, byte *msg, size_t len)
253 /* Reject if its not for us. 0x7f is the "all-call" device ID */
255 /* msg[0] = 0x7f (MMC sysex ID(
257 msg[2] = 0x6 (MMC command) or 0x7 (MMC response)
258 msg[3] = MMC command code
259 msg[4] = (typically) byte count for following part of command
263 cerr << "*** me = " << (int) _receive_device_id << " MMC message: len = " << len << "\n\t";
264 for (size_t i = 0; i < len; i++) {
265 cerr << hex << (int) msg[i] << dec << ' ';
270 if (msg[1] != 0x7f && msg[1] != _receive_device_id) {
281 /* this works for all non-single-byte "counted"
282 commands. we set it to 1 for the exceptions.
285 std::map<int,string>::iterator x = mmc_cmd_map.find ((int)mmc_msg[0]);
286 string cmdname = "unknown";
288 if (x != mmc_cmd_map.end()) {
289 cmdname = (*x).second;
293 cerr << "+++ MMC type "
297 << " \"" << cmdname << "\" "
304 /* SINGLE-BYTE, UNCOUNTED COMMANDS */
316 case cmdDeferredPlay:
317 DeferredPlay (*this);
331 case cmdRecordStrobe:
332 RecordStrobe (*this);
361 case cmdCommandErrorReset:
362 CommandErrorReset (*this);
371 case cmdIllegalMackieJogStart:
376 case cmdIllegalMackieJogStop:
381 /* END OF SINGLE-BYTE, UNCOUNTED COMMANDS */
384 do_masked_write (mmc_msg, len);
388 do_locate (mmc_msg, len);
392 do_shuttle (mmc_msg, len);
396 do_step (mmc_msg, len);
402 case cmdVariablePlay:
404 case cmdAssignSystemMaster:
405 case cmdGeneratorCommand:
410 case cmdDropFrameAdjust:
414 case cmdCommandSegment:
415 case cmdDeferredVariablePlay:
416 case cmdRecordStrobeVariable:
419 error << "MIDI::MachineControl: unimplemented MMC command "
420 << hex << (int) *mmc_msg << dec
426 error << "MIDI::MachineControl: unknown MMC command "
427 << hex << (int) *mmc_msg << dec
433 /* increase skiplen to cover the command byte and
434 count byte (if it existed).
438 skiplen = mmc_msg[1] + 2;
443 if (len <= skiplen) {
450 } while (len > 1); /* skip terminating EOX byte */
454 MachineControl::do_masked_write (byte *msg, size_t len)
456 /* return the number of bytes "consumed" */
458 int retval = msg[1] + 2; /* bytes following + 2 */
461 case 0x4f: /* Track Record Ready Status */
462 write_track_status (&msg[3], len - 3, msg[2]);
465 case 0x62: /* track mute */
466 write_track_status (&msg[3], len - 3, msg[2]);
470 warning << "MIDI::MachineControl: masked write to "
471 << hex << (int) msg[2] << dec
472 << " not implemented"
480 MachineControl::write_track_status (byte *msg, size_t /*len*/, byte reg)
485 /* Bits 0-4 of the first byte are for special tracks:
493 the format of the message (its an MMC Masked Write) is:
496 <count> byte count of following data
497 <name> byte value of the field being written
498 <byte #> byte number of target byte in the
499 bitmap being written to
500 <mask> ones in the mask indicate which bits will be changed
501 <data> new data for the byte being written
503 by the time this code is executing, msg[0] is the
504 byte number of the target byte. if its zero, we
505 are writing to a special byte in the standard
506 track bitmap, in which the first 5 bits are
507 special. hence the bits for tracks 1 + 2 are bits
508 5 and 6 of the first byte of the track
511 change track 1: msg[0] = 0; << first byte of track bitmap
512 msg[1] = 0100000; << binary: bit 5 set
514 change track 2: msg[0] = 0; << first byte of track bitmap
515 msg[1] = 1000000; << binary: bit 6 set
517 change track 3: msg[0] = 1; << second byte of track bitmap
518 msg[1] = 0000001; << binary: bit 0 set
520 the (msg[0] * 8) - 6 computation is an attempt to
521 extract the value of the first track: ie. the one
522 that would be indicated by bit 0 being set.
524 so, if msg[0] = 0, msg[1] = 0100000 (binary),
525 what happens is that base_track = -5, but by the
526 time we check the correct bit, n = 5, and so the
527 computed track for the status change is 0 (first
530 if msg[0] = 1, then the base track for any change is 2 (the third track), and so on.
533 /* XXX check needed to make sure we don't go outside the
534 supported number of tracks.
540 base_track = (msg[0] * 8) - 6;
543 for (n = 0; n < 7; n++) {
544 if (msg[1] & (1<<n)) {
546 /* Only touch tracks that have the "mask"
550 bool val = (msg[2] & (1<<n));
554 trackRecordStatus[base_track+n] = val;
555 TrackRecordStatusChange (*this, base_track+n, val);
559 trackMute[base_track+n] = val;
560 TrackMuteChange (*this, base_track+n, val);
569 MachineControl::do_locate (byte *msg, size_t /*msglen*/)
572 warning << "MIDI::MMC: locate [I/F] command not supported"
577 /* regular "target" locate command */
579 Locate (*this, &msg[3]);
584 MachineControl::do_step (byte *msg, size_t /*msglen*/)
586 int steps = msg[2] & 0x3f;
597 MachineControl::do_shuttle (byte *msg, size_t /*msglen*/)
614 left_shift = (sh & 0x38);
616 integral = ((sh & 0x7) << left_shift) | (sm >> (7 - left_shift));
617 fractional = ((sm << left_shift) << 7) | sl;
619 shuttle_speed = integral +
620 ((float)fractional / (1 << (14 - left_shift)));
622 Shuttle (*this, shuttle_speed, forward);
628 MachineControl::enable_send (bool yn)
633 /** Send a MMC command to a the MMC port.
637 MachineControl::send (MachineControlCommand const & c)
639 if (_output_port == 0 || !_enable_send) {
640 // cerr << "Not delivering MMC " << _mmc->port() << " - " << session_send_mmc << endl;
644 MIDI::byte buffer[32];
645 MIDI::byte* b = c.fill_buffer (this, buffer);
647 if (_output_port->midimsg (buffer, b - buffer, 0)) {
648 error << "MMC: cannot send command" << endmsg;
653 MachineControl::spp_start ()
655 SPPStart (); /* EMIT SIGNAL */
659 MachineControl::spp_continue ()
661 SPPContinue (); /* EMIT SIGNAL */
665 MachineControl::spp_stop ()
667 SPPStop (); /* EMIT SIGNAL */
670 MachineControlCommand::MachineControlCommand (MachineControl::Command c)
676 MachineControlCommand::MachineControlCommand (Timecode::Time t)
677 : _command (MachineControl::cmdLocate)
684 MachineControlCommand::fill_buffer (MachineControl* mmc, MIDI::byte* b) const
686 *b++ = 0xf0; // SysEx
687 *b++ = 0x7f; // Real-time SysEx ID for MMC
688 *b++ = mmc->send_device_id();
689 *b++ = 0x6; // MMC command
693 if (_command == MachineControl::cmdLocate) {
694 *b++ = 0x6; // byte count
695 *b++ = 0x1; // "TARGET" subcommand
697 *b++ = _time.minutes;
698 *b++ = _time.seconds;
700 *b++ = _time.subframes;