StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
crop.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/pointers.hxx>
58#include <StormByte/type_traits/safe.hxx>
59
105 public:
111
121 int x, int y, int width, int height);
122
127 Crop(const Crop& other) = delete;
128
133 Crop(Crop&& other) noexcept = delete;
134
138 ~Crop() noexcept override;
139
145 Crop& operator=(const Crop& other) = delete;
146
152 Crop& operator=(Crop&& other) noexcept = delete;
153
158 enum StormByte::Multimedia::Type Media() const noexcept override;
159
163 void Clean() noexcept override;
164
168 void Setup() noexcept override;
169
174 void Process(const Pipeline::Frame& frame) noexcept override;
175
180 void LastChance(const Pipeline::Frame& frame) noexcept override;
181
182 private:
186 static constexpr std::uint8_t ProbeMax = 200;
187
193 const StormByte::Multimedia::FFmpeg::AVFrame* Luma(
194 const StormByte::Multimedia::FFmpeg::AVFrame& src);
195
201 bool ProbeBars(const StormByte::Multimedia::FFmpeg::AVFrame& src);
202
207 bool Sure() const noexcept;
208
212 void Apply();
213
217 void DropLuma() noexcept;
218
219 bool m_auto;
220 bool m_released;
221 bool m_skip;
222 int m_x;
223 int m_y;
224 int m_w;
225 int m_h;
226 int m_left;
227 int m_right;
228 int m_top;
229 int m_bottom;
230 int m_stable;
231 int m_lumaW;
232 int m_lumaH;
233 int m_lumaFmt;
234 StormByte::Safe::Unique<StormByte::Multimedia::FFmpeg::AVFrame> m_luma;
235 };
236}
237
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
FFmpeg(const FFmpeg &other)=delete
Copy is not allowed.
const StormByte::Multimedia::FFmpeg::AVFrame & AVFrame() const noexcept
Borrowed RAII handle of the current frame.
One-pass filter that mutates decoded frames.
Definition ffmpeg.hxx:844
Crop(Safe::Shared< StormByte::Logger::Log > log)
Detect letterbox / pillarbox.
void Clean() noexcept override
Drops probe state and luma cache.
Crop(Crop &&other) noexcept=delete
Moving the mounted leaf is disabled.
enum StormByte::Multimedia::Type Media() const noexcept override
Media this filter handles.
void LastChance(const Pipeline::Frame &frame) noexcept override
Hold ceiling: crop only if the probe was sure, else no-op.
~Crop() noexcept override
Releases the provider-owned probe cache.
void Process(const Pipeline::Frame &frame) noexcept override
Probes while Held, or applies the window and Save.
Crop(const Crop &other)=delete
Copying the provider-owned leaf is disabled.
Crop(Safe::Shared< StormByte::Logger::Log > log, int x, int y, int width, int height)
Explicit window in frame pixels.
void Setup() noexcept override
Resets probe state.
One decoded access unit.
Definition frame.hxx:103
Multimedia module of the StormByte suite.
Pipeline Demux / decode / filter / encode / mux types.
Video leaves (Process and Analytics).
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61