mixer.c
author Sam Lantinga <slouken@lokigames.com>
Thu, 10 May 2001 18:17:57 +0000
changeset 89 64348871c4ad
parent 79 aa6d957c5920
child 91 12164e8e7faf
permissions -rw-r--r--
Fixed crashes when API used with audio not initialized
slouken@0
     1
/*
slouken@0
     2
    MIXERLIB:  An audio mixer library based on the SDL library
slouken@0
     3
    Copyright (C) 1997-1999  Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@0
     6
    modify it under the terms of the GNU Library General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@0
     8
    version 2 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@0
    13
    Library General Public License for more details.
slouken@0
    14
slouken@0
    15
    You should have received a copy of the GNU Library General Public
slouken@0
    16
    License along with this library; if not, write to the Free
slouken@0
    17
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@0
    20
    5635-34 Springhouse Dr.
slouken@0
    21
    Pleasanton, CA 94588 (USA)
slouken@0
    22
    slouken@devolution.com
slouken@0
    23
*/
slouken@0
    24
megastep@7
    25
/* $Id$ */
megastep@7
    26
slouken@0
    27
#include <stdio.h>
slouken@0
    28
#include <stdlib.h>
slouken@0
    29
#include <string.h>
slouken@0
    30
slouken@24
    31
#include "SDL_mutex.h"
slouken@24
    32
#include "SDL_endian.h"
slouken@29
    33
#include "SDL_timer.h"
slouken@0
    34
slouken@34
    35
#include "SDL_mixer.h"
slouken@0
    36
slouken@0
    37
static int audio_opened = 0;
slouken@0
    38
slouken@0
    39
static SDL_AudioSpec mixer;
slouken@0
    40
static SDL_mutex *mixer_lock;
slouken@0
    41
static struct _Mix_Channel {
slouken@0
    42
	Mix_Chunk *chunk;
slouken@0
    43
	int playing;
slouken@0
    44
	int paused;
slouken@0
    45
	Uint8 *samples;
slouken@0
    46
	int volume;
slouken@0
    47
	int looping;
megastep@7
    48
	int tag;
slouken@42
    49
	Uint32 expire;
megastep@8
    50
	Uint32 start_time;
megastep@4
    51
	Mix_Fading fading;
megastep@4
    52
	int fade_volume;
slouken@42
    53
	Uint32 fade_length;
megastep@4
    54
	Uint32 ticks_fade;
slouken@60
    55
} *mix_channel = NULL;
megastep@7
    56
static int num_channels;
slouken@17
    57
static int reserved_channels = 0;
slouken@0
    58
slouken@0
    59
slouken@26
    60
/* Support for hooking into the mixer callback system */
slouken@26
    61
static void (*mix_postmix)(void *udata, Uint8 *stream, int len) = NULL;
slouken@29
    62
static void *mix_postmix_data = NULL;
slouken@26
    63
slouken@42
    64
/* Music function declarations */
slouken@42
    65
extern int open_music(SDL_AudioSpec *mixer);
slouken@42
    66
extern void close_music(void);
slouken@42
    67
slouken@0
    68
/* Support for user defined music functions, plus the default one */
slouken@42
    69
extern int volatile music_active;
slouken@0
    70
extern void music_mixer(void *udata, Uint8 *stream, int len);
slouken@0
    71
static void (*mix_music)(void *udata, Uint8 *stream, int len) = music_mixer;
slouken@42
    72
static void *music_data = NULL;
slouken@0
    73
slouken@0
    74
/* Mixing function */
slouken@0
    75
