ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions
getid3_voc Class Reference

getID3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g // More...

+ Inheritance diagram for getid3_voc:
+ Collaboration diagram for getid3_voc:

Public Member Functions

 Analyze ()
 
 VOCcompressionTypeLookup ($index)
 
 VOCwFormatLookup ($index)
 
 VOCwFormatActualBitsPerSampleLookup ($index)
 
- Public Member Functions inherited from getid3_handler
 __construct (getID3 $getid3, $call_module=null)
 
 Analyze ()
 
 AnalyzeString ($string)
 
 setStringMode ($string)
 
 saveAttachment ($name, $offset, $length, $image_mime=null)
 

Additional Inherited Members

- Protected Member Functions inherited from getid3_handler
 ftell ()
 
 fread ($bytes)
 
 fseek ($bytes, $whence=SEEK_SET)
 
 feof ()
 
 isDependencyFor ($module)
 
 error ($text)
 
 warning ($text)
 
 notice ($text)
 
- Protected Attributes inherited from getid3_handler
 $getid3
 
 $data_string_flag = false
 
 $data_string = ''
 
 $data_string_position = 0
 
 $data_string_length = 0
 

Detailed Description

getID3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //

Definition at line 18 of file module.audio.voc.php.

Member Function Documentation

◆ Analyze()

getid3_voc::Analyze ( )

Definition at line 21 of file module.audio.voc.php.

References $info, getid3_lib\CastAsInt(), getid3_handler\error(), getid3_handler\feof(), getid3_handler\fread(), getid3_handler\fseek(), getid3_handler\ftell(), getid3_lib\LittleEndian2Int(), getid3_lib\PrintHexBytes(), getid3_lib\safe_inc(), getid3_lib\trunc(), VOCcompressionTypeLookup(), VOCwFormatActualBitsPerSampleLookup(), VOCwFormatLookup(), and getid3_handler\warning().

