add ActionManager::set_sensitive() for Gtk::ActionGroup
[ardour.git] / libs / evoral / src / SMF.cpp
index cf838455ce4bd872a7c70722d5e9a70f968f63fe..64dd4e6889a483f4043709ef7a1cce8247576d50 100644 (file)
@@ -1,5 +1,5 @@
 /* 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
  *
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#define __STDC_LIMIT_MACROS 1
+#include <algorithm>
 #include <cassert>
 #include <cmath>
 #include <iostream>
 #include <stdint.h>
+
+#include <glib/gstdio.h>
+
 #include "libsmf/smf.h"
+
 #include "evoral/Event.hpp"
 #include "evoral/SMF.hpp"
 #include "evoral/midi_util.h"
-#include "pbd/file_manager.h"
+
+#ifdef COMPILER_MSVC
+extern double round(double x);
+#endif
 
 using namespace std;
 
 namespace Evoral {
 
+SMF::SMF()
+       : _smf (0)
+       , _smf_track (0)
+       , _empty (true)
+       , _type0 (false)
+       {};
+
 SMF::~SMF()
 {
-       if (_smf) {
-               smf_delete(_smf);
-               _smf = 0;
-               _smf_track = 0;
-       }
+       close ();
 }
 
 uint16_t
 SMF::num_tracks() const
 {
-       return _smf->number_of_tracks;
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+       return _smf ? _smf->number_of_tracks : 0;
 }
 
 uint16_t
 SMF::ppqn() const
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
        return _smf->ppqn;
 }
 
@@ -59,6 +71,7 @@ SMF::ppqn() const
 int
 SMF::seek_to_track(int track)
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
        _smf_track = smf_get_track_by_number(_smf, track);
        if (_smf_track != NULL) {
                _smf_track->next_event_number = (_smf_track->number_of_events == 0) ? 0 : 1;
@@ -68,6 +81,31 @@ SMF::seek_to_track(int track)
        }
 }
 
+/** Attempt to open the SMF file just to see if it is valid.
+ *
+ * \return  true on success
+ *          false on failure
+ */
+bool
+SMF::test(const std::string& path)
+{
+       FILE* f = g_fopen(path.c_str(), "r");
+       if (f == 0) {
+               return false;
+       }
+
+       smf_t* test_smf = smf_load(f);
+       fclose(f);
+
+       if (!test_smf) {
+               return false;
+       }
+       if (test_smf) {
+               smf_delete(test_smf);
+       }
+       return true;
+}
+
 /** Attempt to open the SMF file for reading and/or writing.
  *
  * \return  0 on success
@@ -77,27 +115,26 @@ SMF::seek_to_track(int track)
 int
 SMF::open(const std::string& path, int track) THROW_FILE_ERROR
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
+       _type0 = false;
+       _type0channels.clear ();
+
        assert(track >= 1);
        if (_smf) {
                smf_delete(_smf);
        }
 
-       _file_path = path;
-
-       PBD::StdioFileDescriptor d (_file_path, "r");
-       FILE* f = d.allocate ();
+       FILE* f = g_fopen(path.c_str(), "r");
        if (f == 0) {
                return -1;
-       }
-       
-       _smf = smf_load (f);
-       if (_smf == NULL) {
+       } else if ((_smf = smf_load(f)) == 0) {
+               fclose(f);
                return -1;
-       }
-
-       _smf_track = smf_get_track_by_number(_smf, track);
-       if (!_smf_track)
+       } else if ((_smf_track = smf_get_track_by_number(_smf, track)) == 0) {
+               fclose(f);
                return -2;
+       }
 
        //cerr << "Track " << track << " # events: " << _smf_track->number_of_events << endl;
        if (_smf_track->number_of_events == 0) {
@@ -108,6 +145,34 @@ SMF::open(const std::string& path, int track) THROW_FILE_ERROR
                _empty = false;
        }
 
+       fclose(f);
+
+       lm.release ();
+       if (_smf->format == 0 && _smf->number_of_tracks == 1 && !_empty) {
+               // type-0 file: scan file for # of used channels.
+               int ret;
+               uint32_t delta_t = 0;
+               uint32_t size    = 0;
+               uint8_t* buf     = NULL;
+               event_id_t event_id = 0;
+               seek_to_start();
+               while ((ret = read_event (&delta_t, &size, &buf, &event_id)) >= 0) {
+                       if (ret == 0) {
+                               continue;
+                       }
+                       if (size == 0) {
+                               break;
+                       }
+                       uint8_t type = buf[0] & 0xf0;
+                       uint8_t chan = buf[0] & 0x0f;
+                       if (type < 0x80 || type > 0xE0) {
+                               continue;
+                       }
+                       _type0channels.insert(chan);
+               }
+               _type0 = true;
+               seek_to_start();
+       }
        return 0;
 }
 
@@ -121,25 +186,28 @@ SMF::open(const std::string& path, int track) THROW_FILE_ERROR
 int
 SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
        assert(track >= 1);
        if (_smf) {
                smf_delete(_smf);
        }
 
-       _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);
+               if (!_smf_track) {
+                       return -2;
+               }
                smf_add_track(_smf, _smf_track);
        }
 
@@ -148,7 +216,25 @@ SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
                return -2;
 
        _smf_track->next_event_number = 0;
+
+       {
+               /* put a stub file on disk */
+
+               FILE* f = g_fopen (path.c_str(), "w+");
+               if (f == 0) {
+                       return -1;
+               }
+
+               if (smf_save (_smf, f)) {
+                       fclose (f);
+                       return -1;
+               }
+               fclose (f);
+       }
+
        _empty = true;
