The IAAFDigitalImageDescriptor2 interface is implemented by objects which describe video content data formatted either using RGBA or luminance/chrominance formatting. More...

Public Member Functions
HRESULT	SetCompression ([in] aafUID_constref compression)
	/// Sets the kind of compression and format of compression information of the video essence data.
HRESULT	GetCompression ([out] aafUID_t *pCompression)
	/// Gets the kind of compression and format of compression information of the video essence data.
HRESULT	SetStoredView ([in] aafUInt32 StoredHeight,[in] aafUInt32 StoredWidth)
	Sets the dimension of the stored view.
HRESULT	GetStoredView ([out] aafUInt32 pStoredHeight,[out] aafUInt32 pStoredWidth)
	Gets the dimension of the stored view.
HRESULT	SetSampledView ([in] aafUInt32 SampledHeight,[in] aafUInt32 SampledWidth,[in] aafInt32 SampledXOffset,[in] aafInt32 SampledYOffset)
	Sets the dimensions of sampled view.
HRESULT	GetSampledView ([out] aafUInt32 pSampledHeight,[out] aafUInt32 pSampledWidth,[out] aafInt32 pSampledXOffset,[out] aafInt32 pSampledYOffset)
	Gets the dimensions of sampled view.
HRESULT	SetDisplayView ([in] aafUInt32 DisplayHeight,[in] aafUInt32 DisplayWidth,[in] aafInt32 DisplayXOffset,[in] aafInt32 DisplayYOffset)
	Sets the dimension of display view.
HRESULT	GetDisplayView ([out] aafUInt32 pDisplayHeight,[out] aafUInt32 pDisplayWidth,[out] aafInt32 pDisplayXOffset,[out] aafInt32 pDisplayYOffset)
	Gets the dimension of display view.
HRESULT	SetFrameLayout ([in] aafFrameLayout_t FrameLayout)
	Sets the frame layout.
HRESULT	GetFrameLayout ([out] aafFrameLayout_t *pFrameLayout)
	Gets the frame layout.
HRESULT	SetVideoLineMap ([in] aafUInt32 numberElements,[in, size_is(numberElements)] aafInt32 *pVideoLineMap)
	Sets the VideoLineMap property.
HRESULT	GetVideoLineMap ([in] aafUInt32 numberElements,[out, size_is(numberElements)] aafInt32 *pVideoLineMap)
	Gets the VideoLineMap property.
HRESULT	GetVideoLineMapSize ([out] aafUInt32 *pNumberElements)
	Get the number of elements in the VideoLineMap property array.
HRESULT	SetImageAspectRatio ([in] aafRational_t ImageAspectRatio)
	Sets the Image Aspect Ratio property.
HRESULT	GetImageAspectRatio ([out] aafRational_t *pImageAspectRatio)
	Gets the Image Aspect Ratio property.
HRESULT	SetAlphaTransparency ([in] aafAlphaTransparency_t AlphaTransparency)
	Sets the AlphaTransparency property.
HRESULT	GetAlphaTransparency ([out] aafAlphaTransparency_t *pAlphaTransparency)
	Gets the AlphaTransparency property.
HRESULT	SetImageAlignmentFactor ([in] aafUInt32 ImageAlignmentFactor)
	Sets the ImageAlignmentFactor property.
HRESULT	GetImageAlignmentFactor ([out] aafUInt32 *pImageAlignmentFactor)
	Gets the ImageAlignmentFactor property.
HRESULT	SetTransferCharacteristic ([in] aafUID_constref transferCharacteristic)
	Sets the TransferCharacteristic property.
HRESULT	GetTransferCharacteristic ([out] aafUID_t *pTransferCharacteristic)
	Gets the TransferCharacteristic property.
HRESULT	SetCodingEquations ([in] aafUID_constref codingEquations)
	Sets the CodingEquations property.
HRESULT	GetCodingEquations ([out] aafUID_t *pCodingEquations)
	Gets the CodingEquations property.
HRESULT	SetColorPrimaries ([in] aafUID_constref colorPrimaries)
	Sets the ColorPrimaries property.
