Media Authoring
with Java API

tv.amwa.maj.entity
Class DigitalImageDescriptor

java.lang.Object
  extended by tv.amwa.maj.entity.InterchangeObject
      extended by tv.amwa.maj.entity.EssenceDescriptor
          extended by tv.amwa.maj.entity.AAFFileDescriptor
              extended by tv.amwa.maj.entity.DigitalImageDescriptor
All Implemented Interfaces:
Serializable, Cloneable, MAJCommon, AAFFileDescriptor, DigitalImageDescriptor, EssenceDescriptor, InterchangeObject, XMLSerializable
Direct Known Subclasses:
CDCIDescriptor, RGBADescriptor

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=9984,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="DigitalImageDescriptor",
          description="The DigitalImageDescriptor class specifies that a File SourceMob is associated with video essence that is formatted either using RGBA or luminance/chrominance formatting.")
public abstract class DigitalImageDescriptor
extends AAFFileDescriptor
implements DigitalImageDescriptor, Serializable, Cloneable

Implements the description of video content data formatted either using RGBA or luminance/chrominance formatting.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:
Richard Cartwright
See Also:
Serialized Form

Nested Class Summary
static class DigitalImageDescriptor.DigitalImageDescriptorXMLHandler
           
static class DigitalImageDescriptor.VideoLineMapXMLHandler
           
 
Nested classes/interfaces inherited from class tv.amwa.maj.entity.AAFFileDescriptor
AAFFileDescriptor.FileDescriptorXMLHandler
 
Nested classes/interfaces inherited from class tv.amwa.maj.entity.EssenceDescriptor
EssenceDescriptor.EssenceDescriptorXMLHandler, EssenceDescriptor.LocatorXMLHandler, EssenceDescriptor.SubDescriptorXMLHandler
 
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject
InterchangeObject.InterchangeObjectXMLHandler
 
Field Summary
static String DIGITALIMAGEDESCRIPTOR_ITEM
           
 
Fields inherited from class tv.amwa.maj.entity.AAFFileDescriptor
FILEDESCRIPTOR_ITEM
 
Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor
ESSENCEDESCRIPTOR_ITEM
 
Fields inherited from interface tv.amwa.maj.iface.DigitalImageDescriptor
ALPHATRANSPARENCY_DEFAULT, DISPLAYF2OFFSET_DEFAULT, FIELDENDOFFSET_DEFAULT, FIELDSTARTOFFSET_DEFAULT, IMAGEALIGNMENTFACTOR_DEFAULT, STOREDF2OFFSET_DEFAULT, Uncompressed
 
