selector.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2019 Intel Corporation. All rights reserved.
 *
 * Author: Lech Betlej <lech.betlej@linux.intel.com>
 */
 
#ifndef __SOF_AUDIO_SELECTOR_H__
#define __SOF_AUDIO_SELECTOR_H__
 
#include <sof/audio/module_adapter/module/generic.h>
#include <sof/trace/trace.h>
#include <ipc/stream.h>
#if CONFIG_IPC_MAJOR_4
#include <ipc4/base-config.h>
#endif
#include <user/selector.h>
#include <user/trace.h>
#include <stdint.h>
 
struct comp_buffer;
struct comp_dev;
struct cir_buf_source;
struct cir_buf_sink;
 
#define SEL_COEF_ONE_Q10 1024 /* int16(1 * 2^10) */
 
#if CONFIG_IPC_MAJOR_3
#define SEL_SOURCE_1CH 1
#define SEL_SOURCE_2CH 2
#define SEL_SOURCE_4CH 4
 
#define SEL_SINK_1CH 1
#define SEL_SINK_2CH 2
#define SEL_SINK_4CH 4
#else
#define SEL_SOURCE_CHANNELS_MAX 8
 
#define SEL_SINK_CHANNELS_MAX   8
 
#define SEL_MAX_NUM_CONFIGS 8
 
#define SEL_NUM_IN_PIN_FMTS 1
#define SEL_NUM_OUT_PIN_FMTS    1
 
#endif
 
#if CONFIG_IPC_MAJOR_4
typedef void (*sel_func)(struct processing_module *mod,
             const struct cir_buf_source *source,
             struct cir_buf_sink *sink, size_t frames);
 
enum ipc4_selector_config_id {
    IPC4_SELECTOR_COEFFS_CONFIG_ID = 0, 
};
 
struct ipc4_selector_coeffs_config {
    uint8_t source_channels_count; 
    uint8_t sink_channels_count; 
    uint8_t source_channel_config; 
    uint8_t sink_channel_config; 
    int16_t coeffs[SEL_SINK_CHANNELS_MAX][SEL_SOURCE_CHANNELS_MAX];
};
 
enum ipc4_selector_init_payload_fmt {
    IPC4_SEL_INIT_PAYLOAD_BASE_WITH_EXT,
    IPC4_SEL_INIT_PAYLOAD_BASE_WITH_OUT_FMT,
};
 
struct sof_selector_ipc4_pin_config {
    struct ipc4_input_pin_format in_pin;
    struct ipc4_output_pin_format out_pin;
};
 
/*
 * Base module config is not added in this structure because it is handled
 * by module adapter.
 */
struct sof_selector_ipc4_config {
    /*
     * Windows will send the base_config + output_format payload, but Linux will
     * send the base_config + base_config_ext payload, use a union to make the
     * selector module be compatible for both OSes.
     */
    union {
        struct sof_selector_ipc4_pin_config pin_cfg;
        struct ipc4_audio_format output_format;
    };
    enum ipc4_selector_init_payload_fmt init_payload_fmt;
};
 
struct sof_selector_avs_ipc4_config {
    struct ipc4_base_module_cfg base_cfg;
    struct ipc4_audio_format output_format;
};
 
#else
typedef int (*sel_func)(struct comp_dev *dev, struct sof_sink *sink,
             struct sof_source *source, size_t frames);
#endif
 
struct comp_data {
#if CONFIG_IPC_MAJOR_4
    struct sof_selector_ipc4_config sel_ipc4_cfg;
    struct ipc4_selector_coeffs_config coeffs_config;
    struct ipc4_selector_coeffs_config *multi_coeffs_config;
    size_t multi_coeffs_config_size;
#endif
 
    uint32_t source_period_bytes;   
    uint32_t sink_period_bytes; 
    enum sof_ipc_frame source_format;   
    enum sof_ipc_frame sink_format;     
    struct sof_sel_config config;   
    sel_func sel_func;  
    int num_configs;    
    bool passthrough;   
    bool new_config;    
};
 
struct comp_func_map {
    uint16_t source;    
    uint32_t out_channels;  
    sel_func sel_func;  
};
 
extern const struct comp_func_map func_map[];
 
#if CONFIG_IPC_MAJOR_4
sel_func sel_get_processing_function(struct processing_module *mod);
 
#ifdef UNIT_TEST
void sys_comp_module_selector_interface_init(void);
#endif
#else
sel_func sel_get_processing_function(struct comp_dev *dev);
 
#ifdef UNIT_TEST
void sys_comp_selector_init(void);
#endif
#endif
 
#endif /* __SOF_AUDIO_SELECTOR_H__ */