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  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or(at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_SMF_HPP
  20 #define EVORAL_SMF_HPP
  21
  22 #include "evoral/StandardMIDIFile.hpp"
  23
  24 namespace Evoral {
  25
  26 template<typename Time> class Event;
  27 template<typename Time> class EventRingBuffer;
  28
  29
  30 /** Standard Midi File (Type 0)
  31  */
  32 template<typename Time>
  33 class SMF : public StandardMIDIFile<Time> {
  34 public:
  35         SMF();
  36         virtual ~SMF();
  37
  38         void seek_to_start() const;
  39
  40         uint16_t ppqn()     const { return _ppqn; }
  41         bool     is_empty() const { return _empty; }
  42         bool     eof()      const { return feof(_fd); }
  43
  44         Time last_event_time() const { return _last_ev_time; }
  45
  46         void begin_write(FrameTime start_time);
  47         void append_event_unlocked(uint32_t delta_t, const Event<Time>& ev);
  48         void end_write();
  49
  50         void flush();
  51         int  flush_header();
  52         int  flush_footer();
  53
  54 protected:
  55         int  open(const std::string& path);
  56         void close();
  57
  58         int read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf) const;
  59
  60 private:
  61         /** Used by flush_footer() to find the position to write the footer */
  62         void seek_to_footer_position();
  63
  64         /** Write the track footer at the current seek position */
  65         void write_footer();
  66
  67         void     write_chunk_header(const char id[4], uint32_t length);
  68         void     write_chunk(const char id[4], uint32_t length, void* data);
  69         size_t   write_var_len(uint32_t val);
  70         uint32_t read_var_len() const;
  71
  72         static const uint16_t _ppqn = 19200;
  73
  74         FILE*    _fd;
  75         Time     _last_ev_time; ///< last frame time written, relative to source start
  76         uint32_t _track_size;
  77         uint32_t _header_size; ///< size of SMF header, including MTrk chunk header
  78         bool     _empty; ///< true iff file contains(non-empty) events
  79 };
  80
  81 }; /* namespace Evoral */
  82
  83 #endif /* EVORAL_SMF_HPP */
  84