libs/ardour/midi_model.cc

   1 /*
   2  Copyright (C) 2007 Paul Davis
   3  Written by Dave Robillard, 2007
   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 #define __STDC_LIMIT_MACROS 1
  22
  23 #include <iostream>
  24 #include <algorithm>
  25 #include <stdexcept>
  26 #include <stdint.h>
  27 #include <pbd/error.h>
  28 #include <pbd/enumwriter.h>
  29 #include <midi++/events.h>
  30
  31 #include <ardour/midi_model.h>
  32 #include <ardour/midi_source.h>
  33 #include <ardour/types.h>
  34 #include <ardour/session.h>
  35
  36 using namespace std;
  37 using namespace ARDOUR;
  38 using namespace PBD;
  39
  40 MidiModel::MidiModel(MidiSource *s, size_t size)
  41         : AutomatableSequence<TimeType>(s->session(), size)
  42         , _midi_source(s)
  43 {
  44         //cerr << "MidiModel \"" << s->name() << "\" constructed: " << this << endl;
  45 }
  46
  47 /** Start a new command.
  48  *
  49  * This has no side-effects on the model or Session, the returned command
  50  * can be held on to for as long as the caller wishes, or discarded without
  51  * formality, until apply_command is called and ownership is taken.
  52  */
  53 MidiModel::DeltaCommand* MidiModel::new_delta_command(const string name)
  54 {
  55         DeltaCommand* cmd = new DeltaCommand(_midi_source->model(), name);
  56         return cmd;
  57 }
  58
  59 /** Apply a command.
  60  *
  61  * Ownership of cmd is taken, it must not be deleted by the caller.
  62  * The command will constitute one item on the undo stack.
  63  */
  64 void
  65 MidiModel::apply_command(Session& session, Command* cmd)
  66 {
  67         session.begin_reversible_command(cmd->name());
  68         (*cmd)();
  69         session.commit_reversible_command(cmd);
  70         set_edited(true);
  71 }
  72
  73
  74 // DeltaCommand
  75
  76 MidiModel::DeltaCommand::DeltaCommand(boost::shared_ptr<MidiModel> m,
  77                 const std::string& name)
  78         : Command(name)
  79         , _model(m)
  80         , _name(name)
  81 {
  82 }
  83
  84 MidiModel::DeltaCommand::DeltaCommand(boost::shared_ptr<MidiModel> m,
  85                 const XMLNode& node)
  86         : _model(m)
  87 {
  88         set_state(node);
  89 }
  90
  91 void
  92 MidiModel::DeltaCommand::add(const boost::shared_ptr< Evoral::Note<TimeType> > note)
  93 {
  94         //cerr << "MEC: apply" << endl;
  95         _removed_notes.remove(note);
  96         _added_notes.push_back(note);
  97 }
  98
  99 void
 100 MidiModel::DeltaCommand::remove(const boost::shared_ptr< Evoral::Note<TimeType> > note)
 101 {
 102         //cerr << "MEC: remove" << endl;
 103         _added_notes.remove(note);
 104         _removed_notes.push_back(note);
 105 }
 106
 107 void
 108 MidiModel::DeltaCommand::operator()()
 109 {
 110         // This could be made much faster by using a priority_queue for added and
 111         // removed notes (or sort here), and doing a single iteration over _model
 112
 113         _model->write_lock();
 114
 115         // Store the current seek position so we can restore the read iterator
 116         // after modifying the contents of the model
 117         const TimeType read_time = _model->read_time();
 118
 119         for (NoteList::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i)
 120                 _model->add_note_unlocked(*i);
 121
 122         for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i)
 123                 _model->remove_note_unlocked(*i);
 124
 125         _model->write_unlock();
 126         // FIXME: race?
 127         _model->read_seek(read_time); // restore read position
 128
 129         _model->ContentsChanged(); /* EMIT SIGNAL */
 130 }
 131
 132 void
 133 MidiModel::DeltaCommand::undo()
 134 {
 135         // This could be made much faster by using a priority_queue for added and
 136         // removed notes (or sort here), and doing a single iteration over _model
 137
 138         _model->write_lock();
 139
 140         // Store the current seek position so we can restore the read iterator
 141         // after modifying the contents of the model
 142         const TimeType read_time = _model->read_time();
 143
 144         for (NoteList::iterator i = _added_notes.begin(); i != _added_notes.end(); ++i)
 145                 _model->remove_note_unlocked(*i);
 146
 147         for (NoteList::iterator i = _removed_notes.begin(); i != _removed_notes.end(); ++i)
 148                 _model->add_note_unlocked(*i);
 149
 150         _model->write_unlock();
 151         // FIXME: race?
 152         _model->read_seek(read_time); // restore read position
 153
 154         _model->ContentsChanged(); /* EMIT SIGNAL */
 155 }
 156
 157 XMLNode&
 158 MidiModel::DeltaCommand::marshal_note(const boost::shared_ptr< Evoral::Note<TimeType> > note)
 159 {
 160         XMLNode *xml_note = new XMLNode("note");
 161         ostringstream note_str(ios::ate);
 162         note_str << int(note->note());
 163         xml_note->add_property("note", note_str.str());
 164
 165         ostringstream channel_str(ios::ate);
 166         channel_str << int(note->channel());
 167         xml_note->add_property("channel", channel_str.str());
 168
 169         ostringstream time_str(ios::ate);
 170         time_str << int(note->time());
 171         xml_note->add_property("time", time_str.str());
 172
 173         ostringstream length_str(ios::ate);
 174         length_str <<(unsigned int) note->length();
 175         xml_note->add_property("length", length_str.str());
 176
 177         ostringstream velocity_str(ios::ate);
 178         velocity_str << (unsigned int) note->velocity();
 179         xml_note->add_property("velocity", velocity_str.str());
 180
 181         return *xml_note;
 182 }
 183
 184 boost::shared_ptr< Evoral::Note<MidiModel::TimeType> >
 185 MidiModel::DeltaCommand::unmarshal_note(XMLNode *xml_note)
 186 {
 187         unsigned int note;
 188         XMLProperty* prop;
 189         unsigned int channel;
 190         unsigned int time;
 191         unsigned int length;
 192         unsigned int velocity;
 193
 194         if ((prop = xml_note->property("note")) != 0) {
 195                 istringstream note_str(prop->value());
 196                 note_str >> note;
 197         } else {
 198                 warning << "note information missing note value" << endmsg;
 199                 note = 127;
 200         }
 201
 202         if ((prop = xml_note->property("channel")) != 0) {
 203                 istringstream channel_str(prop->value());
 204                 channel_str >> channel;
 205         } else {
 206                 warning << "note information missing channel" << endmsg;
 207                 channel = 0;
 208         }
 209
 210         if ((prop = xml_note->property("time")) != 0) {
 211                 istringstream time_str(prop->value());
 212                 time_str >> time;
 213         } else {
 214                 warning << "note information missing time" << endmsg;
 215                 time = 0;
 216         }
 217
 218         if ((prop = xml_note->property("length")) != 0) {
 219                 istringstream length_str(prop->value());
 220                 length_str >> length;
 221         } else {
 222                 warning << "note information missing length" << endmsg;
 223                 note = 1;
 224         }
 225
 226         if ((prop = xml_note->property("velocity")) != 0) {
 227                 istringstream velocity_str(prop->value());
 228                 velocity_str >> velocity;
 229         } else {
 230                 warning << "note information missing velocity" << endmsg;
 231                 velocity = 127;
 232         }
 233
 234         boost::shared_ptr< Evoral::Note<TimeType> > note_ptr(new Evoral::Note<TimeType>(
 235                         channel, time, length, note, velocity));
 236         return note_ptr;
 237 }
 238
 239 #define ADDED_NOTES_ELEMENT "added_notes"
 240 #define REMOVED_NOTES_ELEMENT "removed_notes"
 241 #define DELTA_COMMAND_ELEMENT "DeltaCommand"
 242
 243 int
 244 MidiModel::DeltaCommand::set_state(const XMLNode& delta_command)
 245 {
 246         if (delta_command.name() != string(DELTA_COMMAND_ELEMENT)) {
 247                 return 1;
 248         }
 249
 250         _added_notes.clear();
 251         XMLNode *added_notes = delta_command.child(ADDED_NOTES_ELEMENT);
 252         XMLNodeList notes = added_notes->children();
 253         transform(notes.begin(), notes.end(), back_inserter(_added_notes),
 254                         sigc::mem_fun(*this, &DeltaCommand::unmarshal_note));
 255
 256         _removed_notes.clear();
 257         XMLNode *removed_notes = delta_command.child(REMOVED_NOTES_ELEMENT);
 258         notes = removed_notes->children();
 259         transform(notes.begin(), notes.end(), back_inserter(_removed_notes),
 260                         sigc::mem_fun(*this, &DeltaCommand::unmarshal_note));
 261
 262         return 0;
 263 }
 264
 265 XMLNode&
 266 MidiModel::DeltaCommand::get_state()
 267 {
 268         XMLNode *delta_command = new XMLNode(DELTA_COMMAND_ELEMENT);
 269         delta_command->add_property("midi-source", _model->midi_source()->id().to_s());
 270
 271         XMLNode *added_notes = delta_command->add_child(ADDED_NOTES_ELEMENT);
 272         for_each(_added_notes.begin(), _added_notes.end(), sigc::compose(
 273                         sigc::mem_fun(*added_notes, &XMLNode::add_child_nocopy),
 274                         sigc::mem_fun(*this, &DeltaCommand::marshal_note)));
 275
 276         XMLNode *removed_notes = delta_command->add_child(REMOVED_NOTES_ELEMENT);
 277         for_each(_removed_notes.begin(), _removed_notes.end(), sigc::compose(
 278                         sigc::mem_fun(*removed_notes, &XMLNode::add_child_nocopy),
 279                         sigc::mem_fun(*this, &DeltaCommand::marshal_note)));
 280
 281         return *delta_command;
 282 }
 283
 284 /** Write the model to a MidiSource (i.e. save the model).
 285  * This is different from manually using read to write to a source in that
 286  * note off events are written regardless of the track mode.  This is so the
 287  * user can switch a recorded track (with note durations from some instrument)
 288  * to percussive, save, reload, then switch it back to sustained without
 289  * destroying the original note durations.
 290  */
 291 bool
 292 MidiModel::write_to(boost::shared_ptr<MidiSource> source)
 293 {
 294         read_lock();
 295
 296         const bool old_percussive = percussive();
 297         set_percussive(false);
 298
 299         for (Evoral::Sequence<TimeType>::const_iterator i = begin(); i != end(); ++i) {
 300                 source->append_event_unlocked(Frames, *i);
 301         }
 302
 303         set_percussive(old_percussive);
 304
 305         read_unlock();
 306         set_edited(false);
 307
 308         return true;
 309 }
 310
 311 XMLNode&
 312 MidiModel::get_state()
 313 {
 314         XMLNode *node = new XMLNode("MidiModel");
 315         return *node;
 316 }
 317