* MIDI control lanes: Set Interpolationtype according to Parameter
[ardour.git] / libs / ardour / smf_source.cc
index 394a6f103fc591f3df618849464a1192ce138a84..cc521336e3afd315c2e8ea30ca3c30aec0ebde1c 100644 (file)
 
 #include <glibmm/miscutils.h>
 
+#include <evoral/SMFReader.hpp>
+
 #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/event_type_map.h>
 
 #include "i18n.h"
 
@@ -52,14 +54,9 @@ 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)
+       , SMF ()
        , _flags (Flag(flags | Writable)) // FIXME: this needs to be writable for now
        , _allow_remove_if_empty(true)
-       , _timeline_position (0)
-       , _fd (0)
-       , _last_ev_time(0)
-       , _track_size(4) // 4 bytes for the ever-present EOT event
-       , _header_size(22)
 {
        /* constructor used for new internal-to-session files. file cannot exist */
 
@@ -67,23 +64,17 @@ SMFSource::SMFSource (Session& s, std::string path, Flag flags)
                throw failed_constructor ();
        }
        
-       if (open()) {
+       if (open(path)) {
                throw failed_constructor ();
        }
-       
+
        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)
-       , _timeline_position (0)
-       , _fd (0)
-       , _last_ev_time(0)
-       , _track_size(4) // 4 bytes for the ever-present EOT event
-       , _header_size(22)
 {
        /* constructor used for existing internal-to-session files. file must exist */
 
@@ -95,7 +86,7 @@ SMFSource::SMFSource (Session& s, const XMLNode& node)
                throw failed_constructor ();
        }
        
-       if (open()) {
+       if (open(_path)) {
                throw failed_constructor ();
        }
        
@@ -113,7 +104,7 @@ bool
 SMFSource::removable () const
 {
        return (_flags & Removable) && ((_flags & RemoveAtDestroy) || 
-                                     ((_flags & RemovableIfEmpty) && is_empty (_path)));
+                                     ((_flags & RemovableIfEmpty) && is_empty()));
 }
 
 int
@@ -134,220 +125,67 @@ SMFSource::init (string pathstr, bool must_exist)
        return 0;
 }
 
