//****************************************************************************
//
//	File:		Synth.h
//
//	Description:	Interface to the General MIDI synthesizer.
//
//	Copyright 1997, Be Incorporated
//
//****************************************************************************

#ifndef _SYNTH_H
#define _SYNTH_H

#include <Entry.h>
#include <MidiDefs.h>
#include <OS.h>

typedef enum interpolation_mode
{
    B_DROP_SAMPLE = 0,
    B_2_POINT_INTERPOLATION,
    B_LINEAR_INTERPOLATION
  } interpolation_mode;

typedef enum reverb_mode
{
	B_REVERB_NONE = 1,		
	B_REVERB_CLOSET,	
	B_REVERB_GARAGE,	
	B_REVERB_BALLROOM,	
	B_REVERB_CAVERN,	
	B_REVERB_DUNGEON	
  } reverb_mode;

typedef void (*synth_controller_hook) (int16 channel,
									   int16 controller, 
									   int16 value);
class BMidiSynth;
class BMidiSynthFile;

class BSynth 
{
 public:
	BSynth();
	BSynth(synth_mode synth);

	~BSynth();
	
	status_t 	LoadSynthData(entry_ref *instrumentsFile); 
	status_t 	LoadSynthData(synth_mode synth);
	synth_mode SynthMode(void);

	void	Unload(void);
	bool	IsLoaded(void) const;
	
	// change audio modes
	status_t	SetSamplingRate(int32 sample_rate);
	int32		SamplingRate() const;
	
	status_t	SetInterpolation(interpolation_mode interp_mode);
	interpolation_mode Interpolation() const;
	
	void		SetReverb(reverb_mode rev_mode);
	reverb_mode	Reverb() const;
	
	status_t	EnableReverb(bool reverb_enabled);
	bool		IsReverbEnabled() const;
	
	// change voice allocation
	status_t	SetVoiceLimits(int16 maxSynthVoices,
							   int16 maxSampleVoices,
							   int16 limiterThreshhold);
	
	int16		MaxSynthVoices(void) const;
	int16		MaxSampleVoices(void) const;
	int16		LimiterThreshhold(void) const;
	
	// get and set the master mix volume. A volume level of 1.0
	// is normal, and volume level of 4.0 will overdrive 4 times
	void		SetSynthVolume(double theVolume);
	double		SynthVolume(void) const;
	
	void		SetSampleVolume(double theVolume);
	double		SampleVolume(void) const;
	
	// display feedback information
	// This will return the number of 16-bit samples stored into the pLeft
	//  and pRight arrays. Usually 1024. This returns the current data
	//  points being sent to the hardware.
	status_t		GetAudio(int16 *pLeft, int16 *pRight,
						 int32 max_samples) const;
	
	// disengage from audio output streams
	void		Pause(void);
	// reengage to audio output streams
	void		Resume(void);
	
	// Set a call back on controller events
	void		SetControllerHook(int16 controller,
								  synth_controller_hook cback);
	
	int32		CountClients(void) const;

 private:

virtual	void		_ReservedSynth1();
virtual	void		_ReservedSynth2();
virtual	void		_ReservedSynth3();
virtual	void		_ReservedSynth4();

	friend BMidiSynth;
	friend BMidiSynthFile;

	int32					fClientCount;
	void _init();
	status_t _do_load(synth_mode synth);
	status_t _load_insts(entry_ref *ref);
	synth_mode	fMode;
	int16				fMaxSynthVox;
	int16				fMaxSampleVox;
	int16				fLimiter;
	
	int32					fSRate;
	interpolation_mode		fInterp;
	int32					fModifiers;
	reverb_mode 			fReverb;
	sem_id					fSetupLock;
	uint32					_reserved[4];
};

extern BSynth *be_synth;


#endif