File indexing completed on 2024-05-12 05:58:14
0001 <?php 0002 ///////////////////////////////////////////////////////////////// 0003 /// getID3() by James Heinrich <info@getid3.org> // 0004 // available at http://getid3.sourceforge.net // 0005 // or http://www.getid3.org // 0006 // also https://github.com/JamesHeinrich/getID3 // 0007 ///////////////////////////////////////////////////////////////// 0008 // See readme.txt for more details // 0009 ///////////////////////////////////////////////////////////////// 0010 // // 0011 // module.audio.wavpack.php // 0012 // module for analyzing WavPack v4.0+ Audio files // 0013 // dependencies: NONE // 0014 // /// 0015 ///////////////////////////////////////////////////////////////// 0016 0017 0018 class getid3_wavpack extends getid3_handler 0019 { 0020 0021 public function Analyze() { 0022 $info = &$this->getid3->info; 0023 0024 $this->fseek($info['avdataoffset']); 0025 0026 while (true) { 0027 0028 $wavpackheader = $this->fread(32); 0029 0030 if ($this->ftell() >= $info['avdataend']) { 0031 break; 0032 } elseif (feof($this->getid3->fp)) { 0033 break; 0034 } elseif ( 0035 isset($info['wavpack']['blockheader']['total_samples']) && 0036 isset($info['wavpack']['blockheader']['block_samples']) && 0037 ($info['wavpack']['blockheader']['total_samples'] > 0) && 0038 ($info['wavpack']['blockheader']['block_samples'] > 0) && 0039 (!isset($info['wavpack']['riff_trailer_size']) || ($info['wavpack']['riff_trailer_size'] <= 0)) && 0040 ((isset($info['wavpack']['config_flags']['md5_checksum']) && ($info['wavpack']['config_flags']['md5_checksum'] === false)) || !empty($info['md5_data_source']))) { 0041 break; 0042 } 0043 0044 $blockheader_offset = $this->ftell() - 32; 0045 $blockheader_magic = substr($wavpackheader, 0, 4); 0046 $blockheader_size = getid3_lib::LittleEndian2Int(substr($wavpackheader, 4, 4)); 0047 0048 $magic = 'wvpk'; 0049 if ($blockheader_magic != $magic) { 0050 $info['error'][] = 'Expecting "'.getid3_lib::PrintHexBytes($magic).'" at offset '.$blockheader_offset.', found "'.getid3_lib::PrintHexBytes($blockheader_magic).'"'; 0051 switch (isset($info['audio']['dataformat']) ? $info['audio']['dataformat'] : '') { 0052 case 'wavpack': 0053 case 'wvc': 0054 break; 0055 default: 0056 unset($info['fileformat']); 0057 unset($info['audio']); 0058 unset($info['wavpack']); 0059 break; 0060 } 0061 return false; 0062 } 0063 0064 if (empty($info['wavpack']['blockheader']['block_samples']) || 0065 empty($info['wavpack']['blockheader']['total_samples']) || 0066 ($info['wavpack']['blockheader']['block_samples'] <= 0) || 0067 ($info['wavpack']['blockheader']['total_samples'] <= 0)) { 0068 // Also, it is possible that the first block might not have 0069 // any samples (block_samples == 0) and in this case you should skip blocks 0070 // until you find one with samples because the other information (like 0071 // total_samples) are not guaranteed to be correct until (block_samples > 0) 0072 0073 // Finally, I have defined a format for files in which the length is not known 0074 // (for example when raw files are created using pipes). In these cases 0075 // total_samples will be -1 and you must seek to the final block to determine 0076 // the total number of samples. 0077 0078 0079 $info['audio']['dataformat'] = 'wavpack'; 0080 $info['fileformat'] = 'wavpack'; 0081 $info['audio']['lossless'] = true; 0082 $info['audio']['bitrate_mode'] = 'vbr'; 0083 0084 $info['wavpack']['blockheader']['offset'] = $blockheader_offset; 0085 $info['wavpack']['blockheader']['magic'] = $blockheader_magic; 0086 $info['wavpack']['blockheader']['size'] = $blockheader_size; 0087 0088 if ($info['wavpack']['blockheader']['size'] >= 0x100000) { 0089 $info['error'][] = 'Expecting WavPack block size less than "0x100000", found "'.$info['wavpack']['blockheader']['size'].'" at offset '.$info['wavpack']['blockheader']['offset']; 0090 switch (isset($info['audio']['dataformat']) ? $info['audio']['dataformat'] : '') { 0091 case 'wavpack': 0092 case 'wvc': 0093 break; 0094 default: 0095 unset($info['fileformat']); 0096 unset($info['audio']); 0097 unset($info['wavpack']); 0098 break; 0099 } 0100 return false; 0101 } 0102 0103 $info['wavpack']['blockheader']['minor_version'] = ord($wavpackheader{8}); 0104 $info['wavpack']['blockheader']['major_version'] = ord($wavpackheader{9}); 0105 0106 if (($info['wavpack']['blockheader']['major_version'] != 4) || 0107 (($info['wavpack']['blockheader']['minor_version'] < 4) && 0108 ($info['wavpack']['blockheader']['minor_version'] > 16))) { 0109 $info['error'][] = 'Expecting WavPack version between "4.2" and "4.16", found version "'.$info['wavpack']['blockheader']['major_version'].'.'.$info['wavpack']['blockheader']['minor_version'].'" at offset '.$info['wavpack']['blockheader']['offset']; 0110 switch (isset($info['audio']['dataformat']) ? $info['audio']['dataformat'] : '') { 0111 case 'wavpack': 0112 case 'wvc': 0113 break; 0114 default: 0115 unset($info['fileformat']); 0116 unset($info['audio']); 0117 unset($info['wavpack']); 0118 break; 0119 } 0120 return false; 0121 } 0122 0123 $info['wavpack']['blockheader']['track_number'] = ord($wavpackheader{10}); // unused 0124 $info['wavpack']['blockheader']['index_number'] = ord($wavpackheader{11}); // unused 0125 $info['wavpack']['blockheader']['total_samples'] = getid3_lib::LittleEndian2Int(substr($wavpackheader, 12, 4)); 0126 $info['wavpack']['blockheader']['block_index'] = getid3_lib::LittleEndian2Int(substr($wavpackheader, 16, 4)); 0127 $info['wavpack']['blockheader']['block_samples'] = getid3_lib::LittleEndian2Int(substr($wavpackheader, 20, 4)); 0128 $info['wavpack']['blockheader']['flags_raw'] = getid3_lib::LittleEndian2Int(substr($wavpackheader, 24, 4)); 0129 $info['wavpack']['blockheader']['crc'] = getid3_lib::LittleEndian2Int(substr($wavpackheader, 28, 4)); 0130 0131 $info['wavpack']['blockheader']['flags']['bytes_per_sample'] = 1 + ($info['wavpack']['blockheader']['flags_raw'] & 0x00000003); 0132 $info['wavpack']['blockheader']['flags']['mono'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000004); 0133 $info['wavpack']['blockheader']['flags']['hybrid'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000008); 0134 $info['wavpack']['blockheader']['flags']['joint_stereo'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000010); 0135 $info['wavpack']['blockheader']['flags']['cross_decorrelation'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000020); 0136 $info['wavpack']['blockheader']['flags']['hybrid_noiseshape'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000040); 0137 $info['wavpack']['blockheader']['flags']['ieee_32bit_float'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000080); 0138 $info['wavpack']['blockheader']['flags']['int_32bit'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000100); 0139 $info['wavpack']['blockheader']['flags']['hybrid_bitrate_noise'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000200); 0140 $info['wavpack']['blockheader']['flags']['hybrid_balance_noise'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000400); 0141 $info['wavpack']['blockheader']['flags']['multichannel_initial'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000800); 0142 $info['wavpack']['blockheader']['flags']['multichannel_final'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00001000); 0143 0144 $info['audio']['lossless'] = !$info['wavpack']['blockheader']['flags']['hybrid']; 0145 } 0146 0147 while (!feof($this->getid3->fp) && ($this->ftell() < ($blockheader_offset + $blockheader_size + 8))) { 0148 0149 $metablock = array('offset'=>$this->ftell()); 0150 $metablockheader = $this->fread(2); 0151 if (feof($this->getid3->fp)) { 0152 break; 0153 } 0154 $metablock['id'] = ord($metablockheader{0}); 0155 $metablock['function_id'] = ($metablock['id'] & 0x3F); 0156 $metablock['function_name'] = $this->WavPackMetablockNameLookup($metablock['function_id']); 0157 0158 // The 0x20 bit in the id of the meta subblocks (which is defined as 0159 // ID_OPTIONAL_DATA) is a permanent part of the id. The idea is that 0160 // if a decoder encounters an id that it does not know about, it uses 0161 // that "ID_OPTIONAL_DATA" flag to determine what to do. If it is set 0162 // then the decoder simply ignores the metadata, but if it is zero 0163 // then the decoder should quit because it means that an understanding 0164 // of the metadata is required to correctly decode the audio. 0165 $metablock['non_decoder'] = (bool) ($metablock['id'] & 0x20); 0166 0167 $metablock['padded_data'] = (bool) ($metablock['id'] & 0x40); 0168 $metablock['large_block'] = (bool) ($metablock['id'] & 0x80); 0169 if ($metablock['large_block']) { 0170 $metablockheader .= $this->fread(2); 0171 } 0172 $metablock['size'] = getid3_lib::LittleEndian2Int(substr($metablockheader, 1)) * 2; // size is stored in words 0173 $metablock['data'] = null; 0174 0175 if ($metablock['size'] > 0) { 0176 0177 switch ($metablock['function_id']) { 0178 case 0x21: // ID_RIFF_HEADER 0179 case 0x22: // ID_RIFF_TRAILER 0180 case 0x23: // ID_REPLAY_GAIN 0181 case 0x24: // ID_CUESHEET 0182 case 0x25: // ID_CONFIG_BLOCK 0183 case 0x26: // ID_MD5_CHECKSUM 0184 $metablock['data'] = $this->fread($metablock['size']); 0185 0186 if ($metablock['padded_data']) { 0187 // padded to the nearest even byte 0188 $metablock['size']--; 0189 $metablock['data'] = substr($metablock['data'], 0, -1); 0190 } 0191 break; 0192 0193 case 0x00: // ID_DUMMY 0194 case 0x01: // ID_ENCODER_INFO 0195 case 0x02: // ID_DECORR_TERMS 0196 case 0x03: // ID_DECORR_WEIGHTS 0197 case 0x04: // ID_DECORR_SAMPLES 0198 case 0x05: // ID_ENTROPY_VARS 0199 case 0x06: // ID_HYBRID_PROFILE 0200 case 0x07: // ID_SHAPING_WEIGHTS 0201 case 0x08: // ID_FLOAT_INFO 0202 case 0x09: // ID_INT32_INFO 0203 case 0x0A: // ID_WV_BITSTREAM 0204 case 0x0B: // ID_WVC_BITSTREAM 0205 case 0x0C: // ID_WVX_BITSTREAM 0206 case 0x0D: // ID_CHANNEL_INFO 0207 $this->fseek($metablock['offset'] + ($metablock['large_block'] ? 4 : 2) + $metablock['size']); 0208 break; 0209 0210 default: 0211 $info['warning'][] = 'Unexpected metablock type "0x'.str_pad(dechex($metablock['function_id']), 2, '0', STR_PAD_LEFT).'" at offset '.$metablock['offset']; 0212 $this->fseek($metablock['offset'] + ($metablock['large_block'] ? 4 : 2) + $metablock['size']); 0213 break; 0214 } 0215 0216 switch ($metablock['function_id']) { 0217 case 0x21: // ID_RIFF_HEADER 0218 getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.audio-video.riff.php', __FILE__, true); 0219 $original_wav_filesize = getid3_lib::LittleEndian2Int(substr($metablock['data'], 4, 4)); 0220 0221 $getid3_temp = new getID3(); 0222 $getid3_temp->openfile($this->getid3->filename); 0223 $getid3_riff = new getid3_riff($getid3_temp); 0224 $getid3_riff->ParseRIFFdata($metablock['data']); 0225 $metablock['riff'] = $getid3_temp->info['riff']; 0226 $info['audio']['sample_rate'] = $getid3_temp->info['riff']['raw']['fmt ']['nSamplesPerSec']; 0227 unset($getid3_riff, $getid3_temp); 0228 0229 $metablock['riff']['original_filesize'] = $original_wav_filesize; 0230 $info['wavpack']['riff_trailer_size'] = $original_wav_filesize - $metablock['riff']['WAVE']['data'][0]['size'] - $metablock['riff']['header_size']; 0231 $info['playtime_seconds'] = $info['wavpack']['blockheader']['total_samples'] / $info['audio']['sample_rate']; 0232 0233 // Safe RIFF header in case there's a RIFF footer later 0234 $metablockRIFFheader = $metablock['data']; 0235 break; 0236 0237 0238 case 0x22: // ID_RIFF_TRAILER 0239 $metablockRIFFfooter = $metablockRIFFheader.$metablock['data']; 0240 getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.audio-video.riff.php', __FILE__, true); 0241 0242 $startoffset = $metablock['offset'] + ($metablock['large_block'] ? 4 : 2); 0243 $getid3_temp = new getID3(); 0244 $getid3_temp->openfile($this->getid3->filename); 0245 $getid3_temp->info['avdataend'] = $info['avdataend']; 0246 //$getid3_temp->info['fileformat'] = 'riff'; 0247 $getid3_riff = new getid3_riff($getid3_temp); 0248 $metablock['riff'] = $getid3_riff->ParseRIFF($startoffset, $startoffset + $metablock['size']); 0249 0250 if (!empty($metablock['riff']['INFO'])) { 0251 getid3_riff::parseComments($metablock['riff']['INFO'], $metablock['comments']); 0252 $info['tags']['riff'] = $metablock['comments']; 0253 } 0254 unset($getid3_temp, $getid3_riff); 0255 break; 0256 0257 0258 case 0x23: // ID_REPLAY_GAIN 0259 $info['warning'][] = 'WavPack "Replay Gain" contents not yet handled by getID3() in metablock at offset '.$metablock['offset']; 0260 break; 0261 0262 0263 case 0x24: // ID_CUESHEET 0264 $info['warning'][] = 'WavPack "Cuesheet" contents not yet handled by getID3() in metablock at offset '.$metablock['offset']; 0265 break; 0266 0267 0268 case 0x25: // ID_CONFIG_BLOCK 0269 $metablock['flags_raw'] = getid3_lib::LittleEndian2Int(substr($metablock['data'], 0, 3)); 0270 0271 $metablock['flags']['adobe_mode'] = (bool) ($metablock['flags_raw'] & 0x000001); // "adobe" mode for 32-bit floats 0272 $metablock['flags']['fast_flag'] = (bool) ($metablock['flags_raw'] & 0x000002); // fast mode 0273 $metablock['flags']['very_fast_flag'] = (bool) ($metablock['flags_raw'] & 0x000004); // double fast 0274 $metablock['flags']['high_flag'] = (bool) ($metablock['flags_raw'] & 0x000008); // high quality mode 0275 $metablock['flags']['very_high_flag'] = (bool) ($metablock['flags_raw'] & 0x000010); // double high (not used yet) 0276 $metablock['flags']['bitrate_kbps'] = (bool) ($metablock['flags_raw'] & 0x000020); // bitrate is kbps, not bits / sample 0277 $metablock['flags']['auto_shaping'] = (bool) ($metablock['flags_raw'] & 0x000040); // automatic noise shaping 0278 $metablock['flags']['shape_override'] = (bool) ($metablock['flags_raw'] & 0x000080); // shaping mode specified 0279 $metablock['flags']['joint_override'] = (bool) ($metablock['flags_raw'] & 0x000100); // joint-stereo mode specified 0280 $metablock['flags']['copy_time'] = (bool) ($metablock['flags_raw'] & 0x000200); // copy file-time from source 0281 $metablock['flags']['create_exe'] = (bool) ($metablock['flags_raw'] & 0x000400); // create executable 0282 $metablock['flags']['create_wvc'] = (bool) ($metablock['flags_raw'] & 0x000800); // create correction file 0283 $metablock['flags']['optimize_wvc'] = (bool) ($metablock['flags_raw'] & 0x001000); // maximize bybrid compression 0284 $metablock['flags']['quality_mode'] = (bool) ($metablock['flags_raw'] & 0x002000); // psychoacoustic quality mode 0285 $metablock['flags']['raw_flag'] = (bool) ($metablock['flags_raw'] & 0x004000); // raw mode (not implemented yet) 0286 $metablock['flags']['calc_noise'] = (bool) ($metablock['flags_raw'] & 0x008000); // calc noise in hybrid mode 0287 $metablock['flags']['lossy_mode'] = (bool) ($metablock['flags_raw'] & 0x010000); // obsolete (for information) 0288 $metablock['flags']['extra_mode'] = (bool) ($metablock['flags_raw'] & 0x020000); // extra processing mode 0289 $metablock['flags']['skip_wvx'] = (bool) ($metablock['flags_raw'] & 0x040000); // no wvx stream w/ floats & big ints 0290 $metablock['flags']['md5_checksum'] = (bool) ($metablock['flags_raw'] & 0x080000); // compute & store MD5 signature 0291 $metablock['flags']['quiet_mode'] = (bool) ($metablock['flags_raw'] & 0x100000); // don't report progress % 0292 0293 $info['wavpack']['config_flags'] = $metablock['flags']; 0294 0295 0296 $info['audio']['encoder_options'] = ''; 0297 if ($info['wavpack']['blockheader']['flags']['hybrid']) { 0298 $info['audio']['encoder_options'] .= ' -b???'; 0299 } 0300 $info['audio']['encoder_options'] .= ($metablock['flags']['adobe_mode'] ? ' -a' : ''); 0301 $info['audio']['encoder_options'] .= ($metablock['flags']['optimize_wvc'] ? ' -cc' : ''); 0302 $info['audio']['encoder_options'] .= ($metablock['flags']['create_exe'] ? ' -e' : ''); 0303 $info['audio']['encoder_options'] .= ($metablock['flags']['fast_flag'] ? ' -f' : ''); 0304 $info['audio']['encoder_options'] .= ($metablock['flags']['joint_override'] ? ' -j?' : ''); 0305 $info['audio']['encoder_options'] .= ($metablock['flags']['high_flag'] ? ' -h' : ''); 0306 $info['audio']['encoder_options'] .= ($metablock['flags']['md5_checksum'] ? ' -m' : ''); 0307 $info['audio']['encoder_options'] .= ($metablock['flags']['calc_noise'] ? ' -n' : ''); 0308 $info['audio']['encoder_options'] .= ($metablock['flags']['shape_override'] ? ' -s?' : ''); 0309 $info['audio']['encoder_options'] .= ($metablock['flags']['extra_mode'] ? ' -x?' : ''); 0310 if (!empty($info['audio']['encoder_options'])) { 0311 $info['audio']['encoder_options'] = trim($info['audio']['encoder_options']); 0312 } elseif (isset($info['audio']['encoder_options'])) { 0313 unset($info['audio']['encoder_options']); 0314 } 0315 break; 0316 0317 0318 case 0x26: // ID_MD5_CHECKSUM 0319 if (strlen($metablock['data']) == 16) { 0320 $info['md5_data_source'] = strtolower(getid3_lib::PrintHexBytes($metablock['data'], true, false, false)); 0321 } else { 0322 $info['warning'][] = 'Expecting 16 bytes of WavPack "MD5 Checksum" in metablock at offset '.$metablock['offset'].', but found '.strlen($metablock['data']).' bytes'; 0323 } 0324 break; 0325 0326 0327 case 0x00: // ID_DUMMY 0328 case 0x01: // ID_ENCODER_INFO 0329 case 0x02: // ID_DECORR_TERMS 0330 case 0x03: // ID_DECORR_WEIGHTS 0331 case 0x04: // ID_DECORR_SAMPLES 0332 case 0x05: // ID_ENTROPY_VARS 0333 case 0x06: // ID_HYBRID_PROFILE 0334 case 0x07: // ID_SHAPING_WEIGHTS 0335 case 0x08: // ID_FLOAT_INFO 0336 case 0x09: // ID_INT32_INFO 0337 case 0x0A: // ID_WV_BITSTREAM 0338 case 0x0B: // ID_WVC_BITSTREAM 0339 case 0x0C: // ID_WVX_BITSTREAM 0340 case 0x0D: // ID_CHANNEL_INFO 0341 unset($metablock); 0342 break; 0343 } 0344 0345 } 0346 if (!empty($metablock)) { 0347 $info['wavpack']['metablocks'][] = $metablock; 0348 } 0349 0350 } 0351 0352 } 0353 0354 $info['audio']['encoder'] = 'WavPack v'.$info['wavpack']['blockheader']['major_version'].'.'.str_pad($info['wavpack']['blockheader']['minor_version'], 2, '0', STR_PAD_LEFT); 0355 $info['audio']['bits_per_sample'] = $info['wavpack']['blockheader']['flags']['bytes_per_sample'] * 8; 0356 $info['audio']['channels'] = ($info['wavpack']['blockheader']['flags']['mono'] ? 1 : 2); 0357 0358 if (!empty($info['playtime_seconds'])) { 0359 0360 $info['audio']['bitrate'] = (($info['avdataend'] - $info['avdataoffset']) * 8) / $info['playtime_seconds']; 0361 0362 } else { 0363 0364 $info['audio']['dataformat'] = 'wvc'; 0365 0366 } 0367 0368 return true; 0369 } 0370 0371 0372 public function WavPackMetablockNameLookup(&$id) { 0373 static $WavPackMetablockNameLookup = array( 0374 0x00 => 'Dummy', 0375 0x01 => 'Encoder Info', 0376 0x02 => 'Decorrelation Terms', 0377 0x03 => 'Decorrelation Weights', 0378 0x04 => 'Decorrelation Samples', 0379 0x05 => 'Entropy Variables', 0380 0x06 => 'Hybrid Profile', 0381 0x07 => 'Shaping Weights', 0382 0x08 => 'Float Info', 0383 0x09 => 'Int32 Info', 0384 0x0A => 'WV Bitstream', 0385 0x0B => 'WVC Bitstream', 0386 0x0C => 'WVX Bitstream', 0387 0x0D => 'Channel Info', 0388 0x21 => 'RIFF header', 0389 0x22 => 'RIFF trailer', 0390 0x23 => 'Replay Gain', 0391 0x24 => 'Cuesheet', 0392 0x25 => 'Config Block', 0393 0x26 => 'MD5 Checksum', 0394 ); 0395 return (isset($WavPackMetablockNameLookup[$id]) ? $WavPackMetablockNameLookup[$id] : ''); 0396 } 0397 0398 }