ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
module.audio.shorten.php
Go to the documentation of this file.
1 <?php
4 // available at http://getid3.sourceforge.net //
5 // or http://www.getid3.org //
6 // also https://github.com/JamesHeinrich/getID3 //
8 // See readme.txt for more details //
10 // //
11 // module.audio.shorten.php //
12 // module for analyzing Shorten Audio files //
13 // dependencies: NONE //
14 // ///
16 
17 
18 class getid3_shorten extends getid3_handler
19 {
20 
21  public function Analyze() {
22  $info = &$this->getid3->info;
23 
24  $this->fseek($info['avdataoffset']);
25 
26  $ShortenHeader = $this->fread(8);
27  $magic = 'ajkg';
28  if (substr($ShortenHeader, 0, 4) != $magic) {
29  $this->error('Expecting "'.getid3_lib::PrintHexBytes($magic).'" at offset '.$info['avdataoffset'].', found "'.getid3_lib::PrintHexBytes(substr($ShortenHeader, 0, 4)).'"');
30  return false;
31  }
32  $info['fileformat'] = 'shn';
33  $info['audio']['dataformat'] = 'shn';
34  $info['audio']['lossless'] = true;
35  $info['audio']['bitrate_mode'] = 'vbr';
36 
37  $info['shn']['version'] = getid3_lib::LittleEndian2Int(substr($ShortenHeader, 4, 1));
38 
39  $this->fseek($info['avdataend'] - 12);
40  $SeekTableSignatureTest = $this->fread(12);
41  $info['shn']['seektable']['present'] = (bool) (substr($SeekTableSignatureTest, 4, 8) == 'SHNAMPSK');
42  if ($info['shn']['seektable']['present']) {
43  $info['shn']['seektable']['length'] = getid3_lib::LittleEndian2Int(substr($SeekTableSignatureTest, 0, 4));
44  $info['shn']['seektable']['offset'] = $info['avdataend'] - $info['shn']['seektable']['length'];
45  $this->fseek($info['shn']['seektable']['offset']);
46  $SeekTableMagic = $this->fread(4);
47  $magic = 'SEEK';
48  if ($SeekTableMagic != $magic) {
49 
50  $this->error('Expecting "'.getid3_lib::PrintHexBytes($magic).'" at offset '.$info['shn']['seektable']['offset'].', found "'.getid3_lib::PrintHexBytes($SeekTableMagic).'"');
51  return false;
52 
53  } else {
54 
55  // typedef struct tag_TSeekEntry
56  // {
57  // unsigned long SampleNumber;
58  // unsigned long SHNFileByteOffset;
59  // unsigned long SHNLastBufferReadPosition;
60  // unsigned short SHNByteGet;
61  // unsigned short SHNBufferOffset;
62  // unsigned short SHNFileBitOffset;
63  // unsigned long SHNGBuffer;
64  // unsigned short SHNBitShift;
65  // long CBuf0[3];
66  // long CBuf1[3];
67  // long Offset0[4];
68  // long Offset1[4];
69  // }TSeekEntry;
70 
71  $SeekTableData = $this->fread($info['shn']['seektable']['length'] - 16);
72  $info['shn']['seektable']['entry_count'] = floor(strlen($SeekTableData) / 80);
73  //$info['shn']['seektable']['entries'] = array();
74  //$SeekTableOffset = 0;
75  //for ($i = 0; $i < $info['shn']['seektable']['entry_count']; $i++) {
76  // $SeekTableEntry['sample_number'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
77  // $SeekTableOffset += 4;
78  // $SeekTableEntry['shn_file_byte_offset'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
79  // $SeekTableOffset += 4;
80  // $SeekTableEntry['shn_last_buffer_read_position'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
81  // $SeekTableOffset += 4;
82  // $SeekTableEntry['shn_byte_get'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 2));
83  // $SeekTableOffset += 2;
84  // $SeekTableEntry['shn_buffer_offset'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 2));
85  // $SeekTableOffset += 2;
86  // $SeekTableEntry['shn_file_bit_offset'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 2));
87  // $SeekTableOffset += 2;
88  // $SeekTableEntry['shn_gbuffer'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
89  // $SeekTableOffset += 4;
90  // $SeekTableEntry['shn_bit_shift'] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 2));
91  // $SeekTableOffset += 2;
92  // for ($j = 0; $j < 3; $j++) {
93  // $SeekTableEntry['cbuf0'][$j] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
94  // $SeekTableOffset += 4;
95  // }
96  // for ($j = 0; $j < 3; $j++) {
97  // $SeekTableEntry['cbuf1'][$j] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
98  // $SeekTableOffset += 4;
99  // }
100  // for ($j = 0; $j < 4; $j++) {
101  // $SeekTableEntry['offset0'][$j] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
102  // $SeekTableOffset += 4;
103  // }
104  // for ($j = 0; $j < 4; $j++) {
105  // $SeekTableEntry['offset1'][$j] = getid3_lib::LittleEndian2Int(substr($SeekTableData, $SeekTableOffset, 4));
106  // $SeekTableOffset += 4;
107  // }
108  //
109  // $info['shn']['seektable']['entries'][] = $SeekTableEntry;
110  //}
111 
112  }
113 
114  }
115 
116  if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {
117  $this->error('PHP running in Safe Mode - backtick operator not available, cannot run shntool to analyze Shorten files');
118  return false;
119  }
120 
121  if (GETID3_OS_ISWINDOWS) {
122 
123  $RequiredFiles = array('shorten.exe', 'cygwin1.dll', 'head.exe');
124  foreach ($RequiredFiles as $required_file) {
125  if (!is_readable(GETID3_HELPERAPPSDIR.$required_file)) {
126  $this->error(GETID3_HELPERAPPSDIR.$required_file.' does not exist');
127  return false;
128  }
129  }
130  $commandline = GETID3_HELPERAPPSDIR.'shorten.exe -x "'.$info['filenamepath'].'" - | '.GETID3_HELPERAPPSDIR.'head.exe -c 64';
131  $commandline = str_replace('/', '\\', $commandline);
132 
133  } else {
134 
135  static $shorten_present;
136  if (!isset($shorten_present)) {
137  $shorten_present = file_exists('/usr/local/bin/shorten') || `which shorten`;
138  }
139  if (!$shorten_present) {
140  $this->error('shorten binary was not found in path or /usr/local/bin');
141  return false;
142  }
143  $commandline = (file_exists('/usr/local/bin/shorten') ? '/usr/local/bin/' : '' ) . 'shorten -x '.escapeshellarg($info['filenamepath']).' - | head -c 64';
144 
145  }
146 
147  $output = `$commandline`;
148 
149  if (!empty($output) && (substr($output, 12, 4) == 'fmt ')) {
150 
151  getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.audio-video.riff.php', __FILE__, true);
152 
153  $fmt_size = getid3_lib::LittleEndian2Int(substr($output, 16, 4));
154  $DecodedWAVFORMATEX = getid3_riff::parseWAVEFORMATex(substr($output, 20, $fmt_size));
155  $info['audio']['channels'] = $DecodedWAVFORMATEX['channels'];
156  $info['audio']['bits_per_sample'] = $DecodedWAVFORMATEX['bits_per_sample'];
157  $info['audio']['sample_rate'] = $DecodedWAVFORMATEX['sample_rate'];
158 
159  if (substr($output, 20 + $fmt_size, 4) == 'data') {
160 
161  $info['playtime_seconds'] = getid3_lib::LittleEndian2Int(substr($output, 20 + 4 + $fmt_size, 4)) / $DecodedWAVFORMATEX['raw']['nAvgBytesPerSec'];
162 
163  } else {
164 
165  $this->error('shorten failed to decode DATA chunk to expected location, cannot determine playtime');
166  return false;
167 
168  }
169 
170  $info['audio']['bitrate'] = (($info['avdataend'] - $info['avdataoffset']) / $info['playtime_seconds']) * 8;
171 
172  } else {
173 
174  $this->error('shorten failed to decode file to WAV for parsing');
175  return false;
176 
177  }
178 
179  return true;
180  }
181 
182 }
getid3_shorten\Analyze
Analyze()
Definition: module.audio.shorten.php:21
getid3_handler\error
error($text)
Definition: getid3.php:1752
getid3_riff\parseWAVEFORMATex
static parseWAVEFORMATex($WaveFormatExData)
Definition: module.audio-video.riff.php:1823
getid3_lib\LittleEndian2Int
static LittleEndian2Int($byteword, $signed=false)
Definition: getid3.lib.php:292
getid3_lib\IncludeDependency
static IncludeDependency($filename, $sourcefile, $DieOnFailure=false)
Definition: getid3.lib.php:1373
$output
if(!is_dir( $entity_dir)) exit("Fatal Error ([A-Za-z0-9]+)\+" &#(? foreach( $entity_files as $file) $output
Definition: generate-entity-file.php:67
getid3_handler
Definition: getid3.php:1616
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
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
getid3_shorten
getID3() by James Heinrich info@getid3.org //
Definition: module.audio.shorten.php:18
getid3_handler\fseek
fseek($bytes, $whence=SEEK_SET)
Definition: getid3.php:1711
$info
$info
Definition: index.php:5