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/buffer.h"
  29 #include "ardour/midi_state_tracker.h"
  30
  31 namespace ARDOUR {
  32
  33 class MidiBuffer;
  34
  35 /** A RingBuffer for (MIDI) events.
  36  *
  37  * This is simply a wrapper around a raw ringbuffer which writes/reads events
  38  * as flat placked blobs.
  39  * The buffer looks like this:
  40  *
  41  * [timestamp][type][size][size bytes of raw MIDI][timestamp][type][size](etc...)
  42  */
  43 template<typename T>
  44 class MidiRingBuffer : public Evoral::EventRingBuffer<T> {
  45 public:
  46         /** @param size Size in bytes.
  47          */
  48         MidiRingBuffer(size_t size)
  49                 : Evoral::EventRingBuffer<T>(size)
  50                 , _channel_mask(0x0000FFFF)
  51         {}
  52
  53         inline bool read_prefix(T* time, Evoral::EventType* type, uint32_t* size);
  54         inline bool read_contents(uint32_t size, uint8_t* buf);
  55
  56         size_t read(MidiBuffer& dst, framepos_t start, framepos_t end, framecnt_t offset=0, bool stop_on_overflow_in_destination=false);
  57         void dump(std::ostream& dst);
  58
  59         /** Set the channel filtering mode.
  60          * @param mask If mode is FilterChannels, each bit represents a midi channel:
  61          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
  62          *     process events whose channel bit is 1.
  63          *     If mode is ForceChannel, mask is simply a channel number which all events will
  64          *     be forced to while reading.
  65          */
  66         void set_channel_mode(ChannelMode mode, uint16_t mask) {
  67                 g_atomic_int_set(&_channel_mask, (uint32_t(mode) << 16) | uint32_t(mask));
  68         }
  69
  70         ChannelMode get_channel_mode() const {
  71                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
  72         }
  73
  74         uint16_t get_channel_mask() const {
  75                 return g_atomic_int_get(&_channel_mask) & 0x0000FFFF;
  76         }
  77
  78         void reset_tracker ();
  79
  80 protected:
  81         inline bool is_channel_event(uint8_t event_type_byte) {
  82                 // mask out channel information
  83                 event_type_byte &= 0xF0;
  84                 // midi channel events range from 0x80 to 0xE0
  85                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
  86         }
  87
  88         inline bool is_note_on(uint8_t event_type_byte) {
  89                 // mask out channel information
  90                 return (event_type_byte & 0xF0) == MIDI_CMD_NOTE_ON;
  91         }
  92
  93         inline bool is_note_off(uint8_t event_type_byte) {
  94                 // mask out channel information
  95                 return (event_type_byte & 0xF0) == MIDI_CMD_NOTE_OFF;
  96         }
  97
  98 private:
  99         volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
 100         MidiStateTracker _tracker;
 101 };
 102
 103
 104 /** Read the time and size of an event.  This call MUST be immediately proceeded
 105  * by a call to read_contents (or the read pointer will be garbage).
 106  */
 107 template<typename T>
 108 inline bool
 109 MidiRingBuffer<T>::read_prefix(T* time, Evoral::EventType* type, uint32_t* size)
 110 {
 111         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)time, sizeof(T)) != sizeof (T)) {
 112                 return false;
 113         }
 114
 115         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)type, sizeof(Evoral::EventType)) != sizeof (Evoral::EventType)) {
 116                 return false;
 117         }
 118
 119         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)size, sizeof(uint32_t)) != sizeof (uint32_t)) {
 120                 return false;
 121         }
 122
 123         return true;
 124 }
 125
 126
 127 /** Read the content of an event.  This call MUST be immediately preceded
 128  * by a call to read_prefix (or the returned even will be garbage).
 129  */
 130 template<typename T>
 131 inline bool
 132 MidiRingBuffer<T>::read_contents(uint32_t size, uint8_t* buf)
 133 {
 134         return PBD::RingBufferNPT<uint8_t>::read(buf, size) == size;
 135 }
 136
 137
 138 } // namespace ARDOUR
 139
 140 #endif // __ardour_midi_ring_buffer_h__
 141