enmi-conf.org: comparison wp/wp-includes/ID3/module.audio-video.matroska.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 <?php
 /////////////////////////////////////////////////////////////////
 /// getID3() by James Heinrich <info@getid3.org>               //
-//  available at http://getid3.sourceforge.net                 //
+//  available at https://github.com/JamesHeinrich/getID3       //
-//            or http://www.getid3.org                         //
+//            or https://www.getid3.org                        //
-//          also https://github.com/JamesHeinrich/getID3       //
+//            or http://getid3.sourceforge.net                 //
-/////////////////////////////////////////////////////////////////
+//  see readme.txt for more details                            //
-// See readme.txt for more details                             //
 /////////////////////////////////////////////////////////////////
 //                                                             //
 // module.audio-video.matriska.php                             //
 // module for analyzing Matroska containers                    //
 // dependencies: NONE                                          //
 //                                                            ///
 /////////////////////////////////////////////////////////////////
+if (!defined('GETID3_INCLUDEPATH')) { // prevent path-exposing attacks that access modules directly on public webservers
+	exit;
+}
 define('EBML_ID_CHAPTERS',                  0x0043A770); // [10][43][A7][70] -- A system to define basic menus and partition data. For more detailed information, look at the Chapters Explanation.
 define('EBML_ID_SEEKHEAD',                  0x014D9B74); // [11][4D][9B][74] -- Contains the position of other level 1 elements.
 define('EBML_ID_TAGS',                      0x0254C367); // [12][54][C3][67] -- Element containing elements specific to Tracks/Chapters. A list of valid tags can be found <http://www.matroska.org/technical/specs/tagging/index.html>.
 define('EBML_ID_INFO',                      0x0549A966); // [15][49][A9][66] -- Contains miscellaneous general information and statistics on the file.
 define('EBML_ID_FILENAME',                      0x066E); //         [46][6E] -- Filename of the attached file.
 define('EBML_ID_FILEREFERRAL',                  0x0675); //         [46][75] -- A binary value that a track/codec can refer to when the attachment is needed.
 define('EBML_ID_FILEDESCRIPTION',               0x067E); //         [46][7E] -- A human-friendly name for the attached file.
 define('EBML_ID_FILEUID',                       0x06AE); //         [46][AE] -- Unique ID representing the file, as random as possible.
 define('EBML_ID_CONTENTENCALGO',                0x07E1); //         [47][E1] -- The encryption algorithm used. The value '0' means that the contents have not been encrypted but only signed. Predefined values:
-define('EBML_ID_CONTENTENCKEYID',               0x07E2); //         [47][E2] -- For public key algorithms this is the ID of the public key the the data was encrypted with.
+define('EBML_ID_CONTENTENCKEYID',               0x07E2); //         [47][E2] -- For public key algorithms this is the ID of the public key the data was encrypted with.
 define('EBML_ID_CONTENTSIGNATURE',              0x07E3); //         [47][E3] -- A cryptographic signature of the contents.
 define('EBML_ID_CONTENTSIGKEYID',               0x07E4); //         [47][E4] -- This is the ID of the private key the data was signed with.
 define('EBML_ID_CONTENTSIGALGO',                0x07E5); //         [47][E5] -- The algorithm used for the signature. A value of '0' means that the contents have not been signed but only encrypted. Predefined values:
 define('EBML_ID_CONTENTSIGHASHALGO',            0x07E6); //         [47][E6] -- The hash algorithm used for the signature. A value of '0' means that the contents have not been signed but only encrypted. Predefined values:
 define('EBML_ID_MUXINGAPP',                     0x0D80); //         [4D][80] -- Muxing application or library ("libmatroska-0.4.3").
 * @todo Rewrite EBML parser to reduce it's size and honor default element values
 * @todo After rewrite implement stream size calculation, that will provide additional useful info and enable AAC/FLAC audio bitrate detection
 */
 class getid3_matroska extends getid3_handler
 {
-	// public options
+	/**
-	public static $hide_clusters    = true;  // if true, do not return information about CLUSTER chunks, since there's a lot of them and they're not usually useful [default: TRUE]
+	 * If true, do not return information about CLUSTER chunks, since there's a lot of them
-	public static $parse_whole_file = false; // true to parse the whole file, not only header [default: FALSE]
+	 * and they're not usually useful [default: TRUE].
+	 *
-	// private parser settings/placeholders
+	 * @var bool
+	 */
+	public static $hide_clusters    = true;
+	/**
+	 * True to parse the whole file, not only header [default: FALSE].
+	 *
+	 * @var bool
+	 */
+	public static $parse_whole_file = false;
+	/*
+	 * Private parser settings/placeholders.
+	 */
 	private $EBMLbuffer        = '';
 	private $EBMLbuffer_offset = 0;
 	private $EBMLbuffer_length = 0;
 	private $current_offset    = 0;
 	private $unuseful_elements = array(EBML_ID_CRC32, EBML_ID_VOID);
+	/**
+	 * @return bool
+	 */
 	public function Analyze()
 	{
 		$info = &$this->getid3->info;
 		// parse container
 								}
 								$info['matroska']['track_codec_parsed'][$trackarray['TrackNumber']] = $h264;
 								break;*/
 						}
-						$info['video']['streams'][] = $track_info;
+						$info['video']['streams'][$trackarray['TrackUID']] = $track_info;
 						break;
 					case 2: // Audio
 						$track_info['sample_rate'] = (isset($trackarray['SamplingFrequency']) ? $trackarray['SamplingFrequency'] : 8000.0);
 						$track_info['channels']    = (isset($trackarray['Channels']) ? $trackarray['Channels'] : 1);
 						if (isset($trackarray['CodecName'])) { $track_info['codec']           = $trackarray['CodecName']; }
 						switch ($trackarray['CodecID']) {
 							case 'A_PCM/INT/LIT':
 							case 'A_PCM/INT/BIG':
-								$track_info['bitrate'] = $trackarray['SamplingFrequency'] * $trackarray['Channels'] * $trackarray['BitDepth'];
+								$track_info['bitrate'] = $track_info['sample_rate'] * $track_info['channels'] * $trackarray['BitDepth'];
 								break;
 							case 'A_AC3':
 							case 'A_EAC3':
 							case 'A_DTS':
 								}
 								// create temp instance
 								$getid3_temp = new getID3();
 								if ($track_info['dataformat'] != 'flac') {
-									$getid3_temp->openfile($this->getid3->filename);
+									$getid3_temp->openfile($this->getid3->filename, $this->getid3->info['filesize'], $this->getid3->fp);
 								}
 								$getid3_temp->info['avdataoffset'] = $info['matroska']['track_data_offsets'][$trackarray['TrackNumber']]['offset'];
 								if ($track_info['dataformat'][0] == 'm' || $track_info['dataformat'] == 'flac') {
 									$getid3_temp->info['avdataend'] = $info['matroska']['track_data_offsets'][$trackarray['TrackNumber']]['offset'] + $info['matroska']['track_data_offsets'][$trackarray['TrackNumber']]['length'];
 								}
 									$getid3_audio->Analyze();
 								}
 								if (!empty($getid3_temp->info[$header_data_key])) {
 									$info['matroska']['track_codec_parsed'][$trackarray['TrackNumber']] = $getid3_temp->info[$header_data_key];
 									if (isset($getid3_temp->info['audio']) && is_array($getid3_temp->info['audio'])) {
-										foreach ($getid3_temp->info['audio'] as $key => $value) {
+										foreach ($getid3_temp->info['audio'] as $sub_key => $value) {
-											$track_info[$key] = $value;
+											$track_info[$sub_key] = $value;
 										}
 									}
 								}
 								else {
 									$this->warning('Unable to parse audio data ['.basename(__FILE__).':'.__LINE__.'] because '.$class.'::Analyze() failed at offset '.$getid3_temp->info['avdataoffset']);
 								$oggpageinfo['page_seqno'] = 0;
 								$getid3_ogg->ParseVorbisPageHeader($trackarray['CodecPrivate'], $vorbis_offset, $oggpageinfo);
 								if (!empty($getid3_temp->info['ogg'])) {
 									$info['matroska']['track_codec_parsed'][$trackarray['TrackNumber']] = $getid3_temp->info['ogg'];
 									if (isset($getid3_temp->info['audio']) && is_array($getid3_temp->info['audio'])) {
-										foreach ($getid3_temp->info['audio'] as $key => $value) {
+										foreach ($getid3_temp->info['audio'] as $sub_key => $value) {
-											$track_info[$key] = $value;
+											$track_info[$sub_key] = $value;
 										}
 									}
 								}
 								// copy errors and warnings
 							case 'A_MS/ACM':
 								getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.audio-video.riff.php', __FILE__, true);
 								$parsed = getid3_riff::parseWAVEFORMATex($trackarray['CodecPrivate']);
-								foreach ($parsed as $key => $value) {
+								foreach ($parsed as $sub_key => $value) {
-									if ($key != 'raw') {
+									if ($sub_key != 'raw') {
-										$track_info[$key] = $value;
+										$track_info[$sub_key] = $value;
 									}
 								}
 								$info['matroska']['track_codec_parsed'][$trackarray['TrackNumber']] = $parsed;
 								break;
 							default:
 								$this->warning('Unhandled audio type "'.(isset($trackarray['CodecID']) ? $trackarray['CodecID'] : '').'"');
 								break;
 						}
-						$info['audio']['streams'][] = $track_info;
+						$info['audio']['streams'][$trackarray['TrackUID']] = $track_info;
 						break;
 				}
 			}
 			if (!empty($info['video']['streams'])) {
 			$info['mime_type'] = ($info['matroska']['doctype'] == 'webm' ? 'audio/webm' : 'audio/x-matroska');
 		} elseif (isset($info['mime_type'])) {
 			unset($info['mime_type']);
 		}
+		// use _STATISTICS_TAGS if available to set audio/video bitrates
+		if (!empty($info['matroska']['tags'])) {
+			$_STATISTICS_byTrackUID = array();
+			foreach ($info['matroska']['tags'] as $key1 => $value1) {
+				if (!empty($value1['Targets']['TagTrackUID'][0]) && !empty($value1['SimpleTag'])) {
+					foreach ($value1['SimpleTag'] as $key2 => $value2) {
+						if (!empty($value2['TagName']) && isset($value2['TagString'])) {
+							$_STATISTICS_byTrackUID[$value1['Targets']['TagTrackUID'][0]][$value2['TagName']] = $value2['TagString'];
+						}
+					}
+				}
+			}
+			foreach (array('audio','video') as $avtype) {
+				if (!empty($info[$avtype]['streams'])) {
+					foreach ($info[$avtype]['streams'] as $trackUID => $trackdata) {
+						if (!isset($trackdata['bitrate']) && !empty($_STATISTICS_byTrackUID[$trackUID]['BPS'])) {
+							$info[$avtype]['streams'][$trackUID]['bitrate'] = (int) $_STATISTICS_byTrackUID[$trackUID]['BPS'];
+							@$info[$avtype]['bitrate'] += $info[$avtype]['streams'][$trackUID]['bitrate'];
+						}
+					}
+				}
+			}
+		}
 		return true;
 	}
+	/**
+	 * @param array $info
+	 */
 	private function parseEBML(&$info) {
 		// http://www.matroska.org/technical/specs/index.html#EBMLBasics
 		$this->current_offset = $info['avdataoffset'];
 		while ($this->getEBMLelement($top_element, $info['avdataend'])) {
 										case EBML_ID_TRACKENTRY: //subelements: Describes a track with all elements.
 											while ($this->getEBMLelement($subelement, $track_entry['end'], array(EBML_ID_VIDEO, EBML_ID_AUDIO, EBML_ID_CONTENTENCODINGS, EBML_ID_CODECPRIVATE))) {
 												switch ($subelement['id']) {
+													case EBML_ID_TRACKUID:
+														$track_entry[$subelement['id_name']] = getid3_lib::PrintHexBytes($subelement['data'], true, false);
+														break;
 													case EBML_ID_TRACKNUMBER:
-													case EBML_ID_TRACKUID:
 													case EBML_ID_TRACKTYPE:
 													case EBML_ID_MINCACHE:
 													case EBML_ID_MAXCACHE:
 													case EBML_ID_MAXBLOCKADDITIONID:
 													case EBML_ID_DEFAULTDURATION: // nanoseconds per frame
 																case EBML_ID_TAGTRACKUID:
 																case EBML_ID_TAGEDITIONUID:
 																case EBML_ID_TAGCHAPTERUID:
 																case EBML_ID_TAGATTACHMENTUID:
-																	$targets_entry[$sub_sub_subelement['id_name']][] = getid3_lib::BigEndian2Int($sub_sub_subelement['data']);
+																	$targets_entry[$sub_sub_subelement['id_name']][] = getid3_lib::PrintHexBytes($sub_sub_subelement['data'], true, false);
 																	break;
 																default:
 																	$this->unhandledElement('tags.tag.targets', __LINE__, $sub_sub_subelement);
 																	break;
 					break;
 			}
 		}
 	}
+	/**
+	 * @param int $min_data
+	 *
+	 * @return bool
+	 */
 	private function EnsureBufferHasEnoughData($min_data=1024) {
 		if (($this->current_offset - $this->EBMLbuffer_offset) >= ($this->EBMLbuffer_length - $min_data)) {
 			$read_bytes = max($min_data, $this->getid3->fread_buffer_size());
 			try {
 			}
 		}
 		return true;
 	}
+	/**
+	 * @return int|float|false
+	 */
 	private function readEBMLint() {
 		$actual_offset = $this->current_offset - $this->EBMLbuffer_offset;
 		// get length of integer
 		$first_byte_int = ord($this->EBMLbuffer[$actual_offset]);
 		$this->current_offset += $length;
 		return $int_value;
 	}
+	/**
+	 * @param int  $length
+	 * @param bool $check_buffer
+	 *
+	 * @return string|false
+	 */
 	private function readEBMLelementData($length, $check_buffer=false) {
 		if ($check_buffer && !$this->EnsureBufferHasEnoughData($length)) {
 			return false;
 		}
 		$data = substr($this->EBMLbuffer, $this->current_offset - $this->EBMLbuffer_offset, $length);
 		$this->current_offset += $length;
 		return $data;
 	}
+	/**
+	 * @param array      $element
+	 * @param int        $parent_end
+	 * @param array|bool $get_data
+	 *
+	 * @return bool
+	 */
 	private function getEBMLelement(&$element, $parent_end, $get_data=false) {
 		if ($this->current_offset >= $parent_end) {
 			return false;
 		}
 		}
 		return true;
 	}
+	/**
+	 * @param string $type
+	 * @param int    $line
+	 * @param array  $element
+	 */
 	private function unhandledElement($type, $line, $element) {
 		// warn only about unknown and missed elements, not about unuseful
 		if (!in_array($element['id'], $this->unuseful_elements)) {
 			$this->warning('Unhandled '.$type.' element ['.basename(__FILE__).':'.$line.'] ('.$element['id'].'::'.$element['id_name'].' ['.$element['length'].' bytes]) at '.$element['offset']);
 		}
 		if (!isset($element['data'])) {
 			$this->current_offset = $element['end'];
 		}
 	}
+	/**
+	 * @param array $SimpleTagArray
+	 *
+	 * @return bool
+	 */
 	private function ExtractCommentsSimpleTag($SimpleTagArray) {
 		if (!empty($SimpleTagArray['SimpleTag'])) {
 			foreach ($SimpleTagArray['SimpleTag'] as $SimpleTagKey => $SimpleTagData) {
 				if (!empty($SimpleTagData['TagName']) && !empty($SimpleTagData['TagString'])) {
 					$this->getid3->info['matroska']['comments'][strtolower($SimpleTagData['TagName'])][] = $SimpleTagData['TagString'];
 		}
 		return true;
 	}
+	/**
+	 * @param int $parent_end
+	 *
+	 * @return array
+	 */
 	private function HandleEMBLSimpleTag($parent_end) {
 		$simpletag_entry = array();
 		while ($this->getEBMLelement($element, $parent_end, array(EBML_ID_SIMPLETAG))) {
 			switch ($element['id']) {
 		}
 		return $simpletag_entry;
 	}
+	/**
+	 * @param array $element
+	 * @param int   $block_type
+	 * @param array $info
+	 *
+	 * @return array
+	 */
 	private function HandleEMBLClusterBlock($element, $block_type, &$info) {
 		// http://www.matroska.org/technical/specs/index.html#block_structure
 		// http://www.matroska.org/technical/specs/index.html#simpleblock_structure
 		$block_data = array();
 		$this->current_offset = $element['end'];
 		return $block_data;
 	}
+	/**
+	 * @param string $EBMLstring
+	 *
+	 * @return int|float|false
+	 */
 	private static function EBML2Int($EBMLstring) {
 		// http://matroska.org/specs/
 		// Element ID coded with an UTF-8 like system:
 		// 1xxx xxxx                                  - Class A IDs (2^7 -2 possible values) (base 0x8X)
 		}
 		return getid3_lib::BigEndian2Int($EBMLstring);
 	}
+	/**
+	 * @param int $EBMLdatestamp
+	 *
+	 * @return float
+	 */
 	private static function EBMLdate2unix($EBMLdatestamp) {
 		// Date - signed 8 octets integer in nanoseconds with 0 indicating the precise beginning of the millennium (at 2001-01-01T00:00:00,000000000 UTC)
 		// 978307200 == mktime(0, 0, 0, 1, 1, 2001) == January 1, 2001 12:00:00am UTC
 		return round(($EBMLdatestamp / 1000000000) + 978307200);
 	}
+	/**
+	 * @param int $target_type
+	 *
+	 * @return string|int
+	 */
 	public static function TargetTypeValue($target_type) {
 		// http://www.matroska.org/technical/specs/tagging/index.html
 		static $TargetTypeValue = array();
 		if (empty($TargetTypeValue)) {
 			$TargetTypeValue[10] = 'A: ~ V:shot';                                           // the lowest hierarchy found in music or movies
 			$TargetTypeValue[70] = 'A:collection ~ V:collection';                           // the high hierarchy consisting of many different lower items
 		}
 		return (isset($TargetTypeValue[$target_type]) ? $TargetTypeValue[$target_type] : $target_type);
 	}
+	/**
+	 * @param int $lacingtype
+	 *
+	 * @return string|int
+	 */
 	public static function BlockLacingType($lacingtype) {
 		// http://matroska.org/technical/specs/index.html#block_structure
 		static $BlockLacingType = array();
 		if (empty($BlockLacingType)) {
 			$BlockLacingType[0x00] = 'no lacing';
 			$BlockLacingType[0x03] = 'EBML lacing';
 		}
 		return (isset($BlockLacingType[$lacingtype]) ? $BlockLacingType[$lacingtype] : $lacingtype);
 	}
+	/**
+	 * @param string $codecid
+	 *
+	 * @return string
+	 */
 	public static function CodecIDtoCommonName($codecid) {
 		// http://www.matroska.org/technical/specs/codecid/index.html
 		static $CodecIDlist = array();
 		if (empty($CodecIDlist)) {
 			$CodecIDlist['A_AAC']            = 'aac';
 			$CodecIDlist['A_MS/ACM']         = 'acm'; // Microsoft (TM) Audio Codec Manager (ACM)
 		}
 		return (isset($CodecIDlist[$codecid]) ? $CodecIDlist[$codecid] : $codecid);
 	}
+	/**
+	 * @param int $value
+	 *
+	 * @return string
+	 */
 	private static function EBMLidName($value) {
 		static $EBMLidList = array();
 		if (empty($EBMLidList)) {
 			$EBMLidList[EBML_ID_ASPECTRATIOTYPE]            = 'AspectRatioType';
 			$EBMLidList[EBML_ID_ATTACHEDFILE]               = 'AttachedFile';
 		}
 		return (isset($EBMLidList[$value]) ? $EBMLidList[$value] : dechex($value));
 	}
+	/**
+	 * @param int $value
+	 *
+	 * @return string
+	 */
 	public static function displayUnit($value) {
 		// http://www.matroska.org/technical/specs/index.html#DisplayUnit
 		static $units = array(
 			0 => 'pixels',
 			1 => 'centimeters',
 			3 => 'Display Aspect Ratio');
 		return (isset($units[$value]) ? $units[$value] : 'unknown');
 	}
+	/**
+	 * @param array $streams
+	 *
+	 * @return array
+	 */
 	private static function getDefaultStreamInfo($streams)
 	{
+		$stream = array();
 		foreach (array_reverse($streams) as $stream) {
 			if ($stream['default']) {
 				break;
 			}
 		}

changeset 16	a86126ab1dd4
parent 7	cf61fcea0001
child 19	3d72ae0968f4