DeEmbedFilter.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2025 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef DeEmbedFilter_h
#define DeEmbedFilter_h
 
#include "FFTFilter.h"
 
class DeEmbedFilter : public Filter
{
public:
    DeEmbedFilter(const std::string& color);
    virtual ~DeEmbedFilter();
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
    virtual DataLocation GetInputLocation() override;
 
    static std::string GetProtocolName();
 
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
 
    PROTOCOL_DECODER_INITPROC(DeEmbedFilter)
 
    //Accessors for internal values only used by unit tests
    //TODO: refactor this into a friend class or something?
    size_t test_GetNumPoints()
    { return m_cachedNumPoints; }
 
    size_t test_GetOutLen()
    { return m_cachedOutLen; }
 
    size_t test_GetNouts()
    { return m_cachedNouts; }
 
    AcceleratorBuffer<float>& test_GetCachedInputBuffer()
    { return m_forwardInBuf; }
 
    AcceleratorBuffer<float>& test_GetResampledSines()
    { return m_resampledSparamSines; }
 
    AcceleratorBuffer<float>& test_GetResampledCosines()
    { return m_resampledSparamCosines; }
 
    size_t test_GetIstart()
    { return m_cachedIstart; }
 
protected:
    virtual int64_t GetGroupDelay();
    void DoRefresh(bool invert, vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue);
    virtual void InterpolateSparameters(float bin_hz, bool invert, size_t nouts);
 
    std::string m_maxGainName;
    std::string m_groupDelayTruncModeName;
    std::string m_groupDelayTruncName;
 
    enum TruncationMode
    {
        TRUNC_AUTO,
        TRUNC_MANUAL
    };
 
    float m_cachedMaxGain;
 
    double m_cachedBinSize;
    AcceleratorBuffer<float> m_resampledSparamSines;
    AcceleratorBuffer<float> m_resampledSparamCosines;
 
    size_t m_cachedNumPoints;
    size_t m_cachedOutLen;
    size_t m_cachedNouts;
    size_t m_cachedIstart;
 
    AcceleratorBuffer<float> m_forwardInBuf;
    AcceleratorBuffer<float> m_forwardOutBuf;
    AcceleratorBuffer<float> m_reverseOutBuf;
 
    WaveformCacheKey m_magKey;
    WaveformCacheKey m_angleKey;
 
    SParameterVector m_cachedSparams;
 
    ComputePipeline m_rectangularComputePipeline;
    ComputePipeline m_deEmbedComputePipeline;
    ComputePipeline m_normalizeComputePipeline;
    std::unique_ptr<VulkanFFTPlan> m_vkForwardPlan;
    std::unique_ptr<VulkanFFTPlan> m_vkReversePlan;
};
 
#endif