getid3_id3v2::ParseID3v2Frame( array $parsedFrame ): bool

Compatibility

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

Parameters

$parsedFramearray

Return value

bool

Performance profile

How much work a call to getid3_id3v2::ParseID3v2Frame() 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 what you pass in.

Instructions

156–302

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 10 distinct outcomes

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

• getid3_id3v2::FrameNameLongLookup()
• getid3_id3v2::FrameNameShortLookup()
• getid3_id3v2::DeUnsynchronise()
• getid3_lib::BigEndian2Int()
• getid3_id3v2::warning()
• getid3_id3v2::TextEncodingTerminatorLookup()
• getid3_id3v2::MakeUTF16emptyStringEmpty()
• getid3_id3v2::TextEncodingNameLookup()
• getid3_lib::iconv_fallback()
• getid3_id3v2::RemoveStringTerminator()
• getid3_id3v2::ETCOEventLookup()
• getid3_lib::BigEndian2Bin()

Used by · 1

• getid3_id3v2::Analyze()

Source code

View on Trac ↗View on GitHub ↗

569	public function ParseID3v2Frame(&$parsedFrame) {570 571		// shortcuts572		$info = &$this->getid3->info;573		$id3v2_majorversion = $info['id3v2']['majorversion'];574 575		$parsedFrame['framenamelong']  = $this->FrameNameLongLookup($parsedFrame['frame_name']);576		if (empty($parsedFrame['framenamelong'])) {577			unset($parsedFrame['framenamelong']);578		}579		$parsedFrame['framenameshort'] = $this->FrameNameShortLookup($parsedFrame['frame_name']);580		if (empty($parsedFrame['framenameshort'])) {581			unset($parsedFrame['framenameshort']);582		}583 584		if ($id3v2_majorversion >= 3) { // frame flags are not part of the ID3v2.2 standard585			if ($id3v2_majorversion == 3) {586				//    Frame Header Flags587				//    %abc00000 %ijk00000588				$parsedFrame['flags']['TagAlterPreservation']  = (bool) ($parsedFrame['frame_flags_raw'] & 0x8000); // a - Tag alter preservation589				$parsedFrame['flags']['FileAlterPreservation'] = (bool) ($parsedFrame['frame_flags_raw'] & 0x4000); // b - File alter preservation590				$parsedFrame['flags']['ReadOnly']              = (bool) ($parsedFrame['frame_flags_raw'] & 0x2000); // c - Read only591				$parsedFrame['flags']['compression']           = (bool) ($parsedFrame['frame_flags_raw'] & 0x0080); // i - Compression592				$parsedFrame['flags']['Encryption']            = (bool) ($parsedFrame['frame_flags_raw'] & 0x0040); // j - Encryption593				$parsedFrame['flags']['GroupingIdentity']      = (bool) ($parsedFrame['frame_flags_raw'] & 0x0020); // k - Grouping identity594 595			} elseif ($id3v2_majorversion == 4) {596				//    Frame Header Flags597				//    %0abc0000 %0h00kmnp598				$parsedFrame['flags']['TagAlterPreservation']  = (bool) ($parsedFrame['frame_flags_raw'] & 0x4000); // a - Tag alter preservation599				$parsedFrame['flags']['FileAlterPreservation'] = (bool) ($parsedFrame['frame_flags_raw'] & 0x2000); // b - File alter preservation600				$parsedFrame['flags']['ReadOnly']              = (bool) ($parsedFrame['frame_flags_raw'] & 0x1000); // c - Read only601				$parsedFrame['flags']['GroupingIdentity']      = (bool) ($parsedFrame['frame_flags_raw'] & 0x0040); // h - Grouping identity602				$parsedFrame['flags']['compression']           = (bool) ($parsedFrame['frame_flags_raw'] & 0x0008); // k - Compression603				$parsedFrame['flags']['Encryption']            = (bool) ($parsedFrame['frame_flags_raw'] & 0x0004); // m - Encryption604				$parsedFrame['flags']['Unsynchronisation']     = (bool) ($parsedFrame['frame_flags_raw'] & 0x0002); // n - Unsynchronisation605				$parsedFrame['flags']['DataLengthIndicator']   = (bool) ($parsedFrame['frame_flags_raw'] & 0x0001); // p - Data length indicator606 607				// Frame-level de-unsynchronisation - ID3v2.4608				if ($parsedFrame['flags']['Unsynchronisation']) {609					$parsedFrame['data'] = $this->DeUnsynchronise($parsedFrame['data']);610				}611 612				if ($parsedFrame['flags']['DataLengthIndicator']) {613					$parsedFrame['data_length_indicator'] = getid3_lib::BigEndian2Int(substr($parsedFrame['data'], 0, 4), 1);614					$parsedFrame['data']                  =                           substr($parsedFrame['data'], 4);615				}616			}617 618			//    Frame-level de-compression619			if ($parsedFrame['flags']['compression']) {620				$parsedFrame['decompressed_size'] = getid3_lib::BigEndian2Int(substr($parsedFrame['data'], 0, 4));621				if (!function_exists('gzuncompress')) {622					$this->warning('gzuncompress() support required to decompress ID3v2 frame "'.$parsedFrame['frame_name'].'"');623				} else {624					if ($decompresseddata = @gzuncompress(substr($parsedFrame['data'], 4))) {625					//if ($decompresseddata = @gzuncompress($parsedFrame['data'])) {626						$parsedFrame['data'] = $decompresseddata;627						unset($decompresseddata);628					} else {629						$this->warning('gzuncompress() failed on compressed contents of ID3v2 frame "'.$parsedFrame['frame_name'].'"');630					}631				}632			}633		}634 635		if (!empty($parsedFrame['flags']['DataLengthIndicator'])) {636			if ($parsedFrame['data_length_indicator'] != strlen($parsedFrame['data'])) {637				$this->warning('ID3v2 frame "'.$parsedFrame['frame_name'].'" should be '.$parsedFrame['data_length_indicator'].' bytes long according to DataLengthIndicator, but found '.strlen($parsedFrame['data']).' bytes of data');638			}639		}640 641		if (isset($parsedFrame['datalength']) && ($parsedFrame['datalength'] == 0)) {642 643			$warning = 'Frame "'.$parsedFrame['frame_name'].'" at offset '.$parsedFrame['dataoffset'].' has no data portion';644			switch ($parsedFrame['frame_name']) {645				case 'WCOM':646					$warning .= ' (this is known to happen with files tagged by RioPort)';647					break;648

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.tag.id3v2.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.