gzdoom-gles/libraries/zmusic/zmusic/zmusic.h

#pragma once

#include "mididefs.h"
#include "../../music_common/fileio.h"

namespace ZMusic	// Namespaced because these conflict with the same-named CVARs
{

enum EIntConfigKey
{
	adl_chips_count,
	adl_emulator_id,
	adl_run_at_pcm_rate,
	adl_fullpan,
	adl_bank,
	adl_use_custom_bank,
	adl_volume_model,

	fluid_reverb,
	fluid_chorus,
	fluid_voices,
	fluid_interp,
	fluid_samplerate,
	fluid_threads,
	fluid_chorus_voices,
	fluid_chorus_type,

	opl_numchips,
	opl_core,
	opl_fullpan,

	opn_chips_count,
	opn_emulator_id,
	opn_run_at_pcm_rate,
	opn_fullpan,
	opn_use_custom_bank,

	gus_dmxgus,
	gus_midi_voices,
	gus_memsize,

	timidity_modulation_wheel,
	timidity_portamento,
	timidity_reverb,
	timidity_reverb_level,
	timidity_chorus,
	timidity_surround_chorus,
	timidity_channel_pressure,
	timidity_lpf_def,
	timidity_temper_control,
	timidity_modulation_envelope,
	timidity_overlap_voice_allow,
	timidity_drum_effect,
	timidity_pan_delay,
	timidity_key_adjust,

	wildmidi_reverb,
	wildmidi_enhanced_resampling,

	snd_midiprecache,

	mod_samplerate,
	mod_volramp,
	mod_interp,
	mod_autochip,
	mod_autochip_size_force,
	mod_autochip_size_scan,
	mod_autochip_scan_threshold,

	snd_streambuffersize,
	
	snd_mididevice,
	snd_outputrate,

	NUM_INT_CONFIGS
};

enum EFloatConfigKey
{
	fluid_gain,
	fluid_reverb_roomsize,
	fluid_reverb_damping,
	fluid_reverb_width,
	fluid_reverb_level,
	fluid_chorus_level,
	fluid_chorus_speed,
	fluid_chorus_depth,

	timidity_drum_power,
	timidity_tempo_adjust,
	min_sustain_time,

	gme_stereodepth,
	mod_dumb_mastervolume,

	snd_musicvolume,
	relative_volume,
	snd_mastervolume,

	NUM_FLOAT_CONFIGS
};

enum EStringConfigKey
{
	adl_custom_bank,
	fluid_lib,
	fluid_patchset,
	opn_custom_bank,
	gus_config,
	gus_patchdir,
	timidity_config,
	wildmidi_config,

	NUM_STRING_CONFIGS
};

}

struct Callbacks
{
	// Callbacks the client can install to capture messages from the backends
	// or to provide sound font data.
	
	// The message callbacks are optional, without them the output goes to stdout.
	void (*WildMidi_MessageFunc)(const char* wmfmt, va_list args) = nullptr;
	void (*GUS_MessageFunc)(int type, int verbosity_level, const char* fmt, ...) = nullptr;
	void (*Timidity_Messagefunc)(int type, int verbosity_level, const char* fmt, ...) = nullptr;
	int (*Fluid_MessageFunc)(const char *fmt, ...) = nullptr;
	
	// The sound font callbacks are for allowing the client to customize sound font management
	// Without them only paths to real files can be used.
	const char *(*PathForSoundfont)(const char *name, int type) = nullptr;
	MusicIO::SoundFontReaderInterface *(*OpenSoundFont)(const char* name, int type) = nullptr;
	
	// Used to handle client-specific path macros. If not set, the path may not contain any special tokens that may need expansion.
	std::string (*NicePath)(const char *path) = nullptr;

	// For playing modules with compressed samples.
	short* (*DumbVorbisDecode)(int outlen, const void* oggstream, int sizebytes);

};


#ifndef ZMUSIC_INTERNAL
#define DLL_IMPORT // _declspec(dllimport)
typedef struct { int zm1; } *ZMusic_MidiSource;
typedef struct { int zm2; } *ZMusic_MusicStream;
#endif

