DASHIF\ModuleInterface Class Reference

Inheritance diagram for DASHIF\ModuleInterface:

Public Member Functions
	handleArguments ()
	detectFromManifest ()
	isEnabled ()
	setEnabled ($newVal)
	hookBeforeMPD ()
	Checks if pre-conditions for MPD Validation are met. More...
	hookMPD ()
	hookBeforeRepresentation ()
	hookRepresentation ()
	hookBeforeAdaptationSet ()
	hookAdaptationSet ()
	hookPeriod ()
	hookLiveMpd ($mpd, $nextMpd)

Public Attributes
	$name
	$detected

Protected Member Functions
	addCLIArguments ()
	message ($message)

Protected Attributes
	$enabled
	$messages
	$warnings
	$errors

Detailed Description

Initial description of the interface for the various modules

Member Function Documentation

hookAdaptationSet()

DASHIF\ModuleInterface::hookAdaptationSet

(

)

A hook that is run after running a crossRepresentationProcess. Return value is added to the same array as hookBeforeRepresentation. Return values are ignored.

Module Usage

• CMAF (!!hookAll!!)
  • Runs checks on the presentation
    • Selectionset
    • AlignedSwitchingSets
  • Returns an array of errors.
• CTAWAVE
  • Runs SelectionSet checks
  • Runs Presentation checks
  • No return value
• HBBTV_DVB
  • Creates a content protection report
  • Runs crossvalidation over the adaptation sets.
  • No return value
• IOP
  • Runs crossvalidation over the adaptation sets.
  • No return value
• LOW_LATENCY
  • Runs crossvalidation over the adaptation sets.
  • No return value

Reimplemented in DASHIF\ModuleHbbTVDVB, DASHIF\ModuleDASHLowLatency, DASHIF\ModuleDASHInteroperability, and DASHIF\ModuleCMAF.

hookBeforeAdaptationSet()

DASHIF\ModuleInterface::hookBeforeAdaptationSet

(

)

A hook that is run after running a crossRepresentationProcess. Return value is added to the same array as hookBeforeRepresentation.

Module Usage

• HBBTV_DVB
  • Calls a function that removes images from an html file, leaving the html crippled.
• CMAF (!!hookAdaptationSet!!)
  • Compares switching sets against eachother, writes report report to txt file
  • Returns an array of errors.

Reimplemented in DASHIF\ModuleHbbTVDVB, DASHIF\ModuleCTAWAVE, and DASHIF\ModuleCMAF.

hookBeforeMPD()

DASHIF\ModuleInterface::hookBeforeMPD

(

)

Checks if pre-conditions for MPD Validation are met.

This hook is run between loading the MPD DOM and checking the validity of it.

Returns

TRUE if all checks succeeded or no checks are done, FALSE otherwise.

Module Usage

• HBBTV_DVB
  • Copies some scripts to the session folder (these are not used at this point)
  • !!Re-downloads mpd!!
  • Checks maximum allowed size of mpd (before xlink resolution)
  • Checks maximum amount of periods (before xlink resolution)
  • Writes errors to $mpd_log.txt
  • No return value.

Reimplemented in DASHIF\ModuleHbbTVDVB.

hookBeforeRepresentation()

DASHIF\ModuleInterface::hookBeforeRepresentation

(

)

A hook that is run before downloading and validating the first segment of each period-adaptationset combination. Return value is ignored

Module Usage

• CMAF
  • Unconditionally appends to the $additional_flags global parameter
  • No return value
• CTAWAVE (!!hookTracks!!)
  • Unconditionally appends to the $additional_flags global parameter
  • No return value
• HBBTV_DVB
  • Conditionally appends to the $additional_flags global parameter
  • Returns whether the current representation is a subtitle.
    • Creates a folder for the subtitles if any subtitle representation is found.

Reimplemented in DASHIF\ModuleHbbTVDVB, DASHIF\ModuleCTAWAVE, and DASHIF\ModuleCMAF.

hookMPD()

