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
55#include <StormByte/safe/optional.hxx>
56#include <StormByte/safe/string.hxx>
57
58#include <cstdint>
59
64namespace StormByte {
69 namespace Multimedia {
74 namespace Property {
82 public:
88
97 Audio(ChannelLayout layout, std::uint32_t sample_rate, std::uint8_t channels,
98 std::uint64_t bitrate = 0, StormByte::Safe::Optional<StormByte::Safe::String> profile = std::nullopt) noexcept;
99
105 Audio(const Audio& other);
106
111 Audio(Audio&& other) noexcept;
112
116 ~Audio() noexcept;
117
124 Audio& operator=(const Audio& other);
125
131 Audio& operator=(Audio&& other) noexcept;
132
137 ChannelLayout Layout() const noexcept;
138
143 std::uint32_t SampleRate() const noexcept;
144
149 std::uint8_t Channels() const noexcept;
150
155 std::uint64_t BitRate() const noexcept;
156
161 const StormByte::Safe::Optional<StormByte::Safe::String>& Profile() const noexcept;
162
163 private:
164 ChannelLayout m_layout = ChannelLayout::Unknown;
165 std::uint32_t m_sample_rate = 0;
166 std::uint8_t m_channels = 0;
167 std::uint64_t m_bitrate = 0;
168 StormByte::Safe::Optional<StormByte::Safe::String> m_profile;
169 };
170 }
171 }
172}
173
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
std::uint8_t Channels() const noexcept
Channel count.
ChannelLayout Layout() const noexcept
Speaker layout.
std::uint64_t BitRate() const noexcept
Bitrate in bits per second.
Audio()
Constructs unknown audio properties with no codec profile.
std::uint32_t SampleRate() const noexcept
Sample rate in Hz.
const StormByte::Safe::Optional< StormByte::Safe::String > & Profile() const noexcept
Codec profile name, if present.
Audio(Audio &&other) noexcept
Move constructor.
Audio(ChannelLayout layout, std::uint32_t sample_rate, std::uint8_t channels, std::uint64_t bitrate=0, StormByte::Safe::Optional< StormByte::Safe::String > profile=std::nullopt) noexcept
Constructs audio properties.
Audio(const Audio &other)
Copy constructor.
Multimedia module of the StormByte suite.
Media property value types.
ChannelLayout
Curated speaker layouts.
Definition channel_layout.hxx:74
Multimedia module of the StormByte suite.
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61