source: extensions/charlies_content/getid3/getid3/module.audio.bonk.php @ 3544

Last change on this file since 3544 was 3544, checked in by vdigital, 15 years ago

Change: getid3 upgraded to -> 1.7.9
  • Property svn:keywords set to Author Date Id Revision
File size: 8.9 KB
Line 
1<?php
2/////////////////////////////////////////////////////////////////
3/// getID3() by James Heinrich <info@getid3.org>               //
4//  available at http://getid3.sourceforge.net                 //
5//            or http://www.getid3.org                         //
6/////////////////////////////////////////////////////////////////
7// See readme.txt for more details                             //
8/////////////////////////////////////////////////////////////////
9//                                                             //
10// module.audio.la.php                                         //
11// module for analyzing BONK audio files                       //
12// dependencies: module.tag.id3v2.php (optional)               //
13//                                                            ///
14/////////////////////////////////////////////////////////////////
15
16
17class getid3_bonk
18{
19        function getid3_bonk(&$fd, &$ThisFileInfo) {
20
21                // shortcut
22                $ThisFileInfo['bonk'] = array();
23                $thisfile_bonk        = &$ThisFileInfo['bonk'];
24
25                $thisfile_bonk['dataoffset']      = $ThisFileInfo['avdataoffset'];
26                $thisfile_bonk['dataend']         = $ThisFileInfo['avdataend'];
27
28                if ($thisfile_bonk['dataend'] >= pow(2, 31)) {
29
30                        $ThisFileInfo['warning'][] = 'Unable to parse BONK file from end (v0.6+ preferred method) because PHP filesystem functions only support up to 2GB';
31
32                } else {
33
34                        // scan-from-end method, for v0.6 and higher
35                        fseek($fd, $thisfile_bonk['dataend'] - 8, SEEK_SET);
36                        $PossibleBonkTag = fread($fd, 8);
37                        while ($this->BonkIsValidTagName(substr($PossibleBonkTag, 4, 4), true)) {
38                                $BonkTagSize = getid3_lib::LittleEndian2Int(substr($PossibleBonkTag, 0, 4));
39                                fseek($fd, 0 - $BonkTagSize, SEEK_CUR);
40                                $BonkTagOffset = ftell($fd);
41                                $TagHeaderTest = fread($fd, 5);
42                                if (($TagHeaderTest{0} != "\x00") || (substr($PossibleBonkTag, 4, 4) != strtolower(substr($PossibleBonkTag, 4, 4)))) {
43                                        $ThisFileInfo['error'][] = 'Expecting "Ø'.strtoupper(substr($PossibleBonkTag, 4, 4)).'" at offset '.$BonkTagOffset.', found "'.$TagHeaderTest.'"';
44                                        return false;
45                                }
46                                $BonkTagName = substr($TagHeaderTest, 1, 4);
47
48                                $thisfile_bonk[$BonkTagName]['size']   = $BonkTagSize;
49                                $thisfile_bonk[$BonkTagName]['offset'] = $BonkTagOffset;
50                                $this->HandleBonkTags($fd, $BonkTagName, $ThisFileInfo);
51                                $NextTagEndOffset = $BonkTagOffset - 8;
52                                if ($NextTagEndOffset < $thisfile_bonk['dataoffset']) {
53                                        if (empty($ThisFileInfo['audio']['encoder'])) {
54                                                $ThisFileInfo['audio']['encoder'] = 'Extended BONK v0.9+';
55                                        }
56                                        return true;
57                                }
58                                fseek($fd, $NextTagEndOffset, SEEK_SET);
59                                $PossibleBonkTag = fread($fd, 8);
60                        }
61
62                }
63
64                // seek-from-beginning method for v0.4 and v0.5
65                if (empty($thisfile_bonk['BONK'])) {
66                        fseek($fd, $thisfile_bonk['dataoffset'], SEEK_SET);
67                        do {
68                                $TagHeaderTest = fread($fd, 5);
69                                switch ($TagHeaderTest) {
70                                        case "\x00".'BONK':
71                                                if (empty($ThisFileInfo['audio']['encoder'])) {
72                                                        $ThisFileInfo['audio']['encoder'] = 'BONK v0.4';
73                                                }
74                                                break;
75
76                                        case "\x00".'INFO':
77                                                $ThisFileInfo['audio']['encoder'] = 'Extended BONK v0.5';
78                                                break;
79
80                                        default:
81                                                break 2;
82                                }
83                                $BonkTagName = substr($TagHeaderTest, 1, 4);
84                                $thisfile_bonk[$BonkTagName]['size']   = $thisfile_bonk['dataend'] - $thisfile_bonk['dataoffset'];
85                                $thisfile_bonk[$BonkTagName]['offset'] = $thisfile_bonk['dataoffset'];
86                                $this->HandleBonkTags($fd, $BonkTagName, $ThisFileInfo);
87
88                        } while (true);
89                }
90
91                // parse META block for v0.6 - v0.8
92                if (empty($thisfile_bonk['INFO']) && isset($thisfile_bonk['META']['tags']['info'])) {
93                        fseek($fd, $thisfile_bonk['META']['tags']['info'], SEEK_SET);
94                        $TagHeaderTest = fread($fd, 5);
95                        if ($TagHeaderTest == "\x00".'INFO') {
96                                $ThisFileInfo['audio']['encoder'] = 'Extended BONK v0.6 - v0.8';
97
98                                $BonkTagName = substr($TagHeaderTest, 1, 4);
99                                $thisfile_bonk[$BonkTagName]['size']   = $thisfile_bonk['dataend'] - $thisfile_bonk['dataoffset'];
100                                $thisfile_bonk[$BonkTagName]['offset'] = $thisfile_bonk['dataoffset'];
101                                $this->HandleBonkTags($fd, $BonkTagName, $ThisFileInfo);
102                        }
103                }
104
105                if (empty($ThisFileInfo['audio']['encoder'])) {
106                        $ThisFileInfo['audio']['encoder'] = 'Extended BONK v0.9+';
107                }
108                if (empty($thisfile_bonk['BONK'])) {
109                        unset($ThisFileInfo['bonk']);
110                }
111                return true;
112
113        }
114
115        function HandleBonkTags(&$fd, &$BonkTagName, &$ThisFileInfo) {
116
117                switch ($BonkTagName) {
118                        case 'BONK':
119                                // shortcut
120                                $thisfile_bonk_BONK = &$ThisFileInfo['bonk']['BONK'];
121
122                                $BonkData = "\x00".'BONK'.fread($fd, 17);
123                                $thisfile_bonk_BONK['version']            =        getid3_lib::LittleEndian2Int(substr($BonkData,  5, 1));
124                                $thisfile_bonk_BONK['number_samples']     =        getid3_lib::LittleEndian2Int(substr($BonkData,  6, 4));
125                                $thisfile_bonk_BONK['sample_rate']        =        getid3_lib::LittleEndian2Int(substr($BonkData, 10, 4));
126
127                                $thisfile_bonk_BONK['channels']           =        getid3_lib::LittleEndian2Int(substr($BonkData, 14, 1));
128                                $thisfile_bonk_BONK['lossless']           = (bool) getid3_lib::LittleEndian2Int(substr($BonkData, 15, 1));
129                                $thisfile_bonk_BONK['joint_stereo']       = (bool) getid3_lib::LittleEndian2Int(substr($BonkData, 16, 1));
130                                $thisfile_bonk_BONK['number_taps']        =        getid3_lib::LittleEndian2Int(substr($BonkData, 17, 2));
131                                $thisfile_bonk_BONK['downsampling_ratio'] =        getid3_lib::LittleEndian2Int(substr($BonkData, 19, 1));
132                                $thisfile_bonk_BONK['samples_per_packet'] =        getid3_lib::LittleEndian2Int(substr($BonkData, 20, 2));
133
134                                $ThisFileInfo['avdataoffset'] = $thisfile_bonk_BONK['offset'] + 5 + 17;
135                                $ThisFileInfo['avdataend']    = $thisfile_bonk_BONK['offset'] + $thisfile_bonk_BONK['size'];
136
137                                $ThisFileInfo['fileformat']               = 'bonk';
138                                $ThisFileInfo['audio']['dataformat']      = 'bonk';
139                                $ThisFileInfo['audio']['bitrate_mode']    = 'vbr'; // assumed
140                                $ThisFileInfo['audio']['channels']        = $thisfile_bonk_BONK['channels'];
141                                $ThisFileInfo['audio']['sample_rate']     = $thisfile_bonk_BONK['sample_rate'];
142                                $ThisFileInfo['audio']['channelmode']     = ($thisfile_bonk_BONK['joint_stereo'] ? 'joint stereo' : 'stereo');
143                                $ThisFileInfo['audio']['lossless']        = $thisfile_bonk_BONK['lossless'];
144                                $ThisFileInfo['audio']['codec']           = 'bonk';
145
146                                $ThisFileInfo['playtime_seconds'] = $thisfile_bonk_BONK['number_samples'] / ($thisfile_bonk_BONK['sample_rate'] * $thisfile_bonk_BONK['channels']);
147                                if ($ThisFileInfo['playtime_seconds'] > 0) {
148                                        $ThisFileInfo['audio']['bitrate'] = (($ThisFileInfo['bonk']['dataend'] - $ThisFileInfo['bonk']['dataoffset']) * 8) / $ThisFileInfo['playtime_seconds'];
149                                }
150                                break;
151
152                        case 'INFO':
153                                // shortcut
154                                $thisfile_bonk_INFO = &$ThisFileInfo['bonk']['INFO'];
155
156                                $thisfile_bonk_INFO['version'] = getid3_lib::LittleEndian2Int(fread($fd, 1));
157                                $thisfile_bonk_INFO['entries_count'] = 0;
158                                $NextInfoDataPair = fread($fd, 5);
159                                if (!$this->BonkIsValidTagName(substr($NextInfoDataPair, 1, 4))) {
160                                        while (!feof($fd)) {
161                                                //$CurrentSeekInfo['offset']  = getid3_lib::LittleEndian2Int(substr($NextInfoDataPair, 0, 4));
162                                                //$CurrentSeekInfo['nextbit'] = getid3_lib::LittleEndian2Int(substr($NextInfoDataPair, 4, 1));
163                                                //$thisfile_bonk_INFO[] = $CurrentSeekInfo;
164
165                                                $NextInfoDataPair = fread($fd, 5);
166                                                if ($this->BonkIsValidTagName(substr($NextInfoDataPair, 1, 4))) {
167                                                        fseek($fd, -5, SEEK_CUR);
168                                                        break;
169                                                }
170                                                $thisfile_bonk_INFO['entries_count']++;
171                                        }
172                                }
173                                break;
174
175                        case 'META':
176                                $BonkData = "\x00".'META'.fread($fd, $ThisFileInfo['bonk']['META']['size'] - 5);
177                                $ThisFileInfo['bonk']['META']['version'] = getid3_lib::LittleEndian2Int(substr($BonkData,  5, 1));
178
179                                $MetaTagEntries = floor(((strlen($BonkData) - 8) - 6) / 8); // BonkData - xxxxmeta - ØMETA
180                                $offset = 6;
181                                for ($i = 0; $i < $MetaTagEntries; $i++) {
182                                        $MetaEntryTagName   =                  substr($BonkData, $offset, 4);
183                                        $offset += 4;
184                                        $MetaEntryTagOffset = getid3_lib::LittleEndian2Int(substr($BonkData, $offset, 4));
185                                        $offset += 4;
186                                        $ThisFileInfo['bonk']['META']['tags'][$MetaEntryTagName] = $MetaEntryTagOffset;
187                                }
188                                break;
189
190                        case ' ID3':
191                                $ThisFileInfo['audio']['encoder'] = 'Extended BONK v0.9+';
192
193                                // ID3v2 checking is optional
194                                if (class_exists('getid3_id3v2')) {
195                                        $ThisFileInfo['bonk'][' ID3']['valid'] = new getid3_id3v2($fd, $ThisFileInfo, $ThisFileInfo['bonk'][' ID3']['offset'] + 2);
196                                }
197                                break;
198
199                        default:
200                                $ThisFileInfo['warning'][] = 'Unexpected Bonk tag "'.$BonkTagName.'" at offset '.$ThisFileInfo['bonk'][$BonkTagName]['offset'];
201                                break;
202
203                }
204        }
205
206        function BonkIsValidTagName($PossibleBonkTag, $ignorecase=false) {
207                static $BonkIsValidTagName = array('BONK', 'INFO', ' ID3', 'META');
208                foreach ($BonkIsValidTagName as $validtagname) {
209                        if ($validtagname == $PossibleBonkTag) {
210                                return true;
211                        } elseif ($ignorecase && (strtolower($validtagname) == strtolower($PossibleBonkTag))) {
212                                return true;
213                        }
214                }
215                return false;
216        }
217
218}
219
220
221?>
Note: See TracBrowser for help on using the repository browser.