-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);
-               //cerr << "SMF - read track size " << _track_size << endl;
-
-       // We're making a new file
-       } else {
-               _fd = fopen(path().c_str(), "w+");
-               _track_size = 0;
-
-               // write a tentative header just to pad things out so writing happens in the right spot
-               flush_header();
-               // FIXME: write the footer here too so it's a valid SMF (screw up writing ATM though)
-       }
-
-       return (_fd == 0) ? -1 : 0;
-}
-
-int
-SMFSource::update_header (nframes_t when, struct tm&, time_t)
-{
-       _timeline_position = when;
-       return flush_header();
-}
-
-int
-SMFSource::flush_header ()
-{
-       // FIXME: write timeline position somehow?
-       
-       //cerr << "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
-
-       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, 0);
-       write_chunk("MThd", 6, data);
-       //if (_track_size > 0) {
-               write_chunk_header("MTrk", _track_size); 
-       //}
-
-       fflush(_fd);
-
-       return 0;
-}
-
-int
-SMFSource::flush_footer()
-{
-       //cerr << "SMF - Writing EOT\n";
-
-       fseek(_fd, 0, SEEK_END);
-       write_var_len(1); // whatever...
-       char eot[4] = { 0xFF, 0x2F, 0x00 }; // end-of-track meta-event
-       fwrite(eot, 1, 4, _fd);
-       fflush(_fd);
-       return 0;
-}
-
-/** 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)
-{
-       // FIXME: obviously this is slooow
-       
-       fseek(_fd, _header_size, 0);
-
-       while ( ! feof(_fd) ) {
-               const uint32_t delta_time = read_var_len();
-
-               if (delta_time > start)
-                       return delta_time;
-       }
-
-       return -1;
-}
-*/
-
-/** 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).
- *
- * 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(jack_midi_event_t& ev) const
-{
-       // - 4 is for the EOT event, which we don't actually want to read
-       //if (feof(_fd) || ftell(_fd) >= _header_size + _track_size - 4) {
-       if (feof(_fd)) {
-               return -1;
-       }
-
-       uint32_t delta_time = read_var_len();
-       assert(!feof(_fd));
-       int status = fgetc(_fd);
-       assert(status != EOF); // FIXME die gracefully
-       if (status == 0xFF) {
-               assert(!feof(_fd));
-               int type = fgetc(_fd);
-               if ((unsigned char)type == 0x2F) {
-                       //cerr << "SMF - hit EOT" << endl;
-                       return -1; // we hit the logical EOF anyway...
-               } else {
-                       ev.size = 0;
-                       ev.time = delta_time; // this is needed regardless
-                       return 0;
-               }
-       }
-       
-       ev.time = delta_time;
-       ev.size = midi_event_size((unsigned char)status) + 1;
-
-       if (ev.buffer == NULL)
-               ev.buffer = (Byte*)malloc(sizeof(Byte) * ev.size);
-
-       ev.buffer[0] = (unsigned char)status;
-       fread(ev.buffer+1, 1, ev.size - 1, _fd);
-
-       /*printf("SMF - read event, delta = %u, size = %zu, data = ",
-               delta_time, ev.size);
-       for (size_t i=0; i < ev.size; ++i) {
-               printf("%X ", ev.buffer[i]);
-       }
-       printf("\n");*/
-       
-       return ev.size;
-}
-
 /** 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
 
        _read_data_count = 0;
 
-       // FIXME: ugh
-       unsigned char ev_buf[MidiBuffer::max_event_size()];
-       jack_midi_event_t ev; // time in SMF ticks
-       ev.time = 0;
-       ev.size = MidiBuffer::max_event_size();
-       ev.buffer = ev_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;
 
-       // FIXME: don't seek to start every read
-       fseek(_fd, _header_size, 0);
+       size_t scratch_size = 0; // keep track of scratch to minimize reallocs
+
+       // FIXME: don't seek to start and search every read (brutal!)
+       SMF::seek_to_start();
        
        // 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));
        
-       uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * _ppqn);
+       const uint64_t start_ticks = (uint64_t)((start / frames_per_beat) * ppqn());
 
-       while (!feof(_fd)) {
-               int ret = read_event(ev);
+       while (!SMF::eof()) {
+               int ret = read_event(&ev_delta_t, &ev_size, &ev_buffer);
                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
 
-               if (ret == 0) { // meta-event (skipped)
+               if (ret == 0) { // meta-event (skipped, just accumulate time)
                        //cerr << "SMF - META\n";
-                       time += ev.time; // just accumulate delta time and ignore event
                        continue;
                }
 
-               time += ev.time; // accumulate delta time
-               ev.time = time; // set ev.time to actual time (relative to source start)
+               if (time >= start_ticks) {
+                       const nframes_t ev_frame_time = (nframes_t)(
+                                       ((time / (double)ppqn()) * frames_per_beat)) + stamp_offset;
 
-               if (ev.time >= start_ticks) {
-                       if (ev.time < start_ticks + (cnt / frames_per_beat)) {
+                       if (ev_frame_time <= start + cnt)
+                               dst.write(ev_frame_time - negative_stamp_offset, ev_type, ev_size, ev_buffer);
+                       else
                                break;
-                       } else {
-                               ev.time = (nframes_t)(((ev.time / (double)_ppqn) * frames_per_beat)) + stamp_offset;
-                               // write event time in absolute frames
-                               dst.write(ev.time, ev.size, ev.buffer);
-                       }
                }
 
-               _read_data_count += ev.size;
+               _read_data_count += ev_size;
+
+               if (ev_size > scratch_size)
+                       scratch_size = ev_size;
+               else
+                       ev_size = scratch_size; // minimize realloc in read_event
        }
        
        return cnt;
@@ -358,51 +196,107 @@ nframes_t
 SMFSource::write_unlocked (MidiRingBuffer& src, nframes_t cnt)
 {
        _write_data_count = 0;
+               
+       Evoral::EventTime time;
+       Evoral::EventType type;
+       uint32_t          size;
 
-       boost::shared_ptr<MidiBuffer> buf_ptr(new MidiBuffer(1024)); // FIXME: size?
-       MidiBuffer& buf = *buf_ptr.get();
-       src.read(buf, /*_length*/0, _length + cnt); // FIXME?
+       size_t buf_capacity = 4;
+       uint8_t* buf = (uint8_t*)malloc(buf_capacity);
+       
+       if (_model && ! _model->writing())
+               _model->start_write();
 
