intel_adsp::DetectorModuleInterface Class Reference

#include <src/include/sof/audio/module_adapter/iadk/processing_module_interface.h>

Inheritance diagram for intel_adsp::DetectorModuleInterface:

Collaboration diagram for intel_adsp::DetectorModuleInterface:

Public Types
enum	State { PROCESSING = 0 , IDLE = 1 }

Public Member Functions
virtual State	GetState (void)=0
virtual uint64_t	GetIdlePeriod (void)=0
virtual void	OnStreamState (uint64_t counter, uint32_t stream_index, State state)=0
virtual void	WritePattern (uint16_t stream_index, OutputStreamBuffer *output_buffer)=0
Public Member Functions inherited from intel_adsp::ProcessingModuleInterface
virtual ErrorCode::Type	Init (void)=0
	Additional method called after module initialization.
virtual ErrorCode::Type	Delete (void)=0
	Destructor that may contain logic executed on module destruction.
virtual uint32_t	Process (InputStreamBuffer *input_stream_buffers, OutputStreamBuffer *output_stream_buffers)=0
	Processes the stream buffers extracted from the input pins and produces the resulting signal in stream buffer of the output pins.
virtual void	Reset (void)=0
	Upon call to this method the ADSP system requires the module to reset its internal state into a well-known initial value.
virtual void	SetProcessingMode (ProcessingMode mode)=0
	Sets the processing mode for the module.
virtual ProcessingMode	GetProcessingMode (void)=0
	Gets the processing mode for the module.
virtual ErrorCode::Type	SetConfiguration (uint32_t config_id, ConfigurationFragmentPosition fragment_position, uint32_t data_offset_size, const uint8_t *fragment_buffer, size_t fragment_size, uint8_t *response, size_t &response_size)=0
	Applies the upcoming configuration message for the given configuration ID.
virtual ErrorCode::Type	GetConfiguration (uint32_t config_id, ConfigurationFragmentPosition fragment_position, uint32_t &data_offset_size, uint8_t *fragment_buffer, size_t &fragment_size)=0
	Retrieves the configuration message for the given configuration ID.

Member Enumeration Documentation

State

enum intel_adsp::DetectorModuleInterface::State

Object processing state

Enumerator
PROCESSING	Data are processed
IDLE	No data are processed

Member Function Documentation

GetIdlePeriod()

virtual uint64_t intel_adsp::DetectorModuleInterface::GetIdlePeriod ( void  )

pure virtual

Get idle period that the module processing are not required

GetState()

virtual State intel_adsp::DetectorModuleInterface::GetState ( void  )

pure virtual

Get processing state of module.

OnStreamState()

virtual void intel_adsp::DetectorModuleInterface::OnStreamState ( uint64_t  counter, uint32_t  stream_index, State  state  )

pure virtual

Method for handle stream processing

WritePattern()

virtual void intel_adsp::DetectorModuleInterface::WritePattern ( uint16_t  stream_index, OutputStreamBuffer *  output_buffer  )

pure virtual

Write a pattern when an output stream resumes processing.

---

The documentation for this class was generated from the following file:

• src/include/sof/audio/module_adapter/iadk/processing_module_interface.h