![]() |
Murl Engine API
Version 2024.1
|
The video stream class, see IVideoStream. More...
#include <murl_util_video_stream.h>
The video stream class, see IVideoStream.
Public Member Functions | |
VideoStream (IEnums::PixelFormat outputFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, IEnums::MipMapGenerationMode mipMapGen) | |
The constructor. More... | |
~VideoStream () override | |
The destructor. | |
IVideoStream * | Clone () const override |
Implementation of IVideoStream::Clone(). More... | |
IVideoStream * | Clone (IEnums::PixelFormat pixelFormat) const override |
Implementation of IVideoStream::Clone(IEnums::PixelFormat pixelFormat). More... | |
IVideoStream * | Clone (IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY) const override |
Implementation of IVideoStream::Clone((IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY). More... | |
IVideoStream * | Clone (IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, IEnums::MipMapGenerationMode mipMapGen) const override |
Implementation of IVideoStream::Clone(IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, IEnums::MipMapGenerationMode mipMapGen). More... | |
UInt32 | GetNumberOfFrames () const override |
Implementation of IVideoStream::GetNumberOfFrames(). More... | |
UInt32 | GetFrameIndex (Double startTime) const override |
Implementation of IVideoStream::GetFrameIndex(). More... | |
Double | GetStartTime (UInt32 frameIndex) const override |
Implementation of IVideoStream::GetStartTime(). More... | |
Double | GetFrameRate () const override |
Implementation of IVideoStream::GetFrameRate(). More... | |
Double | GetFrameDuration () const override |
Implementation of IVideoStream::GetFrameDuration(). More... | |
Double | GetTotalDuration () const override |
Implementation of IVideoStream::GetTotalDuration(). More... | |
UInt32 | GetNumberOfMipLevels () const override |
Implementation of IVideoStream::GetNumberOfMipLevels(). More... | |
UInt32 | GetNumberOfPlanes () const override |
Implementation of IVideoStream::GetNumberOfPlanes(). More... | |
IEnums::PixelFormat | GetPixelFormat () const override |
Implementation of IVideoStream::GetPixelFormat(). More... | |
UInt32 | GetBytesPerPixel () const override |
Implementation of IVideoStream::GetBytesPerPixel(). More... | |
UInt32 | GetPixelSizeX (UInt32 mipLevel) const override |
Implementation of IVideoStream::GetPixelSizeX(UInt32 mipLevel). More... | |
UInt32 | GetPixelSizeY (UInt32 mipLevel) const override |
Implementation of IVideoStream::GetPixelSizeY(UInt32 mipLevel). More... | |
UInt32 | GetBytesPerLine (UInt32 mipLevel) const override |
Implementation of IVideoStream::GetBytesPerLine(UInt32 mipLevel). More... | |
UInt32 | GetNumberOfBytes (UInt32 mipLevel) const override |
Implementation of IVideoStream::GetNumberOfBytes(UInt32 mipLevel). More... | |
IEnums::PixelFormat | GetPixelFormat (UInt32 planeIndex) const override |
Implementation of IVideoStream::GetPixelFormat(UInt32 planeIndex). More... | |
UInt32 | GetBytesPerPixel (UInt32 planeIndex) const override |
Implementation of IVideoStream::GetBytesPerPixel(UInt32 planeIndex). More... | |
UInt32 | GetPixelSizeX (UInt32 mipLevel, UInt32 planeIndex) const override |
Implementation of IVideoStream::GetPixelSizeX(UInt32 mipLevel, UInt32 planeIndex). More... | |
UInt32 | GetPixelSizeY (UInt32 mipLevel, UInt32 planeIndex) const override |
Implementation of IVideoStream::GetPixelSizeY(UInt32 mipLevel, UInt32 planeIndex). More... | |
UInt32 | GetBytesPerLine (UInt32 mipLevel, UInt32 planeIndex) const override |
Implementation of IVideoStream::GetBytesPerLine(UInt32 mipLevel, UInt32 planeIndex). More... | |
UInt32 | GetNumberOfBytes (UInt32 mipLevel, UInt32 planeIndex) const override |
Implementation of IVideoStream::GetNumberOfBytes(UInt32 mipLevel, UInt32 planeIndex). More... | |
Bool | IsReadyForDecoding () const override |
Implementation of IVideoStream::IsReadyForDecoding(). More... | |
Bool | StartDecoding () override |
Implementation of IVideoStream::StartDecoding(). More... | |
Bool | EndDecoding () override |
Implementation of IVideoStream::EndDecoding(). More... | |
UInt32 | Decode (UInt32 mipLevel, UInt32 planeIndex, Data &dstBuffer, IEnums::PixelFormat dstFormat, UInt32 firstFrame, UInt32 numFrames) override |
Implementation of IVideoStream::Decode(). More... | |
Bool | SetCurrentMode (IEnums::StreamMode mode) override |
Implementation of IVideoStream::SetCurrentMode(). More... | |
const IEnums::StreamMode | GetCurrentMode () const override |
Implementation of IVideoStream::GetCurrentMode(). More... | |
Bool | SetCurrentTimeOffset (Double timeOffset) override |
Implementation of IVideoStream::SetCurrentTimeOffset(). More... | |
Double | GetCurrentTimeOffset () const override |
Implementation of IVideoStream::GetCurrentTimeOffset(). More... | |
Bool | PrepareDecodedData () override |
Implementation of IVideoStream::PrepareDecodedData(). More... | |
Bool | FinishDecodedData () override |
Implementation of IVideoStream::FinishDecodedData(). More... | |
Bool | ReleaseDecodedData () override |
Implementation of IVideoStream::ReleaseDecodedData(). More... | |
Double | GetDecodedTimeOffset () const override |
Implementation of IVideoStream::GetDecodedTimeOffset(). More... | |
UInt64 | GetDecodedFrameIndex () const override |
Implementation of IVideoStream::GetDecodedFrameIndex(). More... | |
const ConstData & | GetDecodedData (UInt32 mipLevel, UInt32 planeIndex) override |
Implementation of IVideoStream::GetDecodedData(). More... | |
const IVideoSurface * | GetDecodedSurface (UInt32 mipLevel, UInt32 planeIndex) override |
Implementation of IVideoStream::GetDecodedSurface(). More... | |
const MutableData & | LockDecodedData (UInt32 mipLevel, UInt32 planeIndex) override |
Implementation of IVideoStream::LockDecodedData(). More... | |
IVideoSurface * | LockDecodedSurface (UInt32 mipLevel, UInt32 planeIndex) override |
Implementation of IVideoStream::LockDecodedSurface(). More... | |
Bool | UnlockDecodedData (UInt32 mipLevel, UInt32 planeIndex) override |
Implementation of IVideoStream::UnlockDecodedData(). More... | |
Bool | UnlockDecodedSurface (UInt32 mipLevel, UInt32 planeIndex) override |
Implementation of IVideoStream::UnlockDecodedSurface(). More... | |
virtual Bool | SetSurface (UInt32 mipLevel, UInt32 planeIndex, IVideoSurface *surface, Bool takeOwnership) |
Set the surface. More... | |
void | CollectObjectStatistics (IObjectStatistics *stat) const override |
Implementation of IStatisticsObject::CollectObjectStatistics(). More... | |
![]() | |
~IVideoStream () override | |
The destructor. | |
Murl::Util::VideoStream::VideoStream | ( | IEnums::PixelFormat | outputFormat, |
UInt32 | pixelSizeX, | ||
UInt32 | pixelSizeY, | ||
IEnums::MipMapGenerationMode | mipMapGen | ||
) |
The constructor.
Creates a video stream with spcified pixel format and dimension.
outputFormat | The pixel format of the new video object. |
pixelSizeX | The number of horizontal pixels. |
pixelSizeY | The number of vertical pixels. |
mipMapGen | Specifies if and how mip maps are generated. |
|
overridevirtual |
Implementation of IVideoStream::Clone().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::Clone(IEnums::PixelFormat pixelFormat).
pixelFormat | The pixel format of the new video object. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::Clone((IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY).
pixelFormat | The pixel format of the new video object. |
pixelSizeX | The number of horizontal pixels of the new video object. |
pixelSizeY | The number of vertical pixels of the new video object. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::Clone(IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, IEnums::MipMapGenerationMode mipMapGen).
pixelFormat | The pixel format of the new video object. |
pixelSizeX | The number of horizontal pixels of the new video object. |
pixelSizeY | The number of vertical pixels of the new video object. |
mipMapGen | Specifies if and how mip maps are generated. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfFrames().
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetFrameIndex().
startTime | The frame start time in seconds. |
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetStartTime().
frameIndex | The index of the frame to query. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetFrameRate().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetFrameDuration().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetTotalDuration().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfMipLevels().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfPlanes().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetPixelFormat().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetBytesPerPixel().
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetPixelSizeX(UInt32 mipLevel).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetPixelSizeY(UInt32 mipLevel).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetBytesPerLine(UInt32 mipLevel).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetNumberOfBytes(UInt32 mipLevel).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetPixelFormat(UInt32 planeIndex).
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
Implementation of IVideoStream::GetBytesPerPixel(UInt32 planeIndex).
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetPixelSizeX(UInt32 mipLevel, UInt32 planeIndex).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetPixelSizeY(UInt32 mipLevel, UInt32 planeIndex).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetBytesPerLine(UInt32 mipLevel, UInt32 planeIndex).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfBytes(UInt32 mipLevel, UInt32 planeIndex).
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::IsReadyForDecoding().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::StartDecoding().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::EndDecoding().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::Decode().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
dstBuffer | The destination data. |
dstFormat | The destination pixel format. |
firstFrame | The first frame to decode. |
numFrames | The number of frames to decode. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::SetCurrentMode().
mode | The access mode to apply. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetCurrentMode().
Implements Murl::IVideoStream.
Implementation of IVideoStream::SetCurrentTimeOffset().
timeOffset | The time offset in seconds. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetCurrentTimeOffset().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::PrepareDecodedData().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::FinishDecodedData().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::ReleaseDecodedData().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetDecodedTimeOffset().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetDecodedFrameIndex().
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetDecodedData().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::GetDecodedSurface().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::LockDecodedData().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::LockDecodedSurface().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::UnlockDecodedData().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
overridevirtual |
Implementation of IVideoStream::UnlockDecodedSurface().
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
Implements Murl::IVideoStream.
|
virtual |
Set the surface.
mipLevel | The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. |
planeIndex | The color plane index in the range [0 .. GetNumberOfPlanes() - 1]. |
surface | The source video surface. |
takeOwnership | Take the source video surface ownershop if true. |
|
override |
Implementation of IStatisticsObject::CollectObjectStatistics().
stat | The object statistics container. |