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 "ardour/ardour.h"
  27 #include "ardour/region.h"
  28
  29 class XMLNode;
  30
  31 namespace ARDOUR {
  32         namespace Properties {
  33                 /* this is pseudo-property: nothing has this as an actual
  34                    property, but it allows us to signal changes to the
  35                    MidiModel used by the MidiRegion
  36                 */
  37                 extern PBD::PropertyDescriptor<void*> midi_data;
  38                 extern PBD::PropertyDescriptor<Evoral::MusicalTime> length_beats;
  39         }
  40 }
  41
  42 namespace Evoral {
  43 template<typename Time> class EventSink;
  44 }
  45
  46 namespace ARDOUR {
  47
  48 class Route;
  49 class Playlist;
  50 class Session;
  51 class MidiFilter;
  52 class MidiModel;
  53 class MidiSource;
  54 class MidiStateTracker;
  55 template<typename T> class MidiRingBuffer;
  56
  57 class MidiRegion : public Region
  58 {
  59   public:
  60         static void make_property_quarks ();
  61
  62         ~MidiRegion();
  63
  64         boost::shared_ptr<MidiRegion> clone () const;
  65
  66         boost::shared_ptr<MidiSource> midi_source (uint32_t n=0) const;
  67
  68         /* Stub Readable interface */
  69         virtual framecnt_t read (Sample*, framepos_t /*pos*/, framecnt_t /*cnt*/, int /*channel*/) const { return 0; }
  70         virtual framecnt_t readable_length() const { return length(); }
  71
  72         framecnt_t read_at (Evoral::EventSink<framepos_t>& dst,
  73                             framepos_t position,
  74                             framecnt_t dur,
  75                             uint32_t  chan_n = 0,
  76                             NoteMode  mode = Sustained,
  77                             MidiStateTracker* tracker = 0) const;
  78
  79         framepos_t master_read_at (MidiRingBuffer<framepos_t>& dst,
  80                                    framepos_t position,
  81                                    framecnt_t dur,
  82                                    uint32_t  chan_n = 0,
  83                                    NoteMode  mode = Sustained) const;
  84
  85         XMLNode& state ();
  86         int      set_state (const XMLNode&, int version);
  87
  88         int separate_by_channel (ARDOUR::Session&, std::vector< boost::shared_ptr<Region> >&) const;
  89
  90         /* automation */
  91
  92         boost::shared_ptr<Evoral::Control> control(const Evoral::Parameter& id, bool create=false);
  93
  94         virtual boost::shared_ptr<const Evoral::Control> control(const Evoral::Parameter& id) const;
  95
  96         /* export */
  97
  98         int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
  99
 100         boost::shared_ptr<MidiModel> model();
 101         boost::shared_ptr<const MidiModel> model() const;
 102
 103         void fix_negative_start ();
 104         void transpose (int);
 105
 106   protected:
 107
 108         virtual bool can_trim_start_before_source_start () const {
 109                 return true;
 110         }
 111
 112   private:
 113         friend class RegionFactory;
 114         PBD::Property<Evoral::MusicalTime> _length_beats;
 115
 116         MidiRegion (const SourceList&);
 117         MidiRegion (boost::shared_ptr<const MidiRegion>);
 118         MidiRegion (boost::shared_ptr<const MidiRegion>, frameoffset_t offset);
 119
 120         framecnt_t _read_at (const SourceList&, Evoral::EventSink<framepos_t>& dst,
 121                              framepos_t position,
 122                              framecnt_t dur,
 123                              uint32_t chan_n = 0,
 124                              NoteMode mode = Sustained,
 125                              MidiStateTracker* tracker = 0) const;
 126
 127         void register_properties ();
 128         void post_set (const PBD::PropertyChange&);
 129
 130         void recompute_at_start ();
 131         void recompute_at_end ();
 132
 133         void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
 134         void set_length_internal (framecnt_t len);
 135         void update_length_beats ();
 136
 137         void model_changed ();
 138         void model_automation_state_changed (Evoral::Parameter const &);
 139         void model_contents_changed ();
 140
 141         std::set<Evoral::Parameter> _filtered_parameters; ///< parameters that we ask our source not to return when reading
 142         PBD::ScopedConnection _model_connection;
 143         PBD::ScopedConnection _source_connection;
 144         PBD::ScopedConnection _model_contents_connection;
 145
 146         double _last_length_beats;
 147 };
 148
 149 } /* namespace ARDOUR */
 150
 151
 152 #endif /* __ardour_midi_region_h__ */