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

#include "startrek/soundeffects.h"
#include "startrek/startrek.h"

#include "audio/midiparser.h"
#include "audio/mididrv.h"
#include "audio/mixer.h"

namespace Common {
class MacResManager;
}

namespace StarTrek {

class StarTrekEngine;


// Max # of VOC files that can play at once
const int MAX_SFX_PLAYING = 4;

const int NUM_MIDI_SLOTS = 8;

struct MidiPlaybackSlot {
    int slot;
    int track;
    MidiParser *midiParser;
};


class Sound {
public:
    Sound(StarTrekEngine *vm);
    ~Sound();

    void clearAllMidiSlots();
    void playMidiTrack(MidiTracks track);
    void playMidiTrackInSlot(int slot, MidiTracks track);
    bool isMidiPlaying();
    void loadMusicFile(const Common::String &baseSoundName);
    void playMidiMusicTracks(MidiTracks startTrack, MidiLoopType loopType = kLoopTypeNone);
    void playVoc(const Common::String &baseSoundName);
    void playSpeech(const Common::String &basename);
    void stopAllVocSounds();
    void stopPlayingSpeech();
    void playSoundEffectIndex(SoundEffects index);
    void setMusicEnabled(bool enable);
    void setSfxEnabled(bool enable);
    void toggleMusic();
    void toggleSfx();
    void checkLoopMusic();

private:
    StarTrekEngine *_vm;
    Audio::SoundHandle *_soundHandle;

    void loadPCMusicFile(const Common::String &baseSoundName);
    void clearMidiSlot(int slot);

    // MIDI-Related Variables
    MidiDriver *_midiDriver;
    MidiPlaybackSlot _midiSlots[NUM_MIDI_SLOTS]; // 0 is for music; 1-7 are for sfx
    Common::List<MidiPlaybackSlot *> _midiSlotList; // Sorts midi slots by most recently used

    byte *_loadedSoundData;
    int _loadedSoundDataSize;
    uint32 _midiDevice;

    // VOC-related variables
    Audio::SoundHandle _sfxHandles[MAX_SFX_PLAYING];
    Audio::SoundHandle _speechHandle;
    bool _playingSpeech;

public:
    Common::String _loopingAudioName;
    Common::String _loadedMidiFilename;
    MidiTracks _loopingMidiTrack;

private:
    // Driver callback
    static void midiDriverCallback(void *data);
};

} // End of namespace StarTrek

#endif