libs/ardour/ardour/buffer.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Written by Dave Robillard, 2006
   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_buffer_h__
  21 #define __ardour_buffer_h__
  22
  23 #define _XOPEN_SOURCE 600
  24 #include <cstdlib> // for posix_memalign
  25 #include <cassert>
  26 #include <ardour/types.h>
  27 #include <jack/jack.h>
  28
  29 namespace ARDOUR {
  30
  31
  32 /* Yes, this is a bit of a mess right now.  I'll clean it up when everything
  33  * using it works out.. */
  34
  35
  36 /** A buffer of recordable/playable data.
  37  *
  38  * This is a datatype-agnostic base class for all buffers (there are no
  39  * methods to actually access the data).  This provides a way for code that
  40  * doesn't care about the data type to still deal with buffers (which is
  41  * why the base class can't be a template).
  42  *
  43  * To actually read/write buffer contents, use the appropriate derived class.
  44  */
  45 class Buffer
  46 {
  47 public:
  48         /** Unfortunately using RTTI and dynamic_cast to find the type of the
  49          * buffer is just too slow, this is done in very performance critical
  50          * bits of the code. */
  51         enum Type { NIL = 0, AUDIO, MIDI };
  52
  53         Buffer(Type type, size_t capacity)
  54         : _type(type), _capacity(capacity), _size(0)
  55         {}
  56
  57         virtual ~Buffer() {}
  58
  59         /** Maximum capacity of buffer.
  60          * Note in some cases the entire buffer may not contain valid data, use size. */
  61         size_t capacity() const { return _capacity; }
  62
  63         /** Amount of valid data in buffer.  Use this over capacity almost always. */
  64         size_t size() const { return _size; }
  65
  66         /** Type of this buffer.
  67          * Based on this you can static cast a Buffer* to the desired type. */
  68         virtual Type type() const { return _type; }
  69
  70         /** Jack type (eg JACK_DEFAULT_AUDIO_TYPE) */
  71         const char* jack_type() const { return type_to_jack_type(type()); }
  72
  73         /** String type as saved in session XML files (eg "audio" or "midi") */
  74         const char* type_string() const { return type_to_string(type()); }
  75
  76         /* The below static methods need to be separate from the above methods
  77          * because the conversion is needed in places where there's no Buffer */
  78         static const char* type_to_jack_type(Type t) {
  79                 switch (t) {
  80                         case AUDIO: return JACK_DEFAULT_AUDIO_TYPE;
  81                         case MIDI:  return JACK_DEFAULT_MIDI_TYPE;
  82                         default:    return "";
  83                 }
  84         }
  85
  86         static const char* type_to_string(Type t) {
  87                 switch (t) {
  88                         case AUDIO: return "audio";
  89                         case MIDI:  return "midi";
  90                         default:    return "unknown"; // reeeally shouldn't ever happen
  91                 }
  92         }
  93
  94         /** Used for loading from XML (route default types etc) */
  95         static Type type_from_string(const string& str) {
  96                 if (str == "audio")
  97                         return AUDIO;
  98                 else if (str == "midi")
  99                         return MIDI;
 100                 else
 101                         return NIL;
 102         }
 103
 104 protected:
 105         Type   _type;
 106         size_t _capacity;
 107         size_t _size;
 108 };
 109
 110
 111 /* Inside every class with a type in it's name is a template waiting to get out... */
 112
 113
 114 /** Buffer containing 32-bit floating point (audio) data. */
 115 class AudioBuffer : public Buffer
 116 {
 117 public:
 118         AudioBuffer(size_t capacity)
 119                 : Buffer(AUDIO, capacity)
 120                 , _data(NULL)
 121         {
 122                 _size = capacity; // For audio buffers, size = capacity always
 123                 posix_memalign((void**)_data, 16, sizeof(Sample) * capacity);
 124                 assert(_data);
 125                 memset(_data, 0, sizeof(Sample) * capacity);
 126         }
 127
 128         const Sample* data() const { return _data; }
 129         Sample*       data()       { return _data; }
 130
 131 private:
 132         // These are undefined (prevent copies)
 133         AudioBuffer(const AudioBuffer& copy);
 134         AudioBuffer& operator=(const AudioBuffer& copy);
 135
 136         Sample* const _data; ///< Actual buffer contents
 137 };
 138
 139
 140
 141 /** Buffer containing 8-bit unsigned char (MIDI) data. */
 142 class MidiBuffer : public Buffer
 143 {
 144 public:
 145         MidiBuffer(size_t capacity)
 146                 : Buffer(MIDI, capacity)
 147                 , _data(NULL)
 148         {
 149                 posix_memalign((void**)_data, 16, sizeof(RawMidi) * capacity);
 150                 assert(_data);
 151                 assert(_size == 0);
 152                 memset(_data, 0, sizeof(Sample) * capacity);
 153         }
 154
 155         const RawMidi* data() const { return _data; }
 156         RawMidi*       data()       { return _data; }
 157
 158 private:
 159         // These are undefined (prevent copies)
 160         MidiBuffer(const MidiBuffer& copy);
 161         MidiBuffer& operator=(const MidiBuffer& copy);
 162
 163         RawMidi* const _data; ///< Actual buffer contents
 164 };
 165
 166
 167 } // namespace ARDOUR
 168
 169 #endif // __ardour_buffer_h__