MuseScore/mscore/plugin/api/playevent.cpp

//=============================================================================
//  MuseScore
//  Music Composition & Notation
//
//  Copyright (C) 2019 Werner Schweer and others
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License version 2
//  as published by the Free Software Foundation and appearing in
//  the file LICENCE.GPL
//=============================================================================

#include "libmscore/score.h"
#include "libmscore/note.h"
#include "libmscore/undo.h"
#include "elements.h"
#include "playevent.h"

namespace Ms {
namespace PluginAPI {

//---------------------------------------------------------
//   PlayEvent::setPitch
//---------------------------------------------------------

void PlayEvent::setPitch(int v)
      {
      if (!ne || ne->pitch() == v)
            return;                                   // Value hasn't changed so no need to do more.

      if (parentNote == nullptr)
            {
            // We can't check against a parent note we don't have so
            // we check against the absolute range. When this NoteEvent
            // is added to an actual note the range should be checked
            // again.
            if (pitchIsValid(abs(v))) {
                  ne->setPitch(v);                    // Set new ontTime value
                  }
            else
                  {
                  qWarning("PluginAPI::PlayEvent::setPitch: Invalid relative pitch value when added to parent note pitch.");
                  return;
                  }
            }
      else
            {
            Ms::Score* score = parentNote->note()->score();
            if (!score) {
                  qWarning("PluginAPI::PlayEvent::setOntime: A score is required.");
                  return;
                  }
            int parentPitch = parentNote->note()->pitch();
            // A NoteEvent's pitch is actually summed with the parent pitch. This
            // check ensures that it doesn't result with an illegal pitch.
            if (!pitchIsValid(v + parentPitch)) {
                  qWarning("PluginAPI::PlayEvent::setPitch: Invalid relative pitch value when added to parent note pitch.");
                  return;
                  }
            Ms::NoteEvent e = *ne;                    // Make copy of NoteEvent value
            e.setPitch(v);                            // Set new ontTime value
            score->undo(new ChangeNoteEvent(parentNote->note(), ne, e));
            }
      }

//---------------------------------------------------------
//   PlayEvent::setOntime
//---------------------------------------------------------

void PlayEvent::setOntime(int v)
      {
      if (!ne || ne->ontime() == v)
            return;                                   // Value hasn't changed so no need to do more.
      // Note that onTime can be negative so a note can play earlier.
      // See: https://musescore.org/en/node/74651
      if (v < -2 * Ms::NoteEvent::NOTE_LENGTH || v > 2 * Ms::NoteEvent::NOTE_LENGTH) {
            qWarning("PluginAPI::PlayEvent::setOntime: Invalid value.");
            return;
            }
      if (parentNote == nullptr)
            {
            // Unowned floating value in QML context.
            ne->setOntime(v);                         // Set new ontTime value
            }
      else
            {
            Ms::Score* score = parentNote->note()->score();
            if (!score) {
                  qWarning("PluginAPI::PlayEvent::setOntime: A score is required.");
                  return;
                  }
            Ms::NoteEvent e = *ne;                    // Make copy of NoteEvent value
            e.setOntime(v);                           // Set new ontTime value
            score->undo(new ChangeNoteEvent(parentNote->note(), ne, e));
            }
      }

//---------------------------------------------------------
//   PlayEvent::setLen
//---------------------------------------------------------

void PlayEvent::setLen(int v)
      {
      if (!ne || ne->len() == v)
            return;                                   // Value hasn't changed so no need to do more.
      if (v <= 0 || v > 2 * Ms::NoteEvent::NOTE_LENGTH) {
            qWarning("PluginAPI::PlayEvent::setLen: Invalid value.");
            return;
            }
      if (parentNote == nullptr)
            {
            ne->setLen(v);                            // Set new length value
            }
      else
            {
            Ms::Score* score = parentNote->note()->score();
            if (!score) {
                  qWarning("PluginAPI::PlayEvent::setLen: A score is required.");
                  return;
                  }
            Ms::NoteEvent e = *ne;                    // Make copy of NoteEvent value
            e.setLen(v);                              // Set new length value
            score->undo(new ChangeNoteEvent(parentNote->note(), ne, e));
            }
      }

//---------------------------------------------------------
//   QmlPlayEventsListAccess::clear
//---------------------------------------------------------

void QmlPlayEventsListAccess::clear(QQmlListProperty<PlayEvent>* l)
      {
      NoteEventList* plist = static_cast<NoteEventList*>(l->data);
      Note* papinote = static_cast<Note*>(l->object);

      // Get a copy of the current list contents.
      NoteEventList nel = *plist;

      // Modify the list copy.
      nel.clear();

      // Set up the undo operation for the change.
      Ms::Score* score = papinote->note()->score();
      score->undo(new ChangeNoteEventList(papinote->note(), nel));
      }

//---------------------------------------------------------
//   QmlPlayEventsListAccess::append
//---------------------------------------------------------

void QmlPlayEventsListAccess::append(QQmlListProperty<PlayEvent>* l, PlayEvent *v)
      {
      NoteEventList* plist = static_cast<NoteEventList*>(l->data);
      Note* papinote = static_cast<Note*>(l->object);

      // Get a copy of the current list contents.
      NoteEventList nel = *plist;

      // Modify the list copy.
      nel.append(v->getNoteEvent());

      // Set up the undo operation for the change.
      Ms::Score* score = papinote->note()->score();
      score->undo(new ChangeNoteEventList(papinote->note(), nel));
      }

}
}