ISOBMFF
ISO Base Media File Format Reference Software Documentation
 
Loading...
Searching...
No Matches
MPEG 4 IPMPX related functions

MPEG 4 IPMPX related functions. More...

Functions

MP4Err MP4AddDescToSampleDescription (MP4Handle sampleEntryH, MP4Handle descriptorH)
 Can be used to add an IPMP Descriptor Pointer into an existing sampleDescription.
 
MP4Err MP4AddDescToMovieIOD (MP4Movie theMovie, MP4Handle descriptorH)
 Adds a descriptor to the movie IOD.
 
MP4Err MP4NewIPMPTool (MP4Handle ipmpToolH, u64 ipmpToolIdLowerPart, u64 ipmpToolIdUpperPart, MP4Handle altGroupInfoH, MP4Handle parametricInfoH)
 Creates a new IPMPTool structure.
 
MP4Err MP4AddUrlToIPMPTool (MP4Handle ipmpToolH, MP4Handle urlH)
 Add a URL from which one or more tools specified in IPMPTool can be downloaded.
 
MP4Err MP4NewIPMPToolListDescriptor (MP4Handle ipmpToolListDescrH)
 Creates a new IPMPToolListDescriptor.
 
MP4Err MP4AddToolToIPMPToolList (MP4Handle ipmpToolListDescrH, MP4Handle ipmpToolH)
 Description TBD.
 
MP4Err MP4NewIPMPDescriptorPointer (MP4Handle ipmpDescPtrH, u8 ipmpDescriptorId, u16 ipmpToolDescrId)
 Creates a new IPMPDescriptorPointer.
 
MP4Err MP4NewIPMPToolDescriptor (MP4Handle ipmpToolDescH, u16 ipmpToolDescrId, u64 ipmpToolIdLowerPart, u64 ipmpToolIdUpperPart, MP4Handle ipmpInitializeH)
 Creates a new IPMP Tool Descriptor.
 
MP4Err MP4NewIPMPInitialize (MP4Handle ipmpInitializeH, u8 controlPoint, u8 sequenceCode)
 Creates a new IPMPInitialize structure.
 
MP4Err MP4AddIPMPDataToIPMPInitialize (MP4Handle ipmpInitializeH, MP4Handle ipmpDataH)
 Adds IPMP data to the IPMPInitialize structure.
 
MP4Err MP4AddIPMPDataToIPMPToolDescriptor (MP4Handle ipmpToolDescrH, MP4Handle ipmpDataH)
 Adds IPMP data to an IPMP Tool Descriptor.
 
MP4Err MP4NewIPMPToolDescriptorUpdate (MP4Handle ipmpToolDescrUpdateH)
 Creates a new IPMPToolDescriptorUpdate command.
 
MP4Err MP4AddIPMPToolDescriptorToUpdate (MP4Handle ipmpToolDescrUpdateH, MP4Handle ipmpToolDescrH)
 Adds an IPMP Tool Descriptor to IPMPToolDescriptorUpdate command.
 

Detailed Description

MPEG 4 IPMPX related functions.

Function Documentation

◆ MP4AddDescToMovieIOD()

MP4Err MP4AddDescToMovieIOD ( MP4Movie  theMovie,
MP4Handle  descriptorH 
)

Adds a descriptor to the movie IOD.

The descriptor can be an IPMP Tool List Descriptor.

◆ MP4AddIPMPDataToIPMPInitialize()

MP4Err MP4AddIPMPDataToIPMPInitialize ( MP4Handle  ipmpInitializeH,
MP4Handle  ipmpDataH 
)

Adds IPMP data to the IPMPInitialize structure.

Parameters
ipmpInitializeHHandle containing the IPMPInitialize structure. Can be created with the MP4NewIPMPInitialize() function.
ipmpDataHHandle containing the IPMP Data to insert in the IPMPInitalize structure.

◆ MP4AddIPMPDataToIPMPToolDescriptor()

MP4Err MP4AddIPMPDataToIPMPToolDescriptor ( MP4Handle  ipmpToolDescrH,
MP4Handle  ipmpDataH 
)

Adds IPMP data to an IPMP Tool Descriptor.

