The video stream class, see IVideoStream. More...
#include "murl_util_video_stream.h"
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... | |
Public Member Functions inherited from Murl::IVideoStream | |
~IVideoStream () override | |
The destructor. | |
Detailed Description
The video stream class, see IVideoStream.
Constructor & Destructor Documentation
◆ VideoStream()
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.
- Parameters
-
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.
Member Function Documentation
◆ Clone() [1/4]
|
overridevirtual |
Implementation of IVideoStream::Clone().
- Returns
- The new video stream object.
Implements Murl::IVideoStream.
◆ Clone() [2/4]
|
overridevirtual |
Implementation of IVideoStream::Clone(IEnums::PixelFormat pixelFormat).
- Parameters
-
pixelFormat The pixel format of the new video object.
- Returns
- The new video stream object or null if conversion is not available.
Implements Murl::IVideoStream.
◆ Clone() [3/4]
|
overridevirtual |
Implementation of IVideoStream::Clone((IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY).
- Parameters
-
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.
- Returns
- The new video stream object or null if conversion is not available.
Implements Murl::IVideoStream.
◆ Clone() [4/4]
|
overridevirtual |
Implementation of IVideoStream::Clone(IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, IEnums::MipMapGenerationMode mipMapGen).
- Parameters
-
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.
- Returns
- The new video stream object or null if conversion is not available.
Implements Murl::IVideoStream.
◆ GetNumberOfFrames()
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfFrames().
- Returns
- The number of frames.
Implements Murl::IVideoStream.
◆ GetFrameIndex()
Implementation of IVideoStream::GetFrameIndex().
- Parameters
-
startTime The frame start time in seconds.
- Returns
- The frame index.
Implements Murl::IVideoStream.
◆ GetStartTime()
Implementation of IVideoStream::GetStartTime().
- Parameters
-
frameIndex The index of the frame to query.
- Returns
- The frame's start time.
Implements Murl::IVideoStream.
◆ GetFrameRate()
|
overridevirtual |
Implementation of IVideoStream::GetFrameRate().
- Returns
- The number of frames per second.
Implements Murl::IVideoStream.
◆ GetFrameDuration()
|
overridevirtual |
Implementation of IVideoStream::GetFrameDuration().
- Returns
- The frame duration in seconds.
Implements Murl::IVideoStream.
◆ GetTotalDuration()
|
overridevirtual |
Implementation of IVideoStream::GetTotalDuration().
- Returns
- The total duration.
Implements Murl::IVideoStream.
◆ GetNumberOfMipLevels()
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfMipLevels().
- Returns
- The number of mip levels.
Implements Murl::IVideoStream.
◆ GetNumberOfPlanes()
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfPlanes().
- Returns
- The number of color planes.
Implements Murl::IVideoStream.
◆ GetPixelFormat() [1/2]
|
overridevirtual |
Implementation of IVideoStream::GetPixelFormat().
- Returns
- The pixel format of the stream.
Implements Murl::IVideoStream.
◆ GetBytesPerPixel() [1/2]
|
overridevirtual |
Implementation of IVideoStream::GetBytesPerPixel().
- Returns
- The number of bytes per pixel for the stream format.
Implements Murl::IVideoStream.
◆ GetPixelSizeX() [1/2]
Implementation of IVideoStream::GetPixelSizeX(UInt32 mipLevel).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1].
- Returns
- The number of horizontal pixels.
Implements Murl::IVideoStream.
◆ GetPixelSizeY() [1/2]
Implementation of IVideoStream::GetPixelSizeY(UInt32 mipLevel).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1].
- Returns
- The number of vertical pixels.
Implements Murl::IVideoStream.
◆ GetBytesPerLine() [1/2]
Implementation of IVideoStream::GetBytesPerLine(UInt32 mipLevel).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1].
- Returns
- The number of bytes per line.
Implements Murl::IVideoStream.
◆ GetNumberOfBytes() [1/2]
Implementation of IVideoStream::GetNumberOfBytes(UInt32 mipLevel).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1].
- Returns
- The number of bytes.
Implements Murl::IVideoStream.
◆ GetPixelFormat() [2/2]
|
overridevirtual |
Implementation of IVideoStream::GetPixelFormat(UInt32 planeIndex).
- Parameters
-
planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The pixel format of the plane.
Implements Murl::IVideoStream.
◆ GetBytesPerPixel() [2/2]
Implementation of IVideoStream::GetBytesPerPixel(UInt32 planeIndex).
- Parameters
-
planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The number of bytes per pixel for the given plane.
Implements Murl::IVideoStream.
◆ GetPixelSizeX() [2/2]
|
overridevirtual |
Implementation of IVideoStream::GetPixelSizeX(UInt32 mipLevel, UInt32 planeIndex).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The number of horizontal pixels.
Implements Murl::IVideoStream.
◆ GetPixelSizeY() [2/2]
|
overridevirtual |
Implementation of IVideoStream::GetPixelSizeY(UInt32 mipLevel, UInt32 planeIndex).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The number of vertical pixels.
Implements Murl::IVideoStream.
◆ GetBytesPerLine() [2/2]
|
overridevirtual |
Implementation of IVideoStream::GetBytesPerLine(UInt32 mipLevel, UInt32 planeIndex).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The number of bytes per line.
Implements Murl::IVideoStream.
◆ GetNumberOfBytes() [2/2]
|
overridevirtual |
Implementation of IVideoStream::GetNumberOfBytes(UInt32 mipLevel, UInt32 planeIndex).
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The number of bytes.
Implements Murl::IVideoStream.
◆ IsReadyForDecoding()
|
overridevirtual |
Implementation of IVideoStream::IsReadyForDecoding().
- Returns
- true if ready.
Implements Murl::IVideoStream.
◆ StartDecoding()
|
overridevirtual |
Implementation of IVideoStream::StartDecoding().
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ EndDecoding()
|
overridevirtual |
Implementation of IVideoStream::EndDecoding().
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ Decode()
|
overridevirtual |
Implementation of IVideoStream::Decode().
- Parameters
-
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.
- Returns
- The number of decoded frames.
Implements Murl::IVideoStream.
◆ SetCurrentMode()
|
overridevirtual |
Implementation of IVideoStream::SetCurrentMode().
- Parameters
-
mode The access mode to apply.
- Returns
- true if a new frame was triggered.
Implements Murl::IVideoStream.
◆ GetCurrentMode()
|
overridevirtual |
Implementation of IVideoStream::GetCurrentMode().
- Returns
- The current access mode.
Implements Murl::IVideoStream.
◆ SetCurrentTimeOffset()
Implementation of IVideoStream::SetCurrentTimeOffset().
- Parameters
-
timeOffset The time offset in seconds.
- Returns
- true if a new frame was triggered.
Implements Murl::IVideoStream.
◆ GetCurrentTimeOffset()
|
overridevirtual |
Implementation of IVideoStream::GetCurrentTimeOffset().
- Returns
- The time offset in seconds.
Implements Murl::IVideoStream.
◆ PrepareDecodedData()
|
overridevirtual |
Implementation of IVideoStream::PrepareDecodedData().
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ FinishDecodedData()
|
overridevirtual |
Implementation of IVideoStream::FinishDecodedData().
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ ReleaseDecodedData()
|
overridevirtual |
Implementation of IVideoStream::ReleaseDecodedData().
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ GetDecodedTimeOffset()
|
overridevirtual |
Implementation of IVideoStream::GetDecodedTimeOffset().
- Returns
- The time offset in seconds.
Implements Murl::IVideoStream.
◆ GetDecodedFrameIndex()
|
overridevirtual |
Implementation of IVideoStream::GetDecodedFrameIndex().
- Returns
- The frame index.
Implements Murl::IVideoStream.
◆ GetDecodedData()
|
overridevirtual |
Implementation of IVideoStream::GetDecodedData().
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The decoded data or empty data if not supported.
Implements Murl::IVideoStream.
◆ GetDecodedSurface()
|
overridevirtual |
Implementation of IVideoStream::GetDecodedSurface().
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The decoded surface or null if not supported.
Implements Murl::IVideoStream.
◆ LockDecodedData()
|
overridevirtual |
Implementation of IVideoStream::LockDecodedData().
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The mutable data or empty data if not supported.
Implements Murl::IVideoStream.
◆ LockDecodedSurface()
|
overridevirtual |
Implementation of IVideoStream::LockDecodedSurface().
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- The mutable surface or null if not supported.
Implements Murl::IVideoStream.
◆ UnlockDecodedData()
|
overridevirtual |
Implementation of IVideoStream::UnlockDecodedData().
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ UnlockDecodedSurface()
|
overridevirtual |
Implementation of IVideoStream::UnlockDecodedSurface().
- Parameters
-
mipLevel The mip level in the range [0 .. GetNumberOfMipLevels() - 1]. planeIndex The color plane index in the range [0 .. GetNumberOfPlanes() - 1].
- Returns
- true if successful.
Implements Murl::IVideoStream.
◆ SetSurface()
|
virtual |
Set the surface.
- Parameters
-
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.
- Returns
- true if successful.
◆ CollectObjectStatistics()
|
override |
Implementation of IStatisticsObject::CollectObjectStatistics().
- Parameters
-
stat The object statistics container.
The documentation for this class was generated from the following file:
- murl_util_video_stream.h