libs/ardour/ardour/midi_buffer.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: Dave Robillard
   4
   5     This program is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License as published by the Free
   7     Software Foundation; either version 2 of the License, or (at your option)
   8     any later version.
   9
  10     This program is distributed in the hope that it will be useful, but WITHOUT
  11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13     for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_midi_buffer_h__
  21 #define __ardour_midi_buffer_h__
  22
  23 #include <ardour/buffer.h>
  24 #include <ardour/midi_event.h>
  25
  26 namespace ARDOUR {
  27
  28
  29 /** Buffer containing 8-bit unsigned char (MIDI) data. */
  30 class MidiBuffer : public Buffer
  31 {
  32 public:
  33         MidiBuffer(size_t capacity);
  34         ~MidiBuffer();
  35
  36         void silence(nframes_t dur, nframes_t offset=0);
  37
  38         void read_from(const Buffer& src, nframes_t nframes, nframes_t offset);
  39
  40         void copy(const MidiBuffer& copy);
  41
  42         bool  push_back(const ARDOUR::MidiEvent& event);
  43         bool  push_back(const jack_midi_event_t& event);
  44         Byte* reserve(double time, size_t size);
  45
  46         bool merge(const MidiBuffer& a, const MidiBuffer& b);
  47
  48         struct iterator {
  49                 iterator(MidiBuffer& b, size_t i) : buffer(b), index(i) {}
  50
  51                 inline MidiEvent& operator*() const { return buffer[index]; }
  52                 inline iterator& operator++() { ++index; return *this; } // prefix
  53                 inline bool operator!=(const iterator& other) const { return index != other.index; }
  54
  55                 MidiBuffer& buffer;
  56                 size_t      index;
  57         };
  58
  59         struct const_iterator {
  60                 const_iterator(const MidiBuffer& b, size_t i) : buffer(b), index(i) {}
  61
  62                 inline const MidiEvent& operator*() const { return buffer[index]; }
  63                 inline const_iterator& operator++() { ++index; return *this; } // prefix
  64                 inline bool operator!=(const const_iterator& other) const { return index != other.index; }
  65
  66                 const MidiBuffer& buffer;
  67                 size_t            index;
  68         };
  69
  70         iterator begin() { return iterator(*this, 0); }
  71         iterator end()   { return iterator(*this, _size); }
  72
  73         const_iterator begin() const { return const_iterator(*this, 0); }
  74         const_iterator end()   const { return const_iterator(*this, _size); }
  75
  76 private:
  77
  78         friend class iterator;
  79         friend class const_iterator;
  80
  81         const MidiEvent& operator[](size_t i) const { assert(i < _size); return _events[i]; }
  82         MidiEvent& operator[](size_t i) { assert(i < _size); return _events[i]; }
  83
  84         // FIXME: Eliminate this
  85         static const size_t MAX_EVENT_SIZE = 4; // bytes
  86
  87         /* We use _size as "number of events", so the size of _data is
  88          * (_size * MAX_EVENT_SIZE)
  89          */
  90
  91         /* FIXME: this is utter crap.  rewrite as a flat/packed buffer like MidiRingBuffer */
  92
  93         MidiEvent* _events; ///< Event structs that point to offsets in _data
  94         Byte*      _data;   ///< MIDI, straight up.  No time stamps.
  95 };
  96
  97
  98 } // namespace ARDOUR
  99
 100 #endif // __ardour_midi_buffer_h__