HRESULT	GetColorPrimaries ([out] aafUID_t *pColorPrimaries)
	Gets the ColorPrimaries property.
HRESULT	SetFieldStartOffset ([in] aafUInt32 fieldStartOffset)
	Sets the FieldStartOffset property.
HRESULT	GetFieldStartOffset ([out] aafUInt32 *pFieldStartOffset)
	Gets the FieldStartOffset property.
HRESULT	SetFieldEndOffset ([in] aafUInt32 fieldEndOffset)
	Sets the FieldEndOffset property.
HRESULT	GetFieldEndOffset ([out] aafUInt32 *pFieldEndOffset)
	Gets the FieldEndOffset property.
HRESULT	SetFieldDominance ([in] aafFieldNumber_t fieldDominance)
	Sets the FieldDominance property.
HRESULT	GetFieldDominance ([out] aafFieldNumber_t *pFieldDominance)
	Gets the FieldDominance property.
HRESULT	SetDisplayF2Offset ([in] aafInt32 displayF2Offset)
	Sets the DisplayF2Offset property.
HRESULT	GetDisplayF2Offset ([out] aafInt32 *pDisplayF2Offset)
	Gets the DisplayF2Offset property.
HRESULT	SetStoredF2Offset ([in] aafInt32 storedF2Offset)
	Sets the StoredF2Offset property.
HRESULT	GetStoredF2Offset ([out] aafInt32 *pStoredF2Offset)
	Gets the StoredF2Offset property.
HRESULT	SetActiveFormatDescriptor ([in] aafUInt8 activeFormatDescriptor)
	Sets the ActiveFormatDescriptor property.
HRESULT	GetActiveFormatDescriptor ([out] aafUInt8 *pActiveFormatDescriptor)
	Gets the ActiveFormatDescriptor property.
HRESULT	SetSignalStandard ([in] aafSignalStandard_t signalStandard)
	Sets the SignalStandard property.
HRESULT	GetSignalStandard ([out] aafSignalStandard_t *pSignalStandard)
	Gets the SignalStandard property.

Detailed Description

The IAAFDigitalImageDescriptor2 interface is implemented by objects which describe video content data formatted either using RGBA or luminance/chrominance formatting.

The geometry properties accessed by Set/GetStoredView(), Set/GetSampledView(), and Set/GetDisplayView() describe the dimensions and meaning of the stored pixels in the image. The geometry describes the pixels of an uncompressed image. Consequently, the geometry properties are independent of the compression and subsampling.

Three separate geometries - stored, sampled, and display views - are used to define a set of different views on uncompressed digital data. All views are constrained to rectangular regions, which means that storage and sampling has to be rectangular.

The relationships among the views can be shown by the following rectangles, representing areas of a video image:

+------------------+ | | | Stored View | | | +--------------+ +------------------+ <-------- | | | | Sample | Analog Video | | Sampled View | Process | Source | | | | Information | | +--------------+ | | | | | | | | | | | Display View | | | | | | | | | | | +--------------+ | | | | | | | +------------------+ <-------- | | +--------------+

The stored view is the entire data region corresponding to a single uncompressed frame or field of the image, and is defined by its horizontal and vertical dimension properties. The stored view may include data that is not derived from, and would not usually be translated back to, analog data.

The sampled view is defined to be the rectangular dimensions in pixels corresponding to the digital data derived from an analog or digital source. These pixels reside within the rectangle defined by the stored view. This would include the image and auxiliary information included in the analog or digital source. For the capture of video signals, the mapping of these views to the original signal is determined by the VideoLineMap property.

The display view is the rectangular size in pixels corresponding to the viewable area. These pixels contain image data suitable for scaling, display, warping, and other image processing. The display view offsets are relative to the stored view, not to the sampled view.

Although typically the display view is a subset of the sampled view, it is possible that the viewable area may not be a subset of the sampled data. It may overlap or even encapsulate the sampled data. For example, a subset of the input image might be centered in a computer-generated blue screen for use in a chroma key effect. In this case the viewable pixels on disk would contain more than the sampled image.

