StormByte-Multimedia
3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
video.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/multimedia/codec.hxx
>
54
#include <
StormByte/multimedia/pipeline/config/base.hxx
>
55
#include <
StormByte/multimedia/visibility.h
>
56
#include <StormByte/safe/map.hxx>
57
58
#include <cstdint>
59
#include <utility>
60
71
namespace
StormByte::Multimedia::Pipeline::Config
{
82
class
STORMBYTE_MULTIMEDIA_PUBLIC
Video
:
public
Base
{
83
public
:
88
92
Video
();
93
98
Video
(
const
Video
& other);
99
104
Video
(
Video
&& other);
105
109
virtual
~Video
() noexcept override;
110
116
Video
& operator=(const
Video
& other);
117
123
Video
& operator=(
Video
&& other) noexcept;
124
128
133
PointerType
Clone
() const override;
134
139
PointerType
Move
() override;
140
145
150
inline const
StormByte
::
Multimedia
::
Codec
*
Codec
() const noexcept {
151
return
m_codec;
152
}
153
158
inline
void
Codec
(
const
StormByte::Multimedia::Codec
& codec)
noexcept
{
159
m_codec = &codec;
160
}
161
166
inline
const
StormByte::Safe::Optional<double>
&
CRF
() const noexcept {
167
return
m_crf;
168
}
169
174
void
CRF
(
double
value);
175
180
inline
const
StormByte::Safe::Optional<std::int64_t>
&
BitRate
() const noexcept {
181
return
m_bitRate;
182
}
183
188
void
BitRate
(std::int64_t bits_per_second);
189
194
inline
const
StormByte::Safe::Optional<std::int64_t>
&
MaxBitRate
() const noexcept {
195
return
m_maxBitRate;
196
}
197
202
void
MaxBitRate
(std::int64_t bits_per_second);
203
208
inline
const
StormByte::Safe::Optional<StormByte::Safe::String>
&
Preset
() const noexcept {
209
return
m_preset;
210
}
211
216
void
Preset
(
StormByte::Safe::String
name);
217
222
inline
const
StormByte::Safe::Optional<StormByte::Safe::String>
&
Tune
() const noexcept {
223
return
m_tune;
224
}
225
230
void
Tune
(
StormByte::Safe::String
name);
231
236
inline
const
StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>
&
FineTune
() const noexcept {
237
return
m_fineTune;
238
}
239
244
void
FineTune
(
StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>
options)
noexcept
;
245
249
250
private
:
251
const
StormByte::Multimedia::Codec
* m_codec;
252
StormByte::Safe::Optional<double>
m_crf;
253
StormByte::Safe::Optional<std::int64_t>
m_bitRate;
254
StormByte::Safe::Optional<std::int64_t>
m_maxBitRate;
255
StormByte::Safe::Optional<StormByte::Safe::String>
m_preset;
256
StormByte::Safe::Optional<StormByte::Safe::String>
m_tune;
257
StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>
m_fineTune;
258
};
259
}
260
264
STORMBYTE_DECLARE_MAYBE_SAFE
(
StormByte::Multimedia::Pipeline::Config::Video
);
base.hxx
STORMBYTE_DECLARE_MAYBE_SAFE
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
StormByte::Multimedia::Codec
Immutable codec identity owned by Registry.
Definition
codec.hxx:94
StormByte::Multimedia::Pipeline::Config::Base::Base
Base(const Base &other)
Copy constructor.
StormByte::Multimedia::Pipeline::Config::Video
Video-track encoding intention, or Remux without a codec.
Definition
video.hxx:82
StormByte::Multimedia::Pipeline::Config::Video::Preset
void Preset(StormByte::Safe::String name)
Sets the preset.
StormByte::Multimedia::Pipeline::Config::Video::Video
Video(const Video &other)
Copy constructor.
StormByte::Multimedia::Pipeline::Config::Video::FineTune
const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & FineTune() const noexcept
Vendor leftovers.
Definition
video.hxx:236
StormByte::Multimedia::Pipeline::Config::Video::BitRate
void BitRate(std::int64_t bits_per_second)
Sets target bitrate and clears CRF.
StormByte::Multimedia::Pipeline::Config::Video::Codec
void Codec(const StormByte::Multimedia::Codec &codec) noexcept
Sets the destination codec (Encode).
Definition
video.hxx:158
StormByte::Multimedia::Pipeline::Config::Video::Preset
const StormByte::Safe::Optional< StormByte::Safe::String > & Preset() const noexcept
Encoder preset.
Definition
video.hxx:208
StormByte::Multimedia::Pipeline::Config::Video::BitRate
const StormByte::Safe::Optional< std::int64_t > & BitRate() const noexcept
Target bitrate.
Definition
video.hxx:180
StormByte::Multimedia::Pipeline::Config::Video::CRF
void CRF(double value)
Sets CRF/CQ and clears BitRate.
StormByte::Multimedia::Pipeline::Config::Video::Tune
void Tune(StormByte::Safe::String name)
Sets the tune.
StormByte::Multimedia::Pipeline::Config::Video::CRF
const StormByte::Safe::Optional< double > & CRF() const noexcept
CRF/CQ.
Definition
video.hxx:166
StormByte::Multimedia::Pipeline::Config::Video::~Video
virtual ~Video() noexcept override
Destructor.
StormByte::Multimedia::Pipeline::Config::Video::MaxBitRate
void MaxBitRate(std::int64_t bits_per_second)
Sets VBV ceiling.
StormByte::Multimedia::Pipeline::Config::Video::FineTune
void FineTune(StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options) noexcept
Replaces the vendor dict.
StormByte::Multimedia::Pipeline::Config::Video::Move
PointerType Move() override
Move into a new pointer.
StormByte::Multimedia::Pipeline::Config::Video::Tune
const StormByte::Safe::Optional< StormByte::Safe::String > & Tune() const noexcept
Content tune.
Definition
video.hxx:222
StormByte::Multimedia::Pipeline::Config::Video::Video
Video(Video &&other)
Move constructor.
StormByte::Multimedia::Pipeline::Config::Video::Clone
PointerType Clone() const override
Deep copy.
StormByte::Multimedia::Pipeline::Config::Video::MaxBitRate
const StormByte::Safe::Optional< std::int64_t > & MaxBitRate() const noexcept
VBV ceiling.
Definition
video.hxx:194
StormByte::Multimedia::Pipeline::Config::Video::Video
Video()
Empty video config (Remux until Codec is set).
StormByte::Multimedia::Pipeline::Config::Video::Codec
const StormByte::Multimedia::Codec * Codec() const noexcept
Destination codec.
Definition
video.hxx:150
StormByte::Safe::Clonable< Base, StormByte::Safe::Unique< Base > >::PointerType
SmartPointer PointerType
StormByte::Safe::Map
StormByte::Safe::Optional
StormByte::Safe::String
codec.hxx
Multimedia
Multimedia module of the StormByte suite.
StormByte::Multimedia::Pipeline::Config
Per-track intention stored by Plan.
StormByte
Root namespace of the StormByte C++ suite.
visibility.h
STORMBYTE_MULTIMEDIA_PUBLIC
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition
visibility.h:61
lib
public
StormByte
multimedia
pipeline
config
video.hxx
Generated by
1.15.0