~aleteoryx/muditaos

muditaos/module-audio/Audio/StreamFactory.cpp -rw-r--r-- 5.6 KiB
a405cad6Aleteoryx trim readme 6 days ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
// Copyright (c) 2017-2024, Mudita Sp. z.o.o. All rights reserved.
// For licensing, see https://github.com/mudita/MuditaOS/blob/master/LICENSE.md

#include "StreamFactory.hpp"
#include "Endpoint.hpp"

#include "transcode/TransformFactory.hpp"

#include <Math.hpp>
#include <log/log.hpp>

#include <algorithm>
#include <chrono>
#include <stdexcept>
#include <memory>
#include <optional>

#include <cassert>
#include <cmath>

using audio::Stream;
using audio::StreamFactory;
using audio::transcode::InputTranscodeProxy;
using audio::transcode::Transform;
using audio::transcode::TransformFactory;
using namespace std::chrono_literals;

StreamFactory::StreamFactory(std::chrono::milliseconds operationPeriodRequirement)
    : periodRequirement(operationPeriodRequirement)
{}

auto StreamFactory::makeStream(Source &source, Sink &sink) -> std::unique_ptr<AbstractStream>
{
    auto sourceFormat = source.getSourceFormat();
    auto sinkFormat   = sink.getSinkFormat();

    if (sourceFormat == sinkFormat) {
        return makeStream(source.getTraits(), sink.getTraits(), sourceFormat);
    }
    else {
        auto transformFactory = TransformFactory();
        auto transform        = transformFactory.makeTransform(sourceFormat, sinkFormat);

        return makeInputTranscodingStream(source, sink, sinkFormat, std::move(transform));
    }
}

auto StreamFactory::makeStream(Traits sourceTraits, Traits sinkTraits, AudioFormat streamFormat)
    -> std::unique_ptr<Stream>
{
    const auto endpointsTraits  = {sourceTraits, sinkTraits};
    const auto timingConstraint = getTimingConstraints(std::initializer_list<std::optional<std::chrono::milliseconds>>{
        sinkTraits.timeConstraint, sourceTraits.timeConstraint, periodRequirement});
    auto blockSizeConstraint = getBlockSizeConstraint(endpointsTraits);
    auto &streamAllocator    = negotiateAllocator(endpointsTraits);

    if (streamFormat == audio::nullFormat) {
        throw std::invalid_argument("No source format provided");
    }

    if (!blockSizeConstraint.has_value()) {
        blockSizeConstraint = binary::ceilPowerOfTwo(streamFormat.microsecondsToBytes(timingConstraint));
    }

    const auto blockTransferDuration =
        std::chrono::duration<double, std::milli>(streamFormat.bytesToMicroseconds(blockSizeConstraint.value()));
    const auto streamBuffering =
        static_cast<unsigned int>(std::ceil(timingConstraint / blockTransferDuration)) * defaultBuffering;

    LOG_DEBUG("Creating audio stream: block size = %lu bytes; buffering = %u -> stream buffer size = %lu bytes",
              static_cast<unsigned long>(blockSizeConstraint.value()),
              streamBuffering,
              static_cast<unsigned long>(blockSizeConstraint.value() * streamBuffering));

    return std::make_unique<Stream>(streamFormat, streamAllocator, blockSizeConstraint.value(), streamBuffering);
}

auto StreamFactory::makeStream(Source &source, Sink &sink, AudioFormat streamFormat) -> std::unique_ptr<Stream>
{
    return makeStream(source.getTraits(), sink.getTraits(), streamFormat);
}

auto StreamFactory::makeInputTranscodingStream(Source &source,
                                               Sink &sink,
                                               AudioFormat streamFormat,
                                               std::shared_ptr<Transform> transform)
    -> std::unique_ptr<InputTranscodeProxy>
{
    auto sourceTraits = source.getTraits();

    if (sourceTraits.blockSizeConstraint.has_value()) {
        sourceTraits.blockSizeConstraint = transform->transformBlockSize(sourceTraits.blockSizeConstraint.value());
    }

    auto stream            = makeStream(sourceTraits, sink.getTraits(), streamFormat);
    auto transcodingStream = std::make_unique<InputTranscodeProxy>(std::move(stream), transform);

    return transcodingStream;
}

auto StreamFactory::getBlockSizeConstraint(std::initializer_list<audio::Endpoint::Traits> traitsList) const
    -> std::optional<std::size_t>
{
    std::optional<std::size_t> blockSize = std::nullopt;

    for (const auto &traits : traitsList) {
        if (!traits.blockSizeConstraint.has_value()) {
            continue;
        }

        auto blockSizeCandidate = traits.blockSizeConstraint.value();
        if (blockSizeCandidate == 0) {
            throw std::invalid_argument("Invalid stream block size");
        }

        if (!blockSize.has_value()) {
            blockSize = blockSizeCandidate;
        }
        else if (blockSize != blockSizeCandidate) {
            throw std::invalid_argument("Block size mismatch");
        }
    }

    return blockSize;
}

auto StreamFactory::getTimingConstraints(
    std::initializer_list<std::optional<std::chrono::milliseconds>> timingConstraints) const
    -> std::chrono::milliseconds
{
    auto constraint = std::max(timingConstraints, [](const auto &left, const auto &right) {
        return right.value_or(std::chrono::milliseconds(0)).count() >
               left.value_or(std::chrono::milliseconds(0)).count();
    });

    if (!constraint.has_value()) {
        throw std::invalid_argument("At least one timing constraint must be provided");
    }

    return constraint.value();
}

auto StreamFactory::negotiateAllocator(std::initializer_list<audio::Endpoint::Traits> traitsList) noexcept
    -> Stream::Allocator &
{
    auto mustUseDMA =
        std::any_of(std::begin(traitsList), std::end(traitsList), [](const auto &trait) { return trait.usesDMA; });
    if (mustUseDMA) {
        LOG_DEBUG("Using fast memory allocator for audio streaming");
        return nonCacheableAlloc;
    }
    else {
        LOG_DEBUG("Using standard allocator for audio streaming");
        return stdAlloc;
    }
}