-       fseek(_fd, 0, SEEK_END);
+       Evoral::MIDIEvent ev(0, 0.0, 4, NULL, true);
 
-       // 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());
-       
-       for (size_t i=0; i < buf.size(); ++i) {
-               MidiEvent& ev = buf[i];
-               assert(ev.time >= _timeline_position);
-               ev.time -= _timeline_position;
-               assert(ev.time >= _last_ev_time);
-               const uint32_t delta_time = (uint32_t)((ev.time - _last_ev_time) / frames_per_beat * _ppqn);
-               
-               /*printf("SMF - writing event, delta = %u, size = %zu, data = ",
-                       delta_time, ev.size);
-               for (size_t i=0; i < ev.size; ++i) {
-                       printf("%X ", ev.buffer[i]);
+       while (true) {
+               bool ret = src.peek_time(&time);
+               if (!ret || time - _timeline_position > _length + cnt)
+                       break;
+
+               ret = src.read_prefix(&time, &type, &size);
+               if (!ret)
+                       break;
+
+               if (size > buf_capacity) {
+                       buf_capacity = size;
+                       buf = (uint8_t*)realloc(buf, size);
                }
-               printf("\n");
-               */
-               size_t stamp_size = write_var_len(delta_time);
-               fwrite(ev.buffer, 1, ev.size, _fd);
 
-               _track_size += stamp_size + ev.size;
-               _write_data_count += ev.size;
+               ret = src.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;
                
-               _last_ev_time = ev.time;
+               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;
+                       continue;
+               }
+               
+               append_event_unlocked(Frames, ev);
+
+               if (_model) {
+                       _model->append(ev);
+               }
        }
 
-       fflush(_fd);
+       SMF::flush();
+       free(buf);
 
        const nframes_t oldlen = _length;
        update_length(oldlen, cnt);
 
-       _model->append(buf);
-
-       ViewDataRangeReady (buf_ptr, oldlen, cnt); /* EMIT SIGNAL */
+       ViewDataRangeReady (_timeline_position + oldlen, cnt); /* EMIT SIGNAL */
        
        return cnt;
 }
+               
+
+void
+SMFSource::append_event_unlocked(EventTimeUnit unit, const Evoral::Event& ev)
+{
+       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");*/
+       
+       assert(ev.time() >= 0);
+       
+       if (ev.time() < last_event_time()) {
+               cerr << "SMFSource: Warning: Skipping event with ev.time() < last.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_event_time()) / frames_per_beat * ppqn());
+       } else {
+               assert(unit == Beats);
+               delta_time = (uint32_t)((ev.time() - last_event_time()) * ppqn());
+       }
+
+       SMF::append_event_unlocked(delta_time, ev);
+
+       _write_data_count += ev.size();
+}
+
 
 XMLNode&
 SMFSource::get_state ()
@@ -449,26 +343,24 @@ 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);
+       SMF::begin_write (start_frame);
+}
+
 void
 SMFSource::mark_streaming_write_completed ()
 {
+       MidiSource::mark_streaming_write_completed();
+
        if (!writable()) {
                return;
        }
        
-       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
+       _model->set_edited(false);
+       SMF::end_write ();
 }
 
 void
