|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CDCIDescriptor
Specifies the description of a file of video essence formatted with one luminance component and two color-difference components, as specified according to the AAF object specification v1.1. This format is also known as "YCbCr".
Note that the default values for the optional white reference level and color range properties depend on the required component width property. Therefore, the default values of these properties should be computed at runtime.
makeCDCIDescriptor()
,
CodecConstant.CDCI
Field Summary | |
---|---|
static int |
ALPHASAMPLINGWIDTH_DEFAULT
Default value for the alpha sampling width property, which is 0. |
static int |
BLACKREFERENCELEVEL_DEFAULT
Default value for the black reference level property which is 0. |
static ColorSitingType |
COLORSITING_DEFAULT
Default value for the color siting property, which is ColorSitingType.CoSiting . |
static short |
PADDINGBITS_DEFAULT
Default value for the padding bits property, which is 0. |
static boolean |
REVERSEDBYTEORDER_DEFAULT
Default value for the reversed byte order property, which is false . |
static int |
VERTICALSUBSAMPLING_DEFAULT
Default value for the vertical subsampling property, which is 1. |
Fields inherited from interface tv.amwa.maj.iface.DigitalImageDescriptor |
---|
ALPHATRANSPARENCY_DEFAULT, DISPLAYF2OFFSET_DEFAULT, FIELDENDOFFSET_DEFAULT, FIELDSTARTOFFSET_DEFAULT, IMAGEALIGNMENTFACTOR_DEFAULT, STOREDF2OFFSET_DEFAULT, Uncompressed |
Method Summary | |
---|---|
int |
getAlphaSamplingWidth()
Returns the alpha sampling width property of the CDCI descriptor, which specifies the number of bits used to store the alpha component. |
int |
getBlackReferenceLevel()
Returns the black reference level property for this CDCI descriptor, which specifies the digital luminance component value associated with black. |
int |
getColorRange()
Returns the color range property for this CDCI descriptor, which specifies the range of allowable digital chrominance component values. |
ColorSitingType |
getColorSiting()
Returns the color siting property of the CDCI descriptor, which specifies how to compute subsampled chrominance values. |
int |
getComponentWidth()
Returns the component width property of this CDCI descriptor, which specifies the number of bits used to store each component. |
int |
getHorizontalSubsampling()
Returns the horizontal subsampling property for this CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the horizontal direction. |
short |
getPaddingBits()
Returns the padding bits property of the CDCI descriptor, which specifies the number of bits padded to each pixel. |
boolean |
getReversedByteOrder()
Sets the reversed byte order property of the CDCI descriptor, which specifies whether the luma and chroma sample order is reversed relative to the order defined by ITU-R BT.601. |
int |
getVerticalSubsampling()
Returns the vertical subsampling property of the CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the vertical direction. |
int |
getWhiteReferenceLevel()
Sets the white reference level property of this CDCI descriptor, which specifies the digital luminance component component value associated with white. |
void |
setAlphaSamplingWidth(Integer alphaSamplingWidth)
Sets the alpha sampling width property of the CDCI descriptor, which specifies the number of bits used to store the alpha component. |
void |
setBlackReferenceLevel(Integer blackReferenceLevel)
Sets the black reference level property for this CDCI descriptor, which specifies the digital luminance component value associated with black. |
void |
setColorRange(Integer colorRange)
Sets the color range property for this CDCI descriptor, which specifies the range of allowable digital chrominance component values. |
void |
setColorSiting(ColorSitingType colorSiting)
Sets the color siting property of the CDCI descriptor, which specifies how to compute subsampled chrominance values. |
void |
setComponentWidth(int componentWidth)
Sets the component width property of this CDCI descriptor, which specifies the number of bits used to store each component. |
void |
setHorizontalSubsampling(int horizontalSubsampling)
Sets the horizontal subsampling property for this CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the horizontal direction. |
void |
setPaddingBits(Short paddingBits)
Sets the padding bits property of this CDCI descriptor, which specifies the number of bits padded to each pixel. |
void |
setReversedByteOrder(Boolean reversedByteOrder)
Sets the reversed byte order property of the CDCI descriptor, which specifies whether the luma and chroma sample order is reversed relative to the order defined by ITU-R BT.601. |
void |
setVerticalSubsampling(Integer verticalSubsampling)
Sets the vertical subsampling property of the CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the vertical direction. |
void |
setWhiteReferenceLevel(Integer whiteReferenceLevel)
Sets the white reference level property of this CDCI descriptor, which specifies the digital luminance component component value associated with white. |
Methods inherited from interface tv.amwa.maj.iface.AAFFileDescriptor |
---|
getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setLength, setLinkedSlotID, setSampleRate |
Methods inherited from interface tv.amwa.maj.iface.EssenceDescriptor |
---|
appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt |
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject |
---|
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue |
Field Detail |
---|
static final int VERTICALSUBSAMPLING_DEFAULT
Default value for the vertical subsampling property, which is 1.
getVerticalSubsampling()
,
setVerticalSubsampling(Integer)
,
Constant Field Valuesstatic final int ALPHASAMPLINGWIDTH_DEFAULT
Default value for the alpha sampling width property, which is 0.
getAlphaSamplingWidth()
,
setAlphaSamplingWidth(Integer)
,
Constant Field Valuesstatic final short PADDINGBITS_DEFAULT
Default value for the padding bits property, which is 0.
getPaddingBits()
,
setPaddingBits(Short)
,
Constant Field Valuesstatic final ColorSitingType COLORSITING_DEFAULT
Default value for the color siting property, which is
ColorSitingType.CoSiting
.
getColorSiting()
,
setColorSiting(ColorSitingType)
static final int BLACKREFERENCELEVEL_DEFAULT
Default value for the black reference level property which is 0.
getBlackReferenceLevel()
,
setBlackReferenceLevel(Integer)
,
Constant Field Valuesstatic final boolean REVERSEDBYTEORDER_DEFAULT
Default value for the reversed byte order property, which
is false
.
getReversedByteOrder()
,
setReversedByteOrder(Boolean)
,
Constant Field ValuesMethod Detail |
---|
void setComponentWidth(@UInt32 int componentWidth) throws IllegalArgumentException
Sets the component width property of this CDCI descriptor, which specifies the number of bits used to store each component. Typical values can be 8, 10, 12, 14, or 16, but others are permitted by the MAJ API implementation. Each component in a sample is packed contiguously; the sample is filled with the number of bits specified by the optional padding bits property. If the padding bits property is omitted, samples are packed contiguously.
componentWidth
- Component width for the CDCI descriptor.
IllegalArgumentException
- The given component width is negative.getPaddingBits()
@UInt32 int getComponentWidth()
Returns the component width property of this CDCI descriptor, which specifies the number of bits used to store each component. Typical values can be 8, 10, 12, 14, or 16, but others are permitted by the MAJ API implementation. Each component in a sample is packed contiguously; the sample is filled with the number of bits specified by the optional padding bits property. If the padding bits property is omitted, samples are packed contiguously.
getPaddingBits()
void setHorizontalSubsampling(@UInt32 int horizontalSubsampling)
Sets the horizontal subsampling property for this CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the horizontal direction.
For 4:2:2 video, the value is 2, which means that there are twice as many luminance values as there are color-difference values. Another typical value is 1; however other values are permitted by the MAJ API implementation.
horizontalSubsampling
- Horizontal subsampling of the CDCI descriptor.@UInt32 int getHorizontalSubsampling()
Returns the horizontal subsampling property for this CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the horizontal direction.
For 4:2:2 video, the value is 2, which means that there are twice as many luminance values as there are color-difference values. Another typical value is 1; however other values are permitted by the MAJ API implementation.
void setVerticalSubsampling(@UInt32 Integer verticalSubsampling) throws IllegalArgumentException
Sets the vertical subsampling property of the CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the vertical direction.
For 4:2:2 video, the value is 2, which means that there are twice as many luminance values as there are color-difference values. Another typical value is 1; however other values are permitted by the MAJ API implementation.
To omit this optional property, call ths method with null
.
verticalSubsampling
- Vertical subsampling of the CDCI descriptor.
IllegalArgumentException
- The given vertical subsampling property is negative.VERTICALSUBSAMPLING_DEFAULT
@UInt32 int getVerticalSubsampling()
Returns the vertical subsampling property of the CDCI descriptor, which specifies the ratio of luminance sampling to chrominance sampling in the vertical direction.
For 4:2:2 video, the value is 2, which means that there are twice as many luminance values as there are color-difference values. Another typical value is 1; however other values are permitted by the MAJ API implementation.
The default value of this optional property will be returned if it is not present.
VERTICALSUBSAMPLING_DEFAULT
void setColorSiting(ColorSitingType colorSiting)
Sets the color siting property of the CDCI descriptor, which specifies how to compute subsampled chrominance values.
Valid values are:
ColorSitingType.CoSiting
- To calculate subsampled pixels, take the
preceding's pixels color value, discard the other color values and cosite the
color with the first luminance value.ColorSitingType.Averaging
- To calculate subsampled pixels, take the
average of the two adjacent pixels' color values and site the color in the
center of the luminance pixels.ColorSitingType.ThreeTap
- To calculate subsampled pixels, take
25 percent of the the previous pixel's color value, 50 percent of the first
value and 25 percent of the second value. For the first value in a row, use
75 percent of that value since there is no previous value. The
ThreeTap
value is only meaningful when the horizontal subsampling
property has a value of 2.The color siting property is optional and has a default value of
ColorSitingType.CoSiting
. Calling this method with null
to
omit this property.
colorSiting
- Color siting for the CDCI descriptor.COLORSITING_DEFAULT
ColorSitingType getColorSiting()
Returns the color siting property of the CDCI descriptor, which specifies how to compute subsampled chrominance values.
Valid values are:
ColorSitingType.CoSiting
- To calculate subsampled pixels, take the
preceding's pixels color value, discard the other color values and cosite the
color with the first luminance value.ColorSitingType.Averaging
- To calculate subsampled pixels, take the
average of the two adjacent pixels' color values and site the color in the
center of the luminance pixels.ColorSitingType.ThreeTap
- To calculate subsampled pixels, take
25 percent of the the previous pixel's color value, 50 percent of the first
value and 25 percent of the second value. For the first value in a row, use
75 percent of that value since there is no previous value. The
ThreeTap
value is only meaningful when the horizontal subsampling
property has a value of 2.The color siting property is optional and has a default value of
ColorSitingType.CoSiting
. The default value will be returned if the
property is not present.
COLORSITING_DEFAULT
void setBlackReferenceLevel(@UInt32 Integer blackReferenceLevel) throws IllegalArgumentException
Sets the black reference level property for this CDCI descriptor, which specifies the digital luminance component value associated with black.
For CCIR-601/2, the value is 16 for 8-bit video and 64 for 10-bit video. For YUV, the value is 0. These are typical values; other values will not be disallowed by the MAJ API implementation.
The same value is used in CDCI and RGBA when standard colorspace conversion is used.
This property is optional and has a default value of 0.
To omit the property, call this method with null
.
blackReferenceLevel
- Black reference level of the CDCI descriptor.
IllegalArgumentException
- The given black reference level is negative.BLACKREFERENCELEVEL_DEFAULT
@UInt32 int getBlackReferenceLevel()
Returns the black reference level property for this CDCI descriptor, which specifies the digital luminance component value associated with black.
For CCIR-601/2, the value is 16 for 8-bit video and 64 for 10-bit video. For YUV, the value is 0. These are typical values; other values will not be disallowed by the MAJ API implementation.
The same value is used in CDCI and RGBA when standard colorspace conversion is used.
If the property is omitted, its default value will be returned.
BLACKREFERENCELEVEL_DEFAULT
void setWhiteReferenceLevel(@UInt32 Integer whiteReferenceLevel) throws IllegalArgumentException
Sets the white reference level property of this CDCI descriptor, which specifies the digital luminance component component value associated with white.
For CCIR-601/2, the value is 235 for 8-bit video and 940 for 10-bit video. For YUV, the value is 255 for 8-bit video and 1023 for 10-bit video. These are typical values; other values will not be disallowed by the MAJ API implementation.
This property is optional. The default value is the maximum
unsigned integer value for the component size. To omit this optional property,
call this method with null
.
whiteReferenceLevel
- White reference level for the CDCI descriptor.
IllegalArgumentException
- Cannot set the white reference level of
this CDCI descriptor to a negative value.getComponentWidth()
@UInt32 int getWhiteReferenceLevel()
Sets the white reference level property of this CDCI descriptor, which specifies the digital luminance component component value associated with white.
For CCIR-601/2, the value is 235 for 8-bit video and 940 for 10-bit video. For YUV, the value is 255 for 8-bit video and 1023 for 10-bit video. These are typical values; other values will not be disallowed by the MAJ API implementation.
If the property is not present, its default value will be returned. The default value is the maximum unsigned integer value for the component size.
getComponentWidth()
void setColorRange(@UInt32 Integer colorRange)
Sets the color range property for this CDCI descriptor, which specifies the range of allowable digital chrominance component values. Chrominance values are unsigned and the range is centered on 128 for 8-bit video and 512 for 10-bit video. This value is used for both chrominance components.
For CCIR-601/2, the range is 225 for 8-bit video and 897 for 10-bit video. For YUV, the range is 255 for 8-bit video and 1023 for 10-bit video. hese are typical values; other values will not be disallowed by the MAJ API implementation.
This property is optional. The default value is the maximum
unsigned integer value for the component size. To omit this optional
property, call this method with null
.
colorRange
- Color range for the CDCI descriptor.
IllegalArgumentException
- Cannot set the color range property of
this CDCI descriptor to a negative value.getComponentWidth()
@UInt32 int getColorRange()
Returns the color range property for this CDCI descriptor, which specifies the range of allowable digital chrominance component values. Chrominance values are unsigned and the range is centered on 128 for 8-bit video and 512 for 10-bit video. This value is used for both chrominance components.
For CCIR-601/2, the range is 225 for 8-bit video and 897 for 10-bit video. For YUV, the range is 255 for 8-bit video and 1023 for 10-bit video. These are typical values; other values will not be disallowed by the MAJ API implementation.
If this optional property is not present, the default value is returned. The default value is the maximum unsigned integer value for the component size.
getComponentWidth()
void setPaddingBits(@Int16 Short paddingBits)
Sets the padding bits property of this CDCI descriptor, which specifies the number of bits padded to each pixel.
This is an optional property with a default value of 0. To
omit this optional property, call this method with null
.
paddingBits
- Padding bits of the CDCI descriptor.PADDINGBITS_DEFAULT
@Int16 short getPaddingBits()
Returns the padding bits property of the CDCI descriptor, which specifies the number of bits padded to each pixel.
If this optional property is not present, its default value is returned.
PADDINGBITS_DEFAULT
void setAlphaSamplingWidth(@UInt32 Integer alphaSamplingWidth) throws IllegalArgumentException
Sets the alpha sampling width property of the CDCI descriptor, which specifies the number of bits used to store the alpha component.
This property is optional and has a default value of 0. To omit
this optional property, call this method with null
.
alphaSamplingWidth
- Alpha sampling width property of the
CDCI descriptor.
IllegalArgumentException
- The giv en alpha sampling width value is negative.ALPHASAMPLINGWIDTH_DEFAULT
@UInt32 int getAlphaSamplingWidth()
Returns the alpha sampling width property of the CDCI descriptor, which specifies the number of bits used to store the alpha component.
If this optional property is not present, its default value is returned.
ALPHASAMPLINGWIDTH_DEFAULT
void setReversedByteOrder(@Bool Boolean reversedByteOrder)
Sets the reversed byte order property of the CDCI descriptor, which
specifies whether the luma and chroma sample order is reversed relative to
the order defined by ITU-R BT.601. The value is false
if the sample order
conforms conforms to ITU-R BT.601, or true
if the order is reversed (i.e. the
luma sample precedes the chroma).
This property is optional and has a default value of false
.
To omit this optional property, call this method with null
.
reversedByteOrder
- Is the byte order reversed?REVERSEDBYTEORDER_DEFAULT
,
ColorSitingType.Rec601
@Bool boolean getReversedByteOrder()
Sets the reversed byte order property of the CDCI descriptor, which
specifies whether the luma and chroma sample order is reversed relative to
the order defined by ITU-R BT.601. The value is false
if the sample order
conforms conforms to ITU-R BT.601, or true
if the order is reversed (i.e. the
luma sample precedes the chroma).
If this optional property is not present, its default value is returned.
REVERSEDBYTEORDER_DEFAULT
,
ColorSitingType.Rec601
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |