secondaryvideo.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 NANCY_ACTION_SECONDARYVIDEO_H
#define NANCY_ACTION_SECONDARYVIDEO_H
 
#include "engines/nancy/cursor.h"
#include "engines/nancy/nancy.h"
#include "engines/nancy/movieplayer.h"
#include "engines/nancy/action/actionrecord.h"
 
namespace Nancy {
namespace Action {
 
// Shows an (optionally) looping AVF video, which can move around
// the screen with the background frame. When hovered, the video can
// play a special animation instead of the normal looping one.
// Used for character animations _outside_ of conversations.
class PlaySecondaryVideo : public RenderActionRecord {
public:
    static const byte kNoVideoHotspots  = 1;
    static const byte kVideoHotspots    = 2;
 
    enum HoverState { kNoHover, kHover, kEndHover };
 
    PlaySecondaryVideo() : RenderActionRecord(8) {}
    virtual ~PlaySecondaryVideo() { _decoder.close(); }
 
    void init() override;
    void updateGraphics() override;
    void onPause(bool pause) override;
    void handleInput(NancyInput &input) override;
 
    void readData(Common::SeekableReadStream &stream) override;
    void execute() override;
 
    Common::Path _filename;
    Common::Path _paletteFilename;
    // Common::Path _bitmapOverlayFilename
 
    // TVD only
    uint16 _videoFormat = kLargeVideoFormat;
    uint16 _videoHotspots = kVideoHotspots;
 
    uint16 _loopFirstFrame = 0;
    uint16 _loopLastFrame = 0;
    uint16 _onHoverFirstFrame = 0;
    uint16 _onHoverLastFrame = 0;
    uint16 _onHoverEndFirstFrame = 0;
    uint16 _onHoverEndLastFrame = 0;
    SceneChangeDescription _sceneChange;
 
    // Nancy 10+: push current scene before the sceneChange target.
    bool _pushSceneOnTrigger = false;
 
    // Nancy 10+: set an event flag when playback reaches frameID.
    struct FlagAtFrame {
        int16 frameID;
        FlagDescription flagDesc;
    };
    Common::Array<FlagAtFrame> _frameFlags;
 
    Common::Array<SecondaryVideoDescription> _videoDescs;
 
    bool canHaveHotspot() const override { return true; }
    bool isViewportRelative() const override { return true; }
    // Ambient character animations stay on screen across a NO_ART_SCENE change
    // (e.g. while a phone-call conversation is overlaid in front of them).
    bool survivesSceneChange(bool nextSceneIsNoArt) const override { return nextSceneIsNoArt; }
 
    CursorManager::CursorType getHoverCursor() const override {
        return g_nancy->getGameType() >= kGameTypeNancy10 ? CursorManager::kHotspotTalk : CursorManager::kHotspot;
    }
 
    Common::String getRecordExtraInfo() const override {
        return Common::String::format("Scene %d, file %s", _sceneChange.sceneID, _filename.baseName().c_str());
    }
 
protected:
    Common::String getRecordTypeName() const override { return "PlaySecondaryVideo"; }
 
    Graphics::ManagedSurface _fullFrame;
    HoverState _hoverState = kNoHover;
    MoviePlayer _decoder;
    int _currentViewportFrame = -1;
    int _currentViewportScroll = -1;
    bool _isInFrame = false;
    bool _isHovered = false;
};
 
} // End of namespace Action
} // End of namespace Nancy
 
#endif // NANCY_ACTION_SECONDARYVIDEO_H