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, framecnt_t);
  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         bool set_name (std::string const &);
  76
  77         /* stateful */
  78         XMLNode& get_state(void);
  79         int set_state(const XMLNode&, int version);
  80
  81         void monitor_input (bool);
  82
  83         boost::shared_ptr<SMFSource> write_source ()    { return _write_source; }
  84
  85         int set_destructive (bool yn); // doom!
  86
  87         void set_note_mode (NoteMode m);
  88
  89         uint16_t get_channel_mask() {
  90                 uint16_t playback_mask = _playback_buf->get_channel_mask();
  91 #ifndef NDEBUG
  92                 uint16_t capture_mask  = _capture_buf->get_channel_mask();
  93                 assert(playback_mask == capture_mask);
  94 #endif
  95                 return playback_mask;
  96         }
  97
  98         void set_channel_mode(ChannelMode mode, uint16_t mask) {
  99                 _playback_buf->set_channel_mode(mode, mask);
 100                 _capture_buf->set_channel_mode(mode, mask);
 101         }
 102
 103         ChannelMode get_channel_mode() {
 104                 ChannelMode playback_mode = _playback_buf->get_channel_mode();
 105 #ifndef NDEBUG
 106                 ChannelMode capture_mode  = _capture_buf->get_channel_mode();
 107                 assert(playback_mode == capture_mode);
 108 #endif
 109                 return playback_mode;
 110         }
 111
 112         /** Emitted when some MIDI data has been received for recording.
 113          *  Parameter is the source that it is destined for.
 114          *  A caller can get a copy of the data with get_gui_feed_buffer ()
 115          */
 116         PBD::Signal1<void, boost::weak_ptr<MidiSource> > DataRecorded;
 117
 118         boost::shared_ptr<MidiBuffer> get_gui_feed_buffer () const;
 119
 120   protected:
 121         friend class Session;
 122         friend class Butler;
 123
 124         /* the Session is the only point of access for these
 125            because they require that the Session is "inactive"
 126            while they are called.
 127         */
 128
 129         void set_pending_overwrite(bool);
 130         int  overwrite_existing_buffers ();
 131         void set_block_size (pframes_t);
 132         int  internal_playback_seek (framecnt_t distance);
 133         int  can_internal_playback_seek (framecnt_t distance);
 134         std::list<boost::shared_ptr<Source> > steal_write_sources();
 135         void reset_write_sources (bool, bool force = false);
 136         void non_realtime_input_change ();
 137         void non_realtime_locate (framepos_t location);
 138
 139         static void set_readahead_frames (framecnt_t frames_ahead) { midi_readahead = frames_ahead; }
 140
 141   protected:
 142         int seek (framepos_t which_sample, bool complete_refill = false);
 143
 144   protected:
 145         friend class MidiTrack;
 146
 147         int  process (framepos_t transport_frame, pframes_t nframes, framecnt_t &);
 148         bool commit  (framecnt_t nframes);
 149         static framecnt_t midi_readahead;
 150
 151   private:
 152
 153         /* The two central butler operations */
 154         int do_flush (RunContext context, bool force = false);
 155         int do_refill ();
 156
 157         int do_refill_with_alloc();
 158
 159         int read (framepos_t& start, framecnt_t cnt, bool reversed);
 160
 161         void finish_capture ();
 162         void transport_stopped_wallclock (struct tm&, time_t, bool abort);
 163         void transport_looped (framepos_t transport_frame);
 164
 165         void init ();
 166
 167         int use_new_write_source (uint32_t n=0);
 168
 169         int find_and_use_playlist (const string&);
 170
 171         void allocate_temporary_buffers ();
 172
 173         int use_pending_capture_data (XMLNode& node);
 174
 175         void get_input_sources ();
 176         void set_align_style_from_io();
 177
 178         /* fixed size buffers per instance of ardour for now (non-dynamic)
 179          */
 180
 181         void adjust_playback_buffering () {}
 182         void adjust_capture_buffering () {}
 183
 184         void engage_record_enable ();
 185         void disengage_record_enable ();
 186
 187         MidiRingBuffer<framepos_t>*  _playback_buf;
 188         MidiRingBuffer<framepos_t>*  _capture_buf;
 189         boost::weak_ptr<MidiPort>    _source_port;
 190         boost::shared_ptr<SMFSource> _write_source;
 191         NoteMode                     _note_mode;
 192         volatile gint                _frames_written_to_ringbuffer;
 193         volatile gint                _frames_read_from_ringbuffer;
 194
 195         /** A buffer that we use to put newly-arrived MIDI data in for
 196             the GUI to read (so that it can update itself).
 197         */
 198         MidiBuffer                   _gui_feed_buffer;
 199         mutable Glib::Mutex          _gui_feed_buffer_mutex;
 200 };
 201
 202 }; /* namespace ARDOUR */
 203
 204 #endif /* __ardour_midi_diskstream_h__ */