2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_midi_playlist_h__
21 #define __ardour_midi_playlist_h__
26 #include <boost/utility.hpp>
28 #include "ardour/ardour.h"
29 #include "ardour/midi_model.h"
30 #include "ardour/midi_state_tracker.h"
31 #include "ardour/note_fixer.h"
32 #include "ardour/playlist.h"
33 #include "evoral/Note.hpp"
34 #include "evoral/Parameter.hpp"
37 template<typename Time> class EventSink;
44 class BeatsFramesConverter;
45 class MidiChannelFilter;
50 template<typename T> class MidiRingBuffer;
52 class LIBARDOUR_API MidiPlaylist : public ARDOUR::Playlist
55 MidiPlaylist (Session&, const XMLNode&, bool hidden = false);
56 MidiPlaylist (Session&, std::string name, bool hidden = false);
57 MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, std::string name, bool hidden = false);
59 /** This constructor does NOT notify others (session) */
60 MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
68 /** Read a range from the playlist into an event sink.
70 * @param buf Destination for events.
71 * @param start First frame of read range.
72 * @param cnt Number of frames in read range.
73 * @param chan_n Must be 0 (this is the audio-style "channel", where each
74 * channel is backed by a separate region, not MIDI channels, which all
75 * exist in the same region and are not handled here).
76 * @return The number of frames read (time, not an event count).
78 framecnt_t read (Evoral::EventSink<framepos_t>& buf,
82 MidiChannelFilter* filter = NULL);
84 int set_state (const XMLNode&, int version);
86 bool destroy_region (boost::shared_ptr<Region>);
88 void set_note_mode (NoteMode m) { _note_mode = m; }
90 std::set<Evoral::Parameter> contained_automation();
92 /** Handle a region edit during read.
94 * This must be called before the command is applied to the model. Events
95 * are injected into the playlist output to compensate for edits to active
96 * notes and maintain coherent output and tracker state.
98 void region_edited(boost::shared_ptr<Region> region,
99 const MidiModel::NoteDiffCommand* cmd);
101 /** Clear all note trackers. */
102 void reset_note_trackers ();
104 /** Resolve all pending notes and clear all note trackers.
106 * @param dst Sink to write note offs to.
107 * @param time Time stamp of all written note offs.
109 void resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time);
112 void remove_dependents (boost::shared_ptr<Region> region);
115 typedef Evoral::Note<Evoral::Beats> Note;
116 typedef Evoral::Event<framepos_t> Event;
118 struct RegionTracker : public boost::noncopyable {
119 MidiStateTracker tracker; ///< Active note tracker
120 NoteFixer fixer; ///< Edit compensation
123 typedef std::map< Region*, boost::shared_ptr<RegionTracker> > NoteTrackers;
127 NoteTrackers _note_trackers;
129 framepos_t _read_end;
132 } /* namespace ARDOUR */
134 #endif /* __ardour_midi_playlist_h__ */