scummvm/sound/mixer.h

177 lines
5.3 KiB
C
Raw Normal View History

/* ScummVM - Scumm Interpreter
* Copyright (C) 2001 Ludvig Strigeus
* Copyright (C) 2001-2003 The ScummVM project
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Header$
*
*/
#ifndef SOUND_MIXER_H
#define SOUND_MIXER_H
#include "stdafx.h"
#include "common/scummsys.h"
#include "common/system.h"
#ifdef USE_MAD
#include <mad.h>
#endif
#ifdef USE_VORBIS
#include <vorbis/vorbisfile.h>
#endif
2003-06-15 01:56:47 +00:00
typedef uint32 PlayingSoundHandle;
2002-08-24 15:31:37 +00:00
class Channel;
class File;
2003-06-15 01:56:47 +00:00
class SoundMixer {
friend class Channel;
2003-06-15 01:56:47 +00:00
public:
typedef void PremixProc (void *param, int16 *data, uint len);
2003-06-15 01:56:47 +00:00
enum {
NUM_CHANNELS = 16
};
enum {
FLAG_UNSIGNED = 1 << 0, // unsigned samples (default: signed)
FLAG_STEREO = 1 << 1, // sound is in stereo (default: mono)
FLAG_16BITS = 1 << 2, // sound is 16 bits wide (default: 8bit)
FLAG_AUTOFREE = 1 << 3, // sound buffer is freed automagically at the end of playing
FLAG_REVERSE_STEREO = 1 << 4, // reverse the left and right stereo channel
FLAG_LOOP = 1 << 5, // loop the audio
FLAG_LITTLE_ENDIAN = 1 << 6 // sample is little endian (default: big endian)
};
2003-06-15 01:56:47 +00:00
private:
2003-03-06 18:30:44 +00:00
OSystem *_syst;
OSystem::MutexRef _mutex;
2002-07-07 18:04:03 +00:00
2003-06-15 01:56:47 +00:00
void *_premixParam;
PremixProc *_premixProc;
2002-08-24 15:31:37 +00:00
uint _outputRate;
int _globalVolume;
2002-08-24 15:31:37 +00:00
int _musicVolume;
bool _paused;
2003-03-06 18:30:44 +00:00
Channel *_channels[NUM_CHANNELS];
2003-06-15 01:56:47 +00:00
public:
SoundMixer();
~SoundMixer();
/** bind to the OSystem object => mixer will be
* invoked automatically when samples need
* to be generated */
bool bindToSystem(OSystem *syst);
/**
* Set the premix procedure. This is mainly used for the adlib music, but
* is not limited to it. The premix proc is invoked by the mixer whenever
* it needs to generate any data, before any other mixing takes place. The
* premixer than has a chanve to fill the mix buffer with data (usually
* music samples). It should generate the specified number of 16bit stereo
* samples (i.e. len * 4 bytes). The endianess of these samples shall be
* the native endianess.
*/
void setupPremix(PremixProc *proc, void *param);
2002-12-25 00:36:04 +00:00
// start playing a raw sound
int playRaw(PlayingSoundHandle *handle, void *sound, uint32 size, uint rate, byte flags,
int id = -1, byte volume = 255, int8 pan = 0, uint32 loopStart = 0, uint32 loopEnd = 0);
#ifdef USE_MAD
int playMP3(PlayingSoundHandle *handle, File *file, uint32 size, byte volume = 255, int8 pan = 0);
int playMP3CDTrack(PlayingSoundHandle *handle, File *file, mad_timer_t duration, byte volume = 255, int8 pan = 0);
#endif
#ifdef USE_VORBIS
int playVorbis(PlayingSoundHandle *handle, OggVorbis_File *ov_file, int duration, bool is_cd_track, byte volume = 255, int8 pan = 0);
#endif
/** Start a new stream. */
int newStream(PlayingSoundHandle *handle, void *sound, uint32 size, uint rate, byte flags, uint32 buffer_size, byte volume = 255, int8 pan = 0);
/** Append to an existing stream. */
void appendStream(PlayingSoundHandle handle, void *sound, uint32 size);
/** Mark a stream as finished - it will play all its remaining data, then stop. */
void endStream(PlayingSoundHandle handle);
2003-06-15 01:56:47 +00:00
/** stop all currently playing sounds */
2002-08-24 15:31:37 +00:00
void stopAll();
/** stop playing the given channel */
void stopChannel(int channel);
/** stop playing the sound with given ID */
void stopID(int id);
/** stop playing the channel for the given handle */
void stopHandle(PlayingSoundHandle handle);
/** pause/unpause all channels */
void pauseAll(bool paused);
/** pause/unpause the given channel */
void pauseChannel(int index, bool paused);
/** pause/unpause the sound with the given ID */
void pauseID(int id, bool paused);
/** pause/unpause the channel for the given handle */
void pauseHandle(PlayingSoundHandle handle, bool paused);
/** set the channel volume for the given handle (0 - 255) */
void setChannelVolume(PlayingSoundHandle handle, byte volume);
/** set the channel pan for the given handle (-127 ... 0 ... 127) (left ... center ... right)*/
void setChannelPan(PlayingSoundHandle handle, int8 pan);
/** Check whether any SFX channel is active.*/
bool hasActiveSFXChannel();
2003-11-08 23:05:04 +00:00
/** set the global volume, 0-256 */
2002-08-24 15:31:37 +00:00
void setVolume(int volume);
2003-11-08 23:05:04 +00:00
/** query the global volume, 0-256 */
int getVolume() const { return _globalVolume; }
/** set the music volume, 0-256 */
2002-08-24 15:31:37 +00:00
void setMusicVolume(int volume);
2003-11-08 23:05:04 +00:00
/** query the music volume, 0-256 */
int getMusicVolume() const { return _musicVolume; }
2003-11-08 23:05:04 +00:00
/** query the output rate in kHz */
uint getOutputRate() const { return _outputRate; }
private:
int insertChannel(PlayingSoundHandle *handle, Channel *chan);
/** main mixer method */
void mix(int16 * buf, uint len);
static void mixCallback(void *s, byte *samples, int len);
};
#endif