static void mix_channels(void *udata, Uint8 *stream, int len)
slouken@0
    76
{
slouken@0
    77
	int i, mixable, volume;
megastep@7
    78
	Uint32 sdl_ticks;
slouken@0
    79
slouken@15
    80
	/* Mix the music (must be done before the channels are added) */
slouken@19
    81
	if ( music_active || (mix_music != music_mixer) ) {
slouken@15
    82
		mix_music(music_data, stream, len);
slouken@15
    83
	}
slouken@15
    84
slouken@0
    85
	/* Grab the channels we need to mix */
slouken@0
    86
	SDL_mutexP(mixer_lock);
megastep@7
    87
	sdl_ticks = SDL_GetTicks();
megastep@7
    88
	for ( i=0; i<num_channels; ++i ) {
slouken@60
    89
		if( ! mix_channel[i].paused ) {
slouken@60
    90
			if ( mix_channel[i].expire > 0 && mix_channel[i].expire < sdl_ticks ) {
megastep@8
    91
				/* Expiration delay for that channel is reached */
slouken@60
    92
				mix_channel[i].playing = 0;
slouken@60
    93
				mix_channel[i].fading = MIX_NO_FADING;
slouken@60
    94
				mix_channel[i].expire = 0;
slouken@60
    95
			} else if ( mix_channel[i].fading != MIX_NO_FADING ) {
slouken@60
    96
				Uint32 ticks = sdl_ticks - mix_channel[i].ticks_fade;
slouken@60
    97
				if( ticks > mix_channel[i].fade_length ) {
slouken@60
    98
					if( mix_channel[i].fading == MIX_FADING_OUT ) {
slouken@60
    99
						mix_channel[i].playing = 0;
slouken@60
   100
						mix_channel[i].expire = 0;
slouken@60
   101
						Mix_Volume(i, mix_channel[i].fading); /* Restore the volume */
megastep@8
   102
					}
slouken@60
   103
					mix_channel[i].fading = MIX_NO_FADING;
megastep@4
   104
				} else {
slouken@60
   105
					if( mix_channel[i].fading == MIX_FADING_OUT ) {
slouken@60
   106
						Mix_Volume(i, (mix_channel[i].fade_volume * (mix_channel[i].fade_length-ticks))
slouken@60
   107
								   / mix_channel[i].fade_length );
megastep@8
   108
					} else {
slouken@60
   109
						Mix_Volume(i, (mix_channel[i].fade_volume * ticks) / mix_channel[i].fade_length );
megastep@8
   110
					}
megastep@4
   111
				}
megastep@4
   112
			}
slouken@60
   113
			if ( mix_channel[i].playing > 0 ) {
slouken@60
   114
				volume = (mix_channel[i].volume*mix_channel[i].chunk->volume) / MIX_MAX_VOLUME;
slouken@60
   115
				mixable = mix_channel[i].playing;
slouken@45
   116
				if ( mixable > len ) {
slouken@45
   117
					mixable = len;
slouken@45
   118
				}
slouken@60
   119
				SDL_MixAudio(stream,mix_channel[i].samples,mixable,volume);
slouken@60
   120
				mix_channel[i].samples += mixable;
slouken@60
   121
				mix_channel[i].playing -= mixable;
megastep@21
   122
				/* If looping the sample and we are at its end, make sure
megastep@21
   123
				   we will still return a full buffer */
slouken@60
   124
				while ( mix_channel[i].looping && mixable < len ) {
slouken@45
   125
				    	int remaining = len - mixable;
slouken@60
   126
					int alen = mix_channel[i].chunk->alen;
slouken@45
   127
				    	if (remaining > alen) {
slouken@45
   128
						remaining = alen;
slouken@45
   129
				    	}
slouken@60
   130
					SDL_MixAudio(stream+mixable, mix_channel[i].chunk->abuf, remaining, volume);
slouken@60
   131
					--mix_channel[i].looping;
slouken@60
   132
					mix_channel[i].samples = mix_channel[i].chunk->abuf + remaining;
slouken@60
   133
					mix_channel[i].playing = mix_channel[i].chunk->alen - remaining;
slouken@45
   134
					mixable += remaining;
slouken@45
   135
				}
slouken@60
   136
				if ( ! mix_channel[i].playing && mix_channel[i].looping ) {
slouken@60
   137
					if ( --mix_channel[i].looping ) {
slouken@60
   138
						mix_channel[i].samples = mix_channel[i].chunk->abuf;
slouken@60
   139
						mix_channel[i].playing = mix_channel[i].chunk->alen;
megastep@8
   140
					}
slouken@0
   141
				}
slouken@0
   142
			}
slouken@0
   143
		}
slouken@0
   144
	}
slouken@26
   145
	if ( mix_postmix ) {
slouken@26
   146
		mix_postmix(mix_postmix_data, stream, len);
slouken@26
   147
	}
slouken@0
   148
	SDL_mutexV(mixer_lock);
slouken@0
   149
}
slouken@0
   150
slouken@0
   151
static void PrintFormat(char *title, SDL_AudioSpec *fmt)
slouken@0
   152
{
slouken@0
   153
	printf("%s: %d bit %s audio (%s) at %u Hz\n", title, (fmt->format&0xFF),
slouken@0
   154
			(fmt->format&0x8000) ? "signed" : "unsigned",
slouken@0
   155
			(fmt->channels > 1) ? "stereo" : "mono", fmt->freq);
slouken@0
   156
}
slouken@0
   157
slouken@0
   158
/* Open the mixer with a certain desired audio format */
slouken@60
   159
int Mix_OpenAudio(int frequency, Uint16 format, int nchannels, int chunksize)
slouken@0
   160
{
slouken@0
   161
	int i;
slouken@0
   162
	SDL_AudioSpec desired;
slouken@0
   163
slouken@0
   164
	/* If the mixer is already opened, increment open count */
slouken@0
   165
	if ( audio_opened ) {
slouken@0
   166
	    ++audio_opened;
slouken@0
   167
	    return(0);
slouken@0
   168
	}
slouken@0
   169
slouken@0
   170
	/* Set the desired format and frequency */
slouken@0
   171
	desired.freq = frequency;
slouken@0
   172
	desired.format = format;
slouken@60
   173
	desired.channels = nchannels;
slouken@0
   174
	desired.samples = chunksize;
slouken@0
   175
	desired.callback = mix_channels;
slouken@0
   176
	desired.userdata = NULL;
slouken@0
   177
slouken@0
   178
	/* Accept nearly any audio format */
slouken@0
   179
	if ( SDL_OpenAudio(&desired, &mixer) < 0 ) {
slouken@0
   180
		return(-1);
slouken@0
   181
	}
slouken@0
   182
#if 0
slouken@0
   183
	PrintFormat("Audio device", &mixer);
slouken@0
   184
#endif
slouken@0
   185
slouken@0
   186
	/* Create the channel lock mutex */
slouken@0
   187
	mixer_lock = SDL_CreateMutex();
slouken@47
   188
#ifndef macintosh /* Hmm.. what implications does this have? */
slouken@0
   189
	if ( mixer_lock == NULL ) {
slouken@0
   190
		SDL_CloseAudio();
slouken@0
   191
		SDL_SetError("Unable to create mixer lock");
slouken@0
   192
		return(-1);
slouken@0
   193
	}
slouken@47
   194
#endif
slouken@0
   195
slouken@0
   196
	/* Initialize the music players */
slouken@0
   197
	if ( open_music(&mixer) < 0 ) {
slouken@0
   198
		SDL_CloseAudio();
slouken@0
   199
		SDL_DestroyMutex(mixer_lock);
slouken@0
   200
		return(-1);
slouken@0
   201
	}
megastep@7
   202
megastep@7
   203
	num_channels = MIX_CHANNELS;
slouken@60
   204
	mix_channel = (struct _Mix_Channel *) malloc(num_channels * sizeof(struct _Mix_Channel));
megastep@7
   205
slouken@0
   206
	/* Clear out the audio channels */
megastep@7
   207
	for ( i=0; i<num_channels; ++i ) {
slouken@60
   208
		mix_channel[i].chunk = NULL;
slouken@60
   209
		mix_channel[i].playing = 0;
slouken@60
   210
		mix_channel[i].looping = 0;
slouken@60
   211
		mix_channel[i].volume = SDL_MIX_MAXVOLUME;
slouken@60
   212
		mix_channel[i].tag = -1;
slouken@60
   213
		mix_channel[i].expire = 0;
slouken@0
   214
	}
slouken@0
   215
	Mix_VolumeMusic(SDL_MIX_MAXVOLUME);
slouken@0
   216
	audio_opened = 1;
slouken@0
   217
	SDL_PauseAudio(0);
slouken@0
   218
	return(0);
slouken@0
   219
}
slouken@0
   220
