~aleteoryx/muditaos

muditaos/module-audio/Audio/StreamProxy.hpp -rw-r--r-- 1.7 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
// Copyright (c) 2017-2024, Mudita Sp. z.o.o. All rights reserved.
// For licensing, see https://github.com/mudita/MuditaOS/blob/master/LICENSE.md

#pragma once

#include "AbstractStream.hpp"

#include <memory>

namespace audio
{

    /**
     * @brief Proxy for the AbstractStream class allowing to wrap its methods
     * with custom logic.
     */
    class StreamProxy : public AbstractStream
    {
      public:
        /**
         * @brief Construct a new Stream Proxy object
         *
         * @param wrappedStream - stream to wrap.
         */
        explicit StreamProxy(std::shared_ptr<AbstractStream> wrappedStream) noexcept;

        // listener registration
        void registerListener(EventListener *listener) override;
        void unregisterListeners(EventListener *listener) override;

        /// push
        bool push(void *data, std::size_t dataSize) override;
        bool push(const Span &span) override;
        bool push() override;

        /// pop
        bool pop(Span &span) override;

        /// zero copy write
        bool reserve(Span &span) override;
        void commit() override;
        void release() override;

        /// zero copy read
        bool peek(Span &span) override;
        void consume() override;
        void unpeek() override;

        void reset() override;

        [[nodiscard]] auto getInputTraits() const noexcept -> Traits override;
        [[nodiscard]] auto getOutputTraits() const noexcept -> Traits override;
        [[nodiscard]] bool isEmpty() const noexcept override;
        [[nodiscard]] bool isFull() const noexcept override;

      protected:
        auto getWrappedStream() -> AbstractStream &;

      private:
        std::shared_ptr<AbstractStream> wrappedStream;
    };

} // namespace audio