Fix some clang warnings (argument with 'nonnull' attribute passed null)
[ardour.git] / libs / evoral / src / SMF.cpp
index 8b2d10d1976bf018f2a537828ac1b5861638b1a5..60d69c8a4dc0b60f97e6be6b7b26903cba21ea0c 100644 (file)
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+#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);
@@ -35,24 +39,29 @@ 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;
 }
 
@@ -62,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;
@@ -71,6 +81,28 @@ 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);
+
+       const bool success = (test_smf != NULL);
+       smf_delete(test_smf);
+
+       return success;
+}
+
 /** Attempt to open the SMF file for reading and/or writing.
  *
  * \return  0 on success
@@ -80,24 +112,24 @@ 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;
-       }
-
-       if ((_smf = smf_load (f)) == 0) {
+       } else if ((_smf = smf_load(f)) == 0) {
+               fclose(f);
                return -1;
-       }
-
-       if ((_smf_track = smf_get_track_by_number(_smf, track)) == 0) {
+       } else if ((_smf_track = smf_get_track_by_number(_smf, track)) == 0) {
+               fclose(f);
                return -2;
        }
 
@@ -110,6 +142,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;
 }
 
@@ -123,13 +183,13 @@ 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 == NULL) {
@@ -142,7 +202,9 @@ SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
 
        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);
        }
 
@@ -155,18 +217,21 @@ SMF::create(const std::string& path, int track, uint16_t ppqn) THROW_FILE_ERROR
        {
                /* put a stub file on disk */
 
-               PBD::StdioFileDescriptor d (_file_path, "w+");
-               FILE* f = d.allocate ();
+               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;
 }
@@ -174,17 +239,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) {
                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.
@@ -207,6 +281,8 @@ SMF::seek_to_start() const
 int
 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);
@@ -250,10 +326,20 @@ SMF::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* no
                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) {
@@ -269,6 +355,8 @@ SMF::read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* no
 void
 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;
        }
@@ -292,6 +380,7 @@ SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, eve
        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))
                               );
@@ -318,7 +407,7 @@ SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, eve
                /* 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 = (uint8_t*) malloc (sizeof(uint8_t) * event->midi_buffer_length);
 
                event->midi_buffer[0] = 0xff; // Meta-event
                event->midi_buffer[1] = 0x7f; // Sequencer-specific
@@ -342,6 +431,8 @@ SMF::append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, eve
 void
 SMF::begin_write()
 {
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
        assert(_smf_track);
        smf_track_delete(_smf_track);
 
@@ -353,17 +444,25 @@ SMF::begin_write()
 }
 
 void
-SMF::end_write() THROW_FILE_ERROR
+SMF::end_write(string const & path) THROW_FILE_ERROR
 {
-       PBD::StdioFileDescriptor d (_file_path, "w+");
-       FILE* f = d.allocate ();
+       Glib::Threads::Mutex::Lock lm (_smf_lock);
+
+       if (!_smf) {
+               return;
+       }
+
+       FILE* f = g_fopen (path.c_str(), "w+");
        if (f == 0) {
-               throw FileError (_file_path);
+               throw FileError (path);
        }
 
        if (smf_save(_smf, f) != 0) {
-               throw FileError (_file_path);
+               fclose(f);
+               throw FileError (path);
        }
+
+       fclose(f);
 }
 
 double
@@ -375,9 +474,104 @@ SMF::round_to_file_precision (double val) const
 }
 
 void
-SMF::set_path (const std::string& p)
+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
 {
-       _file_path = p;
+       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