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