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 template<typename T>
  41 class MidiRingBuffer : public Evoral::EventRingBuffer<T> {
  42 public:
  43         /** @param size Size in bytes.
  44          */
  45         MidiRingBuffer(size_t size)
  46                 : Evoral::EventRingBuffer<T>(size)
  47                 , _channel_mask(0x0000FFFF)
  48         {}
  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, nframes_t start, nframes_t end, nframes_t offset=0);
  54         void dump(std::ostream& dst);
  55
  56         /** Set the channel filtering mode.
  57          * @param mask If mode is FilterChannels, each bit represents a midi channel:
  58          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
  59          *     process events whose channel bit is 1.
  60          *     If mode is ForceChannel, mask is simply a channel number which all events will
  61          *     be forced to while reading.
  62          */
  63         void set_channel_mode(ChannelMode mode, uint16_t mask) {
  64                 g_atomic_int_set(&_channel_mask, (uint32_t(mode) << 16) | uint32_t(mask));
  65         }
  66
  67         ChannelMode get_channel_mode() const {
  68                 return static_cast<ChannelMode>((g_atomic_int_get(&_channel_mask) & 0xFFFF0000) >> 16);
  69         }
  70
  71         uint16_t get_channel_mask() const {
  72                 return g_atomic_int_get(&_channel_mask) & 0x0000FFFF;
  73         }
  74
  75 protected:
  76         inline bool is_channel_event(uint8_t event_type_byte) {
  77                 // mask out channel information
  78                 event_type_byte &= 0xF0;
  79                 // midi channel events range from 0x80 to 0xE0
  80                 return (0x80 <= event_type_byte) && (event_type_byte <= 0xE0);
  81         }
  82
  83 private:
  84         volatile uint32_t _channel_mask; // 16 bits mode, 16 bits mask
  85 };
  86
  87
  88 /** Read the time and size of an event.  This call MUST be immediately proceeded
  89  * by a call to read_contents (or the read pointer will be garbage).
  90  */
  91 template<typename T>
  92 inline bool
  93 MidiRingBuffer<T>::read_prefix(T* time, Evoral::EventType* type, uint32_t* size)
  94 {
  95         bool success = Evoral::EventRingBuffer<T>::full_read(sizeof(T), (uint8_t*)time);
  96         if (success)
  97                 success = Evoral::EventRingBuffer<T>::full_read(sizeof(Evoral::EventType), (uint8_t*)type);
  98         if (success)
  99                 success = Evoral::EventRingBuffer<T>::full_read(sizeof(uint32_t), (uint8_t*)size);
 100
 101         return success;
 102 }
 103
 104
 105 /** Read the content of an event.  This call MUST be immediately preceded
 106  * by a call to read_prefix (or the returned even will be garbage).
 107  */
 108 template<typename T>
 109 inline bool
 110 MidiRingBuffer<T>::read_contents(uint32_t size, uint8_t* buf)
 111 {
 112         return Evoral::EventRingBuffer<T>::full_read(size, buf);
 113 }
 114
 115
 116 } // namespace ARDOUR
 117
 118 #endif // __ardour_midi_ring_buffer_h__
 119