2 Copyright (C) 2000-2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 $Id: midiregion.h 733 2006-08-01 17:19:38Z drobilla $
21 #ifndef __ardour_midi_region_h__
22 #define __ardour_midi_region_h__
26 #include "evoral/Beats.hpp"
27 #include "evoral/Range.hpp"
29 #include "pbd/string_convert.h"
31 #include "ardour/ardour.h"
32 #include "ardour/midi_cursor.h"
33 #include "ardour/region.h"
38 namespace Properties {
39 LIBARDOUR_API extern PBD::PropertyDescriptor<double> start_beats;
40 LIBARDOUR_API extern PBD::PropertyDescriptor<double> length_beats;
45 template<typename Time> class EventSink;
50 class MidiChannelFilter;
54 class MidiStateTracker;
59 template<typename T> class MidiRingBuffer;
61 class LIBARDOUR_API MidiRegion : public Region
64 static void make_property_quarks ();
68 bool do_export (std::string path) const;
70 boost::shared_ptr<MidiRegion> clone (std::string path = std::string()) const;
71 boost::shared_ptr<MidiRegion> clone (boost::shared_ptr<MidiSource>) const;
73 boost::shared_ptr<MidiSource> midi_source (uint32_t n=0) const;
75 /* Stub Readable interface */
76 virtual samplecnt_t read (Sample*, samplepos_t /*pos*/, samplecnt_t /*cnt*/, int /*channel*/) const { return 0; }
77 virtual samplecnt_t readable_length() const { return length(); }
79 samplecnt_t read_at (Evoral::EventSink<samplepos_t>& dst,
82 Evoral::Range<samplepos_t>* loop_range,
85 NoteMode mode = Sustained,
86 MidiStateTracker* tracker = 0,
87 MidiChannelFilter* filter = 0) const;
89 samplecnt_t master_read_at (MidiRingBuffer<samplepos_t>& dst,
92 Evoral::Range<samplepos_t>* loop_range,
95 NoteMode mode = Sustained) const;
98 int set_state (const XMLNode&, int version);
100 int separate_by_channel (std::vector< boost::shared_ptr<Region> >&) const;
104 boost::shared_ptr<Evoral::Control> control(const Evoral::Parameter& id, bool create=false);
106 virtual boost::shared_ptr<const Evoral::Control> control(const Evoral::Parameter& id) const;
110 boost::shared_ptr<MidiModel> model();
111 boost::shared_ptr<const MidiModel> model() const;
113 void fix_negative_start ();
114 double start_beats () const {return _start_beats; }
115 double length_beats () const {return _length_beats; }
117 void clobber_sources (boost::shared_ptr<MidiSource> source);
121 virtual bool can_trim_start_before_source_start () const {
126 friend class RegionFactory;
127 PBD::Property<double> _start_beats;
128 PBD::Property<double> _length_beats;
130 MidiRegion (const SourceList&);
131 MidiRegion (boost::shared_ptr<const MidiRegion>);
132 MidiRegion (boost::shared_ptr<const MidiRegion>, ARDOUR::MusicSample offset);
134 samplecnt_t _read_at (const SourceList&, Evoral::EventSink<samplepos_t>& dst,
135 samplepos_t position,
137 Evoral::Range<samplepos_t>* loop_range,
140 NoteMode mode = Sustained,
141 MidiStateTracker* tracker = 0,
142 MidiChannelFilter* filter = 0) const;
144 void register_properties ();
145 void post_set (const PBD::PropertyChange&);
147 void recompute_at_start ();
148 void recompute_at_end ();
150 void set_position_internal (samplepos_t pos, bool allow_bbt_recompute, const int32_t sub_num);
151 void set_position_music_internal (double qn);
152 void set_length_internal (samplecnt_t len, const int32_t sub_num);
153 void set_start_internal (samplecnt_t, const int32_t sub_num);
154 void trim_to_internal (samplepos_t position, samplecnt_t length, const int32_t sub_num);
155 void update_length_beats (const int32_t sub_num);
157 void model_changed ();
158 void model_shifted (double qn_distance);
159 void model_automation_state_changed (Evoral::Parameter const &);
161 void set_start_beats_from_start_samples ();
162 void update_after_tempo_map_change (bool send_change = true);
164 std::set<Evoral::Parameter> _filtered_parameters; ///< parameters that we ask our source not to return when reading
165 PBD::ScopedConnection _model_connection;
166 PBD::ScopedConnection _model_shift_connection;
167 PBD::ScopedConnection _source_connection;
168 PBD::ScopedConnection _model_contents_connection;
172 } /* namespace ARDOUR */
175 #endif /* __ardour_midi_region_h__ */