dsp_buffer.h

Go to the documentation of this file.

#pragma once

 
#include "dll_export.h"
#include <cstddef>
#include <cstdint>
#include <volk/volk.h>
 
namespace satdump
{
    namespace ndsp
    {
        enum dsp_buffer_type_t
        {
            DSP_BUFFER_TYPE_TERMINATOR_PROPAGATING = 0,
            DSP_BUFFER_TYPE_TERMINATOR_NON_PROPAGATING = 1,
            DSP_BUFFER_TYPE_SAMPLES = 2,
            DSP_BUFFER_TYPE_INVALID = 255,
        };
 
        SATDUMP_DLL extern const size_t volk_alignment;

        class DSPBuffer
        {
        private:
            void *ptr = nullptr;
            size_t ptr_size = 0;
 
        public:
            dsp_buffer_type_t type = DSP_BUFFER_TYPE_INVALID;
            uint8_t typesize = 0;
            uint32_t max_size = 0;
            uint32_t size = 0;
 
        public:
            friend class DSPStream;
 
        public:
            template <typename T>
            inline T *getSamples()
            {
                return (T *)ptr;
            }

            inline bool isTerminator() { return type == DSP_BUFFER_TYPE_TERMINATOR_PROPAGATING || type == DSP_BUFFER_TYPE_TERMINATOR_NON_PROPAGATING; }

            inline bool terminatorShouldPropagate() { return type == DSP_BUFFER_TYPE_TERMINATOR_PROPAGATING; }
 
            // /**
            //  * @brief Frees the pointer. This MUST be called once you're
            //  * done doing your DSP with this buffer! Otherwise things will
            //  * leak. BADLY leak!
            //  *
            //  * NOTE TODOREWORK : probably only needed for SAMPLES buffers?
            //  */
            // inline void free() { volk_free(ptr); }
 
            // public:
            //     /**
            //      * @brief Create a terminator buffer
            //      * @param prop Whether this terminator should be propagating
            //      * @return the new DSP buffer
            //      */
            //     static DSPBuffer newBufferTerminator(bool prop = true)
            //     {
            //         DSPBuffer b;
            //         b.type = prop ? DSP_BUFFER_TYPE_TERMINATOR_PROPAGATING : DSP_BUFFER_TYPE_TERMINATOR_NON_PROPAGATING;
            //         return b;
            //     }
 
            //     /**
            //      * @brief Create a sample buffer
            //      * @param size size of the new buffer (max_size,
            //      * size is left at 0)
            //      * @return the new DSP buffer
            //      */
            //     template <typename T>
            //     static DSPBuffer newBufferSamples(uint32_t size)
            //     {
            //         DSPBuffer b;
            //         b.type = DSP_BUFFER_TYPE_SAMPLES;
            //         b.max_size = size;
            //         b.ptr_size = size * sizeof(T);
            //         b.ptr = volk_malloc(b.ptr_size, volk_alignment);
            //         return b;
            //     }
        };
    } // namespace ndsp
} // namespace satdump