Constructor Summary
DigitalImageDescriptor()
           
 
Method Summary
 void appendXMLChildren(Node parent)
          Append child elements to the given parent node to serialize the value of an object to an XML fragment.
 boolean areDisplayValuesPresent()
          Returns whether this digital image descriptor contains a display view.
 boolean areSampledValuesPresent()
          Returns whether this digital image descriptor contains a sample area values dimensions and offsets.
 boolean equals(Object o)
          Tests to see if the given object is equal to this interchange object.
 byte getActiveFormatDescriptor()
          Returns the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.).
 AlphaTransparencyType getAlphaTransparency()
          Returns the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency.
 AUID getCodingEquations()
          Returns the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components.
 AUID getColorPrimaries()
          Returns the color primaries property for the digital image descriptor.
 AUID getCompression()
          Returns the kind of compression and format of compression information of the video essence data described by this digital image descriptor.
 int getDisplayF2Offset()
          Returns the display field 2 offset property of this digital image descriptor.
 int getDisplayHeight()
           
 int[] getDisplayView()
          Returns the dimensions of the display view of this digital image descriptor.
 int getDisplayWidth()
           
 int getDisplayXOffset()
           
 int getDisplayYOffset()
           
 FieldNumber getFieldDominance()
          Returns the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields.
 int getFieldEndOffset()
          Returns the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field.
 int getFieldStartOffset()
          Returns the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field.
 LayoutType getFrameLayout()
          Returns the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field.
 int getImageAlignmentFactor()
          Sets the image alignment factor property of this digital image descriptor, which specifies the alignment when storing the digital essence.
 Rational getImageAspectRatio()
          Gets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image.
 int getSampledHeight()
           
 int[] getSampledView()
          Returns the dimensions of the sampled view of this digital image descriptor.
 int getSampledWidth()
           
 int getSampledXOffset()
           
 int getSampledYOffset()
           
 SignalStandardType getSignalStandard()
          Returns the signal standard property of this digital image descriptor.
 int getStoredF2Offset()
          Returns the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture.
 int getStoredHeight()
           
 int[] getStoredView()
          Returns the dimension of the stored view of this digital image descriptor.
 int getStoredWidth()
           
 AUID getTransferCharacteristic()
          Returns the opto-electronic transfer characteristic of this digital image descriptor.
 int[] getVideoLineMap()
          Returns the video line map property of this digital image descriptor, which specifies the scan line in the analog source that corresponds to the beginning of each digitized field.
 int getVideoLineMapSize()
          Returns the number of elements in the video line map property array of this digital image descriptor.
 int hashCode()
          Returns a hash code value for this interchange object.
 void setActiveFormatDescriptor(Byte activeFormatDescriptor)
          Sets the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.).
 void setAlphaTransparency(AlphaTransparencyType alphaTransparency)
          Sets the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency.
 void setCodingEquations(AUID codingEquations)
          Sets the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components.
 void setColorPrimaries(AUID colorPrimaries)
          Sets the color primaries property for this digital image descriptor.
 void setCompression(AUID compression)
          Sets the kind of compression and format of the compression information of the video essence data described by this digital image descriptor.
 void setDisplayF2Offset(Integer displayF2Offset)
          Sets the display field 2 offset property of this digital image descriptor.
 void setDisplayView(int displayHeight, int displayWidth, int displayXOffset, int displayYOffset)
          Sets the dimension of display view of this digital image descriptor.
 void setFieldDominance(FieldNumber fieldDominance)
          Sets the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields.
 void setFieldEndOffset(Integer fieldEndOffset)
          Sets the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field.
 void setFieldStartOffset(Integer fieldStartOffset)
          Sets the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field.
 void setFrameLayout(LayoutType frameLayout)
          Sets the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field.
 void setImageAlignmentFactor(Integer imageAlignmentFactor)
          Sets the image alignment factor property of this digital image descriptor which specifies the alignment when storing the digital essence.
 void setImageAspectRatio(Rational imageAspectRatio)
          Sets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image.
 void setPropertiesFromInterface(DigitalImageDescriptor castFrom)
           
 void setSampledView(int sampledHeight, int sampledWidth, int sampledXOffset, int sampledYOffset)
          Sets the dimensions of the sampled view of this digital image descriptor.
 void setSignalStandard(SignalStandardType signalStandard)
          Sets the signal standard property of this digital image descriptor, which specifies the underlying signal standard used to define the raster.
 void setStoredF2Offset(Integer storedF2Offset)
          Sets the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture.
 void setStoredHeight(int storedHeight)
           
 void setStoredView(int storedHeight, int storedWidth)
          Sets the dimension of the stored view of this digital image descriptor.
 void setStoredWidth(int storedWidth)
           
 void setTransferCharacteristic(AUID transferCharacteristic)
          Sets the opto-electronic transfer characteristic of this digital image descriptor.
 void setVideoLineMap(int[] videoLineMap)
          Sets the video line map property of this digital image descriptor, which specifies the scan line in the analog source that corresponds to the beginning of each digitized field.
 
Methods inherited from class tv.amwa.maj.entity.AAFFileDescriptor
describesStaticEssence, getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setDescribesStaticEssence, setDescribesTimeVaryingEssence, setLength, setLinkedSlotID, setPropertiesFromInterface, setSampleRate
 
Methods inherited from class tv.amwa.maj.entity.EssenceDescriptor
appendLocator, appendSubDescriptor, clone, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt, setPropertiesFromInterface
 
Methods inherited from class tv.amwa.maj.entity.InterchangeObject
castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 
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
 
Methods inherited from interface tv.amwa.maj.entity.MAJCommon
clone, toString
 

Field Detail

DIGITALIMAGEDESCRIPTOR_ITEM

public static final String DIGITALIMAGEDESCRIPTOR_ITEM
See Also:
Constant Field Values
Constructor Detail

DigitalImageDescriptor

public DigitalImageDescriptor()
Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(DigitalImageDescriptor castFrom)
See Also:
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getActiveFormatDescriptor

@AAFProperty(uuid1=67175170,
             uuid2=2304,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="ActiveFormatDescriptor",
             typeName="UInt8",
             optional=true,
             uniqueIdentifier=false,
             pid=12824)
public byte getActiveFormatDescriptor()
                               throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.). The value exactly matches the active_format element defined by ETSI TS 102 154.

This optional property is set to the default value of "unspecified" by omitting its value.

Specified by:
getActiveFormatDescriptor in interface DigitalImageDescriptor
Returns:
Active format descriptor property for the digital image descriptor.
Throws:
PropertyNotPresentException - The optional active format descriptor property is not present in this digital image descriptor.

