MIDI region forking, plus Playlist::regions_to_read() fix forward ported from 2.X...
[ardour.git] / libs / ardour / ardour / midi_track.h
1 /*
2     Copyright (C) 2006 Paul Davis
3     Written by Dave Robillard
4
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.
9
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.
14
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.
18 */
19
20 #ifndef __ardour_midi_track_h__
21 #define __ardour_midi_track_h__
22
23 #include "ardour/track.h"
24 #include "ardour/midi_ring_buffer.h"
25 #include "ardour/midi_state_tracker.h"
26
27 namespace ARDOUR
28 {
29
30 class Session;
31 class MidiDiskstream;
32 class MidiPlaylist;
33 class RouteGroup;
34 class SMFSource;        
35
36 class MidiTrack : public Track
37 {
38 public:
39         MidiTrack (Session&, string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal);
40         ~MidiTrack ();
41
42         int roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame,
43                   int declick, bool can_record, bool rec_monitors_input, bool& need_butler);
44
45         void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
46
47         void use_new_diskstream ();
48         void set_diskstream (boost::shared_ptr<Diskstream>);
49
50         void set_latency_delay (nframes_t);
51
52         int export_stuff (BufferSet& bufs, nframes_t nframes, sframes_t end_frame);
53
54         void freeze_me (InterThreadInfo&);
55         void unfreeze ();
56
57         boost::shared_ptr<Region> bounce (InterThreadInfo&);
58         boost::shared_ptr<Region>  bounce_range (
59                         nframes_t start, nframes_t end, InterThreadInfo&, bool enable_processing);
60
61         int set_state(const XMLNode&, int version);
62
63         void midi_panic(void);
64         bool write_immediate_event(size_t size, const uint8_t* buf);
65
66         /** A control that will send "immediate" events to a MIDI track when twiddled */
67         struct MidiControl : public AutomationControl {
68                 MidiControl(MidiTrack* route, const Evoral::Parameter& param,
69                                 boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>())
70                         : AutomationControl (route->session(), param, al)
71                         , _route (route)
72                 {}
73
74                 void set_value (float val);
75
76                 MidiTrack* _route;
77         };
78
79         NoteMode note_mode() const { return _note_mode; }
80         void set_note_mode (NoteMode m);
81
82         bool step_editing() const { return _step_editing; }
83         void set_step_editing (bool yn);
84         MidiRingBuffer<nframes_t>& step_edit_ring_buffer() { return _step_edit_ring_buffer; }
85
86         uint8_t default_channel() const { return _default_channel; }
87         void set_default_channel (uint8_t chn);
88
89         bool midi_thru() const { return _midi_thru; }
90         void set_midi_thru (bool yn);
91
92         boost::shared_ptr<SMFSource> write_source (uint32_t n = 0);
93         void set_channel_mode (ChannelMode, uint16_t);
94         ChannelMode get_channel_mode ();
95         uint16_t get_channel_mask ();
96         boost::shared_ptr<MidiPlaylist> midi_playlist ();
97         
98 protected:
99         XMLNode& state (bool full);
100         
101         int _set_state (const XMLNode&, int, bool call_base);
102
103 private:
104         boost::shared_ptr<MidiDiskstream> midi_diskstream () const;
105
106         void write_out_of_band_data (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
107
108         void set_state_part_two ();
109         void set_state_part_three ();
110
111         MidiRingBuffer<nframes_t> _immediate_events;
112         MidiRingBuffer<nframes_t> _step_edit_ring_buffer;
113         NoteMode                  _note_mode;
114         bool                      _step_editing;
115         uint8_t                   _default_channel;
116         bool                      _midi_thru;
117
118         int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
119                         bool state_changing, bool can_record, bool rec_monitors_input);
120         void push_midi_input_to_step_edit_ringbuffer (nframes_t nframes);
121 };
122
123 } /* namespace ARDOUR*/
124
125 #endif /* __ardour_midi_track_h__ */