Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
pcm_mapper.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Roc Streaming authors
3 *
4 * This Source Code Form is subject to the terms of the Mozilla Public
5 * License, v. 2.0. If a copy of the MPL was not distributed with this
6 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 */
8
9//! @file roc_audio/pcm_mapper.h
10//! @brief PCM format mapper.
11
12#ifndef ROC_AUDIO_PCM_MAPPER_H_
13#define ROC_AUDIO_PCM_MAPPER_H_
14
17#include "roc_core/stddefs.h"
18
19namespace roc {
20namespace audio {
21
22//! PCM format mapper.
23//! Convert between PCM formats.
24class PcmMapper : public core::NonCopyable<> {
25public:
26 //! Initialize.
27 PcmMapper(const PcmFormat& input_fmt, const PcmFormat& output_fmt);
28
29 //! Get input format.
30 const PcmFormat& input_format() const;
31
32 //! Get output format.
33 const PcmFormat& output_format() const;
34
35 //! Get number of input samples per channel for given number of bytes.
36 size_t input_sample_count(size_t input_bytes) const;
37
38 //! Get number of input samples per channel for given number of bytes.
39 size_t output_sample_count(size_t output_bytes) const;
40
41 //! Get number of input bytes for given number of samples per channel.
42 size_t input_byte_count(size_t input_samples) const;
43
44 //! Get number of output bytes for given number of samples per channel.
45 size_t output_byte_count(size_t output_samples) const;
46
47 //! Get number of input bits for given number of samples per channel.
48 size_t input_bit_count(size_t input_samples) const;
49
50 //! Get number of output bits for given number of samples per channel.
51 size_t output_bit_count(size_t output_samples) const;
52
53 //! Map samples from input to output format.
54 //! @remarks
55 //! @p in_data is a pointer to input buffer
56 //! @p in_byte_size is size of input buffer in bytes
57 //! @p in_bit_off is an offset in input buffer in bits
58 //! @p out_data is a pointer to output buffer
59 //! @p out_byte_size is size of output buffer in bytes
60 //! @p out_bit_off is an offset in output buffer in bits
61 //! @p n_samples is number of input and output samples for all channels
62 //! @returns
63 //! number of samples actually mapped, which may be truncated if
64 //! input or output buffer is smaller than requested
65 //! @note
66 //! updates @p in_bit_off and @p out_bit_off
67 size_t map(const void* in_data,
68 size_t in_byte_size,
69 size_t& in_bit_off,
70 void* out_data,
71 size_t out_byte_size,
72 size_t& out_bit_off,
73 size_t n_samples);
74
75private:
76 const PcmFormat input_fmt_;
77 const PcmFormat output_fmt_;
78
79 const size_t input_sample_bits_;
80 const size_t output_sample_bits_;
81
82 void (*const map_func_)(const uint8_t* in_data,
83 size_t& in_bit_off,
84 uint8_t* out_data,
85 size_t& out_bit_off,
86 size_t n_samples);
87};
88
89} // namespace audio
90} // namespace roc
91
92#endif // ROC_AUDIO_PCM_MAPPER_H_
PCM format mapper. Convert between PCM formats.
Definition pcm_mapper.h:24
size_t output_sample_count(size_t output_bytes) const
Get number of input samples per channel for given number of bytes.
const PcmFormat & output_format() const
Get output format.
size_t map(const void *in_data, size_t in_byte_size, size_t &in_bit_off, void *out_data, size_t out_byte_size, size_t &out_bit_off, size_t n_samples)
Map samples from input to output format.
size_t output_bit_count(size_t output_samples) const
Get number of output bits for given number of samples per channel.
size_t input_sample_count(size_t input_bytes) const
Get number of input samples per channel for given number of bytes.
size_t input_bit_count(size_t input_samples) const
Get number of input bits for given number of samples per channel.
size_t input_byte_count(size_t input_samples) const
Get number of input bytes for given number of samples per channel.
PcmMapper(const PcmFormat &input_fmt, const PcmFormat &output_fmt)
Initialize.
size_t output_byte_count(size_t output_samples) const
Get number of output bytes for given number of samples per channel.
const PcmFormat & input_format() const
Get input format.
Base class for non-copyable objects.
Definition noncopyable.h:23
Root namespace.
Non-copyable object.
PCM format.
Commonly used types and functions.
PCM format description.
Definition pcm_format.h:61