libs/ardour/ardour/midi_playlist.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_midi_playlist_h__
  21 #define __ardour_midi_playlist_h__
  22
  23 #include <vector>
  24 #include <list>
  25
  26 #include <boost/utility.hpp>
  27
  28 #include "ardour/ardour.h"
  29 #include "ardour/midi_model.h"
  30 #include "ardour/midi_state_tracker.h"
  31 #include "ardour/note_fixer.h"
  32 #include "ardour/playlist.h"
  33 #include "evoral/Note.hpp"
  34 #include "evoral/Parameter.hpp"
  35
  36 namespace Evoral {
  37 template<typename Time> class EventSink;
  38 class                         Beats;
  39 }
  40
  41 namespace ARDOUR
  42 {
  43
  44 class BeatsFramesConverter;
  45 class MidiChannelFilter;
  46 class MidiRegion;
  47 class Session;
  48 class Source;
  49
  50 template<typename T> class MidiRingBuffer;
  51
  52 class LIBARDOUR_API MidiPlaylist : public ARDOUR::Playlist
  53 {
  54 public:
  55         MidiPlaylist (Session&, const XMLNode&, bool hidden = false);
  56         MidiPlaylist (Session&, std::string name, bool hidden = false);
  57         MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, std::string name, bool hidden = false);
  58
  59         /** This constructor does NOT notify others (session) */
  60         MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
  61                       framepos_t                            start,
  62                       framecnt_t                            cnt,
  63                       std::string                           name,
  64                       bool                                  hidden = false);
  65
  66         ~MidiPlaylist ();
  67
  68         /** Read a range from the playlist into an event sink.
  69          *
  70          * @param buf Destination for events.
  71          * @param start First frame of read range.
  72          * @param cnt Number of frames in read range.
  73          * @param chan_n Must be 0 (this is the audio-style "channel", where each
  74          * channel is backed by a separate region, not MIDI channels, which all
  75          * exist in the same region and are not handled here).
  76          * @return The number of frames read (time, not an event count).
  77          */
  78         framecnt_t read (Evoral::EventSink<framepos_t>& buf,
  79                          framepos_t                     start,
  80                          framecnt_t                     cnt,
  81                          uint32_t                       chan_n = 0,
  82                          MidiChannelFilter*             filter = NULL);
  83
  84         int set_state (const XMLNode&, int version);
  85
  86         bool destroy_region (boost::shared_ptr<Region>);
  87
  88         void set_note_mode (NoteMode m) { _note_mode = m; }
  89
  90         std::set<Evoral::Parameter> contained_automation();
  91
  92         /** Handle a region edit during read.
  93          *
  94          * This must be called before the command is applied to the model.  Events
  95          * are injected into the playlist output to compensate for edits to active
  96          * notes and maintain coherent output and tracker state.
  97          */
  98         void region_edited(boost::shared_ptr<Region>         region,
  99                            const MidiModel::NoteDiffCommand* cmd);
 100
 101         /** Clear all note trackers. */
 102         void reset_note_trackers ();
 103
 104         /** Resolve all pending notes and clear all note trackers.
 105          *
 106          * @param dst Sink to write note offs to.
 107          * @param time Time stamp of all written note offs.
 108          */
 109         void resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time);
 110
 111 protected:
 112         void remove_dependents (boost::shared_ptr<Region> region);
 113
 114 private:
 115         typedef Evoral::Note<Evoral::Beats> Note;
 116         typedef Evoral::Event<framepos_t>   Event;
 117
 118         struct RegionTracker : public boost::noncopyable {
 119                 MidiStateTracker tracker;  ///< Active note tracker
 120                 NoteFixer        fixer;    ///< Edit compensation
 121         };
 122
 123         typedef std::map< Region*, boost::shared_ptr<RegionTracker> > NoteTrackers;
 124
 125         void dump () const;
 126
 127         NoteTrackers _note_trackers;
 128         NoteMode     _note_mode;
 129         framepos_t   _read_end;
 130 };
 131
 132 } /* namespace ARDOUR */
 133
 134 #endif  /* __ardour_midi_playlist_h__ */
 135
 136