getid3_riff::Analyze(): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

Performance profile

How much work a call to getid3_riff::Analyze() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

181–253

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 3918.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost getid3_riff::Analyze() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 39

• getid3_riff::fseek()
• getid3_riff::fread()
• getid3_riff::ftell()
• getid3_riff::warning()
• getid3_riff::EitherEndian2Int()
• getid3_riff::ParseRIFF()
• getid3_riff::error()
• getid3_riff::ParseRIFFAMV()
• getid3_riff::ParseDIVXTAG()
• getid3_lib::PrintHexBytes()
• getid3_riff::parseWAVEFORMATex()
• getid3_lib::array_merge_noclobber()

Source code

View on Trac ↗View on GitHub ↗

42	public function Analyze() {43		$info = &$this->getid3->info;44 45		// initialize these values to an empty array, otherwise they default to NULL46		// and you can't append array values to a NULL value47		$info['riff'] = array('raw'=>array());48 49		// Shortcuts50		$thisfile_riff             = &$info['riff'];51		$thisfile_riff_raw         = &$thisfile_riff['raw'];52		$thisfile_audio            = &$info['audio'];53		$thisfile_video            = &$info['video'];54		$thisfile_audio_dataformat = &$thisfile_audio['dataformat'];55		$thisfile_riff_audio       = &$thisfile_riff['audio'];56		$thisfile_riff_video       = &$thisfile_riff['video'];57		$thisfile_riff_WAVE        = array();58 59		$Original                 = array();60		$Original['avdataoffset'] = $info['avdataoffset'];61		$Original['avdataend']    = $info['avdataend'];62 63		$this->fseek($info['avdataoffset']);64		$RIFFheader = $this->fread(12);65		$offset = $this->ftell();66		$RIFFtype    = substr($RIFFheader, 0, 4);67		$RIFFsize    = substr($RIFFheader, 4, 4);68		$RIFFsubtype = substr($RIFFheader, 8, 4);69 70		if ($RIFFsize == "\x00\x00\x00\x00") {71			// https://github.com/JamesHeinrich/getID3/issues/46872			// may occur in streaming files where the data size is unknown73			$thisfile_riff['header_size'] = $info['avdataend'] - 8;74			$this->warning('RIFF size field is empty, assuming the correct value is filesize-8 ('.$thisfile_riff['header_size'].')');75		} else {76			$thisfile_riff['header_size'] = $this->EitherEndian2Int($RIFFsize);77		}78 79		switch ($RIFFtype) {80			case 'FORM':  // AIFF, AIFC81				//$info['fileformat']   = 'aiff';82				$this->container = 'aiff';83				$thisfile_riff[$RIFFsubtype]  = $this->ParseRIFF($offset, ($offset + $thisfile_riff['header_size'] - 4));84				break;85 86			case 'RIFF':  // AVI, WAV, etc87			case 'SDSS':  // SDSS is identical to RIFF, just renamed. Used by SmartSound QuickTracks (www.smartsound.com)88			case 'RMP3':  // RMP3 is identical to RIFF, just renamed. Used by [unknown program] when creating RIFF-MP3s89				//$info['fileformat']   = 'riff';90				$this->container = 'riff';91				if ($RIFFsubtype == 'RMP3') {92					// RMP3 is identical to WAVE, just renamed. Used by [unknown program] when creating RIFF-MP3s93					$RIFFsubtype = 'WAVE';94				}95				if ($RIFFsubtype != 'AMV ') {96					// AMV files are RIFF-AVI files with parts of the spec deliberately broken, such as chunk size fields hardcoded to zero (because players known in hardware that these fields are always a certain size97					// Handled separately in ParseRIFFAMV()98					$thisfile_riff[$RIFFsubtype]  = $this->ParseRIFF($offset, ($offset + $thisfile_riff['header_size'] - 4));99				}100				if (($info['avdataend'] - $info['filesize']) == 1) {101					// LiteWave appears to incorrectly *not* pad actual output file102					// to nearest WORD boundary so may appear to be short by one103					// byte, in which case - skip warning104					$info['avdataend'] = $info['filesize'];105				}106 107				$nextRIFFoffset = (int) $Original['avdataoffset'] + 8 + (int) $thisfile_riff['header_size']; // 8 = "RIFF" + 32-bit offset108				while ($nextRIFFoffset < min($info['filesize'], $info['avdataend'])) {109					try {110						$this->fseek($nextRIFFoffset);111					} catch (getid3_exception $e) {112						if ($e->getCode() == 10) {113							//$this->warning('RIFF parser: '.$e->getMessage());114							$this->error('AVI extends beyond '.round(PHP_INT_MAX / 1073741824).'GB and PHP filesystem functions cannot read that far, playtime may be wrong');115							$this->warning('[avdataend] value may be incorrect, multiple AVIX chunks may be present');116							break;117						} else {118							throw $e;119						}120					}121					$nextRIFFheader = $this->fread(12);

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ID3/module.audio-video.riff.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.