Parameters
ipmpToolDescrHHandle containing the IPMP Tool Descriptor. Can be created with the MP4NewIPMPToolDescriptor() function.
ipmpDataHHandle containing the IPMP Data to insert in the IPMP Tool Descriptor.

◆ MP4AddIPMPToolDescriptorToUpdate()

MP4Err MP4AddIPMPToolDescriptorToUpdate ( MP4Handle  ipmpToolDescrUpdateH,
MP4Handle  ipmpToolDescrH 
)

Adds an IPMP Tool Descriptor to IPMPToolDescriptorUpdate command.

Parameters
ipmpToolDescrUpdateHHandle containing the IPMPToolDescriptorUpdate command. Can be created with the MP4NewIPMPToolDescriptorUpdate() function.
ipmpToolDescrHHandle containing the IPMPToolDescriptor to insert in the command. Can be created with the MP4NewIPMPToolDescriptor() function.

◆ MP4NewIPMPDescriptorPointer()

MP4Err MP4NewIPMPDescriptorPointer ( MP4Handle  ipmpDescPtrH,
u8  ipmpDescriptorId,
u16  ipmpToolDescrId 
)

Creates a new IPMPDescriptorPointer.

Parameters
ipmpDescPtrHHandle containing the output IPMP Descriptor Pointer
ipmpDescriptorIdID of the output IPMP Descriptor Pointer
ipmpToolDescrIdID of the IPMP Tool Descriptor pointed by the output IPMP Descriptor Pointer

◆ MP4NewIPMPInitialize()

MP4Err MP4NewIPMPInitialize ( MP4Handle  ipmpInitializeH,
u8  controlPoint,
u8  sequenceCode 
)

Creates a new IPMPInitialize structure.

Parameters
ipmpInitializeHHandle containing the output IPMPInitialize structure
controlPointThe control Point Code can be one of the following:
  • MP4IPMP_NoControlPoint
  • MP4IPMP_DB_Decoder_ControlPoint
  • MP4IPMP_Decoder_CB_ControlPoint
  • MP4IPMP_CB_Compositor_ControlPoint
  • MP4IPMP_BIFSTree_ControlPoint
sequenceCodeThe higher the sequence code, the higher the sequencing priority of the IPMP tool instance at the given control point.

◆ MP4NewIPMPTool()

MP4Err MP4NewIPMPTool ( MP4Handle  ipmpToolH,
u64  ipmpToolIdLowerPart,
u64  ipmpToolIdUpperPart,
MP4Handle  altGroupInfoH,
MP4Handle  parametricInfoH 
)

Creates a new IPMPTool structure.

Parameters
ipmpToolHHandle containing the output IPMPTool structure
ipmpToolIdLowerPartFirst 64 bits of the 128bits IPMP Tool ID
ipmpToolIdUpperPartLast 64 bits of the 128bits IPMP Tool ID
altGroupInfoHCan be set to NULL if the IPMPTool has no alternate. Handle built as an u64[] array containing for example:
  • alternateTool1LowerPart
  • alternateTool1UpperPart
  • alternateTool2LowerPart
  • alternateTool2UpperPart
  • ...
parametricInfoHHandle containing the parametric information of the IPMPTool. Can be set to NULL if the tool is not parametric.

◆ MP4NewIPMPToolDescriptor()

MP4Err MP4NewIPMPToolDescriptor ( MP4Handle  ipmpToolDescH,
u16  ipmpToolDescrId,
u64  ipmpToolIdLowerPart,
u64  ipmpToolIdUpperPart,
MP4Handle  ipmpInitializeH 
)

Creates a new IPMP Tool Descriptor.

Parameters
ipmpToolDescHHandle containing the ouptut IPMP Tool Descriptor
ipmpToolDescrIdID of the output IPMP Tool Descriptor
ipmpToolIdLowerPartFirst 64 bits of the 128bits IPMP Tool ID
ipmpToolIdUpperPartLast 64 bits of the 128bits IPMP Tool ID
ipmpInitializeHHandle Containing the IPMPInitialize structure. Can be set to NULL if no IPMPInitialize structure is present.