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.
  38  * Currently only tempo-based time of a given PPQN is supported.
  39  */
  40 template<typename Time>
  41 class SMF {
  42 public:
  43         class FileError : public std::exception {
  44                 const char* what() const throw() { return "Unknown SMF error"; }
  45         };
  46
  47         SMF() : _smf(0), _smf_track(0), _empty(true) {};
  48         virtual ~SMF();
  49
  50         int  open(const std::string& path, int track=1) THROW_FILE_ERROR;
  51         int  create(const std::string& path, int track=1, uint16_t ppqn=19200) THROW_FILE_ERROR;
  52         void close() THROW_FILE_ERROR;
  53
  54         const std::string& path() const { return _path; };
  55
  56         void seek_to_start() const;
  57         int  seek_to_track(int track);
  58
  59         int read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const;
  60
  61         uint16_t num_tracks() const;
  62         uint16_t ppqn()       const;
  63         bool     is_empty()   const { return _empty; }
  64         bool     eof()        const { assert(false); return true; }
  65
  66         void begin_write();
  67         void append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf);
  68         void end_write() THROW_FILE_ERROR;
  69
  70         void flush() {};
  71
  72 private:
  73         std::string  _path;
  74         smf_t*       _smf;
  75         smf_track_t* _smf_track;
  76
  77         bool         _empty; ///< true iff file contains(non-empty) events
  78 };
  79
  80 }; /* namespace Evoral */
  81
  82 #endif /* EVORAL_SMF_HPP */
  83