TVideoPicture Class Reference

class TVideoPicture

One uncompressed video picture. Used for both decoded picture output as well as uncompressed picture input.

Public Member Enumerations
enumTVideoPictureOptions {
ETimestamp = 0x00000001, ECropRect = 0x00000002, EHeader = 0x00000004, EBitTargets = 0x00000008, EReqInstantRefresh = 0x00000010, ESceneCut = 0x00000020, EPictureEffect = 0x00000040, EEffectParameters = 0x00000080, EContentProtected = 0x00000100
}
Public Attributes
TRect iCropRect
TPictureData iData
TPictureEffect iEffect
TUint iFadeParam
TVideoPictureHeader *iHeader
RArray< TUint > *iLayerBitRates
TDblQueLink iLink
TUint32 iOptions
TTimeIntervalMicroSeconds iTimestamp
TAny *iUser

Member Enumerations Documentation

Enum TVideoPictureOptions

Enumerators

ETimestamp = 0x00000001

The timestamp field is valid.

ECropRect = 0x00000002

The crop rectangle field is valid.

EHeader = 0x00000004

Picture header information is present.

EBitTargets = 0x00000008

The layer bit count targets field is valid.

EReqInstantRefresh = 0x00000010

Set in encoder input to request an instantaneous decoder refresh. As a response, the encoder should code an intra frame and no consecutive frame should refer to any frame before the encoded intra frame (in coding order).

ESceneCut = 0x00000020

Set in encoder input to indicate a scene cut in the picture stream.

EPictureEffect = 0x00000040

Set if a picture effect is in use and the picture effect field is valid.

EEffectParameters = 0x00000080

Set if picture effect parameters are valid.

EContentProtected = 0x00000100

Content protected pictures cannot be displayed on unprotected external displays such as TV-out.

Member Data Documentation

TRect iCropRect

TRect iCropRect

Pan-scan cropping rectangle. Defines the area of the picture used for further processing. Only used for decoded video output.

TPictureData iData

TPictureData iData

The picture data. The picture data, including all pointers, must remain valid until the picture has been returned to its originator.

TPictureEffect iEffect

TPictureEffect iEffect

The picture effect in use when capturing this picture, valid when EPictureEffect is set in the options. This information can be used when encoding the picture. Note that setting a picture effect does not imply that the encoder should modify the picture data based on the effect. Instead, it can be used as an encoding hint. For example, fade to black implies that the global picture brightness has been decreased, and this knowledge can be used to aid motion prediction. TPictureEffects

TUint iFadeParam

TUint iFadeParam

Picture effect parameter for fade to/from black, valid when EEffectParameters is set in the options and iEffect is EEffectFadeFromBlack or EEffectFadeToBlack. The value range is [0 65536], with zero indicating the picture is black and 65536 indicating that the lightness of the picture is unchanged. If the parameter is not given, the caller is unaware of the proper value or the value fluctuates spatially.

TVideoPictureHeader * iHeader

TVideoPictureHeader *iHeader

Picture header information. Valid if EHeader is set in the options. Normally this field is only used in decoded pictures returned from the playback API. In that case the header info pointer is valid until the picture is returned to the API.

RArray< TUint > * iLayerBitRates

RArray< TUint > *iLayerBitRates

The target number of bits for each bit-rate scalability layer, valid when EBitTargets is set in the options. Used in video encoding when the caller controls the bit-rate for each picture separately. The field points to a table containing the target number of bits to use for each layer when encoding this picture, starting from the lowest layer. The bit count for an enhancement layer includes all lower layers. For example, if the client uses two layers, and reserves 1.5 kilobits for the base layer and three kilobits for the whole picture, this field is set to {1500, 3000}.

TDblQueLink iLink

TDblQueLink iLink

A queue link used internally by the MSL video components.

TUint32 iOptions

TUint32 iOptions

Picture options. The value is a bitfield combined from values from TVideoPictureOptions.

TTimeIntervalMicroSeconds iTimestamp

TTimeIntervalMicroSeconds iTimestamp

Picture timestamp. Valid if ETimestamp is set in the options. Used for presentation timestamps in video playback and capture timestamps in uncompressed video input for recording. If the timestamp is not specified for decoded video input for playback, the picture is displayed immediately. For decoded video output in playback and uncompressed video input for recording, the timestamp must always be set.

TAny * iUser

TAny *iUser

A pointer for free-form user data. The pointer is set by the module that created the buffer, and is usually used for memory management purposes.