MPEGVideoDescriptor (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.entity
Class MPEGVideoDescriptor

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.EssenceDescriptor
          tv.amwa.maj.entity.AAFFileDescriptor
              tv.amwa.maj.entity.DigitalImageDescriptor
                  tv.amwa.maj.entity.CDCIDescriptor
                      tv.amwa.maj.entity.MPEGVideoDescriptor

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, AAFFileDescriptor, CDCIDescriptor, DigitalImageDescriptor, EssenceDescriptor, InterchangeObject, MPEGVideoDescriptor, XMLSerializable

@AAFClass(uuid1=218169601, uuid2=257, uuid3=20736, uuid4={6,14,43,52,2,6,1,1}, definedName="MPEGVideoDescriptor", description="Describes essence that is encoded according to the MPEG specifications.") public class MPEGVideoDescriptor
extends CDCIDescriptor
implements MPEGVideoDescriptor, Serializable, Cloneable, MAJCommon
extends CDCIDescriptor
implements MPEGVideoDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of picture essence that is encoded according to the MPEG specifications.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`MPEGVideoDescriptor.XMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.DigitalImageDescriptor
`DigitalImageDescriptor.DigitalImageDescriptorXMLHandler, 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`	`MPEGVIDEODESCRIPTOR_TAG`

Fields inherited from class tv.amwa.maj.entity.CDCIDescriptor
`CDCIDESCRIPTOR_TAG`

Fields inherited from class tv.amwa.maj.entity.DigitalImageDescriptor
`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.CDCIDescriptor
`ALPHASAMPLINGWIDTH_DEFAULT, BLACKREFERENCELEVEL_DEFAULT, COLORSITING_DEFAULT, PADDINGBITS_DEFAULT, REVERSEDBYTEORDER_DEFAULT, VERTICALSUBSAMPLING_DEFAULT`

Fields inherited from interface tv.amwa.maj.iface.DigitalImageDescriptor
`ALPHATRANSPARENCY_DEFAULT, DISPLAYF2OFFSET_DEFAULT, FIELDENDOFFSET_DEFAULT, FIELDSTARTOFFSET_DEFAULT, IMAGEALIGNMENTFACTOR_DEFAULT, STOREDF2OFFSET_DEFAULT, Uncompressed`

Constructor Summary
`MPEGVideoDescriptor(ContainerDefinition containerFormat, int storedHeight, int storedWidth, LayoutType frameLayout, int[] videoLineMap, Rational imageAspectRatio, int horizontalSubsampling, int componentWidth)` Creates and initializes a new MPEG video descriptor descriptor, which specifies that a `file source mob` is associated with video essence that is represented and coded according to the MPEG specifications.

Constructor Summary

MPEGVideoDescriptor(ContainerDefinition containerFormat,
                    int storedHeight,
                    int storedWidth,
                    LayoutType frameLayout,
                    int[] videoLineMap,
                    Rational imageAspectRatio,
                    int horizontalSubsampling,
                    int componentWidth)

Creates and initializes a new MPEG video descriptor descriptor, which specifies that a file source mob is associated with video essence that is represented and coded according to the MPEG specifications.

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.
`MPEGVideoDescriptor`	`clone()` Creates a cloned copy of this entity.
`boolean`	`equals(Object o)` Tests to see if the given object is equal to this interchange object.
`int`	`getBitRate()` Returns the maximum bit rate of the MPEG elementary stream of the described MPEG video essence, measured in bits per second.
`boolean`	`getClosedGOP()` Returns code if "ClosedGop" is set in all GOP headers of the described MPEG video essence, as per ISO/IEC 13818-1 IBP descriptor, otherwise `false`.
`ContentScanningType`	`getCodedContentScanning()` Returns whether the underlying content of the descrived MPEG-coded essence was of a known content scanning type.
`boolean`	`getConstantBPictureCount()` Returns `true` if the associated essence always has a constant number of B frames throughout, or `false` if the number of B frames vary.
`boolean`	`getIdenticalGOP()` Returns `true` if every GOP in the described MPEG video sequence is constructed in the same way, as per ISO/IEC13818-1 IBP descriptor, otherwise `false`.
`boolean`	`getLowDelay()` Returns `true` if the low delay mode was used in the sequence represented by the described MPEG-video essence and `false` otherwise.
`short`	`getMaxBPictureCount()` Returns the maximum number of B pictures between P frames or I frames in the described MPEG video essence, equivalent to ISO/IEC 13818-2 annex D (M-1).
`short`	`getMaxGOP()` Returns the maximum occurring spacing between I frames in the described MPEG video essence, as per an ISO/IEC 13818-1 IBP descriptor.
`byte`	`getProfileAndLevel()` Returns the MPEG-2 video profile and level of the described MPEG video essence.
`boolean`	`getSingleSequence()` Determines whether the described MPEG video essence consists of a single MPEG sequence or if there are a number of sequences.
`int`	`hashCode()` Returns a hash code value for this interchange object.
`void`	`setBitRate(Integer bitRate)` Sets the maximum bit rate of the MPEG elementary stream of the described MPEG video essence, measured in bits per second.
`void`	`setClosedGOP(Boolean closedGOP)` Set to `true` to indicate that "ClosedGop" is set in all GOP headers of the described MPEG video essence, as per ISO/IEC 13818-1 IBP descriptor, otherwise `false`.
`void`	`setCodedContentScanning(ContentScanningType codedContentScanning)` Sets whether the underlying content of the associated MPEG-coded essence was of a known content scanning type.
`void`	`setConstantBPictureCount(Boolean constanBPictureCount)` Set to `true` to indicate that the described MPEG video essence always has a constant number of B frames throughout or to `false` to indicate that the number of B frames vary.
`void`	`setIdenticalGOP(Boolean identicalGOP)` Set to `true` to indicate that every GOP in the described MPEG video sequence is constructed in the same way, as per ISO/IEC 13818-1 IBP descriptor, otherwise `false`.
`void`	`setLowDelay(Boolean lowDelay)` Set to `true` if the low delay mode was used in the sequence represented by the described MPEG video essence and `false` otherwise.
`void`	`setMaxBPictureCount(Short maxBPictureCount)` Sets the maximum number of B pictures between P frames or I frames in the described MPEG video essence, equivalent to ISO/IEC 13818-2 annex D (M-1).
`void`	`setMaxGOP(Short maxGOP)` Sets the maximum occurring spacing between I frames in the described MPEG video essence, as per ISO/IEC 13818-1 IBP descriptor.
`void`	`setProfileAndLevel(Byte profileAndLevel)` Sets the MPEG-2 video profile and level of the described MPEG video essence.
`void`	`setPropertiesFromInterface(MPEGVideoDescriptor castFrom)`
`void`	`setSingleSequence(Boolean singleSequence)` Sets whether the described MPEG video essence consists of a single MPEG sequence or if there are a number of sequences.

Methods inherited from class tv.amwa.maj.entity.CDCIDescriptor
`getAlphaSamplingWidth, getBlackReferenceLevel, getColorRange, getColorSiting, getComponentWidth, getHorizontalSubsampling, getPaddingBits, getReversedByteOrder, getVerticalSubsampling, getWhiteReferenceLevel, setAlphaSamplingWidth, setBlackReferenceLevel, setColorRange, setColorSiting, setComponentWidth, setHorizontalSubsampling, setPaddingBits, setPropertiesFromInterface, setReversedByteOrder, setVerticalSubsampling, setWhiteReferenceLevel`

Methods inherited from class tv.amwa.maj.entity.CDCIDescriptor

getAlphaSamplingWidth, getBlackReferenceLevel, getColorRange, getColorSiting, getComponentWidth, getHorizontalSubsampling, getPaddingBits, getReversedByteOrder, getVerticalSubsampling, getWhiteReferenceLevel, setAlphaSamplingWidth, setBlackReferenceLevel, setColorRange, setColorSiting, setComponentWidth, setHorizontalSubsampling, setPaddingBits, setPropertiesFromInterface, setReversedByteOrder, setVerticalSubsampling, setWhiteReferenceLevel

Methods inherited from class tv.amwa.maj.entity.DigitalImageDescriptor
areDisplayValuesPresent, areSampledValuesPresent, getActiveFormatDescriptor, getAlphaTransparency, getCodingEquations, getColorPrimaries, getCompression, getDisplayF2Offset, getDisplayHeight, getDisplayView, getDisplayWidth, getDisplayXOffset, getDisplayYOffset, getFieldDominance, getFieldEndOffset, getFieldStartOffset, getFrameLayout, getImageAlignmentFactor, getImageAspectRatio, getSampledHeight, getSampledView, getSampledWidth, getSampledXOffset, getSampledYOffset, getSignalStandard, getStoredF2Offset, getStoredHeight, getStoredView, getStoredWidth, getTransferCharacteristic, getVideoLineMap, getVideoLineMapSize, setActiveFormatDescriptor, setAlphaTransparency, setCodingEquations, setColorPrimaries, setCompression, setDisplayF2Offset, setDisplayView, setFieldDominance, setFieldEndOffset, setFieldStartOffset, setFrameLayout, setImageAlignmentFactor, setImageAspectRatio, setPropertiesFromInterface, setSampledView, setSignalStandard, setStoredF2Offset, setStoredHeight, setStoredView, setStoredWidth, setTransferCharacteristic, setVideoLineMap

Methods inherited from class tv.amwa.maj.entity.DigitalImageDescriptor

areDisplayValuesPresent, areSampledValuesPresent, getActiveFormatDescriptor, getAlphaTransparency, getCodingEquations, getColorPrimaries, getCompression, getDisplayF2Offset, getDisplayHeight, getDisplayView, getDisplayWidth, getDisplayXOffset, getDisplayYOffset, getFieldDominance, getFieldEndOffset, getFieldStartOffset, getFrameLayout, getImageAlignmentFactor, getImageAspectRatio, getSampledHeight, getSampledView, getSampledWidth, getSampledXOffset, getSampledYOffset, getSignalStandard, getStoredF2Offset, getStoredHeight, getStoredView, getStoredWidth, getTransferCharacteristic, getVideoLineMap, getVideoLineMapSize, setActiveFormatDescriptor, setAlphaTransparency, setCodingEquations, setColorPrimaries, setCompression, setDisplayF2Offset, setDisplayView, setFieldDominance, setFieldEndOffset, setFieldStartOffset, setFrameLayout, setImageAlignmentFactor, setImageAspectRatio, setPropertiesFromInterface, setSampledView, setSignalStandard, setStoredF2Offset, setStoredHeight, setStoredView, setStoredWidth, setTransferCharacteristic, setVideoLineMap

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, 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.CDCIDescriptor
`getAlphaSamplingWidth, getBlackReferenceLevel, getColorRange, getColorSiting, getComponentWidth, getHorizontalSubsampling, getPaddingBits, getReversedByteOrder, getVerticalSubsampling, getWhiteReferenceLevel, setAlphaSamplingWidth, setBlackReferenceLevel, setColorRange, setColorSiting, setComponentWidth, setHorizontalSubsampling, setPaddingBits, setReversedByteOrder, setVerticalSubsampling, setWhiteReferenceLevel`

Methods inherited from interface tv.amwa.maj.iface.CDCIDescriptor

getAlphaSamplingWidth, getBlackReferenceLevel, getColorRange, getColorSiting, getComponentWidth, getHorizontalSubsampling, getPaddingBits, getReversedByteOrder, getVerticalSubsampling, getWhiteReferenceLevel, setAlphaSamplingWidth, setBlackReferenceLevel, setColorRange, setColorSiting, setComponentWidth, setHorizontalSubsampling, setPaddingBits, setReversedByteOrder, setVerticalSubsampling, setWhiteReferenceLevel

Methods inherited from interface tv.amwa.maj.iface.DigitalImageDescriptor
areDisplayValuesPresent, areSampledValuesPresent, getActiveFormatDescriptor, getAlphaTransparency, getCodingEquations, getColorPrimaries, getCompression, getDisplayF2Offset, getDisplayView, getFieldDominance, getFieldEndOffset, getFieldStartOffset, getFrameLayout, getImageAlignmentFactor, getImageAspectRatio, getSampledView, getSignalStandard, getStoredF2Offset, getStoredView, getTransferCharacteristic, getVideoLineMap, getVideoLineMapSize, setActiveFormatDescriptor, setAlphaTransparency, setCodingEquations, setColorPrimaries, setCompression, setDisplayF2Offset, setDisplayView, setFieldDominance, setFieldEndOffset, setFieldStartOffset, setFrameLayout, setImageAlignmentFactor, setImageAspectRatio, setSampledView, setSignalStandard, setStoredF2Offset, setStoredView, setTransferCharacteristic, setVideoLineMap

Methods inherited from interface tv.amwa.maj.iface.DigitalImageDescriptor

areDisplayValuesPresent, areSampledValuesPresent, getActiveFormatDescriptor, getAlphaTransparency, getCodingEquations, getColorPrimaries, getCompression, getDisplayF2Offset, getDisplayView, getFieldDominance, getFieldEndOffset, getFieldStartOffset, getFrameLayout, getImageAlignmentFactor, getImageAspectRatio, getSampledView, getSignalStandard, getStoredF2Offset, getStoredView, getTransferCharacteristic, getVideoLineMap, getVideoLineMapSize, setActiveFormatDescriptor, setAlphaTransparency, setCodingEquations, setColorPrimaries, setCompression, setDisplayF2Offset, setDisplayView, setFieldDominance, setFieldEndOffset, setFieldStartOffset, setFrameLayout, setImageAlignmentFactor, setImageAspectRatio, setSampledView, setSignalStandard, setStoredF2Offset, setStoredView, setTransferCharacteristic, setVideoLineMap

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
`toString`

Field Detail

MPEGVIDEODESCRIPTOR_TAG

public static final String MPEGVIDEODESCRIPTOR_TAG

See Also:: Constant Field Values

Constructor Detail

MPEGVideoDescriptor

public MPEGVideoDescriptor(ContainerDefinition containerFormat,
                           @UInt32
                           int storedHeight,
                           @UInt32
                           int storedWidth,
                           LayoutType frameLayout,
                           @VideoLineMap
                           int[] videoLineMap,
                           Rational imageAspectRatio,
                           @UInt32
                           int horizontalSubsampling,
                           @UInt32
                           int componentWidth)
                    throws NullPointerException,
                           IllegalArgumentException

Parameters:: containerFormat - Container mechanism used to store the essence.; storedHeight - Number of pixels in vertical dimension of the stored view.; storedWidth - Number of pixels in horizontal dimension of the stored view.; frameLayout - Describes whether all data for a complete sample is in one frame or is split into more than one field.; videoLineMap - 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 interlaced video, there are 2 values in the array.; imageAspectRatio - Describes the ratio between the horizontal size and the vertical size in the intended final image.; horizontalSubsampling - 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. Legal values are 1, 2 and 4.; componentWidth - Number of bits used to store each component. Can have a value of 8, 10, or 16. 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.
Throws:: NullPointerException - One or more of arguments is null.; IllegalArgumentException - The given values are not within the permintted ranges.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(MPEGVideoDescriptor castFrom)

See Also:: InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)