forked from rdkcentral/rdk-halif-device_settings
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dsAudio.h
2075 lines (1977 loc) · 88.4 KB
/
dsAudio.h
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2016 RDK Management
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file dsAudio.h
*
* @brief Device Settings HAL Audio Public APIs.
* These APIs define the HAL for the Device Settings Audio interface.
*
* @par Document
* Document reference.
*
* @par Open Issues (in no particular order)
* -# None
*
* @par Assumptions
* -# None
*
* @par Abbreviations
* - `DS` - Device Settings
* - `HAL` - Hardware Abstraction Layer
* - `API` - Application Programming Interface
* - `Caller` - Any user of the interface via the `APIs`
* - `CB` - Callback function (suffix)
* - `ARC` - Audio Return Channel
* - `eARC` - Enhanced Audio Return Channel
* - `HDMI` - High-Definition Multimedia Interface
* - `LE` - Loudness Equivalence
* - `DRC` - Dynamic Range Control
* - `MI` - Media Intelligent
* - `RF` - Radio Frequency
* - `dB` - Decibel
* - `MS12` - MultiStream 12
* - `AC4` - Audio Compression 4
* - `ms` - milliseconds
* - `CPU` - Central Processing Unit
* - `SAD` - Short Audio Descriptor
* - `DAPV2` - Dolby Audio Processing Version 2
* - `DE` - Dialog Enhacement
*
* @par Implementation Notes
* -# None
*
*/
/**
* @addtogroup HPK Hardware Porting Kit
* @{
* @par The Hardware Porting Kit
* HPK is the next evolution of the well-defined Hardware Abstraction Layer
* (HAL), but augmented with more comprehensive documentation and test suites
* that OEM or SOC vendors can use to self-certify their ports before taking
* them to RDKM for validation or to an operator for final integration and
* deployment. The Hardware Porting Kit effectively enables an OEM and/or SOC
* vendor to self-certify their own Video Accelerator devices, with minimal RDKM
* assistance.
*
*/
/**
* @addtogroup Device_Settings Device Settings Module
* @{
*/
/**
* @addtogroup Device_Settings_HAL Device Settings HAL
* @par Application API Specification
* Described herein are the DeviceSettings HAL types and functions that are part of
* the Audio subsystem. The Audio subsystem manages system-specific HAL operations.
* @{
*/
/**
* @defgroup dsAudio_HAL DS Audio HAL
* @{
* @par Application API Specification
* dsAudio HAL provides an interface for managing the Audio settings for the device settings module
*/
/**
* @defgroup DSHAL_AUDIO_API DS HAL Audio Public APIs
* @{
*/
#ifndef __DS_AUDIO_H__
#define __DS_AUDIO_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include "dsError.h"
#include "dsAVDTypes.h"
/**
* @brief Callback function used to notify the Audio port connection status change to the `caller`.
*
* HAL Implementation should call this method to deliver updated audio port connection event
* to the `caller`.
*
* @param[in] portType - Type of the audio port where connection status is changed. Please refer ::dsAudioPortType_t
* @param[in] uiPortNo - Port number in which the connection status changed. @link dsAudioPORT_NUM_MAX @endlink
* @param[in] isPortCon - Current connection status of the audio port
*
* @pre - dsAudioOutRegisterConnectCB
*/
typedef void (*dsAudioOutPortConnectCB_t)(dsAudioPortType_t portType, unsigned int uiPortNo, bool isPortCon);
/**
* @brief Callback function used to notify Audio Format change to the `caller`.
*
* HAL Implementation should call this method to deliver updated audio format event
* to the `caller`.
*
* @param[in] audioFormat : New audio format of the active port. Please refer ::dsAudioFormat_t
*
* @pre - dsAudioFormatUpdateRegisterCB
*/
typedef void (*dsAudioFormatUpdateCB_t)(dsAudioFormat_t audioFormat);
/**
* @brief Call back function used to notify audio sink Atmos capability change
*
* HAL Implementation should call this method to deliver updated atmos capability change event
* to the `caller`.
*
* @param[in] atmosCaps - current atmos capability of the sink device
* @param[in] status - atmos caps status ( @a true to enable, @a false to disable)
*
* @pre - dsAudioAtmosCapsChangeRegisterCB()
*/
typedef void (*dsAtmosCapsChangeCB_t) (dsATMOSCapability_t atmosCaps, bool status);
/**
* @brief Initializes the audio port sub-system of Device Settings HAL.
*
* This function initializes all the audio output ports and allocates required resources.
* It must return dsERR_OPERATION_NOT_SUPPORTED when there are no audio ports present in the device
* (e.g. a headless gateway device).
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_ALREADY_INITIALIZED - Module is already initialised
* @retval dsERR_GENERAL - Underlying undefined platform error
*
*
* @warning This API is Not thread safe.
*
* @see dsAudioPortTerm()
*
*/
dsError_t dsAudioPortInit();
/**
* @brief Terminate the Audio Port sub-system of Device Settings HAL.
*
* This function terminates all the audio output ports by releasing the audio port specific handles
* and the allocated resources.
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() should be called before calling this API.
*
* @warning This API is Not thread safe.
*/
dsError_t dsAudioPortTerm();
/**
* @brief Gets the audio port handle.
*
* This function returns the handle for the type of audio port requested. It must return
* dsERR_OPERATION_NOT_SUPPORTED if an unavailable audio port is requested.
*
* @param[in] type - Type of audio port (HDMI, SPDIF and so on). Please refer ::dsAudioPortType_t
* @param[in] index - Index of audio port depending on the available ports(0, 1, ...). Maximum value of number of ports is platform specific. Please refer ::dsAudioPortConfig_t
* @param[out] handle - Pointer to hold the handle of the audio port
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid(port is not present or index is out of range)
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() should be called before calling this API.
*
* @warning This API is Not thread safe.
*/
dsError_t dsGetAudioPort(dsAudioPortType_t type, int index, intptr_t *handle);
/**
* @brief Gets the encoding type of an audio port
*
* This function returns the current audio encoding setting for the specified audio port.
*
* @param[in] handle - Handle for the output audio port
* @param[out] encoding - Pointer to hold the encoding setting of the audio port. Please refer ::dsAudioEncoding_t , @link dsAudioSettings_template.h @endlink
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called in this order before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetAudioEncoding()
*/
dsError_t dsGetAudioEncoding(intptr_t handle, dsAudioEncoding_t *encoding);
/**
* @brief Sets the encoding type of an audio port
*
* This function sets the audio encoding type to be used on the specified audio port.
*
* @param[in] handle - Handle for the output audio port
* @param[in] encoding - The encoding type to be used on the audio port. Please refer ::dsAudioEncoding_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetAudioEncoding()
*/
dsError_t dsSetAudioEncoding(intptr_t handle, dsAudioEncoding_t encoding);
/**
* @brief Gets the current audio format.
*
* This function returns the current audio format of the specified audio output port(like PCM, DOLBY AC3). Please refer ::dsAudioFormat_t
*
* @param[in] handle - Handle for the output audio port
* @param[out] audioFormat - Pointer to hold the audio format
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*/
dsError_t dsGetAudioFormat(intptr_t handle, dsAudioFormat_t *audioFormat);
/**
* @brief Gets the audio compression of the specified audio port.
*
* This function returns the audio compression level used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[out] compression - Pointer to hold the compression value of the specified audio port. (Value ranges from 0 to 10)
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetAudioCompression()
*/
dsError_t dsGetAudioCompression(intptr_t handle, int *compression);
/**
* @brief Sets the audio compression of an audio port.
*
* This function sets the audio compression level(non-MS12) to be used on the audio port corresponding to the specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[in] compression - Audio compression level (value ranges from 0 to 10) to be used on the audio port
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetAudioCompression()
*/
dsError_t dsSetAudioCompression(intptr_t handle, int compression);
/**
* @brief Gets the Dialog Enhancement level of the audio port.
*
* This function returns the dialog enhancement level of the audio port corresponding to the specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[out] level - Pointer to Dialog Enhancement level (Value ranges from 0 to 16)
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetDialogEnhancement()
*/
dsError_t dsGetDialogEnhancement(intptr_t handle, int *level);
/**
* @brief Sets the Dialog Enhancement level of an audio port.
*
* This function sets the dialog enhancement level to be used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output audio port.
* @param[in] level - Dialog Enhancement level. Level ranges from 0 to 16.
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetDialogEnhancement()
*/
dsError_t dsSetDialogEnhancement(intptr_t handle, int level);
/**
* @brief Gets the dolby audio mode status of an audio port.
*
* This function returns the dolby audio mode status used in the audio port corresponding to the specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[out] mode - Dolby volume mode
* ( @a true if Dolby Volume mode is enabled, and @a false if disabled)
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetDolbyVolumeMode()
*/
dsError_t dsGetDolbyVolumeMode(intptr_t handle, bool *mode);
/**
* @brief To enable/disable Dolby Volume Mode.
*
* This function sets the dolby audio mode status to the audio port corresponding to port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[in] mode - Dolby volume mode.
* ( @a true to enable Dolby volume mode and @a false to disable Dolby volume mode )
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetDolbyVolumeMode()
*/
dsError_t dsSetDolbyVolumeMode(intptr_t handle, bool mode);
/**
* @brief Gets the Intelligent Equalizer Mode.
*
* This function returns the Intelligent Equalizer Mode setting used in the audio port corresponding to specified Port handle.
*
* @param[in] handle - Handle for the output audio port.
* @param[out] mode - Pointer to Intelligent Equalizer mode. 0 = OFF, 1 = Open, 2 = Rich, 3 = Focused,
* 4 = Balanced, 5 = Warm, 6 = Detailed
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetIntelligentEqualizerMode()
*/
dsError_t dsGetIntelligentEqualizerMode(intptr_t handle, int *mode);
/**
* @brief Sets the Intelligent Equalizer Mode.
*
* This function sets the Intelligent Equalizer Mode to be used in the audio port corresponding to the specified port handle.
*
* @param[in] handle - Handle for the output audio port.
* @param[in] mode - Intelligent Equalizer mode. 0 = OFF, 1 = Open, 2 = Rich, 3 = Focused,
* 4 = Balanced, 5 = Warm, 6 = Detailed
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetIntelligentEqualizerMode()
*/
dsError_t dsSetIntelligentEqualizerMode(intptr_t handle, int mode);
/**
* @brief Gets the Dolby volume leveller settings.
*
* This function returns the Volume leveller(mode and level) value used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[out] volLeveller - Pointer to Volume Leveller. Please refer ::dsVolumeLeveller_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetVolumeLeveller()
*/
dsError_t dsGetVolumeLeveller(intptr_t handle, dsVolumeLeveller_t* volLeveller);
/**
* @brief Sets the Dolby volume leveller settings.
*
* This function sets the Volume leveller(mode and level) value to be used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[in] volLeveller - Volume Leveller setting. Please refer ::dsVolumeLeveller_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetVolumeLeveller()
*/
dsError_t dsSetVolumeLeveller(intptr_t handle, dsVolumeLeveller_t volLeveller);
/**
* @brief Gets the audio Bass
*
* This function returns the Bass used in a given audio port
*
* @param[in] handle - Handle for the output Audio port
* @param[out] boost - Pointer to Bass Enhancer boost value (ranging from 0 to 100)
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetBassEnhancer()
*/
dsError_t dsGetBassEnhancer(intptr_t handle, int *boost);
/**
* @brief Sets the audio Bass
*
* This function sets the Bass to be used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[in] boost - Bass Enhancer boost value (ranging from 0 to 100)
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetBassEnhancer()
*/
dsError_t dsSetBassEnhancer(intptr_t handle, int boost);
/**
* @brief Gets the audio Surround Decoder enabled/disabled status
*
* This function returns enable/disable status of surround decoder
*
* @param[in] handle - Handle for the output Audio port
* @param[out] enabled - Pointer to Surround Decoder enabled(1)/disabled(0) value
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsEnableSurroundDecoder()
*/
dsError_t dsIsSurroundDecoderEnabled(intptr_t handle, bool *enabled);
/**
* @brief Enables / Disables the audio Surround Decoder.
*
* This function will enable/disable surround decoder of the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[in] enabled - Surround Decoder enabled(1)/disabled(0) value
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsIsSurroundDecoderEnabled()
*/
dsError_t dsEnableSurroundDecoder(intptr_t handle, bool enabled);
/**
* @brief Gets the DRC Mode of the specified Audio Port.
*
* This function returns the Dynamic Range Control used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[out] mode - Pointer to DRC mode (0 for DRC line mode and 1 for DRC RF mode)
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetDRCMode()
*/
dsError_t dsGetDRCMode(intptr_t handle, int *mode);
/**
* @brief Sets the DRC Mode of specified audio port.
*
* This function sets the Dynamic Range Control to be used in the audio port corresponding to port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[in] mode - DRC mode (0 for DRC Line Mode and 1 for DRC RF mode)
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetDRCMode()
*/
dsError_t dsSetDRCMode(intptr_t handle, int mode);
/**
* @brief Gets the audio Surround Virtualizer level.
*
* This function returns the Surround Virtualizer level(mode and boost) used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[out] virtualizer - Surround virtualizer setting. Please refer ::dsSurroundVirtualizer_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetSurroundVirtualizer()
*/
dsError_t dsGetSurroundVirtualizer(intptr_t handle, dsSurroundVirtualizer_t *virtualizer);
/**
* @brief Sets the audio Surround Virtualizer level
*
* This function sets the Surround Virtualizer level(mode and boost) to be used in the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[in] virtualizer - Surround virtualizer setting. Please refer ::dsSurroundVirtualizer_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetSurroundVirtualizer()
*/
dsError_t dsSetSurroundVirtualizer(intptr_t handle, dsSurroundVirtualizer_t virtualizer);
/**
* @brief Gets the Media Intelligent Steering of the audio port.
*
* This function returns enable/disable status of Media Intelligent Steering for the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[out] enabled - MI Steering enabled(1)/disabled(0) value
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetMISteering()
*/
dsError_t dsGetMISteering(intptr_t handle, bool *enabled);
/**
* @brief Set the Media Intelligent Steering of the audio port.
*
* This function sets the enable/disable status of Media Intelligent Steering for the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output Audio port
* @param[in] enabled - MI Steering enabled(1)/disabled(0) value
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetMISteering()
*/
dsError_t dsSetMISteering(intptr_t handle, bool enabled);
/**
* @brief Gets the Graphic Equalizer Mode.
*
* This function returns the Graphic Equalizer Mode setting used in the audio port corresponding to the specified port handle.
*
* @param[in] handle - Handle for the output audio port.
* @param[out] mode - Graphic Equalizer Mode. 0 = EQ OFF, 1 = EQ Open, 2 = EQ Rich and 3 = EQ Focused
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetGraphicEqualizerMode()
*/
dsError_t dsGetGraphicEqualizerMode(intptr_t handle, int *mode);
/**
* @brief Sets the Graphic Equalizer Mode.
*
* This function sets the Graphic Equalizer Mode setting to be used in the audio port corresponding to the specified port handle.
*
* @param[in] handle - Handle for the output audio port.
* @param[in] mode - Graphic Equalizer mode. 0 for EQ OFF, 1 for EQ Open, 2 for EQ Rich and 3 for EQ Focused
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetGraphicEqualizerMode()
*/
dsError_t dsSetGraphicEqualizerMode(intptr_t handle, int mode);
/**
* @brief Gets the supported MS12 audio profiles
*
* This function will get the list of supported MS12 audio profiles
*
* @param[in] handle - Handle for the output Audio port
* @param[out] profiles - List of supported audio profiles. Please refer ::dsMS12AudioProfileList_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetMS12AudioProfile()
*/
dsError_t dsGetMS12AudioProfileList(intptr_t handle, dsMS12AudioProfileList_t* profiles);
/**
* @brief Gets current audio profile selection
*
* This function gets the current audio profile configured
*
* @param[in] handle - Handle for the output Audio port
* @param[out] profile - Audio profile configured currently
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetMS12AudioProfile()
*/
dsError_t dsGetMS12AudioProfile(intptr_t handle, char *profile);
/**
* @brief Gets the supported ARC types of the connected ARC/eARC device
*
* This function gets the supported ARC types of the connected device on ARC/eARC port.
*
* @param[in] handle - Handle for the HDMI ARC/eARC port
* @param[out] types - Value of supported ARC types. Please refer ::dsAudioARCTypes_t
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*/
dsError_t dsGetSupportedARCTypes(intptr_t handle, int *types);
/**
* @brief Sets Short Audio Descriptor retrieved from CEC for the connected ARC device
*
* This function sets the Short Audio Descriptor based on best available options
* of Audio capabilities supported by connected ARC device. Required when ARC output
* mode is Auto/Passthrough. Please refer ::dsAudioSADList_t, ::dsSetStereoMode
*
* @param[in] handle - Handle for the HDMI ARC/eARC port.
* @param[in] sad_list - All SADs retrieved from CEC for the connected ARC device.
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*/
dsError_t dsAudioSetSAD(intptr_t handle, dsAudioSADList_t sad_list);
/**
* @brief Enable/Disable ARC/EARC and route audio to connected device.
*
* This function enables/disables ARC/EARC and routes audio to connected device. Please refer ::_dsAudioARCStatus_t and ::dsAudioARCTypes_t
*
* @param[in] handle - Handle for the HDMI ARC/eARC port
* @param[in] arcStatus - ARC/eARC feature. Please refer ::_dsAudioARCStatus_t
* ( @a true to enable ARC/eARC, @a false to disable )
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*/
dsError_t dsAudioEnableARC(intptr_t handle, dsAudioARCStatus_t arcStatus);
/**
* @brief Gets the stereo mode of an audio port.
*
* This function returns the stereo mode setting for the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[out] stereoMode - Pointer to hold the stereo mode setting of the
* specified audio port. Please refer ::dsAudioStereoMode_t
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetStereoMode()
*/
dsError_t dsGetStereoMode(intptr_t handle, dsAudioStereoMode_t *stereoMode);
/**
* @brief Sets the stereo mode of an audio port.
*
* This function sets the stereo mode to be used on the audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[in] mode - Stereo mode to be used on the specified audio port. Please refer ::dsAudioStereoMode_t
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetStereoMode()
*/
dsError_t dsSetStereoMode(intptr_t handle, dsAudioStereoMode_t mode);
/**
* @brief Checks if auto mode is enabled or not for the current audio port.
*
* This function returns the current auto mode of audio port corresponding to specified port handle.
*
* @param[in] handle - Handle for the output audio port
* @param[out] autoMode - Pointer to hold the auto mode setting ( @a if enabled, @a false if disabled) of the specified audio port
*
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsSetStereoAuto()
*/
dsError_t dsGetStereoAuto(intptr_t handle, int *autoMode);
/**
* @brief Sets the Auto Mode to be used on the audio port.
*
* This function sets the auto mode to be used on the specified audio port.
*
* @param[in] handle - Handle for the output audio port.
* @param[in] autoMode - Indicates the auto mode ( @a true if enabled, @a false if disabled ) to be used on audio port.
*
* @return dsError_t - Status
* @retval dsERR_NONE - Success
* @retval dsERR_NOT_INITIALIZED - Module is not initialised
* @retval dsERR_INVALID_PARAM - Parameter passed to this function is invalid
* @retval dsERR_OPERATION_NOT_SUPPORTED - The attempted operation is not supported
* @retval dsERR_GENERAL - Underlying undefined platform error
*
* @pre dsAudioPortInit() and dsGetAudioPort() should be called before calling this API.
*
* @warning This API is Not thread safe.
*
* @see dsGetStereoAuto()
*/
dsError_t dsSetStereoAuto(intptr_t handle, int autoMode);