megastep@7
   221
/* Dynamically change the number of channels managed by the mixer.
megastep@7
   222
   If decreasing the number of channels, the upper channels are
megastep@7
   223
   stopped.
megastep@7
   224
 */
megastep@7
   225
int Mix_AllocateChannels(int numchans)
megastep@7
   226
{
megastep@7
   227
	if ( numchans<0 || numchans==num_channels )
megastep@7
   228
		return(num_channels);
megastep@7
   229
megastep@7
   230
	if ( numchans < num_channels ) {
megastep@7
   231
		/* Stop the affected channels */
megastep@7
   232
		int i;
megastep@7
   233
		for(i=numchans; i < num_channels; i++) {
megastep@7
   234
			Mix_HaltChannel(i);
megastep@7
   235
		}
megastep@7
   236
	}
megastep@7
   237
	SDL_mutexP(mixer_lock);
slouken@60
   238
	mix_channel = (struct _Mix_Channel *) realloc(mix_channel, numchans * sizeof(struct _Mix_Channel));
megastep@7
   239
	if ( numchans > num_channels ) {
megastep@7
   240
		/* Initialize the new channels */
megastep@7
   241
		int i;
megastep@7
   242
		for(i=num_channels; i < numchans; i++) {
slouken@60
   243
			mix_channel[i].chunk = NULL;
slouken@60
   244
			mix_channel[i].playing = 0;
slouken@60
   245
			mix_channel[i].looping = 0;
slouken@60
   246
			mix_channel[i].volume = SDL_MIX_MAXVOLUME;
slouken@60
   247
			mix_channel[i].tag = -1;
slouken@60
   248
			mix_channel[i].expire = 0;
megastep@7
   249
		}
megastep@7
   250
	}
megastep@7
   251
	num_channels = numchans;
megastep@7
   252
	SDL_mutexV(mixer_lock);
megastep@7
   253
	return(num_channels);
megastep@7
   254
}
megastep@7
   255
slouken@0
   256
/* Return the actual mixer parameters */
slouken@0
   257
int Mix_QuerySpec(int *frequency, Uint16 *format, int *channels)
slouken@0
   258
{
slouken@0
   259
	if ( audio_opened ) {
slouken@0
   260
		if ( frequency ) {
slouken@0
   261
			*frequency = mixer.freq;
slouken@0
   262
		}
slouken@0
   263
		if ( format ) {
slouken@0
   264
			*format = mixer.format;
slouken@0
   265
		}
slouken@79
   266
		if ( channels ) {
slouken@0
   267
			*channels = mixer.channels;
slouken@0
   268
		}
slouken@0
   269
	}
slouken@0
   270
	return(audio_opened);
slouken@0
   271
}
slouken@0
   272
slouken@0
   273
/* Load a wave file */
slouken@0
   274
Mix_Chunk *Mix_LoadWAV_RW(SDL_RWops *src, int freesrc)
slouken@0
   275
{
slouken@0
   276
	Mix_Chunk *chunk;
slouken@0
   277
	SDL_AudioSpec wavespec;
slouken@0
   278
	SDL_AudioCVT wavecvt;
slouken@41
   279
	int samplesize;
slouken@0
   280
slouken@0
   281
	/* Make sure audio has been opened */
slouken@0
   282
	if ( ! audio_opened ) {
slouken@0
   283
		SDL_SetError("Audio device hasn't been opened");
slouken@89
   284
		if ( freesrc && src ) {
slouken@0
   285
			SDL_RWclose(src);
slouken@0
   286
		}
slouken@0
   287
		return(NULL);
slouken@0
   288
	}
slouken@0
   289
slouken@0
   290
	/* Allocate the chunk memory */
slouken@0
   291
	chunk = (Mix_Chunk *)malloc(sizeof(Mix_Chunk));
slouken@0
   292
	if ( chunk == NULL ) {
slouken@0
   293
		SDL_SetError("Out of memory");
slouken@0
   294
		if ( freesrc ) {
slouken@0
   295
			SDL_RWclose(src);
slouken@0
   296
		}
slouken@0
   297
		return(NULL);
slouken@0
   298
	}
slouken@0
   299
slouken@0
   300
	/* Load the WAV file into the chunk */
slouken@0
   301
	if ( SDL_LoadWAV_RW(src, freesrc,
slouken@0
   302
		&wavespec, (Uint8 **)&chunk->abuf, &chunk->alen) == NULL ) {
slouken@0
   303
		free(chunk);
slouken@0
   304
		return(NULL);
slouken@0
   305
	}
slouken@0
   306
#if 0
slouken@0
   307
	PrintFormat("Audio device", &mixer);
slouken@0
   308
	PrintFormat("-- Wave file", &wavespec);
slouken@0
   309
#endif
slouken@0
   310
slouken@0
   311
	/* Build the audio converter and create conversion buffers */
slouken@0
   312
	if ( SDL_BuildAudioCVT(&wavecvt,
slouken@0
   313
			wavespec.format, wavespec.channels, wavespec.freq,
slouken@0
   314
			mixer.format, mixer.channels, mixer.freq) < 0 ) {
slouken@0
   315
		SDL_FreeWAV(chunk->abuf);
slouken@0
   316
		free(chunk);
slouken@0
   317
		return(NULL);
slouken@0
   318
	}
slouken@41
   319
	samplesize = ((wavespec.format & 0xFF)/8)*wavespec.channels;
slouken@41
   320
	wavecvt.len = chunk->alen & ~(samplesize-1);
slouken@0
   321
	wavecvt.buf = (Uint8 *)malloc(wavecvt.len*wavecvt.len_mult);
slouken@0
   322
	if ( wavecvt.buf == NULL ) {
slouken@0
   323
		SDL_SetError("Out of memory");
slouken@0
   324
		SDL_FreeWAV(chunk->abuf);
slouken@0
   325
		free(chunk);
slouken@0
   326
		return(NULL);
slouken@0
   327
	}
slouken@0
   328
	memcpy(wavecvt.buf, chunk->abuf, chunk->alen);
slouken@0
   329
	SDL_FreeWAV(chunk->abuf);
slouken@0
   330
slouken@0
   331
	/* Run the audio converter */
slouken@0
   332
	if ( SDL_ConvertAudio(&wavecvt) < 0 ) {
slouken@0
   333
		free(wavecvt.buf);
slouken@0
   334
		free(chunk);
slouken@0
   335
		return(NULL);
slouken@0
   336
	}
slouken@1
   337
	chunk->allocated = 1;
slouken@0
   338
	chunk->abuf = wavecvt.buf;
slouken@0
   339
	chunk->alen = wavecvt.len_cvt;
slouken@0
   340
	chunk->volume = MIX_MAX_VOLUME;
slouken@0
   341
	return(chunk);
slouken@0
   342
}
slouken@0
   343
