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

#include "common/config-manager.h"
#include "common/serializer.h"

namespace Cruise {

class CruiseEngine;
class PCSoundDriver;
class PCSoundFxPlayer;

class PCSound {
private:
    Audio::Mixer *_mixer;
    CruiseEngine *_vm;
    int _genVolume;
protected:
    PCSoundDriver *_soundDriver;
    PCSoundFxPlayer *_player;
public:
    PCSound(Audio::Mixer *mixer, CruiseEngine *vm);
    virtual ~PCSound();

    virtual void loadMusic(const char *name);
    virtual void playMusic();
    virtual void stopMusic();
    virtual void removeMusic();
    virtual void fadeOutMusic();

    virtual void playSound(const uint8 *data, int size, int volume);
    virtual void stopSound(int channel);

    void doSync(Common::Serializer &s);
    const char *musicName();
    void stopChannel(int channel);
    bool isPlaying() const;
    bool songLoaded() const;
    bool songPlayed() const;
    void fadeSong();
    uint8 numOrders() const;
    void setNumOrders(uint8 v);
    void setPattern(int offset, uint8 value);
    bool musicLooping() const;
    void musicLoop(bool v);
    void startNote(int channel, int volume, int freq);
    void syncSounds();

    // Note: Volume variable accessed by these methods is never actually used in original game
    void setVolume(int volume) { _genVolume = volume; }
    uint8 getVolume() const { return _genVolume; }
};

} // End of namespace Cruise

#endif