ardour/libs/evoral/evoral/SMF.h

159 lines
4.5 KiB
C++

/*
* Copyright (C) 2008-2014 David Robillard <d@drobilla.net>
* Copyright (C) 2009-2017 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2009 Hans Baier <hansfbaier@googlemail.com>
* Copyright (C) 2014-2016 Robin Gareus <robin@gareus.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef EVORAL_SMF_HPP
#define EVORAL_SMF_HPP
#include <glibmm/threads.h>
#include <set>
#include "evoral/visibility.h"
#include "evoral/types.h"
struct smf_struct;
struct smf_track_struct;
struct smf_tempo_struct;
typedef smf_struct smf_t;
typedef smf_track_struct smf_track_t;
typedef smf_tempo_struct smf_tempo_t;
namespace Evoral {
/** Standard Midi File.
* Currently only tempo-based time of a given PPQN is supported.
*
* For WRITING: this object specifically wraps a type0 file or a type1 file with only a
* single track. It has no support at this time for a type1 file with multiple
* tracks.
*
* For READING: this object can read a single arbitrary track from a type1
* file, or the single track of a type0 file. It has no support at this time
* for reading more than 1 track.
*/
class LIBEVORAL_API SMF {
public:
class FileError : public std::exception {
public:
FileError (std::string const & n) : _file_name (n) {}
~FileError () throw () {}
const char* what() const throw() { return "Unknown SMF error"; }
std::string file_name () const { return _file_name; }
private:
std::string _file_name;
};
SMF();
virtual ~SMF();
static bool test(const std::string& path);
int open(const std::string& path, int track=1);
// XXX 19200 = 10 * Temporal::ticks_per_beat
int create(const std::string& path, int track=1, uint16_t ppqn=19200);
void close();
void seek_to_start() const;
int seek_to_track(int track);
int read_event(uint32_t* delta_t, uint32_t* size, uint8_t** buf, event_id_t* note_id) const;
uint16_t num_tracks() const;
uint16_t ppqn() const;
bool is_empty() const { return _empty; }
void begin_write();
void append_event_delta(uint32_t delta_t, uint32_t size, const uint8_t* buf, event_id_t note_id);
void end_write(std::string const &);
void flush() {};
double round_to_file_precision (double val) const;
int smf_format () const;
int num_channels () const { return _num_channels; }
typedef std::bitset<16> UsedChannels;
UsedChannels const& used_channels () const { return _used_channels; }
void set_used_channels (UsedChannels used) { _used_channels = used; }
uint64_t n_note_on_events () const { return _n_note_on_events; }
bool has_pgm_change () const { return _has_pgm_change; }
void track_names (std::vector<std::string>&) const;
void instrument_names (std::vector<std::string>&) const;
int num_tempos () const;
/* This is exactly modelled on smf_tempo_t */
struct Tempo {
size_t time_pulses;
int microseconds_per_quarter_note;
int numerator;
int denominator;
int clocks_per_click;
int notes_per_note;
Tempo ()
: time_pulses (0)
, microseconds_per_quarter_note (-1)
, numerator (-1)
, denominator (-1)
, clocks_per_click (-1)
, notes_per_note (-1) {}
Tempo (smf_tempo_t*);
double tempo() const {
return 60.0 * (1000000.0 / (double) microseconds_per_quarter_note);
}
};
Tempo* nth_tempo (size_t n) const;
struct MarkerAt {
std::string text;
size_t time_pulses; /* type matches libsmf smf_event_struct.time_pulses */
MarkerAt (std::string const & txt, size_t tp) : text (txt), time_pulses (tp) {}
};
typedef std::vector<MarkerAt> Markers;
Markers const & markers() const { return _markers; }
void load_markers ();
protected:
uint64_t _n_note_on_events;
bool _has_pgm_change;
int _num_channels;
UsedChannels _used_channels;
private:
smf_t* _smf;
smf_track_t* _smf_track;
bool _empty; ///< true iff file contains(non-empty) events
mutable Glib::Threads::Mutex _smf_lock;
mutable Markers _markers;
};
}; /* namespace Evoral */
#endif /* EVORAL_SMF_HPP */