Automated with clang-tidy readability-identifier-naming (config added to .clang-tidy) plus scripted passes, per the updated rules now documented in CONTRIBUTING.md: - types (class/struct/enum/alias/template params): PascalCase - functions, variables, members: snake_case (incl. rational -> Rational) - private/protected members: trailing underscore; static member variables likewise (instance_, available_themes_) - constants and enum values: snake_case (kLinear -> k_linear, F32P -> f32p); ALL_CAPS reserved for macros - macros: OAK_ prefix (OLIVE_ADD_TEST/OLIVE_ASSERT/OLIVE_CONFIG -> OAK_ADD_TEST/OAK_ASSERT/OAK_CONFIG, GL_PREAMBLE -> OAK_GL_PREAMBLE, include guards -> OAK_*) - file names: all lowercase (Current/Plugin/OliveHost/OliveClip/ OlivePluginInstance -> current/plugin/olivehost/oliveclip/ oliveplugininstance) - getters share the member name sans underscore, setters set_foo() - Qt and third-party (OpenFX) virtual overrides and framework callbacks keep their original names (exempt in .clang-tidy) Manual follow-ups required where automation could not reach: - string-based QMetaObject/SIGNAL/SLOT references updated to renamed methods (AddTask, CreatedFile, DeleteSpecificFile, moveSelectionUp, ...) - macro bodies referencing renamed methods (OLIVE_CONFIG, NODE_DEFAULT_DESTRUCTOR, MANAGEDDISPLAYWIDGET_*) - self-shadowing locals renamed where signals/methods became same-named (size_changed, worker_count, selected_items, import param, filters) - third_party OFX member/namespace usages restored (OFX::Host::*, _created, _clipPrefsDirty, createInstance, clearPersistentMessage) - STL protocol aliases restored (const_iterator) with .clang-tidy ignore rules; qHash overloads restored Full build and test suite pass: ctest 4/4, ~1960 gtest cases green.
103 lines
3.4 KiB
C++
103 lines
3.4 KiB
C++
/***
|
|
|
|
Oak - Non-Linear Video Editor
|
|
Copyright (C) 2026 Oak Team
|
|
|
|
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 OAK_AUDIOWAVEFORMSYNC_H
|
|
#define OAK_AUDIOWAVEFORMSYNC_H
|
|
|
|
#include <cstdint>
|
|
|
|
#include <QVector>
|
|
|
|
#include "olive/core/render/samplebuffer.h"
|
|
|
|
namespace olive
|
|
{
|
|
|
|
class AudioWaveformSync {
|
|
public:
|
|
struct OffsetResult {
|
|
int64_t offset_samples = 0;
|
|
double confidence = 0.0;
|
|
bool valid = false;
|
|
};
|
|
|
|
struct StretchOffsetResult {
|
|
// Playback rate the candidate must be played at to align with the
|
|
// reference (e.g. 2.0 = candidate runs at half speed and needs to be
|
|
// sped up 2x)
|
|
double rate = 1.0;
|
|
int64_t offset_samples = 0;
|
|
double confidence = 0.0;
|
|
bool valid = false;
|
|
};
|
|
|
|
static QVector<double> extract_rms_envelope(const core::SampleBuffer &samples,
|
|
size_t window_samples);
|
|
|
|
static OffsetResult estimate_offset(const core::SampleBuffer &reference,
|
|
const core::SampleBuffer &candidate,
|
|
size_t window_samples,
|
|
int64_t max_offset_samples);
|
|
|
|
static OffsetResult estimate_envelope_offset(const QVector<double> &reference,
|
|
const QVector<double> &candidate,
|
|
size_t window_samples,
|
|
int64_t max_offset_windows);
|
|
|
|
/**
|
|
* @brief Offset estimation that ignores windows flagged as invalid
|
|
*
|
|
* @p reference_valid and @p candidate_valid mark which envelope windows
|
|
* contain real data (e.g. actually cached waveform regions). Windows
|
|
* flagged false on either side are excluded from the correlation instead
|
|
* of being treated as silence, which improves accuracy when parts of the
|
|
* waveform cache have not been generated yet. Empty masks are treated as
|
|
* "all windows valid".
|
|
*/
|
|
static OffsetResult estimate_envelope_offset(const QVector<double> &reference,
|
|
const QVector<double> &candidate,
|
|
const QVector<bool> &reference_valid,
|
|
const QVector<bool> &candidate_valid,
|
|
size_t window_samples,
|
|
int64_t max_offset_windows);
|
|
|
|
/**
|
|
* @brief Estimates a playback-rate change plus offset aligning the
|
|
* candidate to the reference
|
|
*
|
|
* The candidate envelope is resampled at each candidate rate in
|
|
* [min_rate, max_rate] (step rate_step) and correlated against the
|
|
* reference. rate > 1 means the candidate runs slower than the reference
|
|
* and must be sped up. The search is O(rates * lags * overlap), so
|
|
* callers should bound max_offset_windows to a sensible range.
|
|
*/
|
|
static StretchOffsetResult
|
|
estimate_stretch_and_offset(const QVector<double> &reference,
|
|
const QVector<double> &candidate,
|
|
const QVector<bool> &reference_valid,
|
|
const QVector<bool> &candidate_valid, size_t window_samples,
|
|
int64_t max_offset_windows, double min_rate,
|
|
double max_rate, double rate_step);
|
|
};
|
|
|
|
}
|
|
|
|
#endif // OAK_AUDIOWAVEFORMSYNC_H
|