xref: /aosp_15_r20/external/libxaac/test/encoder/ixheaace_error.c (revision 15dc779a375ca8b5125643b829a8aa4b70d7f451)
1 /******************************************************************************
2  *                                                                            *
3  * Copyright (C) 2023 The Android Open Source Project
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *****************************************************************************
18  * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
19  */
20 
21 #include <stdio.h>
22 #include <string.h>
23 #include "ixheaac_type_def.h"
24 #include "ixheaac_error_standards.h"
25 #include "ixheaace_error_handler.h"
26 
27 /*****************************************************************************/
28 /* Global memory constants                                                   */
29 /*****************************************************************************/
30 /*****************************************************************************/
31 /* Ittiam enhaacplus_enc ErrorCode Definitions                             */
32 /*****************************************************************************/
33 /*****************************************************************************/
34 /* Class 0: API Errors
35 *****************************************************************************/
36 /* Non Fatal Errors */
37 
38 /* Fatal Errors */
39 pWORD8 ppb_ia_enhaacplus_enc_api_fatal[IA_MAX_ERROR_SUB_CODE] = {
40     (pWORD8) "Memory allocation failed", (pWORD8) "AOT unsupported"};
41 /*****************************************************************************/
42 /* Class 1: Configuration Errors
43 *****************************************************************************/
44 /* Non Fatal Errors */
45 pWORD8 ppb_ia_enhaacplus_enc_config_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
46     (pWORD8) "Invalid configuration", (pWORD8) "Insufficient bit-reservoir size"};
47 
48 pWORD8 ppb_ia_enhaacplus_enc_mps_config_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
49     (pWORD8) "Invalid configuration", (pWORD8) "Invalid Parameter"};
50 
51 pWORD8 ppb_ia_enhaacplus_enc_drc_config_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
52     (pWORD8) "Missing configuration"};
53 
54 /* Fatal Errors */
55 pWORD8 ppb_ia_enhaacplus_enc_config_fatal[IA_MAX_ERROR_SUB_CODE] = {
56     (pWORD8) "Invalid sampling frequency of the stream",
57     (pWORD8) "Invalid number of channels in the stream",
58     (pWORD8) "Invalid stereo preprocessing flag, use 0 or 1",
59     (pWORD8) "Invalid quality level",
60     (pWORD8) "Invalid PCM wordsize",
61     (pWORD8) "Parametric stereo not allowed with AAC classic profiles",
62     (pWORD8) "Invalid TNS flag, use 0 or 1",
63     (pWORD8) "Invalid channels mask",
64     (pWORD8) "Invalid PCE (Program Configuration Element) flag, use 0 or 1",
65     (pWORD8) "Invalid use full band width flag, use 0 or 1",
66 };
67 
68 pWORD8 ppb_ia_enhaacplus_enc_usac_config_fatal[IA_MAX_ERROR_SUB_CODE] = {
69     (pWORD8) "Invalid sampling frequency", (pWORD8) "Invalid resampler ratio"};
70 
71 pWORD8 ppb_ia_enhaacplus_enc_drc_config_fatal[IA_MAX_ERROR_SUB_CODE] = {
72     (pWORD8) "Invalid configuration",
73     (pWORD8) "Unsupported configuration",
74     (pWORD8) "Parameter out of range",
75     (pWORD8) "Compand failure",
76 };
77 
78 /*****************************************************************************/
79 /* Class 2: Initialization Errors
80 *****************************************************************************/
81 /* Non Fatal Errors */
82 
83 pWORD8 ppb_ia_enhaacplus_enc_mps_init_non_fatal[IA_MAX_ERROR_SUB_CODE] = {NULL};
84 
85 pWORD8 ppb_ia_enhaacplus_enc_drc_init_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
86     (pWORD8) "Invalid DRC gain points",  (pWORD8) "Invalid start subband index" };
87 
88 /* Fatal Errors */
89 
90 pWORD8 ppb_ia_enhaacplus_enc_init_fatal[IA_MAX_ERROR_SUB_CODE] = {
91     (pWORD8) "Resampler initialization failed",
92     (pWORD8) "AAC initialization failed",
93     (pWORD8) "AAC Plus initialization failed",
94     (pWORD8) "Bitrate not supported for the given sampling frequency",
95     (pWORD8) "Invalid TNS parameter",
96     (pWORD8) "Scale factor band not supported",
97     (pWORD8) "Invalid core sample rate",
98     (pWORD8) "Invalid element type",
99     (pWORD8) "Number of channels not supported",
100     (pWORD8) "Invalid number of channels in element",
101     (pWORD8) "Scale factor band initalization failed",
102     (pWORD8) "TNS configuration initalization failed" };
103 
104 pWORD8 ppb_ia_enhaacplus_enc_mps_init_fatal[IA_MAX_ERROR_SUB_CODE] = {
105     (pWORD8) "MPS Initialization failed"};
106 
107 pWORD8 ppb_ia_enhaacplus_enc_usac_init_fatal[IA_MAX_ERROR_SUB_CODE] = {
108     (pWORD8) "Resampler initialization failed", (pWORD8) "Insufficient bit-reservoir size",
109     (pWORD8) "Invalid core sample rate", (pWORD8) "Invalid element type",
110     (pWORD8) "Bitbuffer initialization failed", (pWORD8) "Invalid codec mode"};
111 
112 pWORD8 ppb_ia_enhaacplus_enc_drc_init_fatal[IA_MAX_ERROR_SUB_CODE] = {
113     (pWORD8) "Invalid channel index"};
114 
115 pWORD8 ppb_ia_enhaacplus_enc_sbr_init_fatal[IA_MAX_ERROR_SUB_CODE] = {
116     (pWORD8) "Invalid number of channels",     (pWORD8) "Invalid sample rate mode",
117     (pWORD8) "Invalid frequency coefficients", (pWORD8) "Invalid number of bands",
118     (pWORD8) "Invalid buffer length",          (pWORD8) "SBR noise band not supported"};
119 
120 pWORD8 ppb_ia_enhaacplus_enc_ps_init_fatal[IA_MAX_ERROR_SUB_CODE] = {
121     (pWORD8) "PS Initialization failed" };
122 
123 /*****************************************************************************/
124 /* Class 2: Execution Errors
125 *****************************************************************************/
126 /* Non Fatal Errors */
127 pWORD8 ppb_ia_enhaacplus_enc_aac_exe_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
128     (pWORD8) "Quantization zero spectrum detected",
129     (pWORD8) "Insufficient bit reservoir for non zero spectrum"};
130 
131 pWORD8 ppb_ia_enhaacplus_enc_mps_exe_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
132     (pWORD8) "Encoding Failed", (pWORD8) "Invalid MPS data bands"};
133 
134 pWORD8 ppb_ia_enhaacplus_enc_usac_exe_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
135     (pWORD8) "Quantization zero spectrum detected",
136     (pWORD8) "Insufficient bit reservoir for non zero spectrum"};
137 
138 pWORD8 ppb_ia_enhaacplus_enc_esbr_exe_non_fatal[IA_MAX_ERROR_SUB_CODE] = {
139     (pWORD8) "Invalid bandwidth index encountered",
140     (pWORD8) "Invalid number of patches",
141     (pWORD8) "Invalid vocoder buffer",
142     (pWORD8) "Invalid PVC mode",
143     (pWORD8) "Invalid FFT size",
144     (pWORD8) "Invalid start band",
145     (pWORD8) "Invalid value encountered"};
146 
147 /* Fatal Errors */
148 pWORD8 ppb_ia_enhaacplus_enc_exe_fatal[IA_MAX_ERROR_SUB_CODE] = {
149     (pWORD8) "Invalid SBR time slots",
150     (pWORD8) "Invalid SBR input channels",
151     (pWORD8) "Invalid PS hybrid resolution",
152     (pWORD8) "Unsupported Audio Object Type",
153     (pWORD8) "Invalid block type",
154     (pWORD8) "Invalid SBR frame type",
155     (pWORD8) "Invalid SBR number of envelope",
156     (pWORD8) "Invalid SBR bit stream",
157     (pWORD8) "Invalid SBR code book",
158     (pWORD8) "Invalid scale factor gain",
159     (pWORD8) "Invalid bit reservoir level",
160     (pWORD8) "Invalid bit consumption",
161     (pWORD8) "Invalid side information bits",
162     (pWORD8) "Invalid huffman bits",
163     (pWORD8) "Invalid scale factor bits",
164     (pWORD8) "Invalid amplitude resolution",
165     (pWORD8) "Invalid output bytes",
166     (pWORD8) "Invalid TNS filter order",
167     (pWORD8) "Invalid SBR sample rate"};
168 
169 pWORD8 ppb_ia_enhaacplus_enc_mps_exe_fatal[IA_MAX_ERROR_SUB_CODE] = {
170     (pWORD8) "Null data handle",
171     (pWORD8) "Invalid Huffman data type",
172     (pWORD8) "Invalid number of MPS parameter sets",
173     (pWORD8) "Guided envelope shaping is not supported",
174     (pWORD8) "3D stereo mode is not supported",
175     (pWORD8) "Residual coding is not supported",
176     (pWORD8) "Arbitrary Downmix residual coding is not supported",
177     (pWORD8) "Arbitrary trees are not supported",
178     (pWORD8) "Invalid quant coarse",
179     (pWORD8) "Invalid res type",
180     (pWORD8) "Invalid number of PCB levels",
181     (pWORD8) "Error in complex FFT processing"};
182 
183 pWORD8 ppb_ia_enhaacplus_enc_usac_exe_fatal[IA_MAX_ERROR_SUB_CODE] = {
184     (pWORD8) "Invalid FAC length",
185     (pWORD8) "Invalid number of SBK",
186     (pWORD8) "Invalid number of channels",
187     (pWORD8) "Invalid bit reservoir level",
188     (pWORD8) "Invalid mapping",
189     (pWORD8) "Invalid window type",
190     (pWORD8) "Invalid window length",
191     (pWORD8) "Invalid window shape",
192 };
193 
194 /*****************************************************************************/
195 /* error info structure                                                      */
196 /*****************************************************************************/
197 /* The Module's Error Info Structure */
198 ia_error_info_struct ia_enhaacplus_enc_error_info = {
199     /* The Module Name	*/
200     (pWORD8) "libxaac encoder",
201     {/* The Class Names	*/
202      (pWORD8) "API", (pWORD8) "Configuration", (pWORD8) "Initialization", (pWORD8) "Execution",
203      (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "",
204      (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) ""},
205     {/* The Message Pointers	*/
206      {{NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
207        NULL},
208       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
209        NULL},
210       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
211        NULL},
212       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
213        NULL},
214       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
215        NULL},
216       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
217        NULL},
218       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
219        NULL}},
220      {{NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
221        NULL},
222       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
223        NULL},
224       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
225        NULL},
226       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
227        NULL},
228       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
229        NULL},
230       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
231        NULL},
232       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
233        NULL}}}};
234 
ia_enhaacplus_enc_error_handler_init()235 VOID ia_enhaacplus_enc_error_handler_init() {
236   /* The Message Pointers	*/
237   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][0][0] =
238       ppb_ia_enhaacplus_enc_api_fatal;
239   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][1][0] =
240       ppb_ia_enhaacplus_enc_config_non_fatal;
241   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][1][1] =
242       ppb_ia_enhaacplus_enc_mps_config_non_fatal;
243   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][1][3] =
244       ppb_ia_enhaacplus_enc_drc_config_non_fatal;
245   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][1][0] =
246       ppb_ia_enhaacplus_enc_config_fatal;
247   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][1][2] =
248       ppb_ia_enhaacplus_enc_usac_config_fatal;
249   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][1][3] =
250       ppb_ia_enhaacplus_enc_drc_config_fatal;
251   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][2][1] =
252       ppb_ia_enhaacplus_enc_mps_init_non_fatal;
253   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][2][0] =
254       ppb_ia_enhaacplus_enc_init_fatal;
255   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][2][1] =
256       ppb_ia_enhaacplus_enc_mps_init_fatal;
257   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][2][2] =
258       ppb_ia_enhaacplus_enc_usac_init_fatal;
259   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][2][3] =
260       ppb_ia_enhaacplus_enc_drc_init_fatal;
261   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][2][4] =
262       ppb_ia_enhaacplus_enc_sbr_init_fatal;
263   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][2][5] =
264     ppb_ia_enhaacplus_enc_ps_init_fatal;
265   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][3][1] =
266       ppb_ia_enhaacplus_enc_mps_exe_non_fatal;
267   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][3][4] =
268       ppb_ia_enhaacplus_enc_esbr_exe_non_fatal;
269   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][3][0] =
270       ppb_ia_enhaacplus_enc_exe_fatal;
271   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][3][1] =
272       ppb_ia_enhaacplus_enc_mps_exe_fatal;
273   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[1][3][2] =
274       ppb_ia_enhaacplus_enc_usac_exe_fatal;
275   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][3][0] =
276     ppb_ia_enhaacplus_enc_aac_exe_non_fatal;
277   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][3][2] =
278     ppb_ia_enhaacplus_enc_usac_exe_non_fatal;
279   ia_enhaacplus_enc_error_info.ppppb_error_msg_pointers[0][2][3] =
280     ppb_ia_enhaacplus_enc_drc_init_non_fatal;
281 }
282 
ia_error_handler(ia_error_info_struct * p_mod_err_info,WORD8 * pb_context,IA_ERRORCODE code)283 IA_ERRORCODE ia_error_handler(ia_error_info_struct *p_mod_err_info, WORD8 *pb_context,
284                               IA_ERRORCODE code) {
285   if (code == IA_NO_ERROR) {
286     return IA_NO_ERROR;
287   }
288   {
289     WORD32 is_fatal = (((UWORD32)code & 0x8000) >> 15);
290     WORD32 err_class = (((UWORD32)code & 0x7800) >> 11);
291     WORD mod_name = (((UWORD)code & 0x0700) >> 8);
292     WORD32 err_sub_code = (((UWORD32)code & 0x00FF));
293 
294     printf("\n");
295     if (!is_fatal) {
296       printf("non ");
297     }
298     printf("fatal error: ");
299 
300     if (p_mod_err_info->pb_module_name != NULL) {
301       printf("%s: ", p_mod_err_info->pb_module_name);
302     }
303 
304     if (p_mod_err_info->pb_module_name != NULL &&
305         strcmp((const char *)p_mod_err_info->pb_module_name, "ia_testbench")) {
306       switch (mod_name) {
307         case 0:
308           printf("AAC Profile ");
309           break;
310         case 1:
311           printf("MPEG-Surround ");
312           break;
313         case 2:
314           printf("USAC ");
315           break;
316         case 3:
317           printf("DRC ");
318           break;
319         case 4:
320           printf("SBR/eSBR ");
321           break;
322         case 5:
323           printf("Parametric Stereo ");
324           break;
325         default:
326           break;
327       }
328       printf(":");
329     }
330 
331     if (p_mod_err_info->ppb_class_names[err_class] != NULL) {
332       printf("%s: ", p_mod_err_info->ppb_class_names[err_class]);
333     }
334     if (pb_context != NULL) {
335       printf("%s: ", pb_context);
336     }
337     // printf("%s\n",
338     // p_mod_err_info->ppppb_error_msg_pointers[is_fatal][err_class][err_sub_code]);
339     if (err_sub_code >= IA_MAX_ERROR_SUB_CODE ||
340         p_mod_err_info->ppppb_error_msg_pointers[is_fatal][err_class][mod_name][err_sub_code] ==
341             NULL) {
342       printf("error unlisted\n");
343     } else {
344       printf(
345           "%s\n",
346           p_mod_err_info->ppppb_error_msg_pointers[is_fatal][err_class][mod_name][err_sub_code]);
347     }
348   }
349   return IA_NO_ERROR;
350 }
351 
352 /*****************************************************************************/
353 /* ia_testbench ErrorCode Definitions                                        */
354 /*****************************************************************************/
355 /*****************************************************************************/
356 /* Class 0: Memory & File Manager Errors
357 *****************************************************************************/
358 /* Non Fatal Errors */
359 /* Fatal Errors */
360 pWORD8 ppb_ia_testbench_mem_file_man_fatal[IA_MAX_ERROR_SUB_CODE] = {
361     (pWORD8) "Memory Allocation Error", (pWORD8) "File Open Failed"};
362 
363 /*****************************************************************************/
364 /* error info structure                                                      */
365 /*****************************************************************************/
366 /* The Module's Error Info Structure */
367 ia_error_info_struct ia_testbench_error_info = {
368     /* The Module Name	*/
369     (pWORD8) "ia_testbench",
370     {/* The Class Names	*/
371      (pWORD8) "Memory & File Manager", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "",
372      (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) "",
373      (pWORD8) "", (pWORD8) "", (pWORD8) "", (pWORD8) ""},
374     {/* The Message Pointers	*/
375      {{NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
376        NULL},
377       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
378        NULL},
379       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
380        NULL},
381       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
382        NULL},
383       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
384        NULL},
385       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
386        NULL},
387       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
388        NULL}},
389      {{NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
390        NULL},
391       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
392        NULL},
393       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
394        NULL},
395       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
396        NULL},
397       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
398        NULL},
399       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
400        NULL},
401       {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
402        NULL}}}};
403 
ia_testbench_error_handler_init()404 VOID ia_testbench_error_handler_init() {
405   /* The Message Pointers	*/
406   ia_testbench_error_info.ppppb_error_msg_pointers[1][4][0] = ppb_ia_testbench_mem_file_man_fatal;
407 }
408