slouken@1
   344
/* Load a wave file of the mixer format from a memory buffer */
slouken@1
   345
Mix_Chunk *Mix_QuickLoad_WAV(Uint8 *mem)
slouken@1
   346
{
slouken@1
   347
	Mix_Chunk *chunk;
slouken@1
   348
	Uint8 magic[4];
slouken@1
   349
slouken@1
   350
	/* Make sure audio has been opened */
slouken@1
   351
	if ( ! audio_opened ) {
slouken@1
   352
		SDL_SetError("Audio device hasn't been opened");
slouken@1
   353
		return(NULL);
slouken@1
   354
	}
slouken@1
   355
slouken@1
   356
	/* Allocate the chunk memory */
slouken@1
   357
	chunk = (Mix_Chunk *)malloc(sizeof(Mix_Chunk));
slouken@1
   358
	if ( chunk == NULL ) {
slouken@1
   359
		SDL_SetError("Out of memory");
slouken@1
   360
		return(NULL);
slouken@1
   361
	}
slouken@1
   362
slouken@1
   363
	/* Essentially just skip to the audio data (no error checking - fast) */
slouken@1
   364
	chunk->allocated = 0;
slouken@1
   365
	mem += 12; /* WAV header */
slouken@1
   366
	do {
slouken@1
   367
		memcpy(magic, mem, 4);
slouken@1
   368
		mem += 4;
slouken@1
   369
		chunk->alen = ((mem[3]<<24)|(mem[2]<<16)|(mem[1]<<8)|(mem[0]));
slouken@1
   370
		mem += 4;
slouken@1
   371
		chunk->abuf = mem;
slouken@1
   372
		mem += chunk->alen;
slouken@1
   373
	} while ( memcmp(magic, "data", 4) != 0 );
slouken@1
   374
	chunk->volume = MIX_MAX_VOLUME;
slouken@1
   375
slouken@1
   376
	return(chunk);
slouken@1
   377
}
slouken@1
   378
slouken@0
   379
/* Free an audio chunk previously loaded */
slouken@0
   380
void Mix_FreeChunk(Mix_Chunk *chunk)
slouken@0
   381
{
slouken@0
   382
	int i;
slouken@0
   383
slouken@0
   384
	/* Caution -- if the chunk is playing, the mixer will crash */
slouken@0
   385
	if ( chunk ) {
slouken@0
   386
		/* Guarantee that this chunk isn't playing */
slouken@60
   387
		if ( mix_channel ) {
slouken@60
   388
			SDL_mutexP(mixer_lock);
slouken@60
   389
			for ( i=0; i<num_channels; ++i ) {
slouken@60
   390
				if ( chunk == mix_channel[i].chunk ) {
slouken@60
   391
					mix_channel[i].playing = 0;
slouken@60
   392
				}
slouken@0
   393
			}
slouken@60
   394
			SDL_mutexV(mixer_lock);
slouken@0
   395
		}
slouken@0
   396
slouken@0
   397
		/* Actually free the chunk */
slouken@1
   398
		if ( chunk->allocated ) {
slouken@1
   399
			free(chunk->abuf);
slouken@1
   400
		}
slouken@0
   401
		free(chunk);
slouken@0
   402
	}
slouken@0
   403
}
slouken@0
   404
slouken@26
   405
/* Set a function that is called after all mixing is performed.
slouken@26
   406
   This can be used to provide real-time visual display of the audio stream
slouken@26
   407
   or add a custom mixer filter for the stream data.
slouken@26
   408
*/
slouken@26
   409
void Mix_SetPostMix(void (*mix_func)
slouken@26
   410
                    (void *udata, Uint8 *stream, int len), void *arg)
slouken@26
   411
{
slouken@26
   412
	SDL_LockAudio();
slouken@26
   413
	mix_postmix_data = arg;
slouken@26
   414
	mix_postmix = mix_func;
slouken@26
   415
	SDL_UnlockAudio();
slouken@26
   416
}
slouken@26
   417
