summaryrefslogtreecommitdiffstats
path: root/src/ahl-interface.h
diff options
context:
space:
mode:
authorTai Vuong <tvuong@audiokinetic.com>2017-10-04 14:21:28 -0400
committerTai Vuong <tvuong@audiokinetic.com>2017-10-04 14:21:28 -0400
commit539f65bb5ad87238422a5ca26c5b524c3be44bd1 (patch)
tree01fa955edf1e9b597a4a4247b3a35390c7b6ddbc /src/ahl-interface.h
parentd69dc9732886074e9f400961b500e70d5c8305d7 (diff)
Post AudioWorkshop Work phase v1
Diffstat (limited to 'src/ahl-interface.h')
-rw-r--r--src/ahl-interface.h112
1 files changed, 80 insertions, 32 deletions
diff --git a/src/ahl-interface.h b/src/ahl-interface.h
index 781bb05..edead36 100644
--- a/src/ahl-interface.h
+++ b/src/ahl-interface.h
@@ -18,28 +18,12 @@
#ifndef AHL_INTERFACE_INCLUDE
#define AHL_INTERFACE_INCLUDE
-#define UNDEFINED_ID -1
-
-typedef int endpointID_t;
-typedef int streamID_t;
-
typedef enum EndpointType {
ENDPOINTTYPE_SOURCE = 0, // source devices
ENDPOINTTYPE_SINK, // sink devices
ENDPOINTTYPE_MAXVALUE // Enum count, keep at the end
} EndpointTypeT;
-// Standardized name for common audio roles (not enforced in any way, just helps system being more compatible)
-#define AUDIOROLE_WARNING "warning" // Safety-relevant or critical alerts/alarms
-#define AUDIOROLE_GUIDANCE "guidance" // Important user information where user action is expected (e.g. navigation instruction)
-#define AUDIOROLE_NOTIFICATION "notification" // HMI or else notifications (e.g. touchscreen events, speech recognition on/off,...)
-#define AUDIOROLE_COMMUNICATION "communications" // Voice communications (e.g. handsfree, speech recognition)
-#define AUDIOROLE_ENTERTAINMENT "entertainment" // Multimedia content (e.g. tuner, media player, etc.)
-#define AUDIOROLE_SYSTEM "system" // System level content or development
-#define AUDIOROLE_STARTUP "startup" // Early (startup) sound
-#define AUDIOROLE_SHUTDOWN "shutdown" // Late (shutdown) sound
-#define AUDIOROLE_NONE "none" // Non-assigned / legacy applications
-
typedef enum DeviceURIType {
DEVICEURITYPE_ALSA_HW = 0, // Alsa hardware device URI
DEVICEURITYPE_ALSA_DMIX, // Alsa Dmix device URI (only for playback devices)
@@ -52,23 +36,87 @@ typedef enum DeviceURIType {
DEVICEURITYPE_MAXVALUE // Enum count, keep at the end
} DeviceURITypeT;
-// Standardized list of properties (string used for extensibility)
-#define AUDIOHL_PROPERTY_BALANCE "balance"
-#define AUDIOHL_PROPERTY_FADE "fade"
-#define AUDIOHL_PROPERTY_EQ_LOW "eq_low"
-#define AUDIOHL_PROPERTY_EQ_MID "eq_mid"
-#define AUDIOHL_PROPERTY_EQ_HIGH "eq_high"
+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 state names/values (string used for extensibility)
-#define AUDIOHL_STATE_NAME_ACTIVE "active"
-#define AUDIOHL_STATE_NAME_MUTE "mute"
-#define AUDIOHL_STATE_VALUE_ON "on"
-#define AUDIOHL_STATE_VALUE_OFF "off"
+// Standardized list of events
+#define AHL_EVENTS_PLAYSOUND "play_sound"
+#define AHL_EVENTS_ECHOCANCEL_ENABLE "echocancel_enable"
+#define AHL_EVENTS_ECHOCANCEL_DISABLE "echocancel_disable"
-// Known audio domain string definitions (for configuration file format)
-#define AUDIOHL_DOMAIN_ALSA "Alsa"
-#define AUDIOHL_DOMAIN_PULSE "Pulse"
-#define AUDIOHL_DOMAIN_GSTREAMER "GStreamer"
-#define AUDIOHL_DOMAIN_EXTERNAL "External"
#endif // AHL_INTERFACE_INCLUDE