StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
decimate.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/logger/log.hxx>
57#include <StormByte/safe/optional.hxx>
58#include <StormByte/safe/pointers.hxx>
59#include <StormByte/safe/string.hxx>
60#include <StormByte/type_traits/safe.hxx>
61
62#include <cstdint>
63#include <string>
64
122 friend struct DecimateCadenceTest;
123 public:
132 Safe::Optional<unsigned> cycle = {},
133 Safe::Optional<double> dupthresh = {},
134 Safe::Optional<double> scthresh = {});
135
140 Decimate(const Decimate& other) = delete;
141
146 Decimate(Decimate&& other) noexcept = delete;
147
151 ~Decimate() noexcept override;
152
158 Decimate& operator=(const Decimate& other) = delete;
159
165 Decimate& operator=(Decimate&& other) noexcept = delete;
166
171 enum StormByte::Multimedia::Type Media() const noexcept override;
172
176 void Clean() noexcept override;
177
181 void Setup() noexcept override;
182
187 void Measure(const Pipeline::Frame& frame) noexcept override;
188
192 void Measured() noexcept override;
193
198 void Process(const Pipeline::Frame& frame) noexcept override;
199
203 void Eof() noexcept override;
204
205 private:
211 void Observe(const StormByte::Multimedia::FFmpeg::AVFrame& src, Property::AVRational rate) noexcept;
212
218 Property::AVRational Cadence(Property::AVRational rate) const noexcept;
219
224 StormByte::Safe::String Chain() const;
225
226 Safe::Optional<unsigned> m_cycleIn;
227 Safe::Optional<double> m_dupIn;
228 Safe::Optional<double> m_scIn;
229 Safe::Unique<StormByte::Multimedia::FFmpeg::AVFilterGraph> m_graph;
230 Property::AVRational m_rate{0, 1};
231 Property::AVRational m_timeBase{0, 1};
233 std::int64_t m_ticks = 0;
234 std::int64_t m_intervals = 0;
235 std::int64_t m_minDelta = 0;
236 std::int64_t m_maxDelta = 0;
237 std::int64_t m_durationTicks = 0;
238 bool m_durationValid = true;
239 bool m_timingValid = true;
240 };
241}
242
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
const StormByte::Multimedia::FFmpeg::AVFrame & AVFrame() const noexcept
Borrowed RAII handle of the current frame.
Process that measures the origin before it rewrites.
Definition ffmpeg.hxx:902
friend class FFmpeg
Definition ffmpeg.hxx:904
Cycle decimator via libavfilter decimate.
Definition decimate.hxx:118
~Decimate() noexcept override
Drops the cached graph and measured cadence.
void Clean() noexcept override
Drops the cached graph.
Decimate(Decimate &&other) noexcept=delete
Move is not allowed.
void Measured() noexcept override
Resolves the observed cadence after the measure pass.
void Measure(const Pipeline::Frame &frame) noexcept override
Observes stream FPS and source timing without dropping frames.
Decimate(Safe::Shared< StormByte::Logger::Log > log, Safe::Optional< unsigned > cycle={}, Safe::Optional< double > dupthresh={}, Safe::Optional< double > scthresh={})
Cycle decimator (decimate).
void Setup() noexcept override
Resets the graph, retaining resolved cadence between passes.
void Process(const Pipeline::Frame &frame) noexcept override
Pushes one video frame through decimate and Save.
enum StormByte::Multimedia::Type Media() const noexcept override
Media this filter handles.
friend struct DecimateCadenceTest
Focused test access to the private cadence observer.
Definition decimate.hxx:122
Decimate(const Decimate &other)=delete
Copy is not allowed.
void Eof() noexcept override
Drains frames still held by the cycle window.
One decoded access unit.
Definition frame.hxx:103
Pair {num, den} matching libavutil AVRational.
Definition av_rational.hxx:85
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Media property value types.
Video leaves (Process and Analytics).
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61