slouken@0
   418
/* Add your own music player or mixer function.
slouken@0
   419
   If 'mix_func' is NULL, the default music player is re-enabled.
slouken@0
   420
 */
slouken@0
   421
void Mix_HookMusic(void (*mix_func)(void *udata, Uint8 *stream, int len),
slouken@0
   422
                                                                void *arg)
slouken@0
   423
{
slouken@0
   424
	SDL_LockAudio();
slouken@0
   425
	if ( mix_func != NULL ) {
slouken@0
   426
		music_data = arg;
slouken@0
   427
		mix_music = mix_func;
slouken@0
   428
	} else {
slouken@0
   429
		music_data = NULL;
slouken@0
   430
		mix_music = music_mixer;
slouken@0
   431
	}
slouken@0
   432
	SDL_UnlockAudio();
slouken@0
   433
}
slouken@0
   434
slouken@0
   435
void *Mix_GetMusicHookData(void)
slouken@0
   436
{
slouken@0
   437
	return(music_data);
slouken@0
   438
}
slouken@0
   439
slouken@0
   440
/* Reserve the first channels (0 -> n-1) for the application, i.e. don't allocate
slouken@0
   441
   them dynamically to the next sample if requested with a -1 value below.
slouken@0
   442
   Returns the number of reserved channels.
slouken@0
   443
 */
slouken@0
   444
int Mix_ReserveChannels(int num)
slouken@0
   445
{
megastep@7
   446
	if (num > num_channels)
megastep@7
   447
		num = num_channels;
slouken@0
   448
	reserved_channels = num;
slouken@0
   449
	return num;
slouken@0
   450
}
slouken@0
   451
slouken@0
   452
/* Play an audio chunk on a specific channel.
slouken@0
   453
   If the specified channel is -1, play on the first free channel.
megastep@7
   454
   'ticks' is the number of milliseconds at most to play the sample, or -1
megastep@7
   455
   if there is no limit.
slouken@0
   456
   Returns which channel was used to play the sound.
slouken@0
   457
*/
megastep@7
   458
int Mix_PlayChannelTimed(int which, Mix_Chunk *chunk, int loops, int ticks)
slouken@0
   459
{
slouken@0
   460
	int i;
slouken@0
   461
slouken@0
   462
	/* Don't play null pointers :-) */
slouken@0
   463
	if ( chunk == NULL ) {
slouken@0
   464
		return(-1);
slouken@0
   465
	}
slouken@0
   466
slouken@0
   467
	/* Lock the mixer while modifying the playing channels */
slouken@0
   468
	SDL_mutexP(mixer_lock);
slouken@0
   469
	{
slouken@0
   470
		/* If which is -1, play on the first free channel */
slouken@0
   471
		if ( which == -1 ) {
megastep@7
   472
			for ( i=reserved_channels; i<num_channels; ++i ) {
slouken@60
   473
				if ( mix_channel[i].playing <= 0 )
slouken@0
   474
					break;
slouken@0
   475
			}
megastep@7
   476
			if ( i == num_channels ) {
slouken@0
   477
				which = -1;
slouken@0
   478
			} else {
slouken@0
   479
				which = i;
slouken@0
   480
			}
slouken@0
   481
		}
slouken@0
   482
slouken@0
   483
		/* Queue up the audio data for this channel */
slouken@0
   484
		if ( which >= 0 ) {
megastep@8
   485
			Uint32 sdl_ticks = SDL_GetTicks();
slouken@60
   486
			mix_channel[which].samples = chunk->abuf;
slouken@60
   487
			mix_channel[which].playing = chunk->alen;
slouken@60
   488
			mix_channel[which].looping = loops;
slouken@60
   489
			mix_channel[which].chunk = chunk;
slouken@60
   490
			mix_channel[which].paused = 0;
slouken@60
   491
			mix_channel[which].fading = MIX_NO_FADING;
slouken@60
   492
			mix_channel[which].start_time = sdl_ticks;
slouken@60
   493
			mix_channel[which].expire = (ticks>0) ? (sdl_ticks + ticks) : 0;
megastep@4
   494
		}
megastep@4
   495
	}
megastep@4
   496
	SDL_mutexV(mixer_lock);
megastep@4
   497
megastep@4
   498
	/* Return the channel on which the sound is being played */
megastep@4
   499
	return(which);
megastep@4
   500
}
megastep@4
   501
megastep@7
   502
/* Change the expiration delay for a channel */
megastep@7
   503
int Mix_ExpireChannel(int which, int ticks)
megastep@7
   504
{
megastep@7
   505
	int status = 0;
megastep@7
   506
megastep@7
   507
	if ( which == -1 ) {
megastep@7
   508
		int i;
megastep@7
   509
		for ( i=0; i < num_channels; ++ i ) {
megastep@7
   510
			status += Mix_ExpireChannel(i, ticks);
megastep@7
   511
		}
megastep@7
   512
	} else if ( which < num_channels ) {
megastep@7
   513
		SDL_mutexP(mixer_lock);
slouken@60
   514
		mix_channel[which].expire = (ticks>0) ? (SDL_GetTicks() + ticks) : 0;
megastep@7
   515
		SDL_mutexV(mixer_lock);
megastep@7
   516
		++ status;
megastep@7
   517
	}
megastep@7
   518
	return(status);
megastep@7
   519
}
megastep@7
   520
megastep@4
   521
/* Fade in a sound on a channel, over ms milliseconds */
megastep@7
   522
