oak-team/oak-editor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Allow waveform sync with partially cached audio and add regression tests

Browse Source
This commit is contained in:
Mike-Solar
2026-07-13 10:54:12 +08:00
parent 0410ff2fe7
commit f3389fe6ba
6 changed files with 358 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/widget/timelinewidget/CMakeLists.txt
+2
View File
@@ -26,5 +26,7 @@ set(OLIVE_SOURCES
widget/timelinewidget/timelinewidget.h
widget/timelinewidget/timelinewidgetselections.cpp
widget/timelinewidget/timelinewidgetselections.h
widget/timelinewidget/timelinewidgetwaveformsync.cpp
widget/timelinewidget/timelinewidgetwaveformsync.h
PARENT_SCOPE
)
app/widget/timelinewidget/timelinewidget.cpp
+3 -73
View File
@@ -20,6 +20,7 @@
***/
#include "timelinewidget.h"
#include "timelinewidgetwaveformsync.h"
#include <algorithm>
#include <cfloat>
@@ -76,6 +77,8 @@ namespace olive
#define super TimeBasedWidget
using namespace TimelineWaveformSync;
namespace {
struct SourceSyncClip {
@@ -84,13 +87,6 @@ struct SourceSyncClip {
rational source_head;
};
struct WaveformSyncClip {
ClipBlock *clip = nullptr;
const AudioWaveformCache *waveform = nullptr;
TimeRange media_range;
int sample_rate = 0;
};
bool GetSourceSyncClip(Block *block, SourceSyncClip *out)
{
ClipBlock *clip = dynamic_cast<ClipBlock *>(block);
@@ -124,44 +120,6 @@ QVector<SourceSyncClip> GetSelectedSourceSyncClips(
return clips;
}
bool GetWaveformSyncClip(Block *block, WaveformSyncClip *out)
{
ClipBlock *clip = dynamic_cast<ClipBlock *>(block);
if (!clip || !clip->waveform()) {
return false;
}
const TimeRange media_range = clip->media_range();
if (media_range.length().isNull()) {
return false;
}
const AudioWaveformCache *waveform = clip->waveform();
if (waveform->GetParameters().sample_rate() <= 0 ||
!waveform->GetInvalidatedRanges(media_range).isEmpty()) {
return false;
}
out->clip = clip;
out->waveform = waveform;
out->media_range = media_range;
out->sample_rate = waveform->GetParameters().sample_rate();
return true;
}
QVector<WaveformSyncClip> GetSelectedWaveformSyncClips(
const QVector<Block *> &blocks)
{
QVector<WaveformSyncClip> clips;
for (Block *block : blocks) {
WaveformSyncClip sync_clip;
if (GetWaveformSyncClip(block, &sync_clip)) {
clips.append(sync_clip);
}
}
return clips;
}
QVector<Footage *> GetSelectedProxyFootage(const QVector<Block *> &blocks)
{
QVector<Footage *> footage;
@@ -182,34 +140,6 @@ QVector<Footage *> GetSelectedProxyFootage(const QVector<Block *> &blocks)
return footage;
}
QVector<double> ExtractWaveformCacheEnvelope(const WaveformSyncClip &clip,
int sample_rate,
size_t window_samples)
{
QVector<double> envelope;
if (sample_rate <= 0 || !window_samples) {
return envelope;
}
const rational window_time(static_cast<int>(window_samples), sample_rate);
for (rational t = clip.media_range.in(); t < clip.media_range.out();
t += window_time) {
const rational length = qMin(window_time, clip.media_range.out() - t);
const AudioVisualWaveform::Sample summary =
clip.waveform->GetSummaryFromTime(t, length);
double peak = 0.0;
for (const AudioVisualWaveform::SamplePerChannel &channel : summary) {
const double channel_peak =
std::max(std::abs(static_cast<double>(channel.min)),
std::abs(static_cast<double>(channel.max)));
peak = std::max(peak, channel_peak);
}
envelope.append(peak);
}
return envelope;
}
} // namespace
TimelineWidget::TimelineWidget(QWidget *parent)
app/widget/timelinewidget/timelinewidgetwaveformsync.cpp
+126
View File
@@ -0,0 +1,126 @@
/***
Olive - Non-Linear Video Editor
Copyright (C) 2022 Olive Team
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 "timelinewidgetwaveformsync.h"
#include <cmath>
#include "node/block/clip/clip.h"
#include "render/audiowaveformcache.h"
namespace olive
{
namespace TimelineWaveformSync
{
bool GetWaveformSyncClip(Block *block, WaveformSyncClip *out)
{
ClipBlock *clip = dynamic_cast<ClipBlock *>(block);
if (!clip || !clip->waveform()) {
return false;
}
const TimeRange media_range = clip->media_range();
if (media_range.length().isNull()) {
return false;
}
const AudioWaveformCache *waveform = clip->waveform();
if (waveform->GetParameters().sample_rate() <= 0) {
return false;
}
// Allow waveform sync as long as at least some portion of the clip's
// media range has been validated. Requiring the entire range to be
// validated makes the menu item stay disabled for long clips and gives
// the appearance that "nothing happens" when the user tries to sync.
const TimeRangeList validated_ranges =
waveform->GetValidatedRanges().Intersects(media_range);
if (validated_ranges.isEmpty()) {
return false;
}
out->clip = clip;
out->waveform = waveform;
out->media_range = media_range;
out->sample_rate = waveform->GetParameters().sample_rate();
return true;
}
QVector<WaveformSyncClip> GetSelectedWaveformSyncClips(
const QVector<Block *> &blocks)
{
QVector<WaveformSyncClip> clips;
for (Block *block : blocks) {
WaveformSyncClip sync_clip;
if (GetWaveformSyncClip(block, &sync_clip)) {
clips.append(sync_clip);
}
}
return clips;
}
QVector<double> ExtractWaveformCacheEnvelope(const WaveformSyncClip &clip,
int sample_rate,
size_t window_samples)
{
QVector<double> envelope;
if (sample_rate <= 0 || !window_samples) {
return envelope;
}
const rational window_time(static_cast<int>(window_samples), sample_rate);
// Only trust regions that have actually been validated. Unvalidated cache
// returns zero samples, which both drags the correlation score down and
// can produce false peaks if one clip happens to have more cached data
// than another. Using zero placeholders keeps every envelope aligned to
// the same absolute timeline.
const TimeRangeList validated_ranges =
clip.waveform->GetValidatedRanges().Intersects(clip.media_range);
for (rational t = clip.media_range.in(); t < clip.media_range.out();
t += window_time) {
const rational length = qMin(window_time, clip.media_range.out() - t);
const TimeRange window(t, t + length);
double peak = 0.0;
if (validated_ranges.contains(window)) {
const AudioVisualWaveform::Sample summary =
clip.waveform->GetSummaryFromTime(t, length);
for (const AudioVisualWaveform::SamplePerChannel &channel : summary) {
const double channel_peak =
std::max(std::abs(static_cast<double>(channel.min)),
std::abs(static_cast<double>(channel.max)));
peak = std::max(peak, channel_peak);
}
}
envelope.append(peak);
}
return envelope;
}
} // namespace TimelineWaveformSync
} // namespace olive
app/widget/timelinewidget/timelinewidgetwaveformsync.h
+84
View File
@@ -0,0 +1,84 @@
/***
Olive - Non-Linear Video Editor
Copyright (C) 2022 Olive Team
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/>.
***/
#ifndef TIMELINEWIDGETWAVEFORMSYNC_H
#define TIMELINEWIDGETWAVEFORMSYNC_H
#include <QVector>
#include "node/block/block.h"
#include "olive/core/util/rational.h"
#include "olive/core/util/timerange.h"
namespace olive
{
class AudioWaveformCache;
class ClipBlock;
/**
* @brief Data required to synchronize a clip using its cached audio waveform.
*/
struct WaveformSyncClip {
ClipBlock *clip = nullptr;
const AudioWaveformCache *waveform = nullptr;
TimeRange media_range;
int sample_rate = 0;
};
/**
* @brief Helpers used by TimelineWidget for waveform-based clip synchronization.
*
* Kept in a separate unit so they can be exercised directly by unit tests.
*/
namespace TimelineWaveformSync
{
/**
* @brief Fill @p out with waveform-sync metadata for @p block if it is usable.
*
* A clip is considered usable as long as at least a portion of its media range
* has been validated in the waveform cache. Previously the whole range had to
* be validated, which made the context-menu action unavailable for long clips.
*/
bool GetWaveformSyncClip(Block *block, WaveformSyncClip *out);
/**
* @brief Return all selected blocks that can be synchronized by waveform.
*/
QVector<WaveformSyncClip> GetSelectedWaveformSyncClips(
const QVector<Block *> &blocks);
/**
* @brief Extract a peak envelope from the validated regions of a waveform cache.
*
* Windows that have not been cached yet are filled with zero so that every
* envelope stays aligned to the same absolute timeline.
*/
QVector<double> ExtractWaveformCacheEnvelope(const WaveformSyncClip &clip,
int sample_rate,
size_t window_samples);
} // namespace TimelineWaveformSync
} // namespace olive
#endif // TIMELINEWIDGETWAVEFORMSYNC_H