Total Complexity | 49 |
Total Lines | 491 |
Duplicated Lines | 0 % |
Changes | 1 | ||
Bugs | 0 | Features | 0 |
Complex classes like getid3_midi often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use getid3_midi, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
24 | class getid3_midi extends getid3_handler |
||
25 | { |
||
26 | |||
27 | public function Analyze() |
||
28 | { |
||
29 | $getid3 = $this->getid3; |
||
30 | |||
31 | $getid3->info['midi']['raw'] = []; |
||
32 | $info_midi = &$getid3->info['midi']; |
||
33 | $info_midi_raw = &$info_midi['raw']; |
||
34 | |||
35 | $getid3->info['fileformat'] = 'midi'; |
||
36 | $getid3->info['audio']['dataformat'] = 'midi'; |
||
37 | |||
38 | fseek($getid3->fp, $getid3->info['avdataoffset'], SEEK_SET); |
||
39 | $midi_data = fread($getid3->fp, getid3::FREAD_BUFFER_SIZE); |
||
40 | |||
41 | // Magic bytes: 'MThd' |
||
42 | |||
43 | getid3_lib::ReadSequence( |
||
44 | 'BigEndian2Int', |
||
45 | $info_midi_raw, |
||
46 | $midi_data, |
||
47 | 4, |
||
48 | [ |
||
49 | 'headersize' => 4, |
||
50 | 'fileformat' => 2, |
||
51 | 'tracks' => 2, |
||
52 | 'ticksperqnote' => 2 |
||
53 | ] |
||
54 | ); |
||
55 | |||
56 | $offset = 14; |
||
57 | |||
58 | for ($i = 0; $i < $info_midi_raw['tracks']; $i++) { |
||
59 | if ((strlen($midi_data) - $offset) < 8) { |
||
60 | $midi_data .= fread($getid3->fp, getid3::FREAD_BUFFER_SIZE); |
||
61 | } |
||
62 | |||
63 | $track_id = substr($midi_data, $offset, 4); |
||
64 | $offset += 4; |
||
65 | |||
66 | if ('MTrk' != $track_id) { |
||
67 | throw new getid3_exception('Expecting "MTrk" at ' . $offset . ', found ' . $track_id . ' instead'); |
||
68 | } |
||
69 | |||
70 | $track_size = getid3_lib::BigEndian2Int(substr($midi_data, $offset, 4)); |
||
71 | $offset += 4; |
||
72 | |||
73 | $track_data_array[$i] = substr($midi_data, $offset, $track_size); |
||
74 | $offset += $track_size; |
||
75 | } |
||
76 | |||
77 | if (!isset($track_data_array) || !is_array($track_data_array)) { |
||
|
|||
78 | throw new getid3_exception('Cannot find MIDI track information'); |
||
79 | } |
||
80 | |||
81 | $info_midi['totalticks'] = 0; |
||
82 | $getid3->info['playtime_seconds'] = 0; |
||
83 | $current_ms_per_beat = 500000; // 120 beats per minute; 60,000,000 microseconds per minute -> 500,000 microseconds per beat |
||
84 | $current_beats_per_min = 120; // 120 beats per minute; 60,000,000 microseconds per minute -> 500,000 microseconds per beat |
||
85 | $ms_per_quarter_note_after = []; |
||
86 | |||
87 | foreach ($track_data_array as $track_number => $track_data) { |
||
88 | $events_offset = $last_issued_midi_command = $last_issued_midi_channel = $cumulative_delta_time = $ticks_at_current_bpm = 0; |
||
89 | |||
90 | while ($events_offset < strlen($track_data)) { |
||
91 | $event_id = 0; |
||
92 | if (isset($midi_events[$track_number]) && is_array($midi_events[$track_number])) { |
||
93 | $event_id = count($midi_events[$track_number]); |
||
94 | } |
||
95 | $delta_time = 0; |
||
96 | for ($i = 0; $i < 4; $i++) { |
||
97 | $delta_time_byte = ord($track_data{$events_offset++}); |
||
98 | $delta_time = ($delta_time << 7) + ($delta_time_byte & 0x7F); |
||
99 | if ($delta_time_byte & 0x80) { |
||
100 | // another byte follows |
||
101 | } else { |
||
102 | break; |
||
103 | } |
||
104 | } |
||
105 | |||
106 | $cumulative_delta_time += $delta_time; |
||
107 | $ticks_at_current_bpm += $delta_time; |
||
108 | |||
109 | $midi_events[$track_number][$event_id]['deltatime'] = $delta_time; |
||
110 | |||
111 | $midi_event_channel = ord($track_data{$events_offset++}); |
||
112 | |||
113 | // OK, normal event - MIDI command has MSB set |
||
114 | if ($midi_event_channel & 0x80) { |
||
115 | $last_issued_midi_command = $midi_event_channel >> 4; |
||
116 | $last_issued_midi_channel = $midi_event_channel & 0x0F; |
||
117 | } // Running event - assume last command |
||
118 | else { |
||
119 | $events_offset--; |
||
120 | } |
||
121 | |||
122 | $midi_events[$track_number][$event_id]['eventid'] = $last_issued_midi_command; |
||
123 | $midi_events[$track_number][$event_id]['channel'] = $last_issued_midi_channel; |
||
124 | |||
125 | switch ($midi_events[$track_number][$event_id]['eventid']) { |
||
126 | case 0x8: // Note off (key is released) |
||
127 | case 0x9: // Note on (key is pressed) |
||
128 | case 0xA: // Key after-touch |
||
129 | |||
130 | //$notenumber = ord($track_data{$events_offset++}); |
||
131 | //$velocity = ord($track_data{$events_offset++}); |
||
132 | $events_offset += 2; |
||
133 | break; |
||
134 | |||
135 | case 0xB: // Control Change |
||
136 | |||
137 | //$controllernum = ord($track_data{$events_offset++}); |
||
138 | //$newvalue = ord($track_data{$events_offset++}); |
||
139 | $events_offset += 2; |
||
140 | break; |
||
141 | |||
142 | case 0xC: // Program (patch) change |
||
143 | |||
144 | $new_program_num = ord($track_data{$events_offset++}); |
||
145 | |||
146 | $info_midi_raw['track'][$track_number]['instrumentid'] = $new_program_num; |
||
147 | $info_midi_raw['track'][$track_number]['instrument'] = 10 == $track_number ? getid3_midi::GeneralMIDIpercussionLookup($new_program_num) : getid3_midi::GeneralMIDIinstrumentLookup($new_program_num); |
||
148 | break; |
||
149 | |||
150 | case 0xD: // Channel after-touch |
||
151 | |||
152 | //$channelnumber = ord($track_data{$events_offset++}); |
||
153 | break; |
||
154 | |||
155 | case 0xE: // Pitch wheel change (2000H is normal or no change) |
||
156 | |||
157 | //$changeLSB = ord($track_data{$events_offset++}); |
||
158 | //$changeMSB = ord($track_data{$events_offset++}); |
||
159 | //$pitchwheelchange = (($changeMSB & 0x7F) << 7) & ($changeLSB & 0x7F); |
||
160 | $events_offset += 2; |
||
161 | break; |
||
162 | |||
163 | case 0xF: |
||
164 | |||
165 | if (0xF == $midi_events[$track_number][$event_id]['channel']) { |
||
166 | $meta_event_command = ord($track_data{$events_offset++}); |
||
167 | $meta_event_length = ord($track_data{$events_offset++}); |
||
168 | $meta_event_data = substr($track_data, $events_offset, $meta_event_length); |
||
169 | $events_offset += $meta_event_length; |
||
170 | |||
171 | switch ($meta_event_command) { |
||
172 | case 0x00: // Set track sequence number |
||
173 | |||
174 | //$track_sequence_number = getid3_lib::BigEndian2Int(substr($meta_event_data, 0, $meta_event_length)); |
||
175 | //$info_midi_raw['events'][$track_number][$event_id]['seqno'] = $track_sequence_number; |
||
176 | break; |
||
177 | |||
178 | case 0x01: // Text: generic |
||
179 | |||
180 | $text_generic = substr($meta_event_data, 0, $meta_event_length); |
||
181 | //$info_midi_raw['events'][$track_number][$event_id]['text'] = $text_generic; |
||
182 | $info_midi['comments']['comment'][] = $text_generic; |
||
183 | break; |
||
184 | |||
185 | case 0x02: // Text: copyright |
||
186 | |||
187 | $text_copyright = substr($meta_event_data, 0, $meta_event_length); |
||
188 | //$info_midi_raw['events'][$track_number][$event_id]['copyright'] = $text_copyright; |
||
189 | $info_midi['comments']['copyright'][] = $text_copyright; |
||
190 | break; |
||
191 | |||
192 | case 0x03: // Text: track name |
||
193 | |||
194 | $text_trackname = substr($meta_event_data, 0, $meta_event_length); |
||
195 | $info_midi_raw['track'][$track_number]['name'] = $text_trackname; |
||
196 | break; |
||
197 | |||
198 | case 0x04: // Text: track instrument name |
||
199 | |||
200 | //$text_instrument = substr($meta_event_data, 0, $meta_event_length); |
||
201 | //$info_midi_raw['events'][$track_number][$event_id]['instrument'] = $text_instrument; |
||
202 | break; |
||
203 | |||
204 | case 0x05: // Text: lyrics |
||
205 | |||
206 | $text_lyrics = substr($meta_event_data, 0, $meta_event_length); |
||
207 | //$info_midi_raw['events'][$track_number][$event_id]['lyrics'] = $text_lyrics; |
||
208 | if (!isset($info_midi['lyrics'])) { |
||
209 | $info_midi['lyrics'] = ''; |
||
210 | } |
||
211 | $info_midi['lyrics'] .= $text_lyrics . "\n"; |
||
212 | break; |
||
213 | |||
214 | case 0x06: // Text: marker |
||
215 | |||
216 | //$text_marker = substr($meta_event_data, 0, $meta_event_length); |
||
217 | //$info_midi_raw['events'][$track_number][$event_id]['marker'] = $text_marker; |
||
218 | break; |
||
219 | |||
220 | case 0x07: // Text: cue point |
||
221 | |||
222 | //$text_cuepoint = substr($meta_event_data, 0, $meta_event_length); |
||
223 | //$info_midi_raw['events'][$track_number][$event_id]['cuepoint'] = $text_cuepoint; |
||
224 | break; |
||
225 | |||
226 | case 0x2F: // End Of Track |
||
227 | |||
228 | //$info_midi_raw['events'][$track_number][$event_id]['EOT'] = $cumulative_delta_time; |
||
229 | break; |
||
230 | |||
231 | case 0x51: // Tempo: microseconds / quarter note |
||
232 | |||
233 | $current_ms_per_beat = getid3_lib::BigEndian2Int(substr($meta_event_data, 0, $meta_event_length)); |
||
234 | $info_midi_raw['events'][$track_number][$cumulative_delta_time]['us_qnote'] = $current_ms_per_beat; |
||
235 | $current_beats_per_min = (1000000 / $current_ms_per_beat) * 60; |
||
236 | $ms_per_quarter_note_after[$cumulative_delta_time] = $current_ms_per_beat; |
||
237 | $ticks_at_current_bpm = 0; |
||
238 | break; |
||
239 | |||
240 | case 0x58: // Time signature |
||
241 | $timesig_numerator = getid3_lib::BigEndian2Int($meta_event_data[0]); |
||
242 | $timesig_denominator = pow(2, getid3_lib::BigEndian2Int($meta_event_data[1])); // $02 -> x/4, $03 -> x/8, etc |
||
243 | //$timesig_32inqnote = getid3_lib::BigEndian2Int($meta_event_data[2]); // number of 32nd notes to the quarter note |
||
244 | //$info_midi_raw['events'][$track_number][$event_id]['timesig_32inqnote'] = $timesig_32inqnote; |
||
245 | //$info_midi_raw['events'][$track_number][$event_id]['timesig_numerator'] = $timesig_numerator; |
||
246 | //$info_midi_raw['events'][$track_number][$event_id]['timesig_denominator'] = $timesig_denominator; |
||
247 | //$info_midi_raw['events'][$track_number][$event_id]['timesig_text'] = $timesig_numerator.'/'.$timesig_denominator; |
||
248 | $info_midi['timesignature'][] = $timesig_numerator . '/' . $timesig_denominator; |
||
249 | break; |
||
250 | |||
251 | case 0x59: // Keysignature |
||
252 | |||
253 | $keysig_sharpsflats = getid3_lib::BigEndian2Int($meta_event_data{0}); |
||
254 | if ($keysig_sharpsflats & 0x80) { |
||
255 | // (-7 -> 7 flats, 0 ->key of C, 7 -> 7 sharps) |
||
256 | $keysig_sharpsflats -= 256; |
||
257 | } |
||
258 | |||
259 | $keysig_majorminor = getid3_lib::BigEndian2Int($meta_event_data{1}); // 0 -> major, 1 -> minor |
||
260 | $keysigs = [-7 => 'Cb', -6 => 'Gb', -5 => 'Db', -4 => 'Ab', -3 => 'Eb', -2 => 'Bb', -1 => 'F', 0 => 'C', 1 => 'G', 2 => 'D', 3 => 'A', 4 => 'E', 5 => 'B', 6 => 'F#', 7 => 'C#']; |
||
261 | //$info_midi_raw['events'][$track_number][$event_id]['keysig_sharps'] = (($keysig_sharpsflats > 0) ? abs($keysig_sharpsflats) : 0); |
||
262 | //$info_midi_raw['events'][$track_number][$event_id]['keysig_flats'] = (($keysig_sharpsflats < 0) ? abs($keysig_sharpsflats) : 0); |
||
263 | //$info_midi_raw['events'][$track_number][$event_id]['keysig_minor'] = (bool)$keysig_majorminor; |
||
264 | //$info_midi_raw['events'][$track_number][$event_id]['keysig_text'] = $keysigs[$keysig_sharpsflats].' '.($info_midi_raw['events'][$track_number][$event_id]['keysig_minor'] ? 'minor' : 'major'); |
||
265 | |||
266 | // $keysigs[$keysig_sharpsflats] gets an int key (correct) - $keysigs["$keysig_sharpsflats"] gets a string key (incorrect) |
||
267 | $info_midi['keysignature'][] = $keysigs[$keysig_sharpsflats] . ' ' . ((bool)$keysig_majorminor ? 'minor' : 'major'); |
||
268 | break; |
||
269 | |||
270 | case 0x7F: // Sequencer specific information |
||
271 | |||
272 | $custom_data = substr($meta_event_data, 0, $meta_event_length); |
||
273 | break; |
||
274 | |||
275 | default: |
||
276 | |||
277 | $getid3->warning('Unhandled META Event Command: ' . $meta_event_command); |
||
278 | } |
||
279 | } |
||
280 | break; |
||
281 | |||
282 | default: |
||
283 | $getid3->warning('Unhandled MIDI Event ID: ' . $midi_events[$track_number][$event_id]['eventid']); |
||
284 | } |
||
285 | } |
||
286 | |||
287 | if (($track_number > 0) || (1 == count($track_data_array))) { |
||
288 | $info_midi['totalticks'] = max($info_midi['totalticks'], $cumulative_delta_time); |
||
289 | } |
||
290 | } |
||
291 | |||
292 | $previous_tick_offset = null; |
||
293 | |||
294 | ksort($ms_per_quarter_note_after); |
||
295 | foreach ($ms_per_quarter_note_after as $tick_offset => $ms_per_beat) { |
||
296 | if (is_null($previous_tick_offset)) { |
||
297 | $prev_ms_per_beat = $ms_per_beat; |
||
298 | $previous_tick_offset = $tick_offset; |
||
299 | continue; |
||
300 | } |
||
301 | |||
302 | if ($info_midi['totalticks'] > $tick_offset) { |
||
303 | $getid3->info['playtime_seconds'] += (($tick_offset - $previous_tick_offset) / $info_midi_raw['ticksperqnote']) * ($prev_ms_per_beat / 1000000); |
||
304 | |||
305 | $prev_ms_per_beat = $ms_per_beat; |
||
306 | $previous_tick_offset = $tick_offset; |
||
307 | } |
||
308 | } |
||
309 | |||
310 | if ($info_midi['totalticks'] > $previous_tick_offset) { |
||
311 | $getid3->info['playtime_seconds'] += (($info_midi['totalticks'] - $previous_tick_offset) / $info_midi_raw['ticksperqnote']) * ($ms_per_beat / 1000000); |
||
312 | } |
||
313 | |||
314 | if (@$getid3->info['playtime_seconds'] > 0) { |
||
315 | $getid3->info['bitrate'] = (($getid3->info['avdataend'] - $getid3->info['avdataoffset']) * 8) / $getid3->info['playtime_seconds']; |
||
316 | } |
||
317 | |||
318 | if (!empty($info_midi['lyrics'])) { |
||
319 | $info_midi['comments']['lyrics'][] = $info_midi['lyrics']; |
||
320 | } |
||
321 | |||
322 | return true; |
||
323 | } |
||
324 | |||
325 | public static function GeneralMIDIinstrumentLookup($instrument_id) |
||
326 | { |
||
327 | static $lookup = [ |
||
328 | |||
329 | 0 => 'Acoustic Grand', |
||
330 | 1 => 'Bright Acoustic', |
||
331 | 2 => 'Electric Grand', |
||
332 | 3 => 'Honky-Tonk', |
||
333 | 4 => 'Electric Piano 1', |
||
334 | 5 => 'Electric Piano 2', |
||
335 | 6 => 'Harpsichord', |
||
336 | 7 => 'Clavier', |
||
337 | 8 => 'Celesta', |
||
338 | 9 => 'Glockenspiel', |
||
339 | 10 => 'Music Box', |
||
340 | 11 => 'Vibraphone', |
||
341 | 12 => 'Marimba', |
||
342 | 13 => 'Xylophone', |
||
343 | 14 => 'Tubular Bells', |
||
344 | 15 => 'Dulcimer', |
||
345 | 16 => 'Drawbar Organ', |
||
346 | 17 => 'Percussive Organ', |
||
347 | 18 => 'Rock Organ', |
||
348 | 19 => 'Church Organ', |
||
349 | 20 => 'Reed Organ', |
||
350 | 21 => 'Accordian', |
||
351 | 22 => 'Harmonica', |
||
352 | 23 => 'Tango Accordian', |
||
353 | 24 => 'Acoustic Guitar (nylon)', |
||
354 | 25 => 'Acoustic Guitar (steel)', |
||
355 | 26 => 'Electric Guitar (jazz)', |
||
356 | 27 => 'Electric Guitar (clean)', |
||
357 | 28 => 'Electric Guitar (muted)', |
||
358 | 29 => 'Overdriven Guitar', |
||
359 | 30 => 'Distortion Guitar', |
||
360 | 31 => 'Guitar Harmonics', |
||
361 | 32 => 'Acoustic Bass', |
||
362 | 33 => 'Electric Bass (finger)', |
||
363 | 34 => 'Electric Bass (pick)', |
||
364 | 35 => 'Fretless Bass', |
||
365 | 36 => 'Slap Bass 1', |
||
366 | 37 => 'Slap Bass 2', |
||
367 | 38 => 'Synth Bass 1', |
||
368 | 39 => 'Synth Bass 2', |
||
369 | 40 => 'Violin', |
||
370 | 41 => 'Viola', |
||
371 | 42 => 'Cello', |
||
372 | 43 => 'Contrabass', |
||
373 | 44 => 'Tremolo Strings', |
||
374 | 45 => 'Pizzicato Strings', |
||
375 | 46 => 'Orchestral Strings', |
||
376 | 47 => 'Timpani', |
||
377 | 48 => 'String Ensemble 1', |
||
378 | 49 => 'String Ensemble 2', |
||
379 | 50 => 'SynthStrings 1', |
||
380 | 51 => 'SynthStrings 2', |
||
381 | 52 => 'Choir Aahs', |
||
382 | 53 => 'Voice Oohs', |
||
383 | 54 => 'Synth Voice', |
||
384 | 55 => 'Orchestra Hit', |
||
385 | 56 => 'Trumpet', |
||
386 | 57 => 'Trombone', |
||
387 | 58 => 'Tuba', |
||
388 | 59 => 'Muted Trumpet', |
||
389 | 60 => 'French Horn', |
||
390 | 61 => 'Brass Section', |
||
391 | 62 => 'SynthBrass 1', |
||
392 | 63 => 'SynthBrass 2', |
||
393 | 64 => 'Soprano Sax', |
||
394 | 65 => 'Alto Sax', |
||
395 | 66 => 'Tenor Sax', |
||
396 | 67 => 'Baritone Sax', |
||
397 | 68 => 'Oboe', |
||
398 | 69 => 'English Horn', |
||
399 | 70 => 'Bassoon', |
||
400 | 71 => 'Clarinet', |
||
401 | 72 => 'Piccolo', |
||
402 | 73 => 'Flute', |
||
403 | 74 => 'Recorder', |
||
404 | 75 => 'Pan Flute', |
||
405 | 76 => 'Blown Bottle', |
||
406 | 77 => 'Shakuhachi', |
||
407 | 78 => 'Whistle', |
||
408 | 79 => 'Ocarina', |
||
409 | 80 => 'Lead 1 (square)', |
||
410 | 81 => 'Lead 2 (sawtooth)', |
||
411 | 82 => 'Lead 3 (calliope)', |
||
412 | 83 => 'Lead 4 (chiff)', |
||
413 | 84 => 'Lead 5 (charang)', |
||
414 | 85 => 'Lead 6 (voice)', |
||
415 | 86 => 'Lead 7 (fifths)', |
||
416 | 87 => 'Lead 8 (bass + lead)', |
||
417 | 88 => 'Pad 1 (new age)', |
||
418 | 89 => 'Pad 2 (warm)', |
||
419 | 90 => 'Pad 3 (polysynth)', |
||
420 | 91 => 'Pad 4 (choir)', |
||
421 | 92 => 'Pad 5 (bowed)', |
||
422 | 93 => 'Pad 6 (metallic)', |
||
423 | 94 => 'Pad 7 (halo)', |
||
424 | 95 => 'Pad 8 (sweep)', |
||
425 | 96 => 'FX 1 (rain)', |
||
426 | 97 => 'FX 2 (soundtrack)', |
||
427 | 98 => 'FX 3 (crystal)', |
||
428 | 99 => 'FX 4 (atmosphere)', |
||
429 | 100 => 'FX 5 (brightness)', |
||
430 | 101 => 'FX 6 (goblins)', |
||
431 | 102 => 'FX 7 (echoes)', |
||
432 | 103 => 'FX 8 (sci-fi)', |
||
433 | 104 => 'Sitar', |
||
434 | 105 => 'Banjo', |
||
435 | 106 => 'Shamisen', |
||
436 | 107 => 'Koto', |
||
437 | 108 => 'Kalimba', |
||
438 | 109 => 'Bagpipe', |
||
439 | 110 => 'Fiddle', |
||
440 | 111 => 'Shanai', |
||
441 | 112 => 'Tinkle Bell', |
||
442 | 113 => 'Agogo', |
||
443 | 114 => 'Steel Drums', |
||
444 | 115 => 'Woodblock', |
||
445 | 116 => 'Taiko Drum', |
||
446 | 117 => 'Melodic Tom', |
||
447 | 118 => 'Synth Drum', |
||
448 | 119 => 'Reverse Cymbal', |
||
449 | 120 => 'Guitar Fret Noise', |
||
450 | 121 => 'Breath Noise', |
||
451 | 122 => 'Seashore', |
||
452 | 123 => 'Bird Tweet', |
||
453 | 124 => 'Telephone Ring', |
||
454 | 125 => 'Helicopter', |
||
455 | 126 => 'Applause', |
||
456 | 127 => 'Gunshot' |
||
457 | ]; |
||
458 | |||
459 | return @$lookup[$instrument_id]; |
||
460 | } |
||
461 | |||
462 | public static function GeneralMIDIpercussionLookup($instrument_id) |
||
515 | } |
||
516 | |||
517 | } |
||
520 |