aic-sdk 0.16.0

ai-coustics Speech Enhancement SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use thiserror::Error;

use aic_sdk_sys::AicErrorCode::{self, *};

/// Error type for AIC SDK operations.
#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum AicError {
    #[error(
        "Parameter value is outside the acceptable range. Check documentation for valid values."
    )]
    ParameterOutOfRange,
    #[error(
        "Processor must be initialized before calling this operation. Call `Processor::initialize` first."
    )]
    ProcessorNotInitialized,
    #[error(
        "Audio configuration (samplerate, num_channels, num_frames) is not supported by the model"
    )]
    AudioConfigUnsupported,
    #[error("Audio buffer configuration differs from the one provided during initialization")]
    AudioConfigMismatch,
    #[error(
        "SDK key was not authorized or process failed to report usage. Check if you have internet connection."
    )]
    EnhancementNotAllowed,
    #[error("Internal error occurred. Contact support.")]
    Internal,
    #[error("License key format is invalid or corrupted. Verify the key was copied correctly.")]
    LicenseFormatInvalid,
    #[error(
        "License version is not compatible with the SDK version. Update SDK or contact support."
    )]
    LicenseVersionUnsupported,
    #[error("License key has expired. Renew your license to continue.")]
    LicenseExpired,
    #[error("The model file is invalid or corrupted. Verify the file is correct.")]
    ModelInvalid,
    #[error("The model file version is not compatible with this SDK version.")]
    ModelVersionUnsupported,
    #[error("The path to the model file is invalid")]
    ModelFilePathInvalid,
    #[error(
        "The model file cannot be opened due to a filesystem error. Verify that the file exists."
    )]
    FileSystemError,
    #[error("The model data is not aligned to 64 bytes.")]
    ModelDataUnaligned,
    #[error("Model download error: {0}")]
    ModelDownload(String),
    #[error("Unknown error code: {0}")]
    Unknown(AicErrorCode::Type),
}

impl From<AicErrorCode::Type> for AicError {
    fn from(error_code: AicErrorCode::Type) -> Self {
        match error_code {
            AIC_ERROR_CODE_NULL_POINTER => {
                // This should never happen in our Rust wrapper, but if it does,
                // it indicates a serious bug in our wrapper logic
                panic!(
                    "Unexpected null pointer error from C library - this is a bug in the Rust wrapper"
                );
            }
            AIC_ERROR_CODE_PARAMETER_OUT_OF_RANGE => AicError::ParameterOutOfRange,
            AIC_ERROR_CODE_PROCESSOR_NOT_INITIALIZED => AicError::ProcessorNotInitialized,
            AIC_ERROR_CODE_AUDIO_CONFIG_UNSUPPORTED => AicError::AudioConfigUnsupported,
            AIC_ERROR_CODE_AUDIO_CONFIG_MISMATCH => AicError::AudioConfigMismatch,
            AIC_ERROR_CODE_ENHANCEMENT_NOT_ALLOWED => AicError::EnhancementNotAllowed,
            AIC_ERROR_CODE_INTERNAL_ERROR => AicError::Internal,
            AIC_ERROR_CODE_LICENSE_FORMAT_INVALID => AicError::LicenseFormatInvalid,
            AIC_ERROR_CODE_LICENSE_VERSION_UNSUPPORTED => AicError::LicenseVersionUnsupported,
            AIC_ERROR_CODE_LICENSE_EXPIRED => AicError::LicenseExpired,
            AIC_ERROR_CODE_MODEL_INVALID => AicError::ModelInvalid,
            AIC_ERROR_CODE_MODEL_VERSION_UNSUPPORTED => AicError::ModelVersionUnsupported,
            AIC_ERROR_CODE_MODEL_FILE_PATH_INVALID => AicError::ModelFilePathInvalid,
            AIC_ERROR_CODE_FILE_SYSTEM_ERROR => AicError::FileSystemError,
            AIC_ERROR_CODE_MODEL_DATA_UNALIGNED => AicError::ModelDataUnaligned,
            code => AicError::Unknown(code),
        }
    }
}

/// Helper function to convert C error codes into Result.
pub(crate) fn handle_error(error_code: AicErrorCode::Type) -> Result<(), AicError> {
    match error_code {
        AIC_ERROR_CODE_SUCCESS => Ok(()),
        code => Err(AicError::from(code)),
    }
}

pub(crate) fn assert_success(error_code: AicErrorCode::Type, message: &str) {
    assert_eq!(error_code, AIC_ERROR_CODE_SUCCESS, "{}", message);
}