setActiveFormatDescriptor

public void setActiveFormatDescriptor(Byte activeFormatDescriptor)
                               throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the active format descriptor property for the digital image descriptor, which specifies the desired framing of the content within the displayed image (4:3 in 16:9 etc.). The value exactly matches the "active_format" element defined by ETSI TS 102 154.

To omit this optional property, call this method with null. When the property is not present, it is considered to be the same as its default value of "unspecified".

Specified by:
setActiveFormatDescriptor in interface DigitalImageDescriptor
Parameters:
activeFormatDescriptor - Active format descriptor property for this digital image descriptor.
Throws:
IllegalArgumentException - The active format descriptor is a 4-bit value and cannot lie outside the range 0 to 15.

getAlphaTransparency

@AAFProperty(uuid1=85983490,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="AlphaTransparency",
             typeName="AlphaTransparencyType",
             optional=true,
             uniqueIdentifier=false,
             pid=12815)
public AlphaTransparencyType getAlphaTransparency()
Description copied from interface: DigitalImageDescriptor

Returns the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency. This is an optional property and if the value is omitted, the default value of AlphaTransparencyType.MinValueTransparent is returned.

Specified by:
getAlphaTransparency in interface DigitalImageDescriptor
Returns:
Alpha transparency orientation for this digital image descriptor.
See Also:
DigitalImageDescriptor.ALPHATRANSPARENCY_DEFAULT

setAlphaTransparency

public void setAlphaTransparency(AlphaTransparencyType alphaTransparency)
Description copied from interface: DigitalImageDescriptor

Sets the alpha transparency property of this digital image descriptor, which specifies whether the minimum alpha value or the maximum alpha value indicates transparency. To omit this optional property, call this method with null.

Specified by:
setAlphaTransparency in interface DigitalImageDescriptor
Parameters:
alphaTransparency - Alpha transparency orientation for this digital image descriptor.
See Also:
DigitalImageDescriptor.ALPHATRANSPARENCY_DEFAULT

getCodingEquations

@AAFProperty(uuid1=67174913,
             uuid2=259,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="CodingEquations",
             typeName="CodingEquationsType",
             optional=true,
             uniqueIdentifier=false,
             pid=12826)
public AUID getCodingEquations()
                        throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components.

The default value for this optional property is unspecified which is represented by this property being omitted.

Specified by:
getCodingEquations in interface DigitalImageDescriptor
Returns:
Coding equations property of this digital image descriptor.
Throws:
PropertyNotPresentException - The optional coding equations property is not present for this digital image descriptor, indicating that it is unspecified.
See Also:
CodingEquationsType, TypeDefinitionExtendibleEnumeration.ColorPrimariesType

setCodingEquations

public void setCodingEquations(AUID codingEquations)
Description copied from interface: DigitalImageDescriptor

Sets the coding equations property of this digital image descriptor, which specifies the coding equations to convert RGB image components to component color difference image components.

The default value for this optional property is unspecified, which is represented by omitting this property. Setting the optional coding equations property to null will result in the property being omitted.

Specified by:
setCodingEquations in interface DigitalImageDescriptor
Parameters:
codingEquations - Coding equations property of this digital image descriptor.
See Also:
CodingEquationsType, TypeDefinitionExtendibleEnumeration.ColorPrimariesType

getColorPrimaries

@AAFProperty(uuid1=67174913,
             uuid2=262,
             uuid3=256,
             uuid4={6,14,43,52,1,1,1,9},
             definedName="ColorPrimaries",
             typeName="ColorPrimariesType",
             optional=true,
             uniqueIdentifier=false,
             pid=12825)
public AUID getColorPrimaries()
                       throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the color primaries property for the digital image descriptor.

This is an optional property and if the property is omitted it is assumed to be unspecified.

Specified by:
getColorPrimaries in interface DigitalImageDescriptor
Returns:
Color primaries for this digital image descriptor.
Throws:
PropertyNotPresentException - The optional color primaries property is not present for this digital image descriptor, indicating that it is unspecified.
See Also:
ColorPrimariesType, TypeDefinitionExtendibleEnumeration.ColorPrimariesType

setColorPrimaries

public void setColorPrimaries(AUID colorPrimaries)
Description copied from interface: DigitalImageDescriptor

Sets the color primaries property for this digital image descriptor.

The default value for this property is unspecified, which is represented by omitting this property. Set this optional property to null to omit it.

Specified by:
setColorPrimaries in interface DigitalImageDescriptor
Parameters:
colorPrimaries - Color primaries for the digiral image descriptor.
See Also:
ColorPrimariesType, TypeDefinitionExtendibleEnumeration.ColorPrimariesType

