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