music_mod.c
author Sam Lantinga <slouken@libsdl.org>
Sat, 02 Jan 2016 10:46:07 -0800
changeset 711 f40c5ac95b12
parent 628 461e2724372b
child 725 bdf7b8d20566
permissions -rw-r--r--
Updated copyright to 2016
slouken@411
     1
/*
slouken@518
     2
  SDL_mixer:  An audio mixer library based on the SDL library
slouken@711
     3
  Copyright (C) 1997-2016 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@617
    53
    CHAR *list;
slouken@419
    54
slouken@617
    55
    if ( !Mix_Init(MIX_INIT_MOD) ) {
slouken@617
    56
        return -1;
slouken@617
    57
    }
slouken@411
    58
slouken@617
    59
    /* Set the MikMod music format */
slouken@617
    60
    music_swap8 = 0;
slouken@617
    61
    music_swap16 = 0;
slouken@617
    62
    switch (mixerfmt->format) {
slouken@411
    63
slouken@617
    64
        case AUDIO_U8:
slouken@617
    65
        case AUDIO_S8: {
slouken@617
    66
            if ( mixerfmt->format == AUDIO_S8 ) {
slouken@617
    67
                music_swap8 = 1;
slouken@617
    68
            }
slouken@617
    69
            *mikmod.md_mode = 0;
slouken@617
    70
        }
slouken@617
    71
        break;
slouken@411
    72
slouken@617
    73
        case AUDIO_S16LSB:
slouken@617
    74
        case AUDIO_S16MSB: {
slouken@617
    75
            /* See if we need to correct MikMod mixing */
slouken@411
    76
#if SDL_BYTEORDER == SDL_LIL_ENDIAN
slouken@617
    77
            if ( mixerfmt->format == AUDIO_S16MSB ) {
slouken@411
    78
#else
slouken@617
    79
            if ( mixerfmt->format == AUDIO_S16LSB ) {
slouken@411
    80
#endif
slouken@617
    81
                music_swap16 = 1;
slouken@617
    82
            }
slouken@617
    83
            *mikmod.md_mode = DMODE_16BITS;
slouken@617
    84
        }
slouken@617
    85
        break;
slouken@411
    86
slouken@617
    87
        default: {
slouken@617
    88
            Mix_SetError("Unknown hardware audio format");
slouken@617
    89
            return -1;
slouken@617
    90
        }
slouken@617
    91
    }
slouken@617
    92
    current_output_channels = mixerfmt->channels;
slouken@617
    93
    current_output_format = mixerfmt->format;
slouken@617
    94
    if ( mixerfmt->channels > 1 ) {
slouken@617
    95
        if ( mixerfmt->channels > MAX_OUTPUT_CHANNELS ) {
slouken@617
    96
            Mix_SetError("Hardware uses more channels than mixerfmt");
slouken@617
    97
            return -1;
slouken@617
    98
        }
slouken@617
    99
        *mikmod.md_mode |= DMODE_STEREO;
slouken@617
   100
    }
slouken@617
   101
    *mikmod.md_mixfreq = mixerfmt->freq;
slouken@617
   102
    *mikmod.md_device  = 0;
slouken@617
   103
    *mikmod.md_volume  = 96;
slouken@617
   104
    *mikmod.md_musicvolume = 128;
slouken@617
   105
    *mikmod.md_sndfxvolume = 128;
slouken@617
   106
    *mikmod.md_pansep  = 128;
slouken@617
   107
    *mikmod.md_reverb  = 0;
slouken@617
   108
    *mikmod.md_mode    |= DMODE_HQMIXER|DMODE_SOFT_MUSIC|DMODE_SURROUND;
slouken@419
   109
slouken@617
   110
    list = mikmod.MikMod_InfoDriver();
slouken@617
   111
    if ( list )
slouken@617
   112
      mikmod.MikMod_free(list);
slouken@617
   113
    else
slouken@617
   114
      mikmod.MikMod_RegisterDriver(mikmod.drv_nos);
slouken@419
   115
slouken@617
   116
    list = mikmod.MikMod_InfoLoader();
slouken@617
   117
    if ( list )
slouken@617
   118
      mikmod.MikMod_free(list);
slouken@617
   119
    else
slouken@617
   120
      mikmod.MikMod_RegisterAllLoaders();
slouken@419
   121
slouken@617
   122
    if ( mikmod.MikMod_Init(NULL) ) {
slouken@617
   123
        Mix_SetError("%s", mikmod.MikMod_strerror(*mikmod.MikMod_errno));
slouken@617
   124
        return -1;
slouken@617
   125
    }
slouken@411
   126
slouken@617
   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@617
   133
    if (mikmod.MikMod_Exit) {
slouken@617
   134
        mikmod.MikMod_Exit();
slouken@617
   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@617
   141
    mikmod.Player_SetVolume((SWORD)volume);
slouken@411
   142
}
slouken@411
   143
slouken@411
   144
typedef struct
slouken@411
   145
{
slouken@617
   146
    MREADER mr;
slouken@621
   147
    Sint64 offset;
slouken@621
   148
    Sint64 eof;
slouken@628
   149
    SDL_RWops *src;
slouken@411
   150
} LMM_MREADER;
slouken@411
   151
slouken@411
   152
BOOL LMM_Seek(struct MREADER *mr,long to,int dir)
slouken@411
   153
{
slouken@621
   154
	Sint64 offset = to;
slouken@617
   155
    LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@617
   156
    if ( dir == SEEK_SET ) {
slouken@621
   157
        offset += lmmmr->offset;
slouken@617
   158
    }
slouken@628
   159
    return (SDL_RWseek(lmmmr->src, offset, dir) < lmmmr->offset);
slouken@411
   160
}
slouken@411
   161
long LMM_Tell(struct MREADER *mr)
slouken@411
   162
{
slouken@617
   163
    LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@628
   164
    return (long)(SDL_RWtell(lmmmr->src) - lmmmr->offset);
slouken@411
   165
}
slouken@411
   166
BOOL LMM_Read(struct MREADER *mr,void *buf,size_t sz)
slouken@411
   167
{
slouken@617
   168
    LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@628
   169
    return SDL_RWread(lmmmr->src, buf, sz, 1);
slouken@411
   170
}
slouken@411
   171
int LMM_Get(struct MREADER *mr)
slouken@411
   172
{
slouken@617
   173
    unsigned char c;
slouken@617
   174
    LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@628
   175
    if ( SDL_RWread(lmmmr->src, &c, 1, 1) ) {
slouken@617
   176
        return c;
slouken@617
   177
    }
slouken@617
   178
    return EOF;
slouken@411
   179
}
slouken@411
   180
BOOL LMM_Eof(struct MREADER *mr)
slouken@411
   181
{
slouken@628
   182
    Sint64 offset;
slouken@617
   183
    LMM_MREADER* lmmmr = (LMM_MREADER*)mr;
slouken@617
   184
    offset = LMM_Tell(mr);
slouken@617
   185
    return offset >= lmmmr->eof;
slouken@411
   186
}
slouken@628
   187
MODULE *MikMod_LoadSongRW(SDL_RWops *src, int maxchan)
slouken@411
   188
{
slouken@617
   189
    LMM_MREADER lmmmr = {
slouken@617
   190
        { LMM_Seek, LMM_Tell, LMM_Read, LMM_Get, LMM_Eof },
slouken@617
   191
        0,
slouken@617
   192
        0,
slouken@617
   193
        0
slouken@617
   194
    };
slouken@628
   195
    lmmmr.offset = SDL_RWtell(src);
slouken@628
   196
    SDL_RWseek(src, 0, RW_SEEK_END);
slouken@628
   197
    lmmmr.eof = SDL_RWtell(src);
slouken@628
   198
    SDL_RWseek(src, lmmmr.offset, RW_SEEK_SET);
slouken@628
   199
    lmmmr.src = src;
slouken@617
   200
    return mikmod.Player_LoadGeneric((MREADER*)&lmmmr, maxchan, 0);
slouken@411
   201
}
slouken@411
   202
slouken@411
   203
/* Load a MOD stream from an SDL_RWops object */
slouken@628
   204
MODULE *MOD_new_RW(SDL_RWops *src, int freesrc)
slouken@411
   205
{
slouken@617
   206
    MODULE *module;
slouken@419
   207
slouken@617
   208
    /* Make sure the mikmod library is loaded */
slouken@617
   209
    if ( !Mix_Init(MIX_INIT_MOD) ) {
slouken@617
   210
        return NULL;
slouken@617
   211
    }
slouken@479
   212
slouken@628
   213
    module = MikMod_LoadSongRW(src, 64);
slouken@617
   214
    if (!module) {
slouken@617
   215
        Mix_SetError("%s", mikmod.MikMod_strerror(*mikmod.MikMod_errno));
slouken@617
   216
        return NULL;
slouken@617
   217
    }
slouken@411
   218
slouken@617
   219
    /* Stop implicit looping, fade out and other flags. */
slouken@617
   220
    module->extspd  = 1;
slouken@617
   221
    module->panflag = 1;
slouken@617
   222
    module->wrap    = 0;
slouken@617
   223
    module->loop    = 0;
slouken@411
   224
#if 0 /* Don't set fade out by default - unfortunately there's no real way
slouken@411
   225
to query the status of the song or set trigger actions.  Hum. */
slouken@617
   226
    module->fadeout = 1;
slouken@411
   227
#endif
slouken@521
   228
slouken@628
   229
    if ( freesrc ) {
slouken@628
   230
        SDL_RWclose(src);
slouken@617
   231
    }
slouken@617
   232
    return module;
slouken@411
   233
}
slouken@411
   234
slouken@411
   235
/* Start playback of a given MOD stream */
slouken@411
   236
void MOD_play(MODULE *music)
slouken@411
   237
{
slouken@617
   238
    mikmod.Player_Start(music);
slouken@411
   239
}
slouken@411
   240
slouken@411
   241
/* Return non-zero if a stream is currently playing */
slouken@411
   242
int MOD_playing(MODULE *music)
slouken@411
   243
{
slouken@617
   244
    return mikmod.Player_Active();
slouken@411
   245
}
slouken@411
   246
slouken@411
   247
/* Play some of a stream previously started with MOD_play() */
slouken@411
   248
int MOD_playAudio(MODULE *music, Uint8 *stream, int len)
slouken@411
   249
{
slouken@617
   250
    if (current_output_channels > 2) {
slouken@617
   251
        int small_len = 2 * len / current_output_channels;
slouken@617
   252
        int i;
slouken@617
   253
        Uint8 *src, *dst;
slouken@411
   254
slouken@617
   255
        mikmod.VC_WriteBytes((SBYTE *)stream, small_len);
slouken@617
   256
        /* and extend to len by copying channels */
slouken@617
   257
        src = stream + small_len;
slouken@617
   258
        dst = stream + len;
slouken@411
   259
slouken@617
   260
        switch (current_output_format & 0xFF) {
slouken@617
   261
            case 8:
slouken@617
   262
                for ( i=small_len/2; i; --i ) {
slouken@617
   263
                    src -= 2;
slouken@617
   264
                    dst -= current_output_channels;
slouken@617
   265
                    dst[0] = src[0];
slouken@617
   266
                    dst[1] = src[1];
slouken@617
   267
                    dst[2] = src[0];
slouken@617
   268
                    dst[3] = src[1];
slouken@617
   269
                    if (current_output_channels == 6) {
slouken@617
   270
                        dst[4] = src[0];
slouken@617
   271
                        dst[5] = src[1];
slouken@617
   272
                    }
slouken@617
   273
                }
slouken@617
   274
                break;
slouken@617
   275
            case 16:
slouken@617
   276
                for ( i=small_len/4; i; --i ) {
slouken@617
   277
                    src -= 4;
slouken@617
   278
                    dst -= 2 * current_output_channels;
slouken@617
   279
                    dst[0] = src[0];
slouken@617
   280
                    dst[1] = src[1];
slouken@617
   281
                    dst[2] = src[2];
slouken@617
   282
                    dst[3] = src[3];
slouken@617
   283
                    dst[4] = src[0];
slouken@617
   284
                    dst[5] = src[1];
slouken@617
   285
                    dst[6] = src[2];
slouken@617
   286
                    dst[7] = src[3];
slouken@617
   287
                    if (current_output_channels == 6) {
slouken@617
   288
                        dst[8] = src[0];
slouken@617
   289
                        dst[9] = src[1];
slouken@617
   290
                        dst[10] = src[2];
slouken@617
   291
                        dst[11] = src[3];
slouken@617
   292
                    }
slouken@617
   293
                }
slouken@617
   294
                break;
slouken@617
   295
        }
slouken@617
   296
    } else {
slouken@617
   297
        mikmod.VC_WriteBytes((SBYTE *)stream, len);
slouken@617
   298
    }
slouken@617
   299
    if ( music_swap8 ) {
slouken@617
   300
        Uint8 *dst;
slouken@617
   301
        int i;
slouken@411
   302
slouken@617
   303
        dst = stream;
slouken@617
   304
        for ( i=len; i; --i ) {
slouken@617
   305
            *dst++ ^= 0x80;
slouken@617
   306
        }
slouken@617
   307
    } else
slouken@617
   308
    if ( music_swap16 ) {
slouken@617
   309
        Uint8 *dst, tmp;
slouken@617
   310
        int i;
slouken@411
   311
slouken@617
   312
        dst = stream;
slouken@617
   313
        for ( i=(len/2); i; --i ) {
slouken@617
   314
            tmp = dst[0];
slouken@617
   315
            dst[0] = dst[1];
slouken@617
   316
            dst[1] = tmp;
slouken@617
   317
            dst += 2;
slouken@617
   318
        }
slouken@617
   319
    }
slouken@617
   320
    return 0;
slouken@411
   321
}
slouken@411
   322
slouken@411
   323
/* Stop playback of a stream previously started with MOD_play() */
slouken@411
   324
void MOD_stop(MODULE *music)
slouken@411
   325
{
slouken@617
   326
    mikmod.Player_Stop();
slouken@411
   327
}
slouken@411
   328
slouken@411
   329
/* Close the given MOD stream */
slouken@411
   330
void MOD_delete(MODULE *music)
slouken@411
   331
{
slouken@617
   332
    mikmod.Player_Free(music);
slouken@411
   333
}
slouken@411
   334
slouken@411
   335
/* Jump (seek) to a given position (time is in seconds) */
slouken@411
   336
void MOD_jump_to_time(MODULE *music, double time)
slouken@411
   337
{
slouken@617
   338
    mikmod.Player_SetPosition((UWORD)time);
slouken@411
   339
}
slouken@411
   340
slouken@411
   341
#endif /* MOD_MUSIC */