getCompression

@AAFProperty(uuid1=67175937,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Compression",
             typeName="AUID",
             optional=true,
             uniqueIdentifier=false,
             pid=12801)
public AUID getCompression()
                    throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the kind of compression and format of compression information of the video essence data described by this digital image descriptor. If the image data is uncompressed, a PropertyNotPresentException will be thrown.

Specified by:
getCompression in interface DigitalImageDescriptor
Returns:
Kind of compression and format of compression information of the video essence data.
Throws:
PropertyNotPresentException - The optional compression property is not present in this digital image descriptor, indicating that the described image essence data is uncompressed.

setCompression

public void setCompression(AUID compression)
Description copied from interface: DigitalImageDescriptor

Sets the kind of compression and format of the compression information of the video essence data described by this digital image descriptor. If there is no compression, set this optional property to DigitalImageDescriptor.Uncompressed or null.

Specified by:
setCompression in interface DigitalImageDescriptor
Parameters:
compression - Kind of compression and format of the compression information of the video essence data, or DigitalImageDescriptor.Uncompressed if the image is uncompressed.
See Also:
DigitalImageDescriptor.Uncompressed

getDisplayF2Offset

@AAFProperty(uuid1=67175170,
             uuid2=1792,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="DisplayF2Offset",
             typeName="Int32",
             optional=true,
             uniqueIdentifier=false,
             pid=12823)
public int getDisplayF2Offset()
Description copied from interface: DigitalImageDescriptor

Returns the display field 2 offset property of this digital image descriptor. This value specifies a topness adjustment for the displayed picture. Valid values are 0 or 1.

If this property value is omitted, its default value of 0 will be returned.

Specified by:
getDisplayF2Offset in interface DigitalImageDescriptor
Returns:
Display field 2 offset property of this digital image descriptor.
See Also:
DigitalImageDescriptor.DISPLAYF2OFFSET_DEFAULT

setDisplayF2Offset

public void setDisplayF2Offset(Integer displayF2Offset)
                        throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the display field 2 offset property of this digital image descriptor. This value specifies a topness adjustment for the displayed picture. Valid values are 0 or 1.

Set this optional property to null to omit its value. The default value of this property is 0.

Specified by:
setDisplayF2Offset in interface DigitalImageDescriptor
Parameters:
displayF2Offset - Display field 2 offset property of this digital image descriptor.
Throws:
IllegalArgumentException - The given display field 2 offset is not one of the valid values of 0 or 1.
See Also:
DigitalImageDescriptor.DISPLAYF2OFFSET_DEFAULT

getDisplayView

public int[] getDisplayView()
Description copied from interface: DigitalImageDescriptor

Returns the dimensions of the display view of this digital image descriptor. 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 the stored view.

The value returned is an array of four integer values. The index of the values correspond to:

The display view properties are either all present or all omitted. If the properties are omitted, the default value is returned which is an area equivalent to the stored view. To find out whether the display view properties are present, call DigitalImageDescriptor.areDisplayValuesPresent().

Specified by:
getDisplayView in interface DigitalImageDescriptor
Returns:
Dimensions of the display view.

setDisplayView

public void setDisplayView(int displayHeight,
                           int displayWidth,
                           int displayXOffset,
                           int displayYOffset)
                    throws IllegalPropertyValueException
Description copied from interface: DigitalImageDescriptor

Sets the dimension of display view of this digital image descriptor. 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 the stored view.

All properties are optional and are set as follows:

The display view values are either all present or all omitted. Calling this method successfully will mean display view values are present. To find out whether the display view properties are present, call DigitalImageDescriptor.areDisplayValuesPresent().

Specified by:
setDisplayView in interface DigitalImageDescriptor
Parameters:
displayHeight - Number of pixels in vertical dimension of display view.
displayWidth - Number of pixels in vertical dimension of display view.
displayXOffset - Number of pixels from the top-left corner of the stored view.
displayYOffset - Number pixels from the top-left corner of the stored view.
Throws:
IllegalPropertyValueException - The area specified by display width and display X offset properties is outside the stored view, or the area specified by display height and display Y offset properties is outside the stored view.

getDisplayHeight

@AAFProperty(uuid1=67175681,
             uuid2=2816,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="DisplayHeight",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12808)
public int getDisplayHeight()

getDisplayWidth

@AAFProperty(uuid1=67175681,
             uuid2=3072,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="DisplayWidth",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12809)
public int getDisplayWidth()

getDisplayXOffset

