summaryrefslogtreecommitdiff
path: root/libs/ardour/midi_ring_buffer.cc
blob: 60c0a18a9b251aa6a8246a7b5f84ec1ec78d1119 (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/*
    Copyright (C) 2006-2008 Paul Davis

    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.
*/

#include "pbd/compose.h"

#include "ardour/debug.h"
#include "ardour/midi_ring_buffer.h"
#include "ardour/midi_buffer.h"
#include "ardour/event_type_map.h"

using namespace std;
using namespace ARDOUR;
using namespace PBD;

/** Read a block of MIDI events from buffer into a MidiBuffer.
 *
 * Timestamps of events returned are relative to start (i.e. event with stamp 0
 * occurred at start), with offset added.
 */
template<typename T>
size_t
MidiRingBuffer<T>::read(MidiBuffer& dst, nframes_t start, nframes_t end, nframes_t offset)
{
	if (this->read_space() == 0) {
		return 0;
	}

	T                 ev_time;
	Evoral::EventType ev_type;
	uint32_t          ev_size;

	size_t count = 0;

	while (this->read_space() >= sizeof(T) + sizeof(Evoral::EventType) + sizeof(uint32_t)) {

		this->full_peek(sizeof(T), (uint8_t*)&ev_time);

		if (ev_time > end) {
			DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 past end @ %2\n", ev_time, end));
			break;
		} else if (ev_time < start) {
			DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 before start @ %2\n", ev_time, start));
			break;
		} else {
			DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("MRB event @ %1 in range %2 .. %3\n", ev_time, start, end));
		}

		bool success = read_prefix(&ev_time, &ev_type, &ev_size);
		if (!success) {
			cerr << "WARNING: error reading event prefix from MIDI ring" << endl;
			continue;
		}

		// This event marks a loop end (i.e. the next event's timestamp will be non-monotonic)
		if (ev_type == LoopEventType) {
			/*ev_time -= start;
			  ev_time += offset;*/
			// cerr << "MRB loop boundary @ " << ev_time << endl;

			// Return without reading data or writing to buffer (loop events have no data)
			// FIXME: This is not correct, loses events after the loop this cycle
			return count + 1;
		}

		uint8_t status;
		success = this->full_peek(sizeof(uint8_t), &status);
		assert(success); // If this failed, buffer is corrupt, all hope is lost

		// Ignore event if it doesn't match channel filter
		if (is_channel_event(status) && get_channel_mode() == FilterChannels) {
			const uint8_t channel = status & 0x0F;
			if (!(get_channel_mask() & (1L << channel))) {
				// cerr << "MRB skipping event due to channel mask" << endl;
				this->skip(ev_size); // Advance read pointer to next event
				continue;
			}
		}

		assert(ev_time >= start);
		ev_time -= start;
		ev_time += offset;

		// write the timestamp to address (write_loc - 1)
		uint8_t* write_loc = dst.reserve(ev_time, ev_size);
		if (write_loc == NULL) {
			// cerr << "MRB: Unable to reserve space in buffer, event skipped";
			this->skip (ev_size); // Advance read pointer to next event
			continue;
		}

		// write MIDI buffer contents
		success = Evoral::EventRingBuffer<T>::full_read(ev_size, write_loc);

#ifndef NDEBUG
		DEBUG_TRACE (DEBUG::MidiDiskstreamIO, "wrote MidiEvent to Buffer: ");
		for (size_t i=0; i < ev_size; ++i) {
			DEBUG_STR_DECL(a);
			DEBUG_STR_APPEND(a,hex);
			DEBUG_STR_APPEND(a,"0x");
			DEBUG_STR_APPEND(a,(int)write_loc[i]);
			DEBUG_TRACE (DEBUG::MidiDiskstreamIO, DEBUG_STR(a).str());
		}
		DEBUG_TRACE (DEBUG::MidiDiskstreamIO, "\n");
#endif

		if (success) {
			if (is_channel_event(status) && get_channel_mode() == ForceChannel) {
				write_loc[0] = (write_loc[0] & 0xF0) | (get_channel_mask() & 0x0F);
			}
			++count;
		} else {
			cerr << "WARNING: error reading event contents from MIDI ring" << endl;
		}
	}

	return count;
}
template<typename T>
void
MidiRingBuffer<T>::dump(ostream& str)
{
	size_t rspace;

	if ((rspace = this->read_space()) == 0) {
		str << "MRB::dump: empty\n";
		return;
	}

	T                 ev_time;
	Evoral::EventType ev_type;
	uint32_t          ev_size;
	size_t read_ptr = g_atomic_int_get (&this->_read_ptr);

	str << "Dump @ " << read_ptr << endl;

	while (1) {
		uint8_t* wp;
		uint8_t* data;
		size_t write_ptr;

#define space(r,w) ((w > r) ? (w - r) : ((w - r + this->_size) % this->_size))

		write_ptr  = g_atomic_int_get (&this->_write_ptr);
		if (space (read_ptr, write_ptr) < sizeof (T)) {
			break;
		}

		wp = &this->_buf[read_ptr];
		memcpy (&ev_time, wp, sizeof (T));
		read_ptr = (read_ptr + sizeof (T)) % this->_size;
		str << "time " << ev_time;

		write_ptr  = g_atomic_int_get (&this->_write_ptr);
		if (space (read_ptr, write_ptr) < sizeof (ev_type)) {
			break;
		}

		wp = &this->_buf[read_ptr];
		memcpy (&ev_type, wp, sizeof (ev_type));
		read_ptr = (read_ptr + sizeof (ev_type)) % this->_size;
		str << " type " << ev_type;

		write_ptr  = g_atomic_int_get (&this->_write_ptr);
		if (space (read_ptr, write_ptr) < sizeof (ev_size)) {
			str << "!OUT!\n";
			break;
		}

		wp = &this->_buf[read_ptr];
		memcpy (&ev_size, wp, sizeof (ev_size));
		read_ptr = (read_ptr + sizeof (ev_size)) % this->_size;
		str << " size " << ev_size;

		write_ptr  = g_atomic_int_get (&this->_write_ptr);
		if (space (read_ptr, write_ptr) < ev_size) {
			str << "!OUT!\n";
			break;
		}

		data = new uint8_t[ev_size];

		wp = &this->_buf[read_ptr];
		memcpy (data, wp, ev_size);
		read_ptr = (read_ptr + ev_size) % this->_size;

		for (uint32_t i = 0; i != ev_size; ++i) {
			str << ' ' << hex << (int) data[i] << dec;
		}

		str << endl;

		delete [] data;
	}
}


template class MidiRingBuffer<nframes_t>;