Fix various MIDI corruption bugs.
[ardour.git] / libs / ardour / smf_source.cc
index 4ad8f80b4bb2285f539ca3d8a38eb34c09d9b7d0..389224eb3bc20cd176e361290cd0390015bdd102 100644 (file)
@@ -38,6 +38,7 @@
 #include <ardour/midi_util.h>
 #include <ardour/tempo.h>
 #include <ardour/audioengine.h>
+#include <ardour/smf_reader.h>
 
 #include "i18n.h"
 
@@ -52,7 +53,6 @@ uint64_t                              SMFSource::header_position_offset;
 
 SMFSource::SMFSource (Session& s, std::string path, Flag flags)
        : MidiSource (s, region_name_from_path(path, false))
-       , _channel(0)
        , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
        , _allow_remove_if_empty(true)
        , _fd (0)
@@ -70,14 +70,13 @@ SMFSource::SMFSource (Session& s, std::string path, Flag flags)
                throw failed_constructor ();
        }
 
-       //cerr << "SMF Source path: " << path << endl;
+       cerr << "SMF Source path: " << path << endl;
        
        assert(_name.find("/") == string::npos);
 }
 
 SMFSource::SMFSource (Session& s, const XMLNode& node)
        : MidiSource (s, node)
-       , _channel(0)
        , _flags (Flag (Writable|CanRename))
        , _allow_remove_if_empty(true)
        , _fd (0)
@@ -99,8 +98,6 @@ SMFSource::SMFSource (Session& s, const XMLNode& node)
                throw failed_constructor ();
        }
        
-       //cerr << "SMF Source name: " << _name << endl;
-       
        assert(_name.find("/") == string::npos);
 }
 
@@ -136,6 +133,14 @@ SMFSource::init (string pathstr, bool must_exist)
        return 0;
 }
 
+/** Attempt to open the SMF file for reading and writing.
+ *
+ * Currently SMFSource is always read/write.
+ *
+ * \return  0 on success
+ *         -1 if the file can not be opened for reading,
+ *         -2 if the file can not be opened for writing
+ */
 int
 SMFSource::open()
 {
@@ -156,36 +161,73 @@ SMFSource::open()
        // We're making a new file
        } else {
                _fd = fopen(path().c_str(), "w+");
+               if (_fd == NULL) {
+                       cerr << "ERROR: Can not open SMF file " << path() << " for writing: " <<
+                               strerror(errno) << endl;
+                       return -2;
+               }
                _track_size = 4;
 
                // Write a tentative header just to pad things out so writing happens in the right spot
-               set_timeline_position(0);
                flush_header();
-               write_footer();
-               seek_to_end();
+               flush_footer();
        }
-
+               
        return (_fd == 0) ? -1 : 0;
 }
 
 void
-SMFSource::seek_to_end()
+SMFSource::close()
 {
+       if (_fd) {
+               flush_header();
+               flush_footer();
+               fclose(_fd);
+               _fd = NULL;
+       }
+}
+
+void
+SMFSource::seek_to_footer_position()
+{
+       uint8_t buffer[4];
+       
+       // lets check if there is a track end marker at the end of the data
        fseek(_fd, -4, SEEK_END);
+       //cerr << "SMFSource::seek_to_footer_position: At position: " << ftell(_fd);
+       size_t read_bytes = fread(buffer, sizeof(uint8_t), 4, _fd);
+       /*cerr << " read size: " << read_bytes << " buffer: ";
+       for (size_t i=0; i < read_bytes; ++i) {
+               printf("%x ", buffer[i]);
+       }
+       printf("\n");
+       */
+       
+       if( (read_bytes == 4) && 
+           buffer[0] == 0x00 && 
+           buffer[1] == 0xFF && 
+           buffer[2] == 0x2F && 
+           buffer[3] == 0x00) {
+               // there is one, so overwrite it
+               fseek(_fd, -4, SEEK_END);
+       } else {
+               // there is none, so append
+               fseek(_fd, 0, SEEK_END);
+       }
 }
 
 int