@AAFProperty(uuid1=67175681,
             uuid2=3328,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="DisplayXOffset",
             typeName="Int32",
             optional=true,
             uniqueIdentifier=false,
             pid=12810)
public int getDisplayXOffset()

getDisplayYOffset

@AAFProperty(uuid1=67175681,
             uuid2=3584,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="DisplayYOffset",
             typeName="Int32",
             optional=true,
             uniqueIdentifier=false,
             pid=12811)
public int getDisplayYOffset()

areDisplayValuesPresent

public boolean areDisplayValuesPresent()
Description copied from interface: DigitalImageDescriptor

Returns whether this digital image descriptor contains a display view. A value of true indicates that display height, width, x-offset and y-offset values are present.

Specified by:
areDisplayValuesPresent in interface DigitalImageDescriptor
Returns:
Does this digital image descriptor contain display size and offset information?
See Also:
DigitalImageDescriptor.getDisplayView(), DigitalImageDescriptor.setDisplayView(int, int, int, int)

getFieldDominance

@AAFProperty(uuid1=67175169,
             uuid2=1536,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FieldDominance",
             typeName="FieldNumber",
             optional=true,
             uniqueIdentifier=false,
             pid=12818)
public FieldNumber getFieldDominance()
                              throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields. This is an optional property with no default value.

Specified by:
getFieldDominance in interface DigitalImageDescriptor
Returns:
Field dominance of this digital image descriptor.
Throws:
PropertyNotPresentException - The optional field dominance property is not present for this digital image descriptor.

setFieldDominance

public void setFieldDominance(FieldNumber fieldDominance)
Description copied from interface: DigitalImageDescriptor

Sets the field dominance property of this digital image descriptor, which specifies whether field 1 or field 2 is dominant in images composed of two interlaced fields.

This is an optional property with no default value. Call this method with null to omit this property.

Specified by:
setFieldDominance in interface DigitalImageDescriptor
Parameters:
fieldDominance - Field dominance of this digital image descriptor.

getFieldEndOffset

