libs/evoral/evoral/SMF.hpp

   1 /* This file is part of Evoral.
   2  * Copyright(C) 2008 Dave 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 struct smf_struct;
  26 struct smf_track_struct;
  27 typedef smf_struct smf_t;
  28 typedef smf_track_struct smf_track_t;
  29
  30 namespace Evoral {
  31
  32 template<typename Time> class Event;
  33 template<typename Time> class EventRingBuffer;
  34
  35 #define THROW_FILE_ERROR throw(typename SMF<Time>::FileError)
  36
  37 /** Standard Midi File (Type 0)
  38  */
  39 template<typename Time>
  40 class SMF {
  41 public:
  42         class FileError : public std::exception {
  43                 const char* what() const throw() { return "Unknown SMF error"; }
  44         };
  45
  46         SMF() : _last_ev_time(0), _smf(0), _smf_track(0), _empty(true) {};
  47         virtual ~SMF();
  48
  49         int  open(const std::string& path, bool create=true, int track=1) THROW_FILE_ERROR;
  50         void close() THROW_FILE_ERROR;
  51
  52         void seek_to_start() const;
  53
  54         uint16_t ppqn()     const { return _ppqn; }
  55         bool     is_empty() const { return _empty; }
  56         bool     eof()      const { assert(false); return true; }
  57
  58         Time last_event_time() const { return _last_ev_time; }
  59
  60         void begin_write();
  61         void append_event_delta(uint32_t delta_t, const Event<Time>& ev);
  62         void end_write() THROW_FILE_ERROR;
  63
  64         void flush() {};
  65         int  flush_header() { return 0; }
  66         int  flush_footer() { return 0; }
  67
  68 protected:
  69         int read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const;
  70
  71 private:
  72         static const uint16_t _ppqn = 19200;
  73
  74         Time _last_ev_time; ///< last frame time written, relative to source start
  75
  76         std::string  _path;
  77         smf_t*       _smf;
  78         smf_track_t* _smf_track;
  79
  80         bool         _empty; ///< true iff file contains(non-empty) events
  81 };
  82
  83 }; /* namespace Evoral */
  84
  85 #endif /* EVORAL_SMF_HPP */
  86