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/Beats.hpp"
  27
  28 #include "ardour/ardour.h"
  29 #include "ardour/region.h"
  30
  31 class XMLNode;
  32
  33 namespace ARDOUR {
  34         namespace Properties {
  35                 LIBARDOUR_API extern PBD::PropertyDescriptor<Evoral::Beats> start_beats;
  36                 LIBARDOUR_API extern PBD::PropertyDescriptor<Evoral::Beats> length_beats;
  37                 LIBARDOUR_API extern PBD::PropertyDescriptor<double> start_pulse;
  38                 LIBARDOUR_API extern PBD::PropertyDescriptor<double> length_pulse;
  39         }
  40 }
  41
  42 namespace Evoral {
  43 template<typename Time> class EventSink;
  44 }
  45
  46 namespace ARDOUR {
  47
  48 class MidiChannelFilter;
  49 class MidiFilter;
  50 class MidiModel;
  51 class MidiSource;
  52 class MidiStateTracker;
  53 class Playlist;
  54 class Route;
  55 class Session;
  56
  57 template<typename T> class MidiRingBuffer;
  58
  59 class LIBARDOUR_API MidiRegion : public Region
  60 {
  61   public:
  62         static void make_property_quarks ();
  63
  64         ~MidiRegion();
  65
  66         bool do_export (std::string path) const;
  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,
  83                             MidiChannelFilter* filter = 0) const;
  84
  85         framecnt_t master_read_at (MidiRingBuffer<framepos_t>& dst,
  86                                    framepos_t position,
  87                                    framecnt_t dur,
  88                                    uint32_t  chan_n = 0,
  89                                    NoteMode  mode = Sustained) const;
  90
  91         XMLNode& state ();
  92         int      set_state (const XMLNode&, int version);
  93
  94         int separate_by_channel (ARDOUR::Session&, std::vector< boost::shared_ptr<Region> >&) const;
  95
  96         /* automation */
  97
  98         boost::shared_ptr<Evoral::Control> control(const Evoral::Parameter& id, bool create=false);
  99
 100         virtual boost::shared_ptr<const Evoral::Control> control(const Evoral::Parameter& id) const;
 101
 102         /* export */
 103
 104         boost::shared_ptr<MidiModel> model();
 105         boost::shared_ptr<const MidiModel> model() const;
 106
 107         void fix_negative_start ();
 108         Evoral::Beats start_beats () {return _start_beats.val(); }
 109         Evoral::Beats length_beats () {return _length_beats.val(); }
 110         double start_pulse () const {return _start_pulse; }
 111         double length_pulse () const {return _length_pulse; }
 112   protected:
 113
 114         virtual bool can_trim_start_before_source_start () const {
 115                 return true;
 116         }
 117
 118   private:
 119         friend class RegionFactory;
 120         PBD::Property<Evoral::Beats> _start_beats;
 121         PBD::Property<Evoral::Beats> _length_beats;
 122         PBD::Property<double> _start_pulse;
 123         PBD::Property<double> _length_pulse;
 124
 125         MidiRegion (const SourceList&);
 126         MidiRegion (boost::shared_ptr<const MidiRegion>);
 127         MidiRegion (boost::shared_ptr<const MidiRegion>, frameoffset_t offset, const int32_t sub_num = 0);
 128
 129         framecnt_t _read_at (const SourceList&, Evoral::EventSink<framepos_t>& dst,
 130                              framepos_t position,
 131                              framecnt_t dur,
 132                              uint32_t chan_n = 0,
 133                              NoteMode mode = Sustained,
 134                              MidiStateTracker* tracker = 0,
 135                              MidiChannelFilter* filter = 0) const;
 136
 137         void register_properties ();
 138         void post_set (const PBD::PropertyChange&);
 139
 140         void recompute_at_start ();
 141         void recompute_at_end ();
 142
 143         void set_position_internal (framepos_t pos, bool allow_bbt_recompute, const int32_t sub_num);
 144         void set_length_internal (framecnt_t len, const int32_t sub_num);
 145         void set_start_internal (framecnt_t, const int32_t sub_num);
 146         void trim_to_internal (framepos_t position, framecnt_t length, const int32_t sub_num);
 147         void update_length_beats (const int32_t sub_num);
 148
 149         void model_changed ();
 150         void model_automation_state_changed (Evoral::Parameter const &);
 151
 152         void set_start_beats_from_start_frames ();
 153         void update_after_tempo_map_change (bool send_change = true);
 154
 155         std::set<Evoral::Parameter> _filtered_parameters; ///< parameters that we ask our source not to return when reading
 156         PBD::ScopedConnection _model_connection;
 157         PBD::ScopedConnection _source_connection;
 158         PBD::ScopedConnection _model_contents_connection;
 159
 160         double _last_length_beats;
 161 };
 162
 163 } /* namespace ARDOUR */
 164
 165
 166 #endif /* __ardour_midi_region_h__ */