VideoStreamInfo¶

primo::codecs::VideoStreamInfo

class VideoStreamInfo : public primo::codecs::StreamInfo ¶

VideoStreamInfo describes an elementary video stream.

Public Functions

virtual int32_t frameWidth() const = 0¶

Returns the video frame width.

Returns:: video frame width in pixels.

virtual bool_t setFrameWidth(int32_t frameWidth) = 0¶

Sets the video frame width.

Parameters:: frameWidth – in pixels.
Returns:: TRUE if the frame width is successfully set, otherwise FALSE.

virtual int32_t frameHeight() const = 0¶

Returns the video frame height.

Returns:: video frame height in pixels.

virtual bool_t setFrameHeight(int32_t frameHeight) = 0¶

Sets the video frame height.

Parameters:: frameHeight – in pixels
Returns:: TRUE if the frame height is successfully set, otherwise FALSE.

virtual int32_t displayRatioHeight() const = 0¶

Returns the vertical dimension of the display aspect ratio.

Returns:: vertical display ratio.

virtual int32_t displayRatioWidth() const = 0¶

Returns the horizontal dimension of the display aspect ratio.

Returns:: horizontal display ratio.

virtual bool_t setDisplayRatioHeight(int32_t displayHeight) = 0¶

Sets the vertical dimension of the display aspect ratio.

Parameters:: displayHeight – The value has no meaning on its own. It serves only to express the display aspect ratio.
Returns:: TRUE if the display height is successfully set, otherwise FALSE.

virtual bool_t setDisplayRatioWidth(int32_t displayWidth) = 0¶

Sets the horizontal dimension of the display aspect ratio.

Parameters:: displayWidth – The value has no meaning on its own. It serves only to express the display aspect ratio.
Returns:: TRUE if the display width is successfully set, otherwise FALSE.

virtual double frameRate() const = 0¶

Returns the video frame rate.

Returns:: video frame rate in frames per second.

virtual bool_t setFrameRate(double frameRate) = 0¶

Sets the video frame rate.

Parameters:: frameRate – in frames per second.
Returns:: TRUE if the frame rate is successfully set, otherwise FALSE.

virtual ColorFormat::Enum colorFormat() const = 0¶

Returns the video color format.

Returns:: A ColorFormat::Enum constant.

virtual bool_t setColorFormat(ColorFormat::Enum colorFormat) = 0¶

Sets the video color format.

Parameters:: colorFormat – color format
Returns:: TRUE if the color format is successfully set, otherwise FALSE.

virtual int32_t stride() const = 0¶

Returns the video image stride.

Stride is the distance in bytes from the start of one row of pixels in memory to the start of the next row of pixels. It is also called a pitch.

Returns:: Image stride in bytes.

virtual bool_t setStride(int32_t stride) = 0¶

Sets the video image stride.

Stride is the distance in bytes from the start of one row of pixels in memory to the start of the next row of pixels. It is also called a pitch.

Parameters:: stride – Image stride in bytes.
Returns:: TRUE if the stride is successfully set, otherwise FALSE.

virtual ScanType::Enum scanType() const = 0¶

Returns the scan type of the video frame.

Returns:: Scan type

virtual bool_t setScanType(ScanType::Enum scanType) = 0¶

Sets the scan type of the video frame.

Parameters:: scanType –
Returns:: TRUE The scan type is set, FALSE otherwise.

virtual bool_t frameBottomUp() const = 0¶

Returns whether internally the video frame is stored upside down.

Returns:: TRUE The frame is stored upside down (vertically flipped) but logically it should be displayed normally. This is typical for bitmaps. FALSE The frame is displayed as it is stored - top row is first in memory, bottom row is last.

virtual bool_t setFrameBottomUp(bool_t bottomUp) = 0¶

Sets whether internally the video frame is stored upside down.

Parameters:: bottomUp – TRUE the frame is stored upside down, FALSE the frame is stored normally
Returns:: TRUE if the bottom-up flag is successfully set, otherwise FALSE.

virtual bool_t copyTo(VideoStreamInfo *destination) const = 0¶

Copies the state of the current object to a destination object of the same type.

The reference count of the source and the destination is not modified.

Parameters:: destination – [out] A pointer to the destination object
Returns:: TRUE The object state is copied, FALSE otherwise.

virtual VideoStreamInfo *clone() const = 0¶

Creates a copy of this object.

Remark

When cloned an immutable object becomes mutable.