@AAFProperty(uuid1=68681987,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FieldEndOffset",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12820)
public int getFieldEndOffset()
Description copied from interface: DigitalImageDescriptor

Returns the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field.

If this property value is omitted, its default value of DigitalImageDescriptor.FIELDENDOFFSET_DEFAULT will be returned.

Specified by:
getFieldEndOffset in interface DigitalImageDescriptor
Returns:
Field end offset property of this digital image descriptor.
See Also:
DigitalImageDescriptor.FIELDENDOFFSET_DEFAULT

setFieldEndOffset

public void setFieldEndOffset(Integer fieldEndOffset)
                       throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the field end offset property of this digital image descriptor, which specifies the number of unused bytes at the end of each video field.

Set this optional property to null to omit its value. The default value of this property is 0.

Specified by:
setFieldEndOffset in interface DigitalImageDescriptor
Parameters:
fieldEndOffset - Field end offset property of this digital image descriptor.
Throws:
IllegalArgumentException - Cannot set the field end offset to a negative value for this digital image descriptor.
See Also:
DigitalImageDescriptor.FIELDENDOFFSET_DEFAULT

getFieldStartOffset

@AAFProperty(uuid1=68681986,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="FieldStartOffset",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12819)
public int getFieldStartOffset()
Description copied from interface: DigitalImageDescriptor

Returns the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field.

If this property value is omitted, its default value of 0 will be returned.

Specified by:
getFieldStartOffset in interface DigitalImageDescriptor
Returns:
Field start offset of this digital image descriptor.
See Also:
DigitalImageDescriptor.FIELDSTARTOFFSET_DEFAULT

setFieldStartOffset

public void setFieldStartOffset(Integer fieldStartOffset)
                         throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the field start offset property of this digital image descriptor, which specifies the number of unused bytes at the start of each video field.

Set this optional property to null to omit its value. The default value of this property is 0.

Specified by:
setFieldStartOffset in interface DigitalImageDescriptor
Parameters:
fieldStartOffset - Field start offset of this digital image descriptor.
Throws:
IllegalArgumentException - The given field start offset is negative.
See Also:
DigitalImageDescriptor.FIELDSTARTOFFSET_DEFAULT

getFrameLayout

@AAFProperty(uuid1=67175169,
             uuid2=1024,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="FrameLayout",
             typeName="LayoutType",
             optional=false,
             uniqueIdentifier=false,
             pid=12812)
public LayoutType getFrameLayout()
Description copied from interface: DigitalImageDescriptor

Returns the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field.

Specified by:
getFrameLayout in interface DigitalImageDescriptor
Returns:
Frame layout for the digital image descriptor.

setFrameLayout

public void setFrameLayout(LayoutType frameLayout)
                    throws NullPointerException
Description copied from interface: DigitalImageDescriptor

Sets the frame layout for this digital image descriptor, which describes whether all data for a complete sample is in one frame or is split into more than one field.

Specified by:
setFrameLayout in interface DigitalImageDescriptor
Parameters:
frameLayout - Frame layout for the digital image descriptor.
Throws:
NullPointerException - The given frame layout is null.

getImageAlignmentFactor

@AAFProperty(uuid1=68681985,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="ImageAlignmentFactor",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12817)
public int getImageAlignmentFactor()
Description copied from interface: DigitalImageDescriptor

Sets the image alignment factor property of this digital image descriptor, which 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.

This property is optional and the default value of 1 will be returned if it is currently omitted.

Specified by:
getImageAlignmentFactor in interface DigitalImageDescriptor
Returns:
Image alignment factor of this digital image descriptor.

setImageAlignmentFactor

public void setImageAlignmentFactor(Integer imageAlignmentFactor)
                             throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the image alignment factor property of this digital image descriptor which 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.

Set this optional property to null to omit the property. The default value of this property is 1.

Specified by:
setImageAlignmentFactor in interface DigitalImageDescriptor
Parameters:
imageAlignmentFactor - Image alignment factor of this digital image descriptor.
Throws:
IllegalArgumentException - Cannot set the image alignment factor to a negative value for this digital image descriptor.

getImageAspectRatio

@AAFProperty(uuid1=67174657,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="ImageAspectRatio",
             typeName="Rational",
             optional=false,
             uniqueIdentifier=false,
             pid=12814)
public Rational getImageAspectRatio()
Description copied from interface: DigitalImageDescriptor

Gets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image.

Specified by:
getImageAspectRatio in interface DigitalImageDescriptor
Returns:
Ratio between horizontal and vertical size of the intended final image.

setImageAspectRatio

public void setImageAspectRatio(Rational imageAspectRatio)
                         throws NullPointerException
Description copied from interface: DigitalImageDescriptor

Sets the image aspect ratio property of this digital image descriptor, which describes the ratio between the horizontal size and the vertical size in the intended final image.

Specified by:
setImageAspectRatio in interface DigitalImageDescriptor
Parameters:
imageAspectRatio - Ratio between horizontal and vertical size of the intended final image.
Throws:
NullPointerException - The given image aspect ratio is null.

getSampledView

public int[] getSampledView()
Description copied from interface: DigitalImageDescriptor

Returns the dimensions of the sampled view of this digital image descriptor. 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 the stored view.

The value returned is an array of four integer values. The index of the values correspond to:

The sampled view properties are either all present or all omitted. If the properties are omitted, the default value is returned which is an area equivalent to the stored view. To find out whether the sampled view properties are present, call DigitalImageDescriptor.areSampledValuesPresent().

Specified by:
getSampledView in interface DigitalImageDescriptor
Returns:
Dimensions of the sampled view.

setSampledView

public void setSampledView(int sampledHeight,
                           int sampledWidth,
                           int sampledXOffset,
                           int sampledYOffset)
                    throws IllegalPropertyValueException
Description copied from interface: DigitalImageDescriptor

Sets the dimensions of the sampled view of this digital image descriptor. 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 the stored view.

All properties are optional and are set as follows:

The sampled view values are either all present or all omitted. Calling this method will mean sampled view values are present. To find out whether the sampled view properties are present, call DigitalImageDescriptor.areSampledValuesPresent().

Specified by:
setSampledView in interface DigitalImageDescriptor
Parameters:
sampledHeight - Number of pixels in vertical dimension of sampled view.
sampledWidth - Number of pixels in horizontal dimension of sampled view.
sampledXOffset - Number of pixels from top left corner of the stored view.
sampledYOffset - Number of pixels from top left corner of the stored view.
Throws:
IllegalPropertyValueException - The area specified by the sampled width and sampled X offset is outside the stored view, or the area specified by the sampled height and sampled Y offset is outside the stored view.

getSampledHeight

@AAFProperty(uuid1=67175681,
             uuid2=1792,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="SampledHeight",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12804)
public int getSampledHeight()

getSampledWidth

@AAFProperty(uuid1=67175681,
             uuid2=2048,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="SampledWidth",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=12805)
public int getSampledWidth()

getSampledXOffset

@AAFProperty(uuid1=67175681,
             uuid2=2304,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="SampledXOffset",
             typeName="Int32",
             optional=true,
             uniqueIdentifier=false,
             pid=12806)
public int getSampledXOffset()

getSampledYOffset

@AAFProperty(uuid1=67175681,
             uuid2=2560,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="SampledYOffset",
             typeName="Int32",
             optional=true,
             uniqueIdentifier=false,
             pid=12807)
public int getSampledYOffset()

areSampledValuesPresent

public boolean areSampledValuesPresent()
Description copied from interface: DigitalImageDescriptor

Returns whether this digital image descriptor contains a sample area values dimensions and offsets. A value of true indicates that sampled height, width, x-offset and y-offset values are present.

Specified by:
areSampledValuesPresent in interface DigitalImageDescriptor
Returns:
Does this digital image descriptor contain sample area values and dimensions?
See Also:
DigitalImageDescriptor.getSampledView(), DigitalImageDescriptor.setSampledView(int, int, int, int)

getSignalStandard

@AAFProperty(uuid1=67436819,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="SignalStandard",
             typeName="SignalStandardType",
             optional=true,
             uniqueIdentifier=false,
             pid=12821)
public SignalStandardType getSignalStandard()
                                     throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the signal standard property of this digital image descriptor. This property specifies the underlying signal standard used to define the raster.

The default value for this property is unspecified, which is represented by omitting this property.

Specified by:
getSignalStandard in interface DigitalImageDescriptor
Returns:
Signal standard property of this digital image descriptor.
Throws:
PropertyNotPresentException - The optional signal standard property is not present for this digital image descriptor, indicating that it is unspecified.
See Also:
SignalStandardType

setSignalStandard

public void setSignalStandard(SignalStandardType signalStandard)
Description copied from interface: DigitalImageDescriptor

Sets the signal standard property of this digital image descriptor, which specifies the underlying signal standard used to define the raster.

The default value for signal standard property is unspecified, which is represented by omitting this property. Set this optional property to null to omit it.

Specified by:
setSignalStandard in interface DigitalImageDescriptor
Parameters:
signalStandard - Signal standard property of this digital image descriptor.

getStoredF2Offset

@AAFProperty(uuid1=67175170,
             uuid2=2048,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,5},
             definedName="StoredF2Offset",
             typeName="Int32",
             optional=true,
             uniqueIdentifier=false,
             pid=12822)
