Prefab.hpp

// Copyright 2022 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
#pragma once
 
#include <type_traits>
 
#include "MicArray.hpp"
#include "mic_array/etc/filters_default.h"
 
// This has caused problems previously, so just catch the problems here.
#if defined(MIC_COUNT) || defined(MICS_IN) || defined(FRAME_SIZE) || defined(USE_DCOE)
# error Application must not define the following as precompiler macros: MIC_COUNT, MICS_IN, FRAME_SIZE, USE_DCOE.
#endif
 
namespace mic_array {
 
  namespace prefab {
 
    template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN=MIC_COUNT>
    class BasicMicArray 
        : public MicArray<MIC_COUNT,
                          TwoStageDecimator<MIC_COUNT, STAGE2_DEC_FACTOR, 
                                    STAGE2_TAP_COUNT>,
                          StandardPdmRxService<MICS_IN,MIC_COUNT,STAGE2_DEC_FACTOR>, 
                          // std::conditional uses USE_DCOE to determine which 
                          // sample filter is used.
                          typename std::conditional<USE_DCOE,
                                              DcoeSampleFilter<MIC_COUNT>,
                                              NopSampleFilter<MIC_COUNT>>::type,
                          FrameOutputHandler<MIC_COUNT, FRAME_SIZE, 
                                             ChannelFrameTransmitter>>
    {
 
      public:
 
        using TParent = MicArray<MIC_COUNT,
                                 TwoStageDecimator<MIC_COUNT, STAGE2_DEC_FACTOR, 
                                           STAGE2_TAP_COUNT>,
                                 StandardPdmRxService<MICS_IN,MIC_COUNT,STAGE2_DEC_FACTOR>, 
                                 typename std::conditional<USE_DCOE,
                                            DcoeSampleFilter<MIC_COUNT>,
                                            NopSampleFilter<MIC_COUNT>>::type,
                                 FrameOutputHandler<MIC_COUNT, FRAME_SIZE, 
                                    ChannelFrameTransmitter>>;
 
 
        constexpr BasicMicArray() noexcept {}
 
        void Init();
 
        BasicMicArray(
            port_t p_pdm_mics,
            chanend_t c_frames_out);
 
        void SetPort(
            port_t p_pdm_mics);
 
        void SetOutputChannel(
            chanend_t c_frames_out);
 
        void PdmRxThreadEntry();
 
        void InstallPdmRxISR();
 
        void UnmaskPdmRxISR();
 
 
    };
 
  }
}
 
// Template function implementations below. //
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
void mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>::Init()
{
  this->Decimator.Init((uint32_t*) stage1_coef, stage2_coef, stage2_shr);
}
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>
    ::BasicMicArray(
        port_t p_pdm_mics,
        chanend_t c_frames_out) : TParent(
            StandardPdmRxService<MICS_IN, MIC_COUNT, STAGE2_DEC_FACTOR>(p_pdm_mics), 
            FrameOutputHandler<MIC_COUNT, FRAME_SIZE, 
                ChannelFrameTransmitter>(
                    ChannelFrameTransmitter<MIC_COUNT, FRAME_SIZE>(
                        c_frames_out)))
{
  this->Decimator.Init((uint32_t*) stage1_coef, stage2_coef, stage2_shr);
}
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
void mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>
    ::SetOutputChannel(chanend_t c_frames_out)
{
  this->OutputHandler.FrameTx.SetChannel(c_frames_out);
}
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
void mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>
    ::SetPort(port_t p_pdm_mics)
{
  this->PdmRx.Init(p_pdm_mics);
}
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
void mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>
    ::PdmRxThreadEntry()
{
  this->PdmRx.ThreadEntry();
}
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
void mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>
    ::InstallPdmRxISR()
{
  this->PdmRx.InstallISR();
}
 
 
template <unsigned MIC_COUNT, unsigned FRAME_SIZE, bool USE_DCOE, unsigned MICS_IN>
void mic_array::prefab::BasicMicArray<MIC_COUNT, FRAME_SIZE, USE_DCOE, MICS_IN>
    ::UnmaskPdmRxISR()
{
  this->PdmRx.UnmaskISR();
}