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