TestWaveformSource.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* 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 TestWaveformSource_h
#define TestWaveformSource_h
 
#include "VulkanFFTPlan.h"
#include <random>
 
struct __attribute__((packed)) DegradeSerialDataPushConstants
{
    uint32_t numSamples;
    uint32_t samplesPerThread;
    uint32_t rngSeed;
    uint32_t inputOffset;
    float scale;
    float sigma;
};
 
struct __attribute__((packed)) NoisySinePushConstants
{
    uint32_t fpfreq;
    uint32_t numSamples;
    uint32_t samplesPerThread;
    uint32_t rngSeed;
    float startPhase;
    float scale;
    float sigma;
};
 
struct __attribute__((packed)) NoisySineSumPushConstants
{
    uint32_t fpfreq1;
    uint32_t fpfreq2;
    uint32_t numSamples;
    uint32_t samplesPerThread;
    uint32_t rngSeed;
    float startPhase1;
    float startPhase2;
    float scale;
    float sigma;
};
 
class TestWaveformSource
{
public:
    TestWaveformSource(std::minstd_rand& rng);
    virtual ~TestWaveformSource();
 
    TestWaveformSource(const TestWaveformSource&) =delete;
    TestWaveformSource& operator=(const TestWaveformSource&) =delete;
 
    void GenerateNoisySinewave(
        vk::raii::CommandBuffer& cmdBuf,
        std::shared_ptr<QueueHandle> queue,
        UniformAnalogWaveform* wfm,
        float amplitude,
        float startphase,
        float period,
        int64_t sampleperiod,
        size_t depth,
        float noise_stdev = 0.01);
 
    void GenerateNoisySinewaveSum(
        vk::raii::CommandBuffer& cmdBuf,
        std::shared_ptr<QueueHandle> queue,
        UniformAnalogWaveform* wfm,
        float amplitude,
        float startphase1,
        float startphase2,
        float period1,
        float period2,
        int64_t sampleperiod,
        size_t depth,
        float noise_stdev = 0.01);
 
    void GeneratePRBS31(
        vk::raii::CommandBuffer& cmdBuf,
        std::shared_ptr<QueueHandle> queue,
        UniformAnalogWaveform* wfm,
        float amplitude,
        float period,
        int64_t sampleperiod,
        size_t depth,
        bool lpf = true,
        float noise_stdev = 0.01);
 
    void Generate8b10b(
        vk::raii::CommandBuffer& cmdBuf,
        std::shared_ptr<QueueHandle> queue,
        UniformAnalogWaveform* wfm,
        float amplitude,
        float period,
        int64_t sampleperiod,
        size_t depth,
        bool lpf = true,
        float noise_stdev = 0.01);
 
    WaveformBase* GenerateStep(
        float vlo,
        float vhi,
        int64_t sampleperiod,
        size_t depth);
 
    void DegradeSerialData(
        UniformAnalogWaveform* cap,
        int64_t sampleperiod,
        size_t depth,
        bool lpf,
        float noise_stdev,
        vk::raii::CommandBuffer& cmdBuf,
        std::shared_ptr<QueueHandle> queue);
 
protected:
 
    std::minstd_rand& m_rng;
 
    AcceleratorBuffer<float> m_forwardInBuf;
 
    AcceleratorBuffer<float> m_forwardOutBuf;
 
    AcceleratorBuffer<float> m_reverseOutBuf;
 
    std::unique_ptr<VulkanFFTPlan> m_vkForwardPlan;
 
    std::unique_ptr<VulkanFFTPlan> m_vkReversePlan;
 
    double m_cachedBinSize;
 
    AcceleratorBuffer<float> m_resampledSparamSines;
 
    AcceleratorBuffer<float> m_resampledSparamCosines;
 
    ComputePipeline m_rectangularComputePipeline;
 
    ComputePipeline m_channelEmulationComputePipeline;
 
    ComputePipeline m_noisySineComputePipeline;
 
    ComputePipeline m_noisySineSumComputePipeline;
 
    ComputePipeline m_degradeComputePipeline;
 
    SParameters m_sparams;
 
    size_t m_cachedNumPoints;
 
    size_t m_cachedRawSize;
 
    void InterpolateSparameters(float bin_hz, size_t nouts);
};
 
#endif