public int getStoredF2Offset()
Description copied from interface: DigitalImageDescriptor

Returns the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture. Valid values are 0 or -1.

This is an optional property and if it is omitted, the default value of 0 will be returned.

Specified by:
getStoredF2Offset in interface DigitalImageDescriptor
Returns:
Stored field 2 offset property of this digital image descriptor.
See Also:
DigitalImageDescriptor.STOREDF2OFFSET_DEFAULT

setStoredF2Offset

public void setStoredF2Offset(Integer storedF2Offset)
                       throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the stored field 2 offset property of this digital image descriptor, which specifies a topness adjustment for the stored picture. Valid values are 0 or -1.

Set this optional property to null to omit its value. The default value of this property is 0.

Specified by:
setStoredF2Offset in interface DigitalImageDescriptor
Parameters:
storedF2Offset - Stored field 2 offset property of this digital image descriptor.
Throws:
IllegalArgumentException - The given stored field 2 offset is not one of the valid values of 0 or -1.
See Also:
DigitalImageDescriptor.STOREDF2OFFSET_DEFAULT

getStoredView

public int[] getStoredView()
Description copied from interface: DigitalImageDescriptor

Returns the dimension of the stored view of this digital image descriptor. Typically, this includes leading blank video lines, any VITC lines, as well as the active picture area.

The value returned is an array of two integer values. The first element of the array (index 0) contains the stored height and the second element of the array (index 1) contains the stored width.

Specified by:
getStoredView in interface DigitalImageDescriptor
Returns:
Dimension of the stored view.

setStoredView

public void setStoredView(int storedHeight,
                          int storedWidth)
                   throws IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the dimension of the stored view of this digital image descriptor. Typically, this includes leading blank video lines, any VITC lines, as well as the active picture area.

Specified by:
setStoredView in interface DigitalImageDescriptor
Parameters:
storedHeight - Number of pixels in vertical dimension of stored view.
storedWidth - Number of pixels in horizontal dimension of stored view.
Throws:
IllegalArgumentException - One or both of the given stored width and height properties is/are negative, which is not permitted.

getStoredHeight

@AAFProperty(uuid1=67175682,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="StoredHeight",
             typeName="UInt32",
             optional=false,
             uniqueIdentifier=false,
             pid=12802)
public int getStoredHeight()

setStoredHeight

public void setStoredHeight(int storedHeight)
                     throws IllegalArgumentException
