rlm@3: | rlm@3: // | Allan Hansen | rlm@3: // +----------------------------------------------------------------------+ rlm@3: // | module.audio.wavpack.php | rlm@3: // | module for analyzing WavPack v4.0+ Audio files | rlm@3: // | dependencies: audio-video.riff | rlm@3: // +----------------------------------------------------------------------+ rlm@3: // rlm@3: // $Id: module.audio.wavpack.php,v 1.2 2006/11/02 10:48:02 ah Exp $ rlm@3: rlm@3: rlm@3: class getid3_wavpack extends getid3_handler rlm@3: { rlm@3: rlm@3: public function Analyze() { rlm@3: rlm@3: $getid3 = $this->getid3; rlm@3: rlm@3: $getid3->include_module('audio-video.riff'); rlm@3: rlm@3: $getid3->info['wavpack'] = array (); rlm@3: $info_wavpack = &$getid3->info['wavpack']; rlm@3: rlm@3: fseek($getid3->fp, $getid3->info['avdataoffset'], SEEK_SET); rlm@3: rlm@3: while (true) { rlm@3: rlm@3: $wavpack_header = fread($getid3->fp, 32); rlm@3: rlm@3: if (ftell($getid3->fp) >= $getid3->info['avdataend']) { rlm@3: break; rlm@3: } elseif (feof($getid3->fp)) { rlm@3: break; rlm@3: } elseif ( rlm@3: (@$info_wavpack_blockheader['total_samples'] > 0) && rlm@3: (@$info_wavpack_blockheader['block_samples'] > 0) && rlm@3: (!isset($info_wavpack['riff_trailer_size']) || ($info_wavpack['riff_trailer_size'] <= 0)) && rlm@3: ((@$info_wavpack['config_flags']['md5_checksum'] === false) || !empty($getid3->info['md5_data_source']))) { rlm@3: break; rlm@3: } rlm@3: rlm@3: $block_header_offset = ftell($getid3->fp) - 32; rlm@3: $block_header_magic = substr($wavpack_header, 0, 4); rlm@3: $block_header_size = getid3_lib::LittleEndian2Int(substr($wavpack_header, 4, 4)); rlm@3: rlm@3: if ($block_header_magic != 'wvpk') { rlm@3: throw new getid3_exception('Expecting "wvpk" at offset '.$block_header_offset.', found "'.$block_header_magic.'"'); rlm@3: } rlm@3: rlm@3: if ((@$info_wavpack_blockheader['block_samples'] <= 0) || (@$info_wavpack_blockheader['total_samples'] <= 0)) { rlm@3: rlm@3: // Also, it is possible that the first block might not have rlm@3: // any samples (block_samples == 0) and in this case you should skip blocks rlm@3: // until you find one with samples because the other information (like rlm@3: // total_samples) are not guaranteed to be correct until (block_samples > 0) rlm@3: rlm@3: // Finally, I have defined a format for files in which the length is not known rlm@3: // (for example when raw files are created using pipes). In these cases rlm@3: // total_samples will be -1 and you must seek to the final block to determine rlm@3: // the total number of samples. rlm@3: rlm@3: rlm@3: $getid3->info['audio']['dataformat'] = 'wavpack'; rlm@3: $getid3->info['fileformat'] = 'wavpack'; rlm@3: $getid3->info['audio']['lossless'] = true; rlm@3: $getid3->info['audio']['bitrate_mode'] = 'vbr'; rlm@3: rlm@3: $info_wavpack['blockheader']['offset'] = $block_header_offset; rlm@3: $info_wavpack['blockheader']['magic'] = $block_header_magic; rlm@3: $info_wavpack['blockheader']['size'] = $block_header_size; rlm@3: $info_wavpack_blockheader = &$info_wavpack['blockheader']; rlm@3: rlm@3: if ($info_wavpack_blockheader['size'] >= 0x100000) { rlm@3: throw new getid3_exception('Expecting WavPack block size less than "0x100000", found "'.$info_wavpack_blockheader['size'].'" at offset '.$info_wavpack_blockheader['offset']); rlm@3: } rlm@3: rlm@3: $info_wavpack_blockheader['minor_version'] = ord($wavpack_header{8}); rlm@3: $info_wavpack_blockheader['major_version'] = ord($wavpack_header{9}); rlm@3: rlm@3: if (($info_wavpack_blockheader['major_version'] != 4) || rlm@3: (($info_wavpack_blockheader['minor_version'] < 4) && rlm@3: ($info_wavpack_blockheader['minor_version'] > 16))) { rlm@3: throw new getid3_exception('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']); rlm@3: } rlm@3: rlm@3: $info_wavpack_blockheader['track_number'] = ord($wavpack_header{10}); // unused rlm@3: $info_wavpack_blockheader['index_number'] = ord($wavpack_header{11}); // unused rlm@3: rlm@3: getid3_lib::ReadSequence('LittleEndian2Int', $info_wavpack_blockheader, $wavpack_header, 12, rlm@3: array ( rlm@3: 'total_samples' => 4, rlm@3: 'block_index' => 4, rlm@3: 'block_samples' => 4, rlm@3: 'flags_raw' => 4, rlm@3: 'crc' => 4 rlm@3: ) rlm@3: ); rlm@3: rlm@3: rlm@3: $info_wavpack_blockheader['flags']['bytes_per_sample'] = 1 + ($info_wavpack_blockheader['flags_raw'] & 0x00000003); rlm@3: $info_wavpack_blockheader['flags']['mono'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000004); rlm@3: $info_wavpack_blockheader['flags']['hybrid'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000008); rlm@3: $info_wavpack_blockheader['flags']['joint_stereo'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000010); rlm@3: $info_wavpack_blockheader['flags']['cross_decorrelation'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000020); rlm@3: $info_wavpack_blockheader['flags']['hybrid_noiseshape'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000040); rlm@3: $info_wavpack_blockheader['flags']['ieee_32bit_float'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000080); rlm@3: $info_wavpack_blockheader['flags']['int_32bit'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000100); rlm@3: $info_wavpack_blockheader['flags']['hybrid_bitrate_noise'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000200); rlm@3: $info_wavpack_blockheader['flags']['hybrid_balance_noise'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000400); rlm@3: $info_wavpack_blockheader['flags']['multichannel_initial'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00000800); rlm@3: $info_wavpack_blockheader['flags']['multichannel_final'] = (bool) ($info_wavpack_blockheader['flags_raw'] & 0x00001000); rlm@3: rlm@3: $getid3->info['audio']['lossless'] = !$info_wavpack_blockheader['flags']['hybrid']; rlm@3: } rlm@3: rlm@3: rlm@3: while (!feof($getid3->fp) && (ftell($getid3->fp) < ($block_header_offset + $block_header_size + 8))) { rlm@3: rlm@3: $metablock = array('offset'=>ftell($getid3->fp)); rlm@3: $metablockheader = fread($getid3->fp, 2); rlm@3: if (feof($getid3->fp)) { rlm@3: break; rlm@3: } rlm@3: $metablock['id'] = ord($metablockheader{0}); rlm@3: $metablock['function_id'] = ($metablock['id'] & 0x3F); rlm@3: $metablock['function_name'] = $this->WavPackMetablockNameLookup($metablock['function_id']); rlm@3: rlm@3: // The 0x20 bit in the id of the meta subblocks (which is defined as rlm@3: // ID_OPTIONAL_DATA) is a permanent part of the id. The idea is that rlm@3: // if a decoder encounters an id that it does not know about, it uses rlm@3: // that "ID_OPTIONAL_DATA" flag to determine what to do. If it is set rlm@3: // then the decoder simply ignores the metadata, but if it is zero rlm@3: // then the decoder should quit because it means that an understanding rlm@3: // of the metadata is required to correctly decode the audio. rlm@3: rlm@3: $metablock['non_decoder'] = (bool) ($metablock['id'] & 0x20); rlm@3: $metablock['padded_data'] = (bool) ($metablock['id'] & 0x40); rlm@3: $metablock['large_block'] = (bool) ($metablock['id'] & 0x80); rlm@3: if ($metablock['large_block']) { rlm@3: $metablockheader .= fread($getid3->fp, 2); rlm@3: } rlm@3: $metablock['size'] = getid3_lib::LittleEndian2Int(substr($metablockheader, 1)) * 2; // size is stored in words rlm@3: $metablock['data'] = null; rlm@3: rlm@3: if ($metablock['size'] > 0) { rlm@3: rlm@3: switch ($metablock['function_id']) { rlm@3: rlm@3: case 0x21: // ID_RIFF_HEADER rlm@3: case 0x22: // ID_RIFF_TRAILER rlm@3: case 0x23: // ID_REPLAY_GAIN rlm@3: case 0x24: // ID_CUESHEET rlm@3: case 0x25: // ID_CONFIG_BLOCK rlm@3: case 0x26: // ID_MD5_CHECKSUM rlm@3: $metablock['data'] = fread($getid3->fp, $metablock['size']); rlm@3: rlm@3: if ($metablock['padded_data']) { rlm@3: // padded to the nearest even byte rlm@3: $metablock['size']--; rlm@3: $metablock['data'] = substr($metablock['data'], 0, -1); rlm@3: } rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x00: // ID_DUMMY rlm@3: case 0x01: // ID_ENCODER_INFO rlm@3: case 0x02: // ID_DECORR_TERMS rlm@3: case 0x03: // ID_DECORR_WEIGHTS rlm@3: case 0x04: // ID_DECORR_SAMPLES rlm@3: case 0x05: // ID_ENTROPY_VARS rlm@3: case 0x06: // ID_HYBRID_PROFILE rlm@3: case 0x07: // ID_SHAPING_WEIGHTS rlm@3: case 0x08: // ID_FLOAT_INFO rlm@3: case 0x09: // ID_INT32_INFO rlm@3: case 0x0A: // ID_WV_BITSTREAM rlm@3: case 0x0B: // ID_WVC_BITSTREAM rlm@3: case 0x0C: // ID_WVX_BITSTREAM rlm@3: case 0x0D: // ID_CHANNEL_INFO rlm@3: fseek($getid3->fp, $metablock['offset'] + ($metablock['large_block'] ? 4 : 2) + $metablock['size'], SEEK_SET); rlm@3: break; rlm@3: rlm@3: rlm@3: default: rlm@3: $getid3->warning('Unexpected metablock type "0x'.str_pad(dechex($metablock['function_id']), 2, '0', STR_PAD_LEFT).'" at offset '.$metablock['offset']); rlm@3: fseek($getid3->fp, $metablock['offset'] + ($metablock['large_block'] ? 4 : 2) + $metablock['size'], SEEK_SET); rlm@3: break; rlm@3: } rlm@3: rlm@3: rlm@3: switch ($metablock['function_id']) { rlm@3: rlm@3: case 0x21: // ID_RIFF_HEADER rlm@3: rlm@3: $original_wav_filesize = getid3_lib::LittleEndian2Int(substr($metablock['data'], 4, 4)); rlm@3: rlm@3: // Clone getid3 rlm@3: $clone = clone $getid3; rlm@3: rlm@3: // Analyze clone by string rlm@3: $riff = new getid3_riff($clone); rlm@3: $riff->AnalyzeString($metablock['data']); rlm@3: rlm@3: // Import from clone and destroy rlm@3: $metablock['riff'] = $clone->info['riff']; rlm@3: $getid3->warnings($clone->warnings()); rlm@3: unset($clone); rlm@3: rlm@3: // Save RIFF header - we may need it later for RIFF footer parsing rlm@3: $this->riff_header = $metablock['data']; rlm@3: rlm@3: $metablock['riff']['original_filesize'] = $original_wav_filesize; rlm@3: $info_wavpack['riff_trailer_size'] = $original_wav_filesize - $metablock['riff']['WAVE']['data'][0]['size'] - $metablock['riff']['header_size']; rlm@3: rlm@3: $getid3->info['audio']['sample_rate'] = $metablock['riff']['raw']['fmt ']['nSamplesPerSec']; rlm@3: $getid3->info['playtime_seconds'] = $info_wavpack_blockheader['total_samples'] / $getid3->info['audio']['sample_rate']; rlm@3: rlm@3: // Safe RIFF header in case there's a RIFF footer later rlm@3: $metablock_riff_header = $metablock['data']; rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x22: // ID_RIFF_TRAILER rlm@3: rlm@3: $metablock_riff_footer = $metablock_riff_header.$metablock['data']; rlm@3: rlm@3: $start_offset = $metablock['offset'] + ($metablock['large_block'] ? 4 : 2); rlm@3: rlm@3: $ftell_old = ftell($getid3->fp); rlm@3: rlm@3: // Clone getid3 rlm@3: $clone = clone $getid3; rlm@3: rlm@3: // Call public method that really should be private rlm@3: $riff = new getid3_riff($clone); rlm@3: $metablock['riff'] = $riff->ParseRIFF($start_offset, $start_offset + $metablock['size']); rlm@3: unset($clone); rlm@3: rlm@3: fseek($getid3->fp, $ftell_old, SEEK_SET); rlm@3: rlm@3: if (!empty($metablock['riff']['INFO'])) { rlm@3: getid3_riff::RIFFCommentsParse($metablock['riff']['INFO'], $metablock['comments']); rlm@3: $getid3->info['tags']['riff'] = $metablock['comments']; rlm@3: } rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x23: // ID_REPLAY_GAIN rlm@3: $getid3->warning('WavPack "Replay Gain" contents not yet handled by getID3() in metablock at offset '.$metablock['offset']); rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x24: // ID_CUESHEET rlm@3: $getid3->warning('WavPack "Cuesheet" contents not yet handled by getID3() in metablock at offset '.$metablock['offset']); rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x25: // ID_CONFIG_BLOCK rlm@3: $metablock['flags_raw'] = getid3_lib::LittleEndian2Int(substr($metablock['data'], 0, 3)); rlm@3: rlm@3: $metablock['flags']['adobe_mode'] = (bool) ($metablock['flags_raw'] & 0x000001); // "adobe" mode for 32-bit floats rlm@3: $metablock['flags']['fast_flag'] = (bool) ($metablock['flags_raw'] & 0x000002); // fast mode rlm@3: $metablock['flags']['very_fast_flag'] = (bool) ($metablock['flags_raw'] & 0x000004); // double fast rlm@3: $metablock['flags']['high_flag'] = (bool) ($metablock['flags_raw'] & 0x000008); // high quality mode rlm@3: $metablock['flags']['very_high_flag'] = (bool) ($metablock['flags_raw'] & 0x000010); // double high (not used yet) rlm@3: $metablock['flags']['bitrate_kbps'] = (bool) ($metablock['flags_raw'] & 0x000020); // bitrate is kbps, not bits / sample rlm@3: $metablock['flags']['auto_shaping'] = (bool) ($metablock['flags_raw'] & 0x000040); // automatic noise shaping rlm@3: $metablock['flags']['shape_override'] = (bool) ($metablock['flags_raw'] & 0x000080); // shaping mode specified rlm@3: $metablock['flags']['joint_override'] = (bool) ($metablock['flags_raw'] & 0x000100); // joint-stereo mode specified rlm@3: $metablock['flags']['copy_time'] = (bool) ($metablock['flags_raw'] & 0x000200); // copy file-time from source rlm@3: $metablock['flags']['create_exe'] = (bool) ($metablock['flags_raw'] & 0x000400); // create executable rlm@3: $metablock['flags']['create_wvc'] = (bool) ($metablock['flags_raw'] & 0x000800); // create correction file rlm@3: $metablock['flags']['optimize_wvc'] = (bool) ($metablock['flags_raw'] & 0x001000); // maximize bybrid compression rlm@3: $metablock['flags']['quality_mode'] = (bool) ($metablock['flags_raw'] & 0x002000); // psychoacoustic quality mode rlm@3: $metablock['flags']['raw_flag'] = (bool) ($metablock['flags_raw'] & 0x004000); // raw mode (not implemented yet) rlm@3: $metablock['flags']['calc_noise'] = (bool) ($metablock['flags_raw'] & 0x008000); // calc noise in hybrid mode rlm@3: $metablock['flags']['lossy_mode'] = (bool) ($metablock['flags_raw'] & 0x010000); // obsolete (for information) rlm@3: $metablock['flags']['extra_mode'] = (bool) ($metablock['flags_raw'] & 0x020000); // extra processing mode rlm@3: $metablock['flags']['skip_wvx'] = (bool) ($metablock['flags_raw'] & 0x040000); // no wvx stream w/ floats & big ints rlm@3: $metablock['flags']['md5_checksum'] = (bool) ($metablock['flags_raw'] & 0x080000); // compute & store MD5 signature rlm@3: $metablock['flags']['quiet_mode'] = (bool) ($metablock['flags_raw'] & 0x100000); // don't report progress % rlm@3: rlm@3: $info_wavpack['config_flags'] = $metablock['flags']; rlm@3: rlm@3: $getid3->info['audio']['encoder_options'] = trim( rlm@3: ($info_wavpack_blockheader['flags']['hybrid'] ? ' -b???' : '') . rlm@3: ($metablock['flags']['adobe_mode'] ? ' -a' : '') . rlm@3: ($metablock['flags']['optimize_wvc'] ? ' -cc' : '') . rlm@3: ($metablock['flags']['create_exe'] ? ' -e' : '') . rlm@3: ($metablock['flags']['fast_flag'] ? ' -f' : '') . rlm@3: ($metablock['flags']['joint_override'] ? ' -j?' : '') . rlm@3: ($metablock['flags']['high_flag'] ? ' -h' : '') . rlm@3: ($metablock['flags']['md5_checksum'] ? ' -m' : '') . rlm@3: ($metablock['flags']['calc_noise'] ? ' -n' : '') . rlm@3: ($metablock['flags']['shape_override'] ? ' -s?' : '') . rlm@3: ($metablock['flags']['extra_mode'] ? ' -x?' : '') rlm@3: ); rlm@3: if (!$getid3->info['audio']['encoder_options']) { rlm@3: unset($getid3->info['audio']['encoder_options']); rlm@3: } rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x26: // ID_MD5_CHECKSUM rlm@3: if (strlen($metablock['data']) == 16) { rlm@3: $getid3->info['md5_data_source'] = strtolower(getid3_lib::PrintHexBytes($metablock['data'], true, false, false)); rlm@3: } else { rlm@3: $getid3->warning('Expecting 16 bytes of WavPack "MD5 Checksum" in metablock at offset '.$metablock['offset'].', but found '.strlen($metablock['data']).' bytes'); rlm@3: } rlm@3: break; rlm@3: rlm@3: rlm@3: case 0x00: // ID_DUMMY rlm@3: case 0x01: // ID_ENCODER_INFO rlm@3: case 0x02: // ID_DECORR_TERMS rlm@3: case 0x03: // ID_DECORR_WEIGHTS rlm@3: case 0x04: // ID_DECORR_SAMPLES rlm@3: case 0x05: // ID_ENTROPY_VARS rlm@3: case 0x06: // ID_HYBRID_PROFILE rlm@3: case 0x07: // ID_SHAPING_WEIGHTS rlm@3: case 0x08: // ID_FLOAT_INFO rlm@3: case 0x09: // ID_INT32_INFO rlm@3: case 0x0A: // ID_WV_BITSTREAM rlm@3: case 0x0B: // ID_WVC_BITSTREAM rlm@3: case 0x0C: // ID_WVX_BITSTREAM rlm@3: case 0x0D: // ID_CHANNEL_INFO rlm@3: unset($metablock); rlm@3: break; rlm@3: } rlm@3: rlm@3: } rlm@3: rlm@3: if (!empty($metablock)) { rlm@3: $info_wavpack['metablocks'][] = $metablock; rlm@3: } rlm@3: rlm@3: } rlm@3: rlm@3: } rlm@3: rlm@3: $getid3->info['audio']['encoder'] = 'WavPack v'.$info_wavpack_blockheader['major_version'].'.'.str_pad($info_wavpack_blockheader['minor_version'], 2, '0', STR_PAD_LEFT); rlm@3: $getid3->info['audio']['bits_per_sample'] = $info_wavpack_blockheader['flags']['bytes_per_sample'] * 8; rlm@3: $getid3->info['audio']['channels'] = ($info_wavpack_blockheader['flags']['mono'] ? 1 : 2); rlm@3: rlm@3: if (@$getid3->info['playtime_seconds']) { rlm@3: $getid3->info['audio']['bitrate'] = (($getid3->info['avdataend'] - $getid3->info['avdataoffset']) * 8) / $getid3->info['playtime_seconds']; rlm@3: } else { rlm@3: $getid3->info['audio']['dataformat'] = 'wvc'; rlm@3: } rlm@3: rlm@3: return true; rlm@3: } rlm@3: rlm@3: rlm@3: rlm@3: public static function WavPackMetablockNameLookup($id) { rlm@3: rlm@3: static $lookup = array( rlm@3: 0x00 => 'Dummy', rlm@3: 0x01 => 'Encoder Info', rlm@3: 0x02 => 'Decorrelation Terms', rlm@3: 0x03 => 'Decorrelation Weights', rlm@3: 0x04 => 'Decorrelation Samples', rlm@3: 0x05 => 'Entropy Variables', rlm@3: 0x06 => 'Hybrid Profile', rlm@3: 0x07 => 'Shaping Weights', rlm@3: 0x08 => 'Float Info', rlm@3: 0x09 => 'Int32 Info', rlm@3: 0x0A => 'WV Bitstream', rlm@3: 0x0B => 'WVC Bitstream', rlm@3: 0x0C => 'WVX Bitstream', rlm@3: 0x0D => 'Channel Info', rlm@3: 0x21 => 'RIFF header', rlm@3: 0x22 => 'RIFF trailer', rlm@3: 0x23 => 'Replay Gain', rlm@3: 0x24 => 'Cuesheet', rlm@3: 0x25 => 'Config Block', rlm@3: 0x26 => 'MD5 Checksum', rlm@3: ); rlm@3: rlm@3: return (@$lookup[$id]); rlm@3: } rlm@3: rlm@3: } rlm@3: rlm@3: rlm@3: ?>