+       _type0 = false;
+       _type0channels.clear ();
 
        return 0;
 }
@@ -156,26 +242,26 @@ SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
 void
 SMF::close() THROW_FILE_ERROR
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
        if (_smf) {
-               PBD::StdioFileDescriptor d (_file_path, "w+");
-               FILE* f = d.allocate ();
-               if (f == 0) {
-                       throw FileError ();
-               }
-               
-               if (smf_save(_smf, f) != 0) {
-                       throw FileError();
-               }
                smf_delete(_smf);
                _smf = 0;
                _smf_track = 0;
+               _type0 = false;
+               _type0channels.clear ();
        }
 }
 
 void
 SMF::seek_to_start() const
 {
-       _smf_track->next_event_number = 1;
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+       if (_smf_track) {
+               _smf_track->next_event_number = std::min(_smf_track->number_of_events, (size_t)1);
+       } else {
+               cerr << "WARNING: SMF seek_to_start() with no track" << endl;
+       }
 }
 
 /** Read an event from the current position in file.
@@ -189,24 +275,51 @@ SMF::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).
  */
 int
-SMF::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
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
        smf_event_t* event;
 
        assert(delta_t);
        assert(size);
        assert(buf);
+       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)) {
-                       return 0;
+                       *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;
@@ -216,15 +329,25 @@ SMF::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const
                if (*size < (unsigned)event_size) {
                        *buf = (uint8_t*)realloc(*buf, event_size);
                }
+               assert (*buf);
                memcpy(*buf, event->midi_buffer, size_t(event_size));
                *size = event_size;
+               if (((*buf)[0] & 0xF0) == 0x90 && (*buf)[2] == 0) {
+                       /* normalize note on with velocity 0 to proper note off */
+                       (*buf)[0] = 0x80 | ((*buf)[0] & 0x0F);  /* note off */
+                       (*buf)[2] = 0x40;  /* default velocity */
+               }
 
-               assert(midi_event_is_valid(*buf, *size));
+               if (!midi_event_is_valid(*buf, *size)) {
+                       cerr << "WARNING: SMF ignoring illegal MIDI event" << endl;
+                       *size = 0;
+                       return -1;
+               }
 
                /* printf("SMF::read_event @ %u: ", *delta_t);
-               for (size_t i = 0; i < *size; ++i) {
-                       printf("%X ", (*buf)[i]);
-               } printf("\n") */
+                  for (size_t i = 0; i < *size; ++i) {
+                  printf("%X ", (*buf)[i]);
+                  } printf("\n") */
 
                return event_size;
        } else {
@@ -233,16 +356,38 @@ SMF::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const
 }
 
 void
-SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf)
+SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, event_id_t note_id)
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
        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"); */
