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.
35 /* Reference: http://www.borg.com/~jglatt/tech/midifile.htm */
42 #ifdef PLATFORM_WINDOWS
45 #include <arpa/inet.h>
48 #include "smf_private.h"
51 * Allocates new smf_t structure.
52 * \return pointer to smf_t or NULL.
59 smf_t *smf = (smf_t*)malloc(sizeof(smf_t));
61 g_critical("Cannot allocate smf_t structure: %s", strerror(errno));
65 memset(smf, 0, sizeof(smf_t));
67 smf->tracks_array = g_ptr_array_new();
68 assert(smf->tracks_array);
70 smf->tempo_array = g_ptr_array_new();
71 assert(smf->tempo_array);
73 cantfail = smf_set_ppqn(smf, 120);
76 cantfail = smf_set_format(smf, 0);
85 * Frees smf and all it's descendant structures.
88 smf_delete(smf_t *smf)
90 /* Remove all the tracks, from last to first. */
91 while (smf->tracks_array->len > 0)
92 smf_track_delete((smf_track_t*)g_ptr_array_index(smf->tracks_array, smf->tracks_array->len - 1));
96 assert(smf->tracks_array->len == 0);
97 assert(smf->number_of_tracks == 0);
98 g_ptr_array_free(smf->tracks_array, TRUE);
99 g_ptr_array_free(smf->tempo_array, TRUE);
101 memset(smf, 0, sizeof(smf_t));
106 * Allocates new smf_track_t structure.
107 * \return pointer to smf_track_t or NULL.
112 smf_track_t *track = (smf_track_t*)malloc(sizeof(smf_track_t));
114 g_critical("Cannot allocate smf_track_t structure: %s", strerror(errno));
118 memset(track, 0, sizeof(smf_track_t));
119 track->next_event_number = 0;
121 track->events_array = g_ptr_array_new();
122 assert(track->events_array);
128 * Detaches track from its smf and frees it.
131 smf_track_delete(smf_track_t *track)
134 assert(track->events_array);
136 /* Remove all the events, from last to first. */
137 while (track->events_array->len > 0)
138 smf_event_delete((smf_event_t*)g_ptr_array_index(track->events_array, track->events_array->len - 1));
141 smf_track_remove_from_smf(track);
143 assert(track->events_array->len == 0);
144 assert(track->number_of_events == 0);
145 g_ptr_array_free(track->events_array, TRUE);
147 memset(track, 0, sizeof(smf_track_t));
153 * Appends smf_track_t to smf.
156 smf_add_track(smf_t *smf, smf_track_t *track)
160 assert(track->smf == NULL);
163 g_ptr_array_add(smf->tracks_array, track);
165 smf->number_of_tracks++;
166 track->track_number = smf->number_of_tracks;
168 if (smf->number_of_tracks > 1) {
169 cantfail = smf_set_format(smf, 1);
175 * Detaches track from the smf.
178 smf_track_remove_from_smf(smf_track_t *track)
185 assert(track->smf != NULL);
187 track->smf->number_of_tracks--;
189 assert(track->smf->tracks_array);
190 g_ptr_array_remove(track->smf->tracks_array, track);
192 /* Renumber the rest of the tracks, so they are consecutively numbered. */
193 for (i = track->track_number; i <= track->smf->number_of_tracks; i++) {
194 tmp = smf_get_track_by_number(track->smf, i);
195 tmp->track_number = i;
198 * Events have track numbers too. I guess this wasn't a wise
201 for (j = 1; j <= tmp->number_of_events; j++) {
202 ev = smf_track_get_event_by_number(tmp, j);
203 ev->track_number = i;
207 track->track_number = -1;
212 * Allocates new smf_event_t structure. The caller is responsible for allocating
213 * event->midi_buffer, filling it with MIDI data and setting event->midi_buffer_length properly.
214 * Note that event->midi_buffer will be freed by smf_event_delete.
215 * \return pointer to smf_event_t or NULL.
220 smf_event_t *event = (smf_event_t*)malloc(sizeof(smf_event_t));
222 g_critical("Cannot allocate smf_event_t structure: %s", strerror(errno));
226 memset(event, 0, sizeof(smf_event_t));
228 event->delta_time_pulses = -1;
229 event->time_pulses = -1;
230 event->time_seconds = -1.0;
231 event->track_number = -1;
237 * Allocates an smf_event_t structure and fills it with "len" bytes copied
239 * \param midi_data Pointer to MIDI data. It sill be copied to the newly allocated event->midi_buffer.
240 * \param len Length of the buffer. It must be proper MIDI event length, e.g. 3 for Note On event.
241 * \return Event containing MIDI data or NULL.
244 smf_event_new_from_pointer(const void *midi_data, size_t len)
248 event = smf_event_new();
252 event->midi_buffer_length = len;
253 event->midi_buffer = (uint8_t*)malloc(event->midi_buffer_length);
254 if (event->midi_buffer == NULL) {
255 g_critical("Cannot allocate MIDI buffer structure: %s", strerror(errno));
256 smf_event_delete(event);
261 memcpy(event->midi_buffer, midi_data, len);
267 * Allocates an smf_event_t structure and fills it with at most three bytes of data.
268 * For example, if you need to create Note On event, do something like this:
270 * smf_event_new_from_bytes(0x90, 0x3C, 0x7f);
272 * To create event for MIDI message that is shorter than three bytes, do something
275 * smf_event_new_from_bytes(0xC0, 0x42, -1);
277 * \param first_byte First byte of MIDI message. Must be valid status byte.
278 * \param second_byte Second byte of MIDI message or -1, if message is one byte long.
279 * \param third_byte Third byte of MIDI message or -1, if message is two bytes long.
280 * \return Event containing MIDI data or NULL.
283 smf_event_new_from_bytes(int first_byte, int second_byte, int third_byte)
289 event = smf_event_new();
293 if (first_byte < 0) {
294 g_critical("First byte of MIDI message cannot be < 0");
295 smf_event_delete(event);
300 if (first_byte > 255) {
301 g_critical("smf_event_new_from_bytes: first byte is %d, which is larger than 255.", first_byte);
305 if (!is_status_byte(first_byte)) {
306 g_critical("smf_event_new_from_bytes: first byte is not a valid status byte.");
313 else if (third_byte < 0)
319 if (second_byte > 255) {
320 g_critical("smf_event_new_from_bytes: second byte is %d, which is larger than 255.", second_byte);
324 if (is_status_byte(second_byte)) {
325 g_critical("smf_event_new_from_bytes: second byte cannot be a status byte.");
331 if (third_byte > 255) {
332 g_critical("smf_event_new_from_bytes: third byte is %d, which is larger than 255.", third_byte);
336 if (is_status_byte(third_byte)) {
337 g_critical("smf_event_new_from_bytes: third byte cannot be a status byte.");
342 event->midi_buffer_length = len;
343 event->midi_buffer = (uint8_t*)malloc(event->midi_buffer_length);
344 if (event->midi_buffer == NULL) {
345 g_critical("Cannot allocate MIDI buffer structure: %s", strerror(errno));
346 smf_event_delete(event);
351 event->midi_buffer[0] = first_byte;
353 event->midi_buffer[1] = second_byte;
355 event->midi_buffer[2] = third_byte;
361 * Detaches event from its track and frees it.
364 smf_event_delete(smf_event_t *event)
366 if (event->track != NULL)
367 smf_event_remove_from_track(event);
369 if (event->midi_buffer != NULL) {
370 memset(event->midi_buffer, 0, event->midi_buffer_length);
371 free(event->midi_buffer);
374 memset(event, 0, sizeof(smf_event_t));
379 * Used for sorting track->events_array.
382 events_array_compare_function(gconstpointer aa, gconstpointer bb)
384 const smf_event_t *a, *b;
386 /* "The comparison function for g_ptr_array_sort() doesn't take the pointers
387 from the array as arguments, it takes pointers to the pointers in the array." */
388 a = (const smf_event_t *)*(const gpointer *)aa;
389 b = (const smf_event_t *)*(const gpointer *)bb;
391 if (a->time_pulses < b->time_pulses)
394 if (a->time_pulses > b->time_pulses)
398 * We need to preserve original order, otherwise things will break
399 * when there are several events with the same ->time_pulses.
400 * XXX: This is an ugly hack; we should remove sorting altogether.
403 if (a->event_number < b->event_number)
406 if (a->event_number > b->event_number)
413 * An assumption here is that if there is an EOT event, it will be at the end of the track.
416 remove_eot_if_before_pulses(smf_track_t *track, size_t pulses)
420 event = smf_track_get_last_event(track);
425 if (!smf_event_is_eot(event))
428 if (event->time_pulses > pulses)
431 smf_event_remove_from_track(event);
435 * Adds the event to the track and computes ->delta_pulses. Note that it is faster
436 * to append events to the end of the track than to insert them in the middle.
437 * Usually you want to use smf_track_add_event_seconds or smf_track_add_event_pulses
438 * instead of this one. Event needs to have ->time_pulses and ->time_seconds already set.
439 * If you try to add event after an EOT, EOT event will be automatically deleted.
442 smf_track_add_event(smf_track_t *track, smf_event_t *event)
444 size_t i, last_pulses = 0;
446 assert(track->smf != NULL);
447 assert(event->track == NULL);
448 assert(event->delta_time_pulses == -1);
449 assert(event->time_seconds >= 0.0);
451 remove_eot_if_before_pulses(track, event->time_pulses);
453 event->track = track;
454 event->track_number = track->track_number;
456 if (track->number_of_events == 0) {
457 assert(track->next_event_number == 0);
458 track->next_event_number = 1;
461 if (track->number_of_events > 0)
462 last_pulses = smf_track_get_last_event(track)->time_pulses;
464 track->number_of_events++;
466 /* Are we just appending element at the end of the track? */
467 if (last_pulses <= event->time_pulses) {
468 event->delta_time_pulses = event->time_pulses - last_pulses;
469 assert(event->delta_time_pulses >= 0);
470 g_ptr_array_add(track->events_array, event);
471 event->event_number = track->number_of_events;
473 /* We need to insert in the middle of the track. XXX: This is slow. */
475 /* Append, then sort according to ->time_pulses. */
476 g_ptr_array_add(track->events_array, event);
477 g_ptr_array_sort(track->events_array, events_array_compare_function);
479 /* Renumber entries and fix their ->delta_pulses. */
480 for (i = 1; i <= track->number_of_events; i++) {
481 smf_event_t *tmp = smf_track_get_event_by_number(track, i);
482 tmp->event_number = i;
484 if (tmp->delta_time_pulses != -1)
488 tmp->delta_time_pulses = tmp->time_pulses;
490 tmp->delta_time_pulses = tmp->time_pulses -
491 smf_track_get_event_by_number(track, i - 1)->time_pulses;
492 assert(tmp->delta_time_pulses >= 0);
496 /* Adjust ->delta_time_pulses of the next event. */
497 if (event->event_number < track->number_of_events) {
498 smf_event_t *next_event = smf_track_get_event_by_number(track, event->event_number + 1);
500 assert(next_event->time_pulses >= event->time_pulses);
501 next_event->delta_time_pulses -= event->delta_time_pulses;
502 assert(next_event->delta_time_pulses >= 0);
506 if (smf_event_is_tempo_change_or_time_signature(event)) {
507 if (smf_event_is_last(event))
508 maybe_add_to_tempo_map(event);
510 smf_create_tempo_map_and_compute_seconds(event->track->smf);
515 * Add End Of Track metaevent. Using it is optional, libsmf will automatically
516 * add EOT to the tracks during smf_save, with delta_pulses 0. If you try to add EOT
517 * in the middle of the track, it will fail and nonzero value will be returned.
518 * If you try to add EOT after another EOT event, it will be added, but the existing
519 * EOT event will be removed.
521 * \return 0 if everything went ok, nonzero otherwise.
524 smf_track_add_eot_delta_pulses(smf_track_t *track, uint32_t delta)
528 event = smf_event_new_from_bytes(0xFF, 0x2F, 0x00);
532 smf_track_add_event_delta_pulses(track, event, delta);
538 smf_track_add_eot_pulses(smf_track_t *track, size_t pulses)
540 smf_event_t *event, *last_event;
542 last_event = smf_track_get_last_event(track);
543 if (last_event != NULL) {
544 if (last_event->time_pulses > pulses)
548 event = smf_event_new_from_bytes(0xFF, 0x2F, 0x00);
552 smf_track_add_event_pulses(track, event, pulses);
558 smf_track_add_eot_seconds(smf_track_t *track, double seconds)
560 smf_event_t *event, *last_event;
562 last_event = smf_track_get_last_event(track);
563 if (last_event != NULL) {
564 if (last_event->time_seconds > seconds)
568 event = smf_event_new_from_bytes(0xFF, 0x2F, 0x00);
572 smf_track_add_event_seconds(track, event, seconds);
578 * Detaches event from its track.
581 smf_event_remove_from_track(smf_event_t *event)
588 assert(event->track != NULL);
589 assert(event->track->smf != NULL);
591 track = event->track;
592 was_last = smf_event_is_last(event);
594 /* Adjust ->delta_time_pulses of the next event. */
595 if (event->event_number < track->number_of_events) {
596 tmp = smf_track_get_event_by_number(track, event->event_number + 1);
598 tmp->delta_time_pulses += event->delta_time_pulses;
601 track->number_of_events--;
602 g_ptr_array_remove(track->events_array, event);
604 if (track->number_of_events == 0)
605 track->next_event_number = 0;
607 /* Renumber the rest of the events, so they are consecutively numbered. */
608 for (i = event->event_number; i <= track->number_of_events; i++) {
609 tmp = smf_track_get_event_by_number(track, i);
610 tmp->event_number = i;
613 if (smf_event_is_tempo_change_or_time_signature(event)) {
614 /* XXX: This will cause problems, when there is more than one Tempo Change event at a given time. */
616 remove_last_tempo_with_pulses(event->track->smf, event->time_pulses);
618 smf_create_tempo_map_and_compute_seconds(track->smf);
622 event->event_number = 0;
623 event->delta_time_pulses = -1;
624 event->time_pulses = 0;
625 event->time_seconds = -1.0;
629 * \return Nonzero if event is Tempo Change or Time Signature metaevent.
632 smf_event_is_tempo_change_or_time_signature(const smf_event_t *event)
634 if (!smf_event_is_metadata(event))
637 assert(event->midi_buffer_length >= 2);
639 if (event->midi_buffer[1] == 0x51 || event->midi_buffer[1] == 0x58)
646 * Sets "Format" field of MThd header to the specified value. Note that you
647 * don't really need to use this, as libsmf will automatically change format
648 * from 0 to 1 when you add the second track.
650 * \param format 0 for one track per file, 1 for several tracks per file.
653 smf_set_format(smf_t *smf, int format)
655 assert(format == 0 || format == 1);
657 if (smf->number_of_tracks > 1 && format == 0) {
658 g_critical("There is more than one track, cannot set format to 0.");
662 smf->format = format;
668 * Sets the PPQN ("Division") field of MThd header. This is mandatory, you
669 * should call it right after smf_new. Note that changing PPQN will change time_seconds
672 * \param ppqn New PPQN.
675 smf_set_ppqn(smf_t *smf, uint16_t ppqn)
683 * Returns next event from the track given and advances next event counter.
684 * Do not depend on End Of Track event being the last event on the track - it
685 * is possible that the track will not end with EOT if you haven't added it
686 * yet. EOTs are added automatically during smf_save().
688 * \return Event or NULL, if there are no more events left in this track.
691 smf_track_get_next_event(smf_track_t *track)
693 smf_event_t *event, *next_event;
695 /* Track is empty? */
696 if (track->number_of_events == 0)
700 if (track->next_event_number == 0)
703 assert(track->next_event_number >= 1);
705 event = smf_track_get_event_by_number(track, track->next_event_number);
707 assert(event != NULL);
709 /* Is this the last event in the track? */
710 if (track->next_event_number < track->number_of_events) {
711 next_event = smf_track_get_event_by_number(track, track->next_event_number + 1);
714 track->time_of_next_event = next_event->time_pulses;
715 track->next_event_number++;
717 track->next_event_number = 0;
724 * Returns next event from the track given. Does not change next event counter,
725 * so repeatedly calling this routine will return the same event.
726 * \return Event or NULL, if there are no more events left in this track.
729 smf_peek_next_event_from_track(smf_track_t *track)
734 if (track->next_event_number == 0)
737 assert(track->next_event_number >= 1);
738 assert(track->events_array->len != 0);
740 event = smf_track_get_event_by_number(track, track->next_event_number);
746 * \return Track with a given number or NULL, if there is no such track.
747 * Tracks are numbered consecutively starting from one.
750 smf_get_track_by_number(const smf_t *smf, int track_number)
754 assert(track_number >= 1);
756 if (track_number > smf->number_of_tracks)
759 track = (smf_track_t *)g_ptr_array_index(smf->tracks_array, track_number - 1);
767 * \return Event with a given number or NULL, if there is no such event.
768 * Events are numbered consecutively starting from one.
771 smf_track_get_event_by_number(const smf_track_t *track, size_t event_number)
775 assert(event_number >= 1);
777 if (event_number > track->number_of_events)
780 event = (smf_event_t*)g_ptr_array_index(track->events_array, event_number - 1);
788 * \return Last event on the track or NULL, if track is empty.
791 smf_track_get_last_event(const smf_track_t *track)
795 if (track->number_of_events == 0)
798 event = smf_track_get_event_by_number(track, track->number_of_events);
804 * Searches for track that contains next event, in time order. In other words,
805 * returns the track that contains event that should be played next.
806 * \return Track with next event or NULL, if there are no events left.
809 smf_find_track_with_next_event(smf_t *smf)
813 smf_track_t *track = NULL, *min_time_track = NULL;
815 /* Find track with event that should be played next. */
816 for (i = 1; i <= smf->number_of_tracks; i++) {
817 track = smf_get_track_by_number(smf, i);
821 /* No more events in this track? */
822 if (track->next_event_number == 0)
825 if (track->time_of_next_event < min_time || min_time_track == NULL) {
826 min_time = track->time_of_next_event;
827 min_time_track = track;
831 return (min_time_track);
835 * \return Next event, in time order, or NULL, if there are none left.
838 smf_get_next_event(smf_t *smf)
841 smf_track_t *track = smf_find_track_with_next_event(smf);
845 g_debug("End of the song.");
851 event = smf_track_get_next_event(track);
853 assert(event != NULL);
855 event->track->smf->last_seek_position = -1.0;
861 * Advance the "next event counter". This is functionally the same as calling
862 * smf_get_next_event and ignoring the return value.
865 smf_skip_next_event(smf_t *smf)
869 notused = smf_get_next_event(smf);
873 * \return Next event, in time order, or NULL, if there are none left. Does
874 * not advance position in song.
877 smf_peek_next_event(smf_t *smf)
880 smf_track_t *track = smf_find_track_with_next_event(smf);
884 g_debug("End of the song.");
890 event = smf_peek_next_event_from_track(track);
892 assert(event != NULL);
898 * Rewinds the SMF. What that means is, after calling this routine, smf_get_next_event
899 * will return first event in the song.
902 smf_rewind(smf_t *smf)
905 smf_track_t *track = NULL;
910 smf->last_seek_position = 0.0;
912 for (i = 1; i <= smf->number_of_tracks; i++) {
913 track = smf_get_track_by_number(smf, i);
915 assert(track != NULL);
917 if (track->number_of_events > 0) {
918 track->next_event_number = 1;
919 event = smf_peek_next_event_from_track(track);
921 track->time_of_next_event = event->time_pulses;
923 track->next_event_number = 0;
924 track->time_of_next_event = 0;
926 g_warning("Warning: empty track.");
933 * Seeks the SMF to the given event. After calling this routine, smf_get_next_event
934 * will return the event that was the second argument of this call.
937 smf_seek_to_event(smf_t *smf, const smf_event_t *target)
944 g_debug("Seeking to event %d, track %d.", target->event_number, target->track->track_number);
948 event = smf_peek_next_event(smf);
950 /* There can't be NULL here, unless "target" is not in this smf. */
954 smf_skip_next_event(smf);
959 smf->last_seek_position = event->time_seconds;
965 * Seeks the SMF to the given position. For example, after seeking to 1.0 seconds,
966 * smf_get_next_event will return first event that happens after the first second of song.
969 smf_seek_to_seconds(smf_t *smf, double seconds)
973 assert(seconds >= 0.0);
975 if (seconds == smf->last_seek_position) {
977 g_debug("Avoiding seek to %f seconds.", seconds);
985 g_debug("Seeking to %f seconds.", seconds);
989 event = smf_peek_next_event(smf);
992 g_critical("Trying to seek past the end of song.");
996 if (event->time_seconds < seconds)
997 smf_skip_next_event(smf);
1002 smf->last_seek_position = seconds;
1008 * Seeks the SMF to the given position. For example, after seeking to 10 pulses,
1009 * smf_get_next_event will return first event that happens after the first ten pulses.
1012 smf_seek_to_pulses(smf_t *smf, size_t pulses)
1019 g_debug("Seeking to %d pulses.", pulses);
1023 event = smf_peek_next_event(smf);
1025 if (event == NULL) {
1026 g_critical("Trying to seek past the end of song.");
1030 if (event->time_pulses < pulses)
1031 smf_skip_next_event(smf);
1036 smf->last_seek_position = event->time_seconds;
1042 * \return Length of SMF, in pulses.
1045 smf_get_length_pulses(const smf_t *smf)
1050 for (i = 1; i <= smf->number_of_tracks; i++) {
1054 track = smf_get_track_by_number(smf, i);
1057 event = smf_track_get_last_event(track);
1062 if (event->time_pulses > pulses)
1063 pulses = event->time_pulses;
1070 * \return Length of SMF, in seconds.
1073 smf_get_length_seconds(const smf_t *smf)
1076 double seconds = 0.0;
1078 for (i = 1; i <= smf->number_of_tracks; i++) {
1082 track = smf_get_track_by_number(smf, i);
1085 event = smf_track_get_last_event(track);
1090 if (event->time_seconds > seconds)
1091 seconds = event->time_seconds;
1098 * \return Nonzero, if there are no events in the SMF after this one.
1099 * Note that may be more than one "last event", if they occur at the same time.
1102 smf_event_is_last(const smf_event_t *event)
1104 if (smf_get_length_pulses(event->track->smf) <= event->time_pulses)
1111 * \return Version of libsmf.
1114 smf_get_version(void)
1116 return (SMF_VERSION);