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 ASYLUM_SYSTEM_SOUND_H
#define ASYLUM_SYSTEM_SOUND_H
 
#include "common/array.h"
#include "common/rect.h"
 
#include "audio/mixer.h"
 
#include "asylum/system/config.h"
 
#include "asylum/shared.h"
 
namespace Asylum {
 
class AsylumEngine;
 
struct ResourceEntry;
 
struct SoundItem {
    ResourceId resourceId;
    int32 field_4;
    int32 field_8;
    int32 field_C;
 
    SoundItem() {
        resourceId = kResourceNone;
        field_4 = 0;
        field_8 = 0;
        field_C = 0;
    }
};
 
struct FrameSoundItem {
    ResourceId resourceId;
    uint32 frameIndex;
    int32 index;
    int32 field_C;
    int32 field_10;
    int32 field_14;
 
    FrameSoundItem() {
        resourceId = kResourceNone;
        frameIndex = 0;
        index = 0;
        field_C = 0;
        field_10 = 0;
        field_14 = 0;
    }
};
 
struct AmbientSoundItem {
    int32 field_0;
    int32 flags;
    ResourceId resourceId;
    int32 delta;
    int32 attenuation;
    int32 nextTick;
    int32 flagNum[6];
    Common::Point point;
 
    AmbientSoundItem() {
        field_0 = 0;
        flags = 0;
        resourceId = kResourceNone;
        delta = 0;
        attenuation = 0;
        nextTick = 0;
        memset(&flagNum, 0, sizeof(flagNum));
    }
};
 
struct SoundQueueItem {
    ResourceId resourceId;
    Audio::SoundHandle handle;
 
    SoundQueueItem() {
        resourceId = kResourceNone;
    }
};
 
class Sound {
public:
    Sound(AsylumEngine *engine, Audio::Mixer *mixer);
    ~Sound();
 
    // Playing sounds & music
 
    void playSound(ResourceId resourceId, bool looping = false, int32 volume = Config.sfxVolume, int32 panning = 0);
 
    void playMusic(ResourceId resourceId, int32 volume = Config.musicVolume);
 
    void changeMusic(int32 index, int32 musicStatusExt);
 
    bool isPlaying(ResourceId resourceId);
 
    // Volume & panning
 
    void setVolume(ResourceId resourceId, int32 volume);
 
    void setMusicVolume(int32 volume);
 
    int32 getMusicVolume() { return _musicVolume; }
 
    void setPanning(ResourceId resourceId, int32 panning);
 
    int32 calculateVolumeAdjustement(const Common::Point &point, int32 attenuation, int32 delta);
 
    int32 getAdjustedVolume(int32 volume) const;
 
    int32 calculatePanningAtPoint(const Common::Point &point);
 
    // Stopping sounds
 
    void stop(ResourceId resourceId);
 
    void stopAll(ResourceId resourceId);
 
    void stopAll();
 
    void stopMusic();
 
    // Conversion functions
 
    static void convertVolumeFrom(int32 &vol);
 
    static void convertVolumeTo(int32 &vol);
 
private:
    AsylumEngine *_vm;
 
    Audio::Mixer       *_mixer;
 
    Audio::SoundHandle _musicHandle;
    int32 _musicVolume;
 
    Common::Array<SoundQueueItem> _soundQueue;
 
    // Sound queue
 
    SoundQueueItem *getItem(ResourceId resourceId);
 
    SoundQueueItem *getPlayingItem(ResourceId resourceId);
 
    SoundQueueItem *addToQueue(ResourceId resourceId);
 
    void cleanupQueue();
 
    // Helper functions
 
    bool isValidSoundResource(ResourceId resourceId);
 
    void playSoundData(Audio::Mixer::SoundType type, Audio::SoundHandle *handle, byte *soundData, uint32 soundDataLength, bool loop = false, int32 vol = 0, int32 pan = 0);
 
    // Conversion functions
 
    static void convertPan(int32 &pan);
};
 
} // end of namespace Asylum
 
#endif // ASYLUM_SYSTEM_SOUND_H