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 #include <arpa/inet.h>
44 #include "smf_private.h"
47 * Allocates new smf_t structure.
48 * \return pointer to smf_t or NULL.
55 smf_t *smf = malloc(sizeof(smf_t));
57 g_critical("Cannot allocate smf_t structure: %s", strerror(errno));
61 memset(smf, 0, sizeof(smf_t));
63 smf->tracks_array = g_ptr_array_new();
64 assert(smf->tracks_array);
66 smf->tempo_array = g_ptr_array_new();
67 assert(smf->tempo_array);
69 cantfail = smf_set_ppqn(smf, 120);
72 cantfail = smf_set_format(smf, 0);
81 * Frees smf and all it's descendant structures.
84 smf_delete(smf_t *smf)
86 /* Remove all the tracks, from last to first. */
87 while (smf->tracks_array->len > 0)
88 smf_track_delete(g_ptr_array_index(smf->tracks_array, smf->tracks_array->len - 1));
92 assert(smf->tracks_array->len == 0);
93 assert(smf->number_of_tracks == 0);
94 g_ptr_array_free(smf->tracks_array, TRUE);
95 g_ptr_array_free(smf->tempo_array, TRUE);
97 memset(smf, 0, sizeof(smf_t));
102 * Allocates new smf_track_t structure.
103 * \return pointer to smf_track_t or NULL.
108 smf_track_t *track = malloc(sizeof(smf_track_t));
110 g_critical("Cannot allocate smf_track_t structure: %s", strerror(errno));
114 memset(track, 0, sizeof(smf_track_t));
115 track->next_event_number = 0;
117 track->events_array = g_ptr_array_new();
118 assert(track->events_array);
124 * Detaches track from its smf and frees it.
127 smf_track_delete(smf_track_t *track)
130 assert(track->events_array);
132 /* Remove all the events, from last to first. */
133 while (track->events_array->len > 0)
134 smf_event_delete(g_ptr_array_index(track->events_array, track->events_array->len - 1));
137 smf_track_remove_from_smf(track);
139 assert(track->events_array->len == 0);
140 assert(track->number_of_events == 0);
141 g_ptr_array_free(track->events_array, TRUE);
143 memset(track, 0, sizeof(smf_track_t));
149 * Appends smf_track_t to smf.
152 smf_add_track(smf_t *smf, smf_track_t *track)
158 assert(track->smf == NULL);
161 g_ptr_array_add(smf->tracks_array, track);
163 smf->number_of_tracks++;
164 track->track_number = smf->number_of_tracks;
166 if (smf->number_of_tracks > 1) {
168 cantfail = smf_set_format(smf, 1);
171 smf_set_format(smf, 1);
178 * Detaches track from the smf.
181 smf_track_remove_from_smf(smf_track_t *track)
188 assert(track->smf != NULL);
190 track->smf->number_of_tracks--;
192 assert(track->smf->tracks_array);
193 g_ptr_array_remove(track->smf->tracks_array, track);
195 /* Renumber the rest of the tracks, so they are consecutively numbered. */
196 for (i = track->track_number; i <= track->smf->number_of_tracks; i++) {
197 tmp = smf_get_track_by_number(track->smf, i);
198 tmp->track_number = i;
201 * Events have track numbers too. I guess this wasn't a wise
204 for (j = 1; j <= tmp->number_of_events; j++) {
205 ev = smf_track_get_event_by_number(tmp, j);
206 ev->track_number = i;
210 track->track_number = -1;
215 * Allocates new smf_event_t structure. The caller is responsible for allocating
216 * event->midi_buffer, filling it with MIDI data and setting event->midi_buffer_length properly.
217 * Note that event->midi_buffer will be freed by smf_event_delete.
218 * \return pointer to smf_event_t or NULL.
223 smf_event_t *event = malloc(sizeof(smf_event_t));
225 g_critical("Cannot allocate smf_event_t structure: %s", strerror(errno));
229 memset(event, 0, sizeof(smf_event_t));
231 event->delta_time_pulses = -1;
232 event->time_pulses = -1;
233 event->time_seconds = -1.0;
234 event->track_number = -1;
240 * Allocates an smf_event_t structure and fills it with "len" bytes copied
242 * \param midi_data Pointer to MIDI data. It sill be copied to the newly allocated event->midi_buffer.
243 * \param len Length of the buffer. It must be proper MIDI event length, e.g. 3 for Note On event.
244 * \return Event containing MIDI data or NULL.
247 smf_event_new_from_pointer(const void *midi_data, size_t len)
251 event = smf_event_new();
255 event->midi_buffer_length = len;
256 event->midi_buffer = malloc(event->midi_buffer_length);
257 if (event->midi_buffer == NULL) {
258 g_critical("Cannot allocate MIDI buffer structure: %s", strerror(errno));
259 smf_event_delete(event);
264 memcpy(event->midi_buffer, midi_data, len);
270 * Allocates an smf_event_t structure and fills it with at most three bytes of data.
271 * For example, if you need to create Note On event, do something like this:
273 * smf_event_new_from_bytes(0x90, 0x3C, 0x7f);
275 * To create event for MIDI message that is shorter than three bytes, do something
278 * smf_event_new_from_bytes(0xC0, 0x42, -1);
280 * \param first_byte First byte of MIDI message. Must be valid status byte.
281 * \param second_byte Second byte of MIDI message or -1, if message is one byte long.
282 * \param third_byte Third byte of MIDI message or -1, if message is two bytes long.
283 * \return Event containing MIDI data or NULL.
286 smf_event_new_from_bytes(int first_byte, int second_byte, int third_byte)
292 event = smf_event_new();
296 if (first_byte < 0) {
297 g_critical("First byte of MIDI message cannot be < 0");
298 smf_event_delete(event);
303 if (first_byte > 255) {
304 g_critical("smf_event_new_from_bytes: first byte is %d, which is larger than 255.", first_byte);
308 if (!is_status_byte(first_byte)) {
309 g_critical("smf_event_new_from_bytes: first byte is not a valid status byte.");
316 else if (third_byte < 0)
322 if (second_byte > 255) {
323 g_critical("smf_event_new_from_bytes: second byte is %d, which is larger than 255.", second_byte);
327 if (is_status_byte(second_byte)) {
328 g_critical("smf_event_new_from_bytes: second byte cannot be a status byte.");
334 if (third_byte > 255) {
335 g_critical("smf_event_new_from_bytes: third byte is %d, which is larger than 255.", third_byte);
339 if (is_status_byte(third_byte)) {
340 g_critical("smf_event_new_from_bytes: third byte cannot be a status byte.");
345 event->midi_buffer_length = len;
346 event->midi_buffer = malloc(event->midi_buffer_length);
347 if (event->midi_buffer == NULL) {
348 g_critical("Cannot allocate MIDI buffer structure: %s", strerror(errno));
349 smf_event_delete(event);
354 event->midi_buffer[0] = first_byte;
356 event->midi_buffer[1] = second_byte;
358 event->midi_buffer[2] = third_byte;
364 * Detaches event from its track and frees it.
367 smf_event_delete(smf_event_t *event)
369 if (event->track != NULL)
370 smf_event_remove_from_track(event);
372 if (event->midi_buffer != NULL) {
373 memset(event->midi_buffer, 0, event->midi_buffer_length);
374 free(event->midi_buffer);
377 memset(event, 0, sizeof(smf_event_t));
382 * Used for sorting track->events_array.
385 events_array_compare_function(gconstpointer aa, gconstpointer bb)
387 const smf_event_t *a, *b;
389 /* "The comparison function for g_ptr_array_sort() doesn't take the pointers
390 from the array as arguments, it takes pointers to the pointers in the array." */
391 a = (const smf_event_t *)*(const gpointer *)aa;
392 b = (const smf_event_t *)*(const gpointer *)bb;
394 if (a->time_pulses < b->time_pulses)
397 if (a->time_pulses > b->time_pulses)
401 * We need to preserve original order, otherwise things will break
402 * when there are several events with the same ->time_pulses.
403 * XXX: This is an ugly hack; we should remove sorting altogether.
406 if (a->event_number < b->event_number)
409 if (a->event_number > b->event_number)
416 * An assumption here is that if there is an EOT event, it will be at the end of the track.
419 remove_eot_if_before_pulses(smf_track_t *track, size_t pulses)
423 event = smf_track_get_last_event(track);
428 if (!smf_event_is_eot(event))
431 if (event->time_pulses > pulses)
434 smf_event_remove_from_track(event);
438 * Adds the event to the track and computes ->delta_pulses. Note that it is faster
439 * to append events to the end of the track than to insert them in the middle.
440 * Usually you want to use smf_track_add_event_seconds or smf_track_add_event_pulses
441 * instead of this one. Event needs to have ->time_pulses and ->time_seconds already set.
442 * If you try to add event after an EOT, EOT event will be automatically deleted.
445 smf_track_add_event(smf_track_t *track, smf_event_t *event)
447 size_t i, last_pulses = 0;
449 assert(track->smf != NULL);
450 assert(event->track == NULL);
451 assert(event->delta_time_pulses == -1);
452 assert(event->time_seconds >= 0.0);
454 remove_eot_if_before_pulses(track, event->time_pulses);
456 event->track = track;
457 event->track_number = track->track_number;
459 if (track->number_of_events == 0) {
460 assert(track->next_event_number == 0);
461 track->next_event_number = 1;
464 if (track->number_of_events > 0)
465 last_pulses = smf_track_get_last_event(track)->time_pulses;
467 track->number_of_events++;
469 /* Are we just appending element at the end of the track? */
470 if (last_pulses <= event->time_pulses) {
471 event->delta_time_pulses = event->time_pulses - last_pulses;
472 assert(event->delta_time_pulses >= 0);
473 g_ptr_array_add(track->events_array, event);
474 event->event_number = track->number_of_events;
476 /* We need to insert in the middle of the track. XXX: This is slow. */
478 /* Append, then sort according to ->time_pulses. */
479 g_ptr_array_add(track->events_array, event);
480 g_ptr_array_sort(track->events_array, events_array_compare_function);
482 /* Renumber entries and fix their ->delta_pulses. */
483 for (i = 1; i <= track->number_of_events; i++) {
484 smf_event_t *tmp = smf_track_get_event_by_number(track, i);
485 tmp->event_number = i;
487 if (tmp->delta_time_pulses != -1)
491 tmp->delta_time_pulses = tmp->time_pulses;
493 tmp->delta_time_pulses = tmp->time_pulses -
494 smf_track_get_event_by_number(track, i - 1)->time_pulses;
495 assert(tmp->delta_time_pulses >= 0);
499 /* Adjust ->delta_time_pulses of the next event. */
500 if (event->event_number < track->number_of_events) {
501 smf_event_t *next_event = smf_track_get_event_by_number(track, event->event_number + 1);
503 assert(next_event->time_pulses >= event->time_pulses);
504 next_event->delta_time_pulses -= event->delta_time_pulses;
505 assert(next_event->delta_time_pulses >= 0);
509 if (smf_event_is_tempo_change_or_time_signature(event)) {
510 if (smf_event_is_last(event))
511 maybe_add_to_tempo_map(event);
513 smf_create_tempo_map_and_compute_seconds(event->track->smf);
518 * Add End Of Track metaevent. Using it is optional, libsmf will automatically
519 * add EOT to the tracks during smf_save, with delta_pulses 0. If you try to add EOT
520 * in the middle of the track, it will fail and nonzero value will be returned.
521 * If you try to add EOT after another EOT event, it will be added, but the existing
522 * EOT event will be removed.
524 * \return 0 if everything went ok, nonzero otherwise.
527 smf_track_add_eot_delta_pulses(smf_track_t *track, uint32_t delta)
531 event = smf_event_new_from_bytes(0xFF, 0x2F, 0x00);
535 smf_track_add_event_delta_pulses(track, event, delta);
541 smf_track_add_eot_pulses(smf_track_t *track, size_t pulses)
543 smf_event_t *event, *last_event;
545 last_event = smf_track_get_last_event(track);
546 if (last_event != NULL) {
547 if (last_event->time_pulses > pulses)
551 event = smf_event_new_from_bytes(0xFF, 0x2F, 0x00);
555 smf_track_add_event_pulses(track, event, pulses);
561 smf_track_add_eot_seconds(smf_track_t *track, double seconds)
563 smf_event_t *event, *last_event;
565 last_event = smf_track_get_last_event(track);
566 if (last_event != NULL) {
567 if (last_event->time_seconds > seconds)
571 event = smf_event_new_from_bytes(0xFF, 0x2F, 0x00);
575 smf_track_add_event_seconds(track, event, seconds);
581 * Detaches event from its track.
584 smf_event_remove_from_track(smf_event_t *event)
591 assert(event->track != NULL);
592 assert(event->track->smf != NULL);
594 track = event->track;
595 was_last = smf_event_is_last(event);
597 /* Adjust ->delta_time_pulses of the next event. */
598 if (event->event_number < track->number_of_events) {
599 tmp = smf_track_get_event_by_number(track, event->event_number + 1);
601 tmp->delta_time_pulses += event->delta_time_pulses;
604 track->number_of_events--;
605 g_ptr_array_remove(track->events_array, event);
607 if (track->number_of_events == 0)
608 track->next_event_number = 0;
610 /* Renumber the rest of the events, so they are consecutively numbered. */
611 for (i = event->event_number; i <= track->number_of_events; i++) {
612 tmp = smf_track_get_event_by_number(track, i);
613 tmp->event_number = i;
616 if (smf_event_is_tempo_change_or_time_signature(event)) {
617 /* XXX: This will cause problems, when there is more than one Tempo Change event at a given time. */
619 remove_last_tempo_with_pulses(event->track->smf, event->time_pulses);
621 smf_create_tempo_map_and_compute_seconds(track->smf);
625 event->event_number = 0;
626 event->delta_time_pulses = -1;
627 event->time_pulses = 0;
628 event->time_seconds = -1.0;
632 * \return Nonzero if event is Tempo Change or Time Signature metaevent.
635 smf_event_is_tempo_change_or_time_signature(const smf_event_t *event)
637 if (!smf_event_is_metadata(event))
640 assert(event->midi_buffer_length >= 2);
642 if (event->midi_buffer[1] == 0x51 || event->midi_buffer[1] == 0x58)
649 * Sets "Format" field of MThd header to the specified value. Note that you
650 * don't really need to use this, as libsmf will automatically change format
651 * from 0 to 1 when you add the second track.
653 * \param format 0 for one track per file, 1 for several tracks per file.
656 smf_set_format(smf_t *smf, int format)
658 assert(format == 0 || format == 1);
660 if (smf->number_of_tracks > 1 && format == 0) {
661 g_critical("There is more than one track, cannot set format to 0.");
665 smf->format = format;
671 * Sets the PPQN ("Division") field of MThd header. This is mandatory, you
672 * should call it right after smf_new. Note that changing PPQN will change time_seconds
675 * \param ppqn New PPQN.
678 smf_set_ppqn(smf_t *smf, uint16_t ppqn)
686 * Returns next event from the track given and advances next event counter.
687 * Do not depend on End Of Track event being the last event on the track - it
688 * is possible that the track will not end with EOT if you haven't added it
689 * yet. EOTs are added automatically during smf_save().
691 * \return Event or NULL, if there are no more events left in this track.
694 smf_track_get_next_event(smf_track_t *track)
696 smf_event_t *event, *next_event;
698 /* Track is empty? */
699 if (track->number_of_events == 0)
703 if (track->next_event_number == 0)
706 assert(track->next_event_number >= 1);
708 event = smf_track_get_event_by_number(track, track->next_event_number);
710 assert(event != NULL);
712 /* Is this the last event in the track? */
713 if (track->next_event_number < track->number_of_events) {
714 next_event = smf_track_get_event_by_number(track, track->next_event_number + 1);
717 track->time_of_next_event = next_event->time_pulses;
718 track->next_event_number++;
720 track->next_event_number = 0;
727 * Returns next event from the track given. Does not change next event counter,
728 * so repeatedly calling this routine will return the same event.
729 * \return Event or NULL, if there are no more events left in this track.
732 smf_peek_next_event_from_track(smf_track_t *track)
737 if (track->next_event_number == 0)
740 assert(track->next_event_number >= 1);
741 assert(track->events_array->len != 0);
743 event = smf_track_get_event_by_number(track, track->next_event_number);
749 * \return Track with a given number or NULL, if there is no such track.
750 * Tracks are numbered consecutively starting from one.
753 smf_get_track_by_number(const smf_t *smf, int track_number)
757 assert(track_number >= 1);
759 if (track_number > smf->number_of_tracks)
762 track = (smf_track_t *)g_ptr_array_index(smf->tracks_array, track_number - 1);
770 * \return Event with a given number or NULL, if there is no such event.
771 * Events are numbered consecutively starting from one.
774 smf_track_get_event_by_number(const smf_track_t *track, size_t event_number)
778 assert(event_number >= 1);
780 if (event_number > track->number_of_events)
783 event = g_ptr_array_index(track->events_array, event_number - 1);
791 * \return Last event on the track or NULL, if track is empty.
794 smf_track_get_last_event(const smf_track_t *track)
798 if (track->number_of_events == 0)
801 event = smf_track_get_event_by_number(track, track->number_of_events);
807 * Searches for track that contains next event, in time order. In other words,
808 * returns the track that contains event that should be played next.
809 * \return Track with next event or NULL, if there are no events left.
812 smf_find_track_with_next_event(smf_t *smf)
816 smf_track_t *track = NULL, *min_time_track = NULL;
818 /* Find track with event that should be played next. */
819 for (i = 1; i <= smf->number_of_tracks; i++) {
820 track = smf_get_track_by_number(smf, i);
824 /* No more events in this track? */
825 if (track->next_event_number == 0)
828 if (track->time_of_next_event < min_time || min_time_track == NULL) {
829 min_time = track->time_of_next_event;
830 min_time_track = track;
834 return (min_time_track);
838 * \return Next event, in time order, or NULL, if there are none left.
841 smf_get_next_event(smf_t *smf)
844 smf_track_t *track = smf_find_track_with_next_event(smf);
848 g_debug("End of the song.");
854 event = smf_track_get_next_event(track);
856 assert(event != NULL);
858 event->track->smf->last_seek_position = -1.0;
864 * Advance the "next event counter". This is functionally the same as calling
865 * smf_get_next_event and ignoring the return value.
868 smf_skip_next_event(smf_t *smf)
870 smf_event_t *ignored = smf_get_next_event(smf);
875 * \return Next event, in time order, or NULL, if there are none left. Does
876 * not advance position in song.
879 smf_peek_next_event(smf_t *smf)
882 smf_track_t *track = smf_find_track_with_next_event(smf);
886 g_debug("End of the song.");
892 event = smf_peek_next_event_from_track(track);
894 assert(event != NULL);
900 * Rewinds the SMF. What that means is, after calling this routine, smf_get_next_event
901 * will return first event in the song.
904 smf_rewind(smf_t *smf)
907 smf_track_t *track = NULL;
912 smf->last_seek_position = 0.0;
914 for (i = 1; i <= smf->number_of_tracks; i++) {
915 track = smf_get_track_by_number(smf, i);
917 assert(track != NULL);
919 if (track->number_of_events > 0) {
920 track->next_event_number = 1;
921 event = smf_peek_next_event_from_track(track);
923 track->time_of_next_event = event->time_pulses;
925 track->next_event_number = 0;
926 track->time_of_next_event = 0;
928 g_warning("Warning: empty track.");
935 * Seeks the SMF to the given event. After calling this routine, smf_get_next_event
936 * will return the event that was the second argument of this call.
939 smf_seek_to_event(smf_t *smf, const smf_event_t *target)
946 g_debug("Seeking to event %d, track %d.", target->event_number, target->track->track_number);
950 event = smf_peek_next_event(smf);
952 /* There can't be NULL here, unless "target" is not in this smf. */
956 smf_skip_next_event(smf);
961 smf->last_seek_position = event->time_seconds;
967 * Seeks the SMF to the given position. For example, after seeking to 1.0 seconds,
968 * smf_get_next_event will return first event that happens after the first second of song.
971 smf_seek_to_seconds(smf_t *smf, double seconds)
975 assert(seconds >= 0.0);
977 if (seconds == smf->last_seek_position) {
979 g_debug("Avoiding seek to %f seconds.", seconds);
987 g_debug("Seeking to %f seconds.", seconds);
991 event = smf_peek_next_event(smf);
994 g_critical("Trying to seek past the end of song.");
998 if (event->time_seconds < seconds)
999 smf_skip_next_event(smf);
1004 smf->last_seek_position = seconds;
1010 * Seeks the SMF to the given position. For example, after seeking to 10 pulses,
1011 * smf_get_next_event will return first event that happens after the first ten pulses.
1014 smf_seek_to_pulses(smf_t *smf, size_t pulses)
1021 g_debug("Seeking to %d pulses.", pulses);
1025 event = smf_peek_next_event(smf);
1027 if (event == NULL) {
1028 g_critical("Trying to seek past the end of song.");
1032 if (event->time_pulses < pulses)
1033 smf_skip_next_event(smf);
1038 smf->last_seek_position = event->time_seconds;
1044 * \return Length of SMF, in pulses.
1047 smf_get_length_pulses(const smf_t *smf)
1052 for (i = 1; i <= smf->number_of_tracks; i++) {
1056 track = smf_get_track_by_number(smf, i);
1059 event = smf_track_get_last_event(track);
1064 if (event->time_pulses > pulses)
1065 pulses = event->time_pulses;
1072 * \return Length of SMF, in seconds.
1075 smf_get_length_seconds(const smf_t *smf)
1078 double seconds = 0.0;
1080 for (i = 1; i <= smf->number_of_tracks; i++) {
1084 track = smf_get_track_by_number(smf, i);
1087 event = smf_track_get_last_event(track);
1092 if (event->time_seconds > seconds)
1093 seconds = event->time_seconds;
1100 * \return Nonzero, if there are no events in the SMF after this one.
1101 * Note that may be more than one "last event", if they occur at the same time.
1104 smf_event_is_last(const smf_event_t *event)
1106 if (smf_get_length_pulses(event->track->smf) <= event->time_pulses)
1113 * \return Version of libsmf.
1116 smf_get_version(void)
1118 return (SMF_VERSION);