extern "C"
{
	DLL_IMPORT const char* ZMusic_GetLastError();

	// Sets callbacks for functionality that the client needs to provide.
	DLL_IMPORT void ZMusic_SetCallbacks(const Callbacks* callbacks);
	// Sets GenMidi data for OPL playback. If this isn't provided the OPL synth will not work.
	DLL_IMPORT void ZMusic_SetGenMidi(const uint8_t* data);
	// Set default bank for OPN. Without this OPN only works with custom banks.
	DLL_IMPORT void ZMusic_SetWgOpn(const void* data, unsigned len);
	// Set DMXGUS data for running the GUS synth in actual GUS mode.
	DLL_IMPORT void ZMusic_SetDmxGus(const void* data, unsigned len);

	// These exports are needed by the MIDI dumpers which need to remain on the client side because the need access to the client's file system.
	DLL_IMPORT EMIDIType ZMusic_IdentifyMIDIType(uint32_t* id, int size);
	DLL_IMPORT ZMusic_MidiSource ZMusic_CreateMIDISource(const uint8_t* data, size_t length, EMIDIType miditype);
	DLL_IMPORT bool ZMusic_MIDIDumpWave(ZMusic_MidiSource source, EMidiDevice devtype, const char* devarg, const char* outname, int subsong, int samplerate);

	DLL_IMPORT ZMusic_MusicStream ZMusic_OpenSong(MusicIO::FileInterface* reader, EMidiDevice device, const char* Args);
	DLL_IMPORT ZMusic_MusicStream ZMusic_OpenCDSong(int track, int cdid = 0);

	DLL_IMPORT bool ZMusic_FillStream(ZMusic_MusicStream stream, void* buff, int len);
	DLL_IMPORT bool ZMusic_Start(ZMusic_MusicStream song, int subsong, bool loop);
	DLL_IMPORT void ZMusic_Pause(ZMusic_MusicStream song);
	DLL_IMPORT void ZMusic_Resume(ZMusic_MusicStream song);
	DLL_IMPORT void ZMusic_Update(ZMusic_MusicStream song);
	DLL_IMPORT bool ZMusic_IsPlaying(ZMusic_MusicStream song);
	DLL_IMPORT void ZMusic_Stop(ZMusic_MusicStream song);
	DLL_IMPORT void ZMusic_Close(ZMusic_MusicStream song);
	DLL_IMPORT bool ZMusic_SetSubsong(ZMusic_MusicStream song, int subsong);
	DLL_IMPORT bool ZMusic_IsLooping(ZMusic_MusicStream song);
	DLL_IMPORT bool ZMusic_IsMIDI(ZMusic_MusicStream song);
	DLL_IMPORT void ZMusic_VolumeChanged(ZMusic_MusicStream song);
	DLL_IMPORT bool ZMusic_WriteSMF(ZMusic_MidiSource source, const char* fn, int looplimit);
	SoundStreamInfo ZMusic_GetStreamInfo(ZMusic_MusicStream song);

	// Configuration interface. The return value specifies if a music restart is needed.
	// RealValue should be written back to the CVAR or whatever other method the client uses to store configuration state.
}

class MusInfo;
#if 0
std::string ZMusic_GetStats(ZMusic_MusicStream song);
bool ChangeMusicSetting(ZMusic::EIntConfigKey key, ZMusic_MusicStream song, int value, int* pRealValue = nullptr);
bool ChangeMusicSetting(ZMusic::EFloatConfigKey key, ZMusic_MusicStream song, float value, float* pRealValue = nullptr);
bool ChangeMusicSetting(ZMusic::EStringConfigKey key, ZMusic_MusicStream song, const char* value);
#else
// Cannot be done yet.
std::string ZMusic_GetStats(MusInfo* song);
bool ChangeMusicSetting(ZMusic::EIntConfigKey key, MusInfo* song, int value, int* pRealValue = nullptr);
bool ChangeMusicSetting(ZMusic::EFloatConfigKey key, MusInfo* song, float value, float* pRealValue = nullptr);
bool ChangeMusicSetting(ZMusic::EStringConfigKey key, MusInfo* song, const char* value);
#endif