add a first hack at a step edit cursor (to be changed); add program+bank stubs (non...
[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         void set_record_enabled (bool yn, void *src);
50
51         void set_latency_delay (nframes_t);
52
53         int export_stuff (BufferSet& bufs, nframes_t nframes, sframes_t end_frame);
54
55         void freeze_me (InterThreadInfo&);
56         void unfreeze ();
57         
58         boost::shared_ptr<Region> bounce (InterThreadInfo&);
59         boost::shared_ptr<Region>  bounce_range (
60                         nframes_t start, nframes_t end, InterThreadInfo&, bool enable_processing);
61
62         int set_state(const XMLNode&, int version);
63
64         void midi_panic(void);
65         bool write_immediate_event(size_t size, const uint8_t* buf);
66
67         /** A control that will send "immediate" events to a MIDI track when twiddled */
68         struct MidiControl : public AutomationControl {
69                 MidiControl(MidiTrack* route, const Evoral::Parameter& param,
70                             boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>())
71                         : AutomationControl (route->session(), param, al)
72                         , _route (route)
73                 {}
74
75                 void set_value (double val);
76
77                 MidiTrack* _route;
78         };
79
80         NoteMode note_mode() const { return _note_mode; }
81         void set_note_mode (NoteMode m);
82
83         bool step_editing() const { return _step_editing; }
84         void set_step_editing (bool yn);
85         MidiRingBuffer<nframes_t>& step_edit_ring_buffer() { return _step_edit_ring_buffer; }
86
87         PBD::Signal1<void,bool> StepEditStatusChange;
88
89         uint8_t default_channel() const { return _default_channel; }
90         void set_default_channel (uint8_t chn);
91
92         bool midi_thru() const { return _midi_thru; }
93         void set_midi_thru (bool yn);
94
95         boost::shared_ptr<SMFSource> write_source (uint32_t n = 0);
96         void set_channel_mode (ChannelMode, uint16_t);
97         ChannelMode get_channel_mode ();
98         uint16_t get_channel_mask ();
99         boost::shared_ptr<MidiPlaylist> midi_playlist ();
100
101 protected:
102         XMLNode& state (bool full);
103         
104         int _set_state (const XMLNode&, int, bool call_base);
105
106 private:
107         boost::shared_ptr<MidiDiskstream> midi_diskstream () const;
108
109         void write_out_of_band_data (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
110
111         void set_state_part_two ();
112         void set_state_part_three ();
113
114         MidiRingBuffer<nframes_t> _immediate_events;
115         MidiRingBuffer<nframes_t> _step_edit_ring_buffer;
116         NoteMode                  _note_mode;
117         bool                      _step_editing;
118         uint8_t                   _default_channel;
119         bool                      _midi_thru;
120
121         int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
122                         bool state_changing, bool can_record, bool rec_monitors_input);
123         void push_midi_input_to_step_edit_ringbuffer (nframes_t nframes);
124 };
125
126 } /* namespace ARDOUR*/
127
128 #endif /* __ardour_midi_track_h__ */