libs/midi++2/mmc.cc

   1 /*
   2     Copyright (C) 2000 Paul Barton-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     $Id$
  19 */
  20
  21 #include <map>
  22
  23 #include <pbd/error.h>
  24 #include <midi++/mmc.h>
  25 #include <midi++/port.h>
  26 #include <midi++/parser.h>
  27
  28 using namespace std;
  29 using namespace MIDI;
  30 using namespace PBD;
  31
  32 static std::map<int,string> mmc_cmd_map;
  33 static void build_mmc_cmd_map ()
  34 {
  35         pair<int,string> newpair;
  36
  37         newpair.first = 0x1;
  38         newpair.second = "Stop";
  39         mmc_cmd_map.insert (newpair);
  40
  41         newpair.first = 0x2;
  42         newpair.second = "Play";
  43         mmc_cmd_map.insert (newpair);
  44
  45         newpair.first = 0x3;
  46         newpair.second = "DeferredPlay";
  47         mmc_cmd_map.insert (newpair);
  48
  49         newpair.first = 0x4;
  50         newpair.second = "FastForward";
  51         mmc_cmd_map.insert (newpair);
  52
  53         newpair.first = 0x5;
  54         newpair.second = "Rewind";
  55         mmc_cmd_map.insert (newpair);
  56
  57         newpair.first = 0x6;
  58         newpair.second = "RecordStrobe";
  59         mmc_cmd_map.insert (newpair);
  60
  61         newpair.first = 0x7;
  62         newpair.second = "RecordExit";
  63         mmc_cmd_map.insert (newpair);
  64
  65         newpair.first = 0x8;
  66         newpair.second = "RecordPause";
  67         mmc_cmd_map.insert (newpair);
  68
  69         newpair.first = 0x9;
  70         newpair.second = "Pause";
  71         mmc_cmd_map.insert (newpair);
  72
  73         newpair.first = 0xA;
  74         newpair.second = "Eject";
  75         mmc_cmd_map.insert (newpair);
  76
  77         newpair.first = 0xB;
  78         newpair.second = "Chase";
  79         mmc_cmd_map.insert (newpair);
  80
  81         newpair.first = 0xC;
  82         newpair.second = "CommandErrorReset";
  83         mmc_cmd_map.insert (newpair);
  84
  85         newpair.first = 0xD;
  86         newpair.second = "MmcReset";
  87         mmc_cmd_map.insert (newpair);
  88
  89         newpair.first = 0x20;
  90         newpair.second = "Illegal Mackie Jog Start";
  91         mmc_cmd_map.insert (newpair);
  92
  93         newpair.first = 0x21;
  94         newpair.second = "Illegal Mackie Jog Stop";
  95         mmc_cmd_map.insert (newpair);
  96
  97         newpair.first = 0x40;
  98         newpair.second = "Write";
  99         mmc_cmd_map.insert (newpair);
 100
 101         newpair.first = 0x41;
 102         newpair.second = "MaskedWrite";
 103         mmc_cmd_map.insert (newpair);
 104
 105         newpair.first = 0x42;
 106         newpair.second = "Read";
 107         mmc_cmd_map.insert (newpair);
 108
 109         newpair.first = 0x43;
 110         newpair.second = "Update";
 111         mmc_cmd_map.insert (newpair);
 112
 113         newpair.first = 0x44;
 114         newpair.second = "Locate";
 115         mmc_cmd_map.insert (newpair);
 116
 117         newpair.first = 0x45;
 118         newpair.second = "VariablePlay";
 119         mmc_cmd_map.insert (newpair);
 120
 121         newpair.first = 0x46;
 122         newpair.second = "Search";
 123         mmc_cmd_map.insert (newpair);
 124
 125         newpair.first = 0x47;
 126         newpair.second = "Shuttle";
 127         mmc_cmd_map.insert (newpair);
 128
 129         newpair.first = 0x48;
 130         newpair.second = "Step";
 131         mmc_cmd_map.insert (newpair);
 132
 133         newpair.first = 0x49;
 134         newpair.second = "AssignSystemMaster";
 135         mmc_cmd_map.insert (newpair);
 136
 137         newpair.first = 0x4A;
 138         newpair.second = "GeneratorCommand";
 139         mmc_cmd_map.insert (newpair);
 140
 141         newpair.first = 0x4B;
 142         newpair.second = "MtcCommand";
 143         mmc_cmd_map.insert (newpair);
 144
 145         newpair.first = 0x4C;
 146         newpair.second = "Move";
 147         mmc_cmd_map.insert (newpair);
 148
 149         newpair.first = 0x4D;
 150         newpair.second = "Add";
 151         mmc_cmd_map.insert (newpair);
 152
 153         newpair.first = 0x4E;
 154         newpair.second = "Subtract";
 155         mmc_cmd_map.insert (newpair);
 156
 157         newpair.first = 0x4F;
 158         newpair.second = "DropFrameAdjust";
 159         mmc_cmd_map.insert (newpair);
 160
 161         newpair.first = 0x50;
 162         newpair.second = "Procedure";
 163         mmc_cmd_map.insert (newpair);
 164
 165         newpair.first = 0x51;
 166         newpair.second = "Event";
 167         mmc_cmd_map.insert (newpair);
 168
 169         newpair.first = 0x52;
 170         newpair.second = "Group";
 171         mmc_cmd_map.insert (newpair);
 172
 173         newpair.first = 0x53;
 174         newpair.second = "CommandSegment";
 175         mmc_cmd_map.insert (newpair);
 176
 177         newpair.first = 0x54;
 178         newpair.second = "DeferredVariablePlay";
 179         mmc_cmd_map.insert (newpair);
 180
 181         newpair.first = 0x55;
 182         newpair.second = "RecordStrobeVariable";
 183         mmc_cmd_map.insert (newpair);
 184
 185         newpair.first = 0x7C;
 186         newpair.second = "Wait";
 187         mmc_cmd_map.insert (newpair);
 188
 189         newpair.first = 0x7F;
 190         newpair.second = "Resume";
 191         mmc_cmd_map.insert (newpair);
 192 }
 193
 194
 195 MachineControl::MachineControl (Port &p, float version,
 196                                 CommandSignature &csig,
 197                                 ResponseSignature &rsig)
 198
 199         : _port (p)
 200 {
 201         Parser *parser;
 202
 203         build_mmc_cmd_map ();
 204
 205         _receive_device_id = 0;
 206         _send_device_id = 0x7f;
 207
 208         if ((parser = _port.input()) != 0) {
 209                 parser->mmc.connect
 210                         (mem_fun (*this, &MachineControl::process_mmc_message));
 211         } else {
 212                 warning << "MMC connected to a non-input port: useless!"
 213                         << endmsg;
 214         }
 215 }
 216
 217 void
 218 MachineControl::set_receive_device_id (byte id)
 219 {
 220         _receive_device_id = id & 0x7f;
 221 }
 222
 223 void
 224 MachineControl::set_send_device_id (byte id)
 225 {
 226         _send_device_id = id & 0x7f;
 227 }
 228
 229 bool
 230 MachineControl::is_mmc (byte *sysex_buf, size_t len)
 231
 232 {
 233         if (len < 4 || len > 48) {
 234                 return false;
 235         }
 236
 237         if (sysex_buf[1] != 0x7f) {
 238                 return false;
 239         }
 240
 241         if (sysex_buf[3] != 0x6 && /* MMC Command */
 242             sysex_buf[3] != 0x7) { /* MMC Response */
 243                 return false;
 244         }
 245
 246         return true;
 247 }
 248
 249 void
 250 MachineControl::process_mmc_message (Parser &p, byte *msg, size_t len)
 251
 252 {
 253         size_t skiplen;
 254         byte *mmc_msg;
 255         bool single_byte;
 256
 257         /* Reject if its not for us. 0x7f is the "all-call" device ID */
 258
 259         /* msg[0] = 0x7f (MMC sysex ID(
 260            msg[1] = device ID
 261            msg[2] = 0x6 (MMC command) or 0x7 (MMC response)
 262            msg[3] = MMC command code
 263            msg[4] = (typically) byte count for following part of command
 264         */
 265
 266 #if 0
 267         cerr << "*** me = " << (int) _receive_device_id << " MMC message: len = " << len << "\n\t";
 268         for (size_t i = 0; i < len; i++) {
 269                 cerr << hex << (int) msg[i] << dec << ' ';
 270         }
 271         cerr << endl;
 272 #endif
 273
 274         if (msg[1] != 0x7f && msg[1] != _receive_device_id) {
 275                 return;
 276         }
 277
 278         mmc_msg = &msg[3];
 279         len -= 3;
 280
 281         do {
 282
 283                 single_byte = false;
 284
 285                 /* this works for all non-single-byte "counted"
 286                    commands. we set it to 1 for the exceptions.
 287                 */
 288
 289                 std::map<int,string>::iterator x = mmc_cmd_map.find ((int)mmc_msg[0]);
 290                 string cmdname = "unknown";
 291
 292                 if (x != mmc_cmd_map.end()) {
 293                         cmdname = (*x).second;
 294                 }
 295
 296 #if 0
 297                 cerr << "+++ MMC type "
 298                      << hex
 299                      << ((int) *mmc_msg)
 300                      << dec
 301                      << " \"" << cmdname << "\" "
 302                      << " len = " << len
 303                      << endl;
 304 #endif
 305
 306                 switch (*mmc_msg) {
 307
 308                 /* SINGLE-BYTE, UNCOUNTED COMMANDS */
 309
 310                 case cmdStop:
 311                         Stop (*this);
 312                         single_byte = true;
 313                         break;
 314
 315                 case cmdPlay:
 316                         Play (*this);
 317                         single_byte = true;
 318                         break;
 319
 320                 case cmdDeferredPlay:
 321                         DeferredPlay (*this);
 322                         single_byte = true;
 323                         break;
 324
 325                 case cmdFastForward:
 326                         FastForward (*this);
 327                         single_byte = true;
 328                         break;
 329
 330                 case cmdRewind:
 331                         Rewind (*this);
 332                         single_byte = true;
 333                         break;
 334
 335                 case cmdRecordStrobe:
 336                         RecordStrobe (*this);
 337                         single_byte = true;
 338                         break;
 339
 340                 case cmdRecordExit:
 341                         RecordExit (*this);
 342                         single_byte = true;
 343                         break;
 344
 345                 case cmdRecordPause:
 346                         RecordPause (*this);
 347                         single_byte = true;
 348                         break;
 349
 350                 case cmdPause:
 351                         Pause (*this);
 352                         single_byte = true;
 353                         break;
 354
 355                 case cmdEject:
 356                         Eject (*this);
 357                         single_byte = true;
 358                         break;
 359
 360                 case cmdChase:
 361                         Chase (*this);
 362                         single_byte = true;
 363                         break;
 364
 365                 case cmdCommandErrorReset:
 366                         CommandErrorReset (*this);
 367                         single_byte = true;
 368                         break;
 369
 370                 case cmdMmcReset:
 371                         MmcReset (*this);
 372                         single_byte = true;
 373                         break;
 374
 375                 case cmdIllegalMackieJogStart:
 376                         JogStart (*this);
 377                         single_byte = true;
 378                         break;
 379
 380                 case cmdIllegalMackieJogStop:
 381                         JogStop (*this);
 382                         single_byte = true;
 383                         break;
 384
 385                 /* END OF SINGLE-BYTE, UNCOUNTED COMMANDS */
 386
 387                 case cmdMaskedWrite:
 388                         do_masked_write (mmc_msg, len);
 389                         break;
 390
 391                 case cmdLocate:
 392                         do_locate (mmc_msg, len);
 393                         break;
 394
 395                 case cmdShuttle:
 396                         do_shuttle (mmc_msg, len);
 397                         break;
 398
 399                 case cmdStep:
 400                         do_step (mmc_msg, len);
 401                         break;
 402
 403                 case cmdWrite:
 404                 case cmdRead:
 405                 case cmdUpdate:
 406                 case cmdVariablePlay:
 407                 case cmdSearch:
 408                 case cmdAssignSystemMaster:
 409                 case cmdGeneratorCommand:
 410                 case cmdMtcCommand:
 411                 case cmdMove:
 412                 case cmdAdd:
 413                 case cmdSubtract:
 414                 case cmdDropFrameAdjust:
 415                 case cmdProcedure:
 416                 case cmdEvent:
 417                 case cmdGroup:
 418                 case cmdCommandSegment:
 419                 case cmdDeferredVariablePlay:
 420                 case cmdRecordStrobeVariable:
 421                 case cmdWait:
 422                 case cmdResume:
 423                         error << "MIDI::MachineControl: unimplemented MMC command "
 424                               << hex << (int) *mmc_msg << dec
 425                               << endmsg;
 426
 427                         break;
 428
 429                 default:
 430                         error << "MIDI::MachineControl: unknown MMC command "
 431                               << hex << (int) *mmc_msg << dec
 432                               << endmsg;
 433
 434                         break;
 435                 }
 436
 437                 /* increase skiplen to cover the command byte and
 438                    count byte (if it existed).
 439                 */
 440
 441                 if (!single_byte) {
 442                         skiplen = mmc_msg[1] + 2;
 443                 } else {
 444                         skiplen = 1;
 445                 }
 446
 447                 if (len <= skiplen) {
 448                         break;
 449                 }
 450
 451                 mmc_msg += skiplen;
 452                 len -= skiplen;
 453
 454         } while (len > 1); /* skip terminating EOX byte */
 455 }
 456
 457 int
 458 MachineControl::do_masked_write (byte *msg, size_t len)
 459
 460 {
 461         /* return the number of bytes "consumed" */
 462
 463         int retval = msg[1] + 2; /* bytes following + 2 */
 464
 465         switch (msg[2]) {
 466         case 0x4f:  /* Track Record Ready Status */
 467                 write_track_record_ready (&msg[3], len - 3);
 468                 break;
 469
 470         default:
 471                 warning << "MIDI::MachineControl: masked write to "
 472                         << hex << (int) msg[2] << dec
 473                         << " not implemented"
 474                         << endmsg;
 475         }
 476
 477         return retval;
 478 }
 479
 480 void
 481 MachineControl::write_track_record_ready (byte *msg, size_t len)
 482
 483 {
 484         size_t n;
 485         ssize_t base_track;
 486
 487         /* Bits 0-4 of the first byte are for special tracks:
 488
 489            bit 0: video
 490            bit 1: reserved
 491            bit 2: time code
 492            bit 3: aux track a
 493            bit 4: aux track b
 494
 495            the format of the message (its an MMC Masked Write) is:
 496
 497            0x41      Command Code
 498            <count>   byte count of following data
 499            <name>    byte value of the field being written
 500            <byte #>  byte number of target byte in the
 501            bitmap being written to
 502            <mask>    ones in the mask indicate which bits will be changed
 503            <data>    new data for the byte being written
 504
 505            by the time this code is executing, msg[0] is the
 506            byte number of the target byte. if its zero, we
 507            are writing to a special byte in the standard
 508            track bitmap, in which the first 5 bits are
 509            special. hence the bits for tracks 1 + 2 are bits
 510            5 and 6 of the first byte of the track
 511            bitmap. so:
 512
 513            change track 1:  msg[0] = 0;       << first byte of track bitmap
 514                             msg[1] = 0100000; << binary: bit 5 set
 515
 516            change track 2:  msg[0] = 0;       << first byte of track bitmap
 517                             msg[1] = 1000000; << binary: bit 6 set
 518
 519            change track 3:  msg[0] = 1;       << second byte of track bitmap
 520                             msg[1] = 0000001; << binary: bit 0 set
 521
 522            the (msg[0] * 8) - 6 computation is an attempt to
 523            extract the value of the first track: ie. the one
 524            that would be indicated by bit 0 being set.
 525
 526            so, if msg[0] = 0, msg[1] = 0100000 (binary),
 527            what happens is that base_track = -5, but by the
 528            time we check the correct bit, n = 5, and so the
 529            computed track for the status change is 0 (first
 530            track).
 531
 532            if msg[0] = 1, then the base track for any change is 2 (the third track), and so on.
 533         */
 534
 535         /* XXX check needed to make sure we don't go outside the
 536            supported number of tracks.
 537         */
 538
 539         if (msg[0] == 0) {
 540                 base_track = -5;
 541         } else {
 542                 base_track = (msg[0] * 8) - 6;
 543         }
 544
 545         for (n = 0; n < 7; n++) {
 546                 if (msg[1] & (1<<n)) {
 547
 548                         /* Only touch tracks that have the "mask"
 549                            bit set.
 550                         */
 551
 552                         if (msg[2] & (1<<n)) {
 553                                 trackRecordStatus[base_track+n] = true;
 554                                 TrackRecordStatusChange (*this, base_track+n,
 555                                                          true);
 556                         } else {
 557                                 trackRecordStatus[base_track+n] = false;
 558                                 TrackRecordStatusChange (*this, base_track+n,
 559                                                          false);
 560                         }
 561                 }
 562
 563         }
 564 }
 565
 566 int
 567 MachineControl::do_locate (byte *msg, size_t msglen)
 568
 569 {
 570         if (msg[2] == 0) {
 571                 warning << "MIDI::MMC: locate [I/F] command not supported"
 572                         << endmsg;
 573                 return 0;
 574         }
 575
 576         /* regular "target" locate command */
 577
 578         Locate (*this, &msg[3]);
 579         return 0;
 580 }
 581
 582 int
 583 MachineControl::do_step (byte *msg, size_t msglen)
 584 {
 585         int steps = msg[2] & 0x3f;
 586
 587         if (msg[2] & 0x40) {
 588                 steps = -steps;
 589         }
 590
 591         Step (*this, steps);
 592         return 0;
 593 }
 594
 595 int
 596 MachineControl::do_shuttle (byte *msg, size_t msglen)
 597
 598 {
 599         size_t forward;
 600         byte sh = msg[2];
 601         byte sm = msg[3];
 602         byte sl = msg[4];
 603         size_t left_shift;
 604         size_t integral;
 605         size_t fractional;
 606         float shuttle_speed;
 607
 608         if (sh & (1<<6)) {
 609                 forward = false;
 610         } else {
 611                 forward = true;
 612         }
 613
 614         left_shift = (sh & 0x38);
 615
 616         integral = ((sh & 0x7) << left_shift) | (sm >> (7 - left_shift));
 617         fractional = ((sm << left_shift) << 7) | sl;
 618
 619         shuttle_speed = integral +
 620                 ((float)fractional / (1 << (14 - left_shift)));
 621
 622         Shuttle (*this, shuttle_speed, forward);
 623
 624         return 0;
 625 }
 626