utility 2026.1.9
A comprehensive C++ utilities library tailored for the development of modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
audio_decoder.hpp
1/*
2 Copyright (c) 2026 ETIB Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of
5 this software and associated documentation files (the "Software"), to deal in
6 the Software without restriction, including without limitation the rights to
7 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8 of the Software, and to permit persons to whom the Software is furnished to do
9 so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22#pragma once
23
24#include <AL/al.h>
25#include <AL/alc.h>
26
27#include <iostream>
28#include <vector>
29#include <cstdint>
30
31#include "utility/system_io/file.hpp"
32
33namespace utility::sound
34{
35 class AudioBuffer;
36
48 struct DecodedAudio {
52 std::vector<std::byte> samples;
53
57 uint32_t sampleRate = 0;
58
66 uint16_t channels = 0;
67
73 uint16_t bitsPerSample = 0;
74
81 ALenum format = 0;
82 };
83
89 enum class AudioDecoderType {
93 WAV,
94
98 MP3,
99
103 UNKNOWN
104 };
105
124 {
125 public:
129 virtual ~AAudioDecoder() = default;
130
142 virtual bool canDecode(const std::string &filePath) const = 0;
143
153 virtual bool canDecode(
154 AudioDecoderType type = AudioDecoderType::UNKNOWN) const = 0;
155
170 virtual std::shared_ptr<AudioBuffer>
171 decode(std::shared_ptr<utility::File> file) = 0;
172
186 ALenum getALFormat(uint16_t channels, uint16_t bitsPerSample) const;
187 };
188} // namespace utility::sound
Abstract base class for audio decoders.
virtual bool canDecode(const std::string &filePath) const =0
Determines whether the decoder supports the specified file.
virtual bool canDecode(AudioDecoderType type=AudioDecoderType::UNKNOWN) const =0
Determines whether the decoder supports the specified audio type.
virtual std::shared_ptr< AudioBuffer > decode(std::shared_ptr< utility::File > file)=0
Decodes an audio file into an AudioBuffer.
ALenum getALFormat(uint16_t channels, uint16_t bitsPerSample) const
Converts audio properties to an OpenAL format.
virtual ~AAudioDecoder()=default
Virtual destructor.
Contains decoded Pulse-Code Modulation (PCM) audio data.
uint16_t bitsPerSample
Number of bits used to represent each sample.
uint16_t channels
Number of audio channels.
std::vector< std::byte > samples
Raw PCM sample data.
ALenum format
OpenAL format corresponding to the decoded audio data.
uint32_t sampleRate
Audio sample rate in hertz.