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