ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Wavpack.php
Go to the documentation of this file.
1<?php
2
3namespace GetId3\Module\Audio;
4
5use GetId3\Handler\BaseHandler;
6use GetId3\Lib\Helper;
7use GetId3\GetId3Core;
8use GetId3\Module\AudioVideo\Riff;
9
12// available at http://getid3.sourceforge.net //
13// or http://www.getid3.org //
15// See readme.txt for more details //
17// //
18// module.audio.wavpack.php //
19// module for analyzing WavPack v4.0+ Audio files //
20// dependencies: NONE //
21// ///
23
31class Wavpack extends BaseHandler
32{
33
38 public function analyze()
39 {
40 $info = &$this->getid3->info;
41
42 fseek($this->getid3->fp, $info['avdataoffset'], SEEK_SET);
43
44 while (true) {
45
46 $wavpackheader = fread($this->getid3->fp, 32);
47
48 if (ftell($this->getid3->fp) >= $info['avdataend']) {
49 break;
50 } elseif (feof($this->getid3->fp)) {
51 break;
52 } elseif (
53 isset($info['wavpack']['blockheader']['total_samples']) &&
54 isset($info['wavpack']['blockheader']['block_samples']) &&
55 ($info['wavpack']['blockheader']['total_samples'] > 0) &&
56 ($info['wavpack']['blockheader']['block_samples'] > 0) &&
57 (!isset($info['wavpack']['riff_trailer_size']) || ($info['wavpack']['riff_trailer_size'] <= 0)) &&
58 ((isset($info['wavpack']['config_flags']['md5_checksum']) && ($info['wavpack']['config_flags']['md5_checksum'] === false)) || !empty($info['md5_data_source']))) {
59 break;
60 }
61
62 $blockheader_offset = ftell($this->getid3->fp) - 32;
63 $blockheader_magic = substr($wavpackheader, 0, 4);
64 $blockheader_size = Helper::LittleEndian2Int(substr($wavpackheader, 4, 4));
65
66 $magic = 'wvpk';
67 if ($blockheader_magic != $magic) {
68 $info['error'][] = 'Expecting "'.Helper::PrintHexBytes($magic).'" at offset '.$blockheader_offset.', found "'.Helper::PrintHexBytes($blockheader_magic).'"';
69 switch (isset($info['audio']['dataformat']) ? $info['audio']['dataformat'] : '') {
70 case 'wavpack':
71 case 'wvc':
72 break;
73 default:
74 unset($info['fileformat']);
75 unset($info['audio']);
76 unset($info['wavpack']);
77 break;
78 }
79
80 return false;
81 }
82
83 if (empty($info['wavpack']['blockheader']['block_samples']) ||
84 empty($info['wavpack']['blockheader']['total_samples']) ||
85 ($info['wavpack']['blockheader']['block_samples'] <= 0) ||
86 ($info['wavpack']['blockheader']['total_samples'] <= 0)) {
87 // Also, it is possible that the first block might not have
88 // any samples (block_samples == 0) and in this case you should skip blocks
89 // until you find one with samples because the other information (like
90 // total_samples) are not guaranteed to be correct until (block_samples > 0)
91
92 // Finally, I have defined a format for files in which the length is not known
93 // (for example when raw files are created using pipes). In these cases
94 // total_samples will be -1 and you must seek to the final block to determine
95 // the total number of samples.
96
97 $info['audio']['dataformat'] = 'wavpack';
98 $info['fileformat'] = 'wavpack';
99 $info['audio']['lossless'] = true;
100 $info['audio']['bitrate_mode'] = 'vbr';
101
102 $info['wavpack']['blockheader']['offset'] = $blockheader_offset;
103 $info['wavpack']['blockheader']['magic'] = $blockheader_magic;
104 $info['wavpack']['blockheader']['size'] = $blockheader_size;
105
106 if ($info['wavpack']['blockheader']['size'] >= 0x100000) {
107 $info['error'][] = 'Expecting WavPack block size less than "0x100000", found "'.$info['wavpack']['blockheader']['size'].'" at offset '.$info['wavpack']['blockheader']['offset'];
108 switch (isset($info['audio']['dataformat']) ? $info['audio']['dataformat'] : '') {
109 case 'wavpack':
110 case 'wvc':
111 break;
112 default:
113 unset($info['fileformat']);
114 unset($info['audio']);
115 unset($info['wavpack']);
116 break;
117 }
118
119 return false;
120 }
121
122 $info['wavpack']['blockheader']['minor_version'] = ord($wavpackheader{8});
123 $info['wavpack']['blockheader']['major_version'] = ord($wavpackheader{9});
124
125 if (($info['wavpack']['blockheader']['major_version'] != 4) ||
126 (($info['wavpack']['blockheader']['minor_version'] < 4) &&
127 ($info['wavpack']['blockheader']['minor_version'] > 16))) {
128 $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'];
129 switch (isset($info['audio']['dataformat']) ? $info['audio']['dataformat'] : '') {
130 case 'wavpack':
131 case 'wvc':
132 break;
133 default:
134 unset($info['fileformat']);
135 unset($info['audio']);
136 unset($info['wavpack']);
137 break;
138 }
139
140 return false;
141 }
142
143 $info['wavpack']['blockheader']['track_number'] = ord($wavpackheader{10}); // unused
144 $info['wavpack']['blockheader']['index_number'] = ord($wavpackheader{11}); // unused
145 $info['wavpack']['blockheader']['total_samples'] = Helper::LittleEndian2Int(substr($wavpackheader, 12, 4));
146 $info['wavpack']['blockheader']['block_index'] = Helper::LittleEndian2Int(substr($wavpackheader, 16, 4));
147 $info['wavpack']['blockheader']['block_samples'] = Helper::LittleEndian2Int(substr($wavpackheader, 20, 4));
148 $info['wavpack']['blockheader']['flags_raw'] = Helper::LittleEndian2Int(substr($wavpackheader, 24, 4));
149 $info['wavpack']['blockheader']['crc'] = Helper::LittleEndian2Int(substr($wavpackheader, 28, 4));
150
151 $info['wavpack']['blockheader']['flags']['bytes_per_sample'] = 1 + ($info['wavpack']['blockheader']['flags_raw'] & 0x00000003);
152 $info['wavpack']['blockheader']['flags']['mono'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000004);
153 $info['wavpack']['blockheader']['flags']['hybrid'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000008);
154 $info['wavpack']['blockheader']['flags']['joint_stereo'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000010);
155 $info['wavpack']['blockheader']['flags']['cross_decorrelation'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000020);
156 $info['wavpack']['blockheader']['flags']['hybrid_noiseshape'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000040);
157 $info['wavpack']['blockheader']['flags']['ieee_32bit_float'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000080);
158 $info['wavpack']['blockheader']['flags']['int_32bit'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000100);
159 $info['wavpack']['blockheader']['flags']['hybrid_bitrate_noise'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000200);
160 $info['wavpack']['blockheader']['flags']['hybrid_balance_noise'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000400);
161 $info['wavpack']['blockheader']['flags']['multichannel_initial'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00000800);
162 $info['wavpack']['blockheader']['flags']['multichannel_final'] = (bool) ($info['wavpack']['blockheader']['flags_raw'] & 0x00001000);
163
164 $info['audio']['lossless'] = !$info['wavpack']['blockheader']['flags']['hybrid'];
165 }
166
167 while (!feof($this->getid3->fp) && (ftell($this->getid3->fp) < ($blockheader_offset + $blockheader_size + 8))) {
168
169 $metablock = array('offset'=>ftell($this->getid3->fp));
170 $metablockheader = fread($this->getid3->fp, 2);
171 if (feof($this->getid3->fp)) {
172 break;
173 }
174 $metablock['id'] = ord($metablockheader{0});
175 $metablock['function_id'] = ($metablock['id'] & 0x3F);
176 $metablock['function_name'] = $this->WavPackMetablockNameLookup($metablock['function_id']);
177
178 // The 0x20 bit in the id of the meta subblocks (which is defined as
179 // ID_OPTIONAL_DATA) is a permanent part of the id. The idea is that
180 // if a decoder encounters an id that it does not know about, it uses
181 // that "ID_OPTIONAL_DATA" flag to determine what to do. If it is set
182 // then the decoder simply ignores the metadata, but if it is zero
183 // then the decoder should quit because it means that an understanding
184 // of the metadata is required to correctly decode the audio.
185 $metablock['non_decoder'] = (bool) ($metablock['id'] & 0x20);
186
187 $metablock['padded_data'] = (bool) ($metablock['id'] & 0x40);
188 $metablock['large_block'] = (bool) ($metablock['id'] & 0x80);
189 if ($metablock['large_block']) {
190 $metablockheader .= fread($this->getid3->fp, 2);
191 }
192 $metablock['size'] = Helper::LittleEndian2Int(substr($metablockheader, 1)) * 2; // size is stored in words
193 $metablock['data'] = null;
194
195 if ($metablock['size'] > 0) {
196
197 switch ($metablock['function_id']) {
198 case 0x21: // ID_RIFF_HEADER
199 case 0x22: // ID_RIFF_TRAILER
200 case 0x23: // ID_REPLAY_GAIN
201 case 0x24: // ID_CUESHEET
202 case 0x25: // ID_CONFIG_BLOCK
203 case 0x26: // ID_MD5_CHECKSUM
204 $metablock['data'] = fread($this->getid3->fp, $metablock['size']);
205
206 if ($metablock['padded_data']) {
207 // padded to the nearest even byte
208 $metablock['size']--;
209 $metablock['data'] = substr($metablock['data'], 0, -1);
210 }
211 break;
212
213 case 0x00: // ID_DUMMY
214 case 0x01: // ID_ENCODER_INFO
215 case 0x02: // ID_DECORR_TERMS
216 case 0x03: // ID_DECORR_WEIGHTS
217 case 0x04: // ID_DECORR_SAMPLES
218 case 0x05: // ID_ENTROPY_VARS
219 case 0x06: // ID_HYBRID_PROFILE
220 case 0x07: // ID_SHAPING_WEIGHTS
221 case 0x08: // ID_FLOAT_INFO
222 case 0x09: // ID_INT32_INFO
223 case 0x0A: // ID_WV_BITSTREAM
224 case 0x0B: // ID_WVC_BITSTREAM
225 case 0x0C: // ID_WVX_BITSTREAM
226 case 0x0D: // ID_CHANNEL_INFO
227 fseek($this->getid3->fp, $metablock['offset'] + ($metablock['large_block'] ? 4 : 2) + $metablock['size'], SEEK_SET);
228 break;
229
230 default:
231 $info['warning'][] = 'Unexpected metablock type "0x'.str_pad(dechex($metablock['function_id']), 2, '0', STR_PAD_LEFT).'" at offset '.$metablock['offset'];
232 fseek($this->getid3->fp, $metablock['offset'] + ($metablock['large_block'] ? 4 : 2) + $metablock['size'], SEEK_SET);
233 break;
234 }
235
236 switch ($metablock['function_id']) {
237 case 0x21: // ID_RIFF_HEADER
238 $original_wav_filesize = Helper::LittleEndian2Int(substr($metablock['data'], 4, 4));
239
240 $getid3_temp = new GetId3Core();
241 $getid3_temp->openfile($this->getid3->filename);
242 $getid3_riff = new Riff($getid3_temp);
243 $getid3_riff->ParseRIFFdata($metablock['data']);
244 $metablock['riff'] = $getid3_temp->info['riff'];
245 $info['audio']['sample_rate'] = $getid3_temp->info['riff']['raw']['fmt ']['nSamplesPerSec'];
246 unset($getid3_riff, $getid3_temp);
247
248 $metablock['riff']['original_filesize'] = $original_wav_filesize;
249 $info['wavpack']['riff_trailer_size'] = $original_wav_filesize - $metablock['riff']['WAVE']['data'][0]['size'] - $metablock['riff']['header_size'];
250 $info['playtime_seconds'] = $info['wavpack']['blockheader']['total_samples'] / $info['audio']['sample_rate'];
251
252 // Safe RIFF header in case there's a RIFF footer later
253 $metablockRIFFheader = $metablock['data'];
254 break;
255
256
257 case 0x22: // ID_RIFF_TRAILER
258 $metablockRIFFfooter = $metablockRIFFheader.$metablock['data'];
259
260 $startoffset = $metablock['offset'] + ($metablock['large_block'] ? 4 : 2);
261 $getid3_temp = new GetId3Core();
262 $getid3_temp->openfile($this->getid3->filename);
263 $getid3_temp->info['avdataend'] = $info['avdataend'];
264 $getid3_temp->info['fileformat'] = 'riff';
265 $getid3_riff = new Riff($getid3_temp);
266 $metablock['riff'] = $getid3_riff->ParseRIFF($startoffset, $startoffset + $metablock['size']);
267
268 if (!empty($metablock['riff']['INFO'])) {
269 $getid3_riff->RIFFcommentsParse($metablock['riff']['INFO'], $metablock['comments']);
270 $info['tags']['riff'] = $metablock['comments'];
271 }
272 unset($getid3_temp, $getid3_riff);
273 break;
274
275
276 case 0x23: // ID_REPLAY_GAIN
277 $info['warning'][] = 'WavPack "Replay Gain" contents not yet handled by GetId3Core() in metablock at offset '.$metablock['offset'];
278 break;
279
280
281 case 0x24: // ID_CUESHEET
282 $info['warning'][] = 'WavPack "Cuesheet" contents not yet handled by GetId3Core() in metablock at offset '.$metablock['offset'];
283 break;
284
285
286 case 0x25: // ID_CONFIG_BLOCK
287 $metablock['flags_raw'] = Helper::LittleEndian2Int(substr($metablock['data'], 0, 3));
288
289 $metablock['flags']['adobe_mode'] = (bool) ($metablock['flags_raw'] & 0x000001); // "adobe" mode for 32-bit floats
290 $metablock['flags']['fast_flag'] = (bool) ($metablock['flags_raw'] & 0x000002); // fast mode
291 $metablock['flags']['very_fast_flag'] = (bool) ($metablock['flags_raw'] & 0x000004); // double fast
292 $metablock['flags']['high_flag'] = (bool) ($metablock['flags_raw'] & 0x000008); // high quality mode
293 $metablock['flags']['very_high_flag'] = (bool) ($metablock['flags_raw'] & 0x000010); // double high (not used yet)
294 $metablock['flags']['bitrate_kbps'] = (bool) ($metablock['flags_raw'] & 0x000020); // bitrate is kbps, not bits / sample
295 $metablock['flags']['auto_shaping'] = (bool) ($metablock['flags_raw'] & 0x000040); // automatic noise shaping
296 $metablock['flags']['shape_override'] = (bool) ($metablock['flags_raw'] & 0x000080); // shaping mode specified
297 $metablock['flags']['joint_override'] = (bool) ($metablock['flags_raw'] & 0x000100); // joint-stereo mode specified
298 $metablock['flags']['copy_time'] = (bool) ($metablock['flags_raw'] & 0x000200); // copy file-time from source
299 $metablock['flags']['create_exe'] = (bool) ($metablock['flags_raw'] & 0x000400); // create executable
300 $metablock['flags']['create_wvc'] = (bool) ($metablock['flags_raw'] & 0x000800); // create correction file
301 $metablock['flags']['optimize_wvc'] = (bool) ($metablock['flags_raw'] & 0x001000); // maximize bybrid compression
302 $metablock['flags']['quality_mode'] = (bool) ($metablock['flags_raw'] & 0x002000); // psychoacoustic quality mode
303 $metablock['flags']['raw_flag'] = (bool) ($metablock['flags_raw'] & 0x004000); // raw mode (not implemented yet)
304 $metablock['flags']['calc_noise'] = (bool) ($metablock['flags_raw'] & 0x008000); // calc noise in hybrid mode
305 $metablock['flags']['lossy_mode'] = (bool) ($metablock['flags_raw'] & 0x010000); // obsolete (for information)
306 $metablock['flags']['extra_mode'] = (bool) ($metablock['flags_raw'] & 0x020000); // extra processing mode
307 $metablock['flags']['skip_wvx'] = (bool) ($metablock['flags_raw'] & 0x040000); // no wvx stream w/ floats & big ints
308 $metablock['flags']['md5_checksum'] = (bool) ($metablock['flags_raw'] & 0x080000); // compute & store MD5 signature
309 $metablock['flags']['quiet_mode'] = (bool) ($metablock['flags_raw'] & 0x100000); // don't report progress %
310
311 $info['wavpack']['config_flags'] = $metablock['flags'];
312
313 $info['audio']['encoder_options'] = '';
314 if ($info['wavpack']['blockheader']['flags']['hybrid']) {
315 $info['audio']['encoder_options'] .= ' -b???';
316 }
317 $info['audio']['encoder_options'] .= ($metablock['flags']['adobe_mode'] ? ' -a' : '');
318 $info['audio']['encoder_options'] .= ($metablock['flags']['optimize_wvc'] ? ' -cc' : '');
319 $info['audio']['encoder_options'] .= ($metablock['flags']['create_exe'] ? ' -e' : '');
320 $info['audio']['encoder_options'] .= ($metablock['flags']['fast_flag'] ? ' -f' : '');
321 $info['audio']['encoder_options'] .= ($metablock['flags']['joint_override'] ? ' -j?' : '');
322 $info['audio']['encoder_options'] .= ($metablock['flags']['high_flag'] ? ' -h' : '');
323 $info['audio']['encoder_options'] .= ($metablock['flags']['md5_checksum'] ? ' -m' : '');
324 $info['audio']['encoder_options'] .= ($metablock['flags']['calc_noise'] ? ' -n' : '');
325 $info['audio']['encoder_options'] .= ($metablock['flags']['shape_override'] ? ' -s?' : '');
326 $info['audio']['encoder_options'] .= ($metablock['flags']['extra_mode'] ? ' -x?' : '');
327 if (!empty($info['audio']['encoder_options'])) {
328 $info['audio']['encoder_options'] = trim($info['audio']['encoder_options']);
329 } elseif (isset($info['audio']['encoder_options'])) {
330 unset($info['audio']['encoder_options']);
331 }
332 break;
333
334 case 0x26: // ID_MD5_CHECKSUM
335 if (strlen($metablock['data']) == 16) {
336 $info['md5_data_source'] = strtolower(Helper::PrintHexBytes($metablock['data'], true, false, false));
337 } else {
338 $info['warning'][] = 'Expecting 16 bytes of WavPack "MD5 Checksum" in metablock at offset '.$metablock['offset'].', but found '.strlen($metablock['data']).' bytes';
339 }
340 break;
341
342 case 0x00: // ID_DUMMY
343 case 0x01: // ID_ENCODER_INFO
344 case 0x02: // ID_DECORR_TERMS
345 case 0x03: // ID_DECORR_WEIGHTS
346 case 0x04: // ID_DECORR_SAMPLES
347 case 0x05: // ID_ENTROPY_VARS
348 case 0x06: // ID_HYBRID_PROFILE
349 case 0x07: // ID_SHAPING_WEIGHTS
350 case 0x08: // ID_FLOAT_INFO
351 case 0x09: // ID_INT32_INFO
352 case 0x0A: // ID_WV_BITSTREAM
353 case 0x0B: // ID_WVC_BITSTREAM
354 case 0x0C: // ID_WVX_BITSTREAM
355 case 0x0D: // ID_CHANNEL_INFO
356 unset($metablock);
357 break;
358 }
359
360 }
361 if (!empty($metablock)) {
362 $info['wavpack']['metablocks'][] = $metablock;
363 }
364
365 }
366
367 }
368
369 $info['audio']['encoder'] = 'WavPack v'.$info['wavpack']['blockheader']['major_version'].'.'.str_pad($info['wavpack']['blockheader']['minor_version'], 2, '0', STR_PAD_LEFT);
370 $info['audio']['bits_per_sample'] = $info['wavpack']['blockheader']['flags']['bytes_per_sample'] * 8;
371 $info['audio']['channels'] = ($info['wavpack']['blockheader']['flags']['mono'] ? 1 : 2);
372
373 if (!empty($info['playtime_seconds'])) {
374
375 $info['audio']['bitrate'] = (($info['avdataend'] - $info['avdataoffset']) * 8) / $info['playtime_seconds'];
376
377 } else {
378
379 $info['audio']['dataformat'] = 'wvc';
380
381 }
382
383 return true;
384 }
385
392 public function WavPackMetablockNameLookup(&$id)
393 {
394 static $WavPackMetablockNameLookup = array(
395 0x00 => 'Dummy',
396 0x01 => 'Encoder Info',
397 0x02 => 'Decorrelation Terms',
398 0x03 => 'Decorrelation Weights',
399 0x04 => 'Decorrelation Samples',
400 0x05 => 'Entropy Variables',
401 0x06 => 'Hybrid Profile',
402 0x07 => 'Shaping Weights',
403 0x08 => 'Float Info',
404 0x09 => 'Int32 Info',
405 0x0A => 'WV Bitstream',
406 0x0B => 'WVC Bitstream',
407 0x0C => 'WVX Bitstream',
408 0x0D => 'Channel Info',
409 0x21 => 'RIFF header',
410 0x22 => 'RIFF trailer',
411 0x23 => 'Replay Gain',
412 0x24 => 'Cuesheet',
413 0x25 => 'Config Block',
414 0x26 => 'MD5 Checksum',
415 );
416
417 return (isset($WavPackMetablockNameLookup[$id]) ? $WavPackMetablockNameLookup[$id] : '');
418 }
419}
php
An exception for terminatinating execution or to throw for unit testing.
GetId3\GetId3Core
GetId3() by James Heinrich info@getid3.org //.
Definition: GetId3Core.php:26
GetId3\Handler\BaseHandler
GetId3() by James Heinrich info@getid3.org //.
Definition: BaseHandler.php:26
GetId3\Handler\BaseHandler\fseek
fseek($bytes, $whence=SEEK_SET)
Definition: BaseHandler.php:148
GetId3\Lib\Helper
GetId3() by James Heinrich info@getid3.org //.
Definition: Helper.php:27
GetId3\Lib\Helper\LittleEndian2Int
static LittleEndian2Int($byteword, $signed=false)
Definition: Helper.php:413
GetId3\Lib\Helper\PrintHexBytes
static PrintHexBytes($string, $hex=true, $spaces=true, $htmlencoding='UTF-8')
Definition: Helper.php:36
GetId3\Module\AudioVideo\Riff
GetId3() by James Heinrich info@getid3.org //.
Definition: Riff.php:43
GetId3\Module\Audio\Wavpack
GetId3() by James Heinrich info@getid3.org //.
Definition: Wavpack.php:32
GetId3\Module\Audio\Wavpack\WavPackMetablockNameLookup
WavPackMetablockNameLookup(&$id)
@staticvar array $WavPackMetablockNameLookup
Definition: Wavpack.php:392
$info
$info
Definition: example_052.php:80