video.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 MOHAWK_VIDEO_H
#define MOHAWK_VIDEO_H
 
#include "audio/mixer.h"
#include "audio/timestamp.h"
#include "common/array.h"
#include "common/list.h"
#include "common/noncopyable.h"
#include "common/ptr.h"
#include "common/rational.h"
#include "graphics/pixelformat.h"
#include "video/subtitles.h"
 
namespace Video {
class VideoDecoder;
}
 
namespace Mohawk {
 
class MohawkEngine;
 
class VideoEntry : private Common::NonCopyable {
    // The private members should be able to be manipulated by VideoManager
    friend class VideoManager;
 
private:
    // Hide the destructor/constructor
    // Only VideoManager should be allowed
    VideoEntry();
    VideoEntry(Video::VideoDecoder *video, const Common::Path &fileName);
    VideoEntry(Video::VideoDecoder *video, int id);
 
public:
    ~VideoEntry();
 
    operator bool() const { return isOpen(); }
 
    bool isOpen() const { return _video != 0; }
 
    void close();
 
    bool endOfVideo() const;
 
    uint16 getX() const { return _x; }
 
    uint16 getY() const { return _y; }
 
    bool isLooping() const { return _loop; }
 
    bool isEnabled() const { return _enabled; }
 
    const Audio::Timestamp &getStart() const { return _start; }
 
    const Common::Path &getFileName() const { return _fileName; }
 
    int getID() const { return _id; }
 
    int getCurFrame() const;
 
    uint32 getFrameCount() const;
 
    uint32 getTime() const;
 
    Audio::Timestamp getDuration() const;
 
    Common::Rational getRate() const;
 
    void setX(uint16 x) { _x = x; }
 
    void setY(uint16 y) { _y = y; }
 
    void moveTo(uint16 x, uint16 y) { setX(x); setY(y); }
 
    void center();
 
    void setStart(const Audio::Timestamp &time) { _start = time; }
 
    void setLooping(bool loop) { _loop = loop; }
 
    void setEnabled(bool enabled) { _enabled = enabled; }
 
    void setBounds(const Audio::Timestamp &startTime, const Audio::Timestamp &endTime);
 
    void seek(const Audio::Timestamp &time);
 
    void setRate(const Common::Rational &rate);
 
    void pause(bool isPaused);
 
    void start();
 
    void stop();
 
    bool isPlaying() const;
 
    int getVolume() const;
 
    void setVolume(int volume);
 
    void loadSubtitles(const Common::Path &fname) { _subtitles.loadSRTFile(fname); }
private:
    // Non-changing variables
    Video::VideoDecoder *_video;
    Common::Path _fileName;   // External video files
    int _id;                  // Internal Mohawk files
 
    // Playback variables
    uint16 _x;
    uint16 _y;
    bool _loop;
    bool _enabled;
    Audio::Timestamp _start;
 
    Video::Subtitles _subtitles;
};
 
typedef Common::SharedPtr<VideoEntry> VideoEntryPtr;
 
class VideoManager {
public:
    explicit VideoManager(MohawkEngine *vm);
    virtual ~VideoManager();
 
    // Generic movie functions
    VideoEntryPtr playMovie(const Common::Path &filename, Audio::Mixer::SoundType soundType = Audio::Mixer::kPlainSoundType);
    VideoEntryPtr playMovie(uint16 id);
    bool updateMovies();
    void pauseVideos();
    void resumeVideos();
    void stopVideos();
    bool isVideoPlaying();
 
    // Handle functions
    VideoEntryPtr findVideo(uint16 id);
    VideoEntryPtr findVideo(const Common::Path &fileName);
    void drawVideoFrame(const VideoEntryPtr &video, const Audio::Timestamp &time);
    void removeEntry(const VideoEntryPtr &video);
 
protected:
    MohawkEngine *_vm;
 
    // Keep tabs on any videos playing
    typedef Common::List<VideoEntryPtr> VideoList;
    VideoList _videos;
 
    // Utility functions for managing entries
    VideoEntryPtr open(uint16 id);
    VideoEntryPtr open(const Common::Path &fileName, Audio::Mixer::SoundType soundType);
 
    VideoList::iterator findEntry(VideoEntryPtr ptr);
 
    bool drawNextFrame(VideoEntryPtr videoEntry);
 
    // Dithering control
    bool _enableDither;
    void checkEnableDither(VideoEntryPtr &entry);
};
 
} // End of namespace Mohawk
 
#endif