getID3::analyze( string $filename, int $filesize = null, string $original_filename = '', resource $fp = null ): array

Compatibility

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

Parameters

$filenamestring

$filesizeintoptional

Default: null

$original_filenamestringoptional

Default: ''

$fpresourceoptional

Default: null

Return value

array

Performance profile

How much work a call to getID3::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

Heavy

Reads or writes the filesystem via fread().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

49–164

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

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 it touches

• filesystemfilesystem accessfread()called directly

What one call costs · 88 distinct outcomes

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

• getID3::openfile()
• getID3::include_module()
• getID3::warning()Warning handling.
• getid3_lib::BigEndian2Int()
• getID3::GetFileFormat()
• getID3::error()Error handling.
• getID3::HandleAllTags()
• getID3::ChannelsBitratePlaytimeCalculations()
• getID3::CalculateCompressionRatioVideo()
• getID3::CalculateCompressionRatioAudio()
• getID3::CalculateReplayGain()
• getID3::ProcessAudioStreams()

Source code

View on Trac ↗View on GitHub ↗

664	public function analyze($filename, $filesize=null, $original_filename='', $fp=null) {665		try {666			if (!$this->openfile($filename, $filesize, $fp)) {667				return $this->info;668			}669 670			// Handle tags671			foreach (array('id3v2'=>'id3v2', 'id3v1'=>'id3v1', 'apetag'=>'ape', 'lyrics3'=>'lyrics3') as $tag_name => $tag_key) {672				$option_tag = 'option_tag_'.$tag_name;673				if ($this->$option_tag) {674					$this->include_module('tag.'.$tag_name);675					try {676						$tag_class = 'getid3_'.$tag_name;677						$tag = new $tag_class($this);678						$tag->Analyze();679					}680					catch (getid3_exception $e) {681						throw $e;682					}683				} else {684					$this->warning('skipping check for '.$tag_name.' tags since option_tag_'.$tag_name.'=FALSE');685				}686			}687			if (isset($this->info['id3v2']['tag_offset_start'])) {688				$this->info['avdataoffset'] = max($this->info['avdataoffset'], $this->info['id3v2']['tag_offset_end']);689			}690			foreach (array('id3v1'=>'id3v1', 'apetag'=>'ape', 'lyrics3'=>'lyrics3') as $tag_name => $tag_key) {691				if (isset($this->info[$tag_key]['tag_offset_start'])) {692					$this->info['avdataend'] = min($this->info['avdataend'], $this->info[$tag_key]['tag_offset_start']);693				}694			}695 696			// ID3v2 detection (NOT parsing), even if ($this->option_tag_id3v2 == false) done to make fileformat easier697			if (!$this->option_tag_id3v2) {698				fseek($this->fp, 0);699				$header = fread($this->fp, 10);700				if ((substr($header, 0, 3) == 'ID3') && (strlen($header) == 10)) {701					$this->info['id3v2']['header']        = true;702					$this->info['id3v2']['majorversion']  = ord($header[3]);703					$this->info['id3v2']['minorversion']  = ord($header[4]);704					$this->info['avdataoffset']          += getid3_lib::BigEndian2Int(substr($header, 6, 4), 1) + 10; // length of ID3v2 tag in 10-byte header doesn't include 10-byte header length705				}706			}707 708			// read 32 kb file data709			fseek($this->fp, $this->info['avdataoffset']);710			$formattest = fread($this->fp, 32774);711 712			// determine format713			$determined_format = $this->GetFileFormat($formattest, ($original_filename ? $original_filename : $filename));714 715			// unable to determine file format716			if (!$determined_format) {717				fclose($this->fp);718				return $this->error('unable to determine file format');719			}720 721			// check for illegal ID3 tags722			if (isset($determined_format['fail_id3']) && (in_array('id3v1', $this->info['tags']) || in_array('id3v2', $this->info['tags']))) {723				if ($determined_format['fail_id3'] === 'ERROR') {724					fclose($this->fp);725					return $this->error('ID3 tags not allowed on this file type.');726				} elseif ($determined_format['fail_id3'] === 'WARNING') {727					$this->warning('ID3 tags not allowed on this file type.');728				}729			}730 731			// check for illegal APE tags732			if (isset($determined_format['fail_ape']) && in_array('ape', $this->info['tags'])) {733				if ($determined_format['fail_ape'] === 'ERROR') {734					fclose($this->fp);735					return $this->error('APE tags not allowed on this file type.');736				} elseif ($determined_format['fail_ape'] === 'WARNING') {737					$this->warning('APE tags not allowed on this file type.');738				}739			}740 741			// set mime type742			$this->info['mime_type'] = $determined_format['mime_type'];743

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/getid3.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.