music_mod.c
author Sam Lantinga <slouken@libsdl.org>
Sat, 31 Dec 2011 10:27:48 -0500
changeset 518 8bc9b5fd2aae
parent 479 3d8a5a7b1249
child 521 565549e046b0
permissions -rw-r--r--
Happy New Year!
slouken@411
     1
/*
slouken@518
     2
  SDL_mixer:  An audio mixer library based on the SDL library
slouken@518
     3
  Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
slouken@411
     4
slouken@518
     5
  This software is provided 'as-is', without any express or implied
slouken@518
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@518
     7
  arising from the use of this software.
slouken@411
     8
slouken@518
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@518
    10
  including commercial applications, and to alter it and redistribute it
slouken@518
    11
  freely, subject to the following restrictions:
slouken@411
    12
slouken@518
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@518
    14
     claim that you wrote the original software. If you use this software
slouken@518
    15
     in a product, an acknowledgment in the product documentation would be
slouken@518
    16
     appreciated but is not required.
slouken@518
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@518
    18
     misrepresented as being the original software.
slouken@518
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@411
    20
*/
slouken@411
    21
slouken@411
    22
/* $Id: music_mod.c 4211 2008-12-08 00:27:32Z slouken $ */
slouken@411
    23
slouken@411
    24
#ifdef MOD_MUSIC
slouken@411
    25
slouken@411
    26
/* This file supports MOD tracker music streams */
slouken@411
    27
slouken@411
    28
#include "SDL_mixer.h"
slouken@419
    29
#include "dynamic_mod.h"
slouken@411
    30
#include "music_mod.h"
slouken@411
    31
slouken@411
    32
#include "mikmod.h"
slouken@411
    33
slouken@411
    34
#define SDL_SURROUND
slouken@411
    35
#ifdef SDL_SURROUND
slouken@411
    36
#define MAX_OUTPUT_CHANNELS 6
slouken@411
    37
#else
slouken@411
    38
#define MAX_OUTPUT_CHANNELS 2
slouken@411
    39
#endif
slouken@411
    40
slouken@411
    41
/* Reference for converting mikmod output to 4/6 channels */
slouken@411
    42
static int current_output_channels;
slouken@411
    43
static Uint16 current_output_format;
slouken@411
    44
slouken@411
    45
static int music_swap8;
slouken@411
    46
static int music_swap16;
slouken@411
    47
slouken@419
    48
/* Initialize the MOD player, with the given mixer settings
slouken@411
    49
   This function returns 0, or -1 if there was an error.
slouken@411
    50
 */
slouken@411
    51
