/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

/*
 * This code is based on original Soltys source code
 * Copyright (c) 1994-1995 Janus B. Wisniewski and L.K. Avalon
 */

// ******************************************************
// *  Sound Driver by Hedges (c) 1995 LK AVALON         *
// *  Ver 1.00: 01-Mar-95                               *
// *  Ver 1.10: 03-Mar-95                               *
// *  Ver 1.20: 07-Mar-95                               *
// *  Ver 1.30: 09-Mar-95                               *
// *  Ver 1.40: 11-Mar-95                               *
// ******************************************************

#ifndef __CGE_SNDDRV__
#define __CGE_SNDDRV__

namespace CGE {

// ******************************************************
// *  Constants                                         *
// ******************************************************
// available devices

enum  DEV_TYPE  { DEV_AUTO = -1,                    // auto-detect mode
                  DEV_QUIET,                        // disable sound
                  DEV_SB,                           // sb/pro/16/awe32
                  DEV_GUS,                          // gus/max
                  DEV_GM                            // general midi
                };

#define SERR_OK           0                         // no error
#define SERR_INITFAIL     1                         // couldn't initialize
#define SERR_BADDDEV      128                       // bad device

// driver info
struct DrvInfo {
	DEV_TYPE _dDev;                                    // digi device
	DEV_TYPE _mDev;                                    // midi device
	uint16   _dBase;                                   // digi base port
	uint16   _dDma;                                    // digi dma no
	uint16   _dIrq;                                    // digi irq no
	uint16   _mBase;                                   // midi base port
	union {
		struct {
			uint16 _dr : 4;
			uint16 _dl : 4;
			uint16 _mr : 4;
			uint16 _ml : 4;
		} Vol4;
		struct {
			uint8  _d;                                     // digi volume
			uint8  _m;                                     // midi volume
		} Vol2;
	};
};

// sample info
struct SmpInfo {
	uint8  *_saddr;                                    // address
	uint16  _slen;                                     // length
	uint16  _span;                                     // left/right pan (0-15)
	int     _sflag;                                    // flag
};

// ******************************************************
// *  Data                                              *
// ******************************************************
// driver info
extern DrvInfo _sndDrvInfo;

// midi player flag (1 means we are playing)
extern uint16 _midiPlayFlag;

// midi song end flag (1 means we have crossed end mark)
extern uint16 _midiEndFlag;

// ******************************************************
// *  Driver Code                                       *
// ******************************************************
// Init Digi Device
void sndInit();

// Close Digi Device
void sndDone();

// Set Volume
void sndSetVolume();

// Start Digi
void sndDigiStart(SmpInfo *PSmpInfo);

// Stop Digi
void sndDigiStop(SmpInfo *PSmpInfo);

// Start MIDI File
void sndMidiStart(uint8 *MIDFile);

// Stop MIDI File
void sndMidiStop();

// Play MIDI File (to be called while interrupting)
// WARNING: Uses ALL registers!
void sndMidiPlay();

} // End of namespace CGE

#endif