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 #include "evoral/types.hpp"
  25
  26 struct smf_struct;
  27 struct smf_track_struct;
  28 typedef smf_struct smf_t;
  29 typedef smf_track_struct smf_track_t;
  30
  31 namespace Evoral {
  32
  33 #define THROW_FILE_ERROR throw(FileError)
  34
  35 /** Standard Midi File.
  36  * Currently only tempo-based time of a given PPQN is supported.
  37  */
  38 class SMF {
  39 public:
  40         class FileError : public std::exception {
  41         public:
  42                 FileError (std::string const & n) : _file_name (n) {}
  43                 ~FileError () throw () {}
  44                 const char* what() const throw() { return "Unknown SMF error"; }
  45                 std::string file_name () const { return _file_name; }
  46         private:
  47                 std::string _file_name;
  48         };
  49
  50         SMF() : _smf(0), _smf_track(0), _empty(true) {};
  51         virtual ~SMF();
  52
  53         int  open(const std::string& path, int track=1) THROW_FILE_ERROR;
  54         int  create(const std::string& path, int track=1, uint16_t ppqn=19200) THROW_FILE_ERROR;
  55         void close() THROW_FILE_ERROR;
  56
  57         const std::string& file_path() const { return _file_path; };
  58
  59         void seek_to_start() const;
  60         int  seek_to_track(int track);
  61
  62         int read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* note_id) const;
  63
  64         uint16_t num_tracks() const;
  65         uint16_t ppqn()       const;
  66         bool     is_empty()   const { return _empty; }
  67
  68         void begin_write();
  69         void append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, event_id_t note_id);
  70         void end_write() THROW_FILE_ERROR;
  71
  72         void flush() {};
  73
  74         double round_to_file_precision (double val) const;
  75
  76 protected:
  77         void set_path (const std::string& p);
  78
  79 private:
  80         std::string  _file_path;
  81         smf_t*       _smf;
  82         smf_track_t* _smf_track;
  83         bool         _empty; ///< true iff file contains(non-empty) events
  84 };
  85
  86 }; /* namespace Evoral */
  87
  88 #endif /* EVORAL_SMF_HPP */
  89