21  {
22  $info = &$this->getid3->info;
23 
24  $OriginalAVdataOffset = $info['avdataoffset'];
25  $this->fseek($info['avdataoffset']);
26  $VOCheader = $this->fread(26);
27 
28  $magic = 'Creative Voice File';
29  if (substr($VOCheader, 0, 19) != $magic) {
30  $this->error('Expecting "'.getid3_lib::PrintHexBytes($magic).'" at offset '.$info['avdataoffset'].', found "'.getid3_lib::PrintHexBytes(substr($VOCheader, 0, 19)).'"');
31  return false;
32  }
33 
34  // shortcuts
35  $thisfile_audio = &$info['audio'];
36  $info['voc'] = array();
37  $thisfile_voc = &$info['voc'];
38 
39  $info['fileformat'] = 'voc';
40  $thisfile_audio['dataformat'] = 'voc';
41  $thisfile_audio['bitrate_mode'] = 'cbr';
42  $thisfile_audio['lossless'] = true;
43  $thisfile_audio['channels'] = 1; // might be overriden below
44  $thisfile_audio['bits_per_sample'] = 8; // might be overriden below
45 
46  // byte # Description
47  // ------ ------------------------------------------
48  // 00-12 'Creative Voice File'
49  // 13 1A (eof to abort printing of file)
50  // 14-15 Offset of first datablock in .voc file (std 1A 00 in Intel Notation)
51  // 16-17 Version number (minor,major) (VOC-HDR puts 0A 01)
52  // 18-19 2's Comp of Ver. # + 1234h (VOC-HDR puts 29 11)
53 
54  $thisfile_voc['header']['datablock_offset'] = getid3_lib::LittleEndian2Int(substr($VOCheader, 20, 2));
55  $thisfile_voc['header']['minor_version'] = getid3_lib::LittleEndian2Int(substr($VOCheader, 22, 1));
56  $thisfile_voc['header']['major_version'] = getid3_lib::LittleEndian2Int(substr($VOCheader, 23, 1));
57 
58  do {
59 
60  $BlockOffset = $this->ftell();
61  $BlockData = $this->fread(4);
62  $BlockType = ord($BlockData{0});
63  $BlockSize = getid3_lib::LittleEndian2Int(substr($BlockData, 1, 3));
64  $ThisBlock = array();
65 
66  getid3_lib::safe_inc($thisfile_voc['blocktypes'][$BlockType], 1);
67  switch ($BlockType) {
68  case 0: // Terminator
69  // do nothing, we'll break out of the loop down below
70  break;
71 
72  case 1: // Sound data
73  $BlockData .= $this->fread(2);
74  if ($info['avdataoffset'] <= $OriginalAVdataOffset) {
75  $info['avdataoffset'] = $this->ftell();
76  }
77  $this->fseek($BlockSize - 2, SEEK_CUR);
78 
79  $ThisBlock['sample_rate_id'] = getid3_lib::LittleEndian2Int(substr($BlockData, 4, 1));
80  $ThisBlock['compression_type'] = getid3_lib::LittleEndian2Int(substr($BlockData, 5, 1));
81 
82  $ThisBlock['compression_name'] = $this->VOCcompressionTypeLookup($ThisBlock['compression_type']);
83  if ($ThisBlock['compression_type'] <= 3) {
84  $thisfile_voc['compressed_bits_per_sample'] = getid3_lib::CastAsInt(str_replace('-bit', '', $ThisBlock['compression_name']));
85  }
86 
87  // Less accurate sample_rate calculation than the Extended block (#8) data (but better than nothing if Extended Block is not available)
88  if (empty($thisfile_audio['sample_rate'])) {
89  // SR byte = 256 - (1000000 / sample_rate)
90  $thisfile_audio['sample_rate'] = getid3_lib::trunc((1000000 / (256 - $ThisBlock['sample_rate_id'])) / $thisfile_audio['channels']);
91  }
92  break;
93 
94  case 2: // Sound continue
95  case 3: // Silence
96  case 4: // Marker
97  case 6: // Repeat
98  case 7: // End repeat
99  // nothing useful, just skip
100  $this->fseek($BlockSize, SEEK_CUR);
101  break;
102 
103  case 8: // Extended
104  $BlockData .= $this->fread(4);
105 
106  //00-01 Time Constant:
107  // Mono: 65536 - (256000000 / sample_rate)
108  // Stereo: 65536 - (256000000 / (sample_rate * 2))
109  $ThisBlock['time_constant'] = getid3_lib::LittleEndian2Int(substr($BlockData, 4, 2));
110  $ThisBlock['pack_method'] = getid3_lib::LittleEndian2Int(substr($BlockData, 6, 1));
111  $ThisBlock['stereo'] = (bool) getid3_lib::LittleEndian2Int(substr($BlockData, 7, 1));
112 
113  $thisfile_audio['channels'] = ($ThisBlock['stereo'] ? 2 : 1);
114  $thisfile_audio['sample_rate'] = getid3_lib::trunc((256000000 / (65536 - $ThisBlock['time_constant'])) / $thisfile_audio['channels']);
115  break;
116 
117  case 9: // data block that supersedes blocks 1 and 8. Used for stereo, 16 bit
118  $BlockData .= $this->fread(12);
119  if ($info['avdataoffset'] <= $OriginalAVdataOffset) {
120  $info['avdataoffset'] = $this->ftell();
121  }
122  $this->fseek($BlockSize - 12, SEEK_CUR);
123 
124  $ThisBlock['sample_rate'] = getid3_lib::LittleEndian2Int(substr($BlockData, 4, 4));
125  $ThisBlock['bits_per_sample'] = getid3_lib::LittleEndian2Int(substr($BlockData, 8, 1));
126  $ThisBlock['channels'] = getid3_lib::LittleEndian2Int(substr($BlockData, 9, 1));
127  $ThisBlock['wFormat'] = getid3_lib::LittleEndian2Int(substr($BlockData, 10, 2));
128 
129  $ThisBlock['compression_name'] = $this->VOCwFormatLookup($ThisBlock['wFormat']);
130  if ($this->VOCwFormatActualBitsPerSampleLookup($ThisBlock['wFormat'])) {
131  $thisfile_voc['compressed_bits_per_sample'] = $this->VOCwFormatActualBitsPerSampleLookup($ThisBlock['wFormat']);
132  }
133 
134  $thisfile_audio['sample_rate'] = $ThisBlock['sample_rate'];
135  $thisfile_audio['bits_per_sample'] = $ThisBlock['bits_per_sample'];
136  $thisfile_audio['channels'] = $ThisBlock['channels'];
137  break;
138 
139  default:
140  $this->warning('Unhandled block type "'.$BlockType.'" at offset '.$BlockOffset);
141  $this->fseek($BlockSize, SEEK_CUR);
142  break;
143  }
144 
145  if (!empty($ThisBlock)) {
146  $ThisBlock['block_offset'] = $BlockOffset;
147  $ThisBlock['block_size'] = $BlockSize;
148  $ThisBlock['block_type_id'] = $BlockType;
149  $thisfile_voc['blocks'][] = $ThisBlock;
150  }
151 
152  } while (!feof($this->getid3->fp) && ($BlockType != 0));
153 
154  // Terminator block doesn't have size field, so seek back 3 spaces
155  $this->fseek(-3, SEEK_CUR);
156 
157  ksort($thisfile_voc['blocktypes']);
158 
159  if (!empty($thisfile_voc['compressed_bits_per_sample'])) {
160  $info['playtime_seconds'] = (($info['avdataend'] - $info['avdataoffset']) * 8) / ($thisfile_voc['compressed_bits_per_sample'] * $thisfile_audio['channels'] * $thisfile_audio['sample_rate']);
161  $thisfile_audio['bitrate'] = (($info['avdataend'] - $info['avdataoffset']) * 8) / $info['playtime_seconds'];
162  }
163 
164  return true;
165  }
getid3_lib\safe_inc
static safe_inc(&$variable, $increment=1)
Definition: getid3.lib.php:56
getid3_handler\error
error($text)
Definition: getid3.php:1752
getid3_handler\warning
warning($text)
Definition: getid3.php:1758
getid3_lib\LittleEndian2Int
static LittleEndian2Int($byteword, $signed=false)
Definition: getid3.lib.php:292
getid3_voc\VOCcompressionTypeLookup
VOCcompressionTypeLookup($index)
Definition: module.audio.voc.php:167
getid3_voc\VOCwFormatActualBitsPerSampleLookup
VOCwFormatActualBitsPerSampleLookup($index)
Definition: module.audio.voc.php:191
getid3_lib\trunc
static trunc($floatnumber)
Definition: getid3.lib.php:39
getid3_voc\VOCwFormatLookup
VOCwFormatLookup($index)
Definition: module.audio.voc.php:177
getid3_lib\CastAsInt
static CastAsInt($floatnum)
Definition: getid3.lib.php:65
getid3_lib\PrintHexBytes
static PrintHexBytes($string, $hex=true, $spaces=true, $htmlencoding='UTF-8')
Definition: getid3.lib.php:18
getid3_handler\fread
fread($bytes)
Definition: getid3.php:1683
getid3_handler\feof
feof()
Definition: getid3.php:1741
getid3_handler\fseek
fseek($bytes, $whence=SEEK_SET)
Definition: getid3.php:1711
$info
$info
Definition: index.php:5
getid3_handler\ftell
ftell()
Definition: getid3.php:1676
+ Here is the call graph for this function:

