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 TITANIC_SOUND_H
#define TITANIC_SOUND_H

#include "titanic/support/simple_file.h"
#include "titanic/sound/proximity.h"
#include "titanic/sound/sound_manager.h"
#include "titanic/sound/wave_file.h"
#include "titanic/core/list.h"
#include "titanic/core/view_item.h"
#include "titanic/true_talk/dialogue_file.h"

namespace Titanic {

class CGameManager;

class CSoundItem : public ListItem {
public:
    CString _name;
    CWaveFile *_waveFile;
    File *_dialogueFileHandle;
    int _speechId;
    DisposeAfterUse::Flag _disposeAfterUse;
    bool _active;
public:
    CSoundItem() : ListItem(), _waveFile(nullptr), _dialogueFileHandle(nullptr),
        _speechId(0), _disposeAfterUse(DisposeAfterUse::NO), _active(false) {}
    CSoundItem(const CString &name) : ListItem(), _name(name), _waveFile(nullptr),
        _dialogueFileHandle(nullptr), _disposeAfterUse(DisposeAfterUse::NO),
        _speechId(0), _active(false) {}
    CSoundItem(File *dialogueFile, int speechId) : ListItem(), _waveFile(nullptr),
        _dialogueFileHandle(dialogueFile), _speechId(speechId), _active(false),
        _disposeAfterUse(DisposeAfterUse::NO) {}
    ~CSoundItem() override;
};

class CSoundItemList : public List<CSoundItem> {
};

class CSound {
private:
    CGameManager *_gameManager;
    CSoundItemList _sounds;
private:
    void checkSounds();

    void removeOldest();
public:
    QSoundManager _soundManager;
public:
    CSound(CGameManager *owner, Audio::Mixer *mixer);
    ~CSound();

    void save(SimpleFile *file) const;

    void load(SimpleFile *file);

    void preLoad();

    void postLoad() { _soundManager.postLoad(); }

    void preSave() { _soundManager.preSave(); }

    void postSave() { _soundManager.postSave(); }

    void preEnterView(CViewItem *newView, bool isNewRoom);

    bool isActive(int handle);

    void setVolume(uint handle, uint volume, uint seconds);

    void activateSound(CWaveFile *waveFile,
        DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::NO);

    void stopChannel(int channel);

    CWaveFile *getTrueTalkSound(CDialogueFile *dialogueFile, int index);

    CWaveFile *loadSpeech(CDialogueFile *dialogueFile, int speechId);

    int playSpeech(CDialogueFile *dialogueFile, int speechId, CProximity &prox);

    CWaveFile *loadSound(const CString &name);

    int playSound(const CString &name, CProximity &prox);

    void stopSound(uint handle);

    void setCanFree(int handle);

    void updateMixer();
};

} // End of namespace Titanic

#endif /* TITANIC_SOUND_H */