initial pass at session-renaming functionality
[ardour.git] / libs / ardour / smf_source.cc
index 3bd929d2ca134438bb0f8bb8bf1668734c9c02a9..9078a17608aaad0c2a7eebb002a2dd66cdf37e0a 100644 (file)
@@ -1,6 +1,6 @@
 /*
-    Copyright (C) 2006 Paul Davis 
-       Written by Dave Robillard, 2006
+    Copyright (C) 2006 Paul Davis
+    Author: David Robillard
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <unistd.h>
 #include <errno.h>
 
-#include <pbd/mountpoint.h>
-#include <pbd/pathscanner.h>
-#include <pbd/stl_delete.h>
-#include <pbd/strsplit.h>
+#include "pbd/mountpoint.h"
+#include "pbd/pathscanner.h"
+#include "pbd/stl_delete.h"
+#include "pbd/strsplit.h"
 
 #include <glibmm/miscutils.h>
 
-#include <ardour/smf_source.h>
-#include <ardour/session.h>
-#include <ardour/midi_ring_buffer.h>
-#include <ardour/midi_util.h>
-#include <ardour/tempo.h>
-#include <ardour/audioengine.h>
-#include <ardour/smf_reader.h>
-#include <ardour/event_type_map.h>
+#include "evoral/Control.hpp"
+
+#include "ardour/audioengine.h"
+#include "ardour/event_type_map.h"
+#include "ardour/midi_model.h"
+#include "ardour/midi_ring_buffer.h"
+#include "ardour/midi_state_tracker.h"
+#include "ardour/session.h"
+#include "ardour/smf_source.h"
+#include "ardour/debug.h"
 
 #include "i18n.h"
 
 using namespace ARDOUR;
-
-string SMFSource::_search_path;
-
-/*sigc::signal<void,struct tm*, time_t> SMFSource::HeaderPositionOffsetChanged;
-bool                                  SMFSource::header_position_negative;
-uint64_t                              SMFSource::header_position_offset;
-*/
-
-SMFSource::SMFSource (Session& s, std::string path, Flag flags)
-       : MidiSource (s, region_name_from_path(path, false))
-       , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
-       , _allow_remove_if_empty(true)
-       , _fd (0)
-       , _last_ev_time(0)
-       , _track_size(4) // 4 bytes for the ever-present EOT event
-       , _header_size(22)
-       , _empty(true)
-{
-       /* constructor used for new internal-to-session files. file cannot exist */
-
-       if (init (path, false)) {
-               throw failed_constructor ();
-       }
-       
-       if (open()) {
+using namespace Glib;
+using namespace PBD;
+
+/** Constructor used for new internal-to-session files.  File cannot exist. */
+SMFSource::SMFSource (Session& s, const string& path, Source::Flag flags)
+       : Source(s, DataType::MIDI, path, flags)
+       , MidiSource(s, path, flags)
+       , FileSource(s, DataType::MIDI, path, string(), flags)
+       , Evoral::SMF()
+       , _last_ev_time_beats(0.0)
+       , _last_ev_time_frames(0)
+       , _smf_last_read_end (0)
+       , _smf_last_read_time (0)
+{
+       /* note that origin remains empty */
+
+       if (init(_path, false)) {
                throw failed_constructor ();
        }
 
-       assert(_name.find("/") == string::npos);
+        /* file is not opened until write */
 }
 
-SMFSource::SMFSource (Session& s, const XMLNode& node)
-       : MidiSource (s, node)
-       , _flags (Flag (Writable|CanRename))
-       , _allow_remove_if_empty(true)
-       , _fd (0)
-       , _last_ev_time(0)
-       , _track_size(4) // 4 bytes for the ever-present EOT event
-       , _header_size(22)
-       , _empty(true)
+/** Constructor used for existing internal-to-session files. */
+SMFSource::SMFSource (Session& s, const XMLNode& node, bool must_exist)
+       : Source(s, node)
+       , MidiSource(s, node)
+       , FileSource(s, node, must_exist)
+       , _last_ev_time_beats(0.0)
+       , _last_ev_time_frames(0)
+       , _smf_last_read_end (0)
+       , _smf_last_read_time (0)
 {
-       /* constructor used for existing internal-to-session files. file must exist */
-
-       if (set_state (node)) {
+       if (set_state(node, Stateful::loading_state_version)) {
                throw failed_constructor ();
        }
-       
-       if (init (_name, true)) {
+
+       if (init(_path, true)) {
                throw failed_constructor ();
        }
-       
-       if (open()) {
+
+       if (open(_path)) {
                throw failed_constructor ();
        }
-       
-       assert(_name.find("/") == string::npos);
+
+        _open = true;
 }
 
 SMFSource::~SMFSource ()
@@ -109,870 +101,513 @@ SMFSource::~SMFSource ()
        }
 }
 
-bool
-SMFSource::removable () const
-{
-       return (_flags & Removable) && ((_flags & RemoveAtDestroy) || 
-                                     ((_flags & RemovableIfEmpty) && is_empty()));
-}
-
 int
-SMFSource::init (string pathstr, bool must_exist)
+SMFSource::open_for_write ()
 {
-       bool is_new = false;
-
-       if (!find (pathstr, must_exist, is_new)) {
-               cerr << "cannot find " << pathstr << " with me = " << must_exist << endl;
-               return -1;
-       }
-
-       if (is_new && must_exist) {
-               return -1;
-       }
-
-       assert(_name.find("/") == string::npos);
-       return 0;
+       if (create (_path)) {
+                return -1;
+        }
+        _open = true;
+        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()
-{
-       //cerr << "Opening SMF file " << path() << " writeable: " << writable() << endl;
-
-       assert(writable()); // FIXME;
-
-       _fd = fopen(path().c_str(), "r+");
-
-       // File already exists
-       if (_fd) {
-               fseek(_fd, _header_size - 4, 0);
-               uint32_t track_size_be = 0;
-               fread(&track_size_be, 4, 1, _fd);
-               _track_size = GUINT32_FROM_BE(track_size_be);
-               _empty = _track_size > 4;
-               //cerr << "SMF - read track size " << _track_size << endl;
-
-       // 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;
-               _empty = true;
-
-               // Write a tentative header just to pad things out so writing happens in the right spot
-               flush_header();
-               flush_footer();
-       }
-               
-       return (_fd == 0) ? -1 : 0;
-}
-
-void
-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()
-{
-       // FIXME: write timeline position somehow?
-       
-       //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 quarter note (beat)
-
-       char data[6];
-       memcpy(data, &type, 2);
-       memcpy(data+2, &ntracks, 2);
-       memcpy(data+4, &division, 2);
-
-       _fd = freopen(path().c_str(), "r+", _fd);
-       assert(_fd);
-       fseek(_fd, 0, SEEK_SET);
-       write_chunk("MThd", 6, data);
-       write_chunk_header("MTrk", _track_size); 
-
-       fflush(_fd);
-
-       return 0;
-}
-
-int
-SMFSource::flush_footer()
-{
-       //cerr << path() << " SMF Flushing footer\n";
-       seek_to_footer_position();
-       write_footer();
-       seek_to_footer_position();
-
-       return 0;
-}
-
-void
-SMFSource::write_footer()
-{
-       write_var_len(0);
-       char eot[3] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
-       fwrite(eot, 1, 3, _fd);
-       fflush(_fd);
-}
-
-/** Returns the offset of the first event in the file with a time past @a start,
- * relative to the start of the source.
- *
- * Returns -1 if not found.
- */
-/*
-long
-SMFSource::find_first_event_after(nframes_t start)
+/** All stamps in audio frames */
+framecnt_t
+SMFSource::read_unlocked (Evoral::EventSink<framepos_t>& destination, framepos_t const source_start,
+                         framepos_t start, framecnt_t duration,
+                         MidiStateTracker* tracker) const
 {
-       // FIXME: obviously this is slooow
-       
-       fseek(_fd, _header_size, 0);
-
-       while ( ! feof(_fd) ) {
-               const uint32_t delta_time = read_var_len();
+       int      ret  = 0;
+       uint64_t time = 0; // in SMF ticks, 1 tick per _ppqn
 
-               if (delta_time > start)
-                       return delta_time;
-       }
+        if (writable() && !_open) {
+                /* nothing to read since nothing has ben written */
+                return duration;
+        }
 
-       return -1;
-}
-*/
+       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start %1 duration %2\n", start, duration));
 
-/** Read an event from the current position in file.
- *
- * File position MUST be at the beginning of a delta time, or this will die very messily.
- * ev.buffer must be of size ev.size, and large enough for the event.  The returned event
- * will have it's time field set to it's delta time, in SMF tempo-based ticks, using the
- * rate given by ppqn() (it is the caller's responsibility to calculate a real time).
- *
- * \a size should be the capacity of \a buf.  If it is not large enough, \a buf will
- * be freed and a new buffer allocated in its place, the size of which will be placed
- * in size.
- *
- * Returns event length (including status byte) on success, 0 if event was
- * skipped (eg a meta event), or -1 on EOF (or end of track).
- */
-int
-SMFSource::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const
-{
-       if (feof(_fd)) {
-               return -1;
-       }
+       _read_data_count = 0;
 
-       assert(delta_t);
-       assert(size);
-       assert(buf);
+       // Output parameters for read_event (which will allocate scratch in buffer as needed)
+       uint32_t ev_delta_t = 0;
+       uint32_t ev_type    = 0;
+       uint32_t ev_size    = 0;
+       uint8_t* ev_buffer  = 0;
 
-       try {
-               *delta_t = SMFReader::read_var_len(_fd);
-       } catch (...) {
-               return -1; // Premature EOF
-       }
-       
-       if (feof(_fd)) {
-               return -1; // Premature EOF
-       }
+       size_t scratch_size = 0; // keep track of scratch to minimize reallocs
 
-       const int status = fgetc(_fd);
+       BeatsFramesConverter converter(_session.tempo_map(), source_start);
 
-       if (status == EOF) {
-               return -1; // Premature EOF
-       }
+       const uint64_t start_ticks = (uint64_t)(converter.from(start) * ppqn());
+       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: start in ticks %1\n", start_ticks));
 
-       //printf("Status @ %X = %X\n", (unsigned)ftell(_fd) - 1, status);
+       if (_smf_last_read_end == 0 || start != _smf_last_read_end) {
+               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: seek to %1\n", start));
+               Evoral::SMF::seek_to_start();
+               while (time < start_ticks) {
+                       gint ignored;
 
-       if (status == 0xFF) {
-               if (feof(_fd)) {
-                       return -1; // Premature EOF
-               }
-               const int type = fgetc(_fd);
-               if ((unsigned char)type == 0x2F) {
-                       return -1; // hit end of track
-               } else {
-                       *size = 0;
-                       return 0;
+                       ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
+                       if (ret == -1) { // EOF
+                               _smf_last_read_end = start + duration;
+                               return duration;
+                       }
+                       time += ev_delta_t; // accumulate delta time
                }
+       } else {
+               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked: set time to %1\n", _smf_last_read_time));
+               time = _smf_last_read_time;
        }
-       
-       const int event_size = midi_event_size((unsigned char)status) + 1;
-       if (event_size <= 0) {
-               *size = 0;
-               return 0;
-       }
-       
-       // Make sure we have enough scratch buffer
-       if (*size < (unsigned)event_size)
-               *buf = (uint8_t*)realloc(*buf, event_size);
-       
-       *size = event_size;
-
-       (*buf)[0] = (unsigned char)status;
-       if (event_size > 1)
-               fread((*buf) + 1, 1, *size - 1, _fd);
-
-       /*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]);
-       }
-       printf("\n");*/
-       
-       return (int)*size;
-}
-
-/** All stamps in audio frames */
-nframes_t
-SMFSource::read_unlocked (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset, nframes_t negative_stamp_offset) const
-{
-       //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
-
-       _read_data_count = 0;
 
-       // Output parameters for read_event (which will allocate scratch in buffer as needed)
-       uint32_t ev_delta_t = 0;
-       uint32_t ev_type = 0;
-       uint32_t ev_size = 0;
-       uint8_t* ev_buffer = 0;
+       _smf_last_read_end = start + duration;
 
-       size_t scratch_size = 0; // keep track of scratch to minimize reallocs
+       while (true) {
+               gint ignored; /* XXX don't ignore note id's ??*/
 
-       // FIXME: don't seek to start and search every read (brutal!)
-       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.tempo_map().meter_at(_timeline_position));
-       
-       const uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
-
-       while (!feof(_fd)) {
-               int ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
+               ret = read_event(&ev_delta_t, &ev_size, &ev_buffer, &ignored);
                if (ret == -1) { // EOF
-                       //cerr << "SMF - EOF\n";
                        break;
                }
-               
-               ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]);
-               
+
                time += ev_delta_t; // accumulate delta time
+               _smf_last_read_time = time;
 
                if (ret == 0) { // meta-event (skipped, just accumulate time)
-                       //cerr << "SMF - META\n";
                        continue;
                }
 
-               if (time >= start_ticks) {
-                       const nframes_t ev_frame_time = (nframes_t)(
-                                       ((time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
+               ev_type = EventTypeMap::instance().midi_event_type(ev_buffer[0]);
+
+               DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF read_unlocked delta %1, time %2, buf[0] %3, type %4\n",
+                                                                 ev_delta_t, time, ev_buffer[0], ev_type));
+
+               assert(time >= start_ticks);
+
+               /* Note that we add on the source start time (in session frames) here so that ev_frame_time
+                  is in session frames.
+               */
+               const framepos_t ev_frame_time = converter.to(time / (double)ppqn()) + source_start;
+
+               if (ev_frame_time < start + duration) {
+                       destination.write (ev_frame_time, ev_type, ev_size, ev_buffer);
 
-                       if (ev_frame_time <= start + cnt)
-                               dst.write(ev_frame_time - negative_stamp_offset, ev_type, ev_size, ev_buffer);
-                       else
-                               break;
+                       if (tracker) {
+                               if (ev_buffer[0] & MIDI_CMD_NOTE_ON) {
+                                       tracker->add (ev_buffer[1], ev_buffer[0] & 0xf);
+                               } else if (ev_buffer[0] & MIDI_CMD_NOTE_OFF) {
+                                       tracker->remove (ev_buffer[1], ev_buffer[0] & 0xf);
+                               }
+                       }
+               } else {
+                       break;
                }
 
                _read_data_count += ev_size;
 
-               if (ev_size > scratch_size)
+               if (ev_size > scratch_size) {
                        scratch_size = ev_size;
-               else
-                       ev_size = scratch_size; // minimize realloc in read_event
+               }
+               ev_size = scratch_size; // ensure read_event only allocates if necessary
        }
-       
-       return cnt;
+
+       return duration;
 }
 
-/** All stamps in audio frames */
-nframes_t
-SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
+/** Write data to this source from a MidiRingBuffer.
+ *  @param source Buffer to read from.
+ *  @param position This source's start position in session frames.
+ */
+framecnt_t
+SMFSource::write_unlocked (MidiRingBuffer<framepos_t>& source, framepos_t position, framecnt_t duration)
 {
+        if (!_writing) {
+                mark_streaming_write_started ();
+        }
+
        _write_data_count = 0;
-               
-       EventTime time;
-       EventType type;
-       uint32_t  size;
-
-       size_t buf_capacity = 4;
-       uint8_t* buf = (uint8_t*)malloc(buf_capacity);
-       
-       if (_model && ! _model->writing())
+
+       framepos_t        time;
+       Evoral::EventType type;
+       uint32_t          size;
+
+       size_t   buf_capacity = 4;
+       uint8_t* buf          = (uint8_t*)malloc(buf_capacity);
+
+       if (_model && ! _model->writing()) {
                _model->start_write();
+       }
+
+       Evoral::MIDIEvent<framepos_t> ev;
 
-       Evoral::MIDIEvent ev(0, 0.0, 4, NULL, true);
+       cerr << "SMFSource::write unlocked, begins writing from src buffer\n";
 
        while (true) {
-               bool ret = src.peek_time(&time);
-               if (!ret || time - _timeline_position > _length + cnt)
+               bool ret = source.peek ((uint8_t*)&time, sizeof (time));
+               if (!ret || time > _last_write_end + duration) {
+                       DEBUG_TRACE (DEBUG::MidiIO, string_compose ("SMFSource::write_unlocked: dropping event @ %1 because ret %4 or it is later than %2 + %3\n",
+                                                                   time, _last_write_end, duration, ret));
                        break;
+               }
 
-               ret = src.read_prefix(&time, &type, &size);
-               if (!ret)
+               ret = source.read_prefix(&time, &type, &size);
+               if (!ret) {
+                       cerr << "ERROR: Unable to read event prefix, corrupt MIDI ring buffer" << endl;
                        break;
+               }
 
                if (size > buf_capacity) {
                        buf_capacity = size;
                        buf = (uint8_t*)realloc(buf, size);
                }
 
-               ret = src.read_contents(size, buf);
+               ret = source.read_contents(size, buf);
                if (!ret) {
                        cerr << "ERROR: Read time/size but not buffer, corrupt MIDI ring buffer" << endl;
                        break;
                }
-               
-               assert(time >= _timeline_position);
-               time -= _timeline_position;
-               
+
+               /* convert from session time to time relative to the source start */
+               assert(time >= position);
+               time -= position;
+
                ev.set(buf, size, time);
                ev.set_event_type(EventTypeMap::instance().midi_event_type(ev.buffer()[0]));
-               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;
+               ev.set_id (Evoral::next_event_id());
+
+               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);
+               cerr << "SMFSource:: calling append_event_unlocked_frames()\n";
+               append_event_unlocked_frames(ev, position);
        }
 
-       fflush(_fd);
-       free(buf);
-
-       const nframes_t oldlen = _length;
-       update_length(oldlen, cnt);
+       Evoral::SMF::flush();
+       free (buf);
 
-       ViewDataRangeReady (_timeline_position + oldlen, cnt); /* EMIT SIGNAL */
-       
-       return cnt;
+       return duration;
 }
-               
 
+
+/** Append an event with a timestamp in beats (double) */
 void
-SMFSource::append_event_unlocked(EventTimeUnit unit, const Evoral::Event& ev)
+SMFSource::append_event_unlocked_beats (const Evoral::Event<double>& ev)
 {
-       if (ev.size() == 0)
+       assert(_writing);
+       if (ev.size() == 0)  {
                return;
-
-       /*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("SMFSource: %s - append_event_unlocked_beats ID = %d time = %lf, size = %u, data = ",
+               name().c_str(), ev.id(), ev.time(), ev.size());
+              for (size_t i = 0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
+
        assert(ev.time() >= 0);
-       
-       if (ev.time() < _last_ev_time) {
-               cerr << "SMFSource: Warning: Skipping event with ev.time() < _last_ev_time" << endl;
+       if (ev.time() < _last_ev_time_beats) {
+               cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
                return;
        }
-       
-       uint32_t delta_time = 0;
-       
-       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);
+
+       Evoral::event_id_t event_id;
+
+       if (ev.id() < 0) {
+               event_id  = Evoral::next_event_id();
        } else {
-               assert(unit == Beats);
-               delta_time = (uint32_t)((ev.time() - _last_ev_time) * _ppqn);
+               event_id = ev.id();
        }
 
-       
-       const size_t stamp_size = write_var_len(delta_time);
-       fwrite(ev.buffer(), 1, ev.size(), _fd);
+       if (_model) {
+               _model->append (ev, event_id);
+       }
 
-       _track_size += stamp_size + ev.size();
-       _write_data_count += ev.size();
-       _last_ev_time = ev.time();
+       _length_beats = max(_length_beats, ev.time());
 
-       if (ev.size() > 0)
-               _empty = false;
-}
+       const double delta_time_beats   = ev.time() - _last_ev_time_beats;
+       const uint32_t delta_time_ticks = (uint32_t)lrint(delta_time_beats * (double)ppqn());
 
+       Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
+       _last_ev_time_beats = ev.time();
+
+       _write_data_count += ev.size();
 
-XMLNode&
-SMFSource::get_state ()
-{
-       XMLNode& root (MidiSource::get_state());
-       char buf[16];
-       snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
-       root.add_property ("flags", buf);
-       return root;
 }
 
-int
-SMFSource::set_state (const XMLNode& node)
+/** Append an event with a timestamp in frames (framepos_t) */
+void
+SMFSource::append_event_unlocked_frames (const Evoral::Event<framepos_t>& ev, framepos_t position)
 {
-       const XMLProperty* prop;
-
-       if (MidiSource::set_state (node)) {
-               return -1;
+       assert(_writing);
+       if (ev.size() == 0)  {
+               cerr << "SMFSource: asked to append zero-size event\n";
+               return;
        }
 
-       if ((prop = node.property (X_("flags"))) != 0) {
-
-               int ival;
-               sscanf (prop->value().c_str(), "0x%x", &ival);
-               _flags = Flag (ival);
+       /* printf("SMFSource: %s - append_event_unlocked_frames ID = %d time = %u, size = %u, data = ",
+               name().c_str(), ev.id(), ev.time(), ev.size());
+          for (size_t i=0; i < ev.size(); ++i) printf("%X ", ev.buffer()[i]); printf("\n");*/
 
-       } else {
+       if (ev.time() < _last_ev_time_frames) {
+               cerr << "SMFSource: Warning: Skipping event with non-monotonic time" << endl;
+               return;
+       }
 
-               _flags = Flag (0);
+       BeatsFramesConverter converter(_session.tempo_map(), position);
+       const double ev_time_beats = converter.from(ev.time());
+       Evoral::event_id_t event_id;
 
+       if (ev.id() < 0) {
+               event_id  = Evoral::next_event_id();
+       } else {
+               event_id = ev.id();
        }
 
-       assert(_name.find("/") == string::npos);
+       if (_model) {
+               const Evoral::Event<double> beat_ev (ev.event_type(),
+                                                    ev_time_beats,
+                                                    ev.size(),
+                                                    (uint8_t*)ev.buffer());
+               _model->append (beat_ev, event_id);
+       }
 
-       return 0;
-}
+       _length_beats = max(_length_beats, ev_time_beats);
 
-void
-SMFSource::mark_for_remove ()
-{
-       if (!writable()) {
-               return;
-       }
-       _flags = Flag (_flags | RemoveAtDestroy);
-}
+       const framepos_t delta_time_frames = ev.time() - _last_ev_time_frames;
+       const double     delta_time_beats  = converter.from(delta_time_frames);
+       const uint32_t   delta_time_ticks  = (uint32_t)(lrint(delta_time_beats * (double)ppqn()));
 
-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);
-}
+       Evoral::SMF::append_event_delta(delta_time_ticks, ev.size(), ev.buffer(), event_id);
+       _last_ev_time_frames = ev.time();
 
-void
-SMFSource::mark_streaming_write_completed ()
-{
-       MidiSource::mark_streaming_write_completed();
+       _write_data_count += ev.size();
 
-       if (!writable()) {
-               return;
-       }
-       
-       _model->set_edited(false);
-       flush_header();
-       flush_footer();
 }
 
-void
-SMFSource::mark_take (string id)
+XMLNode&
+SMFSource::get_state ()
 {
-       if (writable()) {
-               _take_id = id;
-       }
+       XMLNode& node = MidiSource::get_state();
+       node.add_property (X_("origin"), _origin);
+       return node;
 }
 
 int
-SMFSource::move_to_trash (const string trash_dir_name)
+SMFSource::set_state (const XMLNode& node, int version)
 {
-       string newpath;
-
-       if (!writable()) {
+       if (Source::set_state (node, version)) {
                return -1;
        }
 
-       /* don't move the file across filesystems, just
-          stick it in the 'trash_dir_name' directory
-          on whichever filesystem it was already on.
-       */
-
-       newpath = Glib::path_get_dirname (_path);
-       newpath = Glib::path_get_dirname (newpath);
-
-       newpath += '/';
-       newpath += trash_dir_name;
-       newpath += '/';
-       newpath += Glib::path_get_basename (_path);
+       if (MidiSource::set_state (node, version)) {
+               return -1;
+       }
 
-       if (access (newpath.c_str(), F_OK) == 0) {
+       if (FileSource::set_state (node, version)) {
+               return -1;
+       }
 
-               /* the new path already exists, try versioning */
-               
-               char buf[PATH_MAX+1];
-               int version = 1;
-               string newpath_v;
+       return 0;
+}
 
-               snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
-               newpath_v = buf;
+void
+SMFSource::mark_streaming_midi_write_started (NoteMode mode)
+{
+        /* CALLER MUST HOLD LOCK */
 
-               while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
-                       snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
-                       newpath_v = buf;
-               }
-               
-               if (version == 999) {
-                       PBD::error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
-                                         newpath)
-                             << endmsg;
-               } else {
-                       newpath = newpath_v;
-               }
+        if (!_open && open_for_write()) {
+                error << string_compose (_("cannot open MIDI file %1 for write"), _path) << endmsg;
+                /* XXX should probably throw or return something */
+                return;
+        }
 
-       } else {
+       MidiSource::mark_streaming_midi_write_started (mode);
+       Evoral::SMF::begin_write ();
+       _last_ev_time_beats = 0.0;
+       _last_ev_time_frames = 0;
+}
 
-               /* it doesn't exist, or we can't read it or something */
+void
+SMFSource::mark_streaming_write_completed ()
+{
+       Glib::Mutex::Lock lm (_lock);
+       MidiSource::mark_streaming_write_completed();
 
+       if (!writable()) {
+               return;
        }
 
-       if (::rename (_path.c_str(), newpath.c_str()) != 0) {
-               PBD::error << string_compose (_("cannot rename midi file source from %1 to %2 (%3)"),
-                                 _path, newpath, strerror (errno))
-                     << endmsg;
-               return -1;
-       }
-#if 0
-       if (::unlink (peakpath.c_str()) != 0) {
-               PBD::error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
-                                 peakpath, _path, strerror (errno))
-                     << endmsg;
-               /* try to back out */
-               rename (newpath.c_str(), _path.c_str());
-               return -1;
+       if (_model) {
+               _model->set_edited(false);
        }
-           
-       _path = newpath;
-       peakpath = "";
-#endif 
-       /* file can not be removed twice, since the operation is not idempotent */
 
-       _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
+       Evoral::SMF::end_write ();
 
-       return 0;
+       /* data in the file now, not removable */
+
+       mark_nonremovable ();
 }
 
 bool
-SMFSource::safe_file_extension(const Glib::ustring& file)
+SMFSource::safe_midi_file_extension (const string& file)
 {
-       return (file.rfind(".mid") != Glib::ustring::npos);
+       return (file.rfind(".mid") != string::npos) || (file.rfind (".MID") != string::npos);
 }
 
-// FIXME: Merge this with audiofilesource somehow (make a generic filesource?)
-bool
-SMFSource::find (string pathstr, bool must_exist, bool& isnew)
+void
+SMFSource::load_model (bool lock, bool force_reload)
 {
-       string::size_type pos;
-       bool ret = false;
+       if (_writing) {
+               return;
+       }
 
-       isnew = false;
+       boost::shared_ptr<Glib::Mutex::Lock> lm;
+       if (lock)
+               lm = boost::shared_ptr<Glib::Mutex::Lock>(new Glib::Mutex::Lock(_lock));
 
-       /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
+       if (_model && !force_reload) {
+               return;
+       }
 
-       if ((pos = pathstr.find_last_of (':')) == string::npos) {
-               pathstr = pathstr;
+       if (!_model) {
+               _model = boost::shared_ptr<MidiModel> (new MidiModel (shared_from_this ()));
        } else {
-               pathstr = pathstr.substr (0, pos);
+               _model->clear();
        }
 
-       if (pathstr[0] != '/') {
+        if (writable() && !_open) {
+                return;
+        }
 
-               /* non-absolute pathname: find pathstr in search path */
+       _model->start_write();
+       Evoral::SMF::seek_to_start();
 
-               vector<string> dirs;
-               int cnt;
-               string fullpath;
-               string keeppath;
+       uint64_t time = 0; /* in SMF ticks */
+       Evoral::Event<double> ev;
 
-               if (_search_path.length() == 0) {
-                       PBD::error << _("FileSource: search path not set") << endmsg;
-                       goto out;
-               }
+       size_t scratch_size = 0; // keep track of scratch and minimize reallocs
 
-               split (_search_path, dirs, ':');
+       uint32_t delta_t = 0;
+       uint32_t size    = 0;
+       uint8_t* buf     = NULL;
+       int ret;
+       gint event_id;
+       bool have_event_id = false;
 
-               cnt = 0;
-               
-               for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
+       while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
+
+               time += delta_t;
 
-                       fullpath = *i;
-                       if (fullpath[fullpath.length()-1] != '/') {
-                               fullpath += '/';
+               if (ret == 0) {
+
+                       /* meta-event : did we get an event ID ?
+                        */
+
+                       if (event_id >= 0) {
+                               have_event_id = true;
                        }
-                       fullpath += pathstr;
-                       
-                       if (access (fullpath.c_str(), R_OK) == 0) {
-                               keeppath = fullpath;
-                               ++cnt;
-                       } 
+
+                       continue;
                }
 
-               if (cnt > 1) {
+               if (ret > 0) {
 
-                       PBD::error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, _search_path) << endmsg;
-                       goto out;
+                       /* not a meta-event */
 
-               } else if (cnt == 0) {
+                       ev.set (buf, size, time / (double)ppqn());
+                       ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
 
-                       if (must_exist) {
-                               PBD::error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, _search_path) << endmsg;
-                               goto out;
-                       } else {
-                               isnew = true;
+                       if (!have_event_id) {
+                               event_id = Evoral::next_event_id();
                        }
-               }
-               
-               _name = pathstr;
-               _path = keeppath;
-               ret = true;
+#ifndef NDEBUG
+                       std::string ss;
 
-       } else {
-               
-               /* external files and/or very very old style sessions include full paths */
-               
-               _path = pathstr;
-               _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
-               
-               if (access (_path.c_str(), R_OK) != 0) {
-
-                       /* file does not exist or we cannot read it */
-
-                       if (must_exist) {
-                               PBD::error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
-                               goto out;
-                       }
-                       
-                       if (errno != ENOENT) {
-                               PBD::error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
-                               goto out;
+                       for (uint32_t xx = 0; xx < size; ++xx) {
+                               char b[8];
+                               snprintf (b, sizeof (b), "0x%x ", buf[xx]);
+                               ss += b;
                        }
-                       
-                       /* a new file */
 
-                       isnew = true;
-                       ret = true;
+                       DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("SMF %6 load model delta %1, time %2, size %3 buf %4, type %5\n",
+                                                                         delta_t, time, size, ss , ev.event_type(), name()));
+#endif
 
-               } else {
-                       
-                       /* already exists */
-
-                       ret = true;
-               }
-       }
-       
-  out:
-       return ret;
-}
-
-void
-SMFSource::set_search_path (string p)
-{
-       _search_path = p;
-}
+                       _model->append (ev, event_id);
 
+                       if (ev.size() > scratch_size) {
+                               scratch_size = ev.size();
+                       }
 
-void
-SMFSource::set_allow_remove_if_empty (bool yn)
-{
-       if (writable()) {
-               _allow_remove_if_empty = yn;
-       }
-}
+                       ev.size() = scratch_size; // ensure read_event only allocates if necessary
 
-int
-SMFSource::set_source_name (string newname, bool destructive)
-{
-       //Glib::Mutex::Lock lm (_lock); FIXME
-       string oldpath = _path;
-       string newpath = Session::change_midi_path_by_name (oldpath, _name, newname, destructive);
+                       _length_beats = max(_length_beats, ev.time());
+               }
 
-       if (newpath.empty()) {
-               PBD::error << string_compose (_("programming error: %1"), "cannot generate a changed midi path") << endmsg;
-               return -1;
-       }
+               /* event ID's must immediately precede the event they are for
+                */
 
-       if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
-               PBD::error << string_compose (_("cannot rename midi file for %1 to %2"), _name, newpath) << endmsg;
-               return -1;
+               have_event_id = false;
        }
 
-       _name = Glib::path_get_basename (newpath);
-       _path = newpath;
+       _model->end_write (_length_beats, false, true);
+       //_model->end_write (false);
+       _model->set_edited (false);
 
-       return 0;//rename_peakfile (peak_path (_path));
-}
+       _model_iter = _model->begin();
 
-bool
-SMFSource::is_empty () const
-{
-       return _empty;
+       free(buf);
 }
 
-
 void
-SMFSource::write_chunk_header(const char id[4], uint32_t length)
+SMFSource::destroy_model ()
 {
-       const uint32_t length_be = GUINT32_TO_BE(length);
-
-       fwrite(id, 1, 4, _fd);
-       fwrite(&length_be, 4, 1, _fd);
+       //cerr << _name << " destroying model " << _model.get() << endl;
+       _model.reset();
 }
 
 void
-SMFSource::write_chunk(const char id[4], uint32_t length, void* data)
-{
-       write_chunk_header(id, length);
-       
-       fwrite(data, 1, length, _fd);
-}
-
-/** Returns the size (in bytes) of the value written. */
-size_t
-SMFSource::write_var_len(uint32_t value)
+SMFSource::flush_midi ()
 {
-       size_t ret = 0;
-
-       uint32_t buffer = value & 0x7F;
-
-       while ( (value >>= 7) ) {
-               buffer <<= 8;
-               buffer |= ((value & 0x7F) | 0x80);
-       }
-
-       while (true) {
-               //printf("Writing var len byte %X\n", (unsigned char)buffer);
-               ++ret;
-               fputc(buffer, _fd);
-               if (buffer & 0x80)
-                       buffer >>= 8;
-               else
-                       break;
+       if (!writable() || (writable() && !_open)) {
+               return;
        }
 
-       return ret;
+       Evoral::SMF::end_write ();
+       /* data in the file means its no longer removable */
+       mark_nonremovable ();
 }
 
 void
-SMFSource::load_model(bool lock, bool force_reload)
+SMFSource::set_path (const string& p)
 {
-       if (_writing)
-               return;
-
-       if (lock)
-               Glib::Mutex::Lock lm (_lock);
-
-       if (_model && !force_reload && !_model->empty())
-               return;
+       FileSource::set_path (p);
+       SMF::set_path (_path);
+}
 
-       if (! _model) {
-               _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
-               cerr << _name << " loaded new model " << _model.get() << endl;
+/** Ensure that this source has some file on disk, even if it's just a SMF header */
+void
+SMFSource::ensure_disk_file ()
+{
+       if (_model) {
+               /* We have a model, so write it to disk; see MidiSource::session_saved
+                  for an explanation of what we are doing here.
+               */
+               boost::shared_ptr<MidiModel> mm = _model;
+               _model.reset ();
+               mm->sync_to_source ();
+               _model = mm;
        } else {
-               cerr << _name << " reloading model " << _model.get()
-                       << " (" << _model->n_notes() << " notes)" <<endl;
-               _model->clear();
-       }
-
-       _model->start_write();
-
-       fseek(_fd, _header_size, SEEK_SET);
-
-       uint64_t time = 0; /* in SMF ticks */
-       Evoral::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.tempo_map().meter_at(_timeline_position));
-       
-       uint32_t delta_t = 0;
-       uint32_t size    = 0;
-       uint8_t* buf     = NULL;
-       int ret;
-       while ((ret = read_event(&delta_t, &size, &buf)) >= 0) {
-               
-               ev.set(buf, size, 0.0);
-               time += delta_t;
-               
-               if (ret > 0) { // didn't skip (meta) event
-                       // make ev.time absolute time in frames
-                       ev.time() = time * frames_per_beat / (EventTime)_ppqn;
-                       ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
-                       _model->append(ev);
+               /* No model; if it's not already open, it's an empty source, so create
+                  and open it for writing.
+               */
+               if (!_open) {
+                       open_for_write ();
                }
 
-               if (ev.size() > scratch_size)
-                       scratch_size = ev.size();
-               else
-                       ev.size() = scratch_size;
+               /* Flush, which will definitely put something on disk */
+               flush_midi ();
        }
-       
-       _model->end_write(false);
-       _model->set_edited(false);
-
-       free(buf);
-}
-
-
-void
-SMFSource::destroy_model()
-{
-       //cerr << _name << " destroying model " << _model.get() << endl;
-       _model.reset();
 }