int Mix_FadeInChannelTimed(int which, Mix_Chunk *chunk, int loops, int ms, int ticks)
megastep@4
   523
{
megastep@4
   524
	int i;
megastep@4
   525
megastep@4
   526
	/* Don't play null pointers :-) */
megastep@4
   527
	if ( chunk == NULL ) {
megastep@4
   528
		return(-1);
megastep@4
   529
	}
megastep@4
   530
megastep@4
   531
	/* Lock the mixer while modifying the playing channels */
megastep@4
   532
	SDL_mutexP(mixer_lock);
megastep@4
   533
	{
megastep@4
   534
		/* If which is -1, play on the first free channel */
megastep@4
   535
		if ( which == -1 ) {
megastep@7
   536
			for ( i=reserved_channels; i<num_channels; ++i ) {
slouken@60
   537
				if ( mix_channel[i].playing <= 0 )
megastep@4
   538
					break;
megastep@4
   539
			}
megastep@7
   540
			if ( i == num_channels ) {
megastep@4
   541
				which = -1;
megastep@4
   542
			} else {
megastep@4
   543
				which = i;
megastep@4
   544
			}
megastep@4
   545
		}
megastep@4
   546
megastep@4
   547
		/* Queue up the audio data for this channel */
megastep@4
   548
		if ( which >= 0 ) {
megastep@8
   549
			Uint32 sdl_ticks = SDL_GetTicks();
slouken@60
   550
			mix_channel[which].samples = chunk->abuf;
slouken@60
   551
			mix_channel[which].playing = chunk->alen;
slouken@60
   552
			mix_channel[which].looping = loops;
slouken@60
   553
			mix_channel[which].chunk = chunk;
slouken@60
   554
			mix_channel[which].paused = 0;
slouken@60
   555
			mix_channel[which].fading = MIX_FADING_IN;
slouken@60
   556
			mix_channel[which].fade_volume = mix_channel[which].volume;
slouken@60
   557
			mix_channel[which].volume = 0;
slouken@60
   558
			mix_channel[which].fade_length = (Uint32)ms;
slouken@60
   559
			mix_channel[which].start_time = mix_channel[which].ticks_fade = sdl_ticks;
slouken@60
   560
			mix_channel[which].expire = (ticks > 0) ? (sdl_ticks+ticks) : 0;
slouken@0
   561
		}
slouken@0
   562
	}
slouken@0
   563
	SDL_mutexV(mixer_lock);
slouken@0
   564
slouken@0
   565
	/* Return the channel on which the sound is being played */
slouken@0
   566
	return(which);
slouken@0
   567
}
slouken@0
   568
slouken@0
   569
/* Set volume of a particular channel */
slouken@0
   570
int Mix_Volume(int which, int volume)
slouken@0
   571
{
slouken@0
   572
	int i;
slouken@0
   573
	int prev_volume;
slouken@0
   574
slouken@0
   575
	if ( which == -1 ) {
slouken@0
   576
		prev_volume = 0;
megastep@7
   577
		for ( i=0; i<num_channels; ++i ) {
slouken@0
   578
			prev_volume += Mix_Volume(i, volume);
slouken@0
   579
		}
megastep@7
   580
		prev_volume /= num_channels;
slouken@0
   581
	} else {
slouken@60
   582
		prev_volume = mix_channel[which].volume;
megastep@4
   583
		if ( volume < 0 ) {
megastep@4
   584
			volume = 0;
slouken@0
   585
		}
megastep@4
   586
		if ( volume > SDL_MIX_MAXVOLUME ) {
megastep@4
   587
			volume = SDL_MIX_MAXVOLUME;
megastep@4
   588
		}
slouken@60
   589
		mix_channel[which].volume = volume;
slouken@0
   590
	}
slouken@0
   591
	return(prev_volume);
slouken@0
   592
}
slouken@0
   593
/* Set volume of a particular chunk */
slouken@0
   594
int Mix_VolumeChunk(Mix_Chunk *chunk, int volume)
slouken@0
   595
{
slouken@0
   596
	int prev_volume;
slouken@0
   597
slouken@0
   598
	prev_volume = chunk->volume;
slouken@0
   599
	if ( volume >= 0 ) {
slouken@0
   600
		if ( volume > MIX_MAX_VOLUME ) {
slouken@0
   601
			volume = MIX_MAX_VOLUME;
slouken@0
   602
		}
slouken@0
   603
		chunk->volume = volume;
slouken@0
   604
	}
slouken@0
   605
	return(prev_volume);
slouken@0
   606
}
slouken@0
   607
slouken@0
   608
/* Halt playing of a particular channel */
slouken@0
   609
int Mix_HaltChannel(int which)
slouken@0
   610
{
slouken@0
   611
	int i;
slouken@0
   612
slouken@0
   613
	if ( which == -1 ) {
megastep@7
   614
		for ( i=0; i<num_channels; ++i ) {
slouken@0
   615
			Mix_HaltChannel(i);
slouken@0
   616
		}
slouken@0
   617
	} else {
slouken@0
   618
		SDL_mutexP(mixer_lock);
slouken@60
   619
		mix_channel[which].playing = 0;
slouken@60
   620
		mix_channel[which].expire = 0;
slouken@60
   621
		if(mix_channel[which].fading != MIX_NO_FADING) /* Restore volume */
slouken@60
   622
			mix_channel[which].volume = mix_channel[which].fade_volume;
slouken@60
   623
		mix_channel[which].fading = MIX_NO_FADING;
slouken@0
   624
		SDL_mutexV(mixer_lock);
slouken@0
   625
	}
slouken@0
   626
	return(0);
slouken@0
   627
}
slouken@0
   628
megastep@7
   629
/* Halt playing of a particular group of channels */
megastep@7
   630
