getid3_ogg::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_ogg::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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

76–344

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

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 · 13 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost getid3_ogg::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 · 20

• getid3_ogg::warning()
• getid3_ogg::fseek()
• getid3_ogg::ParseOggPageHeader()
• getid3_ogg::ftell()
• getid3_ogg::error()
• getid3_ogg::fread()
• getid3_ogg::ParseVorbisPageHeader()
• getid3_ogg::ParseOpusPageHeader()
• getid3_lib::LittleEndian2Int()
• getid3_ogg::SpeexBandModeLookup()
• getid3_lib::BigEndian2Int()
• getid3_ogg::TheoraColorSpace()

Source code

View on Trac ↗View on GitHub ↗

29	public function Analyze() {30		$info = &$this->getid3->info;31 32		$info['fileformat'] = 'ogg';33 34		// Warn about illegal tags - only vorbiscomments are allowed35		if (isset($info['id3v2'])) {36			$this->warning('Illegal ID3v2 tag present.');37		}38		if (isset($info['id3v1'])) {39			$this->warning('Illegal ID3v1 tag present.');40		}41		if (isset($info['ape'])) {42			$this->warning('Illegal APE tag present.');43		}44 45 46		// Page 1 - Stream Header47 48		$this->fseek($info['avdataoffset']);49 50		$oggpageinfo = $this->ParseOggPageHeader();51		$info['ogg']['pageheader'][$oggpageinfo['page_seqno']] = $oggpageinfo;52 53		if ($this->ftell() >= $this->getid3->fread_buffer_size()) {54			$this->error('Could not find start of Ogg page in the first '.$this->getid3->fread_buffer_size().' bytes (this might not be an Ogg-Vorbis file?)');55			unset($info['fileformat']);56			unset($info['ogg']);57			return false;58		}59 60		$filedata = $this->fread($oggpageinfo['page_length']);61		$filedataoffset = 0;62 63		if (substr($filedata, 0, 4) == 'fLaC') {64 65			$info['audio']['dataformat']   = 'flac';66			$info['audio']['bitrate_mode'] = 'vbr';67			$info['audio']['lossless']     = true;68 69		} elseif (substr($filedata, 1, 6) == 'vorbis') {70 71			$this->ParseVorbisPageHeader($filedata, $filedataoffset, $oggpageinfo);72 73		} elseif (substr($filedata, 0, 8) == 'OpusHead') {74 75			if ($this->ParseOpusPageHeader($filedata, $filedataoffset, $oggpageinfo) === false) {76				return false;77			}78 79		} elseif (substr($filedata, 0, 8) == 'Speex   ') {80 81			// http://www.speex.org/manual/node10.html82 83			$info['audio']['dataformat']   = 'speex';84			$info['mime_type']             = 'audio/speex';85			$info['audio']['bitrate_mode'] = 'abr';86			$info['audio']['lossless']     = false;87 88			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['speex_string']           =                              substr($filedata, $filedataoffset, 8); // hard-coded to 'Speex   '89			$filedataoffset += 8;90			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['speex_version']          =                              substr($filedata, $filedataoffset, 20);91			$filedataoffset += 20;92			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['speex_version_id']       = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));93			$filedataoffset += 4;94			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['header_size']            = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));95			$filedataoffset += 4;96			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['rate']                   = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));97			$filedataoffset += 4;98			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['mode']                   = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));99			$filedataoffset += 4;100			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['mode_bitstream_version'] = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));101			$filedataoffset += 4;102			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['nb_channels']            = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));103			$filedataoffset += 4;104			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['bitrate']                = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));105			$filedataoffset += 4;106			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['framesize']              = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));107			$filedataoffset += 4;108			$info['ogg']['pageheader'][$oggpageinfo['page_seqno']]['vbr']                    = getid3_lib::LittleEndian2Int(substr($filedata, $filedataoffset, 4));

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.ogg.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.