sac_error.h

SPARK Audio Core error codes.

Copyright

Copyright (C) 2021 SPARK Microsystems International Inc. All rights reserved.

License

This source code is proprietary and subject to the SPARK Microsystems Software EULA found in this package in file EULA.txt.

Author

SPARK FW Team.

Typedefs

typedef enum sac_error sac_error_t

SAC Errors.

Enums

enum sac_error

SAC Errors.

Values:

enumerator SAC_ERR_NONE = 0

No error occurred

enumerator SAC_ERR_NOT_ENOUGH_MEMORY

Not enough memory is allocated by the application for a full audio core initialization

enumerator SAC_ERR_PROC_STAGE_LIMIT_REACHED

Maximum number of processing stages for a given SAC pipeline is already reached when trying to add another one

enumerator SAC_ERR_PRODUCER_Q_FULL

Producer’s queue is full when trying to produce

enumerator SAC_ERR_CONSUMER_Q_EMPTY

Consumer’s queue is empty when trying to consume

enumerator SAC_ERR_BUFFERING_NOT_COMPLETE

Initial buffering is not completed when trying to consume

enumerator SAC_ERR_NO_SAMPLES_TO_PROCESS

Producer’s queue is empty when trying to process

enumerator SAC_ERR_PROCESSING_STAGE_INIT

An error occurred during the processing stage initialization

enumerator SAC_ERR_PIPELINE_CFG_INVALID

Pipeline configuration is invalid

enumerator SAC_ERR_NULL_PTR

A pointer is NULL while it should have been initialized

enumerator SAC_ERR_MIXER_INIT_FAILURE

An error occurred during the mixer module initialization

enumerator SAC_ERR_MAXIMUM_REACHED

The maximum number of elements allowed have been reached

enumerator SAC_ERR_INVALID_CMD

A processing stage’s control function has been called with an invalid command

enumerator SAC_ERR_FALLBACK_INIT_FAILURE

An error occurred during the fallback module initialization

enumerator SAC_ERR_BIT_DEPTH

The configured bit depth is invalid

enumerator SAC_ERR_CHANNEL_COUNT

The configured channel count is invalid

enumerator SAC_ERR_MIXER_OPTION

The configured mixer option is invalid

enumerator SAC_ERR_INVALID_ARG

A processing stage’s control function has been called with an invalid argument