libs/ardour/ardour/midi_region.h

   1 /*
   2     Copyright (C) 2000-2006 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: midiregion.h 733 2006-08-01 17:19:38Z drobilla $
  19 */
  20
  21 #ifndef __ardour_midi_region_h__
  22 #define __ardour_midi_region_h__
  23
  24 #include <vector>
  25
  26 #include "pbd/fastlog.h"
  27 #include "pbd/undo.h"
  28
  29 #include "ardour/ardour.h"
  30 #include "ardour/gain.h"
  31 #include "ardour/logcurve.h"
  32 #include "ardour/midi_model.h"
  33 #include "ardour/midi_source.h"
  34 #include "ardour/region.h"
  35
  36 class XMLNode;
  37
  38 namespace ARDOUR {
  39
  40 class Route;
  41 class Playlist;
  42 class Session;
  43 class MidiFilter;
  44 class MidiSource;
  45 template<typename T> class MidiRingBuffer;
  46
  47 class MidiRegion : public Region
  48 {
  49   public:
  50         ~MidiRegion();
  51
  52         boost::shared_ptr<MidiSource> midi_source (uint32_t n=0) const;
  53
  54         /* Stub Readable interface */
  55         virtual nframes_t read (Sample*, sframes_t /*pos*/, nframes_t /*cnt*/, int /*channel*/) const { return 0; }
  56         virtual sframes_t readable_length() const { return length(); }
  57
  58         nframes_t read_at (MidiRingBuffer<nframes_t>& dst,
  59                         sframes_t position,
  60                         nframes_t dur,
  61                         uint32_t  chan_n = 0,
  62                         NoteMode  mode = Sustained) const;
  63
  64         nframes_t master_read_at (MidiRingBuffer<nframes_t>& dst,
  65                         sframes_t position,
  66                         nframes_t dur,
  67                         uint32_t  chan_n = 0,
  68                         NoteMode  mode = Sustained) const;
  69
  70         XMLNode& state (bool);
  71         int      set_state (const XMLNode&);
  72
  73         int separate_by_channel (ARDOUR::Session&, std::vector< boost::shared_ptr<Region> >&) const;
  74
  75         /* automation */
  76
  77         boost::shared_ptr<Evoral::Control>
  78         control(const Evoral::Parameter& id, bool create=false) {
  79                 return model()->data().control(id, create);
  80         }
  81
  82         virtual boost::shared_ptr<const Evoral::Control>
  83         control(const Evoral::Parameter& id) const {
  84                 return model()->data().control(id);
  85         }
  86
  87         /* export */
  88
  89         int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
  90
  91         boost::shared_ptr<MidiModel> model()             { return midi_source()->model(); }
  92         boost::shared_ptr<const MidiModel> model() const { return midi_source()->model(); }
  93
  94   private:
  95         friend class RegionFactory;
  96
  97         MidiRegion (boost::shared_ptr<MidiSource>, nframes_t start, nframes_t length);
  98         MidiRegion (boost::shared_ptr<MidiSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
  99         MidiRegion (const SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 100         MidiRegion (boost::shared_ptr<const MidiRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 101         MidiRegion (boost::shared_ptr<const MidiRegion>);
 102         MidiRegion (boost::shared_ptr<MidiSource>, const XMLNode&);
 103         MidiRegion (const SourceList &, const XMLNode&);
 104
 105   private:
 106         nframes_t _read_at (const SourceList&, MidiRingBuffer<nframes_t>& dst,
 107                             nframes_t position,
 108                             nframes_t dur,
 109                             uint32_t chan_n = 0,
 110                                 NoteMode mode = Sustained) const;
 111
 112         void recompute_at_start ();
 113         void recompute_at_end ();
 114
 115         void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
 116
 117         void switch_source(boost::shared_ptr<Source> source);
 118
 119   protected:
 120
 121         int set_live_state (const XMLNode&, Change&, bool send);
 122 };
 123
 124 } /* namespace ARDOUR */
 125
 126
 127 #endif /* __ardour_midi_region_h__ */