@@ -557,6 +449,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)
@@ -701,130 +599,91 @@ SMFSource::set_source_name (string newname, bool destructive)
        return 0;//rename_peakfile (peak_path (_path));
 }
 
-bool
-SMFSource::is_empty (string path)
-{
-       /* XXX fix me */
-
-       return false;
-}
-
-
 void
-SMFSource::write_chunk_header(char id[4], uint32_t length)
-{
-       const uint32_t length_be = GUINT32_TO_BE(length);
-
-       fwrite(id, 1, 4, _fd);
-       fwrite(&length_be, 4, 1, _fd);
-}
-
-void
-SMFSource::write_chunk(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)
-{
-       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;
-       }
-
-       return ret;
-}
-
-uint32_t
-SMFSource::read_var_len() const
+SMFSource::load_model(bool lock, bool force_reload)
 {
-       assert(!feof(_fd));
-
-       //int offset = ftell(_fd);
-       //cerr << "SMF - reading var len at " << offset << endl;
-
-       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);
+       if (_writing) {
+               return;
        }
+       
 
-       return value;
-}
-
-void
-SMFSource::load_model(bool lock, bool force_reload)
-{
-       if (lock)
+       if (lock) {
                Glib::Mutex::Lock lm (_lock);
+       }
 
-       if (_model && _model_loaded && ! force_reload) {
-               assert(_model);
+       if (_model && !force_reload && !_model->empty()) {
                return;
        }
 
-       if (! _model)
-               _model = new MidiModel(_session);
+       if (! _model) {
+               _model = boost::shared_ptr<MidiModel>(new MidiModel(this));
+               cerr << _name << " loaded new model " << _model.get() << endl;
+       } else {
+               cerr << _name << " reloading model " << _model.get()
+                       << " (" << _model->n_notes() << " notes)" <<endl;
+               _model->clear();
+       }
 
        _model->start_write();
-
-       fseek(_fd, _header_size, 0);
+       SMF::seek_to_start();
 
        uint64_t time = 0; /* in SMF ticks */
-       jack_midi_event_t ev;
-       ev.time = 0;
-       ev.size = 0;
-       ev.buffer = NULL;
+       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.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(ev)) >= 0) {
-               time += ev.time;
+       while ((ret = read_event(&delta_t, &size, &buf)) >= 0) {
+               
+               ev.set(buf, size, 0.0);
+               time += delta_t;
                
-               const double ev_time = (double)(time * frames_per_beat / (double)_ppqn); // in frames
-
                if (ret > 0) { // didn't skip (meta) event
-                       //cerr << "ADDING EVENT TO MODEL: " << ev.time << endl;
-                       _model->append(ev_time, ev.size, ev.buffer);
+                       // make ev.time absolute time in frames
+                       ev.time() = time * frames_per_beat / (Evoral::EventTime)ppqn();
+                       ev.set_event_type(EventTypeMap::instance().midi_event_type(buf[0]));
+                       _model->append(ev);
+               }
+
+               if (ev.size() > scratch_size) {
+                       scratch_size = ev.size();
+               } else {
+                       ev.size() = scratch_size;
                }
        }
+
+       // set interpolation style to defaults, can be changed by the GUI later
+       Evoral::ControlSet::Controls controls = _model->controls();
+       for (Evoral::ControlSet::Controls::iterator c = controls.begin(); c != controls.end(); ++c) {
+               (*c).second->list()->set_interpolation(
+                       EventTypeMap::instance().interpolation_of((*c).first));
+       }
        
-       _model->end_write(false); /* FIXME: delete stuck notes iff percussion? */
+       _model->end_write(false);
+       _model->set_edited(false);
 
-       _model_loaded = true;
+       free(buf);
 }
 
 
 void
 SMFSource::destroy_model()
 {
-       delete _model;
-       _model = NULL;
+       //cerr << _name << " destroying model " << _model.get() << endl;
+       _model.reset();
+}
+
+void
+SMFSource::flush_midi()
+{
+       SMF::end_write();
 }