◆ VOCcompressionTypeLookup()

getid3_voc::VOCcompressionTypeLookup (   $index)

Definition at line 167 of file module.audio.voc.php.

References $index.

Referenced by Analyze().

167  {
168  static $VOCcompressionTypeLookup = array(
169  0 => '8-bit',
170  1 => '4-bit',
171  2 => '2.6-bit',
172  3 => '2-bit'
173  );
174  return (isset($VOCcompressionTypeLookup[$index]) ? $VOCcompressionTypeLookup[$index] : 'Multi DAC ('.($index - 3).') channels');
175  }
$index
$index
Definition: metadata.php:60
+ Here is the caller graph for this function:

◆ VOCwFormatActualBitsPerSampleLookup()

getid3_voc::VOCwFormatActualBitsPerSampleLookup (   $index)

Definition at line 191 of file module.audio.voc.php.

References $index.

Referenced by Analyze().

191  {
192  static $VOCwFormatLookup = array(
193  0x0000 => 8,
194  0x0001 => 4,
195  0x0002 => 3,
196  0x0003 => 2,
197  0x0004 => 16,
198  0x0006 => 8,
199  0x0007 => 8,
200  0x2000 => 4
201  );
202  return (isset($VOCwFormatLookup[$index]) ? $VOCwFormatLookup[$index] : false);
203  }
$index
$index
Definition: metadata.php:60
+ Here is the caller graph for this function:

◆ VOCwFormatLookup()

getid3_voc::VOCwFormatLookup (   $index)

Definition at line 177 of file module.audio.voc.php.

References $index.

Referenced by Analyze().

177  {
178  static $VOCwFormatLookup = array(
179  0x0000 => '8-bit unsigned PCM',
180  0x0001 => 'Creative 8-bit to 4-bit ADPCM',
181  0x0002 => 'Creative 8-bit to 3-bit ADPCM',
182  0x0003 => 'Creative 8-bit to 2-bit ADPCM',
183  0x0004 => '16-bit signed PCM',
184  0x0006 => 'CCITT a-Law',
185  0x0007 => 'CCITT u-Law',
186  0x2000 => 'Creative 16-bit to 4-bit ADPCM'
187  );
188  return (isset($VOCwFormatLookup[$index]) ? $VOCwFormatLookup[$index] : false);
189  }
$index
$index
Definition: metadata.php:60
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: