]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - vendor/james-heinrich/getid3/getid3/module.audio.optimfrog.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / vendor / james-heinrich / getid3 / getid3 / module.audio.optimfrog.php
diff --git a/vendor/james-heinrich/getid3/getid3/module.audio.optimfrog.php b/vendor/james-heinrich/getid3/getid3/module.audio.optimfrog.php
new file mode 100644 (file)
index 0000000..50e0ffd
--- /dev/null
@@ -0,0 +1,427 @@
+<?php
+/////////////////////////////////////////////////////////////////
+/// getID3() by James Heinrich <info@getid3.org>               //
+//  available at http://getid3.sourceforge.net                 //
+//            or http://www.getid3.org                         //
+//          also https://github.com/JamesHeinrich/getID3       //
+/////////////////////////////////////////////////////////////////
+// See readme.txt for more details                             //
+/////////////////////////////////////////////////////////////////
+//                                                             //
+// module.audio.optimfrog.php                                  //
+// module for analyzing OptimFROG audio files                  //
+// dependencies: module.audio.riff.php                         //
+//                                                            ///
+/////////////////////////////////////////////////////////////////
+
+getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.audio-video.riff.php', __FILE__, true);
+
+class getid3_optimfrog extends getid3_handler
+{
+
+       public function Analyze() {
+               $info = &$this->getid3->info;
+
+               $info['fileformat']            = 'ofr';
+               $info['audio']['dataformat']   = 'ofr';
+               $info['audio']['bitrate_mode'] = 'vbr';
+               $info['audio']['lossless']     = true;
+
+               $this->fseek($info['avdataoffset']);
+               $OFRheader  = $this->fread(8);
+               if (substr($OFRheader, 0, 5) == '*RIFF') {
+
+                       return $this->ParseOptimFROGheader42();
+
+               } elseif (substr($OFRheader, 0, 3) == 'OFR') {
+
+                       return $this->ParseOptimFROGheader45();
+
+               }
+
+               $this->error('Expecting "*RIFF" or "OFR " at offset '.$info['avdataoffset'].', found "'.getid3_lib::PrintHexBytes($OFRheader).'"');
+               unset($info['fileformat']);
+               return false;
+       }
+
+
+       public function ParseOptimFROGheader42() {
+               // for fileformat of v4.21 and older
+
+               $info = &$this->getid3->info;
+               $this->fseek($info['avdataoffset']);
+               $OptimFROGheaderData = $this->fread(45);
+               $info['avdataoffset'] = 45;
+
+               $OptimFROGencoderVersion_raw   = getid3_lib::LittleEndian2Int(substr($OptimFROGheaderData, 0, 1));
+               $OptimFROGencoderVersion_major = floor($OptimFROGencoderVersion_raw / 10);
+               $OptimFROGencoderVersion_minor = $OptimFROGencoderVersion_raw - ($OptimFROGencoderVersion_major * 10);
+               $RIFFdata                = substr($OptimFROGheaderData, 1, 44);
+               $OrignalRIFFheaderSize   = getid3_lib::LittleEndian2Int(substr($RIFFdata,  4, 4)) +  8;
+               $OrignalRIFFdataSize     = getid3_lib::LittleEndian2Int(substr($RIFFdata, 40, 4)) + 44;
+
+               if ($OrignalRIFFheaderSize > $OrignalRIFFdataSize) {
+                       $info['avdataend'] -= ($OrignalRIFFheaderSize - $OrignalRIFFdataSize);
+                       $this->fseek($info['avdataend']);
+                       $RIFFdata .= $this->fread($OrignalRIFFheaderSize - $OrignalRIFFdataSize);
+               }
+
+               // move the data chunk after all other chunks (if any)
+               // so that the RIFF parser doesn't see EOF when trying
+               // to skip over the data chunk
+               $RIFFdata = substr($RIFFdata, 0, 36).substr($RIFFdata, 44).substr($RIFFdata, 36, 8);
+
+               $getid3_temp = new getID3();
+               $getid3_temp->openfile($this->getid3->filename);
+               $getid3_temp->info['avdataoffset'] = $info['avdataoffset'];
+               $getid3_temp->info['avdataend']    = $info['avdataend'];
+               $getid3_riff = new getid3_riff($getid3_temp);
+               $getid3_riff->ParseRIFFdata($RIFFdata);
+               $info['riff'] = $getid3_temp->info['riff'];
+
+               $info['audio']['encoder']         = 'OptimFROG '.$OptimFROGencoderVersion_major.'.'.$OptimFROGencoderVersion_minor;
+               $info['audio']['channels']        = $info['riff']['audio'][0]['channels'];
+               $info['audio']['sample_rate']     = $info['riff']['audio'][0]['sample_rate'];
+               $info['audio']['bits_per_sample'] = $info['riff']['audio'][0]['bits_per_sample'];
+               $info['playtime_seconds']         = $OrignalRIFFdataSize / ($info['audio']['channels'] * $info['audio']['sample_rate'] * ($info['audio']['bits_per_sample'] / 8));
+               $info['audio']['bitrate']         = (($info['avdataend'] - $info['avdataoffset']) * 8) / $info['playtime_seconds'];
+
+               unset($getid3_riff, $getid3_temp, $RIFFdata);
+
+               return true;
+       }
+
+
+       public function ParseOptimFROGheader45() {
+               // for fileformat of v4.50a and higher
+
+               $info = &$this->getid3->info;
+               $RIFFdata = '';
+               $this->fseek($info['avdataoffset']);
+               while (!feof($this->getid3->fp) && ($this->ftell() < $info['avdataend'])) {
+                       $BlockOffset = $this->ftell();
+                       $BlockData   = $this->fread(8);
+                       $offset      = 8;
+                       $BlockName   =                  substr($BlockData, 0, 4);
+                       $BlockSize   = getid3_lib::LittleEndian2Int(substr($BlockData, 4, 4));
+
+                       if ($BlockName == 'OFRX') {
+                               $BlockName = 'OFR ';
+                       }
+                       if (!isset($info['ofr'][$BlockName])) {
+                               $info['ofr'][$BlockName] = array();
+                       }
+                       $thisfile_ofr_thisblock = &$info['ofr'][$BlockName];
+
+                       switch ($BlockName) {
+                               case 'OFR ':
+
+                                       // shortcut
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+
+                                       $info['audio']['encoder'] = 'OptimFROG 4.50 alpha';
+                                       switch ($BlockSize) {
+                                               case 12:
+                                               case 15:
+                                                       // good
+                                                       break;
+
+                                               default:
+                                                       $this->warning('"'.$BlockName.'" contains more data than expected (expected 12 or 15 bytes, found '.$BlockSize.' bytes)');
+                                                       break;
+                                       }
+                                       $BlockData .= $this->fread($BlockSize);
+
+                                       $thisfile_ofr_thisblock['total_samples']      = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 6));
+                                       $offset += 6;
+                                       $thisfile_ofr_thisblock['raw']['sample_type'] = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 1));
+                                       $thisfile_ofr_thisblock['sample_type']        = $this->OptimFROGsampleTypeLookup($thisfile_ofr_thisblock['raw']['sample_type']);
+                                       $offset += 1;
+                                       $thisfile_ofr_thisblock['channel_config']     = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 1));
+                                       $thisfile_ofr_thisblock['channels']           = $thisfile_ofr_thisblock['channel_config'];
+                                       $offset += 1;
+                                       $thisfile_ofr_thisblock['sample_rate']        = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 4));
+                                       $offset += 4;
+
+                                       if ($BlockSize > 12) {
+
+                                               // OFR 4.504b or higher
+                                               $thisfile_ofr_thisblock['channels']           = $this->OptimFROGchannelConfigNumChannelsLookup($thisfile_ofr_thisblock['channel_config']);
+                                               $thisfile_ofr_thisblock['raw']['encoder_id']  = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 2));
+                                               $thisfile_ofr_thisblock['encoder']            = $this->OptimFROGencoderNameLookup($thisfile_ofr_thisblock['raw']['encoder_id']);
+                                               $offset += 2;
+                                               $thisfile_ofr_thisblock['raw']['compression'] = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 1));
+                                               $thisfile_ofr_thisblock['compression']        = $this->OptimFROGcompressionLookup($thisfile_ofr_thisblock['raw']['compression']);
+                                               $thisfile_ofr_thisblock['speedup']            = $this->OptimFROGspeedupLookup($thisfile_ofr_thisblock['raw']['compression']);
+                                               $offset += 1;
+
+                                               $info['audio']['encoder']         = 'OptimFROG '.$thisfile_ofr_thisblock['encoder'];
+                                               $info['audio']['encoder_options'] = '--mode '.$thisfile_ofr_thisblock['compression'];
+
+                                               if ((($thisfile_ofr_thisblock['raw']['encoder_id'] & 0xF0) >> 4) == 7) { // v4.507
+                                                       if (strtolower(getid3_lib::fileextension($info['filename'])) == 'ofs') {
+                                                               // OptimFROG DualStream format is lossy, but as of v4.507 there is no way to tell the difference
+                                                               // between lossless and lossy other than the file extension.
+                                                               $info['audio']['dataformat']   = 'ofs';
+                                                               $info['audio']['lossless']     = true;
+                                                       }
+                                               }
+
+                                       }
+
+                                       $info['audio']['channels']        = $thisfile_ofr_thisblock['channels'];
+                                       $info['audio']['sample_rate']     = $thisfile_ofr_thisblock['sample_rate'];
+                                       $info['audio']['bits_per_sample'] = $this->OptimFROGbitsPerSampleTypeLookup($thisfile_ofr_thisblock['raw']['sample_type']);
+                                       break;
+
+
+                               case 'COMP':
+                                       // unlike other block types, there CAN be multiple COMP blocks
+
+                                       $COMPdata['offset'] = $BlockOffset;
+                                       $COMPdata['size']   = $BlockSize;
+
+                                       if ($info['avdataoffset'] == 0) {
+                                               $info['avdataoffset'] = $BlockOffset;
+                                       }
+
+                                       // Only interested in first 14 bytes (only first 12 needed for v4.50 alpha), not actual audio data
+                                       $BlockData .= $this->fread(14);
+                                       $this->fseek($BlockSize - 14, SEEK_CUR);
+
+                                       $COMPdata['crc_32']                       = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 4));
+                                       $offset += 4;
+                                       $COMPdata['sample_count']                 = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 4));
+                                       $offset += 4;
+                                       $COMPdata['raw']['sample_type']           = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 1));
+                                       $COMPdata['sample_type']                  = $this->OptimFROGsampleTypeLookup($COMPdata['raw']['sample_type']);
+                                       $offset += 1;
+                                       $COMPdata['raw']['channel_configuration'] = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 1));
+                                       $COMPdata['channel_configuration']        = $this->OptimFROGchannelConfigurationLookup($COMPdata['raw']['channel_configuration']);
+                                       $offset += 1;
+                                       $COMPdata['raw']['algorithm_id']          = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 2));
+                                       //$COMPdata['algorithm']                    = OptimFROGalgorithmNameLookup($COMPdata['raw']['algorithm_id']);
+                                       $offset += 2;
+
+                                       if ($info['ofr']['OFR ']['size'] > 12) {
+
+                                               // OFR 4.504b or higher
+                                               $COMPdata['raw']['encoder_id']        = getid3_lib::LittleEndian2Int(substr($BlockData, $offset, 2));
+                                               $COMPdata['encoder']                  = $this->OptimFROGencoderNameLookup($COMPdata['raw']['encoder_id']);
+                                               $offset += 2;
+
+                                       }
+
+                                       if ($COMPdata['crc_32'] == 0x454E4F4E) {
+                                               // ASCII value of 'NONE' - placeholder value in v4.50a
+                                               $COMPdata['crc_32'] = false;
+                                       }
+
+                                       $thisfile_ofr_thisblock[] = $COMPdata;
+                                       break;
+
+                               case 'HEAD':
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+
+                                       $RIFFdata .= $this->fread($BlockSize);
+                                       break;
+
+                               case 'TAIL':
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+
+                                       if ($BlockSize > 0) {
+                                               $RIFFdata .= $this->fread($BlockSize);
+                                       }
+                                       break;
+
+                               case 'RECV':
+                                       // block contains no useful meta data - simply note and skip
+
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+
+                                       $this->fseek($BlockSize, SEEK_CUR);
+                                       break;
+
+
+                               case 'APET':
+                                       // APEtag v2
+
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+                                       $this->warning('APEtag processing inside OptimFROG not supported in this version ('.$this->getid3->version().') of getID3()');
+
+                                       $this->fseek($BlockSize, SEEK_CUR);
+                                       break;
+
+
+                               case 'MD5 ':
+                                       // APEtag v2
+
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+
+                                       if ($BlockSize == 16) {
+
+                                               $thisfile_ofr_thisblock['md5_binary'] = $this->fread($BlockSize);
+                                               $thisfile_ofr_thisblock['md5_string'] = getid3_lib::PrintHexBytes($thisfile_ofr_thisblock['md5_binary'], true, false, false);
+                                               $info['md5_data_source'] = $thisfile_ofr_thisblock['md5_string'];
+
+                                       } else {
+
+                                               $this->warning('Expecting block size of 16 in "MD5 " chunk, found '.$BlockSize.' instead');
+                                               $this->fseek($BlockSize, SEEK_CUR);
+
+                                       }
+                                       break;
+
+
+                               default:
+                                       $thisfile_ofr_thisblock['offset'] = $BlockOffset;
+                                       $thisfile_ofr_thisblock['size']   = $BlockSize;
+
+                                       $this->warning('Unhandled OptimFROG block type "'.$BlockName.'" at offset '.$thisfile_ofr_thisblock['offset']);
+                                       $this->fseek($BlockSize, SEEK_CUR);
+                                       break;
+                       }
+               }
+               if (isset($info['ofr']['TAIL']['offset'])) {
+                       $info['avdataend'] = $info['ofr']['TAIL']['offset'];
+               }
+
+               $info['playtime_seconds'] = (float) $info['ofr']['OFR ']['total_samples'] / ($info['audio']['channels'] * $info['audio']['sample_rate']);
+               $info['audio']['bitrate'] = (($info['avdataend'] - $info['avdataoffset']) * 8) / $info['playtime_seconds'];
+
+               // move the data chunk after all other chunks (if any)
+               // so that the RIFF parser doesn't see EOF when trying
+               // to skip over the data chunk
+               $RIFFdata = substr($RIFFdata, 0, 36).substr($RIFFdata, 44).substr($RIFFdata, 36, 8);
+
+               $getid3_temp = new getID3();
+               $getid3_temp->openfile($this->getid3->filename);
+               $getid3_temp->info['avdataoffset'] = $info['avdataoffset'];
+               $getid3_temp->info['avdataend']    = $info['avdataend'];
+               $getid3_riff = new getid3_riff($getid3_temp);
+               $getid3_riff->ParseRIFFdata($RIFFdata);
+               $info['riff'] = $getid3_temp->info['riff'];
+
+               unset($getid3_riff, $getid3_temp, $RIFFdata);
+
+               return true;
+       }
+
+
+       public static function OptimFROGsampleTypeLookup($SampleType) {
+               static $OptimFROGsampleTypeLookup = array(
+                       0  => 'unsigned int (8-bit)',
+                       1  => 'signed int (8-bit)',
+                       2  => 'unsigned int (16-bit)',
+                       3  => 'signed int (16-bit)',
+                       4  => 'unsigned int (24-bit)',
+                       5  => 'signed int (24-bit)',
+                       6  => 'unsigned int (32-bit)',
+                       7  => 'signed int (32-bit)',
+                       8  => 'float 0.24 (32-bit)',
+                       9  => 'float 16.8 (32-bit)',
+                       10 => 'float 24.0 (32-bit)'
+               );
+               return (isset($OptimFROGsampleTypeLookup[$SampleType]) ? $OptimFROGsampleTypeLookup[$SampleType] : false);
+       }
+
+       public static function OptimFROGbitsPerSampleTypeLookup($SampleType) {
+               static $OptimFROGbitsPerSampleTypeLookup = array(
+                       0  => 8,
+                       1  => 8,
+                       2  => 16,
+                       3  => 16,
+                       4  => 24,
+                       5  => 24,
+                       6  => 32,
+                       7  => 32,
+                       8  => 32,
+                       9  => 32,
+                       10 => 32
+               );
+               return (isset($OptimFROGbitsPerSampleTypeLookup[$SampleType]) ? $OptimFROGbitsPerSampleTypeLookup[$SampleType] : false);
+       }
+
+       public static function OptimFROGchannelConfigurationLookup($ChannelConfiguration) {
+               static $OptimFROGchannelConfigurationLookup = array(
+                       0 => 'mono',
+                       1 => 'stereo'
+               );
+               return (isset($OptimFROGchannelConfigurationLookup[$ChannelConfiguration]) ? $OptimFROGchannelConfigurationLookup[$ChannelConfiguration] : false);
+       }
+
+       public static function OptimFROGchannelConfigNumChannelsLookup($ChannelConfiguration) {
+               static $OptimFROGchannelConfigNumChannelsLookup = array(
+                       0 => 1,
+                       1 => 2
+               );
+               return (isset($OptimFROGchannelConfigNumChannelsLookup[$ChannelConfiguration]) ? $OptimFROGchannelConfigNumChannelsLookup[$ChannelConfiguration] : false);
+       }
+
+
+
+       // static function OptimFROGalgorithmNameLookup($AlgorithID) {
+       //     static $OptimFROGalgorithmNameLookup = array();
+       //     return (isset($OptimFROGalgorithmNameLookup[$AlgorithID]) ? $OptimFROGalgorithmNameLookup[$AlgorithID] : false);
+       // }
+
+
+       public static function OptimFROGencoderNameLookup($EncoderID) {
+               // version = (encoderID >> 4) + 4500
+               // system  =  encoderID & 0xF
+
+               $EncoderVersion  = number_format(((($EncoderID & 0xF0) >> 4) + 4500) / 1000, 3);
+               $EncoderSystemID = ($EncoderID & 0x0F);
+
+               static $OptimFROGencoderSystemLookup = array(
+                       0x00 => 'Windows console',
+                       0x01 => 'Linux console',
+                       0x0F => 'unknown'
+               );
+               return $EncoderVersion.' ('.(isset($OptimFROGencoderSystemLookup[$EncoderSystemID]) ? $OptimFROGencoderSystemLookup[$EncoderSystemID] : 'undefined encoder type (0x'.dechex($EncoderSystemID).')').')';
+       }
+
+       public static function OptimFROGcompressionLookup($CompressionID) {
+               // mode    = compression >> 3
+               // speedup = compression & 0x07
+
+               $CompressionModeID    = ($CompressionID & 0xF8) >> 3;
+               //$CompressionSpeedupID = ($CompressionID & 0x07);
+
+               static $OptimFROGencoderModeLookup = array(
+                       0x00 => 'fast',
+                       0x01 => 'normal',
+                       0x02 => 'high',
+                       0x03 => 'extra', // extranew (some versions)
+                       0x04 => 'best',  // bestnew (some versions)
+                       0x05 => 'ultra',
+                       0x06 => 'insane',
+                       0x07 => 'highnew',
+                       0x08 => 'extranew',
+                       0x09 => 'bestnew'
+               );
+               return (isset($OptimFROGencoderModeLookup[$CompressionModeID]) ? $OptimFROGencoderModeLookup[$CompressionModeID] : 'undefined mode (0x'.str_pad(dechex($CompressionModeID), 2, '0', STR_PAD_LEFT).')');
+       }
+
+       public static function OptimFROGspeedupLookup($CompressionID) {
+               // mode    = compression >> 3
+               // speedup = compression & 0x07
+
+               //$CompressionModeID    = ($CompressionID & 0xF8) >> 3;
+               $CompressionSpeedupID = ($CompressionID & 0x07);
+
+               static $OptimFROGencoderSpeedupLookup = array(
+                       0x00 => '1x',
+                       0x01 => '2x',
+                       0x02 => '4x'
+               );
+               return (isset($OptimFROGencoderSpeedupLookup[$CompressionSpeedupID]) ? $OptimFROGencoderSpeedupLookup[$CompressionSpeedupID] : 'undefined mode (0x'.dechex($CompressionSpeedupID));
+       }
+
+}