libs/ardour/ardour/midi_model.h

   1 /*
   2     Copyright (C) 2007 Paul Davis
   3     Author: Dave 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
  21 #ifndef __ardour_midi_model_h__
  22 #define __ardour_midi_model_h__
  23
  24 #include <queue>
  25 #include <deque>
  26 #include <utility>
  27 #include <boost/utility.hpp>
  28 #include <glibmm/thread.h>
  29 #include "pbd/command.h"
  30 #include "ardour/types.h"
  31 #include "ardour/midi_buffer.h"
  32 #include "ardour/midi_ring_buffer.h"
  33 #include "ardour/automatable_sequence.h"
  34 #include "ardour/types.h"
  35 #include "evoral/Note.hpp"
  36 #include "evoral/Sequence.hpp"
  37
  38 namespace ARDOUR {
  39
  40 class Session;
  41 class MidiSource;
  42
  43 /** This is a higher level (than MidiBuffer) model of MIDI data, with separate
  44  * representations for notes (instead of just unassociated note on/off events)
  45  * and controller data.  Controller data is represented as part of the
  46  * Automatable base (i.e. in a map of AutomationList, keyed by Parameter).
  47  * Because of this MIDI controllers and automatable controllers/widgets/etc
  48  * are easily interchangeable.
  49  */
  50 class MidiModel : public AutomatableSequence<Evoral::MusicalTime> {
  51 public:
  52         typedef Evoral::MusicalTime TimeType;
  53
  54         MidiModel(MidiSource* s);
  55
  56         NoteMode note_mode() const { return (percussive() ? Percussive : Sustained); }
  57         void set_note_mode(NoteMode mode) { set_percussive(mode == Percussive); };
  58
  59         class DiffCommand : public Command {
  60         public:
  61                 enum Property {
  62                         NoteNumber,
  63                         Velocity,
  64                         StartTime,
  65                         Length,
  66                         Channel
  67                 };
  68
  69                 DiffCommand (boost::shared_ptr<MidiModel> m, const std::string& name);
  70                 DiffCommand (boost::shared_ptr<MidiModel> m, const XMLNode& node);
  71
  72                 const std::string& name() const { return _name; }
  73
  74                 void operator()();
  75                 void undo();
  76
  77                 int set_state (const XMLNode&, int version);
  78                 XMLNode& get_state ();
  79
  80                 void add (const NotePtr note);
  81                 void remove (const NotePtr note);
  82                 void side_effect_remove (const NotePtr note);
  83
  84                 void change (const NotePtr note, Property prop, uint8_t new_value);
  85                 void change (const NotePtr note, Property prop, TimeType new_time);
  86
  87                 bool adds_or_removes() const {
  88                         return !_added_notes.empty() || !_removed_notes.empty();
  89                 }
  90
  91                 DiffCommand& operator+= (const DiffCommand& other);
  92                 boost::shared_ptr<MidiModel> model() const { return _model; }
  93
  94           private:
  95                 boost::shared_ptr<MidiModel> _model;
  96                 const std::string            _name;
  97
  98                 struct NoteChange {
  99                         DiffCommand::Property property;
 100                         NotePtr note;
 101                         union {
 102                                 uint8_t  old_value;
 103                                 TimeType old_time;
 104                         };
 105                         union {
 106                                 uint8_t  new_value;
 107                                 TimeType new_time;
 108                         };
 109                 };
 110
 111                 typedef std::list<NoteChange> ChangeList;
 112                 ChangeList _changes;
 113
 114                 typedef std::list< boost::shared_ptr< Evoral::Note<TimeType> > > NoteList;
 115                 NoteList _added_notes;
 116                 NoteList _removed_notes;
 117
 118                 std::set<NotePtr> side_effect_removals;
 119
 120                 XMLNode &marshal_change(const NoteChange&);
 121                 NoteChange unmarshal_change(XMLNode *xml_note);
 122
 123                 XMLNode &marshal_note(const NotePtr note);
 124                 NotePtr unmarshal_note(XMLNode *xml_note);
 125         };
 126
 127         MidiModel::DiffCommand*  new_diff_command(const std::string name="midi edit");
 128         void                     apply_command(Session& session, Command* cmd);
 129         void                     apply_command_as_subcommand(Session& session, Command* cmd);
 130
 131         bool sync_to_source ();
 132         bool write_to(boost::shared_ptr<MidiSource> source);
 133         bool write_section_to (boost::shared_ptr<MidiSource> source, Evoral::MusicalTime begin = Evoral::MinMusicalTime,
 134                                Evoral::MusicalTime end = Evoral::MaxMusicalTime);
 135
 136         // MidiModel doesn't use the normal AutomationList serialisation code
 137         // since controller data is stored in the .mid
 138         XMLNode& get_state();
 139         int set_state(const XMLNode&) { return 0; }
 140
 141         PBD::Signal0<void> ContentsChanged;
 142
 143         const MidiSource* midi_source() const { return _midi_source; }
 144         void set_midi_source (MidiSource *);
 145
 146         boost::shared_ptr<Evoral::Note<TimeType> > find_note (NotePtr);
 147         boost::shared_ptr<Evoral::Note<TimeType> > find_note (gint note_id);
 148
 149         InsertMergePolicy insert_merge_policy () const;
 150         void set_insert_merge_policy (InsertMergePolicy);
 151
 152         boost::shared_ptr<Evoral::Control> control_factory(const Evoral::Parameter& id);
 153
 154 protected:
 155         int resolve_overlaps_unlocked (const NotePtr, void* arg = 0);
 156
 157 private:
 158         struct WriteLockImpl : public AutomatableSequence<TimeType>::WriteLockImpl {
 159                 WriteLockImpl(Glib::Mutex::Lock* source_lock, Glib::RWLock& s, Glib::Mutex& c)
 160                         : AutomatableSequence<TimeType>::WriteLockImpl(s, c)
 161                         , source_lock(source_lock)
 162                 {}
 163                 ~WriteLockImpl() {
 164                         delete source_lock;
 165                 }
 166                 Glib::Mutex::Lock* source_lock;
 167         };
 168
 169 public:
 170         virtual WriteLock edit_lock();
 171         virtual WriteLock write_lock();
 172
 173 private:
 174         friend class DeltaCommand;
 175
 176         void source_interpolation_changed (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
 177         void control_list_interpolation_changed (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
 178
 179         PBD::ScopedConnectionList _midi_source_connections;
 180
 181         // We cannot use a boost::shared_ptr here to avoid a retain cycle
 182         MidiSource* _midi_source;
 183         InsertMergePolicy _insert_merge_policy;
 184 };
 185
 186 } /* namespace ARDOUR */
 187
 188 #endif /* __ardour_midi_model_h__ */
 189