StormByte-Multimedia
3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
audio.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
{
86
class
STORMBYTE_MULTIMEDIA_PUBLIC
Audio
:
public
Base
{
87
public
:
92
96
Audio
();
97
102
Audio
(
const
Audio
& other);
103
108
Audio
(
Audio
&& other);
109
113
virtual
~Audio
() noexcept override;
114
120
Audio
& operator=(const
Audio
& other);
121
127
Audio
& operator=(
Audio
&& other) noexcept;
128
132
137
PointerType
Clone
() const override;
138
143
PointerType
Move
() override;
144
149
155
inline const
StormByte
::
Multimedia
::
Codec
*
Codec
() const noexcept {
156
return
m_codec;
157
}
158
164
inline
void
Codec
(
const
StormByte::Multimedia::Codec
& codec)
noexcept
{
165
m_codec = &codec;
166
}
167
173
inline
const
StormByte::Safe::Optional<double>
&
CRF
() const noexcept {
174
return
m_crf;
175
}
176
182
void
CRF
(
double
value);
183
189
inline
const
StormByte::Safe::Optional<std::int64_t>
&
BitRate
() const noexcept {
190
return
m_bitRate;
191
}
192
198
void
BitRate
(std::int64_t bits_per_second);
199
204
inline
const
StormByte::Safe::Optional<std::int64_t>
&
MaxBitRate
() const noexcept {
205
return
m_maxBitRate;
206
}
207
213
void
MaxBitRate
(std::int64_t bits_per_second);
214
219
inline
const
StormByte::Safe::Optional<StormByte::Safe::String>
&
Preset
() const noexcept {
220
return
m_preset;
221
}
222
228
void
Preset
(
StormByte::Safe::String
name);
229
235
inline
const
StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>
&
FineTune
() const noexcept {
236
return
m_fineTune;
237
}
238
243
void
FineTune
(
StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>
options)
noexcept
;
244
248
249
private
:
250
const
StormByte::Multimedia::Codec
* m_codec;
251
StormByte::Safe::Optional<double>
m_crf;
252
StormByte::Safe::Optional<std::int64_t>
m_bitRate;
253
StormByte::Safe::Optional<std::int64_t>
m_maxBitRate;
254
StormByte::Safe::Optional<StormByte::Safe::String>
m_preset;
255
StormByte::Safe::Map<StormByte::Safe::String, StormByte::Safe::String>
m_fineTune;
256
};
257
}
258
262
STORMBYTE_DECLARE_MAYBE_SAFE
(
StormByte::Multimedia::Pipeline::Config::Audio
);
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::Audio
Audio-track encoding intention, or Remux without a codec.
Definition
audio.hxx:86
StormByte::Multimedia::Pipeline::Config::Audio::FineTune
const StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > & FineTune() const noexcept
Vendor leftovers.
Definition
audio.hxx:235
StormByte::Multimedia::Pipeline::Config::Audio::Move
PointerType Move() override
Move into a new pointer in Multimedia.
StormByte::Multimedia::Pipeline::Config::Audio::~Audio
virtual ~Audio() noexcept override
Destructor.
StormByte::Multimedia::Pipeline::Config::Audio::BitRate
const StormByte::Safe::Optional< std::int64_t > & BitRate() const noexcept
Target bitrate.
Definition
audio.hxx:189
StormByte::Multimedia::Pipeline::Config::Audio::Codec
const StormByte::Multimedia::Codec * Codec() const noexcept
Destination codec.
Definition
audio.hxx:155
StormByte::Multimedia::Pipeline::Config::Audio::Audio
Audio(Audio &&other)
Move constructor.
StormByte::Multimedia::Pipeline::Config::Audio::CRF
void CRF(double value)
Sets constant quality and clears BitRate.
StormByte::Multimedia::Pipeline::Config::Audio::Preset
void Preset(StormByte::Safe::String name)
Sets the preset.
StormByte::Multimedia::Pipeline::Config::Audio::FineTune
void FineTune(StormByte::Safe::Map< StormByte::Safe::String, StormByte::Safe::String > options) noexcept
Replaces the vendor dict.
StormByte::Multimedia::Pipeline::Config::Audio::CRF
const StormByte::Safe::Optional< double > & CRF() const noexcept
Constant quality in the encoder's native scale.
Definition
audio.hxx:173
StormByte::Multimedia::Pipeline::Config::Audio::Preset
const StormByte::Safe::Optional< StormByte::Safe::String > & Preset() const noexcept
Encoder preset, if the implementation has one.
Definition
audio.hxx:219
StormByte::Multimedia::Pipeline::Config::Audio::Audio
Audio(const Audio &other)
Copy constructor.
StormByte::Multimedia::Pipeline::Config::Audio::Clone
PointerType Clone() const override
Deep copy in Multimedia; the registry codec remains borrowed.
StormByte::Multimedia::Pipeline::Config::Audio::MaxBitRate
void MaxBitRate(std::int64_t bits_per_second)
Sets maximum bitrate.
StormByte::Multimedia::Pipeline::Config::Audio::BitRate
void BitRate(std::int64_t bits_per_second)
Sets target bitrate and clears CRF.
StormByte::Multimedia::Pipeline::Config::Audio::MaxBitRate
const StormByte::Safe::Optional< std::int64_t > & MaxBitRate() const noexcept
Maximum bitrate.
Definition
audio.hxx:204
StormByte::Multimedia::Pipeline::Config::Audio::Audio
Audio()
Empty audio config (Remux until Codec is set).
StormByte::Multimedia::Pipeline::Config::Audio::Codec
void Codec(const StormByte::Multimedia::Codec &codec) noexcept
Sets the destination codec (Encode).
Definition
audio.hxx:164
StormByte::Multimedia::Pipeline::Config::Base::Base
Base(const Base &other)
Copy constructor.
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
audio.hxx
Generated by
1.15.0