libs/midi++2/midi++/parser.h

   1 /*
   2     Copyright (C) 1998 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 */
  19
  20 #ifndef  __midi_parse_h__
  21 #define  __midi_parse_h__
  22
  23 #include <string>
  24 #include <iostream>
  25
  26 #include "pbd/signals.h"
  27
  28 #include "midi++/libmidi_visibility.h"
  29 #include "midi++/types.h"
  30
  31 namespace MIDI {
  32
  33 class Port;
  34 class Parser;
  35
  36 typedef PBD::Signal1<void,Parser&>                   ZeroByteSignal;
  37 typedef PBD::Signal2<void,Parser&,unsigned short>    BankSignal;
  38 typedef PBD::Signal2<void,Parser&,framecnt_t>        TimestampedSignal;
  39 typedef PBD::Signal2<void,Parser&, byte>             OneByteSignal;
  40 typedef PBD::Signal2<void,Parser &, EventTwoBytes *> TwoByteSignal;
  41 typedef PBD::Signal2<void,Parser &, pitchbend_t>     PitchBendSignal;
  42 typedef PBD::Signal3<void,Parser &, byte *, size_t>  Signal;
  43
  44 class LIBMIDIPP_API Parser {
  45  public:
  46         Parser ();
  47         ~Parser ();
  48
  49         /* sets the time that will be reported for any MTC or MIDI Clock
  50            message the next time ::scanner() parses such a message. It should
  51            therefore be set before every byte passed into ::scanner().
  52         */
  53
  54         framecnt_t get_timestamp() const { return _timestamp; }
  55         void set_timestamp (const framecnt_t timestamp) { _timestamp = timestamp; }
  56
  57         /* signals that anyone can connect to */
  58
  59         BankSignal            bank_change;
  60         TwoByteSignal         note_on;
  61         TwoByteSignal         note_off;
  62         TwoByteSignal         poly_pressure;
  63         OneByteSignal         pressure;
  64         OneByteSignal         program_change;
  65         PitchBendSignal       pitchbend;
  66         TwoByteSignal         controller;
  67
  68         BankSignal            channel_bank_change[16];
  69         TwoByteSignal         channel_note_on[16];
  70         TwoByteSignal         channel_note_off[16];
  71         TwoByteSignal         channel_poly_pressure[16];
  72         OneByteSignal         channel_pressure[16];
  73         OneByteSignal         channel_program_change[16];
  74         PitchBendSignal       channel_pitchbend[16];
  75         TwoByteSignal         channel_controller[16];
  76         ZeroByteSignal        channel_active_preparse[16];
  77         ZeroByteSignal        channel_active_postparse[16];
  78
  79         OneByteSignal         mtc_quarter_frame; /* see below for more useful signals */
  80         Signal                mtc;
  81         Signal                raw_preparse;
  82         Signal                raw_postparse;
  83         Signal                any;
  84         Signal                sysex;
  85         Signal                mmc;
  86         Signal                position;
  87         Signal                song;
  88
  89         ZeroByteSignal        all_notes_off;
  90         ZeroByteSignal        tune;
  91         ZeroByteSignal        active_sense;
  92         ZeroByteSignal        reset;
  93         ZeroByteSignal        eox;
  94
  95         TimestampedSignal     timing;
  96         TimestampedSignal     start;
  97         TimestampedSignal     stop;
  98         TimestampedSignal     contineu;  /* note spelling */
  99
 100         /* This should really be protected, but then derivatives of Port
 101            can't access it.
 102         */
 103
 104         void scanner (byte c);
 105
 106         size_t *message_counts() { return message_counter; }
 107         const char *midi_event_type_name (MIDI::eventType);
 108         void trace (bool onoff, std::ostream *o, const std::string &prefix = "");
 109         bool tracing() { return trace_stream != 0; }
 110
 111         void set_offline (bool);
 112         bool offline() const { return _offline; }
 113         PBD::Signal0<void> OfflineStatusChanged;
 114
 115         PBD::Signal2<int,byte *, size_t> edit;
 116
 117         void set_mmc_forwarding (bool yn) {
 118                 _mmc_forward = yn;
 119         }
 120
 121         /* MTC */
 122
 123         MTC_FPS mtc_fps() const { return _mtc_fps; }
 124         MTC_Status  mtc_running() const { return _mtc_running; }
 125         const byte *mtc_current() const { return _mtc_time; }
 126         bool        mtc_locked() const  { return _mtc_locked; }
 127
 128         PBD::Signal3<void, Parser &, int, framecnt_t>      mtc_qtr;
 129         PBD::Signal3<void, const byte *, bool, framecnt_t> mtc_time;
 130         PBD::Signal1<void, MTC_Status>                     mtc_status;
 131         PBD::Signal0<bool>                                 mtc_skipped;
 132
 133         void set_mtc_forwarding (bool yn) {
 134                 _mtc_forward = yn;
 135         }
 136
 137         void reset_mtc_state ();
 138
 139   private:
 140         /* tracing */
 141
 142         std::ostream *trace_stream;
 143         std::string trace_prefix;
 144         void trace_event (Parser &p, byte *msg, size_t len);
 145         PBD::ScopedConnection trace_connection;
 146
 147         size_t message_counter[256];
 148
 149         enum ParseState {
 150                 NEEDSTATUS,
 151                 NEEDONEBYTE,
 152                 NEEDTWOBYTES,
 153                 VARIABLELENGTH
 154         };
 155         ParseState state;
 156         unsigned char *msgbuf;
 157         int msglen;
 158         int msgindex;
 159         MIDI::eventType msgtype;
 160         channel_t channel;
 161         bool _offline;
 162         bool runnable;
 163         bool was_runnable;
 164         bool _mmc_forward;
 165         bool _mtc_forward;
 166         int   expected_mtc_quarter_frame_code;
 167         byte _mtc_time[5];
 168         byte _qtr_mtc_time[5];
 169         unsigned long consecutive_qtr_frame_cnt;
 170         MTC_FPS _mtc_fps;
 171         MTC_Status _mtc_running;
 172         bool       _mtc_locked;
 173         byte last_qtr_frame;
 174
 175         framecnt_t _timestamp;
 176
 177         ParseState pre_variable_state;
 178         MIDI::eventType pre_variable_msgtype;
 179         byte last_status_byte;
 180
 181         void channel_msg (byte);
 182         void realtime_msg (byte);
 183         void system_msg (byte);
 184         void signal (byte *msg, size_t msglen);
 185         bool possible_mmc (byte *msg, size_t msglen);
 186         bool possible_mtc (byte *msg, size_t msglen);
 187         void process_mtc_quarter_frame (byte *msg);
 188 };
 189
 190 } // namespace MIDI
 191
 192 #endif   // __midi_parse_h__
 193