getid3_lyrics3::getLyrics3Data( int $endoffset, int $version, int $length ): 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

$endoffsetint

$versionint

$lengthint

Return value

bool

Performance profile

How much work a call to getid3_lyrics3::getLyrics3Data() 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

14–149

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

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

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

Uses · 9

• getid3_lib::intValueSupported()
• getid3_lyrics3::warning()
• getid3_lyrics3::fseek()
• getid3_lyrics3::fread()
• getid3_lyrics3::error()
• getid3_lyrics3::Lyrics3LyricsTimestampParse()
• getid3_lyrics3::ftell()
• getid3_lyrics3::IntString2Bool()
• getid3_lyrics3::Lyrics3Timestamp2Seconds()

Used by · 1

• getid3_lyrics3::Analyze()

Source code

View on Trac ↗View on GitHub ↗

147	public function getLyrics3Data($endoffset, $version, $length) {148		// http://www.volweb.cz/str/tags.htm149 150		$info = &$this->getid3->info;151 152		if (!getid3_lib::intValueSupported($endoffset)) {153			$this->warning('Unable to check for Lyrics3 because file is larger than '.round(PHP_INT_MAX / 1073741824).'GB');154			return false;155		}156 157		$this->fseek($endoffset);158		if ($length <= 0) {159			return false;160		}161		$rawdata = $this->fread($length);162 163		$ParsedLyrics3 = array();164 165		$ParsedLyrics3['raw']['lyrics3version'] = $version;166		$ParsedLyrics3['raw']['lyrics3tagsize'] = $length;167		$ParsedLyrics3['tag_offset_start']      = $endoffset;168		$ParsedLyrics3['tag_offset_end']        = $endoffset + $length - 1;169 170		if (substr($rawdata, 0, 11) != 'LYRICSBEGIN') {171			if (strpos($rawdata, 'LYRICSBEGIN') !== false) {172 173				$this->warning('"LYRICSBEGIN" expected at '.$endoffset.' but actually found at '.($endoffset + strpos($rawdata, 'LYRICSBEGIN')).' - this is invalid for Lyrics3 v'.$version);174				$info['avdataend'] = $endoffset + strpos($rawdata, 'LYRICSBEGIN');175				$rawdata = substr($rawdata, strpos($rawdata, 'LYRICSBEGIN'));176				$length = strlen($rawdata);177				$ParsedLyrics3['tag_offset_start'] = $info['avdataend'];178				$ParsedLyrics3['raw']['lyrics3tagsize'] = $length;179 180			} else {181 182				$this->error('"LYRICSBEGIN" expected at '.$endoffset.' but found "'.substr($rawdata, 0, 11).'" instead');183				return false;184 185			}186 187		}188 189		switch ($version) {190 191			case 1:192				if (substr($rawdata, strlen($rawdata) - 9, 9) == 'LYRICSEND') {193					$ParsedLyrics3['raw']['LYR'] = trim(substr($rawdata, 11, strlen($rawdata) - 11 - 9));194					$this->Lyrics3LyricsTimestampParse($ParsedLyrics3);195				} else {196					$this->error('"LYRICSEND" expected at '.($this->ftell() - 11 + $length - 9).' but found "'.substr($rawdata, strlen($rawdata) - 9, 9).'" instead');197					return false;198				}199				break;200 201			case 2:202				if (substr($rawdata, strlen($rawdata) - 9, 9) == 'LYRICS200') {203					$ParsedLyrics3['raw']['unparsed'] = substr($rawdata, 11, strlen($rawdata) - 11 - 9 - 6); // LYRICSBEGIN + LYRICS200 + LSZ204					$rawdata = $ParsedLyrics3['raw']['unparsed'];205					while (strlen($rawdata) > 0) {206						$fieldname = substr($rawdata, 0, 3);207						$fieldsize = (int) substr($rawdata, 3, 5);208						$ParsedLyrics3['raw'][$fieldname] = substr($rawdata, 8, $fieldsize);209						$rawdata = substr($rawdata, 3 + 5 + $fieldsize);210					}211 212					if (isset($ParsedLyrics3['raw']['IND'])) {213						$i = 0;214						$flagnames = array('lyrics', 'timestamps', 'inhibitrandom');215						foreach ($flagnames as $flagname) {216							if (strlen($ParsedLyrics3['raw']['IND']) > $i++) {217								$ParsedLyrics3['flags'][$flagname] = $this->IntString2Bool(substr($ParsedLyrics3['raw']['IND'], $i, 1 - 1));218							}219						}220					}221 222					$fieldnametranslation = array('ETT'=>'title', 'EAR'=>'artist', 'EAL'=>'album', 'INF'=>'comment', 'AUT'=>'author');223					foreach ($fieldnametranslation as $key => $value) {224						if (isset($ParsedLyrics3['raw'][$key])) {225							$ParsedLyrics3['comments'][$value][] = trim($ParsedLyrics3['raw'][$key]);226						}

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