https://github.com/scummvm/scummvm
Tip revision: 5dbefa955166e4b22207d117104181d044f5590a authored by Lothar Serra Mari on 16 July 2022, 20:03:12 UTC
DISTS: Generated Code::Blocks and MSVC project files
DISTS: Generated Code::Blocks and MSVC project files
Tip revision: 5dbefa9
sound.h
/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef SCUMM_SOUND_H
#define SCUMM_SOUND_H
#include "common/scummsys.h"
#include "common/serializer.h"
#include "common/str.h"
#include "audio/mididrv.h"
#include "backends/audiocd/audiocd.h"
#include "scumm/file.h"
// The number of "ticks" (1/10th of a second) into the Overture that the
// LucasFilm logo should appear. This corresponds to a timer value of 204.
// The default value is selected to work well with the Ozawa recording.
#define DEFAULT_LOOM_OVERTURE_TRANSITION 1160
namespace Audio {
class Mixer;
class SoundHandle;
}
namespace Scumm {
class ScummEngine;
struct MP3OffsetTable;
enum {
kTalkSoundID = 10000
};
// TODO: Consider splitting Sound into even more subclasses.
// E.g. for v1-v4, v5, v6+, ...
class Sound : public Common::Serializable {
public:
enum SoundMode {
kVOCMode,
kMP3Mode,
kVorbisMode,
kFLACMode
};
protected:
ScummEngine *_vm;
Audio::Mixer *_mixer;
int16 _soundQuePos, _soundQue[0x100];
int16 _soundQue2Pos;
struct {
int16 sound;
int32 offset;
int16 channel;
int16 flags;
int16 freq;
int16 pan;
int16 vol;
} _soundQue2[10];
Common::String _sfxFilename;
byte _sfxFileEncByte;
SoundMode _soundMode;
MP3OffsetTable *_offsetTable; // For compressed audio
int _numSoundEffects; // For compressed audio
uint32 _talk_sound_a1, _talk_sound_a2, _talk_sound_b1, _talk_sound_b2;
byte _talk_sound_mode, _talk_sound_channel;
bool _mouthSyncMode;
bool _endOfMouthSync;
uint16 _mouthSyncTimes[64];
uint _curSoundPos;
int16 _currentCDSound;
int16 _currentMusic;
Audio::SoundHandle *_loomSteamCDAudioHandle;
bool _isLoomSteam;
AudioCDManager::Status _loomSteamCD;
bool _useReplacementAudioTracks;
int _musicTimer;
int _loomOvertureTransition;
uint32 _replacementTrackStartTime;
public:
Audio::SoundHandle *_talkChannelHandle; // Handle of mixer channel actor is talking on
bool _soundsPaused;
byte _sfxMode;
uint _lastSound;
uint32 _cdMusicTimerMod;
uint32 _cdMusicTimer;
uint32 _speechTimerMod;
MidiDriverFlags _musicType;
public:
Sound(ScummEngine *parent, Audio::Mixer *mixer, bool useReplacementAudioTracks);
~Sound() override;
virtual void addSoundToQueue(int sound, int heOffset = 0, int heChannel = 0, int heFlags = 0, int heFreq = 0, int hePan = 0, int heVol = 0);
virtual void addSoundToQueue2(int sound, int heOffset = 0, int heChannel = 0, int heFlags = 0, int heFreq = 0, int hePan = 0, int heVol = 0);
void processSound();
void playSound(int soundID);
void startTalkSound(uint32 offset, uint32 b, int mode, Audio::SoundHandle *handle = NULL);
void stopTalkSound();
bool isMouthSyncOff(uint pos);
virtual int isSoundRunning(int sound) const;
bool isSoundInUse(int sound) const;
virtual void stopSound(int sound);
virtual void stopAllSounds();
void soundKludge(int *list, int num);
void talkSound(uint32 a, uint32 b, int mode, int channel = 0);
virtual void setupSound();
void pauseSounds(bool pause);
bool isSfxFileCompressed();
bool hasSfxFile() const;
ScummFile *restoreDiMUSESpeechFile(const char *fileName);
void extractSyncsFromDiMUSEMarker(const char *marker);
void incrementSpeechTimer();
void resetSpeechTimer();
void startSpeechTimer();
void stopSpeechTimer();
void startCDTimer();
void stopCDTimer();
void playCDTrack(int track, int numLoops, int startFrame, int duration);
void playCDTrackInternal(int track, int numLoops, int startFrame, int duration);
void stopCD();
int pollCD() const;
void updateCD();
AudioCDManager::Status getCDStatus();
int getCurrentCDSound() const { return _currentCDSound; }
bool isRolandLoom() const;
bool useReplacementAudioTracks() const { return _useReplacementAudioTracks; }
void updateMusicTimer();
int getMusicTimer() const { return _musicTimer; }
int getCDMusicTimer() const { return _cdMusicTimer; }
void saveLoadWithSerializer(Common::Serializer &ser) override;
void restoreAfterLoad();
protected:
void setupSfxFile();
bool isSfxFinished() const;
void processSfxQueues();
bool isSoundInQueue(int sound) const;
virtual void processSoundQueues();
int getReplacementAudioTrack(int soundID);
};
} // End of namespace Scumm
#endif