libs/ardour/ardour/midi_track.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: David 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 "pbd/ffs.h"
  24
  25 #include "ardour/track.h"
  26 #include "ardour/midi_ring_buffer.h"
  27
  28 namespace ARDOUR
  29 {
  30
  31 class InterThreadInfo;
  32 class MidiDiskstream;
  33 class MidiPlaylist;
  34 class RouteGroup;
  35 class SMFSource;
  36 class Session;
  37
  38 class LIBARDOUR_API MidiTrack : public Track
  39 {
  40 public:
  41         MidiTrack (Session&, string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal);
  42         ~MidiTrack ();
  43
  44         int init ();
  45
  46         int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& need_butler);
  47
  48         void realtime_handle_transport_stopped ();
  49         void realtime_locate ();
  50
  51         boost::shared_ptr<Diskstream> create_diskstream ();
  52         void set_diskstream (boost::shared_ptr<Diskstream>);
  53         void set_record_enabled (bool yn, void *src);
  54
  55         DataType data_type () const {
  56                 return DataType::MIDI;
  57         }
  58
  59         void freeze_me (InterThreadInfo&);
  60         void unfreeze ();
  61
  62         bool bounceable (boost::shared_ptr<Processor>, bool) const { return false; }
  63         boost::shared_ptr<Region> bounce (InterThreadInfo&);
  64         boost::shared_ptr<Region> bounce_range (framepos_t                   start,
  65                                                 framepos_t                   end,
  66                                                 InterThreadInfo&             iti,
  67                                                 boost::shared_ptr<Processor> endpoint,
  68                                                 bool                         include_endpoint);
  69
  70         int export_stuff (BufferSet&                   bufs,
  71                           framepos_t                   start_frame,
  72                           framecnt_t                   end_frame,
  73                           boost::shared_ptr<Processor> endpoint,
  74                           bool                         include_endpoint,
  75                           bool                         for_export,
  76                           bool                         for_freeze);
  77
  78         int set_state (const XMLNode&, int version);
  79
  80         void midi_panic(void);
  81         bool write_immediate_event(size_t size, const uint8_t* buf);
  82
  83         /** A control that will send "immediate" events to a MIDI track when twiddled */
  84         struct MidiControl : public AutomationControl {
  85                 MidiControl(MidiTrack* route, const Evoral::Parameter& param,
  86                             boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>())
  87                         : AutomationControl (route->session(), param, al)
  88                         , _route (route)
  89                 {}
  90
  91                 void set_value (double val);
  92
  93                 MidiTrack* _route;
  94         };
  95
  96         NoteMode note_mode() const { return _note_mode; }
  97         void set_note_mode (NoteMode m);
  98
  99         std::string describe_parameter (Evoral::Parameter param);
 100
 101         bool step_editing() const { return _step_editing; }
 102         void set_step_editing (bool yn);
 103         MidiRingBuffer<framepos_t>& step_edit_ring_buffer() { return _step_edit_ring_buffer; }
 104
 105         PBD::Signal1<void,bool> StepEditStatusChange;
 106
 107         boost::shared_ptr<SMFSource> write_source (uint32_t n = 0);
 108
 109         /** Channel filtering mode.
 110          * @param mask If mode is FilterChannels, each bit represents a midi channel:
 111          *     bit 0 = channel 0, bit 1 = channel 1 etc. the read and write methods will only
 112          *     process events whose channel bit is 1.
 113          *     If mode is ForceChannel, mask is simply a channel number which all events will
 114          *     be forced to while reading.
 115          */
 116         void set_capture_channel_mode (ChannelMode mode, uint16_t mask);
 117         void set_playback_channel_mode (ChannelMode mode, uint16_t mask);
 118         void set_playback_channel_mask (uint16_t mask);
 119         void set_capture_channel_mask (uint16_t mask);
 120
 121         ChannelMode get_playback_channel_mode() const {
 122                 return static_cast<ChannelMode>((g_atomic_int_get(&_playback_channel_mask) & 0xffff0000) >> 16);
 123         }
 124         uint16_t get_playback_channel_mask() const {
 125                 return g_atomic_int_get(&_playback_channel_mask) & 0x0000ffff;
 126         }
 127         ChannelMode get_capture_channel_mode() const {
 128                 return static_cast<ChannelMode>((g_atomic_int_get(&_capture_channel_mask) & 0xffff0000) >> 16);
 129         }
 130         uint16_t get_capture_channel_mask() const {
 131                 return g_atomic_int_get(&_capture_channel_mask) & 0x0000ffff;
 132         }
 133
 134         boost::shared_ptr<MidiPlaylist> midi_playlist ();
 135
 136         PBD::Signal0<void> PlaybackChannelMaskChanged;
 137         PBD::Signal0<void> PlaybackChannelModeChanged;
 138         PBD::Signal0<void> CaptureChannelMaskChanged;
 139         PBD::Signal0<void> CaptureChannelModeChanged;
 140
 141         PBD::Signal1<void, boost::weak_ptr<MidiSource> > DataRecorded;
 142         boost::shared_ptr<MidiBuffer> get_gui_feed_buffer () const;
 143
 144         void set_monitoring (MonitorChoice);
 145         MonitorState monitoring_state () const;
 146
 147         void set_input_active (bool);
 148         bool input_active () const;
 149         PBD::Signal0<void> InputActiveChanged;
 150
 151 protected:
 152         XMLNode& state (bool full);
 153
 154         void act_on_mute ();
 155
 156 private:
 157         MidiRingBuffer<framepos_t> _immediate_events;
 158         MidiRingBuffer<framepos_t> _step_edit_ring_buffer;
 159         NoteMode                   _note_mode;
 160         bool                       _step_editing;
 161         bool                       _input_active;
 162         uint32_t                   _playback_channel_mask; // 16 bits mode, 16 bits mask
 163         uint32_t                   _capture_channel_mask; // 16 bits mode, 16 bits mask
 164
 165         virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &);
 166
 167         boost::shared_ptr<MidiDiskstream> midi_diskstream () const;
 168
 169         void write_out_of_band_data (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, framecnt_t nframes);
 170
 171         void set_state_part_two ();
 172         void set_state_part_three ();
 173
 174
 175         int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool state_changing);
 176         void push_midi_input_to_step_edit_ringbuffer (framecnt_t nframes);
 177
 178         void diskstream_data_recorded (boost::weak_ptr<MidiSource>);
 179         PBD::ScopedConnection _diskstream_data_recorded_connection;
 180
 181         void track_input_active (IOChange, void*);
 182         void map_input_active (bool);
 183
 184         void filter_channels (BufferSet& bufs, ChannelMode mode, uint32_t mask);
 185
 186 /* if mode is ForceChannel, force mask to the lowest set channel or 1 if no
 187  * channels are set.
 188  */
 189 #define force_mask(mode,mask) (((mode) == ForceChannel) ? (((mask) ? (1<<(PBD::ffs((mask))-1)) : 1)) : mask)
 190
 191         void _set_playback_channel_mode(ChannelMode mode, uint16_t mask) {
 192                 mask = force_mask (mode, mask);
 193                 g_atomic_int_set(&_playback_channel_mask, (uint32_t(mode) << 16) | uint32_t(mask));
 194         }
 195         void _set_playback_channel_mask (uint16_t mask) {
 196                 mask = force_mask (get_playback_channel_mode(), mask);
 197                 g_atomic_int_set(&_playback_channel_mask, (uint32_t(get_playback_channel_mode()) << 16) | uint32_t(mask));
 198         }
 199         void _set_capture_channel_mode(ChannelMode mode, uint16_t mask) {
 200                 mask = force_mask (mode, mask);
 201                 g_atomic_int_set(&_capture_channel_mask, (uint32_t(mode) << 16) | uint32_t(mask));
 202         }
 203         void _set_capture_channel_mask (uint16_t mask) {
 204                 mask = force_mask (get_capture_channel_mode(), mask);
 205                 g_atomic_int_set(&_capture_channel_mask, (uint32_t(get_capture_channel_mode()) << 16) | uint32_t(mask));
 206         }
 207
 208 #undef force_mask
 209 };
 210
 211 } /* namespace ARDOUR*/
 212
 213 #endif /* __ardour_midi_track_h__ */