libs/evoral/evoral/SMF.hpp

   1 /* This file is part of Evoral.
   2  * Copyright(C) 2008 David Robillard <http://drobilla.net>
   3  * Copyright(C) 2000-2008 Paul Davis
   4  * Author: Hans Baier
   5  *
   6  * Evoral is free software; you can redistribute it and/or modify it under the
   7  * terms of the GNU General Public License as published by the Free Software
   8  * Foundation; either version 2 of the License, or(at your option) any later
   9  * version.
  10  *
  11  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef EVORAL_SMF_HPP
  21 #define EVORAL_SMF_HPP
  22
  23 #include <cassert>
  24
  25 #include <glibmm/threads.h>
  26
  27 #include "evoral/visibility.h"
  28 #include "evoral/types.hpp"
  29
  30 struct smf_struct;
  31 struct smf_track_struct;
  32 typedef smf_struct smf_t;
  33 typedef smf_track_struct smf_track_t;
  34
  35 namespace Evoral {
  36
  37 #define THROW_FILE_ERROR throw(FileError)
  38
  39 /** Standard Midi File.
  40  * Currently only tempo-based time of a given PPQN is supported.
  41  */
  42 class LIBEVORAL_API SMF {
  43 public:
  44         class FileError : public std::exception {
  45         public:
  46                 FileError (std::string const & n) : _file_name (n) {}
  47                 ~FileError () throw () {}
  48                 const char* what() const throw() { return "Unknown SMF error"; }
  49                 std::string file_name () const { return _file_name; }
  50         private:
  51                 std::string _file_name;
  52         };
  53
  54         SMF() : _smf(0), _smf_track(0), _empty(true) {};
  55         virtual ~SMF();
  56
  57         static bool test(const std::string& path);
  58         int  open(const std::string& path, int track=1) THROW_FILE_ERROR;
  59         // XXX 19200 = 10 * Timecode::BBT_Time::ticks_per_beat
  60         int  create(const std::string& path, int track=1, uint16_t ppqn=19200) THROW_FILE_ERROR;
  61         void close() THROW_FILE_ERROR;
  62
  63         const std::string& file_path() const { return _file_path; };
  64
  65         void seek_to_start() const;
  66         int  seek_to_track(int track);
  67
  68         int read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* note_id) const;
  69
  70         uint16_t num_tracks() const;
  71         uint16_t ppqn()       const;
  72         bool     is_empty()   const { return _empty; }
  73
  74         void begin_write();
  75         void append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, event_id_t note_id);
  76         void end_write() THROW_FILE_ERROR;
  77
  78         void flush() {};
  79
  80         double round_to_file_precision (double val) const;
  81
  82 protected:
  83         void set_path (const std::string& p);
  84
  85 private:
  86         std::string  _file_path;
  87         smf_t*       _smf;
  88         smf_track_t* _smf_track;
  89         bool         _empty; ///< true iff file contains(non-empty) events
  90         mutable Glib::Threads::Mutex _smf_lock;
  91 };
  92
  93 }; /* namespace Evoral */
  94
  95 #endif /* EVORAL_SMF_HPP */
  96