2 * Copyright (c) 2007, 2008 Edward Tomasz NapieraĆa <trasz@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * ALTHOUGH THIS SOFTWARE IS MADE OF WIN AND SCIENCE, IT IS PROVIDED BY THE
15 * AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
16 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
18 * THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
20 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
21 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
23 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * Event decoding routines.
40 #ifdef PLATFORM_WINDOWS
43 #include <arpa/inet.h>
47 #include "smf_private.h"
49 #define BUFFER_SIZE 1024
52 * \return Nonzero if event is metaevent. You should never send metaevents;
53 * they are not really MIDI messages. They carry information like track title,
57 smf_event_is_metadata(const smf_event_t *event)
59 assert(event->midi_buffer);
60 assert(event->midi_buffer_length > 0);
62 if (event->midi_buffer[0] == 0xFF)
69 * \return Nonzero if event is System Realtime.
72 smf_event_is_system_realtime(const smf_event_t *event)
74 assert(event->midi_buffer);
75 assert(event->midi_buffer_length > 0);
77 if (smf_event_is_metadata(event))
80 if (event->midi_buffer[0] >= 0xF8)
87 * \return Nonzero if event is System Common.
90 smf_event_is_system_common(const smf_event_t *event)
92 assert(event->midi_buffer);
93 assert(event->midi_buffer_length > 0);
95 if (event->midi_buffer[0] >= 0xF0 && event->midi_buffer[0] <= 0xF7)
101 * \return Nonzero if event is SysEx message.
104 smf_event_is_sysex(const smf_event_t *event)
106 assert(event->midi_buffer);
107 assert(event->midi_buffer_length > 0);
109 if (event->midi_buffer[0] == 0xF0)
116 smf_event_decode_textual(const smf_event_t *event, const char *name)
119 char *buf, *extracted;
121 buf = (char*)malloc(BUFFER_SIZE);
123 g_critical("smf_event_decode_textual: malloc failed.");
127 extracted = smf_event_extract_text(event);
128 if (extracted == NULL) {
133 snprintf(buf + off, BUFFER_SIZE - off, "%s: %s", name, extracted);
139 smf_event_decode_metadata(const smf_event_t *event)
141 int off = 0, mspqn, flats, isminor;
144 static const char *const major_keys[] = {"Fb", "Cb", "Gb", "Db", "Ab",
145 "Eb", "Bb", "F", "C", "G", "D", "A", "E", "B", "F#", "C#", "G#"};
147 static const char *const minor_keys[] = {"Dbm", "Abm", "Ebm", "Bbm", "Fm",
148 "Cm", "Gm", "Dm", "Am", "Em", "Bm", "F#m", "C#m", "G#m", "D#m", "A#m", "E#m"};
150 assert(smf_event_is_metadata(event));
152 switch (event->midi_buffer[1]) {
154 return (smf_event_decode_textual(event, "Text"));
157 return (smf_event_decode_textual(event, "Copyright"));
160 return (smf_event_decode_textual(event, "Sequence/Track Name"));
163 return (smf_event_decode_textual(event, "Instrument"));
166 return (smf_event_decode_textual(event, "Lyric"));
169 return (smf_event_decode_textual(event, "Marker"));
172 return (smf_event_decode_textual(event, "Cue Point"));
175 return (smf_event_decode_textual(event, "Program Name"));
178 return (smf_event_decode_textual(event, "Device (Port) Name"));
184 buf = (char*)malloc(BUFFER_SIZE);
186 g_critical("smf_event_decode_metadata: malloc failed.");
190 switch (event->midi_buffer[1]) {
192 off += snprintf(buf + off, BUFFER_SIZE - off, "Sequence number");
195 /* http://music.columbia.edu/pipermail/music-dsp/2004-August/061196.html */
197 if (event->midi_buffer_length < 4) {
198 g_critical("smf_event_decode_metadata: truncated MIDI message.");
202 off += snprintf(buf + off, BUFFER_SIZE - off, "Channel Prefix: %d", event->midi_buffer[3]);
206 if (event->midi_buffer_length < 4) {
207 g_critical("smf_event_decode_metadata: truncated MIDI message.");
211 off += snprintf(buf + off, BUFFER_SIZE - off, "MIDI Port: %d", event->midi_buffer[3]);
215 off += snprintf(buf + off, BUFFER_SIZE - off, "End Of Track");
219 if (event->midi_buffer_length < 6) {
220 g_critical("smf_event_decode_metadata: truncated MIDI message.");
224 mspqn = (event->midi_buffer[3] << 16) + (event->midi_buffer[4] << 8) + event->midi_buffer[5];
226 off += snprintf(buf + off, BUFFER_SIZE - off, "Tempo: %d microseconds per quarter note, %.2f BPM",
227 mspqn, 60000000.0 / (double)mspqn);
231 off += snprintf(buf + off, BUFFER_SIZE - off, "SMPTE Offset");
235 if (event->midi_buffer_length < 7) {
236 g_critical("smf_event_decode_metadata: truncated MIDI message.");
240 off += snprintf(buf + off, BUFFER_SIZE - off,
241 "Time Signature: %d/%d, %d clocks per click, %d notated 32nd notes per quarter note",
242 event->midi_buffer[3], (int)pow((double)2, event->midi_buffer[4]), event->midi_buffer[5],
243 event->midi_buffer[6]);
247 if (event->midi_buffer_length < 5) {
248 g_critical("smf_event_decode_metadata: truncated MIDI message.");
252 flats = event->midi_buffer[3];
253 isminor = event->midi_buffer[4];
255 if (isminor != 0 && isminor != 1) {
256 g_critical("smf_event_decode_metadata: last byte of the Key Signature event has invalid value %d.", isminor);
260 off += snprintf(buf + off, BUFFER_SIZE - off, "Key Signature: ");
262 if (flats > 8 && flats < 248) {
263 off += snprintf(buf + off, BUFFER_SIZE - off, "%d %s, %s key", abs((int8_t)flats),
264 flats > 127 ? "flats" : "sharps", isminor ? "minor" : "major");
266 int i = (flats - 248) & 255;
268 assert(i >= 0 && (size_t)i < sizeof(minor_keys) / sizeof(*minor_keys));
269 assert(i >= 0 && (size_t)i < sizeof(major_keys) / sizeof(*major_keys));
272 off += snprintf(buf + off, BUFFER_SIZE - off, "%s", minor_keys[i]);
274 off += snprintf(buf + off, BUFFER_SIZE - off, "%s", major_keys[i]);
280 off += snprintf(buf + off, BUFFER_SIZE - off, "Proprietary (aka Sequencer) Event, length %zu",
281 event->midi_buffer_length);
297 smf_event_decode_system_realtime(const smf_event_t *event)
302 assert(smf_event_is_system_realtime(event));
304 if (event->midi_buffer_length != 1) {
305 g_critical("smf_event_decode_system_realtime: event length is not 1.");
309 buf = (char*)malloc(BUFFER_SIZE);
311 g_critical("smf_event_decode_system_realtime: malloc failed.");
315 switch (event->midi_buffer[0]) {
317 off += snprintf(buf + off, BUFFER_SIZE - off, "MIDI Clock (realtime)");
321 off += snprintf(buf + off, BUFFER_SIZE - off, "Tick (realtime)");
325 off += snprintf(buf + off, BUFFER_SIZE - off, "MIDI Start (realtime)");
329 off += snprintf(buf + off, BUFFER_SIZE - off, "MIDI Continue (realtime)");
333 off += snprintf(buf + off, BUFFER_SIZE - off, "MIDI Stop (realtime)");
337 off += snprintf(buf + off, BUFFER_SIZE - off, "Active Sense (realtime)");
349 smf_event_decode_sysex(const smf_event_t *event)
352 char *buf, manufacturer, subid, subid2;
354 assert(smf_event_is_sysex(event));
356 if (event->midi_buffer_length < 5) {
357 g_critical("smf_event_decode_sysex: truncated MIDI message.");
361 buf = (char*)malloc(BUFFER_SIZE);
363 g_critical("smf_event_decode_sysex: malloc failed.");
367 manufacturer = event->midi_buffer[1];
369 if (manufacturer == 0x7F) {
370 off += snprintf(buf + off, BUFFER_SIZE - off, "SysEx, realtime, channel %d", event->midi_buffer[2]);
371 } else if (manufacturer == 0x7E) {
372 off += snprintf(buf + off, BUFFER_SIZE - off, "SysEx, non-realtime, channel %d", event->midi_buffer[2]);
374 off += snprintf(buf + off, BUFFER_SIZE - off, "SysEx, manufacturer 0x%x", manufacturer);
379 subid = event->midi_buffer[3];
380 subid2 = event->midi_buffer[4];
383 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Header");
385 else if (subid == 0x02)
386 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Data Packet");
388 else if (subid == 0x03)
389 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Request");
391 else if (subid == 0x04 && subid2 == 0x01)
392 off += snprintf(buf + off, BUFFER_SIZE - off, ", Master Volume");
394 else if (subid == 0x05 && subid2 == 0x01)
395 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Loop Point Retransmit");
397 else if (subid == 0x05 && subid2 == 0x02)
398 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Loop Point Request");
400 else if (subid == 0x06 && subid2 == 0x01)
401 off += snprintf(buf + off, BUFFER_SIZE - off, ", Identity Request");
403 else if (subid == 0x06 && subid2 == 0x02)
404 off += snprintf(buf + off, BUFFER_SIZE - off, ", Identity Reply");
406 else if (subid == 0x08 && subid2 == 0x00)
407 off += snprintf(buf + off, BUFFER_SIZE - off, ", Bulk Tuning Dump Request");
409 else if (subid == 0x08 && subid2 == 0x01)
410 off += snprintf(buf + off, BUFFER_SIZE - off, ", Bulk Tuning Dump");
412 else if (subid == 0x08 && subid2 == 0x02)
413 off += snprintf(buf + off, BUFFER_SIZE - off, ", Single Note Tuning Change");
415 else if (subid == 0x08 && subid2 == 0x03)
416 off += snprintf(buf + off, BUFFER_SIZE - off, ", Bulk Tuning Dump Request (Bank)");
418 else if (subid == 0x08 && subid2 == 0x04)
419 off += snprintf(buf + off, BUFFER_SIZE - off, ", Key Based Tuning Dump");
421 else if (subid == 0x08 && subid2 == 0x05)
422 off += snprintf(buf + off, BUFFER_SIZE - off, ", Scale/Octave Tuning Dump, 1 byte format");
424 else if (subid == 0x08 && subid2 == 0x06)
425 off += snprintf(buf + off, BUFFER_SIZE - off, ", Scale/Octave Tuning Dump, 2 byte format");
427 else if (subid == 0x08 && subid2 == 0x07)
428 off += snprintf(buf + off, BUFFER_SIZE - off, ", Single Note Tuning Change (Bank)");
430 else if (subid == 0x09)
431 off += snprintf(buf + off, BUFFER_SIZE - off, ", General MIDI %s", subid2 == 0 ? "disable" : "enable");
433 else if (subid == 0x7C)
434 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Wait");
436 else if (subid == 0x7D)
437 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump Cancel");
439 else if (subid == 0x7E)
440 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump NAK");
442 else if (subid == 0x7F)
443 off += snprintf(buf + off, BUFFER_SIZE - off, ", Sample Dump ACK");
446 off += snprintf(buf + off, BUFFER_SIZE - off, ", Unknown");
452 smf_event_decode_system_common(const smf_event_t *event)
457 assert(smf_event_is_system_common(event));
459 if (smf_event_is_sysex(event))
460 return (smf_event_decode_sysex(event));
462 buf = (char*)malloc(BUFFER_SIZE);
464 g_critical("smf_event_decode_system_realtime: malloc failed.");
468 switch (event->midi_buffer[0]) {
470 off += snprintf(buf + off, BUFFER_SIZE - off, "MTC Quarter Frame");
474 off += snprintf(buf + off, BUFFER_SIZE - off, "Song Position Pointer");
478 off += snprintf(buf + off, BUFFER_SIZE - off, "Song Select");
482 off += snprintf(buf + off, BUFFER_SIZE - off, "Tune Request");
494 note_from_int(char *buf, int note_number)
497 const char *names[] = {"C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"};
499 octave = note_number / 12 - 1;
500 note = note_number % 12;
502 sprintf(buf, "%s%d", names[note], octave);
506 * \return Textual representation of the event given, or NULL, if event is unknown.
507 * Returned string looks like this:
509 * Note On, channel 1, note F#3, velocity 0
511 * You should free the returned string afterwards, using free(3).
514 smf_event_decode(const smf_event_t *event)
516 int off = 0, channel;
519 if (smf_event_is_metadata(event))
520 return (smf_event_decode_metadata(event));
522 if (smf_event_is_system_realtime(event))
523 return (smf_event_decode_system_realtime(event));
525 if (smf_event_is_system_common(event))
526 return (smf_event_decode_system_common(event));
528 if (!smf_event_length_is_valid(event)) {
529 g_critical("smf_event_decode: incorrect MIDI message length.");
533 buf = (char*)malloc(BUFFER_SIZE);
535 g_critical("smf_event_decode: malloc failed.");
539 /* + 1, because user-visible channels used to be in range <1-16>. */
540 channel = (event->midi_buffer[0] & 0x0F) + 1;
542 switch (event->midi_buffer[0] & 0xF0) {
544 note_from_int(note, event->midi_buffer[1]);
545 off += snprintf(buf + off, BUFFER_SIZE - off, "Note Off, channel %d, note %s, velocity %d",
546 channel, note, event->midi_buffer[2]);
550 note_from_int(note, event->midi_buffer[1]);
551 off += snprintf(buf + off, BUFFER_SIZE - off, "Note On, channel %d, note %s, velocity %d",
552 channel, note, event->midi_buffer[2]);
556 note_from_int(note, event->midi_buffer[1]);
557 off += snprintf(buf + off, BUFFER_SIZE - off, "Aftertouch, channel %d, note %s, pressure %d",
558 channel, note, event->midi_buffer[2]);
562 off += snprintf(buf + off, BUFFER_SIZE - off, "Controller, channel %d, controller %d, value %d",
563 channel, event->midi_buffer[1], event->midi_buffer[2]);
567 off += snprintf(buf + off, BUFFER_SIZE - off, "Program Change, channel %d, controller %d",
568 channel, event->midi_buffer[1]);
572 off += snprintf(buf + off, BUFFER_SIZE - off, "Channel Pressure, channel %d, pressure %d",
573 channel, event->midi_buffer[1]);
577 off += snprintf(buf + off, BUFFER_SIZE - off, "Pitch Wheel, channel %d, value %d",
578 channel, ((int)event->midi_buffer[2] << 7) | (int)event->midi_buffer[2]);
590 * \return Textual representation of the data extracted from MThd header, or NULL, if something goes wrong.
591 * Returned string looks like this:
593 * format: 1 (several simultaneous tracks); number of tracks: 4; division: 192 PPQN.
595 * You should free the returned string afterwards, using free(3).
598 smf_decode(const smf_t *smf)
603 buf = (char*)malloc(BUFFER_SIZE);
605 g_critical("smf_event_decode: malloc failed.");
609 off += snprintf(buf + off, BUFFER_SIZE - off, "format: %d ", smf->format);
611 switch (smf->format) {
613 off += snprintf(buf + off, BUFFER_SIZE - off, "(single track)");
617 off += snprintf(buf + off, BUFFER_SIZE - off, "(several simultaneous tracks)");
621 off += snprintf(buf + off, BUFFER_SIZE - off, "(several independent tracks)");
625 off += snprintf(buf + off, BUFFER_SIZE - off, "(INVALID FORMAT)");
629 off += snprintf(buf + off, BUFFER_SIZE - off, "; number of tracks: %d", smf->number_of_tracks);
632 off += snprintf(buf + off, BUFFER_SIZE - off, "; division: %d PPQN", smf->ppqn);
634 off += snprintf(buf + off, BUFFER_SIZE - off, "; division: %d FPS, %d resolution", smf->frames_per_second, smf->resolution);