mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-16 22:58:09 +00:00
291 lines
7.0 KiB
C++
291 lines
7.0 KiB
C++
/* 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 2
|
|
* 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, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* $URL$
|
|
* $Id$
|
|
*
|
|
*/
|
|
|
|
#ifndef VIDEO_DECODER_H
|
|
#define VIDEO_DECODER_H
|
|
|
|
#include "common/events.h"
|
|
#include "common/list.h"
|
|
#include "common/rational.h"
|
|
|
|
#include "graphics/surface.h"
|
|
#include "graphics/pixelformat.h"
|
|
|
|
namespace Common {
|
|
class SeekableReadStream;
|
|
}
|
|
|
|
namespace Video {
|
|
|
|
/**
|
|
* Implementation of a generic video decoder
|
|
*/
|
|
class VideoDecoder {
|
|
public:
|
|
VideoDecoder();
|
|
virtual ~VideoDecoder() {}
|
|
|
|
/**
|
|
* Returns the width of the video
|
|
* @return the width of the video
|
|
*/
|
|
virtual uint16 getWidth() const = 0;
|
|
|
|
/**
|
|
* Returns the height of the video
|
|
* @return the height of the video
|
|
*/
|
|
virtual uint16 getHeight() const = 0;
|
|
|
|
/**
|
|
* Returns the current frame number of the video
|
|
* @return the last frame decoded by the video
|
|
*/
|
|
virtual int32 getCurFrame() const { return _curFrame; }
|
|
|
|
/**
|
|
* Returns the amount of frames in the video
|
|
* @return the amount of frames in the video
|
|
*/
|
|
virtual uint32 getFrameCount() const = 0;
|
|
|
|
/**
|
|
* Returns the time (in ms) that the video has been running
|
|
*/
|
|
virtual uint32 getElapsedTime() const;
|
|
|
|
/**
|
|
* Returns whether a frame should be decoded or not
|
|
* @return whether a frame should be decoded or not
|
|
*/
|
|
virtual bool needsUpdate() const;
|
|
|
|
/**
|
|
* Load a video file
|
|
* @param filename the filename to load
|
|
*/
|
|
virtual bool loadFile(const Common::String &filename);
|
|
|
|
/**
|
|
* Load a video file
|
|
* @param stream the stream to load
|
|
*/
|
|
virtual bool load(Common::SeekableReadStream *stream) = 0;
|
|
|
|
/**
|
|
* Close a video file
|
|
*/
|
|
virtual void close() = 0;
|
|
|
|
/**
|
|
* Returns if a video file is loaded or not
|
|
*/
|
|
virtual bool isVideoLoaded() const = 0;
|
|
|
|
/**
|
|
* Decode the next frame and return the frame's surface
|
|
* @note the return surface should *not* be freed
|
|
* @note this may return 0, in which case the last frame should be kept on screen
|
|
*/
|
|
virtual const Graphics::Surface *decodeNextFrame() = 0;
|
|
|
|
/**
|
|
* Get the pixel format of the video
|
|
*/
|
|
virtual Graphics::PixelFormat getPixelFormat() const = 0;
|
|
|
|
/**
|
|
* Get the palette for the video in RGB format (if 8bpp or less)
|
|
*/
|
|
virtual const byte *getPalette() { return 0; }
|
|
|
|
/**
|
|
* Returns if the palette is dirty or not
|
|
*/
|
|
virtual bool hasDirtyPalette() const { return false; }
|
|
|
|
/**
|
|
* Returns if the video is finished or not
|
|
*/
|
|
virtual bool endOfVideo() const;
|
|
|
|
/**
|
|
* Set the current palette to the system palette
|
|
*/
|
|
void setSystemPalette();
|
|
|
|
/**
|
|
* Return the time until the next frame (in ms)
|
|
*/
|
|
virtual uint32 getTimeToNextFrame() const = 0;
|
|
|
|
/**
|
|
* Pause or resume the video. This should stop/resume any audio playback
|
|
* and other stuff. The initial pause time is kept so that any timing
|
|
* variables can be updated appropriately.
|
|
*
|
|
* This is a convenience tracker which automatically keeps track on how
|
|
* often the video has been paused, ensuring that after pausing an video
|
|
* e.g. twice, it has to be unpaused twice before actuallying resuming.
|
|
*
|
|
* @param pause true to pause the video, false to resume it
|
|
*/
|
|
void pauseVideo(bool pause);
|
|
|
|
/**
|
|
* Return whether the video is currently paused or not.
|
|
*/
|
|
bool isPaused() const { return _pauseLevel != 0; }
|
|
|
|
protected:
|
|
/**
|
|
* Resets _curFrame and _startTime. Should be called from every close() function.
|
|
*/
|
|
void reset();
|
|
|
|
/**
|
|
* Actual implementation of pause by subclasses. See pause()
|
|
* for details.
|
|
*/
|
|
virtual void pauseVideoIntern(bool pause) {}
|
|
|
|
/**
|
|
* Add the time the video has been paused to maintain sync
|
|
*/
|
|
virtual void addPauseTime(uint32 ms) { _startTime += ms; }
|
|
|
|
/**
|
|
* Reset the pause start time (which should be called when seeking)
|
|
*/
|
|
void resetPauseStartTime();
|
|
|
|
int32 _curFrame;
|
|
int32 _startTime;
|
|
|
|
private:
|
|
uint32 _pauseLevel;
|
|
uint32 _pauseStartTime;
|
|
};
|
|
|
|
/**
|
|
* A VideoDecoder wrapper that implements getTimeToNextFrame() based on getFrameRate().
|
|
*/
|
|
class FixedRateVideoDecoder : public virtual VideoDecoder {
|
|
public:
|
|
uint32 getTimeToNextFrame() const;
|
|
|
|
protected:
|
|
/**
|
|
* Return the frame rate in frames per second
|
|
* This returns a Rational because videos can have rates that are not integers and
|
|
* there are some videos with frame rates < 1.
|
|
*/
|
|
virtual Common::Rational getFrameRate() const = 0;
|
|
|
|
private:
|
|
uint32 getFrameBeginTime(uint32 frame) const;
|
|
};
|
|
|
|
/**
|
|
* A VideoDecoder that can rewind back to the beginning.
|
|
*/
|
|
class RewindableVideoDecoder : public virtual VideoDecoder {
|
|
public:
|
|
/**
|
|
* Rewind to the beginning of the video.
|
|
*/
|
|
virtual void rewind() = 0;
|
|
};
|
|
|
|
/**
|
|
* A simple video timestamp that holds time according to a specific scale.
|
|
*
|
|
* The scale is in terms of 1/x. For example, if you set units to 1 and the scale to
|
|
* 1000, the timestamp will hold the value of 1/1000s or 1ms.
|
|
*/
|
|
class VideoTimestamp {
|
|
public:
|
|
VideoTimestamp();
|
|
VideoTimestamp(uint units, uint scale = 1000);
|
|
|
|
/**
|
|
* Get the units in terms of _scale
|
|
*/
|
|
uint getUnits() const { return _units; }
|
|
|
|
/**
|
|
* Get the scale of this timestamp
|
|
*/
|
|
uint getScale() const { return _scale; }
|
|
|
|
/**
|
|
* Get the value of the units in terms of the specified scale
|
|
*/
|
|
uint getUnitsInScale(uint scale) const;
|
|
|
|
// TODO: Simple comparisons (<, <=, >, >=, ==, !=)
|
|
|
|
private:
|
|
uint _units, _scale;
|
|
};
|
|
|
|
/**
|
|
* A VideoDecoder that can seek to a frame or point in time.
|
|
*/
|
|
class SeekableVideoDecoder : public virtual RewindableVideoDecoder {
|
|
public:
|
|
/**
|
|
* Seek to the frame specified
|
|
* If seekToFrame(0) is called, frame 0 will be decoded next in decodeNextFrame()
|
|
*/
|
|
virtual void seekToFrame(uint32 frame) = 0;
|
|
|
|
/**
|
|
* Seek to the time specified
|
|
*
|
|
* This will round to the previous frame showing. If the time would happen to
|
|
* land while a frame is showing, this function will seek to the beginning of that
|
|
* frame. In other words, there is *no* subframe accuracy. This may change in a
|
|
* later revision of the API.
|
|
*/
|
|
virtual void seekToTime(VideoTimestamp time) = 0;
|
|
|
|
/**
|
|
* Seek to the frame specified (in ms)
|
|
*
|
|
* See seekToTime(VideoTimestamp)
|
|
*/
|
|
void seekToTime(uint32 time) { seekToTime(VideoTimestamp(time)); }
|
|
|
|
/**
|
|
* Implementation of RewindableVideoDecoder::rewind()
|
|
*/
|
|
virtual void rewind() { seekToTime(0); }
|
|
};
|
|
|
|
} // End of namespace Video
|
|
|
|
#endif
|