int Mix_HaltGroup(int tag)
megastep@7
   631
{
megastep@7
   632
	int i;
megastep@7
   633
megastep@7
   634
	for ( i=0; i<num_channels; ++i ) {
slouken@60
   635
		if( mix_channel[i].tag == tag ) {
megastep@7
   636
			Mix_HaltChannel(i);
megastep@7
   637
		}
megastep@7
   638
	}
megastep@7
   639
	return(0);
megastep@7
   640
}
megastep@7
   641
megastep@4
   642
/* Fade out a channel and then stop it automatically */
megastep@4
   643
int Mix_FadeOutChannel(int which, int ms)
megastep@4
   644
{
megastep@4
   645
	int status;
megastep@4
   646
megastep@4
   647
	status = 0;
slouken@89
   648
	if ( audio_opened ) {
slouken@89
   649
		if ( which == -1 ) {
slouken@89
   650
			int i;
megastep@4
   651
slouken@89
   652
			for ( i=0; i<num_channels; ++i ) {
slouken@89
   653
				status += Mix_FadeOutChannel(i, ms);
slouken@89
   654
			}
slouken@89
   655
		} else {
slouken@89
   656
			SDL_mutexP(mixer_lock);
slouken@89
   657
			if ( mix_channel[which].playing && 
slouken@89
   658
			    (mix_channel[which].volume > 0) &&
slouken@89
   659
			    (mix_channel[which].fading != MIX_FADING_OUT) ) {
slouken@89
   660
slouken@89
   661
				mix_channel[which].fading = MIX_FADING_OUT;
slouken@89
   662
				mix_channel[which].fade_volume = mix_channel[which].volume;
slouken@89
   663
				mix_channel[which].fade_length = ms;
slouken@89
   664
				mix_channel[which].ticks_fade = SDL_GetTicks();
slouken@89
   665
				++status;
slouken@89
   666
			}
slouken@89
   667
			SDL_mutexV(mixer_lock);
megastep@4
   668
		}
megastep@4
   669
	}
megastep@4
   670
	return(status);
megastep@4
   671
}
megastep@4
   672
megastep@7
   673
/* Halt playing of a particular group of channels */
megastep@7
   674
int Mix_FadeOutGroup(int tag, int ms)
megastep@7
   675
{
megastep@7
   676
	int i;
megastep@7
   677
	int status = 0;
megastep@7
   678
	for ( i=0; i<num_channels; ++i ) {
slouken@60
   679
		if( mix_channel[i].tag == tag ) {
megastep@7
   680
			status += Mix_FadeOutChannel(i,ms);
megastep@7
   681
		}
megastep@7
   682
	}
megastep@7
   683
	return(status);
megastep@7
   684
}
megastep@7
   685
megastep@4
   686
Mix_Fading Mix_FadingChannel(int which)
megastep@4
   687
{
slouken@60
   688
	return mix_channel[which].fading;
megastep@4
   689
}
megastep@4
   690
slouken@0
   691
/* Check the status of a specific channel.
slouken@60
   692
   If the specified mix_channel is -1, check all mix_channels.
slouken@0
   693
*/
slouken@0
   694
int Mix_Playing(int which)
slouken@0
   695
{
slouken@0
   696
	int status;
slouken@0
   697
slouken@0
   698
	status = 0;
slouken@0
   699
	if ( which == -1 ) {
slouken@0
   700
		int i;
slouken@0
   701
megastep@7
   702
		for ( i=0; i<num_channels; ++i ) {
slouken@60
   703
			if ( mix_channel[i].playing > 0 ) {
slouken@0
   704
				++status;
slouken@0
   705
			}
slouken@0
   706
		}
slouken@0
   707
	} else {
slouken@60
   708
		if ( mix_channel[which].playing > 0 ) {
slouken@0
   709
			++status;
slouken@0
   710
		}
slouken@0
   711
	}
slouken@0
   712
	return(status);
slouken@0
   713
}
slouken@0
   714
slouken@0
   715
/* Close the mixer, halting all playing audio */
slouken@0
   716
void Mix_CloseAudio(void)
slouken@0
   717
{
slouken@0
   718
	if ( audio_opened ) {
slouken@0
   719
		if ( audio_opened == 1 ) {
slouken@0
   720
			close_music();
slouken@0
   721
			Mix_HaltChannel(-1);
slouken@0
   722
			SDL_CloseAudio();
slouken@0
   723
			SDL_DestroyMutex(mixer_lock);
slouken@60
   724
			free(mix_channel);
slouken@60
   725
			mix_channel = NULL;
slouken@0
   726
		}
slouken@0
   727
		--audio_opened;
slouken@0
   728
	}
slouken@0
   729
}
slouken@0
   730
slouken@0
   731
/* Pause a particular channel (or all) */
slouken@0
   732
void Mix_Pause(int which)
slouken@0
   733
{
megastep@8
   734
	Uint32 sdl_ticks = SDL_GetTicks();
slouken@0
   735
	if ( which == -1 ) {
slouken@0
   736
		int i;
slouken@0
   737
megastep@7
   738
		for ( i=0; i<num_channels; ++i ) {
slouken@60
   739
			if ( mix_channel[i].playing > 0 ) {
slouken@60
   740
				mix_channel[i].paused = sdl_ticks;
slouken@0
   741
			}
slouken@0
   742
		}
slouken@0
   743
	} else {
slouken@60
   744
		if ( mix_channel[which].playing > 0 ) {
slouken@60
   745
			mix_channel[which].paused = sdl_ticks;
slouken@0
   746
		}
slouken@0
   747
	}
slouken@0
   748
}
slouken@0
   749
slouken@0
   750
/* Resume a paused channel */
slouken@0
   751