-SMFSource::flush_header ()
+SMFSource::flush_header()
 {
        // FIXME: write timeline position somehow?
        
-       //cerr << "SMF Flushing header\n";
+       //cerr << path() << " SMF Flushing header\n";
 
        assert(_fd);
 
        const uint16_t type     = GUINT16_TO_BE(0);     // SMF Type 0 (single track)
        const uint16_t ntracks  = GUINT16_TO_BE(1);     // Number of tracks (always 1 for Type 0)
-       const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per beat
+       const uint16_t division = GUINT16_TO_BE(_ppqn); // Pulses per quarter note (beat)
 
        char data[6];
        memcpy(data, &type, 2);
@@ -194,11 +236,9 @@ SMFSource::flush_header ()
 
        _fd = freopen(path().c_str(), "r+", _fd);
        assert(_fd);
-       fseek(_fd, 0, 0);
+       fseek(_fd, 0, SEEK_SET);
        write_chunk("MThd", 6, data);
-       //if (_track_size > 0) {
-               write_chunk_header("MTrk", _track_size); 
-       //}
+       write_chunk_header("MTrk", _track_size); 
 
        fflush(_fd);
 
@@ -208,9 +248,10 @@ SMFSource::flush_header ()
 int
 SMFSource::flush_footer()
 {
-       seek_to_end();
+       //cerr << path() << " SMF Flushing footer\n";
+       seek_to_footer_position();
        write_footer();
-       seek_to_end();
+       seek_to_footer_position();
 
        return 0;
 }
@@ -218,8 +259,6 @@ SMFSource::flush_footer()
 void
 SMFSource::write_footer()
 {
-       //cerr << "SMF " << name() << " writing EOT at byte " << ftell(_fd) << endl;
-       
        write_var_len(0);
        char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
        fwrite(eot, 1, 3, _fd);
@@ -275,20 +314,31 @@ SMFSource::read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const
        assert(size);
        assert(buf);
 
-       *delta_t = read_var_len();
-       assert(!feof(_fd));
+       try {
+               *delta_t = SMFReader::read_var_len(_fd);
+       } catch (...) {
+               return -1; // Premature EOF
+       }
+       
+       if (feof(_fd)) {
+               return -1; // Premature EOF
+       }
 
        const int status = fgetc(_fd);
-       assert(status != EOF); // FIXME die gracefully
+
+       if (status == EOF) {
+               return -1; // Premature EOF
+       }
 
        //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
 
        if (status == 0xFF) {
-               assert(!feof(_fd));
+               if (feof(_fd)) {
+                       return -1; // Premature EOF
+               }
                const int type = fgetc(_fd);
                if ((unsigned char)type == 0x2F) {
-                       //cerr << _name << " hit EOT" << endl;
-                       return -1;
+                       return -1; // hit end of track
                } else {
                        *size = 0;
                        return 0;
@@ -307,14 +357,11 @@ SMFSource::read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const
        
        *size = event_size;
 
-       /*if (ev.buffer == NULL)
-               ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);*/
-
        (*buf)[0] = (unsigned char)status;
        if (event_size > 1)
                fread((*buf) + 1, 1, *size - 1, _fd);
 
-       /*printf("%s read event: delta = %u, size = %u, data = ", _name.c_str(), *delta_t, *size);
+       /*printf("SMFSource %s read event: delta = %u, size = %u, data = ", _name.c_str(), *delta_t, *size);
        for (size_t i=0; i < *size; ++i) {
                printf("%X ", (*buf)[i]);
        }
@@ -325,9 +372,9 @@ SMFSource::read_event(uint32_t* delta_t, uint32_t* size, Byte** buf) const
 
 /** All stamps in audio frames */
 nframes_t
-SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
+SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset, nframes_t negative_stamp_offset) const
 {
-       //cerr << "SMF - read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
+       //cerr << "SMF read_unlocked " << name() << " read " << start << ", count=" << cnt << ", offset=" << stamp_offset << endl;
 
        // 64 bits ought to be enough for anybody
        uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
@@ -342,11 +389,12 @@ SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, n
        size_t scratch_size = 0; // keep track of scratch to minimize reallocs
 
        // FIXME: don't seek to start and search every read (brutal!)
-       fseek(_fd, _header_size, 0);
+       fseek(_fd, _header_size, SEEK_SET);
        
        // FIXME: assumes tempo never changes after start
        const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
-                       _session.engine().frame_rate());
+                       _session.engine().frame_rate(),
+                       _session.tempo_map().meter_at(_timeline_position));
        
        const uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
 
@@ -370,7 +418,7 @@ SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, n
                                        ((time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
 
                        if (ev_frame_time <= start + cnt)
-                               dst.write(ev_frame_time, ev_size, ev_buffer);
+                               dst.write(ev_frame_time - negative_stamp_offset, ev_size, ev_buffer);
                        else
                                break;
                }
@@ -403,7 +451,7 @@ SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
 
        while (true) {
                bool ret = src.full_peek(sizeof(double), (Byte*)&time);
-               if (!ret || time > _length + cnt)
+               if (!ret || time - _timeline_position > _length + cnt)
                        break;
 
                ret = src.read_prefix(&time, &size);
@@ -423,10 +471,14 @@ SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
                
                assert(time >= _timeline_position);
                time -= _timeline_position;
-               assert(time >= _last_ev_time);
-
-               const MidiEvent ev(time, size, buf);
-               append_event_unlocked(MidiEvent(ev));
+               
+               const MIDI::Event ev(time, size, buf);
+               if (! (ev.is_channel_event() || ev.is_smf_meta_event() || ev.is_sysex()) ) {
+                       //cerr << "SMFSource: WARNING: caller tried to write non SMF-Event of type " << std::hex << int(ev.buffer()[0]) << endl;
+                       continue;
+               }
+               
+               append_event_unlocked(Frames, ev);
 
                if (_model)
                        _model->append(ev);
@@ -438,29 +490,40 @@ SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
        const nframes_t oldlen = _length;
        update_length(oldlen, cnt);
 
-       ViewDataRangeReady (oldlen, cnt); /* EMIT SIGNAL */
+       ViewDataRangeReady (_timeline_position + oldlen, cnt); /* EMIT SIGNAL */
        
        return cnt;
 }
                
 
 void
-SMFSource::append_event_unlocked(const MidiEvent& ev)
+SMFSource::append_event_unlocked(EventTimeUnit unit, const MIDI::Event& ev)
 {
-       /*printf("SMF - writing event, time = %lf, size = %u, data = ", ev.time(), ev.size());
+       printf("SMFSource: %s - append_event_unlocked chan = %u, time = %lf, size = %u, data = ",
+                       name().c_str(), (unsigned)ev.channel(), ev.time(), ev.size()); 
        for (size_t i=0; i < ev.size(); ++i) {
                printf("%X ", ev.buffer()[i]);
        }
-       printf("\n");*/
-
+       printf("\n");
+       
+       assert(ev.time() >= 0);
        assert(ev.time() >= _last_ev_time);
        
-       // FIXME: assumes tempo never changes after start
-       const double frames_per_beat = _session.tempo_map().tempo_at
-                       (_timeline_position).frames_per_beat(_session.engine().frame_rate());
+       uint32_t delta_time = 0;
        
-       const uint32_t delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
+       if (unit == Frames) {
+               // FIXME: assumes tempo never changes after start
+               const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
+                               _session.engine().frame_rate(),
+                               _session.tempo_map().meter_at(_timeline_position));
 
+               delta_time = (uint32_t)((ev.time() - _last_ev_time) / frames_per_beat * _ppqn);
+       } else {
+               assert(unit == Beats);
+               delta_time = (uint32_t)((ev.time() - _last_ev_time) * _ppqn);
+       }
+
+       
        const size_t stamp_size = write_var_len(delta_time);
        fwrite(ev.buffer(), 1, ev.size(), _fd);
 
@@ -516,6 +579,14 @@ SMFSource::mark_for_remove ()
        _flags = Flag (_flags | RemoveAtDestroy);
 }
 
+void
+SMFSource::mark_streaming_midi_write_started (NoteMode mode, nframes_t start_frame)
+{
+       MidiSource::mark_streaming_midi_write_started (mode, start_frame);
+       _last_ev_time = 0;
+       fseek(_fd, _header_size, SEEK_SET);
+}
+
 void
 SMFSource::mark_streaming_write_completed ()
 {
@@ -525,20 +596,9 @@ SMFSource::mark_streaming_write_completed ()
                return;
        }
        
+       _model->set_edited(false);
        flush_header();
        flush_footer();
-
-#if 0
-       Glib::Mutex::Lock lm (_lock);
-
-
-       next_peak_clear_should_notify = true;
-
-       if (_peaks_built || pending_peak_builds.empty()) {
-               _peaks_built = true;
-                PeaksReady (); /* EMIT SIGNAL */
-       }
-#endif
 }
 
 void
@@ -627,6 +687,12 @@ SMFSource::move_to_trash (const string trash_dir_name)
        return 0;
 }
 
