summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/buffer.h
blob: f0ad3be67e47b11dc5072f0ead5e40b05de1e3a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*
    Copyright (C) 2006 Paul Davis 
    Written by Dave Robillard, 2006
    
    This program is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by the Free
    Software Foundation; either version 2 of the License, or (at your option)
    any later version.
    
    This program is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
    
    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __ardour_buffer_h__
#define __ardour_buffer_h__

#define _XOPEN_SOURCE 600
#include <cstdlib> // for posix_memalign
#include <cassert>
#include <ardour/types.h>
#include <jack/jack.h>

namespace ARDOUR {


/* Yes, this is a bit of a mess right now.  I'll clean it up when everything
 * using it works out.. */


/** A buffer of recordable/playable data.
 *
 * This is a datatype-agnostic base class for all buffers (there are no
 * methods to actually access the data).  This provides a way for code that
 * doesn't care about the data type to still deal with buffers (which is
 * why the base class can't be a template).
 * 
 * To actually read/write buffer contents, use the appropriate derived class.
 */
class Buffer
{
public:
	/** Unfortunately using RTTI and dynamic_cast to find the type of the
	 * buffer is just too slow, this is done in very performance critical
	 * bits of the code. */
	enum Type { NIL = 0, AUDIO, MIDI };

	Buffer(Type type, size_t capacity)
	: _type(type), _capacity(capacity), _size(0) 
	{}

	virtual ~Buffer() {}

	/** Maximum capacity of buffer.
	 * Note in some cases the entire buffer may not contain valid data, use size. */
	size_t capacity() const { return _capacity; }

	/** Amount of valid data in buffer.  Use this over capacity almost always. */
	size_t size() const { return _size; }

	/** Type of this buffer.
	 * Based on this you can static cast a Buffer* to the desired type. */
	virtual Type type() const { return _type; }

	/** Jack type (eg JACK_DEFAULT_AUDIO_TYPE) */
	const char* jack_type() const { return type_to_jack_type(type()); }
	
	/** String type as saved in session XML files (eg "audio" or "midi") */
	const char* type_string() const { return type_to_string(type()); }

	/* The below static methods need to be separate from the above methods
	 * because the conversion is needed in places where there's no Buffer */
	static const char* type_to_jack_type(Type t) {
		switch (t) {
			case AUDIO: return JACK_DEFAULT_AUDIO_TYPE;
			case MIDI:  return JACK_DEFAULT_MIDI_TYPE;
			default:    return "";
		}
	}
	
	static const char* type_to_string(Type t) {
		switch (t) {
			case AUDIO: return "audio";
			case MIDI:  return "midi";
			default:    return "unknown"; // reeeally shouldn't ever happen
		}
	}

	/** Used for loading from XML (route default types etc) */
	static Type type_from_string(const string& str) {
		if (str == "audio")
			return AUDIO;
		else if (str == "midi")
			return MIDI;
		else
			return NIL;
	}

protected:
	Type   _type;
	size_t _capacity;
	size_t _size;
};


/* Inside every class with a type in it's name is a template waiting to get out... */


/** Buffer containing 32-bit floating point (audio) data. */
class AudioBuffer : public Buffer
{
public:
	AudioBuffer(size_t capacity)
		: Buffer(AUDIO, capacity)
		, _data(NULL)
	{
		_size = capacity; // For audio buffers, size = capacity always
		posix_memalign((void**)_data, 16, sizeof(Sample) * capacity);
		assert(_data);
		memset(_data, 0, sizeof(Sample) * capacity);
	}

	const Sample* data() const { return _data; }
	Sample*       data()       { return _data; }

private:
	// These are undefined (prevent copies)
	AudioBuffer(const AudioBuffer& copy);            
	AudioBuffer& operator=(const AudioBuffer& copy);

	Sample* const _data; ///< Actual buffer contents
};



/** Buffer containing 8-bit unsigned char (MIDI) data. */
class MidiBuffer : public Buffer
{
public:
	MidiBuffer(size_t capacity)
		: Buffer(MIDI, capacity)
		, _data(NULL)
	{
		posix_memalign((void**)_data, 16, sizeof(RawMidi) * capacity);
		assert(_data);
		assert(_size == 0);
		memset(_data, 0, sizeof(Sample) * capacity);
	}

	const RawMidi* data() const { return _data; }
	RawMidi*       data()       { return _data; }

private:
	// These are undefined (prevent copies)
	MidiBuffer(const MidiBuffer& copy);            
	MidiBuffer& operator=(const MidiBuffer& copy);

	RawMidi* const _data; ///< Actual buffer contents
};


} // namespace ARDOUR

#endif // __ardour_buffer_h__