aboutsummaryrefslogtreecommitdiff
path: root/sound/mods/protracker.cpp
blob: a0c8da45de2421bb9a24252f51336162c8a5984f (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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/* ScummVM - Scumm Interpreter
 * Copyright (C) 2006 The ScummVM project
 * Based on code by madmoose
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *
 */

#include "common/stdafx.h"

#include "sound/mods/protracker.h"
#include "sound/mods/paula.h"
#include "sound/mods/module.h"

#include "sound/audiostream.h"

namespace Modules {

class ProtrackerStream : public ::Audio::Paula {
private:
	Module *_module;

	int _rate;

	int _tick;
	int _row;
	int _pos;

	int _patternDelay;

	int _speed;
	int _bpm;

	// For effect 0xB - Jump To Pattern;
	bool _hasJumpToPattern;
	int _jumpToPattern;

	// For effect 0xD - PatternBreak;
	bool _hasPatternBreak;
	int _skiprow;

	// For effect 0xE6 - Pattern Loop
	bool _hasPatternLoop;
	int _patternLoopCount;
	int _patternLoopRow;

	struct {
		byte sample;
		uint16 period;
		double offset;

		byte vol;

		// For effect 0x3 - Porta to note
		uint16 portaToNote;
		byte portaToNoteSpeed;

		// For effect 0x4 - Vibrato
		int vibrato;
		byte vibratoPos;
		byte vibratoSpeed;
		byte vibratoDepth;
	} _track[4];

public:
	ProtrackerStream(Common::ReadStream *stream, int rate, bool stereo);

private:
	void startPlay() { _playing = true; _end = false; }
	void interrupt();

	void updateRow();
	void updateEffects();

};

ProtrackerStream::ProtrackerStream(Common::ReadStream *stream, int rate, bool stereo) :
		Paula(stereo, rate, rate/50) {
	_module = new Module();
	bool result = _module->load(*stream);
	assert(result);

	_rate = rate;
	_tick = _row = _pos = 0;
	_hasJumpToPattern = false;
	_hasPatternBreak = false;
	_hasPatternLoop = false;
	_patternDelay = 0;
	_patternLoopCount = 0;
	_patternLoopRow = 0;
	_speed = 6;
	_bpm = 125;

	for (int t = 0; t < 4; t++) {
		_track[t].sample = 0;
		_track[t].period = 0;
		_track[t].offset = 0.0;
		_track[t].vibrato = 0;
	}	

	startPlay();
}

void ProtrackerStream::updateRow() {
	for (int track = 0; track < 4; track++) {
		_track[track].vibrato = 0;
		note_t note =
		    _module->pattern[_module->songpos[_pos]][_row][track];

		int effect = note.effect >> 8;

		_track[track].sample = note.sample;
		if (_track[track].sample != note.sample) {
			_track[track].vibratoPos = 0;
		}
		if (note.sample) {
			_track[track].vol = _module->sample[note.sample - 1].vol;
		}
		if (note.period) {
			if (effect != 3 && effect != 5) {
				_track[track].period = note.period;
				_track[track].offset = 0.0;
			}
		}

		int exy = note.effect & 0xff;
		int ex = (note.effect >> 4) & 0xf;
		int ey = note.effect & 0xf;

		switch (effect) {
		case 0x0:
			break;
		case 0x1:
			break;
		case 0x2:
			break;
		case 0x3:
			if (note.period)
				_track[track].portaToNote = note.period;

			if (exy)
				_track[track].portaToNoteSpeed = exy;
			break;
		case 0x4:
			if (ex || ey) {
				_track[track].vibratoSpeed = ex;
				_track[track].vibratoDepth = ey;
			}
			break;
		case 0x5:
			break;
		case 0xA:
			break;
		case 0xB:
			_hasJumpToPattern = true;
			_jumpToPattern = exy;
			break;
		case 0xC:
			_track[track].vol = exy;
			break;
		case 0xD:
			_hasPatternBreak = true;
			_skiprow = ex * 10 + ey;
			break;

		case 0xE:
			switch (ex) {
			case 0x6:
				if (ey == 0) {
					_patternLoopRow = _row;
				} else {
					_patternLoopCount++;
					if (_patternLoopCount <= ey)
						_hasPatternLoop = true;
					else
						_patternLoopCount = 0;
				}
				break;
			case 0x9:
				break;	// Retrigger note
			default:
				warning("Unimplemented effect %X\n", note.effect);
			}
			break;

		case 0xF:
			if (exy < 0x20) {
				_speed = exy;
			} else {
				_bpm = exy;
				setInterruptFreq((int) (((double) _bpm) * 0.4));
			}
			break;
		default:
			warning("Unimplemented effect %X\n", note.effect);
		}
	}
}

void ProtrackerStream::updateEffects() {

	static const int16 sinetable[64] = {
		   0,   24,   49,   74,   97,  120,  141,  161,
		 180,  197,  212,  224,  235,  244,  250,  253,
		 255,  253,  250,  244,  235,  224,  212,  197,
		 180,  161,  141,  120,   97,   74,   49,   24,
		   0,  -24,  -49,  -74,  -97, -120, -141, -161,
		-180, -197, -212, -224, -235, -244, -250, -253,
		-255, -253, -250, -244, -235, -224, -212, -197,
		-180, -161, -141, -120,  -97,  -74,  -49,  -24
	};

	for (int track = 0; track < 4; track++) {
		_track[track].vibrato = 0;

		note_t note =
		    _module->pattern[_module->songpos[_pos]][_row][track];

		int effect = note.effect >> 8;

		int exy = note.effect & 0xff;
		int ex = (note.effect >> 4) & 0xf;
		int ey = (note.effect) & 0xf;

		int vol;
		switch (effect) {
		case 0x0:
			break;
		case 0x1:
			_track[track].period -= exy;
			break;
		case 0x2:
			_track[track].period += exy;
			break;
		case 0x3:
			if (_track[track].portaToNote && _track[track].portaToNoteSpeed) {
				if (_track[track].period < _track[track].portaToNote) {
					_track[track].period += _track[track].portaToNoteSpeed;
					if (_track[track].period > _track[track].portaToNote)
						_track[track].period = _track[track].portaToNote;
				} else if (_track[track].period > _track[track].portaToNote) {
					_track[track].period -= _track[track].portaToNoteSpeed;
					if (_track[track].period < _track[track].portaToNote)
						_track[track].period = _track[track].portaToNote;
				}
			}
			break;
		case 0x4:
			_track[track].vibrato =
			    (_track[track].vibratoDepth * sinetable[_track[track].vibratoPos]) / 128;
			_track[track].vibratoPos += _track[track].vibratoSpeed;
			_track[track].vibratoPos %= 64;
			break;

		case 0x5:
			if (_track[track].portaToNote
			    && _track[track].portaToNoteSpeed) {
				if (_track[track].period < _track[track].portaToNote) {
					_track[track].period += _track[track].portaToNoteSpeed;
					if (_track[track].period > _track[track].portaToNote)
						_track[track].period = _track[track].portaToNote;
				} else if (_track[track].period > _track[track].portaToNote) {
					_track[track].period -= _track[track].portaToNoteSpeed;
					if (_track[track].period < _track[track].portaToNote)
						_track[track].period = _track[track].portaToNote;
				}
			}

			vol = _track[track].vol;
			if (ex == 0)
				vol -= ey;
			else if (ey == 0)
				vol += ex;

			if (vol < 0)
				vol = 0;
			else if (vol > 64)
				vol = 64;

			_track[track].vol = vol;

			break;

		case 0x6:
			_track[track].vibrato =
			    (_track[track].vibratoDepth * sinetable[_track[track].vibratoPos]) / 128;
			_track[track].vibratoPos += _track[track].vibratoSpeed;
			_track[track].vibratoPos %= 64;

			vol = _track[track].vol;
			if (ex == 0)
				vol -= ey;
			else if (ey == 0)
				vol += ex;

			if (vol < 0)
				vol = 0;
			else if (vol > 64)
				vol = 64;

			_track[track].vol = vol;

			break;

		case 0xA:
			vol = _track[track].vol;
			if (ex == 0)
				vol -= ey;
			else if (ey == 0)
				vol += ex;

			if (vol < 0)
				vol = 0;
			else if (vol > 64)
				vol = 64;

			_track[track].vol = vol;

			break;

		case 0xE:
			switch (ex) {
			case 0x6:
				break;	// Pattern loop
			case 0x9:	// Retrigger note
				if (ey && _tick % ey == 0)
					_track[track].offset = 0.0;
				break;
			}
			break;
		}
	}
}

void ProtrackerStream::interrupt(void) {
	int track;

	for (track = 0; track < 4; track++)
		_track[track].offset = _voice[track].offset;

	if (_tick == 0) {
		if (_hasJumpToPattern) {
			_hasJumpToPattern = false;
			_pos = _jumpToPattern;
			_row = 0;
		} else if (_hasPatternBreak) {
			_hasPatternBreak = false;
			_row = _skiprow;
			_pos = (_pos + 1) % _module->songlen;
			_patternLoopRow = 0;
		} else if (_hasPatternLoop) {
			_hasPatternLoop = false;
			_row = _patternLoopRow;
		}
		if (_row >= 64) {
			_row = 0;
			_pos = (_pos + 1) % _module->songlen;
			_patternLoopRow = 0;
		}

		if (_patternDelay == 0) {
			updateRow();
		} else {
			_patternDelay--;
		}
	} else
		updateEffects();

	_tick = (_tick + 1) % _speed;
	if (_tick == 0)
		_row++;

	for (track = 0; track < 4; track++) {
		_voice[track].period = _track[track].period + _track[track].vibrato;
		_voice[track].volume = _track[track].vol;
		if (_track[track].sample) {
			sample_t &sample = _module->sample[_track[track].sample - 1];
			_voice[track].data = sample.data;
			_voice[track].dataRepeat = sample.replen > 2 ? sample.data + sample.repeat : 0;
			_voice[track].length = sample.len;
			_voice[track].lengthRepeat = sample.replen;
			_voice[track].offset = _track[track].offset;
			_track[track].sample = 0;
		}
	}
}

} // End of namespace Modules

namespace Audio {

AudioStream *makeProtrackerStream(Common::ReadStream *stream, int rate, bool stereo) {
	return new Modules::ProtrackerStream(stream, rate, stereo);
}

} // End of namespace Audio