void Mix_Resume(int which)
slouken@0
   752
{
megastep@8
   753
	Uint32 sdl_ticks = SDL_GetTicks();
slouken@0
   754
	if ( which == -1 ) {
slouken@0
   755
		int i;
slouken@0
   756
megastep@8
   757
		SDL_mutexP(mixer_lock);
megastep@7
   758
		for ( i=0; i<num_channels; ++i ) {
slouken@60
   759
			if ( mix_channel[i].playing > 0 ) {
slouken@60
   760
				if(mix_channel[i].expire > 0)
slouken@60
   761
					mix_channel[i].expire += sdl_ticks - mix_channel[i].paused;
slouken@60
   762
				mix_channel[i].paused = 0;
slouken@0
   763
			}
slouken@0
   764
		}
megastep@8
   765
		SDL_mutexV(mixer_lock);
slouken@0
   766
	} else {
megastep@8
   767
		SDL_mutexP(mixer_lock);
slouken@60
   768
		if ( mix_channel[which].playing > 0 ) {
slouken@60
   769
			if(mix_channel[which].expire > 0)
slouken@60
   770
				mix_channel[which].expire += sdl_ticks - mix_channel[which].paused;
slouken@60
   771
			mix_channel[which].paused = 0;
slouken@0
   772
		}
megastep@8
   773
		SDL_mutexV(mixer_lock);
slouken@0
   774
	}
slouken@0
   775
}
megastep@7
   776
megastep@13
   777
int Mix_Paused(int which)
megastep@13
   778
{
megastep@14
   779
	if ( which > num_channels )
megastep@13
   780
		return(0);
megastep@14
   781
	if ( which < 0 ) {
megastep@14
   782
		int status = 0;
megastep@14
   783
		int i;
megastep@14
   784
		for( i=0; i < num_channels; ++i ) {
slouken@60
   785
			if ( mix_channel[i].paused ) {
megastep@14
   786
				++ status;
megastep@14
   787
			}
megastep@14
   788
		}
megastep@14
   789
		return(status);
megastep@14
   790
	} else {
slouken@60
   791
		return(mix_channel[which].paused != 0);
megastep@14
   792
	}
megastep@13
   793
}
megastep@13
   794
megastep@7
   795
/* Change the group of a channel */
megastep@7
   796
int Mix_GroupChannel(int which, int tag)
megastep@7
   797
{
megastep@7
   798
	if ( which < 0 || which > num_channels )
megastep@7
   799
		return(0);
megastep@7
   800
megastep@7
   801
	SDL_mutexP(mixer_lock);
slouken@60
   802
	mix_channel[which].tag = tag;
megastep@7
   803
	SDL_mutexV(mixer_lock);
megastep@7
   804
	return(1);
megastep@7
   805
}
megastep@7
   806
megastep@7
   807
/* Assign several consecutive channels to a group */
megastep@7
   808
int Mix_GroupChannels(int from, int to, int tag)
megastep@7
   809
{
megastep@7
   810
	int status = 0;
megastep@7
   811
	for( ; from <= to; ++ from ) {
megastep@7
   812
		status += Mix_GroupChannel(from, tag);
megastep@7
   813
	}
megastep@7
   814
	return(status);
megastep@7
   815
}
megastep@7
   816
megastep@7
   817
/* Finds the first available channel in a group of channels */
megastep@7
   818
int Mix_GroupAvailable(int tag)
megastep@7
   819
{
megastep@7
   820
	int i;
megastep@7
   821
	for( i=0; i < num_channels; i ++ ) {
slouken@60
   822
		if ( ((tag == -1) || (tag == mix_channel[i].tag)) &&
slouken@60
   823
		                    (mix_channel[i].playing <= 0) )
megastep@7
   824
			return i;
megastep@7
   825
	}
megastep@7
   826
	return(-1);
megastep@7
   827
}
megastep@7
   828
megastep@7
   829
int Mix_GroupCount(int tag)
megastep@7
   830
{
megastep@7
   831
	int count = 0;
megastep@7
   832
	int i;
megastep@7
   833
	for( i=0; i < num_channels; i ++ ) {
slouken@60
   834
		if ( mix_channel[i].tag==tag || tag==-1 )
megastep@7
   835
			++ count;
megastep@7
   836
	}
megastep@7
   837
	return(count);
megastep@7
   838
}
megastep@8
   839
megastep@8
   840
/* Finds the "oldest" sample playing in a group of channels */
megastep@8
   841
int Mix_GroupOldest(int tag)
megastep@8
   842
{
megastep@8
   843
	int chan = -1;
megastep@8
   844
	Uint32 mintime = SDL_GetTicks();
megastep@8
   845
	int i;
megastep@8
   846
	for( i=0; i < num_channels; i ++ ) {
slouken@60
   847
		if ( (mix_channel[i].tag==tag || tag==-1) && mix_channel[i].playing > 0
slouken@60
   848
			 && mix_channel[i].start_time <= mintime ) {
slouken@60
   849
			mintime = mix_channel[i].start_time;
megastep@8
   850
			chan = i;
megastep@8
   851
		}
megastep@8
   852
	}
megastep@8
   853
	return(chan);
megastep@8
   854
}
megastep@8
   855
megastep@8
   856
/* Finds the "most recent" (i.e. last) sample playing in a group of channels */
megastep@8
   857
int Mix_GroupNewer(int tag)
megastep@8
   858
{
megastep@8
   859
	int chan = -1;
megastep@8
   860
	Uint32 maxtime = 0;
megastep@8
   861
	int i;
megastep@8
   862
	for( i=0; i < num_channels; i ++ ) {
slouken@60
   863
		if ( (mix_channel[i].tag==tag || tag==-1) && mix_channel[i].playing > 0
slouken@60
   864
			 && mix_channel[i].start_time >= maxtime ) {
slouken@60
   865
			maxtime = mix_channel[i].start_time;
megastep@8
   866
			chan = i;
megastep@8
   867
		}
megastep@8
   868
	}
megastep@8
   869
	return(chan);
megastep@8
   870
}