Each of these data views will have a width and height value. Both the sampled view and the display view also have offsets relative to the top left corner of the stored view.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

insufficient system memory is available to perform the operation.

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFDigitalImageDescriptor2 is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface.

Objects that implement IAAFDigitalImageDescriptor2 also implement the following interfaces:

Definition at line 43178 of file AAF.idl.

Member Function Documentation

HRESULT IAAFDigitalImageDescriptor2::GetActiveFormatDescriptor ( [out] aafUInt8 * pActiveFormatDescriptor )

Gets the ActiveFormatDescriptor property.

Succeeds if all of the following are true:

pActiveFormatDescriptor is a valid pointer

If this method fails, pActiveFormatDescriptor will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pActiveFormatDescriptor is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pActiveFormatDescriptor [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetAlphaTransparency ( [out] aafAlphaTransparency_t * pAlphaTransparency )

Gets the AlphaTransparency property.

This property is optional.

Valid values: kMaxValueTransparent - means the maximum Alpha value is transparent kMinValueTransparent - means the minimum Alpha value is transparent

Succeeds if all of the following are true:

pAlphaTransparency is a valid pointer

If this method fails, pAlphaTransparency not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pAlphaTransparency is NULL.

Parameters:

pAlphaTransparency [out] Alpha Transparency value.

HRESULT IAAFDigitalImageDescriptor2::GetCodingEquations ( [out] aafUID_t * pCodingEquations )

Gets the CodingEquations property.

Succeeds if all of the following are true:

pCodingEquations is a valid pointer

If this method fails, pCodingEquations will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pCodingEquations is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pCodingEquations [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetColorPrimaries ( [out] aafUID_t * pColorPrimaries )

Gets the ColorPrimaries property.

Succeeds if all of the following are true:

pColorPrimaries is a valid pointer

If this method fails, pColorPrimaries will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pColorPrimaries is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pColorPrimaries [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetCompression ( [out] aafUID_t * pCompression )

/// Gets the kind of compression and format of compression information of the video essence data.

This property is optional.

Succeeds if all of the following are true:

the pCompression pointer is valid.

If this method fails nothing will be written to *pCompression.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pComporession arg is NULL.

Parameters:

pCompression [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetDisplayF2Offset ( [out] aafInt32 * pDisplayF2Offset )

Gets the DisplayF2Offset property.

Succeeds if all of the following are true:

pDisplayF2Offset is a valid pointer

If this method fails, pDisplayF2Offset will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pDisplayF2Offset is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pDisplayF2Offset [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetDisplayView	(	[out] aafUInt32 *	pDisplayHeight,
		[out] aafUInt32 *	pDisplayWidth,
		[out] aafInt32 *	pDisplayXOffset,
		[out] aafInt32 *	pDisplayYOffset
	)

Gets the dimension of display view.

Typically this includes the active picture area, but excludes leading blank video lines and any VITC lines. The offset is specified relative to the rectangle specified by Set/GetStoredView().

Note that The specified display rectangle may exist outside the SampledView or even the StoredView.

Succeeds if all of the following are true:

pDisplayHeight, pDisplayWidth, pDisplayXOffset and pDisplayYOffset are valid pointers.

If this method fails, *pDisplayHeight, *pDisplayWidth, pDisplayXOffset, and *pDisplayYOffset will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

any of pDisplayHeight, pDisplayWidth, pDisplayXOffset, or pDisplayYOffset are NULL.

Parameters:

pDisplayHeight	[out] Number of pixels in vertical dimension of display view. Optional.
pDisplayWidth	[out] Number of pixels in horizontal dimension of display view. Optional.
pDisplayXOffset	[out] Number of pixels from the top-left corner of the display view. Optional.
pDisplayYOffset	[out] Number pixels from the top-left corner of the display view. Optional.

HRESULT IAAFDigitalImageDescriptor2::GetFieldDominance ( [out] aafFieldNumber_t * pFieldDominance )

Gets the FieldDominance property.

Succeeds if all of the following are true:

pFieldDominance is a valid pointer

If this method fails, pFieldDominance will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFieldDominance is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pFieldDominance [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetFieldEndOffset ( [out] aafUInt32 * pFieldEndOffset )

Gets the FieldEndOffset property.

Succeeds if all of the following are true:

pFieldEndOffset is a valid pointer

If this method fails, pFieldEndOffset will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFieldEndOffset is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pFieldEndOffset [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetFieldStartOffset ( [out] aafUInt32 * pFieldStartOffset )

Gets the FieldStartOffset property.

Succeeds if all of the following are true:

pFieldStartOffset is a valid pointer

If this method fails, pFieldStartOffset will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFieldStartOffset is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pFieldStartOffset [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetFrameLayout ( [out] aafFrameLayout_t * pFrameLayout )

Gets the frame layout.

The frame layout describes whether all data for a complete sample is in one frame or is split into more than one field.

Values are:

kNoLayout - Default; not a valid value. kFullFrame - Each frame contains a full sample in progressive scan lines. kSeparateFields - Each sample consists of two fields, which when interlaced produce a full sample. kOneField - Each sample consists of two interlaced fields, but only one field is stored in the data stream. kMixedFields - Similar to FullFrame, except the two fields may have been sampled at different times.

Succeeds if all of the following are true:

pFrameLayout is a valid pointer

If this method fails, *pFrameLayout will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFrameLayout is NULL.

Parameters:

pFrameLayout [out] layout of the frame

HRESULT IAAFDigitalImageDescriptor2::GetImageAlignmentFactor ( [out] aafUInt32 * pImageAlignmentFactor )

Gets the ImageAlignmentFactor property.

Specifies the alignment when storing the digital essence. For example, a value of 16 means that the image is stored on 16-byte boundaries. The starting point for a field will always be a multiple of 16 bytes. If the field does not end on a 16-byte boundary, it is padded out to the next 16-byte boundary.

Succeeds if all of the following are true:

pImageAlignmentFactor is a valid pointer

If this method fails, pImageAlignmentFactor will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pImageAlignmentFactor is NULL.

Parameters:

pImageAlignmentFactor [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetImageAspectRatio ( [out] aafRational_t * pImageAspectRatio )

Gets the Image Aspect Ratio property.

This ratio describes the ratio between the horizontal size and the vertical size in the intended final image.

Succeeds if all of the following are true:

pImageAspectRatio is a valid pointer

If this method fails, *pImageAspectRatio will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pImageAspectRatio is NULL.

Parameters:

pImageAspectRatio [out] Ratio between horizontal and vertical size

HRESULT IAAFDigitalImageDescriptor2::GetSampledView	(	[out] aafUInt32 *	pSampledHeight,
		[out] aafUInt32 *	pSampledWidth,
		[out] aafInt32 *	pSampledXOffset,
		[out] aafInt32 *	pSampledYOffset
	)

Gets the dimensions of sampled view.

Typically this includes any VITC lines as well as the active picture area, but excludes leading blank video lines. The offset is specified relative to the rectangle specified by Set/GetStoredView().

Succeeds if all of the following are true:

pSampledHeight, pSampledWidth, pSampledXOffset and pSampledYOffset are valid pointers

If any of the input parameters are NULL, the property will not be returned.

If this method fails, *pSampledHeight, *pSampledWidth, pSampledXOffset, and *pSampledYOffset will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

any of pSampledHeight, pSampledWidth, pSampledXOffset, or pSampledYOffset are NULL.

Parameters:

pSampledHeight	[out] Number of pixels in vertical dimension of sampled view.
pSampledWidth	[out] Number of pixels in horizontal dimension of sampled view.
pSampledXOffset	[out] Number of pixels from top left corner of sampled view. Optional.
pSampledYOffset	[out] Number of pixels from top left corner of sampled view. Optional.

HRESULT IAAFDigitalImageDescriptor2::GetSignalStandard ( [out] aafSignalStandard_t * pSignalStandard )

Gets the SignalStandard property.

This property is optional.

Succeeds if all of the following are true:

pSignalStandard is a valid pointer

If this method fails, pSignalStandard not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pSignalStandard is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pSignalStandard [out] Signal standard value.

HRESULT IAAFDigitalImageDescriptor2::GetStoredF2Offset ( [out] aafInt32 * pStoredF2Offset )

Gets the StoredF2Offset property.

Succeeds if all of the following are true:

pStoredF2Offset is a valid pointer

If this method fails, pStoredF2Offset will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pStoredF2Offset is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pStoredF2Offset [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetStoredView	(	[out] aafUInt32 *	pStoredHeight,
		[out] aafUInt32 *	pStoredWidth
	)

Gets the dimension of the stored view.

Typically this includes leading blank video lines, any VITC lines, as well as the active picture area.

Succeeds if all of the following are true:

pStoredHieght and pStoredWidth are valid pointers.

If this method fails, the *pStoredHieght and *pStoredWidth will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

either pStoredHeight or pStoredWidth is NULL.

Parameters:

pStoredHeight	[out] Number of pixels in vertical dimension of stored view.
pStoredWidth	[out] Number of pixels in horizontal dimension of stored view.

HRESULT IAAFDigitalImageDescriptor2::GetTransferCharacteristic ( [out] aafUID_t * pTransferCharacteristic )

Gets the TransferCharacteristic property.

Succeeds if all of the following are true:

pTransferCharacteristic is a valid pointer

If this method fails, pTransferCharacteristic will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pTransferCharacteristic is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pTransferCharacteristic [out] Optional.

HRESULT IAAFDigitalImageDescriptor2::GetVideoLineMap	(	[in] aafUInt32	numberElements,
		[out, size_is(numberElements)] aafInt32 *	pVideoLineMap
	)

Gets the VideoLineMap property.

The video line map specifies the scan line in the analog source that corresponds to the beginning of each digitized field. For single-field video, there is 1 value in the array. For interleaved video, there are 2 values in the array.

The values are written to the array specified by pVideoLineMap, which is of size numberElements. The required size may be found by calling GetVideoLineMapSize().

Succeeds if all of the following are true:

pVideoLineMap is a valid pointer.
numberElements indicates the array is large enough to hold the data.

If this method fails, videoLineMap will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pNumberElements is NULL.

AAFRESULT_SMALLBUF

numberElements indicates that the array is too small to hold the data.

Parameters:

numberElements	[in] The number of elements in the array
pVideoLineMap	[out, size_is(numberElements)] Array to hold the Video Line Map information

HRESULT IAAFDigitalImageDescriptor2::GetVideoLineMapSize ( [out] aafUInt32 * pNumberElements )

Get the number of elements in the VideoLineMap property array.

Succeeds if all of the following are true:

pNumberElements is a valid pointer

If this method fails, *pNumberElements will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pNumberElements is NULL.

Parameters:

pNumberElements [out] The number of elements in the array

HRESULT IAAFDigitalImageDescriptor2::SetActiveFormatDescriptor ( [in] aafUInt8 activeFormatDescriptor )

Sets the ActiveFormatDescriptor property.

Succeeds if all of the following are true:

If this method fails, the ActiveFormatDescriptor property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

activeFormatDescriptor [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetAlphaTransparency ( [in] aafAlphaTransparency_t AlphaTransparency )

Sets the AlphaTransparency property.

This property is optional.

Valid values: kMaxValueTransparent - means the maximum Alpha value is transparent kMinValueTransparent - means the minimum Alpha value is transparent

Succeeds if all of the following are true:

AlphaTransparency is a valid value.

If this method fails, the AlphaTransparency property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

AlphaTransparency is not a valid value.

Parameters:

AlphaTransparency [in] Alpha Transparency value.

HRESULT IAAFDigitalImageDescriptor2::SetCodingEquations ( [in] aafUID_constref codingEquations )

Sets the CodingEquations property.

Succeeds if all of the following are true:

If this method fails, the CodingEquations property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

codingEquations [in] Optional

HRESULT IAAFDigitalImageDescriptor2::SetColorPrimaries ( [in] aafUID_constref colorPrimaries )

Sets the ColorPrimaries property.

Succeeds if all of the following are true:

If this method fails, the ColorPrimaries property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

colorPrimaries [in] Optional

HRESULT IAAFDigitalImageDescriptor2::SetCompression ( [in] aafUID_constref compression )

/// Sets the kind of compression and format of compression information of the video essence data.

This property is optional. If there is no compression, the property is omitted.

If this method fails the Data Definition property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

compression [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetDisplayF2Offset ( [in] aafInt32 displayF2Offset )

Sets the DisplayF2Offset property.

Succeeds if all of the following are true:

If this method fails, the DisplayF2Offset property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

displayF2Offset is not a valid value.

Parameters:

displayF2Offset [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetDisplayView	(	[in] aafUInt32	DisplayHeight,
		[in] aafUInt32	DisplayWidth,
		[in] aafInt32	DisplayXOffset,
		[in] aafInt32	DisplayYOffset
	)

Sets the dimension of display view.

Typically this includes the active picture area, but excludes leading blank video lines and any VITC lines. The offset is specified relative to the rectangle specified by Set/GetStoredView().

The following properties are optional:

DisplayHeight - The default value is the storedHeight. Use storedHeight to select the default. DisplayWidth - The default value is the storedWidth. Use storedWidth to select the default. DisplayXOffset - The default value is 0. Use a value of 0 to select the default. DisplayYOffset - The default value is 0. Use a value of 0 to select the default.

Note that The specified display rectangle may exist outside the SampledView or even the StoredView.

If this method fails the DisplayHeight, DisplayWidth, DisplayXOffset and DisplayYOffset properties will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

The area specified by DisplayHeight and DisplayXOffset is outside the StoredView, or the area specified by DisplayWidth and DisplayYOffset is outside the StoredView.

Parameters:

DisplayHeight	[in] Number of pixels in vertical dimension of display view. Optional.
DisplayWidth	[in] Number of pixels in horizontal dimension of display view. Optional.
DisplayXOffset	[in] Number of pixels from the top-left corner of the display view. Optional.
DisplayYOffset	[in] Number pixels from the top-left corner of the display view. Optional.

HRESULT IAAFDigitalImageDescriptor2::SetFieldDominance ( [in] aafFieldNumber_t fieldDominance )

Sets the FieldDominance property.

Succeeds if all of the following are true:

If this method fails, the FieldDominance property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

FieldDominance is not a valid value.

Parameters:

fieldDominance [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetFieldEndOffset ( [in] aafUInt32 fieldEndOffset )

Sets the FieldEndOffset property.

Succeeds if all of the following are true:

If this method fails, the FieldEndOffset property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

fieldEndOffset [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetFieldStartOffset ( [in] aafUInt32 fieldStartOffset )

Sets the FieldStartOffset property.

Succeeds if all of the following are true:

If this method fails, the FieldStartOffset property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

fieldStartOffset [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetFrameLayout ( [in] aafFrameLayout_t FrameLayout )

Sets the frame layout.

The frame layout describes whether all data for a complete sample is in one frame or is split into more than/ one field.

Values are:

kNoLayout - Default; not a valid value. kFullFrame - Each frame contains a full sample in progressive scan lines. kSeparateFields - Each sample consists of two fields, which when interlaced produce a full sample. kOneField - Each sample consists of two interlaced fields, but only one field is stored in the data stream. kMixedFields - Similar to FullFrame, except the two fields may have been sampled at different times.

Succeeds if all of the following are true:

frameLayout is a valid value

If this method fails, the Frame Layout property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

FrameLayout is not a valid value.

Parameters:

FrameLayout [in] layout of the frame

HRESULT IAAFDigitalImageDescriptor2::SetImageAlignmentFactor ( [in] aafUInt32 ImageAlignmentFactor )

Sets the ImageAlignmentFactor property.

Specifies the alignment when storing the digital essence. For example, a value of 16 means that the image is stored on 16-byte boundaries. The starting point for a field will always be a multiple of 16 bytes. If the field does not end on a 16-byte boundary, it is padded out to the next 16-byte boundary.

Succeeds if all of the following are true:

If this method fails, the ImageAlignmentFactor property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

ImageAlignmentFactor [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetImageAspectRatio ( [in] aafRational_t ImageAspectRatio )

Sets the Image Aspect Ratio property.

This ratio describes the ratio between the horizontal size and the vertical size in the intended final image.

Succeeds if all of the following are true:

If this method fails, the Image Access Ratio property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

ImageAspectRatio [in] Ratio between horizontal and vertical size

HRESULT IAAFDigitalImageDescriptor2::SetSampledView	(	[in] aafUInt32	SampledHeight,
		[in] aafUInt32	SampledWidth,
		[in] aafInt32	SampledXOffset,
		[in] aafInt32	SampledYOffset
	)

Sets the dimensions of sampled view.

Typically this includes any VITC lines as well as the active picture area, but excludes leading blank video lines. The offset is specified relative to the rectangle specified by Set/GetStoredView().

The following properties are optional:

SampledXOffset - The default value is 0. Use a value of 0 to select the default. SampledYOffset - The default value is 0. Use a value of 0 to select the default.

Succeeds if all of the following are true:

The given dimensions exist within the StoredView.

If this method fails, the SampledXOffset and SampledYOffset properties will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

The area specified by SampledHeight and SampledXOffset is outside the StoredView, or the area specified by SampledWidth and SampledYOffset is outside the StoredView.

Parameters:

SampledHeight	[in] Number of pixels in vertical dimension of sampled view.
SampledWidth	[in] Number of pixels in horizontal dimension of sampled view.
SampledXOffset	[in] Number of pixels from top left corner of sampled view. Optional.
SampledYOffset	[in] Number of pixels from top left corner of sampled view. Optional.

HRESULT IAAFDigitalImageDescriptor2::SetSignalStandard ( [in] aafSignalStandard_t signalStandard )

Sets the SignalStandard property.

This property is optional.

Succeeds if all of the following are true:

If this method fails, the SignalStandard property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_AAFRESULT_INVALID_ENUM_VALUE

signalStandard is not a valid value.

Parameters:

signalStandard [in] Signal standard value.

HRESULT IAAFDigitalImageDescriptor2::SetStoredF2Offset ( [in] aafInt32 storedF2Offset )

Sets the StoredF2Offset property.

Succeeds if all of the following are true:

If this method fails, the StoredF2Offset property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_ILLEGAL_VALUE

storedF2Offset is not a valid value.

Parameters:

storedF2Offset [in] Optional.

HRESULT IAAFDigitalImageDescriptor2::SetStoredView	(	[in] aafUInt32	StoredHeight,
		[in] aafUInt32	StoredWidth
	)

Sets the dimension of the stored view.

Typically this includes leading blank video lines, any VITC lines, as well as the active picture area.

If this method fails the Stored Height and Stored Width properties will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

StoredHeight	[in] Number of pixels in vertical dimension of stored view.
StoredWidth	[in] Number of pixels in horizontal dimension of stored view.

HRESULT IAAFDigitalImageDescriptor2::SetTransferCharacteristic ( [in] aafUID_constref transferCharacteristic )

Sets the TransferCharacteristic property.

Succeeds if all of the following are true:

If this method fails, the TransferCharacteristic property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

transferCharacteristic [in] Optional

HRESULT IAAFDigitalImageDescriptor2::SetVideoLineMap	(	[in] aafUInt32	numberElements,
		[in, size_is(numberElements)] aafInt32 *	pVideoLineMap
	)

Sets the VideoLineMap property.

The video line map specifies the scan line in the analog source that corresponds to the beginning of each digitized field. For single-field video, there is 1 value in the array. For interleaved video, there are 2 values in the array.

Succeeds if all of the following are true:

pVideoLineMap is a valid pointer

If this method fails, the Video Line Map property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pVideoLineMap is NULL.

Parameters:

numberElements	[in] The number of elements in the array
pVideoLineMap	[in, size_is(numberElements)] Array to hold the Video Line Map information

Public Member Functions

Detailed Description

Member Function Documentation