summaryrefslogtreecommitdiff
path: root/apps/plugins/mikmod/mikmod.h
diff options
context:
space:
mode:
Diffstat (limited to 'apps/plugins/mikmod/mikmod.h')
-rw-r--r--apps/plugins/mikmod/mikmod.h783
1 files changed, 783 insertions, 0 deletions
diff --git a/apps/plugins/mikmod/mikmod.h b/apps/plugins/mikmod/mikmod.h
new file mode 100644
index 0000000000..a1c201f6d2
--- /dev/null
+++ b/apps/plugins/mikmod/mikmod.h
@@ -0,0 +1,783 @@
1/* MikMod sound library
2 (c) 1998, 1999, 2000 Miodrag Vallat and others - see file AUTHORS
3 for complete list.
4
5 This library is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of
8 the License, or (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18 02111-1307, USA.
19*/
20
21/*==============================================================================
22
23 $Id: mikmod.h.in,v 1.3 2005/03/30 19:09:21 realtech Exp $
24
25 MikMod sound library include file
26
27==============================================================================*/
28
29#ifndef _MIKMOD_H_
30#define _MIKMOD_H_
31
32#include <stdio.h>
33#include <stdlib.h>
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39#include "mikmod_supp.h"
40
41/*
42 * ========== Compiler magic for shared libraries
43 */
44
45#if defined WIN32 && defined _DLL
46#ifdef DLL_EXPORTS
47#define MIKMODAPI __declspec(dllexport)
48#else
49#define MIKMODAPI __declspec(dllimport)
50#endif
51#else
52#define MIKMODAPI
53#endif
54
55/*
56 * ========== Library version
57 */
58
59#define LIBMIKMOD_VERSION_MAJOR 3L
60#define LIBMIKMOD_VERSION_MINOR 2L
61#define LIBMIKMOD_REVISION 0L
62
63#define LIBMIKMOD_VERSION \
64 ((LIBMIKMOD_VERSION_MAJOR<<16)| \
65 (LIBMIKMOD_VERSION_MINOR<< 8)| \
66 (LIBMIKMOD_REVISION))
67
68MIKMODAPI extern long MikMod_GetVersion(void);
69
70/*
71 * ========== Platform independent-type definitions
72 */
73#if 0
74#ifdef WIN32
75#define WIN32_LEAN_AND_MEAN
76#include <windows.h>
77#include <io.h>
78#include <mmsystem.h>
79#endif
80
81#if defined(__OS2__)||defined(__EMX__)
82#define INCL_DOSSEMAPHORES
83#include <os2.h>
84#else
85typedef char CHAR;
86#endif
87#endif
88
89typedef char CHAR;
90
91
92#if defined(__arch64__) || defined(__alpha) || defined(__x86_64) || defined(__powerpc64__)
93/* 64 bit architectures */
94
95typedef signed char SBYTE; /* 1 byte, signed */
96typedef unsigned char UBYTE; /* 1 byte, unsigned */
97typedef signed short SWORD; /* 2 bytes, signed */
98typedef unsigned short UWORD; /* 2 bytes, unsigned */
99typedef signed int SLONG; /* 4 bytes, signed */
100typedef unsigned int ULONG; /* 4 bytes, unsigned */
101//typedef int BOOL; /* 0=false, <>0 true */
102
103#else
104/* 32 bit architectures */
105
106typedef signed char SBYTE; /* 1 byte, signed */
107typedef unsigned char UBYTE; /* 1 byte, unsigned */
108typedef signed short SWORD; /* 2 bytes, signed */
109typedef unsigned short UWORD; /* 2 bytes, unsigned */
110typedef signed long SLONG; /* 4 bytes, signed */
111#if !defined(__OS2__)&&!defined(__EMX__)&&!defined(WIN32)
112typedef unsigned long ULONG; /* 4 bytes, unsigned */
113//typedef int BOOL; /* 0=false, <>0 true */
114#endif
115#endif
116
117/*
118 * ========== Error codes
119 */
120
121enum {
122 MMERR_OPENING_FILE = 1,
123 MMERR_OUT_OF_MEMORY,
124 MMERR_DYNAMIC_LINKING,
125
126 MMERR_SAMPLE_TOO_BIG,
127 MMERR_OUT_OF_HANDLES,
128 MMERR_UNKNOWN_WAVE_TYPE,
129
130 MMERR_LOADING_PATTERN,
131 MMERR_LOADING_TRACK,
132 MMERR_LOADING_HEADER,
133 MMERR_LOADING_SAMPLEINFO,
134 MMERR_NOT_A_MODULE,
135 MMERR_NOT_A_STREAM,
136 MMERR_MED_SYNTHSAMPLES,
137 MMERR_ITPACK_INVALID_DATA,
138
139 MMERR_DETECTING_DEVICE,
140 MMERR_INVALID_DEVICE,
141 MMERR_INITIALIZING_MIXER,
142 MMERR_OPENING_AUDIO,
143 MMERR_8BIT_ONLY,
144 MMERR_16BIT_ONLY,
145 MMERR_STEREO_ONLY,
146 MMERR_ULAW,
147 MMERR_NON_BLOCK,
148
149 MMERR_AF_AUDIO_PORT,
150
151 MMERR_AIX_CONFIG_INIT,
152 MMERR_AIX_CONFIG_CONTROL,
153 MMERR_AIX_CONFIG_START,
154
155 MMERR_GUS_SETTINGS,
156 MMERR_GUS_RESET,
157 MMERR_GUS_TIMER,
158
159 MMERR_HP_SETSAMPLESIZE,
160 MMERR_HP_SETSPEED,
161 MMERR_HP_CHANNELS,
162 MMERR_HP_AUDIO_OUTPUT,
163 MMERR_HP_AUDIO_DESC,
164 MMERR_HP_BUFFERSIZE,
165
166 MMERR_OSS_SETFRAGMENT,
167 MMERR_OSS_SETSAMPLESIZE,
168 MMERR_OSS_SETSTEREO,
169 MMERR_OSS_SETSPEED,
170
171 MMERR_SGI_SPEED,
172 MMERR_SGI_16BIT,
173 MMERR_SGI_8BIT,
174 MMERR_SGI_STEREO,
175 MMERR_SGI_MONO,
176
177 MMERR_SUN_INIT,
178
179 MMERR_OS2_MIXSETUP,
180 MMERR_OS2_SEMAPHORE,
181 MMERR_OS2_TIMER,
182 MMERR_OS2_THREAD,
183
184 MMERR_DS_PRIORITY,
185 MMERR_DS_BUFFER,
186 MMERR_DS_FORMAT,
187 MMERR_DS_NOTIFY,
188 MMERR_DS_EVENT,
189 MMERR_DS_THREAD,
190 MMERR_DS_UPDATE,
191
192 MMERR_WINMM_HANDLE,
193 MMERR_WINMM_ALLOCATED,
194 MMERR_WINMM_DEVICEID,
195 MMERR_WINMM_FORMAT,
196 MMERR_WINMM_UNKNOWN,
197
198 MMERR_MAC_SPEED,
199 MMERR_MAC_START,
200
201 MMERR_OSX_UNKNOWN_DEVICE,
202 MMERR_OSX_BAD_PROPERTY,
203 MMERR_OSX_UNSUPPORTED_FORMAT,
204 MMERR_OSX_SET_STEREO,
205 MMERR_OSX_BUFFER_ALLOC,
206 MMERR_OSX_ADD_IO_PROC,
207 MMERR_OSX_DEVICE_START,
208 MMERR_OSX_PTHREAD,
209
210 MMERR_DOSWSS_STARTDMA,
211 MMERR_DOSSB_STARTDMA,
212
213 MMERR_MAX
214};
215
216/*
217 * ========== Error handling
218 */
219
220typedef void (MikMod_handler)(void);
221typedef MikMod_handler *MikMod_handler_t;
222
223MIKMODAPI extern int MikMod_errno;
224MIKMODAPI extern int MikMod_critical;
225MIKMODAPI extern char *MikMod_strerror(int);
226
227MIKMODAPI extern MikMod_handler_t MikMod_RegisterErrorHandler(MikMod_handler_t);
228
229/*
230 * ========== Library initialization and core functions
231 */
232
233struct MDRIVER;
234
235MIKMODAPI extern void MikMod_RegisterAllDrivers(void);
236
237MIKMODAPI extern CHAR* MikMod_InfoDriver(void);
238MIKMODAPI extern void MikMod_RegisterDriver(struct MDRIVER*);
239MIKMODAPI extern int MikMod_DriverFromAlias(CHAR*);
240MIKMODAPI extern struct MDRIVER *MikMod_DriverByOrdinal(int);
241
242MIKMODAPI extern int MikMod_Init(CHAR*);
243MIKMODAPI extern void MikMod_Exit(void);
244MIKMODAPI extern int MikMod_Reset(CHAR*);
245MIKMODAPI extern int MikMod_SetNumVoices(int,int);
246MIKMODAPI extern int MikMod_Active(void);
247MIKMODAPI extern int MikMod_EnableOutput(void);
248MIKMODAPI extern void MikMod_DisableOutput(void);
249MIKMODAPI extern void MikMod_Update(void);
250
251MIKMODAPI extern int MikMod_InitThreads(void);
252MIKMODAPI extern void MikMod_Lock(void);
253MIKMODAPI extern void MikMod_Unlock(void);
254
255MIKMODAPI extern void* MikMod_malloc(size_t);
256MIKMODAPI extern void* MikMod_realloc(void *, size_t);
257MIKMODAPI extern void* MikMod_calloc(size_t,size_t);
258MIKMODAPI extern void MikMod_free(void*);
259
260/*
261 * ========== Reader, Writer
262 */
263
264typedef struct MREADER {
265 int (*Seek)(struct MREADER*,long,int);
266 long (*Tell)(struct MREADER*);
267 int (*Read)(struct MREADER*,void*,size_t);
268 int (*Get)(struct MREADER*);
269 int (*Eof)(struct MREADER*);
270 long iobase;
271 long prev_iobase;
272} MREADER;
273
274typedef struct MWRITER {
275 int (*Seek)(struct MWRITER*,long,int);
276 long (*Tell)(struct MWRITER*);
277 int (*Write)(struct MWRITER*,void*,size_t);
278 int (*Put)(struct MWRITER*,int);
279} MWRITER;
280
281/*
282 * ========== Samples
283 */
284
285/* Sample playback should not be interrupted */
286#define SFX_CRITICAL 1
287
288/* Sample format [loading and in-memory] flags: */
289#define SF_16BITS 0x0001
290#define SF_STEREO 0x0002
291#define SF_SIGNED 0x0004
292#define SF_BIG_ENDIAN 0x0008
293#define SF_DELTA 0x0010
294#define SF_ITPACKED 0x0020
295
296#define SF_FORMATMASK 0x003F
297
298/* General Playback flags */
299
300#define SF_LOOP 0x0100
301#define SF_BIDI 0x0200
302#define SF_REVERSE 0x0400
303#define SF_SUSTAIN 0x0800
304
305#define SF_PLAYBACKMASK 0x0C00
306
307/* Module-only Playback Flags */
308
309#define SF_OWNPAN 0x1000
310#define SF_UST_LOOP 0x2000
311
312#define SF_EXTRAPLAYBACKMASK 0x3000
313
314/* Panning constants */
315#define PAN_LEFT 0
316#define PAN_HALFLEFT 64
317#define PAN_CENTER 128
318#define PAN_HALFRIGHT 192
319#define PAN_RIGHT 255
320#define PAN_SURROUND 512 /* panning value for Dolby Surround */
321
322typedef struct SAMPLE {
323 SWORD panning; /* panning (0-255 or PAN_SURROUND) */
324 ULONG speed; /* Base playing speed/frequency of note */
325 UBYTE volume; /* volume 0-64 */
326 UWORD inflags; /* sample format on disk */
327 UWORD flags; /* sample format in memory */
328 ULONG length; /* length of sample (in samples!) */
329 ULONG loopstart; /* repeat position (relative to start, in samples) */
330 ULONG loopend; /* repeat end */
331 ULONG susbegin; /* sustain loop begin (in samples) \ Not Supported */
332 ULONG susend; /* sustain loop end / Yet! */
333
334 /* Variables used by the module player only! (ignored for sound effects) */
335 UBYTE globvol; /* global volume */
336 UBYTE vibflags; /* autovibrato flag stuffs */
337 UBYTE vibtype; /* Vibratos moved from INSTRUMENT to SAMPLE */
338 UBYTE vibsweep;
339 UBYTE vibdepth;
340 UBYTE vibrate;
341 CHAR* samplename; /* name of the sample */
342
343 /* Values used internally only */
344 UWORD avibpos; /* autovibrato pos [player use] */
345 UBYTE divfactor; /* for sample scaling, maintains proper period slides */
346 ULONG seekpos; /* seek position in file */
347 SWORD handle; /* sample handle used by individual drivers */
348 void (*onfree)(void *ctx); /* called from Sample_Free if not NULL */
349 void *ctx; /* context passed to previous function*/
350} SAMPLE;
351
352/* Sample functions */
353
354MIKMODAPI extern SAMPLE *Sample_LoadRaw(CHAR *,ULONG rate, ULONG channel, ULONG flags);
355MIKMODAPI extern SAMPLE *Sample_LoadRawFP(int fp,ULONG rate,ULONG channel, ULONG flags);
356MIKMODAPI extern SAMPLE *Sample_LoadRawMem(const char *buf, int len, ULONG rate, ULONG channel, ULONG flags);
357MIKMODAPI extern SAMPLE *Sample_LoadRawGeneric(MREADER*reader,ULONG rate, ULONG channel, ULONG flags);
358
359MIKMODAPI extern SAMPLE *Sample_Load(CHAR*);
360MIKMODAPI extern SAMPLE *Sample_LoadFP(int);
361MIKMODAPI extern SAMPLE *Sample_LoadMem(const char *buf, int len);
362MIKMODAPI extern SAMPLE *Sample_LoadGeneric(MREADER*);
363MIKMODAPI extern void Sample_Free(SAMPLE*);
364MIKMODAPI extern SBYTE Sample_Play(SAMPLE*,ULONG,UBYTE);
365
366MIKMODAPI extern void Voice_SetVolume(SBYTE,UWORD);
367MIKMODAPI extern UWORD Voice_GetVolume(SBYTE);
368MIKMODAPI extern void Voice_SetFrequency(SBYTE,ULONG);
369MIKMODAPI extern ULONG Voice_GetFrequency(SBYTE);
370MIKMODAPI extern void Voice_SetPanning(SBYTE,ULONG);
371MIKMODAPI extern ULONG Voice_GetPanning(SBYTE);
372MIKMODAPI extern void Voice_Play(SBYTE,SAMPLE*,ULONG);
373MIKMODAPI extern void Voice_Stop(SBYTE);
374MIKMODAPI extern int Voice_Stopped(SBYTE);
375MIKMODAPI extern SLONG Voice_GetPosition(SBYTE);
376MIKMODAPI extern ULONG Voice_RealVolume(SBYTE);
377
378/*
379 * ========== Internal module representation (UniMod)
380 */
381
382/*
383 Instrument definition - for information only, the only field which may be
384 of use in user programs is the name field
385*/
386
387/* Instrument note count */
388#define INSTNOTES 120
389
390/* Envelope point */
391typedef struct ENVPT {
392 SWORD pos;
393 SWORD val;
394} ENVPT;
395
396/* Envelope point count */
397#define ENVPOINTS 32
398
399/* Instrument structure */
400typedef struct INSTRUMENT {
401 CHAR* insname;
402
403 UBYTE flags;
404 UWORD samplenumber[INSTNOTES];
405 UBYTE samplenote[INSTNOTES];
406
407 UBYTE nnatype;
408 UBYTE dca; /* duplicate check action */
409 UBYTE dct; /* duplicate check type */
410 UBYTE globvol;
411 UWORD volfade;
412 SWORD panning; /* instrument-based panning var */
413
414 UBYTE pitpansep; /* pitch pan separation (0 to 255) */
415 UBYTE pitpancenter; /* pitch pan center (0 to 119) */
416 UBYTE rvolvar; /* random volume varations (0 - 100%) */
417 UBYTE rpanvar; /* random panning varations (0 - 100%) */
418
419 /* volume envelope */
420 UBYTE volflg; /* bit 0: on 1: sustain 2: loop */
421 UBYTE volpts;
422 UBYTE volsusbeg;
423 UBYTE volsusend;
424 UBYTE volbeg;
425 UBYTE volend;
426 ENVPT volenv[ENVPOINTS];
427 /* panning envelope */
428 UBYTE panflg; /* bit 0: on 1: sustain 2: loop */
429 UBYTE panpts;
430 UBYTE pansusbeg;
431 UBYTE pansusend;
432 UBYTE panbeg;
433 UBYTE panend;
434 ENVPT panenv[ENVPOINTS];
435 /* pitch envelope */
436 UBYTE pitflg; /* bit 0: on 1: sustain 2: loop */
437 UBYTE pitpts;
438 UBYTE pitsusbeg;
439 UBYTE pitsusend;
440 UBYTE pitbeg;
441 UBYTE pitend;
442 ENVPT pitenv[ENVPOINTS];
443} INSTRUMENT;
444
445struct MP_CONTROL;
446struct MP_VOICE;
447
448/*
449 Module definition
450*/
451
452/* maximum master channels supported */
453#define UF_MAXCHAN 64
454
455/* Module flags */
456#define UF_XMPERIODS 0x0001 /* XM periods / finetuning */
457#define UF_LINEAR 0x0002 /* LINEAR periods (UF_XMPERIODS must be set) */
458#define UF_INST 0x0004 /* Instruments are used */
459#define UF_NNA 0x0008 /* IT: NNA used, set numvoices rather
460 than numchn */
461#define UF_S3MSLIDES 0x0010 /* uses old S3M volume slides */
462#define UF_BGSLIDES 0x0020 /* continue volume slides in the background */
463#define UF_HIGHBPM 0x0040 /* MED: can use >255 bpm */
464#define UF_NOWRAP 0x0080 /* XM-type (i.e. illogical) pattern break
465 semantics */
466#define UF_ARPMEM 0x0100 /* IT: need arpeggio memory */
467#define UF_FT2QUIRKS 0x0200 /* emulate some FT2 replay quirks */
468#define UF_PANNING 0x0400 /* module uses panning effects or have
469 non-tracker default initial panning */
470
471typedef struct MODULE {
472 /* general module information */
473 CHAR* songname; /* name of the song */
474 CHAR* modtype; /* string type of module loaded */
475 CHAR* comment; /* module comments */
476
477 UWORD flags; /* See module flags above */
478 UBYTE numchn; /* number of module channels */
479 UBYTE numvoices; /* max # voices used for full NNA playback */
480 UWORD numpos; /* number of positions in this song */
481 UWORD numpat; /* number of patterns in this song */
482 UWORD numins; /* number of instruments */
483 UWORD numsmp; /* number of samples */
484struct INSTRUMENT* instruments; /* all instruments */
485struct SAMPLE* samples; /* all samples */
486 UBYTE realchn; /* real number of channels used */
487 UBYTE totalchn; /* total number of channels used (incl NNAs) */
488
489 /* playback settings */
490 UWORD reppos; /* restart position */
491 UBYTE initspeed; /* initial song speed */
492 UWORD inittempo; /* initial song tempo */
493 UBYTE initvolume; /* initial global volume (0 - 128) */
494 UWORD panning[UF_MAXCHAN]; /* panning positions */
495 UBYTE chanvol[UF_MAXCHAN]; /* channel positions */
496 UWORD bpm; /* current beats-per-minute speed */
497 UWORD sngspd; /* current song speed */
498 SWORD volume; /* song volume (0-128) (or user volume) */
499
500 int extspd; /* extended speed flag (default enabled) */
501 int panflag; /* panning flag (default enabled) */
502 int wrap; /* wrap module ? (default disabled) */
503 int loop; /* allow module to loop ? (default enabled) */
504 int fadeout; /* volume fade out during last pattern */
505
506 UWORD patpos; /* current row number */
507 SWORD sngpos; /* current song position */
508 ULONG sngtime; /* current song time in 2^-10 seconds */
509
510 SWORD relspd; /* relative speed factor */
511
512 /* internal module representation */
513 UWORD numtrk; /* number of tracks */
514 UBYTE** tracks; /* array of numtrk pointers to tracks */
515 UWORD* patterns; /* array of Patterns */
516 UWORD* pattrows; /* array of number of rows for each pattern */
517 UWORD* positions; /* all positions */
518
519 int forbid; /* if true, no player update! */
520 UWORD numrow; /* number of rows on current pattern */
521 UWORD vbtick; /* tick counter (counts from 0 to sngspd) */
522 UWORD sngremainder;/* used for song time computation */
523
524struct MP_CONTROL* control; /* Effects Channel info (size pf->numchn) */
525struct MP_VOICE* voice; /* Audio Voice information (size md_numchn) */
526
527 UBYTE globalslide; /* global volume slide rate */
528 UBYTE pat_repcrazy;/* module has just looped to position -1 */
529 UWORD patbrk; /* position where to start a new pattern */
530 UBYTE patdly; /* patterndelay counter (command memory) */
531 UBYTE patdly2; /* patterndelay counter (real one) */
532 SWORD posjmp; /* flag to indicate a jump is needed... */
533 UWORD bpmlimit; /* threshold to detect bpm or speed values */
534} MODULE;
535
536
537/* This structure is used to query current playing voices status */
538typedef struct VOICEINFO {
539 INSTRUMENT* i; /* Current channel instrument */
540 SAMPLE* s; /* Current channel sample */
541 SWORD panning; /* panning position */
542 SBYTE volume; /* channel's "global" volume (0..64) */
543 UWORD period; /* period to play the sample at */
544 UBYTE kick; /* if true = sample has been restarted */
545} VOICEINFO;
546
547/*
548 * ========== Module loaders
549 */
550
551struct MLOADER;
552
553MIKMODAPI extern CHAR* MikMod_InfoLoader(void);
554MIKMODAPI extern void MikMod_RegisterAllLoaders(void);
555MIKMODAPI extern void MikMod_RegisterLoader(struct MLOADER*);
556
557MIKMODAPI extern struct MLOADER load_669; /* 669 and Extended-669 (by Tran/Renaissance) */
558MIKMODAPI extern struct MLOADER load_amf; /* DMP Advanced Module Format (by Otto Chrons) */
559MIKMODAPI extern struct MLOADER load_asy; /* ASYLUM Music Format 1.0 */
560MIKMODAPI extern struct MLOADER load_dsm; /* DSIK internal module format */
561MIKMODAPI extern struct MLOADER load_far; /* Farandole Composer (by Daniel Potter) */
562MIKMODAPI extern struct MLOADER load_gdm; /* General DigiMusic (by Edward Schlunder) */
563MIKMODAPI extern struct MLOADER load_gt2; /* Graoumf tracker */
564MIKMODAPI extern struct MLOADER load_it; /* Impulse Tracker (by Jeffrey Lim) */
565MIKMODAPI extern struct MLOADER load_imf; /* Imago Orpheus (by Lutz Roeder) */
566MIKMODAPI extern struct MLOADER load_med; /* Amiga MED modules (by Teijo Kinnunen) */
567MIKMODAPI extern struct MLOADER load_m15; /* Soundtracker 15-instrument */
568MIKMODAPI extern struct MLOADER load_mod; /* Standard 31-instrument Module loader */
569MIKMODAPI extern struct MLOADER load_mtm; /* Multi-Tracker Module (by Renaissance) */
570MIKMODAPI extern struct MLOADER load_okt; /* Amiga Oktalyzer */
571MIKMODAPI extern struct MLOADER load_stm; /* ScreamTracker 2 (by Future Crew) */
572MIKMODAPI extern struct MLOADER load_stx; /* STMIK 0.2 (by Future Crew) */
573MIKMODAPI extern struct MLOADER load_s3m; /* ScreamTracker 3 (by Future Crew) */
574MIKMODAPI extern struct MLOADER load_ult; /* UltraTracker (by MAS) */
575MIKMODAPI extern struct MLOADER load_uni; /* MikMod and APlayer internal module format */
576MIKMODAPI extern struct MLOADER load_xm; /* FastTracker 2 (by Triton) */
577
578/*
579 * ========== Module player
580 */
581
582MIKMODAPI extern MODULE* Player_Load(CHAR*,int,int);
583MIKMODAPI extern MODULE* Player_LoadFP(int,int,int);
584MIKMODAPI extern MODULE* Player_LoadMem(const char *buffer,int len,int maxchan,int curious);
585MIKMODAPI extern MODULE* Player_LoadGeneric(MREADER*,int,int);
586MIKMODAPI extern CHAR* Player_LoadTitle(CHAR*);
587MIKMODAPI extern CHAR* Player_LoadTitleFP(int);
588MIKMODAPI extern CHAR* Player_LoadTitleMem(const char *buffer,int len);
589MIKMODAPI extern CHAR* Player_LoadTitleGeneric(MREADER*);
590
591MIKMODAPI extern void Player_Free(MODULE*);
592MIKMODAPI extern void Player_Start(MODULE*);
593MIKMODAPI extern int Player_Active(void);
594MIKMODAPI extern void Player_Stop(void);
595MIKMODAPI extern void Player_TogglePause(void);
596MIKMODAPI extern int Player_Paused(void);
597MIKMODAPI extern void Player_NextPosition(void);
598MIKMODAPI extern void Player_PrevPosition(void);
599MIKMODAPI extern void Player_SetPosition(UWORD);
600MIKMODAPI extern int Player_Muted(UBYTE);
601MIKMODAPI extern void Player_SetVolume(SWORD);
602MIKMODAPI extern MODULE* Player_GetModule(void);
603MIKMODAPI extern void Player_SetSpeed(UWORD);
604MIKMODAPI extern void Player_SetTempo(UWORD);
605MIKMODAPI extern void Player_Unmute(SLONG,...);
606MIKMODAPI extern void Player_Mute(SLONG,...);
607MIKMODAPI extern void Player_ToggleMute(SLONG,...);
608MIKMODAPI extern int Player_GetChannelVoice(UBYTE);
609MIKMODAPI extern UWORD Player_GetChannelPeriod(UBYTE);
610MIKMODAPI extern int Player_QueryVoices(UWORD numvoices, VOICEINFO *vinfo);
611MIKMODAPI extern int Player_GetRow(void);
612MIKMODAPI extern int Player_GetOrder(void);
613
614typedef void (*MikMod_player_t)(void);
615typedef void (*MikMod_callback_t)(unsigned char *data, size_t len);
616
617MIKMODAPI extern MikMod_player_t MikMod_RegisterPlayer(MikMod_player_t);
618
619#define MUTE_EXCLUSIVE 32000
620#define MUTE_INCLUSIVE 32001
621
622/*
623 * ========== Drivers
624 */
625
626enum {
627 MD_MUSIC = 0,
628 MD_SNDFX
629};
630
631enum {
632 MD_HARDWARE = 0,
633 MD_SOFTWARE
634};
635
636/* Mixing flags */
637
638/* These ones take effect only after MikMod_Init or MikMod_Reset */
639#define DMODE_16BITS 0x0001 /* enable 16 bit output */
640#define DMODE_STEREO 0x0002 /* enable stereo output */
641#define DMODE_SOFT_SNDFX 0x0004 /* Process sound effects via software mixer */
642#define DMODE_SOFT_MUSIC 0x0008 /* Process music via software mixer */
643#define DMODE_HQMIXER 0x0010 /* Use high-quality (slower) software mixer */
644#define DMODE_FLOAT 0x0020 /* enable float output */
645/* These take effect immediately. */
646#define DMODE_SURROUND 0x0100 /* enable surround sound */
647#define DMODE_INTERP 0x0200 /* enable interpolation */
648#define DMODE_REVERSE 0x0400 /* reverse stereo */
649#define DMODE_SIMDMIXER 0x0800 /* enable SIMD mixing */
650#define DMODE_NOISEREDUCTION 0x1000 /* Low pass filtering */
651
652struct SAMPLOAD;
653typedef struct MDRIVER {
654struct MDRIVER* next;
655 CHAR* Name;
656 CHAR* Version;
657
658 UBYTE HardVoiceLimit; /* Limit of hardware mixer voices */
659 UBYTE SoftVoiceLimit; /* Limit of software mixer voices */
660
661 CHAR *Alias;
662 CHAR *CmdLineHelp;
663
664 void (*CommandLine) (CHAR*);
665 int (*IsPresent) (void);
666 SWORD (*SampleLoad) (struct SAMPLOAD*,int);
667 void (*SampleUnload) (SWORD);
668 ULONG (*FreeSampleSpace) (int);
669 ULONG (*RealSampleLength) (int,struct SAMPLE*);
670 int (*Init) (void);
671 void (*Exit) (void);
672 int (*Reset) (void);
673 int (*SetNumVoices) (void);
674 int (*PlayStart) (void);
675 void (*PlayStop) (void);
676 void (*Update) (void);
677 void (*Pause) (void);
678 void (*VoiceSetVolume) (UBYTE,UWORD);
679 UWORD (*VoiceGetVolume) (UBYTE);
680 void (*VoiceSetFrequency)(UBYTE,ULONG);
681 ULONG (*VoiceGetFrequency)(UBYTE);
682 void (*VoiceSetPanning) (UBYTE,ULONG);
683 ULONG (*VoiceGetPanning) (UBYTE);
684 void (*VoicePlay) (UBYTE,SWORD,ULONG,ULONG,ULONG,ULONG,UWORD);
685 void (*VoiceStop) (UBYTE);
686 int (*VoiceStopped) (UBYTE);
687 SLONG (*VoiceGetPosition) (UBYTE);
688 ULONG (*VoiceRealVolume) (UBYTE);
689} MDRIVER;
690
691/* These variables can be changed at ANY time and results will be immediate */
692MIKMODAPI extern UBYTE md_volume; /* global sound volume (0-128) */
693MIKMODAPI extern UBYTE md_musicvolume; /* volume of song */
694MIKMODAPI extern UBYTE md_sndfxvolume; /* volume of sound effects */
695MIKMODAPI extern UBYTE md_reverb; /* 0 = none; 15 = chaos */
696MIKMODAPI extern UBYTE md_pansep; /* 0 = mono; 128 == 100% (full left/right) */
697
698/* The variables below can be changed at any time, but changes will not be
699 implemented until MikMod_Reset is called. A call to MikMod_Reset may result
700 in a skip or pop in audio (depending on the soundcard driver and the settings
701 changed). */
702MIKMODAPI extern UWORD md_device; /* device */
703MIKMODAPI extern UWORD md_mixfreq; /* mixing frequency */
704MIKMODAPI extern UWORD md_mode; /* mode. See DMODE_? flags above */
705
706/* The following variable should not be changed! */
707MIKMODAPI extern MDRIVER* md_driver; /* Current driver in use. */
708
709/* Known drivers list */
710
711MIKMODAPI extern struct MDRIVER drv_nos; /* no sound */
712#if 0
713MIKMODAPI extern struct MDRIVER drv_pipe; /* piped output */
714MIKMODAPI extern struct MDRIVER drv_raw; /* raw file disk writer [music.raw] */
715MIKMODAPI extern struct MDRIVER drv_stdout; /* output to stdout */
716MIKMODAPI extern struct MDRIVER drv_wav; /* RIFF WAVE file disk writer [music.wav] */
717MIKMODAPI extern struct MDRIVER drv_aiff; /* AIFF file disk writer [music.aiff] */
718
719MIKMODAPI extern struct MDRIVER drv_ultra; /* Linux Ultrasound driver */
720MIKMODAPI extern struct MDRIVER drv_sam9407; /* Linux sam9407 driver */
721
722MIKMODAPI extern struct MDRIVER drv_AF; /* Dec Alpha AudioFile */
723MIKMODAPI extern struct MDRIVER drv_aix; /* AIX audio device */
724MIKMODAPI extern struct MDRIVER drv_alsa; /* Advanced Linux Sound Architecture (ALSA) */
725MIKMODAPI extern struct MDRIVER drv_esd; /* Enlightened sound daemon (EsounD) */
726MIKMODAPI extern struct MDRIVER drv_hp; /* HP-UX audio device */
727MIKMODAPI extern struct MDRIVER drv_nas; /* Network Audio System (NAS) */
728MIKMODAPI extern struct MDRIVER drv_oss; /* OpenSound System (Linux,FreeBSD...) */
729MIKMODAPI extern struct MDRIVER drv_sgi; /* SGI audio library */
730MIKMODAPI extern struct MDRIVER drv_sun; /* Sun/NetBSD/OpenBSD audio device */
731
732MIKMODAPI extern struct MDRIVER drv_dart; /* OS/2 Direct Audio RealTime */
733MIKMODAPI extern struct MDRIVER drv_os2; /* OS/2 MMPM/2 */
734
735MIKMODAPI extern struct MDRIVER drv_ds; /* Win32 DirectSound driver */
736MIKMODAPI extern struct MDRIVER drv_win; /* Win32 multimedia API driver */
737
738MIKMODAPI extern struct MDRIVER drv_mac; /* Macintosh Sound Manager driver */
739MIKMODAPI extern struct MDRIVER drv_osx; /* MacOS X CoreAudio Driver */
740
741MIKMODAPI extern struct MDRIVER drv_gp32; /* GP32 Sound driver */
742
743MIKMODAPI extern struct MDRIVER drv_wss; /* DOS WSS driver */
744MIKMODAPI extern struct MDRIVER drv_sb; /* DOS SB driver */
745#endif
746/*========== Virtual channel mixer interface (for user-supplied drivers only) */
747
748MIKMODAPI extern int VC_Init(void);
749MIKMODAPI extern void VC_Exit(void);
750MIKMODAPI extern void VC_SetCallback(MikMod_callback_t callback);
751MIKMODAPI extern int VC_SetNumVoices(void);
752MIKMODAPI extern ULONG VC_SampleSpace(int);
753MIKMODAPI extern ULONG VC_SampleLength(int,SAMPLE*);
754
755MIKMODAPI extern int VC_PlayStart(void);
756MIKMODAPI extern void VC_PlayStop(void);
757
758MIKMODAPI extern SWORD VC_SampleLoad(struct SAMPLOAD*,int);
759MIKMODAPI extern void VC_SampleUnload(SWORD);
760
761MIKMODAPI extern ULONG VC_WriteBytes(SBYTE*,ULONG);
762MIKMODAPI extern ULONG VC_SilenceBytes(SBYTE*,ULONG);
763
764MIKMODAPI extern void VC_VoiceSetVolume(UBYTE,UWORD);
765MIKMODAPI extern UWORD VC_VoiceGetVolume(UBYTE);
766MIKMODAPI extern void VC_VoiceSetFrequency(UBYTE,ULONG);
767MIKMODAPI extern ULONG VC_VoiceGetFrequency(UBYTE);
768MIKMODAPI extern void VC_VoiceSetPanning(UBYTE,ULONG);
769MIKMODAPI extern ULONG VC_VoiceGetPanning(UBYTE);
770MIKMODAPI extern void VC_VoicePlay(UBYTE,SWORD,ULONG,ULONG,ULONG,ULONG,UWORD);
771
772MIKMODAPI extern void VC_VoiceStop(UBYTE);
773MIKMODAPI extern int VC_VoiceStopped(UBYTE);
774MIKMODAPI extern SLONG VC_VoiceGetPosition(UBYTE);
775MIKMODAPI extern ULONG VC_VoiceRealVolume(UBYTE);
776
777#ifdef __cplusplus
778}
779#endif
780
781#endif
782
783/* ex:set ts=4: */
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-07 16:50:52 +0000