2 Copyright (C) 2006 Paul Davis
3 Written by Dave Robillard, 2006
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)
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
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.
20 #ifndef __ardour_buffer_h__
21 #define __ardour_buffer_h__
23 #define _XOPEN_SOURCE 600
24 #include <cstdlib> // for posix_memalign
26 #include <ardour/types.h>
27 #include <jack/jack.h>
32 /* Yes, this is a bit of a mess right now. I'll clean it up when everything
33 * using it works out.. */
36 /** A buffer of recordable/playable data.
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).
43 * To actually read/write buffer contents, use the appropriate derived class.
48 Buffer(DataType type, size_t capacity)
49 : _type(type), _capacity(capacity), _size(0)
54 /** Maximum capacity of buffer.
55 * Note in some cases the entire buffer may not contain valid data, use size. */
56 size_t capacity() const { return _capacity; }
58 /** Amount of valid data in buffer. Use this over capacity almost always. */
59 size_t size() const { return _size; }
61 /** Type of this buffer.
62 * Based on this you can static cast a Buffer* to the desired type. */
63 virtual DataType type() const { return _type; }
65 /** Jack type (eg JACK_DEFAULT_AUDIO_TYPE) */
66 const char* jack_type() const { return type_to_jack_type(type()); }
68 /** String type as saved in session XML files (eg "audio" or "midi") */
69 const char* type_string() const { return type_to_string(type()); }
71 /* The below static methods need to be separate from the above methods
72 * because the conversion is needed in places where there's no Buffer.
73 * These should probably live somewhere else...
76 static const char* type_to_jack_type(DataType t) {
78 case AUDIO: return JACK_DEFAULT_AUDIO_TYPE;
79 //case MIDI: return JACK_DEFAULT_MIDI_TYPE;
84 static const char* type_to_string(DataType t) {
86 case AUDIO: return "audio";
87 case MIDI: return "midi";
88 default: return "unknown"; // reeeally shouldn't ever happen
92 /** Used for loading from XML (route default types etc) */
93 static DataType type_from_string(const string& str) {
96 else if (str == "midi")
109 /* Inside every class with a type in it's name is a template waiting to get out... */
112 /** Buffer containing 32-bit floating point (audio) data. */
113 class AudioBuffer : public Buffer
116 AudioBuffer(size_t capacity)
117 : Buffer(AUDIO, capacity)
120 _size = capacity; // For audio buffers, size = capacity (always)
121 #ifdef NO_POSIX_MEMALIGN
122 _data = (Sample *) malloc(sizeof(Sample) * capacity);
124 posix_memalign((void**)_data, 16, sizeof(Sample) * capacity);
127 memset(_data, 0, sizeof(Sample) * capacity);
130 const Sample* data() const { return _data; }
131 Sample* data() { return _data; }
134 // These are undefined (prevent copies)
135 AudioBuffer(const AudioBuffer& copy);
136 AudioBuffer& operator=(const AudioBuffer& copy);
138 Sample* const _data; ///< Actual buffer contents
142 } // namespace ARDOUR
144 #endif // __ardour_buffer_h__