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

#include "mediastation/actor.h"
#include "mediastation/audio.h"
#include "mediastation/datafile.h"
#include "mediastation/clients.h"
#include "mediastation/mediascript/scriptvalue.h"
#include "mediastation/mediascript/scriptconstants.h"

namespace MediaStation {

class SoundActor : public Actor, public ChannelClient, public SoundClient, public ImtDeviceUser {
public:
    SoundActor() : Actor(kActorTypeSound), _sequence(this) {};
    ~SoundActor();

    virtual void readParameter(Chunk &chunk, ActorHeaderSectionType paramType) override;
    virtual ScriptValue callMethod(BuiltInMethod methodId, Common::Array<ScriptValue> &args) override;
    virtual void readChunk(Chunk &chunk) override;
    virtual bool isActive() const override { return _playState == kSoundPlayStatePlaying; }
    virtual bool giveUpDevice() override;

    virtual void onEvent(const ActorEvent &event) override;
    virtual void timerEvent(const TimerEvent &event) override;
    virtual void soundPlayStateChanged(SoundPlayState state, SoundStopReason why) override;

    void start();
    void stop();
    void pause();
    void resume(bool restart);

private:
    ImtStreamFeed *_streamFeed = nullptr;
    bool _isLoadedFromChunk = false;
    bool _discardAfterUse = false;
    SoundPlayState _playState = kSoundPlayStateStopped;
    AudioSequence _sequence;

    void openStream();
};

} // End of namespace MediaStation

#endif