StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
vmaf.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Multimedia.
5 *
6 * StormByte-Multimedia original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Multimedia source in this
20 * file. Third-party components — including FFmpeg and embedded trained data —
21 * remain under their own licenses and are not covered by the commercial grant.
22 *
23 * A written StormByte commercial agreement may license this original source
24 * on terms other than the LGPL, including specific use, distribution or
25 * linking arrangements such as static linking, as stated in that agreement.
26 * It does not grant rights to dependencies or waive their license conditions.
27 * Enabling WITH_GPL or WITH_NONFREE may include components with separate
28 * obligations for modification, linking (static or dynamic), redistribution
29 * or works that incorporate them. The person modifying, linking, packaging or
30 * distributing the resulting work is responsible for determining and meeting
31 * all applicable requirements, including any needed patent permissions.
32 * A StormByte commercial agreement does not provide those rights for GPL or
33 * nonfree components.
34 *
35 * Neither license grants any patent rights. Any patent licenses required
36 * to use this software or third-party components must be obtained separately
37 * from the patent holders.
38 *
39 * StormByte-Multimedia is distributed in the hope that it will be useful,
40 * but WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 * GNU Lesser General Public License for more details.
43 *
44 * You should have received a copy of the GNU Lesser General Public License
45 * version 3 along with StormByte-Multimedia. If not, see
46 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
47 *
48 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
49 */
50
51#pragma once
52
53#include <StormByte/size.hxx>
54#include <StormByte/logger/log.hxx>
59#include <StormByte/safe/map.hxx>
60#include <StormByte/safe/optional.hxx>
61#include <StormByte/safe/pointers.hxx>
62#include <StormByte/safe/string.hxx>
63
64#include <cstddef>
65
74 struct Lane;
75}
76
78
155 public:
170
174 VMAF(const VMAF& other) = delete;
175
179 VMAF(VMAF&& other) noexcept = delete;
180
184 ~VMAF() noexcept override;
185
189 VMAF& operator=(const VMAF& other) = delete;
190
194 VMAF& operator=(VMAF&& other) noexcept = delete;
195
200 enum StormByte::Multimedia::Type Media() const noexcept override;
201
210 StormByte::Size InputCeiling() const noexcept override;
211
221 class Filter::Report Report() const override;
222
223 protected:
227 void Clean() noexcept override;
228
232 void Setup() noexcept override;
233
241 void Process(const Pipeline::Frame& frame) noexcept override;
242
246 void Eof() noexcept override;
247
248 private:
252 using Lane = Detail::VMAF::Lane;
253
268 bool Fill(Lane& lane, const StormByte::Multimedia::FFmpeg::AVFrame& raw,
269 int tw, int th, void* out) noexcept;
270
276 bool OpenLane(Lane& lane);
277
288 void Score(Lane& lane,
289 const StormByte::Multimedia::FFmpeg::AVFrame& ref,
290 const StormByte::Multimedia::FFmpeg::AVFrame& dist,
291 unsigned index);
292
297 void Drain(Lane& lane);
298
303 unsigned Threads() const noexcept;
304
309 void DropParked(Lane& lane) noexcept;
310
314 void DropAll() noexcept;
315
319 static constexpr StormByte::Size Ceiling = 32;
320
321 StormByte::Safe::String m_modelName;
322 StormByte::Safe::Optional<unsigned short> m_threads;
323 StormByte::Safe::Map<int, StormByte::Safe::Shared<Lane>> m_lanes;
324 };
325}
326
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Measures units.
Definition ffmpeg.hxx:1079
friend class StormByte::Multimedia::Backend::Pipeline::Detail::Worker::Filter
Definition ffmpeg.hxx:264
FFmpeg(const FFmpeg &other)=delete
Copy is not allowed.
const StormByte::Multimedia::FFmpeg::AVFrame & AVFrame() const noexcept
Borrowed RAII handle of the current frame.
StormByte::Size InputCeiling() const noexcept override
Ceiling of the analytics input hopper.
void Eof() noexcept override
Flushes libvmaf and pools the score.
void Process(const Pipeline::Frame &frame) noexcept override
Parks one look and scores when both FIFOs of that track have a head.
class Filter::Report Report() const override
Pooled VMAF after EoF.
void Clean() noexcept override
Drops parked looks and closes libvmaf.
VMAF(const VMAF &other)=delete
Copy is not allowed.
enum StormByte::Multimedia::Type Media() const noexcept override
Media this filter handles.
VMAF(StormByte::Safe::Shared< StormByte::Logger::Log > log, StormByte::Safe::String model, StormByte::Safe::Optional< unsigned short > threads={})
VMAF with a built-in libvmaf model version.
void Setup() noexcept override
Names the model.
VMAF(VMAF &&other) noexcept=delete
Move is not allowed.
One decoded access unit.
Definition frame.hxx:103
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Provider-owned VMAF implementation state.
Video leaves (Process and Analytics).
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61