Catch exception thrown by SMF code when it cannot write
[ardour.git] / libs / evoral / src / SMF.cpp
index 2b47cbfe4bf74cbf1735db9e45c459bd9fba85cf..b84507818c306a752089976e42695ff08c873707 100644 (file)
@@ -1,54 +1,53 @@
 /* This file is part of Evoral.
- * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
+ * Copyright (C) 2008 David Robillard <http://drobilla.net>
  * Copyright (C) 2000-2008 Paul Davis
  * Author: Hans Baier
- * 
+ *
  * Evoral is free software; you can redistribute it and/or modify it under the
  * terms of the GNU General Public License as published by the Free Software
  * Foundation; either version 2 of the License, or (at your option) any later
  * version.
- * 
+ *
  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
- * 
+ *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#define __STDC_LIMIT_MACROS 1
 #include <cassert>
+#include <cmath>
 #include <iostream>
 #include <stdint.h>
+#include "libsmf/smf.h"
 #include "evoral/Event.hpp"
 #include "evoral/SMF.hpp"
-#include "libsmf/smf.h"
+#include "evoral/midi_util.h"
+#include "pbd/file_manager.h"
 
 using namespace std;
 
 namespace Evoral {
 
-template<typename Time>
-SMF<Time>::~SMF()
-{      
+SMF::~SMF()
+{
        if (_smf) {
                smf_delete(_smf);
                _smf = 0;
                _smf_track = 0;
-       } 
+       }
 }
 
-template<typename Time>
 uint16_t
-SMF<Time>::num_tracks() const
+SMF::num_tracks() const
 {
        return _smf->number_of_tracks;
 }
 
-template<typename Time>
 uint16_t
-SMF<Time>::ppqn() const
+SMF::ppqn() const
 {
        return _smf->ppqn;
 }
@@ -56,9 +55,8 @@ SMF<Time>::ppqn() const
 /** Seek to the specified track (1-based indexing)
  * \return 0 on success
  */
-template<typename Time>
 int
