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