/
music_ogg.c
519 lines (455 loc) · 14.8 KB
1
/*
2
SDL_mixer: An audio mixer library based on the SDL library
3
Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
20
21
*/
22
#ifdef MUSIC_OGG
23
24
25
/* This file supports Ogg Vorbis music streams */
26
#include "SDL_loadso.h"
27
28
29
#include "music_ogg.h"
30
#define OV_EXCLUDE_STATIC_CALLBACKS
31
32
33
34
35
36
37
38
#if defined(OGG_HEADER)
#include OGG_HEADER
#elif defined(OGG_USE_TREMOR)
#include <tremor/ivorbisfile.h>
#else
#include <vorbis/vorbisfile.h>
#endif
39
40
41
42
43
44
typedef struct {
int loaded;
void *handle;
int (*ov_clear)(OggVorbis_File *vf);
vorbis_info *(*ov_info)(OggVorbis_File *vf,int link);
45
vorbis_comment *(*ov_comment)(OggVorbis_File *vf,int link);
46
47
48
49
50
int (*ov_open_callbacks)(void *datasource, OggVorbis_File *vf, const char *initial, long ibytes, ov_callbacks callbacks);
ogg_int64_t (*ov_pcm_total)(OggVorbis_File *vf,int i);
#ifdef OGG_USE_TREMOR
long (*ov_read)(OggVorbis_File *vf,char *buffer,int length, int *bitstream);
int (*ov_time_seek)(OggVorbis_File *vf,ogg_int64_t pos);
51
52
ogg_int64_t (*ov_time_total)(OggVorbis_File *vf, int i);
#else
53
54
long (*ov_read)(OggVorbis_File *vf,char *buffer,int length, int bigendianp,int word,int sgned,int *bitstream);
int (*ov_time_seek)(OggVorbis_File *vf,double pos);
55
double (*ov_time_total)(OggVorbis_File *vf, int i);
56
#endif
57
58
int (*ov_pcm_seek)(OggVorbis_File *vf, ogg_int64_t pos);
ogg_int64_t (*ov_pcm_tell)(OggVorbis_File *vf);
59
60
61
62
63
64
65
} vorbis_loader;
static vorbis_loader vorbis = {
0, NULL
};
#ifdef OGG_DYNAMIC
66
67
68
69
70
71
72
#define FUNCTION_LOADER(FUNC, SIG) \
vorbis.FUNC = (SIG) SDL_LoadFunction(vorbis.handle, #FUNC); \
if (vorbis.FUNC == NULL) { SDL_UnloadObject(vorbis.handle); return -1; }
#else
#define FUNCTION_LOADER(FUNC, SIG) \
vorbis.FUNC = FUNC;
#endif
73
74
static int OGG_Load(void)
75
{
76
if (vorbis.loaded == 0) {
77
#ifdef OGG_DYNAMIC
78
79
80
81
vorbis.handle = SDL_LoadObject(OGG_DYNAMIC);
if (vorbis.handle == NULL) {
return -1;
}
82
83
84
85
86
87
#elif defined(__MACOSX__)
extern int ov_open_callbacks(void*, OggVorbis_File*, const char*, long, ov_callbacks) __attribute__((weak_import));
if (ov_open_callbacks == NULL)
{
/* Missing weakly linked framework */
Mix_SetError("Missing Vorbis.framework");
88
89
return -1;
}
90
91
92
93
#endif
FUNCTION_LOADER(ov_clear, int (*)(OggVorbis_File *))
FUNCTION_LOADER(ov_info, vorbis_info *(*)(OggVorbis_File *,int))
FUNCTION_LOADER(ov_comment, vorbis_comment *(*)(OggVorbis_File *,int))
94
FUNCTION_LOADER(ov_open_callbacks, int (*)(void *,OggVorbis_File *,const char *,long,ov_callbacks))
95
FUNCTION_LOADER(ov_pcm_total, ogg_int64_t (*)(OggVorbis_File *,int))
96
#ifdef OGG_USE_TREMOR
97
FUNCTION_LOADER(ov_read, long (*)(OggVorbis_File *,char *,int,int *))
98
FUNCTION_LOADER(ov_time_seek, int (*)(OggVorbis_File *,ogg_int64_t))
99
FUNCTION_LOADER(ov_time_total, ogg_int64_t (*)(OggVorbis_File *, int))
100
#else
101
102
FUNCTION_LOADER(ov_read, long (*)(OggVorbis_File *,char *,int,int,int,int,int *))
FUNCTION_LOADER(ov_time_seek, int (*)(OggVorbis_File *,double))
103
FUNCTION_LOADER(ov_time_total, double (*)(OggVorbis_File *, int))
104
#endif
105
106
FUNCTION_LOADER(ov_pcm_seek, int (*)(OggVorbis_File *,ogg_int64_t))
FUNCTION_LOADER(ov_pcm_tell, ogg_int64_t (*)(OggVorbis_File *))
107
108
109
110
}
++vorbis.loaded;
return 0;
111
112
}
113
static void OGG_Unload(void)
114
{
115
116
117
118
if (vorbis.loaded == 0) {
return;
}
if (vorbis.loaded == 1) {
119
#ifdef OGG_DYNAMIC
120
SDL_UnloadObject(vorbis.handle);
121
#endif
122
123
}
--vorbis.loaded;
124
125
}
126
127
128
129
typedef struct {
SDL_RWops *src;
int freesrc;
130
int play_count;
131
132
int volume;
OggVorbis_File vf;
133
vorbis_info vi;
134
int section;
135
136
137
SDL_AudioStream *stream;
char *buffer;
int buffer_size;
138
139
140
141
int loop;
ogg_int64_t loop_start;
ogg_int64_t loop_end;
ogg_int64_t loop_len;
142
143
} OGG_music;
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
static int set_ov_error(const char *function, int error)
{
#define HANDLE_ERROR_CASE(X) case X: Mix_SetError("%s: %s", function, #X); break;
switch (error) {
HANDLE_ERROR_CASE(OV_FALSE);
HANDLE_ERROR_CASE(OV_EOF);
HANDLE_ERROR_CASE(OV_HOLE);
HANDLE_ERROR_CASE(OV_EREAD);
HANDLE_ERROR_CASE(OV_EFAULT);
HANDLE_ERROR_CASE(OV_EIMPL);
HANDLE_ERROR_CASE(OV_EINVAL);
HANDLE_ERROR_CASE(OV_ENOTVORBIS);
HANDLE_ERROR_CASE(OV_EBADHEADER);
HANDLE_ERROR_CASE(OV_EVERSION);
HANDLE_ERROR_CASE(OV_ENOTAUDIO);
HANDLE_ERROR_CASE(OV_EBADPACKET);
HANDLE_ERROR_CASE(OV_EBADLINK);
HANDLE_ERROR_CASE(OV_ENOSEEK);
default:
Mix_SetError("%s: unknown error %d\n", function, error);
break;
}
return -1;
}
170
171
172
173
174
static size_t sdl_read_func(void *ptr, size_t size, size_t nmemb, void *datasource)
{
return SDL_RWread((SDL_RWops*)datasource, ptr, size, nmemb);
}
175
static int sdl_seek_func(void *datasource, ogg_int64_t offset, int whence)
176
{
177
return (int)SDL_RWseek((SDL_RWops*)datasource, offset, whence);
178
179
}
180
static long sdl_tell_func(void *datasource)
181
{
182
return (long)SDL_RWtell((SDL_RWops*)datasource);
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
static int OGG_Seek(void *context, double time);
static void OGG_Delete(void *context);
static int OGG_UpdateSection(OGG_music *music)
{
vorbis_info *vi;
vi = vorbis.ov_info(&music->vf, -1);
if (!vi) {
Mix_SetError("ov_info returned NULL");
return -1;
}
if (vi->channels == music->vi.channels && vi->rate == music->vi.rate) {
return 0;
}
SDL_memcpy(&music->vi, vi, sizeof(*vi));
if (music->buffer) {
SDL_free(music->buffer);
music->buffer = NULL;
}
if (music->stream) {
SDL_FreeAudioStream(music->stream);
music->stream = NULL;
}
213
music->stream = SDL_NewAudioStream(AUDIO_S16, (Uint8)vi->channels, (int)vi->rate,
214
215
216
217
218
music_spec.format, music_spec.channels, music_spec.freq);
if (!music->stream) {
return -1;
}
219
220
music->buffer_size = music_spec.samples * (int)sizeof(Sint16) * vi->channels;
music->buffer = (char *)SDL_malloc((size_t)music->buffer_size);
221
222
223
224
225
226
if (!music->buffer) {
return -1;
}
return 0;
}
227
228
/* Parse time string of the form HH:MM:SS.mmm and return equivalent sample
* position */
229
static ogg_int64_t parse_time(char *time, long samplerate_hz)
230
231
232
233
234
{
char *num_start, *p;
ogg_int64_t result = 0;
char c;
235
236
/* Time is directly expressed as a sample position */
if (SDL_strchr(time, ':') == NULL) {
237
return (ogg_int64_t)SDL_strtoull(time, NULL, 10);
238
239
240
241
242
}
result = 0;
num_start = time;
243
244
for (p = time; *p != '\0'; ++p) {
if (*p == '.' || *p == ':') {
245
246
247
248
249
250
c = *p; *p = '\0';
result = result * 60 + SDL_atoi(num_start);
num_start = p + 1;
*p = c;
}
251
if (*p == '.') {
252
return result * samplerate_hz
253
+ (ogg_int64_t) (SDL_atof(p) * samplerate_hz);
254
255
256
257
258
259
}
}
return (result * 60 + SDL_atoi(num_start)) * samplerate_hz;
}
260
/* Load an OGG stream from an SDL_RWops object */
261
static void *OGG_CreateFromRW(SDL_RWops *src, int freesrc)
262
{
263
264
OGG_music *music;
ov_callbacks callbacks;
265
vorbis_comment *vc;
266
long rate;
267
268
ogg_int64_t full_length;
SDL_bool is_loop_length = SDL_FALSE;
269
int i;
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
music = (OGG_music *)SDL_calloc(1, sizeof *music);
if (!music) {
SDL_OutOfMemory();
return NULL;
}
music->src = src;
music->volume = MIX_MAX_VOLUME;
music->section = -1;
music->loop = -1;
music->loop_start = -1;
music->loop_end = 0;
music->loop_len = 0;
SDL_zero(callbacks);
285
286
287
288
callbacks.read_func = sdl_read_func;
callbacks.seek_func = sdl_seek_func;
callbacks.tell_func = sdl_tell_func;
289
290
291
292
293
if (vorbis.ov_open_callbacks(src, &music->vf, NULL, 0, callbacks) < 0) {
SDL_SetError("Not an Ogg Vorbis audio stream");
SDL_free(music);
return NULL;
}
294
295
296
297
298
if (OGG_UpdateSection(music) < 0) {
OGG_Delete(music);
return NULL;
}
299
300
vc = vorbis.ov_comment(&music->vf, -1);
301
rate = music->vi.rate;
302
303
304
305
306
307
308
309
for (i = 0; i < vc->comments; i++) {
char *param = SDL_strdup(vc->user_comments[i]);
char *argument = param;
char *value = SDL_strchr(param, '=');
if (value == NULL) {
value = param + SDL_strlen(param);
} else {
*(value++) = '\0';
310
311
}
312
313
314
315
316
317
318
/* Want to match LOOP-START, LOOP_START, etc. Remove - or _ from
* string if it is present at position 4. */
if ((argument[4] == '_') || (argument[4] == '-')) {
SDL_memmove(argument + 4, argument + 5, SDL_strlen(argument) - 4);
}
319
if (SDL_strcasecmp(argument, "LOOPSTART") == 0)
320
music->loop_start = parse_time(value, rate);
321
else if (SDL_strcasecmp(argument, "LOOPLENGTH") == 0) {
322
music->loop_len = (ogg_int64_t)SDL_strtoull(value, NULL, 10);
323
is_loop_length = SDL_TRUE;
324
} else if (SDL_strcasecmp(argument, "LOOPEND") == 0) {
325
music->loop_end = parse_time(value, rate);
326
is_loop_length = SDL_FALSE;
327
}
328
329
SDL_free(param);
}
330
331
if (is_loop_length) {
332
music->loop_end = music->loop_start + music->loop_len;
333
} else {
334
335
336
music->loop_len = music->loop_end - music->loop_start;
}
337
full_length = vorbis.ov_pcm_total(&music->vf, -1);
338
339
if (((music->loop_start >= 0) || (music->loop_end > 0)) &&
((music->loop_start < music->loop_end) || (music->loop_end == 0)) &&
340
341
(music->loop_start < full_length) &&
(music->loop_end <= full_length)) {
342
if (music->loop_start < 0) music->loop_start = 0;
343
if (music->loop_end == 0) music->loop_end = full_length;
344
music->loop = 1;
345
}
346
347
music->freesrc = freesrc;
348
349
350
351
352
353
354
355
return music;
}
/* Set the volume for an OGG stream */
static void OGG_SetVolume(void *context, int volume)
{
OGG_music *music = (OGG_music *)context;
music->volume = volume;
356
357
}
358
/* Start playback of a given OGG stream */
359
static int OGG_Play(void *context, int play_count)
360
{
361
OGG_music *music = (OGG_music *)context;
362
363
music->play_count = play_count;
return OGG_Seek(music, 0.0);
364
365
}
366
367
/* Play some of a stream previously started with OGG_play() */
static int OGG_GetSome(void *context, void *data, int bytes, SDL_bool *done)
368
{
369
OGG_music *music = (OGG_music *)context;
370
371
SDL_bool looped = SDL_FALSE;
int filled, amount, result;
372
int section;
373
ogg_int64_t pcmPos;
374
375
376
377
378
379
380
381
382
383
384
385
386
filled = SDL_AudioStreamGet(music->stream, data, bytes);
if (filled != 0) {
return filled;
}
if (!music->play_count) {
/* All done */
*done = SDL_TRUE;
return 0;
}
section = music->section;
387
#ifdef OGG_USE_TREMOR
388
amount = vorbis.ov_read(&music->vf, music->buffer, music->buffer_size, §ion);
390
amount = (int)vorbis.ov_read(&music->vf, music->buffer, music->buffer_size, 0, 2, 1, §ion);
392
393
394
if (amount < 0) {
set_ov_error("ov_read", amount);
return -1;
395
396
}
397
398
399
400
if (section != music->section) {
music->section = section;
if (OGG_UpdateSection(music) < 0) {
return -1;
401
402
403
}
}
404
pcmPos = vorbis.ov_pcm_tell(&music->vf);
405
if ((music->loop == 1) && (music->play_count != 1) && (pcmPos >= music->loop_end)) {
406
amount -= (int)((pcmPos - music->loop_end) * music->vi.channels) * (int)sizeof(Sint16);
407
408
409
410
result = vorbis.ov_pcm_seek(&music->vf, music->loop_start);
if (result < 0) {
set_ov_error("ov_pcm_seek", result);
return -1;
411
412
413
414
415
416
} else {
int play_count = -1;
if (music->play_count > 0) {
play_count = (music->play_count - 1);
}
music->play_count = play_count;
417
}
418
looped = SDL_TRUE;
419
}
420
421
422
423
424
425
426
427
428
if (amount > 0) {
if (SDL_AudioStreamPut(music->stream, music->buffer, amount) < 0) {
return -1;
}
} else if (!looped) {
if (music->play_count == 1) {
music->play_count = 0;
SDL_AudioStreamFlush(music->stream);
429
} else {
430
431
432
433
434
435
436
int play_count = -1;
if (music->play_count > 0) {
play_count = (music->play_count - 1);
}
if (OGG_Play(music, play_count) < 0) {
return -1;
}
437
438
}
}
439
return 0;
440
}
441
static int OGG_GetAudio(void *context, void *data, int bytes)
442
{
443
OGG_music *music = (OGG_music *)context;
444
return music_pcm_getaudio(context, data, bytes, music->volume, OGG_GetSome);
445
446
}
447
448
449
450
/* Jump (seek) to a given position (time is in seconds) */
static int OGG_Seek(void *context, double time)
{
OGG_music *music = (OGG_music *)context;
451
int result;
452
#ifdef OGG_USE_TREMOR
453
result = vorbis.ov_time_seek(&music->vf, (ogg_int64_t)(time * 1000.0));
454
#else
455
result = vorbis.ov_time_seek(&music->vf, time);
456
#endif
457
458
459
if (result < 0) {
return set_ov_error("ov_time_seek", result);
}
460
461
462
return 0;
}
463
464
465
466
467
468
469
470
471
472
473
/* Return music duration in seconds */
static double OGG_Duration(void *context)
{
OGG_music *music = (OGG_music *)context;
#ifdef OGG_USE_TREMOR
return vorbis.ov_time_total(&music->vf, -1) / 1000.0;
#else
return vorbis.ov_time_total(&music->vf, -1);
#endif
}
474
/* Close the given OGG stream */
475
static void OGG_Delete(void *context)
476
{
477
OGG_music *music = (OGG_music *)context;
478
479
480
481
482
483
484
485
486
vorbis.ov_clear(&music->vf);
if (music->stream) {
SDL_FreeAudioStream(music->stream);
}
if (music->buffer) {
SDL_free(music->buffer);
}
if (music->freesrc) {
SDL_RWclose(music->src);
487
}
488
SDL_free(music);
489
490
}
491
Mix_MusicInterface Mix_MusicInterface_OGG =
492
{
493
494
495
496
497
498
499
500
501
502
503
504
"OGG",
MIX_MUSIC_OGG,
MUS_OGG,
SDL_FALSE,
SDL_FALSE,
OGG_Load,
NULL, /* Open */
OGG_CreateFromRW,
NULL, /* CreateFromFile */
OGG_SetVolume,
OGG_Play,
505
NULL, /* IsPlaying */
506
507
OGG_GetAudio,
OGG_Seek,
508
OGG_Duration,
509
510
NULL, /* Pause */
NULL, /* Resume */
511
NULL, /* Stop */
512
513
OGG_Delete,
NULL, /* Close */
514
OGG_Unload
515
516
517
};
#endif /* MUSIC_OGG */
518
519
/* vi: set ts=4 sw=4 expandtab: */