snd_xmp.c

   1 /*
   2         Copyright (C) 2014 nyov <nyov@nexnode.net>
   3
   4         This program is free software; you can redistribute it and/or
   5         modify it under the terms of the GNU General Public License
   6         as published by the Free Software Foundation; either version 2
   7         of the License, or (at your option) any later version.
   8
   9         This program is distributed in the hope that it will be useful,
  10         but WITHOUT ANY WARRANTY; without even the implied warranty of
  11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13         See the GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18 /*
  19  * libxmp is licensed under the terms of the Lesser General Public License 2.1
  20  */
  21
  22
  23 #include "quakedef.h"
  24 #include "snd_main.h"
  25 #include "snd_xmp.h"
  26
  27 #ifdef LINK_TO_LIBXMP
  28 #include <xmp.h>
  29
  30 /* libxmp API */
  31 // Version and player information
  32 #define qxmp_version xmp_version // const char *xmp_version
  33 #define qxmp_vercode xmp_vercode // const unsigned int xmp_vercode
  34 //#define qxmp_get_format_list xmp_get_format_list // char **xmp_get_format_list()
  35 // Context creation
  36 #define qxmp_create_context xmp_create_context // xmp_context xmp_create_context()
  37 #define qxmp_free_context xmp_free_context // void xmp_free_context(xmp_context c)
  38 // Module loading
  39 #define qxmp_test_module xmp_test_module // int xmp_test_module(char *path, struct xmp_test_info *test_info)
  40 //#define qxmp_load_module xmp_load_module // int xmp_load_module(xmp_context c, char *path)
  41 #define qxmp_load_module_from_memory xmp_load_module_from_memory // int xmp_load_module_from_memory(xmp_context c, void *mem, long size)
  42 //#define qxmp_load_module_from_file xmp_load_module_from_file // int xmp_load_module_from_file(xmp_context c, FILE *f, long size)
  43 #define qxmp_release_module xmp_release_module // void xmp_release_module(xmp_context c)
  44 //#define qxmp_scan_module xmp_scan_module // void xmp_scan_module(xmp_context c)
  45 #define qxmp_get_module_info xmp_get_module_info // void xmp_get_module_info(xmp_context c, struct xmp_module_info *info)
  46 // Module playing
  47 #define qxmp_start_player xmp_start_player // int xmp_start_player(xmp_context c, int rate, int format)
  48 #define qxmp_play_frame xmp_play_frame // int xmp_play_frame(xmp_context c)
  49 #define qxmp_play_buffer xmp_play_buffer // int xmp_play_buffer(xmp_context c, void *buffer, int size, int loop)
  50 #define qxmp_get_frame_info xmp_get_frame_info // void xmp_get_frame_info(xmp_context c, struct xmp_frame_info *info)
  51 #define qxmp_end_player xmp_end_player // void xmp_end_player(xmp_context c)
  52 // Player control
  53 //#define qxmp_next_position xmp_next_position // int xmp_next_position(xmp_context c)
  54 //#define qxmp_prev_position xmp_prev_position// int xmp_prev_position(xmp_context c)
  55 //#define qxmp_set_position xmp_set_position // int xmp_set_position(xmp_context c, int pos)
  56 //#define qxmp_stop_module xmp_stop_module // void xmp_stop_module(xmp_context c)
  57 //#define qxmp_restart_module xmp_restart_module // void xmp_restart_module(xmp_context c)
  58 //#define qxmp_seek_time xmp_seek_time // int xmp_seek_time(xmp_context c, int time)
  59 //#define qxmp_channel_mute xmp_channel_mute // int xmp_channel_mute(xmp_context c, int channel, int status)
  60 //#define qxmp_channel_vol xmp_channel_vol // int xmp_channel_vol(xmp_context c, int channel, int vol)
  61 //#define qxmp_inject_event xmp_inject_event // void xmp_inject_event(xmp_context c, int channel, struct xmp_event *event)
  62 // Player parameter setting
  63 //#define qxmp_set_instrument_path xmp_set_instrument_path // int xmp_set_instrument_path(xmp_context c, char *path)
  64 #define qxmp_get_player xmp_get_player // int xmp_get_player(xmp_context c, int param)
  65 #define qxmp_set_player xmp_set_player // int xmp_set_player(xmp_context c, int param, int val)
  66
  67 #define xmp_dll 1
  68
  69 qboolean XMP_OpenLibrary (void)
  70 {
  71         Con_Printf("Linked against libxmp version %s (0x0%x)\n", qxmp_version, qxmp_vercode);
  72         return true;
  73 }
  74 void XMP_CloseLibrary (void) {}
  75 #else
  76
  77 /* libxmp ABI */
  78 /*
  79 =================================================================
  80
  81   definitions from xmp.h
  82
  83 =================================================================
  84 */
  85
  86 // constants from libxmp
  87 #define XMP_NAME_SIZE           64      /* Size of module name and type */
  88
  89 /* sample format flags */
  90 #define XMP_FORMAT_8BIT         (1 << 0) /* Mix to 8-bit instead of 16 */
  91 #define XMP_FORMAT_UNSIGNED     (1 << 1) /* Mix to unsigned samples */
  92 #define XMP_FORMAT_MONO         (1 << 2) /* Mix to mono instead of stereo */
  93
  94 /* player parameters */
  95 #define XMP_PLAYER_AMP          0       /* Amplification factor */
  96 #define XMP_PLAYER_MIX          1       /* Stereo mixing */
  97 #define XMP_PLAYER_INTERP       2       /* Interpolation type */
  98 #define XMP_PLAYER_DSP          3       /* DSP effect flags */
  99 #define XMP_PLAYER_FLAGS        4       /* Player flags */
 100 #define XMP_PLAYER_CFLAGS       5       /* Player flags for current module */
 101 #define XMP_PLAYER_SMPCTL       6       /* Sample control flags */
 102 #define XMP_PLAYER_VOLUME       7       /* Player module volume */
 103 #define XMP_PLAYER_STATE        8       /* Internal player state */
 104 #define XMP_PLAYER_SMIX_VOLUME  9       /* SMIX volume */
 105 #define XMP_PLAYER_DEFPAN       10      /* Default pan setting */
 106
 107 /* interpolation types */
 108 #define XMP_INTERP_NEAREST      0       /* Nearest neighbor */
 109 #define XMP_INTERP_LINEAR       1       /* Linear (default) */
 110 #define XMP_INTERP_SPLINE       2       /* Cubic spline */
 111
 112 /* player state */
 113 #define XMP_STATE_UNLOADED      0       /* Context created */
 114 #define XMP_STATE_LOADED        1       /* Module loaded */
 115 #define XMP_STATE_PLAYING       2       /* Module playing */
 116
 117 /* sample flags */
 118 #define XMP_SMPCTL_SKIP         (1 << 0) /* Don't load samples */
 119
 120 /* limits */
 121 //#define XMP_MAX_KEYS          121     /* Number of valid keys */
 122 //#define XMP_MAX_ENV_POINTS    32      /* Max number of envelope points */
 123 #define XMP_MAX_MOD_LENGTH      256     /* Max number of patterns in module */
 124 //#define XMP_MAX_CHANNELS      64      /* Max number of channels in module */
 125 //#define XMP_MAX_SRATE         49170   /* max sampling rate (Hz) */
 126 //#define XMP_MIN_SRATE         4000    /* min sampling rate (Hz) */
 127 //#define XMP_MIN_BPM           20      /* min BPM */
 128 #define XMP_MAX_FRAMESIZE       (5 * XMP_MAX_SRATE * 2 / XMP_MIN_BPM)
 129
 130 /* error codes */
 131 #define XMP_END                 1
 132 #define XMP_ERROR_INTERNAL      2       /* Internal error */
 133 #define XMP_ERROR_FORMAT        3       /* Unsupported module format */
 134 #define XMP_ERROR_LOAD          4       /* Error loading file */
 135 #define XMP_ERROR_DEPACK        5       /* Error depacking file */
 136 #define XMP_ERROR_SYSTEM        6       /* System error */
 137 #define XMP_ERROR_INVALID       7       /* Invalid parameter */
 138 #define XMP_ERROR_STATE         8       /* Invalid player state */
 139
 140 // types from libxmp
 141 typedef char *xmp_context;
 142
 143 static const char **qxmp_version;
 144 static const unsigned int *qxmp_vercode;
 145
 146 struct xmp_channel {
 147 //      int pan;                        /* Channel pan (0x80 is center) */
 148 //      int vol;                        /* Channel volume */
 149 //#define XMP_CHANNEL_SYNTH     (1 << 0)  /* Channel is synthesized */
 150 //#define XMP_CHANNEL_MUTE      (1 << 1)  /* Channel is muted */
 151 //      int flg;                        /* Channel flags */
 152 };
 153
 154 //struct xmp_sequence {
 155 //      int entry_point;
 156 //      int duration;
 157 //};
 158
 159 struct xmp_module {
 160         char name[XMP_NAME_SIZE];       /* Module title */
 161         char type[XMP_NAME_SIZE];       /* Module format */
 162         int pat;                        /* Number of patterns */
 163         int trk;                        /* Number of tracks */
 164         int chn;                        /* Tracks per pattern */
 165         int ins;                        /* Number of instruments */
 166         int smp;                        /* Number of samples */
 167         int spd;                        /* Initial speed */
 168         int bpm;                        /* Initial BPM */
 169         int len;                        /* Module length in patterns */
 170         int rst;                        /* Restart position */
 171         int gvl;                        /* Global volume */
 172
 173         struct xmp_pattern **xxp;       /* Patterns */
 174         struct xmp_track **xxt;         /* Tracks */
 175         struct xmp_instrument *xxi;     /* Instruments */
 176         struct xmp_sample *xxs;         /* Samples */
 177         struct xmp_channel xxc[64];     /* Channel info */
 178         unsigned char xxo[XMP_MAX_MOD_LENGTH];  /* Orders */
 179 };
 180
 181 struct xmp_test_info {
 182 //      char name[XMP_NAME_SIZE];       /* Module title */
 183 //      char type[XMP_NAME_SIZE];       /* Module format */
 184 };
 185
 186 struct xmp_module_info {
 187         unsigned char md5[16];          /* MD5 message digest */
 188         int vol_base;                   /* Volume scale */
 189         struct xmp_module *mod;         /* Pointer to module data */
 190         char *comment;                  /* Comment text, if any */
 191         int num_sequences;              /* Number of valid sequences */
 192         struct xmp_sequence *seq_data;  /* Pointer to sequence data */
 193 };
 194
 195 struct xmp_frame_info {                 /* Current frame information */
 196 //      int pos;                        /* Current position */
 197 //      int pattern;                    /* Current pattern */
 198 //      int row;                        /* Current row in pattern */
 199 //      int num_rows;                   /* Number of rows in current pattern */
 200 //      int frame;                      /* Current frame */
 201 //      int speed;                      /* Current replay speed */
 202 //      int bpm;                        /* Current bpm */
 203 //      int time;                       /* Current module time in ms */
 204 //      int total_time;                 /* Estimated replay time in ms*/
 205 //      int frame_time;                 /* Frame replay time in us */
 206 //      void *buffer;                   /* Pointer to sound buffer */
 207 //      int buffer_size;                /* Used buffer size */
 208 //      int total_size;                 /* Total buffer size */
 209 //      int volume;                     /* Current master volume */
 210 //      int loop_count;                 /* Loop counter */
 211 //      int virt_channels;              /* Number of virtual channels */
 212 //      int virt_used;                  /* Used virtual channels */
 213 //      int sequence;                   /* Current sequence */
 214 //
 215 //      struct xmp_channel_info {       /* Current channel information */
 216 //              unsigned int period;    /* Sample period */
 217 //              unsigned int position;  /* Sample position */
 218 //              short pitchbend;        /* Linear bend from base note*/
 219 //              unsigned char note;     /* Current base note number */
 220 //              unsigned char instrument; /* Current instrument number */
 221 //              unsigned char sample;   /* Current sample number */
 222 //              unsigned char volume;   /* Current volume */
 223 //              unsigned char pan;      /* Current stereo pan */
 224 //              unsigned char reserved; /* Reserved */
 225 //              struct xmp_event event; /* Current track event */
 226 //      } channel_info[XMP_MAX_CHANNELS];
 227 };
 228
 229 // Functions exported from libxmp
 230 static xmp_context (*qxmp_create_context)  (void);
 231 static void        (*qxmp_free_context)    (xmp_context);
 232 static int         (*qxmp_test_module)     (char *, struct xmp_test_info *);
 233 //static int         (*qxmp_load_module)     (xmp_context, char *);
 234 //static void        (*qxmp_scan_module)     (xmp_context);
 235 static void        (*qxmp_release_module)  (xmp_context);
 236 static int         (*qxmp_start_player)    (xmp_context, int, int);
 237 static int         (*qxmp_play_frame)      (xmp_context);
 238 static int         (*qxmp_play_buffer)     (xmp_context, void *, int, int);
 239 static void        (*qxmp_get_frame_info)  (xmp_context, struct xmp_frame_info *);
 240 static void        (*qxmp_end_player)      (xmp_context);
 241 //static void        (*qxmp_inject_event)    (xmp_context, int, struct xmp_event *);
 242 static void        (*qxmp_get_module_info) (xmp_context, struct xmp_module_info *);
 243 //static char      **(*qxmp_get_format_list) (void); // FIXME: did I do this right?
 244 //static int         (*qxmp_next_position)   (xmp_context);
 245 //static int         (*qxmp_prev_position)   (xmp_context);
 246 //static int         (*qxmp_set_position)    (xmp_context, int);
 247 //static void        (*qxmp_stop_module)     (xmp_context);
 248 //static void        (*qxmp_restart_module)  (xmp_context);
 249 //static int         (*qxmp_seek_time)       (xmp_context, int);
 250 //static int         (*qxmp_channel_mute)    (xmp_context, int, int);
 251 //static int         (*qxmp_channel_vol)     (xmp_context, int, int);
 252 static int         (*qxmp_set_player)      (xmp_context, int, int);
 253 static int         (*qxmp_get_player)      (xmp_context, int);
 254 //static int         (*qxmp_set_instrument_path) (xmp_context, char *);
 255 static int         (*qxmp_load_module_from_memory) (xmp_context, void *, long);
 256 //static int         (*qxmp_load_module_from_file) (xmp_context, void *, long);
 257 //static int        (XMP_EXPORT *qxmp_load_module_from_file) (xmp_context, void *, long);
 258
 259 /* External sample mixer API */
 260 /*
 261 static int         (*qxmp_start_smix)       (xmp_context, int, int);
 262 static void        (*qxmp_end_smix)         (xmp_context);
 263 static int         (*qxmp_smix_play_instrument)(xmp_context, int, int, int, int);
 264 static int         (*qxmp_smix_play_sample) (xmp_context, int, int, int, int);
 265 static int         (*qxmp_smix_channel_pan) (xmp_context, int, int);
 266 static int         (*qxmp_smix_load_sample) (xmp_context, int, char *);
 267 static int         (*qxmp_smix_release_sample) (xmp_context, int);
 268 // end Functions exported from libxmp
 269 */
 270
 271 /*
 272 =================================================================
 273
 274   DarkPlaces definitions
 275
 276 =================================================================
 277 */
 278
 279 static dllfunction_t xmpfuncs[] =
 280 {
 281         /* libxmp ABI */
 282         // Version and player information
 283         {"xmp_version",                 (void **) &qxmp_version},
 284         {"xmp_vercode",                 (void **) &qxmp_vercode},
 285 //      {"xmp_get_format_list",         (void **) &qxmp_get_format_list},
 286         // Context creation
 287         {"xmp_create_context",          (void **) &qxmp_create_context},
 288         {"xmp_free_context",            (void **) &qxmp_free_context},
 289         // Module loading
 290         {"xmp_test_module",             (void **) &qxmp_test_module},
 291 //      {"xmp_load_module",             (void **) &qxmp_load_module},
 292         {"xmp_load_module_from_memory", (void **) &qxmp_load_module_from_memory}, // since libxmp 4.2.0
 293 //      {"xmp_load_module_from_file",   (void **) &qxmp_load_module_from_file},   // since libxmp 4.3.0
 294         {"xmp_release_module",          (void **) &qxmp_release_module},
 295 //      {"xmp_scan_module",             (void **) &qxmp_scan_module},
 296         {"xmp_get_module_info",         (void **) &qxmp_get_module_info},
 297         // Module playing
 298         {"xmp_start_player",            (void **) &qxmp_start_player},
 299         {"xmp_play_frame",              (void **) &qxmp_play_frame},
 300         {"xmp_play_buffer",             (void **) &qxmp_play_buffer},
 301         {"xmp_get_frame_info",          (void **) &qxmp_get_frame_info},
 302         {"xmp_end_player",              (void **) &qxmp_end_player},
 303         // Player control
 304 //      {"xmp_next_position",           (void **) &qxmp_next_position},
 305 //      {"xmp_prev_position",           (void **) &qxmp_prev_position},
 306 //      {"xmp_set_position",            (void **) &qxmp_set_position},
 307 //      {"xmp_stop_module",             (void **) &qxmp_stop_module},
 308 //      {"xmp_restart_module",          (void **) &qxmp_restart_module},
 309 //      {"xmp_seek_time",               (void **) &qxmp_seek_time},
 310 //      {"xmp_channel_mute",            (void **) &qxmp_channel_mute},
 311 //      {"xmp_channel_vol",             (void **) &qxmp_channel_vol},
 312 //      {"xmp_inject_event",            (void **) &qxmp_inject_event},
 313         // Player parameter setting
 314 //      {"xmp_set_instrument_path",     (void **) &qxmp_set_instrument_path},
 315         {"xmp_get_player",              (void **) &qxmp_get_player},
 316         {"xmp_set_player",              (void **) &qxmp_set_player},
 317         /* smix */ // for completeness sake only, right now
 318 //      {"xmp_start_smix",              (void **) &qxmp_start_smix},
 319 //      {"xmp_end_smix",                (void **) &qxmp_end_smix},
 320 //      {"xmp_smix_play_instrument",    (void **) &qxmp_smix_play_instrument},
 321 //      {"xmp_smix_play_sample",        (void **) &qxmp_smix_play_sample},
 322 //      {"xmp_smix_channel_pan",        (void **) &qxmp_smix_channel_pan},
 323 //      {"xmp_smix_load_sample",        (void **) &qxmp_smix_load_sample},
 324 //      {"xmp_smix_release_sample",     (void **) &qxmp_smix_release_sample},
 325         {NULL, NULL}
 326 };
 327
 328 // libxmp DLL handle
 329 static dllhandle_t xmp_dll = NULL;
 330
 331
 332 /*
 333 =================================================================
 334
 335   DLL load & unload
 336
 337 =================================================================
 338 */
 339
 340 /*
 341 ====================
 342 XMP_OpenLibrary
 343
 344 Try to load the libxmp DLL
 345 ====================
 346 */
 347 qboolean XMP_OpenLibrary (void)
 348 {
 349         const char* dllnames_xmp [] =
 350         {
 351 #if defined(WIN32)
 352                 "libxmp.dll",
 353 #elif defined(MACOSX) // FIXME: untested, please test a mac os build
 354                 "libxmp.4.dylib",
 355                 "libxmp.dylib",
 356 #else
 357                 "libxmp.so.4",
 358                 "libxmp.so",
 359 #endif
 360                 NULL
 361         };
 362
 363         if (xmp_dll) // Already loaded?
 364                 return true;
 365
 366 // COMMANDLINEOPTION: Sound: -noxmp disables xmp module sound support
 367         if (COM_CheckParm("-noxmp"))
 368                 return false;
 369
 370         // Load the DLL
 371         if (Sys_LoadLibrary (dllnames_xmp, &xmp_dll, xmpfuncs))
 372         {
 373                 if (*qxmp_vercode < 0x040200)
 374                 {
 375                         Con_Printf("Found incompatible XMP library version %s, not loading. (4.2.0 or higher required)\n", *qxmp_version);
 376                         Sys_UnloadLibrary (&xmp_dll);
 377                         return false;
 378                 }
 379                 Con_Printf("XMP library loaded, version %s (0x0%x)\n", *qxmp_version, *qxmp_vercode);
 380                 return true;
 381         }
 382         else
 383                 return false;
 384 }
 385
 386
 387 /*
 388 ====================
 389 XMP_CloseLibrary
 390
 391 Unload the libxmp DLL
 392 ====================
 393 */
 394 void XMP_CloseLibrary (void)
 395 {
 396         Sys_UnloadLibrary (&xmp_dll);
 397 }
 398
 399 #endif
 400
 401 /*
 402 =================================================================
 403
 404         Module file decoding
 405
 406 =================================================================
 407 */
 408
 409 // Per-sfx data structure
 410 typedef struct
 411 {
 412         unsigned char   *file;
 413         size_t          filesize;
 414 } xmp_stream_persfx_t;
 415
 416 // Per-channel data structure
 417 typedef struct
 418 {
 419         xmp_context     playercontext;
 420         int             bs;
 421         int             buffer_firstframe;
 422         int             buffer_numframes;
 423         unsigned char   buffer[STREAM_BUFFERSIZE*4];
 424 } xmp_stream_perchannel_t;
 425
 426
 427 /*
 428 ====================
 429 XMP_GetSamplesFloat
 430 ====================
 431 */
 432 static void XMP_GetSamplesFloat(channel_t *ch, sfx_t *sfx, int firstsampleframe, int numsampleframes, float *outsamplesfloat)
 433 {
 434         int i, len = numsampleframes * sfx->format.channels;
 435         int f = sfx->format.width * sfx->format.channels; // bytes per frame in the buffer
 436         xmp_stream_perchannel_t* per_ch = (xmp_stream_perchannel_t *)ch->fetcher_data;
 437         xmp_stream_persfx_t* per_sfx = (xmp_stream_persfx_t *)sfx->fetcher_data;
 438         const short *buf;
 439         int newlength, done;
 440         unsigned int format = 0;
 441
 442         // if this channel does not yet have a channel fetcher, make one
 443         if (per_ch == NULL)
 444         {
 445                 // allocate a struct to keep track of our file position and buffer
 446                 per_ch = (xmp_stream_perchannel_t *)Mem_Alloc(snd_mempool, sizeof(*per_ch));
 447
 448                 // create an xmp file context
 449                 if ((per_ch->playercontext = qxmp_create_context()) == NULL)
 450                 {
 451                         //Con_Printf("error getting a libxmp file context; while trying to load file \"%s\"\n", filename);
 452                         Mem_Free(per_ch);
 453                         return;
 454                 }
 455                 // copy file to xmp
 456                 if (qxmp_load_module_from_memory(per_ch->playercontext, (void *)per_sfx->file, (long)per_sfx->filesize) < 0)
 457                 {
 458                         qxmp_free_context(per_ch->playercontext);
 459                         Mem_Free(per_ch);
 460                         return;
 461                 }
 462
 463                 // start playing the loaded file
 464                 if (sfx->format.width == 1)    { format |= XMP_FORMAT_8BIT; } // else 16bit
 465                 if (sfx->format.channels == 1) { format |= XMP_FORMAT_MONO; } // else stereo
 466                 if (qxmp_start_player(per_ch->playercontext, sfx->format.speed, format) < 0) // FIXME: only if speed is in XMP acceptable range, else default to 48khz and let DP mix
 467                 {
 468                         Mem_Free(per_ch);
 469                         return;
 470                 }
 471
 472                 per_ch->bs = 0;
 473                 per_ch->buffer_firstframe = 0;
 474                 per_ch->buffer_numframes = 0;
 475                 // attach the struct to our channel
 476                 ch->fetcher_data = (void *)per_ch;
 477
 478                 // reset internal xmp state / syncs buffer start with frame start
 479                 qxmp_play_buffer(per_ch->playercontext, NULL, 0, 0);
 480         }
 481
 482         // if the request is too large for our buffer, loop...
 483         while (numsampleframes * f > (int)sizeof(per_ch->buffer))
 484         {
 485                 done = sizeof(per_ch->buffer) / f;
 486                 XMP_GetSamplesFloat(ch, sfx, firstsampleframe, done, outsamplesfloat);
 487                 firstsampleframe += done;
 488                 numsampleframes -= done;
 489                 outsamplesfloat += done * sfx->format.channels;
 490         }
 491
 492         // seek if the request is before the current buffer (loop back)
 493         // seek if the request starts beyond the current buffer by at least one frame (channel was zero volume for a while)
 494         // do not seek if the request overlaps the buffer end at all (expected behavior)
 495         if (per_ch->buffer_firstframe > firstsampleframe || per_ch->buffer_firstframe + per_ch->buffer_numframes < firstsampleframe)
 496         {
 497                 // we expect to decode forward from here so this will be our new buffer start
 498                 per_ch->buffer_firstframe = firstsampleframe;
 499                 per_ch->buffer_numframes = 0;
 500                 // no seeking at this time
 501         }
 502
 503         // render the file to pcm as needed
 504         if (firstsampleframe + numsampleframes > per_ch->buffer_firstframe + per_ch->buffer_numframes)
 505         {
 506                 // first slide the buffer back, discarding any data preceding the range we care about
 507                 int offset = firstsampleframe - per_ch->buffer_firstframe;
 508                 int keeplength = per_ch->buffer_numframes - offset;
 509                 if (keeplength > 0)
 510                         memmove(per_ch->buffer, per_ch->buffer + offset * sfx->format.width * sfx->format.channels, keeplength * sfx->format.width * sfx->format.channels);
 511                 per_ch->buffer_firstframe = firstsampleframe;
 512                 per_ch->buffer_numframes -= offset;
 513                 // render as much as we can fit in the buffer
 514                 newlength = sizeof(per_ch->buffer) - per_ch->buffer_numframes * f;
 515                 done = 0;
 516 //              while (newlength > done && qxmp_play_buffer(per_ch->playercontext, (void *)((char *)per_ch->buffer + done), (int)(newlength - done), 1) == 0) // don't loop by default (TODO: fix pcm duration calculation first)
 517                 while (newlength > done && qxmp_play_buffer(per_ch->playercontext, (void *)((char *)per_ch->buffer + done), (int)(newlength - done), 0) == 0) // loop forever
 518                 {
 519                         done += (int)(newlength - done);
 520                 }
 521                 // clear the missing space if any
 522                 if (done < newlength)
 523                 {
 524                         memset(per_ch->buffer + done, 0, newlength - done);
 525                 }
 526                 // we now have more data in the buffer
 527                 per_ch->buffer_numframes += done / f;
 528         }
 529
 530         // convert the sample format for the caller
 531         buf = (short *)((char *)per_ch->buffer + (firstsampleframe - per_ch->buffer_firstframe) * f);
 532         for (i = 0;i < len;i++)
 533                 outsamplesfloat[i] = buf[i] * (1.0f / 32768.0f);
 534 }
 535
 536 /*
 537 ====================
 538 XMP_StopChannel
 539 ====================
 540 */
 541 static void XMP_StopChannel(channel_t *ch)
 542 {
 543         xmp_stream_perchannel_t *per_ch = (xmp_stream_perchannel_t *)ch->fetcher_data;
 544         if (per_ch != NULL)
 545         {
 546                 // stop the player
 547                 qxmp_end_player(per_ch->playercontext);
 548                 // free the module
 549                 qxmp_release_module(per_ch->playercontext);
 550                 // free the xmp playercontext
 551                 qxmp_free_context(per_ch->playercontext);
 552                 Mem_Free(per_ch);
 553         }
 554 }
 555
 556 /*
 557 ====================
 558 XMP_FreeSfx
 559 ====================
 560 */
 561 static void XMP_FreeSfx(sfx_t *sfx)
 562 {
 563         xmp_stream_persfx_t* per_sfx = (xmp_stream_persfx_t *)sfx->fetcher_data;
 564         // free the complete file we were keeping around
 565         Mem_Free(per_sfx->file);
 566         // free the file information structure
 567         Mem_Free(per_sfx);
 568 }
 569
 570 static const snd_fetcher_t xmp_fetcher = { XMP_GetSamplesFloat, XMP_StopChannel, XMP_FreeSfx };
 571
 572 /*
 573 ===============
 574 XMP_LoadModFile
 575
 576 Load an XMP module file into memory
 577 ===============
 578 */
 579 qboolean XMP_LoadModFile(const char *filename, sfx_t *sfx)
 580 {
 581         fs_offset_t filesize;
 582         unsigned char *data;
 583         xmp_context xc;
 584         xmp_stream_persfx_t* per_sfx;
 585         struct xmp_module_info mi;
 586
 587 #ifndef LINK_TO_LIBXMP
 588         if (!xmp_dll)
 589                 return false;
 590 #endif
 591
 592 // COMMANDLINEOPTION: Sound: -noxmp disables xmp module sound support
 593         if (COM_CheckParm("-noxmp"))
 594                 return false;
 595
 596         // Return if already loaded
 597         if (sfx->fetcher != NULL)
 598                 return true;
 599
 600         // Load the file
 601         data = FS_LoadFile(filename, snd_mempool, false, &filesize);
 602         if (data == NULL)
 603                 return false;
 604
 605         // Create an xmp file context
 606         if ((xc = qxmp_create_context()) == NULL)
 607         {
 608                 Con_Printf("error creating a libxmp file context; while trying to load file \"%s\"\n", filename);
 609                 Mem_Free(data);
 610                 return false;
 611         }
 612
 613         if (developer_loading.integer >= 2)
 614                 Con_Printf("Loading Module file (libxmp) \"%s\"\n", filename);
 615
 616         if (qxmp_load_module_from_memory(xc, (void *)data, (long)filesize) < 0) // Added in libxmp 4.2
 617         {
 618                 Con_Printf("error while trying to load xmp module \"%s\"\n", filename);
 619                 qxmp_free_context(xc);
 620                 Mem_Free(data);
 621                 return false;
 622         }
 623
 624         if (developer_loading.integer >= 2)
 625                 Con_Printf ("\"%s\" will be streamed\n", filename);
 626
 627         // keep the file around
 628         per_sfx = (xmp_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
 629         per_sfx->file = data;
 630         per_sfx->filesize = filesize;
 631         // set dp sfx
 632         sfx->memsize += sizeof(*per_sfx);
 633         sfx->memsize += filesize; // total memory used (including sfx_t and fetcher data)
 634 //      sfx->format // format describing the audio data that fetcher->getsamplesfloat shall return
 635         sfx->format.speed = 48000; // default to this sample rate
 636         sfx->format.width = 2;  // default to 16 bit samples
 637 //      sfx->format.width = 1; // 8-bit
 638         sfx->format.channels = 2; // default to stereo
 639 //      sfx->format.channels = 1; // mono
 640         sfx->flags |= SFXFLAG_STREAMED; // cf SFXFLAG_* defines
 641 //      sfx->total_length // in (pcm) sample frames
 642         sfx->total_length = 1<<30; // 2147384647; // they always loop (FIXME this breaks after 6 hours, we need support for a real "infinite" value!)
 643         sfx->loopstart = sfx->total_length; // (modplug does it) in sample frames. equals total_length if not looped
 644         sfx->fetcher_data = per_sfx;
 645         sfx->fetcher = &xmp_fetcher;
 646 //      sfx->volume_mult // for replay gain (multiplier to apply)
 647 //      sfx->volume_peak // for replay gain (highest peak); if set to 0, ReplayGain isn't supported
 648
 649         qxmp_get_module_info(xc, &mi);
 650         if (developer_loading.integer >= 1)
 651         {
 652                 Con_Printf("Decoding module (libxmp):\n"
 653                         "    Module name  : %s\n"
 654                         "    Module type  : %s\n"
 655                         "    Module length: %i patterns\n"
 656                         "    Patterns     : %i\n"
 657                         "    Instruments  : %i\n"
 658                         "    Samples      : %i\n"
 659                         "    Channels     : %i\n"
 660                         "    Initial Speed: %i\n"
 661                         "    Initial BPM  : %i\n"
 662                         "    Restart Pos. : %i\n"
 663                         "    Global Volume: %i\n",
 664                         mi.mod->name, mi.mod->type,
 665                         mi.mod->len, mi.mod->pat, mi.mod->ins, mi.mod->smp, mi.mod->chn,
 666                         mi.mod->spd, mi.mod->bpm, mi.mod->rst, mi.mod->gvl
 667                 );
 668         }
 669         else if (developer.integer >= 1)
 670                 Con_Printf("Decoding module (libxmp) \"%s\" (%s)\n", mi.mod->name, mi.mod->type);
 671
 672         qxmp_free_context(xc);
 673         return true;
 674 }