+bool
+SMFSource::safe_file_extension(const Glib::ustring& file)
+{
+       return (file.rfind(".mid") != Glib::ustring::npos);
+}
+
 // FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
 bool
 SMFSource::find (string pathstr, bool must_exist, bool& isnew)
@@ -825,25 +891,6 @@ SMFSource::write_var_len(uint32_t value)
        return ret;
 }
 
-uint32_t
-SMFSource::read_var_len() const
-{
-       assert(!feof(_fd));
-
-       uint32_t value;
-       unsigned char c;
-
-       if ( (value = getc(_fd)) & 0x80 ) {
-               value &= 0x7F;
-               do {
-                       assert(!feof(_fd));
-                       value = (value << 7) + ((c = getc(_fd)) & 0x7F);
-               } while (c & 0x80);
-       }
-
-       return value;
-}
-
 void
 SMFSource::load_model(bool lock, bool force_reload)
 {
@@ -853,16 +900,11 @@ SMFSource::load_model(bool lock, bool force_reload)
        if (lock)
                Glib::Mutex::Lock lm (_lock);
 
-       if (_model && !force_reload && !_model->empty()) {
-               //cerr << _name << " NOT reloading model " << _model.get() << " (" << _model->n_notes()
-               //      << " notes)" << endl;
+       if (_model && !force_reload && !_model->empty())
                return;
-       } else {
-               cerr << _name << " loading model" << endl;
-       }
 
        if (! _model) {
-               _model = boost::shared_ptr<MidiModel>(new MidiModel(_session));
+               _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
                cerr << _name << " loaded new model " << _model.get() << endl;
        } else {
                cerr << _name << " reloading model " << _model.get()
@@ -872,16 +914,17 @@ SMFSource::load_model(bool lock, bool force_reload)
 
        _model->start_write();
 
-       fseek(_fd, _header_size, 0);
+       fseek(_fd, _header_size, SEEK_SET);
 
        uint64_t time = 0; /* in SMF ticks */
-       MidiEvent ev;
+       MIDI::Event ev;
        
        size_t scratch_size = 0; // keep track of scratch and minimize reallocs
        
        // FIXME: assumes tempo never changes after start
        const double frames_per_beat = _session.tempo_map().tempo_at(_timeline_position).frames_per_beat(
-                       _session.engine().frame_rate());
+                       _session.engine().frame_rate(),
+                       _session.tempo_map().meter_at(_timeline_position));
        
        uint32_t delta_t = 0;
        int ret;
@@ -903,6 +946,7 @@ SMFSource::load_model(bool lock, bool force_reload)
        }
        
        _model->end_write(false);
+       _model->set_edited(false);
 
        free(ev.buffer());
 }