DASHIF\ModuleInterface::hookMPD

(

)

A hook that is run between validating the MPD DOM, and reporting on it. Validity check of MPD DOM is ignored when running these hooks. Result Values are used in reporting on the MPD.

Module Usage

• HBBTV_DVB
  • Attempts to open $mpd_log.txt, if unsuccessfull no check are done and returns 'undefined'
  • Runs common checks, saving to mpd_log
  • Runs conditional checks for dvb and hbbtv, saving to mpd_log
  • Reads contents of the entire mpd_log file, and retrurns based on its contents.
    • !!This ASSUMES no other modules use the same file and inserts checked sequences.!!
    • If '###' is found anywhere in the file, return "error"
    • Otherwise, if 'Warning' is found anywhere in the file, return "warning"
    • Return true otherwise.
  • Reads xml from mpd_xml_report, saves the return value, then writes it back in whole.
• IOP
  • Attempts to open $mpd_log.txt, if unsuccessfull no check are done and returns 'undefined'
  • Runs conditional conformance checks and saves them to mpd_log
  • Reads contents of the entire mpd_log file, and retrurns based on its contents.
    • !!This ASSUMES no other modules use the same file and inserts checked sequences.!!
    • If 'DASH-IF IOP 4.3 check violated' if found in the file, return "error"
      • This does not occur for messages generated by IOP_ValidateMPD_Common()
    • Return true otherwise
  • Reads xml from mpd_xml_report, saves the return value, then writes it back in whole.
• LOW_LATENCY
  • Attempts to open $mpd_log.txt, if unsuccessfull no check are done and returns 'undefined'
  • Runs conformance checks and saves them to mpd_log
  • Reads contents of the temporary internal buffer, and retrurns based on its contents.
    • If 'violated' is found in the internal buffer, return "error"
    • Else, if 'warning' is found in the internal buffer, return "warning"
    • Else return true
  • Reads xml from mpd_xml_report, saves the return value, then writes it back in whole.

Reimplemented in DASHIF\ModuleHbbTVDVB, DASHIF\ModuleDASHLowLatency, and DASHIF\ModuleDASHInteroperability.

hookPeriod()

DASHIF\ModuleInterface::hookPeriod

(

)

Is called after all the periods have been parsed. Return value is ignored.

Module Usage

• CTAWAVE
  • Runs splice point checks
  • Runs wave program checks
  • No return value

Reimplemented in DASHIF\ModuleCTAWAVE.

hookRepresentation()

DASHIF\ModuleInterface::hookRepresentation

(

)

A hook that is run after downloading and validating the first segment of each period-adaptationset combination. Return value is added to an unnamed aray and used for reporting.

Module Usage

• CMAF
  • Only if representation xml exists:
    • Creates a file for writing errors/logs for the current representation.
    • Runs various checks, and writes their output to the error/log file.
  • Returns an array with 1 element, either 'noerror' 'warning' or 'error' depending on the contents of the error/log file.
• HBBTV_DVB
  • Creates a file for writing errors/logs for the current representation.
  • Runs various checks, and writes their output to the error/log file.
  • Adds images to the global $string_info variable
    • Duplicated html ids when called on a stream with multiple representations
    • Remove option of add_remove_images is completely broken.
  • Returns an array with 1 element, either 'noerror' 'warning' or 'error' depending on the contents of the error/log file.
• IOP
  • Runs only if representation xml file exists
  • Runs checks, saves in internal buffer
  • Writes internal buffer to error/log file
  • Reads error/log file for returncode parsing
  • Returns an array with 1 element, either 'noerror' 'warning' or 'error' depending on the contents of the error/log file.

Reimplemented in DASHIF\ModuleWaveHLSInterop, DASHIF\ModuleHbbTVDVB, DASHIF\ModuleDolby, DASHIF\ModuleDASHInteroperability, and DASHIF\ModuleCMAF.

---

The documentation for this class was generated from the following file:

• Utils/moduleInterface.php