-SMF<Time>::seek_to_track(int track)
+SMF::seek_to_track(int track)
 {
        _smf_track = smf_get_track_by_number(_smf, track);
        if (_smf_track != NULL) {
@@ -75,26 +73,31 @@ SMF<Time>::seek_to_track(int track)
  *         -1 if the file can not be opened or created
  *         -2 if the file exists but specified track does not exist
  */
-template<typename Time>
 int
-SMF<Time>::open(const std::string& path, int track) THROW_FILE_ERROR
+SMF::open(const std::string& path, int track) THROW_FILE_ERROR
 {
        assert(track >= 1);
-       if (_smf) { 
+       if (_smf) {
                smf_delete(_smf);
        }
-       
-       _path = path;
-       _smf = smf_load(_path.c_str());
-       if (_smf == NULL) {
+
+       _file_path = path;
+
+       PBD::StdioFileDescriptor d (_file_path, "r");
+       FILE* f = d.allocate ();
+       if (f == 0) {
                return -1;
        }
 
-       _smf_track = smf_get_track_by_number(_smf, track);
-       if (!_smf_track)
+       if ((_smf = smf_load (f)) == 0) {
+               return -1;
+       }
+
+       if ((_smf_track = smf_get_track_by_number(_smf, track)) == 0) {
                return -2;
+       }
 
-       cerr << "Track " << track << " # events: " << _smf_track->number_of_events << endl;
+       //cerr << "Track " << track << " # events: " << _smf_track->number_of_events << endl;
        if (_smf_track->number_of_events == 0) {
                _smf_track->next_event_number = 0;
                _empty = true;
@@ -102,7 +105,7 @@ SMF<Time>::open(const std::string& path, int track) THROW_FILE_ERROR
                _smf_track->next_event_number = 1;
                _empty = false;
        }
-       
+
        return 0;
 }
 
@@ -113,26 +116,26 @@ SMF<Time>::open(const std::string& path, int track) THROW_FILE_ERROR
  *         -1 if the file can not be created
  *         -2 if the track can not be created
  */
-template<typename Time>
 int
-SMF<Time>::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
+SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
 {
        assert(track >= 1);
-       if (_smf) { 
+       if (_smf) {
                smf_delete(_smf);
        }
-       
-       _path = path;
+
+       _file_path = path;
 
        _smf = smf_new();
-       if (smf_set_ppqn(_smf, ppqn) != 0) {
-               throw FileError();
-       }
-       
+
        if (_smf == NULL) {
                return -1;
        }
-       
+
+       if (smf_set_ppqn(_smf, ppqn) != 0) {
+               return -1;
+       }
+
        for (int i = 0; i < track; ++i) {
                _smf_track = smf_track_new();
                assert(_smf_track);
@@ -144,28 +147,38 @@ SMF<Time>::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_
                return -2;
 
        _smf_track->next_event_number = 0;
+
+       {
+               /* put a stub file on disk */
+
+               PBD::StdioFileDescriptor d (_file_path, "w+");
+               FILE* f = d.allocate ();
+               if (f == 0) {
+                       return -1;
+               }
+
+               if (smf_save (_smf, f)) {
+                       return -1;
+               }
+       }
+
        _empty = true;
-       
+
        return 0;
 }
 
-template<typename Time>
 void
-SMF<Time>::close() THROW_FILE_ERROR
+SMF::close() THROW_FILE_ERROR
 {
        if (_smf) {
-               if (smf_save(_smf, _path.c_str()) != 0) {
-                       throw FileError();
-               }
                smf_delete(_smf);
                _smf = 0;
                _smf_track = 0;
        }
 }
 
-template<typename Time>
 void
-SMF<Time>::seek_to_start() const
+SMF::seek_to_start() const
 {
        _smf_track->next_event_number = 1;
 }
@@ -181,97 +194,186 @@ SMF<Time>::seek_to_start() const
  * \a size must be the capacity of \a buf.  If it is not large enough, \a buf will
  * be reallocated and *size will be set to the new size of buf.
  *
+ * if the event is a meta-event and is an Evoral Note ID, then \a note_id will be set
+ * to the value of the NoteID; otherwise, meta-events will set \a note_id to -1.
+ *
  * \return event length (including status byte) on success, 0 if event was
- * skipped (e.g. a meta event), or -1 on EOF (or end of track).
+ * a meta event, or -1 on EOF (or end of track).
  */
-template<typename Time>
 int
-SMF<Time>::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const
+SMF::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* note_id) const
 {
        smf_event_t* event;
-       
+
        assert(delta_t);
        assert(size);
        assert(buf);
-       
-    if ((event = smf_track_get_next_event(_smf_track)) != NULL) {
-       if (smf_event_is_metadata(event)) {
-               return 0;
-       }
-       *delta_t = event->delta_time_pulses;
-       
-       int event_size = event->midi_buffer_length;
-       assert(event_size > 0);
-               
-       // Make sure we have enough scratch buffer
-       if (*size < (unsigned)event_size) {
-               *buf = (uint8_t*)realloc(*buf, event_size);
-       }
-       memcpy(*buf, event->midi_buffer, size_t(event_size));
-       *size = event_size;
-       
-               /*printf("SMF::read_event:\n");
-               for (size_t i=0; i < *size; ++i) {
-                       printf("%X ", (*buf)[i]);
-               } printf("\n");*/
-       
-       return event_size;
-    } else {
-       return -1;
-    }
+       assert(note_id);
+
+       if ((event = smf_track_get_next_event(_smf_track)) != NULL) {
+
+               *delta_t = event->delta_time_pulses;
+
+               if (smf_event_is_metadata(event)) {
+                       *note_id = -1; // "no note id in this meta-event */
+
+                       if (event->midi_buffer[1] == 0x7f) { // Sequencer-specific
+
+                               uint32_t evsize;
+                               uint32_t lenlen;
+
+                               if (smf_extract_vlq (&event->midi_buffer[2], event->midi_buffer_length-2, &evsize, &lenlen) == 0) {
+
+                                       if (event->midi_buffer[2+lenlen] == 0x99 &&  // Evoral
+                                           event->midi_buffer[3+lenlen] == 0x1) { // Evoral Note ID
+
+                                               uint32_t id;
+                                               uint32_t idlen;
+
+                                               if (smf_extract_vlq (&event->midi_buffer[4+lenlen], event->midi_buffer_length-(4+lenlen), &id, &idlen) == 0) {
+                                                       *note_id = id;
+                                               }
+                                       }
+                               }
+                       }
+                       return 0; /* this is a meta-event */
+               }
+
+               int event_size = event->midi_buffer_length;
+               assert(event_size > 0);
+
+               // Make sure we have enough scratch buffer
+               if (*size < (unsigned)event_size) {
+                       *buf = (uint8_t*)realloc(*buf, event_size);
+               }
+               memcpy(*buf, event->midi_buffer, size_t(event_size));
+               *size = event_size;
+
+               assert(midi_event_is_valid(*buf, *size));
+
+               /* printf("SMF::read_event @ %u: ", *delta_t);
+                  for (size_t i = 0; i < *size; ++i) {
+                  printf("%X ", (*buf)[i]);
+                  } printf("\n") */
+
+               return event_size;
+       } else {
+               return -1;
+       }
 }
 
-template<typename Time>
 void
-SMF<Time>::append_event_delta(uint32_t delta_t, const Event<Time>& ev)
+SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, event_id_t note_id)
 {
-       assert(ev.size() > 0);
-       
-       /*printf("SMF::append_event_delta:\n");
-       for (size_t i=0; i < ev.size(); ++i) {
-               printf("%X ", ev.buffer()[i]);
-       } printf("\n");*/
+       if (size == 0) {
+               return;
+       }
+
+       /* printf("SMF::append_event_delta @ %u:", delta_t);
+          for (size_t i = 0; i < size; ++i) {
+          printf("%X ", buf[i]);
+          } printf("\n"); */
+
+       if (!midi_event_is_valid(buf, size)) {
+               cerr << "WARNING: SMF ignoring illegal MIDI event" << endl;
+               return;
+       }
 
        smf_event_t* event;
 
-       event = smf_event_new_from_pointer((void *) ev.buffer(), int(ev.size()));
+       /* XXX july 2010: currently only store event ID's for notes, program changes and bank changes
+        */
+
+       uint8_t const c = buf[0] & 0xf0;
+       bool const store_id = (
+               c == MIDI_CMD_NOTE_ON ||
+               c == MIDI_CMD_NOTE_OFF ||
+               c == MIDI_CMD_PGM_CHANGE ||
+               (c == MIDI_CMD_CONTROL && (buf[1] == MIDI_CTL_MSB_BANK || buf[1] == MIDI_CTL_LSB_BANK))
+                              );
+
+       if (store_id && note_id >= 0) {
+               int idlen;
+               int lenlen;
+               uint8_t idbuf[16];
+               uint8_t lenbuf[16];
+
+               event = smf_event_new ();
+               assert(event != NULL);
+
+               /* generate VLQ representation of note ID */
+               idlen = smf_format_vlq (idbuf, sizeof(idbuf), note_id);
+
+               /* generate VLQ representation of meta event length,
+                  which is the idlen + 2 bytes (Evoral type ID plus Note ID type)
+               */
+
+               lenlen = smf_format_vlq (lenbuf, sizeof(lenbuf), idlen+2);
+
+               event->midi_buffer_length = 2 + lenlen + 2 + idlen;
+               /* this should be allocated by malloc(3) because libsmf will
+                  call free(3) on it
+               */
+               event->midi_buffer = (uint8_t*) malloc (sizeof (uint8_t*) * event->midi_buffer_length);
+
+               event->midi_buffer[0] = 0xff; // Meta-event
+               event->midi_buffer[1] = 0x7f; // Sequencer-specific
+               memcpy (&event->midi_buffer[2], lenbuf, lenlen);
+               event->midi_buffer[2+lenlen] = 0x99; // Evoral type ID
+               event->midi_buffer[3+lenlen] = 0x1;  // Evoral type Note ID
+               memcpy (&event->midi_buffer[4+lenlen], idbuf, idlen);
+
+               assert(_smf_track);
+               smf_track_add_event_delta_pulses(_smf_track, event, 0);
+       }
+
+       event = smf_event_new_from_pointer(buf, size);
        assert(event != NULL);
-       
-       memcpy(event->midi_buffer, ev.buffer(), ev.size());
-       
+
        assert(_smf_track);
-       smf_track_add_event_delta_pulses(_smf_track, event, int(delta_t));
-       _last_ev_time = ev.time();
-       
-       if (ev.size() > 0) {
-               _empty = false;
-       }
+       smf_track_add_event_delta_pulses(_smf_track, event, delta_t);
+       _empty = false;
 }
 
-template<typename Time>
 void
-SMF<Time>::begin_write()
+SMF::begin_write()
 {
        assert(_smf_track);
        smf_track_delete(_smf_track);
-       
+
        _smf_track = smf_track_new();
        assert(_smf_track);
-       
+
        smf_add_track(_smf, _smf_track);
        assert(_smf->number_of_tracks == 1);
-       
-       _last_ev_time = 0;
 }
 
-template<typename Time>
 void
-SMF<Time>::end_write() THROW_FILE_ERROR
+SMF::end_write() THROW_FILE_ERROR
 {
-       if (smf_save(_smf, _path.c_str()) != 0)
-               throw FileError();
+       PBD::StdioFileDescriptor d (_file_path, "w+");
+       FILE* f = d.allocate ();
+       if (f == 0) {
+               throw FileError (_file_path);
+       }
+
+       if (smf_save(_smf, f) != 0) {
+               throw FileError (_file_path);
+       }
 }
 
-template class SMF<double>;
+double
+SMF::round_to_file_precision (double val) const
+{
+       double div = ppqn();
+
+       return round (val * div) / div;
+}
+
+void
+SMF::set_path (const std::string& p)
+{
+       _file_path = p;
+}
 
 } // namespace Evoral