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         inline uint32_t write(T  time, Evoral::EventType  type, uint32_t  size, const uint8_t* buf);
  58
  59         void dump(std::ostream& dst);
  60         void flush (framepos_t start, framepos_t end);
  61
  62         /** Set the channel filtering mode.
  63          * @param mask If mode is FilterChannels, each bit represents a midi channel:
  64          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
  65          *     process events whose channel bit is 1.
  66          *     If mode is ForceChannel, mask is simply a channel number which all events will
  67          *     be forced to while reading.
  68          */
  69         void set_channel_mode(ChannelMode mode, uint16_t mask) {
  70                 g_atomic_int_set(&_channel_mask, (uint32_t(mode) << 16) | uint32_t(mask));
  71         }
  72
  73         ChannelMode get_channel_mode() const {
  74                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
  75         }
  76
  77         uint16_t get_channel_mask() const {
  78                 return g_atomic_int_get(&_channel_mask) & 0x0000FFFF;
  79         }
  80
  81         void reset_tracker ();
  82
  83 protected:
  84         inline bool is_channel_event(uint8_t event_type_byte) {
  85                 // mask out channel information
  86                 event_type_byte &= 0xF0;
  87                 // midi channel events range from 0x80 to 0xE0
  88                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
  89         }
  90
  91         inline bool is_note_on(uint8_t event_type_byte) {
  92                 // mask out channel information
  93                 return (event_type_byte & 0xF0) == MIDI_CMD_NOTE_ON;
  94         }
  95
  96         inline bool is_note_off(uint8_t event_type_byte) {
  97                 // mask out channel information
  98                 return (event_type_byte & 0xF0) == MIDI_CMD_NOTE_OFF;
  99         }
 100
 101 private:
 102         volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
 103         MidiStateTracker _tracker;
 104 };
 105
 106
 107 /** Read the time and size of an event.  This call MUST be immediately proceeded
 108  * by a call to read_contents (or the read pointer will be garbage).
 109  */
 110 template<typename T>
 111 inline bool
 112 MidiRingBuffer<T>::read_prefix(T* time, Evoral::EventType* type, uint32_t* size)
 113 {
 114         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)time, sizeof(T)) != sizeof (T)) {
 115                 return false;
 116         }
 117
 118         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)type, sizeof(Evoral::EventType)) != sizeof (Evoral::EventType)) {
 119                 return false;
 120         }
 121
 122         if (PBD::RingBufferNPT<uint8_t>::read((uint8_t*)size, sizeof(uint32_t)) != sizeof (uint32_t)) {
 123                 return false;
 124         }
 125
 126         return true;
 127 }
 128
 129
 130 /** Read the content of an event.  This call MUST be immediately preceded
 131  * by a call to read_prefix (or the returned even will be garbage).
 132  */
 133 template<typename T>
 134 inline bool
 135 MidiRingBuffer<T>::read_contents(uint32_t size, uint8_t* buf)
 136 {
 137         return PBD::RingBufferNPT<uint8_t>::read(buf, size) == size;
 138 }
 139
 140 template<typename T>
 141 inline uint32_t
 142 MidiRingBuffer<T>::write(T time, Evoral::EventType type, uint32_t size, const uint8_t* buf)
 143 {
 144         assert(size > 0);
 145         uint8_t status = buf[0];
 146
 147         // Ignore event if it doesn't match channel filter
 148         if (is_channel_event(status)) {
 149                 ChannelMode mode = get_channel_mode();
 150                 if (mode == FilterChannels) {
 151                         const uint8_t channel = status & 0x0F;
 152                         if (!(get_channel_mask() & (1L << channel))) {
 153                                 return 0;
 154                         }
 155                 } else if (mode == ForceChannel) {
 156                         uint8_t* tmpbuf = (uint8_t*) malloc(size);
 157                         assert(tmpbuf);
 158                         memcpy(tmpbuf, buf, size);
 159
 160                         tmpbuf[0] = (tmpbuf[0] & 0xF0) | (get_channel_mask() & 0x0F);
 161
 162                         uint32_t bytes_written = Evoral::EventRingBuffer<T>::write(time, type, size, tmpbuf);
 163                         free(tmpbuf);
 164                         return bytes_written;
 165                 }
 166         }
 167
 168         return Evoral::EventRingBuffer<T>::write(time, type, size, buf);
 169 }
 170
 171
 172 } // namespace ARDOUR
 173
 174 #endif // __ardour_midi_ring_buffer_h__
 175