StormByte-Multimedia
3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
channel_layout.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
59
namespace
StormByte
{
64
namespace
Multimedia
{
69
namespace
Property
{
74
enum class
STORMBYTE_MULTIMEDIA_PUBLIC
ChannelLayout
{
75
Unknown
,
76
Mono
,
77
Stereo
,
78
TwoPointOne
,
79
ThreePointZero
,
80
FourPointZero
,
81
Quad
,
82
FivePointZero
,
83
FivePointOne
,
84
SixPointOne
,
85
SevenPointOne
,
86
SevenPointOneW
,
87
Octagonal
,
88
TwentyTwoPointTwo
89
};
90
96
constexpr
const
char
*
ToString
(
ChannelLayout
layout)
noexcept
{
97
switch
(layout) {
98
case
ChannelLayout::Unknown
:
return
"Unknown"
;
99
case
ChannelLayout::Mono
:
return
"Mono"
;
100
case
ChannelLayout::Stereo
:
return
"Stereo"
;
101
case
ChannelLayout::TwoPointOne
:
return
"2.1"
;
102
case
ChannelLayout::ThreePointZero
:
return
"3.0"
;
103
case
ChannelLayout::FourPointZero
:
return
"4.0"
;
104
case
ChannelLayout::Quad
:
return
"Quad"
;
105
case
ChannelLayout::FivePointZero
:
return
"5.0"
;
106
case
ChannelLayout::FivePointOne
:
return
"5.1"
;
107
case
ChannelLayout::SixPointOne
:
return
"6.1"
;
108
case
ChannelLayout::SevenPointOne
:
return
"7.1"
;
109
case
ChannelLayout::SevenPointOneW
:
return
"7.1W"
;
110
case
ChannelLayout::Octagonal
:
return
"Octagonal"
;
111
case
ChannelLayout::TwentyTwoPointTwo
:
return
"22.2"
;
112
default
:
return
"Invalid"
;
113
}
114
}
115
121
constexpr
unsigned
ChannelCount
(
ChannelLayout
layout)
noexcept
{
122
switch
(layout) {
123
case
ChannelLayout::Mono
:
return
1;
124
case
ChannelLayout::Stereo
:
return
2;
125
case
ChannelLayout::TwoPointOne
:
return
3;
126
case
ChannelLayout::ThreePointZero
:
return
3;
127
case
ChannelLayout::FourPointZero
:
return
4;
128
case
ChannelLayout::Quad
:
return
4;
129
case
ChannelLayout::FivePointZero
:
return
5;
130
case
ChannelLayout::FivePointOne
:
return
6;
131
case
ChannelLayout::SixPointOne
:
return
7;
132
case
ChannelLayout::SevenPointOne
:
return
8;
133
case
ChannelLayout::SevenPointOneW
:
return
8;
134
case
ChannelLayout::Octagonal
:
return
8;
135
case
ChannelLayout::TwentyTwoPointTwo
:
return
24;
136
default
:
return
0;
137
}
138
}
139
}
140
}
141
}
StormByte::Multimedia::Property
Media property value types.
StormByte::Multimedia::Property::ChannelCount
constexpr unsigned ChannelCount(ChannelLayout layout) noexcept
Channel count of a standard layout.
Definition
channel_layout.hxx:121
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
ChannelLayout
Curated speaker layouts.
Definition
channel_layout.hxx:74
StormByte::Multimedia::Property::ChannelLayout::TwentyTwoPointTwo
@ TwentyTwoPointTwo
22.2
Definition
channel_layout.hxx:88
StormByte::Multimedia::Property::ChannelLayout::SevenPointOneW
@ SevenPointOneW
7.1 wide
Definition
channel_layout.hxx:86
StormByte::Multimedia::Property::ChannelLayout::FourPointZero
@ FourPointZero
4.0
Definition
channel_layout.hxx:80
StormByte::Multimedia::Property::ChannelLayout::FivePointOne
@ FivePointOne
5.1
Definition
channel_layout.hxx:83
StormByte::Multimedia::Property::ChannelLayout::ThreePointZero
@ ThreePointZero
3.0
Definition
channel_layout.hxx:79
StormByte::Multimedia::Property::ChannelLayout::Mono
@ Mono
1.0
Definition
channel_layout.hxx:76
StormByte::Multimedia::Property::ChannelLayout::SixPointOne
@ SixPointOne
6.1
Definition
channel_layout.hxx:84
StormByte::Multimedia::Property::ChannelLayout::Unknown
@ Unknown
Unlisted or missing.
Definition
channel_layout.hxx:75
StormByte::Multimedia::Property::ChannelLayout::FivePointZero
@ FivePointZero
5.0
Definition
channel_layout.hxx:82
StormByte::Multimedia::Property::ChannelLayout::SevenPointOne
@ SevenPointOne
7.1
Definition
channel_layout.hxx:85
StormByte::Multimedia::Property::ChannelLayout::TwoPointOne
@ TwoPointOne
2.1
Definition
channel_layout.hxx:78
StormByte::Multimedia::Property::ChannelLayout::Stereo
@ Stereo
2.0
Definition
channel_layout.hxx:77
StormByte::Multimedia::Property::ChannelLayout::Quad
@ Quad
Quad.
Definition
channel_layout.hxx:81
StormByte::Multimedia::Property::ChannelLayout::Octagonal
@ Octagonal
8.0 octagonal
Definition
channel_layout.hxx:87
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
channel_layout.hxx
Generated by
1.15.0