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
|
/*
* Copyright (C) 2017 "Audiokinetic Inc"
* Author Francois Thibault <fthibault@audiokinetic.com>
*
* 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.
*/
#ifndef AHL_INTERFACE_INCLUDE
#define AHL_INTERFACE_INCLUDE
typedef enum EndpointType {
ENDPOINTTYPE_SOURCE = 0, // source devices
ENDPOINTTYPE_SINK, // sink devices
ENDPOINTTYPE_MAXVALUE // Enum count, keep at the end
} EndpointTypeT;
typedef enum DeviceURIType {
DEVICEURITYPE_ALSA_HW = 0, // Alsa hardware device URI
DEVICEURITYPE_ALSA_DMIX, // Alsa Dmix device URI (only for playback devices)
DEVICEURITYPE_ALSA_DSNOOP, // Alsa DSnoop device URI (only for capture devices)
DEVICEURITYPE_ALSA_SOFTVOL, // Alsa softvol device URI
DEVICEURITYPE_ALSA_OTHER, // Alsa domain URI device of unspecified type
DEVICEURITYPE_PULSE, // Pulse device URI
DEVICEURITYPE_GSTREAMER, // GStreamer device URI
DEVICEURITYPE_EXTERNAL, // Device URI for external ECU device
DEVICEURITYPE_MAXVALUE // Enum count, keep at the end
} DeviceURITypeT;
typedef enum StreamState {
STREAM_STATUS_READY = 0, // Stream is inactive
STREAM_STATUS_RUNNING, // Stream is running
STREAM_STATUS_MAXVALUE, // Enum count, keep at the end
} StreamStateT;
typedef enum StreamMute {
STREAM_UNMUTED = 0, // Stream is not muted
STREAM_MUTED, // Stream is muted
STREAM_MUTE_MAXVALUE, // Enum count, keep at the end
} StreamMuteT;
// Define default behavior of audio role when interrupted by higher priority sources
typedef enum InterruptedBehavior {
AHL_INTERRUPTEDBEHAVIOR_CONTINUE = 0, // Continue to play when interrupted (e.g. media may be ducked)
AHL_INTERRUPTEDBEHAVIOR_CANCEL, // Abort playback when interrupted (e.g. non-important HMI feedback that does not make sense later)
AHL_INTERRUPTEDBEHAVIOR_PAUSE, // Pause source when interrupted, to be resumed afterwards (e.g. non-temporal guidance)
AHL_INTERRUPTEDBEHAVIOR_MAXVALUE, // Enum count, keep at the end
} InterruptedBehaviorT;
#define AHL_ENDPOINT_PROPERTY_EVENT "ahl_endpoint_property_event"
#define AHL_ENDPOINT_VOLUME_EVENT "ahl_endpoint_volume_event"
#define AHL_POST_EVENT "ahl_post_event"
// CPU endianness assumed in all formats
typedef enum SampleType {
AHL_FORMAT_UNKNOWN = -1, // Unknown
AHL_FORMAT_U8 = 0, // Unsigned 8 bit
AHL_FORMAT_S16, // Signed 16 bit Little Endian
AHL_FORMAT_S24, // Signed 24 bit Little Endian using low three bytes in 32-bit word
AHL_FORMAT_S32, // Signed 32 bit Little Endian
AHL_FORMAT_FLOAT, // Float 32 bit Little Endian, Range -1.0 to 1.0
AHL_FORMAT_FLOAT64, // Float 64 bit Little Endian, Range -1.0 to 1.0
AHL_FORMAT_IEC958, // IEC-958 Little Endian (SPDIF)
AHL_FORMAT_MU_LAW, // Mu-Law
AHL_FORMAT_A_LAW, // A-Law
AHL_FORMAT_IMA_ADPCM, // Ima-ADPCM
AHL_FORMAT_MPEG, // MPEG
AHL_FORMAT_GSM, // GSM
AHL_FORMAT_G723, // G723
AHL_FORMAT_DSD, // Direct stream digital
AHL_FORMAT_MAXVALUE, // Enum count, keep at the end
} SampleTypeT;
// Stream event types
typedef enum StreamEventType {
AHL_STREAMEVENT_START = 0, // Audio streaming should start
AHL_STREAMEVENT_STOP, // Audio streaming should stop
AHL_STREAMEVENT_UNMUTE, // Audio stream unmuted
AHL_STREAMEVENT_MUTE, // Audio stream muted
AHL_STREAMEVENT_MAXVALUE, // Enum count, keep at the end
} StreamEventTypeT;
// Known audio domain string definitions (for configuration file format and device URI interpretation)
#define AHL_DOMAIN_ALSA "alsa"
#define AHL_DOMAIN_PULSE "pulse"
#define AHL_DOMAIN_GSTREAMER "gstreamer"
#define AHL_DOMAIN_EXTERNAL "external"
// Standardized name for common audio roles (not enforced in any way, just helps compatibility)
#define AHL_ROLE_WARNING "warning" // Safety-relevant or critical alerts/alarms
#define AHL_ROLE_GUIDANCE "guidance" // Important user information where user action is expected (e.g. navigation instruction)
#define AHL_ROLE_NOTIFICATION "notification" // HMI or else notifications (e.g. touchscreen events, speech recognition on/off,...)
#define AHL_ROLE_COMMUNICATION "communications" // Voice communications (e.g. handsfree, speech recognition)
#define AHL_ROLE_ENTERTAINMENT "entertainment" // Multimedia content (e.g. tuner, media player, etc.)
#define AHL_ROLE_SYSTEM "system" // System level content or development
#define AHL_ROLE_STARTUP "startup" // Early (startup) sound
#define AHL_ROLE_SHUTDOWN "shutdown" // Late (shutdown) sound
#define AHL_ROLE_NONE "none" // Non-assigned / legacy applications
// Standardized list of properties (not enforced in any way, just helps compatibility)
#define AHL_PROPERTY_BALANCE "balance"
#define AHL_PROPERTY_FADE "fade"
#define AHL_PROPERTY_EQ_LOW "eq_bass"
#define AHL_PROPERTY_EQ_MID "eq_mid"
#define AHL_PROPERTY_EQ_HIGH "eq_treble"
// Standardized list of events
#define AHL_EVENTS_PLAYSOUND "play_sound"
#define AHL_EVENTS_ECHOCANCEL_ENABLE "echocancel_enable"
#define AHL_EVENTS_ECHOCANCEL_DISABLE "echocancel_disable"
#endif // AHL_INTERFACE_INCLUDE
|
