audio_process.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 ULTIMA8_AUDIO_AUDIOPROCESS_H
#define ULTIMA8_AUDIO_AUDIOPROCESS_H

#include "ultima/ultima8/kernel/process.h"
#include "ultima/ultima8/usecode/intrinsics.h"
#include "ultima/shared/std/string.h"
#include "ultima/ultima8/misc/classtype.h"

namespace Ultima {
namespace Ultima8 {

class AudioSample;

class AudioProcess : public Process {
public:

    static const uint32 PITCH_SHIFT_NONE;

    struct SampleInfo {
        int32       _sfxNum;
        int32       _priority;
        ObjId       _objId;
        int32       _loops;
        int32       _channel;
        Std::string _barked;
        uint32      _curSpeechStart, _curSpeechEnd;
        uint32      _pitchShift;    // PITCH_SHIFT_NONE is normal
        uint16      _volume;         // 0-255
        int16       _calcVol;
        int8        _balance;
        bool        _ambient;

        SampleInfo() : _sfxNum(-1) { }
        SampleInfo(int32 s, int32 p, ObjId o, int32 l, int32 c, uint32 ps, uint16 v, int16 cv, int8 bal, bool ambient) :
            _sfxNum(s), _priority(p), _objId(o), _loops(l), _channel(c),
            _pitchShift(ps), _volume(v), _calcVol(cv), _balance(bal),
            _curSpeechStart(0), _curSpeechEnd(0), _ambient(ambient) { }
        SampleInfo(const Std::string &b, int32 shpnum, ObjId o, int32 c,
                   uint32 s, uint32 e, uint32 ps, uint16 v, int16 cv, int8 bal, bool ambient) :
            _sfxNum(-1), _priority(shpnum), _objId(o), _loops(0), _channel(c), _barked(b),
            _curSpeechStart(s), _curSpeechEnd(e), _pitchShift(ps), _volume(v),
            _calcVol(cv), _balance(bal), _ambient(ambient) { }
    };

    Std::list<SampleInfo> _sampleInfo;
public:
    // p_dynamic_class stuff
    ENABLE_RUNTIME_CLASSTYPE()

    AudioProcess(void);
    ~AudioProcess(void) override;

    static AudioProcess *get_instance() {
        return _theAudioProcess;
    }

    INTRINSIC(I_playSFX);
    INTRINSIC(I_playAmbientSFX);
    INTRINSIC(I_playSFXCru);
    INTRINSIC(I_playAmbientSFXCru);
    INTRINSIC(I_isSFXPlaying);
    INTRINSIC(I_isSFXPlayingForObject);
    INTRINSIC(I_setVolumeSFX);
    INTRINSIC(I_setVolumeForObjectSFX);
    INTRINSIC(I_stopSFX);
    INTRINSIC(I_stopSFXCru);
    INTRINSIC(I_stopAllSFX);

    void run() override;

    void playSFX(int sfxNum, int priority, ObjId objId, int loops,
                 bool no_duplicates, uint32 pitchShift,
                 uint16 volume, int16 calcVol, int8 balance,
                 bool ambient);

    void playSFX(int sfxNum, int priority, ObjId objId, int loops,
                 bool no_duplicates = false, uint32 pitchShift = PITCH_SHIFT_NONE,
                 uint16 volume = 0x80, bool ambient = false) {
        playSFX(sfxNum, priority, objId, loops, no_duplicates, pitchShift, volume, -1, 0, ambient);
    }

    void stopSFX(int sfxNum, ObjId objId);
    bool isSFXPlaying(int sfxNum);
    bool isSFXPlayingForObject(int sfxNum, ObjId objId);
    void setVolumeSFX(int sfxNum, uint8 volume);
    void setVolumeForObjectSFX(ObjId objId, int sfxNum, uint8 volume);

    bool playSpeech(const Std::string &barked, int shapenum, ObjId objId,
                    uint32 pitchShift = PITCH_SHIFT_NONE, uint16 volume = 255);
    void stopSpeech(const Std::string &barked, int shapenum, ObjId objId);
    bool isSpeechPlaying(const Std::string &barked, int shapenum);

    uint32 getSpeechLength(const Std::string &barked, int shapenum) const;

    int playSample(AudioSample *sample, int priority, int loops, bool isSpeech = false,
                   uint32 pitchShift = PITCH_SHIFT_NONE, int16 volume = 255,
                   int8 balance = 0, bool ambient = false);

    void pauseAllSamples();
    void unpauseAllSamples();

    void stopAllExceptSpeech();

    bool loadData(Common::ReadStream *rs, uint32 version);
    void saveData(Common::WriteStream *ws) override;

private:
    uint32 _paused;

    bool continueSpeech(SampleInfo &si);

    bool calculateSoundVolume(ObjId objId, int16 &volume, int8 &balance) const;

    static AudioProcess *_theAudioProcess;
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif