libs/ardour/ardour/midi_ring_buffer.h

   1 /*
   2     Copyright (C) 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 #ifndef __ardour_midi_ring_buffer_h__
  20 #define __ardour_midi_ring_buffer_h__
  21
  22 #include <iostream>
  23 #include <algorithm>
  24
  25 #include "evoral/EventRingBuffer.hpp"
  26
  27 #include "ardour/types.h"
  28 #include "ardour/midi_state_tracker.h"
  29
  30 namespace ARDOUR {
  31
  32 class MidiBuffer;
  33
  34 /** A RingBuffer for (MIDI) events.
  35  *
  36  * This is simply a wrapper around a raw ringbuffer which writes/reads events
  37  * as flat placked blobs.
  38  * The buffer looks like this:
  39  *
  40  * [timestamp][type][size][size bytes of raw MIDI][timestamp][type][size](etc...)
  41  */
  42 template<typename T>
  43 class MidiRingBuffer : public Evoral::EventRingBuffer<T> {
  44 public:
  45         /** @param size Size in bytes.
  46          */
  47         MidiRingBuffer(size_t size)
  48                 : Evoral::EventRingBuffer<T>(size) {}
  49
  50         inline bool read_prefix(T* time, Evoral::EventType* type, uint32_t* size);
  51         inline bool read_contents(uint32_t size, uint8_t* buf);
  52
  53         size_t read(MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset=0, bool stop_on_overflow_in_destination=false);
  54
  55         void dump(std::ostream& dst);
  56         void flush (framepos_t start, framepos_t end);
  57
  58         void reset_tracker ();
  59         void loop_resolve (MidiBuffer& dst, framepos_t);
  60
  61 protected:
  62         inline bool is_channel_event(uint8_t event_type_byte) {
  63                 // mask out channel information
  64                 event_type_byte &= 0xF0;
  65                 // midi channel events range from 0x80 to 0xE0
  66                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
  67         }
  68
  69         inline bool is_note_on(uint8_t event_type_byte) {
  70                 // mask out channel information
  71                 return (event_type_byte & 0xF0) == MIDI_CMD_NOTE_ON;
  72         }
  73
  74         inline bool is_note_off(uint8_t event_type_byte) {
  75                 // mask out channel information
  76                 return (event_type_byte & 0xF0) == MIDI_CMD_NOTE_OFF;
  77         }
  78
  79 private:
  80         MidiStateTracker _tracker;
  81 };
  82
  83
  84 /** Read the time and size of an event.  This call MUST be immediately proceeded
  85  * by a call to read_contents (or the read pointer will be garbage).
  86  */
  87 template<typename T>
  88 inline bool
  89 MidiRingBuffer<T>::read_prefix(T* time, Evoral::EventType* type, uint32_t* size)
  90 {
  91         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)time, sizeof(T)) != sizeof (T)) {
  92                 return false;
  93         }
  94
  95         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)type, sizeof(Evoral::EventType)) != sizeof (Evoral::EventType)) {
  96                 return false;
  97         }
  98
  99         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)size, sizeof(uint32_t)) != sizeof (uint32_t)) {
 100                 return false;
 101         }
 102
 103         return true;
 104 }
 105
 106
 107 /** Read the content of an event.  This call MUST be immediately preceded
 108  * by a call to read_prefix (or the returned even will be garbage).
 109  */
 110 template<typename T>
 111 inline bool
 112 MidiRingBuffer<T>::read_contents(uint32_t size, uint8_t* buf)
 113 {
 114         return PBD::RingBufferNPT<uint8_t>::read(buf, size) == size;
 115 }
 116
 117 } // namespace ARDOUR
 118
 119 #endif // __ardour_midi_ring_buffer_h__
 120