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/property/av_rational.hxx
>
54
#include <
StormByte/multimedia/property/color.hxx
>
55
#include <
StormByte/multimedia/property/dovi.hxx
>
56
#include <
StormByte/multimedia/property/hdr10.hxx
>
57
#include <
StormByte/multimedia/property/resolution.hxx
>
58
#include <
StormByte/multimedia/visibility.h
>
59
#include <StormByte/safe/optional.hxx>
60
65
namespace
StormByte
{
70
namespace
Multimedia
{
75
namespace
Property
{
82
class
STORMBYTE_MULTIMEDIA_PUBLIC
Video
final {
83
public
:
88
Video
();
89
99
Video
(
Color
color,
Resolution
resolution,
100
StormByte::Safe::Optional<HDR10>
hdr10 = std::nullopt,
101
StormByte::Safe::Optional<AVRational>
frameRate = std::nullopt,
102
StormByte::Safe::Optional<AVRational>
sampleAspectRatio = std::nullopt,
103
StormByte::Safe::Optional<class DOVI>
dovi = std::nullopt)
noexcept
;
104
110
Video
(
const
Video
& other);
111
116
Video
(
Video
&& other)
noexcept
;
117
121
~Video
() noexcept;
122
129
Video
& operator=(const
Video
& other);
130
136
Video
& operator=(
Video
&& other) noexcept;
137
142
const class
Color
&
Color
() const noexcept;
143
148
const class
Resolution
&
Resolution
() const noexcept;
149
154
const
StormByte
::
Safe
::Optional<class
HDR10
>&
HDR10
() const noexcept;
155
160
const
StormByte
::
Safe
::Optional<class
DOVI
>&
DOVI
() const noexcept;
161
166
const
StormByte
::
Safe
::Optional<
AVRational
>&
FrameRate
() const noexcept;
167
172
const
StormByte
::
Safe
::Optional<
AVRational
>&
SampleAspectRatio
() const noexcept;
173
174
private:
175
class
Color
m_color;
176
class
Resolution
m_resolution;
177
StormByte
::
Safe
::Optional<class
HDR10
> m_hdr10;
178
StormByte
::
Safe
::Optional<
AVRational
> m_frameRate;
179
StormByte
::
Safe
::Optional<
AVRational
> m_sar;
180
StormByte
::
Safe
::Optional<class
DOVI
> m_dovi;
181
};
182
}
183
}
184
}
185
193
STORMBYTE_DECLARE_MAYBE_SAFE
(
StormByte
::
Multimedia
::
Property
::Video);
av_rational.hxx
STORMBYTE_DECLARE_MAYBE_SAFE
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
StormByte::Multimedia::Property::AVRational
Pair {num, den} matching libavutil AVRational.
Definition
av_rational.hxx:85
StormByte::Multimedia::Property::Video::Color
const class Color & Color() const noexcept
Colorimetry and pixel format.
StormByte::Multimedia::Property::Video::Video
Video(Video &&other) noexcept
Move constructor.
StormByte::Multimedia::Property::Video::Resolution
const class Resolution & Resolution() const noexcept
Frame size.
StormByte::Multimedia::Property::Video::Video
Video(const Video &other)
Copy constructor.
StormByte::Multimedia::Property::Video::FrameRate
const StormByte::Safe::Optional< AVRational > & FrameRate() const noexcept
Stream frame rate, if the container exposed one.
StormByte::Multimedia::Property::Video::DOVI
const StormByte::Safe::Optional< class DOVI > & DOVI() const noexcept
Dolby Vision configuration and decoded metadata, if present.
StormByte::Multimedia::Property::Video::HDR10
const StormByte::Safe::Optional< class HDR10 > & HDR10() const noexcept
Mastering-display metadata, if present.
StormByte::Multimedia::Property::Video::SampleAspectRatio
const StormByte::Safe::Optional< AVRational > & SampleAspectRatio() const noexcept
Pixel aspect ratio (sample_aspect_ratio).
StormByte::Multimedia::Property::Video::Video
Video(Color color, Resolution resolution, StormByte::Safe::Optional< HDR10 > hdr10=std::nullopt, StormByte::Safe::Optional< AVRational > frameRate=std::nullopt, StormByte::Safe::Optional< AVRational > sampleAspectRatio=std::nullopt, StormByte::Safe::Optional< class DOVI > dovi=std::nullopt) noexcept
Constructs video properties.
StormByte::Multimedia::Property::Video::~Video
~Video() noexcept
Destructor.
StormByte::Multimedia::Property::Video::Video
Video()
Constructs unknown video properties without optional metadata.
StormByte::Safe::Optional
color.hxx
dovi.hxx
hdr10.hxx
Multimedia
Multimedia module of the StormByte suite.
Property
Media property value types.
StormByte::Multimedia::Property
Media property value types.
StormByte::Multimedia
Multimedia module of the StormByte suite.
StormByte::Safe
StormByte
Root namespace of the StormByte C++ suite.
resolution.hxx
visibility.h
STORMBYTE_MULTIMEDIA_PUBLIC
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition
visibility.h:61
lib
public
StormByte
multimedia
property
video.hxx
Generated by
1.15.0