Class TVideoPicture

class TVideoPicture;

Description

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

Members

Defined in TVideoPicture:

• EBitTargetsThe layer bit count targets field is valid.
• ECropRectThe crop rectangle field is valid.
• EEffectParametersSet if picture effect parameters are valid.
• EHeaderPicture header information is present.
• EPictureEffectSet if a picture effect is in use and the picture effect field is valid.
• EReqInstantRefreshSet in encoder input to request an instantaneous decoder refresh. As a response,...
• ESceneCutSet in encoder input to indicate a scene cut in the picture stream.
• ETimestampThe timestamp field is valid.
• TVideoPictureOptions
• iCropRectPan-scan cropping rectangle. Defines the area of the picture used for further pr...
• iDataThe picture data. The picture data, including all pointers, must remain valid un...
• iEffectThe picture effect in use when capturing this picture, valid when EPictureEffect...
• iFadeParamPicture effect parameter for fade to/from black, valid when EEffectParameters is...
• iHeaderPicture header information. Valid if EHeader is set in the options. Normally thi...
• iLayerBitRatesThe target number of bits for each bit-rate scalability layer, valid when EBitTa...
• iLinkA queue link used internally by the MSL video components.
• iOptionsPicture options. The value is a bitfield combined from values from TVideoPicture...
• iTimestampPicture timestamp. Valid if ETimestamp is set in the options. Used for presentat...
• iUserA pointer for free-form user data. The pointer is set by the module that created...

TVideoPictureOptions

Description

TPictureData iData;

Description

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

TUint32 iOptions;

Description

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

TTimeIntervalMicroSeconds iTimestamp;

Description

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.

TRect iCropRect;

Description

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

TVideoPictureHeader * iHeader;

Description

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;

Description

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}.

TPictureEffect iEffect;

Description

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.

TUint iFadeParam;

Description

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.

TAny * iUser;

Description

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.

TDblQueLink iLink;

Description

A queue link used internally by the MSL video components.