oak-editor/app/dialog/speedduration/speeddurationdialog.cpp

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2023 Olive Studios LLC
  Modifications Copyright (C) 2025 mikesolar

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

***/

#include "speeddurationdialog.h"

#include <QDialogButtonBox>
#include <QGridLayout>
#include <QGroupBox>
#include <QMessageBox>

#include "core.h"
#include "node/nodeundo.h"
#include "timeline/timelineundopointer.h"

namespace olive
{

#define super QDialog

SpeedDurationDialog::SpeedDurationDialog(const QVector<ClipBlock *> &clips,
										 const Rational &timebase,
										 QWidget *parent)
	: super(parent)
	, clips_(clips)
	, timebase_(timebase)
{
	setWindowTitle(tr("Clip Properties"));

	QVBoxLayout *layout = new QVBoxLayout(this);

	{
		QGroupBox *speed_group = new QGroupBox(tr("Speed/Duration"));
		layout->addWidget(speed_group);

		QGridLayout *speed_layout = new QGridLayout(speed_group);

		int row = 0;

		speed_layout->addWidget(new QLabel(tr("Speed:")), row, 0);

		speed_slider_ = new FloatSlider();
		speed_slider_->set_display_type(FloatSlider::k_percentage);
		connect(speed_slider_, &FloatSlider::value_changed, this,
				&SpeedDurationDialog::speed_changed);
		speed_layout->addWidget(speed_slider_, row, 1);

		row++;

		speed_layout->addWidget(new QLabel(tr("Duration:")), row, 0);

		dur_slider_ = new RationalSlider();
		dur_slider_->set_timebase(timebase);
		dur_slider_->set_display_type(RationalSlider::k_time);
		connect(dur_slider_, &RationalSlider::value_changed, this,
				&SpeedDurationDialog::duration_changed);
		speed_layout->addWidget(dur_slider_, row, 1);

		row++;

		link_box_ = new QCheckBox(tr("Link Speed and Duration"));
		link_box_->setChecked(true);
		speed_layout->addWidget(link_box_, row, 0, 1, 2);

		row++;

		reverse_box_ = new QCheckBox(tr("Reverse"));
		speed_layout->addWidget(reverse_box_, row, 0, 1, 2);

		row++;

		maintain_audio_pitch_box_ = new QCheckBox(tr("Maintain Audio Pitch"));
		speed_layout->addWidget(maintain_audio_pitch_box_, row, 0, 1, 2);

		row++;

		ripple_box_ = new QCheckBox(tr("Ripple Trailing Clips"));
		speed_layout->addWidget(ripple_box_, row, 0, 1, 2);
	}

	{
		auto loop_box = new QGroupBox(tr("Loop"));
		layout->addWidget(loop_box);

		auto loop_layout = new QGridLayout(loop_box);

		int row = 0;

		loop_layout->addWidget(new QLabel(tr("Loop:")), row, 0);

		loop_combo_ = new QComboBox();
		loop_combo_->addItem(tr("None"), int(LoopMode::k_loop_mode_off));
		loop_combo_->addItem(tr("Loop"), int(LoopMode::k_loop_mode_loop));
		loop_combo_->addItem(tr("Clamp"), int(LoopMode::k_loop_mode_clamp));
		loop_layout->addWidget(loop_combo_, row, 1);
	}

	QDialogButtonBox *btns =
		new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
	btns->setCenterButtons(true);
	connect(btns, &QDialogButtonBox::accepted, this,
			&SpeedDurationDialog::accept);
	connect(btns, &QDialogButtonBox::rejected, this,
			&SpeedDurationDialog::reject);
	layout->addWidget(btns);

	// Determine which speed value to use
	start_speed_ = clips.first()->speed();
	start_duration_ = clips.first()->length();
	start_reverse_ = clips.first()->reverse();
	start_maintain_audio_pitch_ = clips.first()->maintain_audio_pitch();
	start_loop_ = int(clips.first()->loop_mode());
	for (int i = 1; i < clips.size(); i++) {
		ClipBlock *c = clips.at(i);

		if (!qIsNaN(start_speed_) && !qFuzzyCompare(start_speed_, c->speed())) {
			// Speed differs per clip
			start_speed_ = qSNaN();
		}

		if (start_duration_ != -1 && c->length() != start_duration_) {
			start_duration_ = -1;
		}

		// Yes, in theory a bool should only ever be 0 or 1 anyway, but MSVC complained and it is
		// *possible* that a bool could be something else, so this code is safer
		int clip_reverse = c->reverse() ? 1 : 0;
		int clip_maintain_pitch = c->maintain_audio_pitch() ? 1 : 0;
		if (start_reverse_ != -1 && clip_reverse != start_reverse_) {
			start_reverse_ = -1;
		}
		if (start_maintain_audio_pitch_ != -1 &&
			clip_maintain_pitch != start_maintain_audio_pitch_) {
			start_maintain_audio_pitch_ = -1;
		}

		if (start_loop_ != -1 && int(c->loop_mode()) != start_loop_) {
			start_loop_ = -1;
		}
	}

	if (qIsNaN(start_speed_)) {
		speed_slider_->set_tristate();
	} else {
		speed_slider_->set_value(start_speed_);
	}

	if (start_duration_ == -1) {
		dur_slider_->set_tristate();
	} else {
		dur_slider_->set_value(start_duration_);
	}

	if (start_reverse_ == -1) {
		reverse_box_->setTristate();
	} else {
		reverse_box_->setChecked(start_reverse_);
	}

	if (start_maintain_audio_pitch_ == -1) {
		maintain_audio_pitch_box_->setTristate();
	} else {
		maintain_audio_pitch_box_->setChecked(start_maintain_audio_pitch_);
	}

	if (start_loop_ == -1) {
		loop_combo_->setCurrentIndex(-1);
	} else {
		loop_combo_->setCurrentIndex(start_loop_);
	}
}

void SpeedDurationDialog::accept()
{
	MultiUndoCommand *command = new MultiUndoCommand();

	// Set duration values
	TimelineRippleDeleteGapsAtRegionsCommand::RangeList ripple_ranges;

	foreach (ClipBlock *c, clips_) {
		Rational proposed_length = c->length();

		if (dur_slider_->is_tristate()) {
			if (link_box_->isChecked() && !speed_slider_->is_tristate()) {
				proposed_length = get_length_adjustment(c->length(), c->speed(),
													  speed_slider_->get_value(),
													  timebase_);
			}
		} else {
			proposed_length = dur_slider_->get_value();
		}

		if (proposed_length != c->length()) {
			// Clip length should ideally change, but check if there's "room" to do so
			if (proposed_length > c->length() && c->next()) {
				if (GapBlock *gap = dynamic_cast<GapBlock *>(c->next())) {
					proposed_length =
						qMin(proposed_length, gap->out() - c->in());
				} else {
					proposed_length = c->length();
				}
			}

			if (proposed_length != c->length()) {
				command->add_child(new BlockTrimCommand(
					c->track(), c, proposed_length, Timeline::k_trim_out));
				ripple_ranges.append(
					{ c->track(),
					  TimeRange(c->in() + proposed_length, c->out()) });
			}
		}
	}

	if (ripple_box_->isChecked()) {
		command->add_child(new TimelineRippleDeleteGapsAtRegionsCommand(
			clips_.first()->track()->sequence(), ripple_ranges));
	}

	// Set speed values
	if (speed_slider_->is_tristate()) {
		if (link_box_->isChecked() && !dur_slider_->is_tristate()) {
			// Automatically determine speed from duration
			foreach (ClipBlock *c, clips_) {
				command->add_child(new NodeParamSetStandardValueCommand(
					NodeKeyframeTrackReference(
						NodeInput(c, ClipBlock::k_speed_input)),
					get_speed_adjustment(c->speed(), c->length(),
									   dur_slider_->get_value())));
			}
		}
	} else {
		// Set speeds to value of slider
		foreach (ClipBlock *c, clips_) {
			command->add_child(new NodeParamSetStandardValueCommand(
				NodeKeyframeTrackReference(NodeInput(c, ClipBlock::k_speed_input)),
				speed_slider_->get_value()));
		}
	}

	// Set reverse values
	if (!reverse_box_->isTristate()) {
		foreach (ClipBlock *c, clips_) {
			command->add_child(new NodeParamSetStandardValueCommand(
				NodeKeyframeTrackReference(
					NodeInput(c, ClipBlock::k_reverse_input)),
				reverse_box_->isChecked()));
		}
	}

	// Set reverse values
	if (!maintain_audio_pitch_box_->isTristate()) {
		foreach (ClipBlock *c, clips_) {
			command->add_child(new NodeParamSetStandardValueCommand(
				NodeKeyframeTrackReference(
					NodeInput(c, ClipBlock::k_maintain_audio_pitch_input)),
				maintain_audio_pitch_box_->isChecked()));
		}
	}

	if (loop_combo_->currentIndex() != -1) {
		foreach (ClipBlock *c, clips_) {
			command->add_child(new NodeParamSetStandardValueCommand(
				NodeKeyframeTrackReference(
					NodeInput(c, ClipBlock::k_loop_mode_input)),
				loop_combo_->currentData()));
		}
	}

	QString name = (clips_.size() > 1) ?
					   tr("Set %1 Clip Properties").arg(clips_.size()) :
					   tr("Set Clip \"%1\" Properties")
						   .arg(clips_.first()->get_label_or_name());
	Core::instance()->undo_stack()->push(command, name);

	super::accept();
}

Rational SpeedDurationDialog::get_length_adjustment(
	const Rational &original_length, double original_speed, double new_speed,
	const Rational &timebase)
{
	return Timecode::snap_time_to_timebase(
		Rational::from_double(original_length.to_double() / new_speed *
							 original_speed),
		timebase);
}

double SpeedDurationDialog::get_speed_adjustment(double original_speed,
											   const Rational &original_length,
											   const Rational &new_length)
{
	return original_speed / new_length.to_double() * original_length.to_double();
}

void SpeedDurationDialog::speed_changed(double s)
{
	if (!link_box_->isChecked()) {
		return;
	}

	if (start_duration_ == -1) {
		dur_slider_->set_tristate();
	} else {
		dur_slider_->set_value(
			get_length_adjustment(start_duration_, start_speed_, s, timebase_));
	}
}

void SpeedDurationDialog::duration_changed(const Rational &r)
{
	if (!link_box_->isChecked()) {
		return;
	}

	if (qIsNaN(start_speed_)) {
		speed_slider_->set_tristate();
	} else {
		speed_slider_->set_value(
			get_speed_adjustment(start_speed_, start_duration_, r));
	}
}

}