int MOD_init(SDL_AudioSpec *mixerfmt)
slouken@411
    52
{
slouken@411
    53
	CHAR *list;
slouken@419
    54
slouken@470
    55
	if ( !Mix_Init(MIX_INIT_MOD) ) {
slouken@420
    56
		return -1;
slouken@419
    57
	}
slouken@411
    58
slouken@411
    59
	/* Set the MikMod music format */
slouken@411
    60
	music_swap8 = 0;
slouken@411
    61
	music_swap16 = 0;
slouken@411
    62
	switch (mixerfmt->format) {
slouken@411
    63
slouken@411
    64
		case AUDIO_U8:
slouken@411
    65
		case AUDIO_S8: {
slouken@411
    66
			if ( mixerfmt->format == AUDIO_S8 ) {
slouken@411
    67
				music_swap8 = 1;
slouken@411
    68
			}
slouken@419
    69
			*mikmod.md_mode = 0;
slouken@411
    70
		}
slouken@411
    71
		break;
slouken@411
    72
slouken@411
    73
		case AUDIO_S16LSB:
slouken@411
    74
		case AUDIO_S16MSB: {
slouken@411
    75
			/* See if we need to correct MikMod mixing */
slouken@411
    76
#if SDL_BYTEORDER == SDL_LIL_ENDIAN
slouken@411
    77
			if ( mixerfmt->format == AUDIO_S16MSB ) {
slouken@411
    78
#else
slouken@411
    79
			if ( mixerfmt->format == AUDIO_S16LSB ) {
slouken@411
    80
#endif
slouken@411
    81
				music_swap16 = 1;
slouken@411
    82
			}
slouken@419
    83
			*mikmod.md_mode = DMODE_16BITS;
slouken@411
    84
		}
slouken@411
    85
		break;
slouken@411
    86
slouken@411
    87
		default: {
slouken@411
    88
			Mix_SetError("Unknown hardware audio format");
slouken@411
    89
			return -1;
slouken@411
    90
		}
slouken@411
    91
	}
slouken@411
    92
	current_output_channels = mixerfmt->channels;
slouken@411
    93
	current_output_format = mixerfmt->format;
slouken@411
    94
	if ( mixerfmt->channels > 1 ) {
slouken@411
    95
		if ( mixerfmt->channels > MAX_OUTPUT_CHANNELS ) {
slouken@411
    96
			Mix_SetError("Hardware uses more channels than mixerfmt");
slouken@411
    97
			return -1;
slouken@411
    98
		}
slouken@419
    99
		*mikmod.md_mode |= DMODE_STEREO;
slouken@411
   100
	}
slouken@419
   101
	*mikmod.md_mixfreq = mixerfmt->freq;
slouken@419
   102
	*mikmod.md_device  = 0;
slouken@419
   103
	*mikmod.md_volume  = 96;
slouken@419
   104
	*mikmod.md_musicvolume = 128;
slouken@419
   105
	*mikmod.md_sndfxvolume = 128;
slouken@419
   106
	*mikmod.md_pansep  = 128;
slouken@419
   107
	*mikmod.md_reverb  = 0;
slouken@419
   108
	*mikmod.md_mode    |= DMODE_HQMIXER|DMODE_SOFT_MUSIC|DMODE_SURROUND;
slouken@419
   109
slouken@419
   110
	list = mikmod.MikMod_InfoDriver();
slouken@411
   111
	if ( list )
slouken@411
   112
	  free(list);
slouken@411
   113
	else
slouken@419
   114
	  mikmod.MikMod_RegisterDriver(mikmod.drv_nos);
slouken@419
   115
slouken@419
   116
	list = mikmod.MikMod_InfoLoader();
slouken@411
   117
	if ( list )
slouken@411
   118
	  free(list);
slouken@411
   119
	else
slouken@419
   120
	  mikmod.MikMod_RegisterAllLoaders();
slouken@419
   121
slouken@419
   122
	if ( mikmod.MikMod_Init(NULL) ) {
slouken@419
   123
		Mix_SetError("%s", mikmod.MikMod_strerror(*mikmod.MikMod_errno));
slouken@411
   124
		return -1;
slouken@411
   125
	}
slouken@411
   126
slouken@411
   127
	return 0;
slouken@411
   128
}
slouken@411
   129
slouken@411
   130
/* Uninitialize the music players */
slouken@411
   131
void MOD_exit(void)
slouken@411
   132
{
slouken@478
   133
	if (mikmod.MikMod_Exit) {
slouken@478
   134
		mikmod.MikMod_Exit();
slouken@478
   135
	}
slouken@411
   136
}
slouken@411
   137
slouken@411
   138
/* Set the volume for a MOD stream */
slouken@411
   139
void MOD_setvolume(MODULE *music, int volume)
slouken@411
   140
{
slouken@419
   141
	mikmod.Player_SetVolume((SWORD)volume);
slouken@411
   142
}
slouken@411
   143
slouken@411
   144
/* Load a MOD stream from the given file */
slouken@411
   145
MODULE *MOD_new(const char *file)
slouken@411
   146
{
slouken@411
   147
	SDL_RWops *rw;
slouken@411
   148
slouken@411
   149
	rw = SDL_RWFromFile(file, "rb");
slouken@411
   150
	if ( rw == NULL ) {
slouken@411
   151
		/* FIXME: Free rw, need to free on delete */
slouken@411
   152
		SDL_SetError("Couldn't open %s", file);
slouken@411
   153
		return NULL;
slouken@411
   154
	}
slouken@411
   155
	return MOD_new_RW(rw);
slouken@411
   156
}
slouken@411
   157
slouken@411
   158
slouken@411
   159
typedef struct
slouken@411
   160
{
slouken@411
   161
	MREADER mr;
slouken@427
   162
	long offset;
slouken@427
   163
	long eof;
slouken@411
   164
	SDL_RWops *rw;
slouken@411
   165
} LMM_MREADER;
slouken@411
   166
slouken@411
   167
BOOL LMM_Seek(struct MREADER *mr,long to,int dir)
slouken@411
   168
{
slouken@419
   169
	LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@419
   170
	if ( dir == SEEK_SET ) {
slouken@419
   171
		to += lmmmr->offset;
slouken@419
   172
	}
slouken@419
   173
	return (SDL_RWseek(lmmmr->rw, to, dir) < lmmmr->offset);
slouken@411
   174
}
slouken@411
   175
long LMM_Tell(struct MREADER *mr)
slouken@411
   176
{
slouken@419
   177
	LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@419
   178
	return SDL_RWtell(lmmmr->rw) - lmmmr->offset;
slouken@411
   179
}
slouken@411
   180
BOOL LMM_Read(struct MREADER *mr,void *buf,size_t sz)
slouken@411
   181
{
slouken@419
   182
	LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@419
   183
	return SDL_RWread(lmmmr->rw, buf, sz, 1);
slouken@411
   184
}
slouken@411
   185
int LMM_Get(struct MREADER *mr)
slouken@411
   186
{
slouken@411
   187
	unsigned char c;
slouken@419
   188
	LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@419
   189
	if ( SDL_RWread(lmmmr->rw, &c, 1, 1) ) {
slouken@419
   190
		return c;
slouken@419
   191
	}
slouken@419
   192
	return EOF;
slouken@411
   193
}
slouken@411
   194
BOOL LMM_Eof(struct MREADER *mr)
slouken@411
   195
{
slouken@427
   196
	long offset;
slouken@419
   197
	LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@419
   198
	offset = LMM_Tell(mr);
slouken@419
   199
	return offset >= lmmmr->eof;
slouken@411
   200
}
slouken@411
   201
MODULE *MikMod_LoadSongRW(SDL_RWops *rw, int maxchan)
slouken@411
   202
{
slouken@411
   203
	LMM_MREADER lmmmr = {
slouken@411
   204
		{ LMM_Seek, LMM_Tell, LMM_Read, LMM_Get, LMM_Eof },
slouken@411
   205
		0,
slouken@411
   206
		0,
slouken@411
   207
		0
slouken@411
   208
	};
slouken@419
   209
	lmmmr.offset = SDL_RWtell(rw);
slouken@473
   210
	SDL_RWseek(rw, 0, RW_SEEK_END);
slouken@419
   211
	lmmmr.eof = SDL_RWtell(rw);
slouken@473
   212
	SDL_RWseek(rw, lmmmr.offset, RW_SEEK_SET);
slouken@411
   213
        lmmmr.rw = rw;
slouken@419
   214
	return mikmod.Player_LoadGeneric((MREADER*)&lmmmr, maxchan, 0);
slouken@411
   215
}
slouken@411
   216
slouken@411
   217
/* Load a MOD stream from an SDL_RWops object */
slouken@411
   218
MODULE *MOD_new_RW(SDL_RWops *rw)
slouken@411
   219
{
slouken@419
   220
	MODULE *module;
slouken@419
   221
slouken@479
   222
	/* Make sure the mikmod library is loaded */
slouken@479
   223
	if ( !Mix_Init(MIX_INIT_MOD) ) {
slouken@479
   224
		return NULL;
slouken@479
   225
	}
slouken@479
   226
slouken@419
   227
	module = MikMod_LoadSongRW(rw,64);
slouken@411
   228
	if (!module) {
slouken@419
   229
		Mix_SetError("%s", mikmod.MikMod_strerror(*mikmod.MikMod_errno));
slouken@411
   230
		return NULL;
slouken@411
   231
	}
slouken@411
   232
slouken@411
   233
	/* Stop implicit looping, fade out and other flags. */
slouken@411
   234
	module->extspd  = 1;
slouken@411
   235
	module->panflag = 1;
slouken@411
   236
	module->wrap    = 0;
slouken@411
   237
	module->loop    = 0;
slouken@411
   238
#if 0 /* Don't set fade out by default - unfortunately there's no real way
slouken@411
   239
to query the status of the song or set trigger actions.  Hum. */
slouken@411
   240
	module->fadeout = 1;
slouken@411
   241
#endif
slouken@411
   242
	return module;
slouken@411
   243
}
slouken@411
   244
slouken@411
   245
/* Start playback of a given MOD stream */
slouken@411
   246
void MOD_play(MODULE *music)
slouken@411
   247
{
slouken@419
   248
	mikmod.Player_Start(music);
slouken@411
   249
}
slouken@411
   250
slouken@411
   251
/* Return non-zero if a stream is currently playing */
slouken@411
   252
int MOD_playing(MODULE *music)
slouken@411
   253
{
slouken@419
   254
	return mikmod.Player_Active();
slouken@411
   255
}
slouken@411
   256
slouken@411
   257
/* Play some of a stream previously started with MOD_play() */
slouken@411
   258
int MOD_playAudio(MODULE *music, Uint8 *stream, int len)
slouken@411
   259
{
slouken@411
   260
	if (current_output_channels > 2) {
slouken@411
   261
		int small_len = 2 * len / current_output_channels;
slouken@411
   262
		int i;
slouken@411
   263
		Uint8 *src, *dst;
slouken@411
   264
slouken@419
   265
		mikmod.VC_WriteBytes((SBYTE *)stream, small_len);
slouken@411
   266
		/* and extend to len by copying channels */
slouken@411
   267
		src = stream + small_len;
slouken@411
   268
		dst = stream + len;
slouken@411
   269
slouken@411
   270
		switch (current_output_format & 0xFF) {
slouken@411
   271
			case 8:
slouken@411
   272
				for ( i=small_len/2; i; --i ) {
slouken@411
   273
					src -= 2;
slouken@411
   274
					dst -= current_output_channels;
slouken@411
   275
					dst[0] = src[0];
slouken@411
   276
					dst[1] = src[1];
slouken@411
   277
					dst[2] = src[0];
slouken@411
   278
					dst[3] = src[1];
slouken@411
   279
					if (current_output_channels == 6) {
slouken@411
   280
						dst[4] = src[0];
slouken@411
   281
						dst[5] = src[1];
slouken@411
   282
					}
slouken@411
   283
				}
slouken@411
   284
				break;
slouken@411
   285
			case 16:
slouken@411
   286
				for ( i=small_len/4; i; --i ) {
slouken@411
   287
					src -= 4;
slouken@411
   288
					dst -= 2 * current_output_channels;
slouken@411
   289
					dst[0] = src[0];
slouken@411
   290
					dst[1] = src[1];
slouken@411
   291
					dst[2] = src[2];
slouken@411
   292
					dst[3] = src[3];
slouken@411
   293
					dst[4] = src[0];
slouken@411
   294
					dst[5] = src[1];
slouken@411
   295
					dst[6] = src[2];
slouken@411
   296
					dst[7] = src[3];
slouken@411
   297
					if (current_output_channels == 6) {
slouken@411
   298
						dst[8] = src[0];
slouken@411
   299
						dst[9] = src[1];
slouken@411
   300
						dst[10] = src[2];
slouken@411
   301
						dst[11] = src[3];
slouken@411
   302
					}
slouken@411
   303
				}
slouken@411
   304
				break;
slouken@411
   305
		}
slouken@411
   306
	} else {
slouken@419
   307
		mikmod.VC_WriteBytes((SBYTE *)stream, len);
slouken@411
   308
	}
slouken@411
   309
	if ( music_swap8 ) {
slouken@411
   310
		Uint8 *dst;
slouken@411
   311
		int i;
slouken@411
   312
slouken@411
   313
		dst = stream;
slouken@411
   314
		for ( i=len; i; --i ) {
slouken@411
   315
			*dst++ ^= 0x80;
slouken@411
   316
		}
slouken@411
   317
	} else
slouken@411
   318
	if ( music_swap16 ) {
slouken@411
   319
		Uint8 *dst, tmp;
slouken@411
   320
		int i;
slouken@411
   321
slouken@411
   322
		dst = stream;
slouken@411
   323
		for ( i=(len/2); i; --i ) {
slouken@411
   324
			tmp = dst[0];
slouken@411
   325
			dst[0] = dst[1];
slouken@411
   326
			dst[1] = tmp;
slouken@411
   327
			dst += 2;
slouken@411
   328
		}
slouken@411
   329
	}
slouken@411
   330
	return 0;
slouken@411
   331
}
slouken@411
   332
slouken@411
   333
/* Stop playback of a stream previously started with MOD_play() */
slouken@411
   334
void MOD_stop(MODULE *music)
slouken@411
   335
{
slouken@419
   336
	mikmod.Player_Stop();
slouken@411
   337
}
slouken@411
   338
slouken@411
   339
/* Close the given MOD stream */
slouken@411
   340
void MOD_delete(MODULE *music)
slouken@411
   341
{
slouken@419
   342
	mikmod.Player_Free(music);
slouken@411
   343
}
slouken@411
   344
slouken@411
   345
/* Jump (seek) to a given position (time is in seconds) */
slouken@411
   346
void MOD_jump_to_time(MODULE *music, double time)
slouken@411
   347
{
slouken@419
   348
	mikmod.Player_SetPosition((UWORD)time);
slouken@411
   349
}
slouken@411
   350
slouken@411
   351
#endif /* MOD_MUSIC */