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 #include <sigc++/signal.h>
  25
  26 #include <cmath>
  27 #include <cassert>
  28 #include <string>
  29 #include <queue>
  30 #include <map>
  31 #include <vector>
  32
  33 #include <time.h>
  34
  35 #include "pbd/fastlog.h"
  36 #include "pbd/ringbufferNPT.h"
  37
  38 #include "ardour/ardour.h"
  39 #include "ardour/diskstream.h"
  40 #include "ardour/midi_playlist.h"
  41 #include "ardour/midi_ring_buffer.h"
  42 #include "ardour/utils.h"
  43
  44 struct tm;
  45
  46 namespace ARDOUR {
  47
  48 class IO;
  49 class MidiEngine;
  50 class MidiPort;
  51 class MidiRingbuffer;
  52 class SMFSource;
  53 class Send;
  54 class Session;
  55
  56 class MidiDiskstream : public Diskstream
  57 {
  58   public:
  59         MidiDiskstream (Session &, const string& name, Diskstream::Flag f = Recordable);
  60         MidiDiskstream (Session &, const XMLNode&);
  61         ~MidiDiskstream();
  62
  63         float playback_buffer_load() const;
  64         float capture_buffer_load() const;
  65
  66         void get_playback(MidiBuffer& dst, nframes_t start, nframes_t end);
  67
  68         void set_record_enabled (bool yn);
  69
  70         boost::shared_ptr<MidiPlaylist> midi_playlist () { return boost::dynamic_pointer_cast<MidiPlaylist>(_playlist); }
  71
  72         int use_playlist (boost::shared_ptr<Playlist>);
  73         int use_new_playlist ();
  74         int use_copy_playlist ();
  75
  76         /* stateful */
  77         XMLNode& get_state(void);
  78         int set_state(const XMLNode&, int version);
  79
  80         void monitor_input (bool);
  81
  82         MidiRingBuffer<nframes_t>*   playback_buffer () { return _playback_buf; }
  83         MidiRingBuffer<nframes_t>*   capture_buffer ()  { return _capture_buf; }
  84         boost::shared_ptr<SMFSource> write_source ()    { return _write_source; }
  85
  86         int set_destructive (bool yn); // doom!
  87
  88         void set_note_mode (NoteMode m);
  89
  90         uint16_t get_channel_mask() {
  91                 uint16_t playback_mask = _playback_buf->get_channel_mask();
  92 #ifndef NDEBUG
  93                 uint16_t capture_mask  = _capture_buf->get_channel_mask();
  94                 assert(playback_mask == capture_mask);
  95 #endif
  96                 return playback_mask;
  97         }
  98
  99         void set_channel_mode(ChannelMode mode, uint16_t mask) {
 100                 _playback_buf->set_channel_mode(mode, mask);
 101                 _capture_buf->set_channel_mode(mode, mask);
 102         }
 103
 104         ChannelMode get_channel_mode() {
 105                 ChannelMode playback_mode = _playback_buf->get_channel_mode();
 106 #ifndef NDEBUG
 107                 ChannelMode capture_mode  = _capture_buf->get_channel_mode();
 108                 assert(playback_mode == capture_mode);
 109 #endif
 110                 return playback_mode;
 111         }
 112
 113   protected:
 114         friend class Session;
 115         friend class Butler;
 116
 117         /* the Session is the only point of access for these
 118            because they require that the Session is "inactive"
 119            while they are called.
 120         */
 121
 122         void set_pending_overwrite(bool);
 123         int  overwrite_existing_buffers ();
 124         void set_block_size (nframes_t);
 125         int  internal_playback_seek (nframes_t distance);
 126         int  can_internal_playback_seek (nframes_t distance);
 127         int  rename_write_sources ();
 128         void reset_write_sources (bool, bool force = false);
 129         void non_realtime_input_change ();
 130         void non_realtime_locate (nframes_t location);
 131
 132         static void set_readahead_frames(nframes_t frames_ahead) { midi_readahead = frames_ahead; }
 133
 134   protected:
 135         int seek (nframes_t which_sample, bool complete_refill = false);
 136
 137   protected:
 138         friend class MidiTrack;
 139
 140         int  process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input);
 141         bool commit  (nframes_t nframes);
 142         static nframes_t midi_readahead;
 143
 144   private:
 145
 146         /* The two central butler operations */
 147         int do_flush (RunContext context, bool force = false);
 148         int do_refill ();
 149
 150         int do_refill_with_alloc();
 151
 152         int read (nframes_t& start, nframes_t cnt, bool reversed);
 153
 154         void finish_capture (bool rec_monitors_input);
 155         void transport_stopped (struct tm&, time_t, bool abort);
 156         void transport_looped (nframes_t transport_frame);
 157
 158         void init (Diskstream::Flag);
 159
 160         int use_new_write_source (uint32_t n=0);
 161
 162         int find_and_use_playlist (const string&);
 163
 164         void allocate_temporary_buffers ();
 165
 166         int use_pending_capture_data (XMLNode& node);
 167
 168         void get_input_sources ();
 169         void set_align_style_from_io();
 170
 171         void engage_record_enable ();
 172         void disengage_record_enable ();
 173
 174         MidiRingBuffer<nframes_t>*   _playback_buf;
 175         MidiRingBuffer<nframes_t>*   _capture_buf;
 176         MidiPort*                    _source_port;
 177         boost::shared_ptr<SMFSource> _write_source;
 178         nframes_t                    _last_flush_frame;
 179         NoteMode                     _note_mode;
 180         volatile gint                _frames_written_to_ringbuffer;
 181         volatile gint                _frames_read_from_ringbuffer;
 182 };
 183
 184 }; /* namespace ARDOUR */
 185
 186 #endif /* __ardour_midi_diskstream_h__ */