mixer.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 AUDIO_MIXER_H
#define AUDIO_MIXER_H

#include "common/mutex.h"
#include "common/types.h"
#include "common/noncopyable.h"

namespace Audio {

class AudioStream;
class Channel;
class Timestamp;

class SoundHandle {
    friend class Channel;
    friend class MixerImpl;
    uint32 _val = 0xffffffff;

public:
    bool  operator==(const SoundHandle &h)    const { return _val == h._val; }

    bool  operator!=(const SoundHandle &h)    const { return _val != h._val; }
};

class Mixer : Common::NonCopyable {
public:
    enum SoundType {
        kPlainSoundType = 0, 
        kMusicSoundType = 1, 
        kSFXSoundType = 2,   
        kSpeechSoundType = 3 
    };
    enum {
        kMaxChannelVolume = 255, 
        kMaxMixerVolume = 256    
    };

public:
    Mixer() {}
    virtual ~Mixer() {}



    virtual bool isReady() const = 0;

    virtual Common::Mutex &mutex() = 0;

    virtual void playStream(
        SoundType type,
        SoundHandle *handle,
        AudioStream *stream,
        int id = -1,
        byte volume = kMaxChannelVolume,
        int8 balance = 0,
        DisposeAfterUse::Flag autofreeStream = DisposeAfterUse::YES,
        bool permanent = false,
        bool reverseStereo = false) = 0;

    virtual void stopAll() = 0;

    virtual void stopID(int id) = 0;

    virtual void stopHandle(SoundHandle handle) = 0;



    virtual void pauseAll(bool paused) = 0;

    virtual void pauseID(int id, bool paused) = 0;

    virtual void pauseHandle(SoundHandle handle, bool paused) = 0;



    virtual bool isSoundIDActive(int id) = 0;

    virtual int getSoundID(SoundHandle handle) = 0;

    virtual bool isSoundHandleActive(SoundHandle handle) = 0;


    virtual void muteSoundType(SoundType type, bool mute) = 0;

    virtual bool isSoundTypeMuted(SoundType type) const = 0;

    virtual void setChannelVolume(SoundHandle handle, byte volume) = 0;

    virtual byte getChannelVolume(SoundHandle handle) = 0;

    virtual void setChannelBalance(SoundHandle handle, int8 balance) = 0;

    virtual int8 getChannelBalance(SoundHandle handle) = 0;

    virtual void setChannelFaderL(SoundHandle handle, uint8 faderL) = 0;

    virtual uint8 getChannelFaderL(SoundHandle handle) = 0;

    virtual void setChannelFaderR(SoundHandle handle, uint8 faderR) = 0;

    virtual uint8 getChannelFaderR(SoundHandle handle) = 0;

    virtual void setChannelRate(SoundHandle handle, uint32 rate) = 0;

    virtual uint32 getChannelRate(SoundHandle handle) = 0;

    virtual void resetChannelRate(SoundHandle handle) = 0;

    virtual uint32 getSoundElapsedTime(SoundHandle handle) = 0;

    virtual Timestamp getElapsedTime(SoundHandle handle) = 0;

    virtual void loopChannel(SoundHandle handle) = 0;

    virtual bool hasActiveChannelOfType(SoundType type) = 0;

    virtual void setVolumeForSoundType(SoundType type, int volume) = 0;

    virtual int getVolumeForSoundType(SoundType type) const = 0;

    virtual uint getOutputRate() const = 0;

    virtual bool getOutputStereo() const = 0;

    virtual uint getOutputBufSize() const = 0;
};

} // End of namespace Audio

#endif