libs/ardour/ardour/midi_diskstream.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18     $Id: diskstream.h 579 2006-06-12 19:56:37Z essej $
  19 */
  20
  21 #ifndef __ardour_midi_diskstream_h__
  22 #define __ardour_midi_diskstream_h__
  23
  24
  25 #include <cmath>
  26 #include <cassert>
  27 #include <string>
  28 #include <queue>
  29 #include <map>
  30 #include <vector>
  31
  32 #include <time.h>
  33
  34 #include "pbd/fastlog.h"
  35 #include "pbd/ringbufferNPT.h"
  36
  37 #include "ardour/ardour.h"
  38 #include "ardour/diskstream.h"
  39 #include "ardour/midi_playlist.h"
  40 #include "ardour/midi_ring_buffer.h"
  41 #include "ardour/utils.h"
  42
  43 struct tm;
  44
  45 namespace ARDOUR {
  46
  47 class IO;
  48 class MidiEngine;
  49 class MidiPort;
  50 class MidiRingbuffer;
  51 class SMFSource;
  52 class Send;
  53 class Session;
  54
  55 class MidiDiskstream : public Diskstream
  56 {
  57   public:
  58         MidiDiskstream (Session &, const string& name, Diskstream::Flag f = Recordable);
  59         MidiDiskstream (Session &, const XMLNode&);
  60         ~MidiDiskstream();
  61
  62         float playback_buffer_load() const;
  63         float capture_buffer_load() const;
  64
  65         void get_playback(MidiBuffer& dst, framepos_t start, framepos_t end);
  66
  67         void set_record_enabled (bool yn);
  68
  69         boost::shared_ptr<MidiPlaylist> midi_playlist () { return boost::dynamic_pointer_cast<MidiPlaylist>(_playlist); }
  70
  71         int use_playlist (boost::shared_ptr<Playlist>);
  72         int use_new_playlist ();
  73         int use_copy_playlist ();
  74
  75         /* stateful */
  76         XMLNode& get_state(void);
  77         int set_state(const XMLNode&, int version);
  78
  79         void monitor_input (bool);
  80
  81         boost::shared_ptr<SMFSource> write_source ()    { return _write_source; }
  82
  83         int set_destructive (bool yn); // doom!
  84
  85         void set_note_mode (NoteMode m);
  86
  87         uint16_t get_channel_mask() {
  88                 uint16_t playback_mask = _playback_buf->get_channel_mask();
  89 #ifndef NDEBUG
  90                 uint16_t capture_mask  = _capture_buf->get_channel_mask();
  91                 assert(playback_mask == capture_mask);
  92 #endif
  93                 return playback_mask;
  94         }
  95
  96         void set_channel_mode(ChannelMode mode, uint16_t mask) {
  97                 _playback_buf->set_channel_mode(mode, mask);
  98                 _capture_buf->set_channel_mode(mode, mask);
  99         }
 100
 101         ChannelMode get_channel_mode() {
 102                 ChannelMode playback_mode = _playback_buf->get_channel_mode();
 103 #ifndef NDEBUG
 104                 ChannelMode capture_mode  = _capture_buf->get_channel_mode();
 105                 assert(playback_mode == capture_mode);
 106 #endif
 107                 return playback_mode;
 108         }
 109
 110         /** Emitted when some MIDI data has been received for recording.
 111          *  First parameter is the data.
 112          *  Second parameter is the source that it is destined for.
 113          */
 114         PBD::Signal2<void, boost::shared_ptr<MidiBuffer>, boost::weak_ptr<MidiSource> > DataRecorded;
 115
 116   protected:
 117         friend class Session;
 118         friend class Butler;
 119
 120         /* the Session is the only point of access for these
 121            because they require that the Session is "inactive"
 122            while they are called.
 123         */
 124
 125         void set_pending_overwrite(bool);
 126         int  overwrite_existing_buffers ();
 127         void set_block_size (pframes_t);
 128         int  internal_playback_seek (framecnt_t distance);
 129         int  can_internal_playback_seek (framecnt_t distance);
 130         int  rename_write_sources ();
 131         std::list<boost::shared_ptr<Source> > steal_write_sources();
 132         void reset_write_sources (bool, bool force = false);
 133         void non_realtime_input_change ();
 134         void non_realtime_locate (framepos_t location);
 135
 136         static void set_readahead_frames (framecnt_t frames_ahead) { midi_readahead = frames_ahead; }
 137
 138   protected:
 139         int seek (framepos_t which_sample, bool complete_refill = false);
 140
 141   protected:
 142         friend class MidiTrack;
 143
 144         int  process (framepos_t transport_frame, pframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler);
 145         bool commit  (framecnt_t nframes);
 146         static framecnt_t midi_readahead;
 147
 148   private:
 149
 150         /* The two central butler operations */
 151         int do_flush (RunContext context, bool force = false);
 152         int do_refill ();
 153
 154         int do_refill_with_alloc();
 155
 156         int read (framepos_t& start, framecnt_t cnt, bool reversed);
 157
 158         void finish_capture (bool rec_monitors_input);
 159         void transport_stopped_wallclock (struct tm&, time_t, bool abort);
 160         void transport_looped (framepos_t transport_frame);
 161
 162         void init ();
 163
 164         int use_new_write_source (uint32_t n=0);
 165
 166         int find_and_use_playlist (const string&);
 167
 168         void allocate_temporary_buffers ();
 169
 170         int use_pending_capture_data (XMLNode& node);
 171
 172         void get_input_sources ();
 173         void set_align_style_from_io();
 174
 175         /* fixed size buffers per instance of ardour for now (non-dynamic)
 176          */
 177
 178         void adjust_playback_buffering () {}
 179         void adjust_capture_buffering () {}
 180
 181         void engage_record_enable ();
 182         void disengage_record_enable ();
 183
 184         MidiRingBuffer<framepos_t>*  _playback_buf;
 185         MidiRingBuffer<framepos_t>*  _capture_buf;
 186         MidiPort*                    _source_port;
 187         boost::shared_ptr<SMFSource> _write_source;
 188         framepos_t                   _last_flush_frame;
 189         NoteMode                     _note_mode;
 190         volatile gint                _frames_written_to_ringbuffer;
 191         volatile gint                _frames_read_from_ringbuffer;
 192 };
 193
 194 }; /* namespace ARDOUR */
 195
 196 #endif /* __ardour_midi_diskstream_h__ */