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