+          for (size_t i = 0; i < size; ++i) {
+          printf("%X ", buf[i]);
+          } printf("\n"); */
+
+       switch (buf[0]) {
+       case 0xf1:
+       case 0xf2:
+       case 0xf3:
+       case 0xf4:
+       case 0xf5:
+       case 0xf6:
+       case 0xf8:
+       case 0xf9:
+       case 0xfa:
+       case 0xfb:
+       case 0xfc:
+       case 0xfd:
+       case 0xfe:
+       case 0xff:
+               /* System Real Time or System Common event: not valid in SMF
+                */
+               return;
+       }
 
        if (!midi_event_is_valid(buf, size)) {
                cerr << "WARNING: SMF ignoring illegal MIDI event" << endl;
@@ -251,6 +396,53 @@ SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf)
 
        smf_event_t* event;
 
+       /* 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_NOTE_PRESSURE ||
+               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);
 
@@ -262,6 +454,8 @@ SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf)
 void
 SMF::begin_write()
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
        assert(_smf_track);
        smf_track_delete(_smf_track);
 
@@ -273,27 +467,25 @@ SMF::begin_write()
 }
 
 void
-SMF::end_write() THROW_FILE_ERROR
+SMF::end_write(string const & path) THROW_FILE_ERROR
 {
-#if 0
-        /* don't create empty MIDI files 
-         */
-
-        smf_rewind (_smf); // smf_save() would have done this anyway
-        if (smf_peek_next_event (_smf) == 0) {
-                return;
-        }
-#endif
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
+       if (!_smf) {
+               return;
+       }
 
-       PBD::StdioFileDescriptor d (_file_path, "w+");
-       FILE* f = d.allocate ();
+       FILE* f = g_fopen (path.c_str(), "w+");
        if (f == 0) {
-               throw FileError ();
+               throw FileError (path);
        }
-       
+
        if (smf_save(_smf, f) != 0) {
-               throw FileError();
+               fclose(f);
+               throw FileError (path);
        }
+
+       fclose(f);
 }
 
 double
@@ -304,5 +496,105 @@ SMF::round_to_file_precision (double val) const
        return round (val * div) / div;
 }
 
+void
+SMF::track_names(vector<string>& names) const
+{
+       if (!_smf) {
+               return;
+       }
+
+       names.clear ();
+
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
+       for (uint16_t n = 0; n < _smf->number_of_tracks; ++n) {
+               smf_track_t* trk = smf_get_track_by_number (_smf, n+1);
+               if (!trk) {
+                       names.push_back (string());
+               } else {
+                       if (trk->name) {
+                               names.push_back (trk->name);
+                       } else {
+                               names.push_back (string());
+                       }
+               }
+       }
+}
+
+void
+SMF::instrument_names(vector<string>& names) const
+{
+       if (!_smf) {
+               return;
+       }
+
+       names.clear ();
+
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
+       for (uint16_t n = 0; n < _smf->number_of_tracks; ++n) {
+               smf_track_t* trk = smf_get_track_by_number (_smf, n+1);
+               if (!trk) {
+                       names.push_back (string());
+               } else {
+                       if (trk->instrument) {
+                               names.push_back (trk->instrument);
+                       } else {
+                               names.push_back (string());
+                       }
+               }
+       }
+}
+
+SMF::Tempo::Tempo (smf_tempo_t* smft)
+       : time_pulses (smft->time_pulses)
+       , time_seconds (smft->time_seconds)
+       , microseconds_per_quarter_note (smft->microseconds_per_quarter_note)
+       , numerator (smft->numerator)
+       , denominator (smft->denominator)
+       , clocks_per_click (smft->clocks_per_click)
+       , notes_per_note (smft->notes_per_note)
+{
+}
+
+int
+SMF::num_tempos () const
+{
+       assert (_smf);
+       return smf_get_tempo_count (_smf);
+}
+
+SMF::Tempo*
+SMF::tempo_at_smf_pulse (size_t smf_pulse) const
+{
+       smf_tempo_t* t = smf_get_tempo_by_seconds (_smf, smf_pulse);
+       if (!t) {
+               return 0;
+       }
+       return new Tempo (t);
+}
+
+SMF::Tempo*
+SMF::tempo_at_seconds (double seconds) const
+{
+       smf_tempo_t* t = smf_get_tempo_by_seconds (_smf, seconds);
+       if (!t) {
+               return 0;
+       }
+       return new Tempo (t);
+}
+
+SMF::Tempo*
+SMF::nth_tempo (size_t n) const
+{
+       assert (_smf);
+
+       smf_tempo_t* t = smf_get_tempo_by_number (_smf, n);
+       if (!t) {
+               return 0;
+       }
+
+       return new Tempo (t);
+}
 
 } // namespace Evoral