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/region.h>
  31 #include <ardour/gain.h>
  32 #include <ardour/logcurve.h>
  33 #include <ardour/midi_source.h>
  34
  35 class XMLNode;
  36
  37 using std::vector;
  38
  39 namespace ARDOUR {
  40
  41 class Route;
  42 class Playlist;
  43 class Session;
  44 class MidiFilter;
  45 class MidiSource;
  46 class MidiRingBuffer;
  47
  48 class MidiRegion : public Region
  49 {
  50   public:
  51         ~MidiRegion();
  52
  53         boost::shared_ptr<MidiSource> midi_source (uint32_t n=0) const;
  54
  55         /* Stub Readable interface */
  56         virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const { return 0; }
  57         virtual nframes64_t readable_length() const { return length(); }
  58
  59         nframes_t read_at (MidiRingBuffer& dst,
  60                            nframes_t position,
  61                            nframes_t dur,
  62                            uint32_t  chan_n = 0,
  63                            NoteMode  mode = Sustained) const;
  64
  65         nframes_t master_read_at (MidiRingBuffer& dst,
  66                         nframes_t position,
  67                         nframes_t dur,
  68                         uint32_t  chan_n = 0,
  69                         NoteMode  mode = Sustained) const;
  70
  71         XMLNode& state (bool);
  72         int      set_state (const XMLNode&);
  73
  74         int separate_by_channel (ARDOUR::Session&, vector<MidiRegion*>&) const;
  75
  76         UndoAction get_memento() const;
  77
  78         // Act as a proxy for MidiModel automation stuff (for CC)
  79         // Yep, this is pretty ugly...
  80         Controls&       controls()       { return midi_source()->model()->controls(); }
  81         const Controls& controls() const { return midi_source()->model()->controls(); }
  82
  83         boost::shared_ptr<Evoral::Control> control(const Evoral::Parameter& id, bool create=false)
  84                         { return midi_source()->model()->control(id, create); }
  85
  86         boost::shared_ptr<const Evoral::Control> control(const Evoral::Parameter& id) const
  87                         { return midi_source()->model()->control(id); }
  88
  89         int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
  90
  91   private:
  92         friend class RegionFactory;
  93
  94         MidiRegion (boost::shared_ptr<MidiSource>, nframes_t start, nframes_t length);
  95         MidiRegion (boost::shared_ptr<MidiSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
  96         MidiRegion (const SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
  97         MidiRegion (boost::shared_ptr<const MidiRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
  98         MidiRegion (boost::shared_ptr<const MidiRegion>);
  99         MidiRegion (boost::shared_ptr<MidiSource>, const XMLNode&);
 100         MidiRegion (const SourceList &, const XMLNode&);
 101
 102   private:
 103         nframes_t _read_at (const SourceList&, MidiRingBuffer& dst,
 104                             nframes_t position,
 105                             nframes_t dur,
 106                             uint32_t chan_n = 0,
 107                                 NoteMode mode = Sustained) const;
 108
 109         void recompute_at_start ();
 110         void recompute_at_end ();
 111
 112         void switch_source(boost::shared_ptr<Source> source);
 113
 114   protected:
 115
 116         int set_live_state (const XMLNode&, Change&, bool send);
 117 };
 118
 119 } /* namespace ARDOUR */
 120
 121
 122 #endif /* __ardour_midi_region_h__ */