Throws:
IllegalArgumentException

getStoredWidth

@AAFProperty(uuid1=67175682,
             uuid2=512,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,1},
             definedName="StoredWidth",
             typeName="UInt32",
             optional=false,
             uniqueIdentifier=false,
             pid=12803)
public int getStoredWidth()

setStoredWidth

public void setStoredWidth(int storedWidth)
                    throws IllegalArgumentException
Throws:
IllegalArgumentException

getTransferCharacteristic

@AAFProperty(uuid1=67174913,
             uuid2=257,
             uuid3=512,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="TransferCharacteristic",
             typeName="TransferCharacteristicType",
             optional=true,
             uniqueIdentifier=false,
             pid=12816)
public AUID getTransferCharacteristic()
                               throws PropertyNotPresentException
Description copied from interface: DigitalImageDescriptor

Returns the opto-electronic transfer characteristic of this digital image descriptor. If this optional property is omitted, the opto-electronic characteristic is unspecified.

Specified by:
getTransferCharacteristic in interface DigitalImageDescriptor
Returns:
Opto-electronic transfer characteristic of this digital image descriptor.
Throws:
PropertyNotPresentException - The optional opto-electronic characteristic of this digital image descriptor is not present and so is unspecified.
See Also:
TransferCharacteristicType, TypeDefinitionExtendibleEnumeration.TransferCharacteristicType

setTransferCharacteristic

public void setTransferCharacteristic(AUID transferCharacteristic)
Description copied from interface: DigitalImageDescriptor

Sets the opto-electronic transfer characteristic of this digital image descriptor.

The default value for the transfer characteristic property is unspecified, which is represented by this property being omitted. If this method is called with a null value, the this optional property is omitted.

Specified by:
setTransferCharacteristic in interface DigitalImageDescriptor
Parameters:
transferCharacteristic - Opto-electronic transfer characteristic of the digital image descriptor.
See Also:
TransferCharacteristicType, TypeDefinitionExtendibleEnumeration.TransferCharacteristicType

getVideoLineMap

@AAFProperty(uuid1=67175170,
             uuid2=1280,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="VideoLineMap",
             typeName="Int32Array",
             optional=false,
             uniqueIdentifier=false,
             pid=12813)
public int[] getVideoLineMap()
Description copied from interface: DigitalImageDescriptor

Returns the video line map property of this digital image descriptor, which 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.

Specified by:
getVideoLineMap in interface DigitalImageDescriptor
Returns:
Video line map property of this digital image descriptor.

setVideoLineMap

public void setVideoLineMap(int[] videoLineMap)
                     throws NullPointerException,
                            IllegalArgumentException
Description copied from interface: DigitalImageDescriptor

Sets the video line map property of this digital image descriptor, which 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.

Specified by:
setVideoLineMap in interface DigitalImageDescriptor
Parameters:
videoLineMap - Video line map for the digital image descriptor.
Throws:
NullPointerException - The given video line map is null.
IllegalArgumentException - The size of the video line map must be 1 or 2 for this digital image descriptor.

getVideoLineMapSize

public int getVideoLineMapSize()
Description copied from interface: DigitalImageDescriptor

Returns the number of elements in the video line map property array of this digital image descriptor.

Specified by:
getVideoLineMapSize in interface DigitalImageDescriptor
Returns:
Number of elements in the video line map property array.
See Also:
DigitalImageDescriptor.getVideoLineMap()

equals

public boolean equals(Object o)
Description copied from interface: MAJCommon

Tests to see if the given object is equal to this interchange object. To be equal, the given value must be not null, share the same interface to its value and each of the properties of the value must each be equal.

Specified by:
equals in interface MAJCommon
Overrides:
equals in class AAFFileDescriptor
Parameters:
o - Object to test for equality with.
Returns:
Is the given object equals to this value?
See Also:
Object.equals(Object)

hashCode

public int hashCode()
Description copied from interface: MAJCommon

Returns a hash code value for this interchange object.

Specified by:
hashCode in interface MAJCommon
Overrides:
hashCode in class AAFFileDescriptor
Returns:
Hash code value for this interchange object.
See Also:
Object.hashCode()

appendXMLChildren

public void appendXMLChildren(Node parent)
Description copied from interface: XMLSerializable

Append child elements to the given parent node to serialize the value of an object to an XML fragment. Methods of the XMLBuilder class are provided to help with this process.

Specified by:
appendXMLChildren in interface XMLSerializable
Overrides:
appendXMLChildren in class AAFFileDescriptor
Parameters:
parent - XML parent element to append child nodes to.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.