StormByte-Multimedia
3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
pixel_format.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/visibility.h
>
54
55
#include <cstdint>
56
61
namespace
StormByte
{
66
namespace
Multimedia
{
71
namespace
Property
{
76
enum class
STORMBYTE_MULTIMEDIA_PUBLIC
PixelFormat
{
77
Unknown
,
78
YUV420P
,
79
YUV422P
,
80
YUV444P
,
81
YUV420P10
,
82
YUV422P10
,
83
YUV444P10
,
84
YUV420P12
,
85
YUV422P12
,
86
YUV444P12
,
87
NV12
,
88
NV21
,
89
P010
,
90
RGB24
,
91
BGR24
,
92
RGBA
,
93
BGRA
,
94
GRAY8
,
95
GRAY10
,
96
GRAY16
97
};
98
104
constexpr
const
char
*
ToString
(
PixelFormat
format)
noexcept
{
105
switch
(format) {
106
case
PixelFormat::Unknown
:
return
"Unknown"
;
107
case
PixelFormat::YUV420P
:
return
"YUV420P"
;
108
case
PixelFormat::YUV422P
:
return
"YUV422P"
;
109
case
PixelFormat::YUV444P
:
return
"YUV444P"
;
110
case
PixelFormat::YUV420P10
:
return
"YUV420P10"
;
111
case
PixelFormat::YUV422P10
:
return
"YUV422P10"
;
112
case
PixelFormat::YUV444P10
:
return
"YUV444P10"
;
113
case
PixelFormat::YUV420P12
:
return
"YUV420P12"
;
114
case
PixelFormat::YUV422P12
:
return
"YUV422P12"
;
115
case
PixelFormat::YUV444P12
:
return
"YUV444P12"
;
116
case
PixelFormat::NV12
:
return
"NV12"
;
117
case
PixelFormat::NV21
:
return
"NV21"
;
118
case
PixelFormat::P010
:
return
"P010"
;
119
case
PixelFormat::RGB24
:
return
"RGB24"
;
120
case
PixelFormat::BGR24
:
return
"BGR24"
;
121
case
PixelFormat::RGBA
:
return
"RGBA"
;
122
case
PixelFormat::BGRA
:
return
"BGRA"
;
123
case
PixelFormat::GRAY8
:
return
"GRAY8"
;
124
case
PixelFormat::GRAY10
:
return
"GRAY10"
;
125
case
PixelFormat::GRAY16
:
return
"GRAY16"
;
126
default
:
return
"Invalid"
;
127
}
128
}
129
135
constexpr
std::uint8_t
BitDepth
(
PixelFormat
format)
noexcept
{
136
switch
(format) {
137
case
PixelFormat::YUV420P
:
138
case
PixelFormat::YUV422P
:
139
case
PixelFormat::YUV444P
:
140
case
PixelFormat::NV12
:
141
case
PixelFormat::NV21
:
142
case
PixelFormat::RGB24
:
143
case
PixelFormat::BGR24
:
144
case
PixelFormat::RGBA
:
145
case
PixelFormat::BGRA
:
146
case
PixelFormat::GRAY8
:
147
return
8;
148
case
PixelFormat::YUV420P10
:
149
case
PixelFormat::YUV422P10
:
150
case
PixelFormat::YUV444P10
:
151
case
PixelFormat::P010
:
152
case
PixelFormat::GRAY10
:
153
return
10;
154
case
PixelFormat::YUV420P12
:
155
case
PixelFormat::YUV422P12
:
156
case
PixelFormat::YUV444P12
:
157
return
12;
158
case
PixelFormat::GRAY16
:
159
return
16;
160
default
:
161
return
0;
162
}
163
}
164
}
165
}
166
}
StormByte::Multimedia::Property
Media property value types.
StormByte::Multimedia::Property::ToString
constexpr const char * ToString(ChannelLayout layout) noexcept
Converts a ChannelLayout to a string.
Definition
channel_layout.hxx:96
StormByte::Multimedia::Property::ChannelLayout::Unknown
@ Unknown
Unlisted or missing.
Definition
channel_layout.hxx:75
StormByte::Multimedia::Property::BitDepth
constexpr std::uint8_t BitDepth(PixelFormat format) noexcept
Component bit depth of format.
Definition
pixel_format.hxx:135
StormByte::Multimedia::Property::PixelFormat
PixelFormat
Curated pixel formats.
Definition
pixel_format.hxx:76
StormByte::Multimedia::Property::PixelFormat::RGB24
@ RGB24
Packed RGB 8-bit.
Definition
pixel_format.hxx:90
StormByte::Multimedia::Property::PixelFormat::YUV444P10
@ YUV444P10
Planar YUV 4:4:4 10-bit.
Definition
pixel_format.hxx:83
StormByte::Multimedia::Property::PixelFormat::YUV444P
@ YUV444P
Planar YUV 4:4:4 8-bit.
Definition
pixel_format.hxx:80
StormByte::Multimedia::Property::PixelFormat::NV12
@ NV12
Semi-planar YUV 4:2:0 8-bit.
Definition
pixel_format.hxx:87
StormByte::Multimedia::Property::PixelFormat::YUV422P12
@ YUV422P12
Planar YUV 4:2:2 12-bit.
Definition
pixel_format.hxx:85
StormByte::Multimedia::Property::PixelFormat::GRAY16
@ GRAY16
Gray 16-bit.
Definition
pixel_format.hxx:96
StormByte::Multimedia::Property::PixelFormat::YUV422P10
@ YUV422P10
Planar YUV 4:2:2 10-bit.
Definition
pixel_format.hxx:82
StormByte::Multimedia::Property::PixelFormat::BGRA
@ BGRA
Packed BGRA 8-bit.
Definition
pixel_format.hxx:93
StormByte::Multimedia::Property::PixelFormat::GRAY10
@ GRAY10
Gray 10-bit.
Definition
pixel_format.hxx:95
StormByte::Multimedia::Property::PixelFormat::Unknown
@ Unknown
Unlisted or missing.
Definition
pixel_format.hxx:77
StormByte::Multimedia::Property::PixelFormat::NV21
@ NV21
Semi-planar YUV 4:2:0 8-bit (VU).
Definition
pixel_format.hxx:88
StormByte::Multimedia::Property::PixelFormat::GRAY8
@ GRAY8
Gray 8-bit.
Definition
pixel_format.hxx:94
StormByte::Multimedia::Property::PixelFormat::YUV420P10
@ YUV420P10
Planar YUV 4:2:0 10-bit.
Definition
pixel_format.hxx:81
StormByte::Multimedia::Property::PixelFormat::P010
@ P010
Semi-planar YUV 4:2:0 10-bit.
Definition
pixel_format.hxx:89
StormByte::Multimedia::Property::PixelFormat::YUV422P
@ YUV422P
Planar YUV 4:2:2 8-bit.
Definition
pixel_format.hxx:79
StormByte::Multimedia::Property::PixelFormat::RGBA
@ RGBA
Packed RGBA 8-bit.
Definition
pixel_format.hxx:92
StormByte::Multimedia::Property::PixelFormat::YUV444P12
@ YUV444P12
Planar YUV 4:4:4 12-bit.
Definition
pixel_format.hxx:86
StormByte::Multimedia::Property::PixelFormat::YUV420P
@ YUV420P
Planar YUV 4:2:0 8-bit.
Definition
pixel_format.hxx:78
StormByte::Multimedia::Property::PixelFormat::YUV420P12
@ YUV420P12
Planar YUV 4:2:0 12-bit.
Definition
pixel_format.hxx:84
StormByte::Multimedia::Property::PixelFormat::BGR24
@ BGR24
Packed BGR 8-bit.
Definition
pixel_format.hxx:91
StormByte::Multimedia
Multimedia module of the StormByte suite.
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
property
pixel_format.hxx
Generated by
1.15.0