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_status sac_status_t

SAC Errors and Warnings.

Enums

enum sac_status

SAC Errors and Warnings.

Values:

enumerator SAC_OK = 0

No error nor warning occurred.

enumerator SAC_ERR_NOT_ENOUGH_MEMORY = -1

Errors (negative values)

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

enumerator SAC_ERR_PROC_STAGE_LIMIT_REACHED = -2

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

enumerator SAC_ERR_PROCESSING_STAGE_INIT = -3

An error occurred during the processing stage initialization.

enumerator SAC_ERR_PIPELINE_CFG_INVALID = -4

Pipeline configuration is invalid.

enumerator SAC_ERR_NULL_PTR = -5

A pointer is NULL while it should have been initialized.

enumerator SAC_ERR_MIXER_INIT_FAILURE = -6

An error occurred during the mixer module initialization.

enumerator SAC_ERR_MAXIMUM_REACHED = -7

The maximum number of elements allowed have been reached.

enumerator SAC_ERR_INVALID_CMD = -8

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

enumerator SAC_ERR_FALLBACK_INIT_FAILURE = -9

An error occurred during the fallback module initialization.

enumerator SAC_ERR_BIT_DEPTH = -10

The configured bit depth is invalid.

enumerator SAC_ERR_CHANNEL_COUNT = -11

The configured channel count is invalid.

enumerator SAC_ERR_MIXER_OPTION = -12

The configured mixer option is invalid.

enumerator SAC_ERR_INVALID_ARG = -13

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

enumerator SAC_ERR_NODE_DATA_SIZE_TOO_SMALL = -14

A node is too small for the data that needs to be copied into it.

enumerator SAC_ERR_NOT_INIT = -15

The SAC has not been initialized yet.

enumerator SAC_ERR_FALLBACK_PROC_NOT_FOUND = -16

A fallback process wasn’t found in the processing stage list.

enumerator SAC_ERR_INVALID_PACKET_SIZE = -17

A process received an invalid packet size.

enumerator SAC_WARN_PRODUCER_Q_FULL = 1

Warnings (positive values)

Producer’s queue is full when trying to produce.

enumerator SAC_WARN_CONSUMER_Q_EMPTY = 2

Consumer’s queue is empty when trying to consume.

enumerator SAC_WARN_BUFFERING_NOT_COMPLETE = 3

Initial buffering is not completed when trying to consume.

enumerator SAC_WARN_NO_SAMPLES_TO_PROCESS = 4

Producer’s queue is empty when trying to process.

enumerator SAC_WARN_PROCESSING_Q_EMPTY = 5

The processing queue is empty and no nodes are available for processing.