diff options
Diffstat (limited to 'src/ahl-binding.h')
| -rw-r--r-- | src/ahl-binding.h | 180 |
1 files changed, 122 insertions, 58 deletions
diff --git a/src/ahl-binding.h b/src/ahl-binding.h index 8f308d5..af122c3 100644 --- a/src/ahl-binding.h +++ b/src/ahl-binding.h @@ -1,6 +1,5 @@ /* * 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. @@ -19,18 +18,25 @@ #define AHL_BINDING_INCLUDE #define AFB_BINDING_VERSION 2 -#include <afb/afb-binding.h> + +//#define AHL_DISCONNECT_POLICY // define for debugging HLB in standalone only + #include <json-c/json.h> #include <glib.h> #include "ahl-interface.h" +#include <afb/afb-binding.h> #ifndef PUBLIC #define PUBLIC #endif +#define AHL_SUCCESS 0 +#define AHL_FAIL 1 + #define AHL_POLICY_ACCEPT 1 #define AHL_POLICY_REJECT 0 + #define AHL_ACCESS_CONTROL_GRANTED 1 #define AHL_ACCESS_CONTROL_DENIED 0 @@ -39,19 +45,75 @@ typedef int endpointID_t; typedef int streamID_t; -// 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; - -typedef enum EndpointSelectionMode { - AHL_ENDPOINTSELMODE_AUTO = 0, // Automatic endpoint selection based on config priority - AHL_ENDPOINTSELMODE_MANUAL, // Explicit endpoint selection - AHL_ENDPOINTSELMODEMAXVALUE, // Enum count, keep at the end -} EndpointSelectionModeT; +#define AHL_STR_MAX_LENGTH 256 + +typedef enum EndpointType { + ENDPOINTTYPE_SOURCE = 0, // source devices + ENDPOINTTYPE_SINK, // sink devices + ENDPOINTTYPE_MAXVALUE // Enum count, keep at the end +} EndpointTypeT; + +typedef enum StreamState { + STREAM_STATE_IDLE = 0, // Stream is inactive + STREAM_STATE_RUNNING, // Stream is active and running + STREAM_STATE_PAUSED, // Stream is active but paused + STREAM_STATE_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; + +typedef enum StreamEvent { + STREAM_EVENT_START = 0, // Stream is inactive + STREAM_EVENT_STOP, // Stream is running + STREAM_EVENT_PAUSE, // Audio stream paused + STREAM_EVENT_RESUME, // Audio stream resumed + STREAM_EVENT_MUTED, // Audio stream muted + STREAM_EVENT_UNMUTED, // Audio stream unmuted + STREAM_EVENT_MAXVALUE // Enum count, keep at the end +} StreamEventT; + +// Define default behavior of audio role when interrupting lower priority sources +typedef enum InterruptBehavior { + INTERRUPTBEHAVIOR_CONTINUE = 0, // Continue to play lower priority source when interrupted (e.g. media may be ducked) + INTERRUPTBEHAVIOR_CANCEL, // Abort playback of lower priority source when interrupted (e.g. non-important HMI feedback that does not make sense later) + INTERRUPTBEHAVIOR_PAUSE, // Pause lower priority source when interrupted, to be resumed afterwards (e.g. non-temporal guidance) + INTERRUPTBEHAVIOR_MAXVALUE, // Enum count, keep at the end +} InterruptBehaviorT; + +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_PLUG, // Alsa plug device URI + DEVICEURITYPE_ALSA_OTHER, // Alsa domain URI device of unspecified type + DEVICEURITYPE_NOT_ALSA, // Unknown (not ALSA domain) + DEVICEURITYPE_MAXVALUE // Enum count, keep at the end +} DeviceURITypeT; + +// 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; typedef struct AudioFormat { int sampleRate; // Sample rate @@ -67,44 +129,59 @@ typedef struct AlsaDeviceInfo { int subDeviceNum; // HW sub device number } AlsaDeviceInfoT; +typedef enum EndpointSelectionMode { + ENDPOINTSELMODE_AUTO = 0, // Automatic endpoint selection based on config priority + ENDPOINTSELMODE_MANUAL, // Explicit endpoint selection + ENDPOINTSELMODEMAXVALUE, // Enum count, keep at the end +} EndpointSelectionModeT; + typedef struct EndpointInfo { endpointID_t endpointID; // Unique endpoint ID (per type) EndpointTypeT type; // Source or sink device - GString * gsDeviceName; // Unique device card name - GString * gsDisplayName; // Application display name - GString * gsDeviceURI; // Associated URI + char * gsDeviceName; // Unique device card name + char * gsDisplayName; // Application display name + char * gsDeviceURI; // Associated URI + char * gsDeviceDomain; // Device URI domain (e.g. alsa or pulse) + char * pRoleName; // Role assigned to this endpoint DeviceURITypeT deviceURIType; // Device URI type (includes audio domain information) - GString * gsAudioRole; // Audio role that registered this endpoint - GString * gsHALAPIName; // HAL associated with the device (for volume control) + char * gsHALAPIName; // HAL associated with the device (for volume control) AlsaDeviceInfoT alsaInfo; // ALSA specific device information AudioFormatT format; // Preferred audio format supported (later could be array of supported formats) - int iVolume; // Storage for current endpoint volume (policy effected). Target volume during ramping? + int iVolume; // Storage for current endpoint volume (policy effected). GHashTable * pPropTable; // Storage for array of properties (policy effected) } EndpointInfoT; typedef struct StreamInfo { - streamID_t streamID; // Stream unique ID - EndpointInfoT * pEndpointInfo; // Associated endpoint information - StreamStateT streamState; // Stream activity state - StreamMuteT streamMute; // Stream mute state - struct afb_event streamStateEvent; // Stream specific event for stream state changes - EndpointSelectionModeT endpointSelMode; // Automatic (priority based) or manual endpoint selection + streamID_t streamID; // Stream unique ID + EndpointInfoT * pEndpointInfo; // Associated endpoint information (reference) + StreamStateT streamState; // Stream activity state + StreamMuteT streamMute; // Stream mute state + struct afb_event streamStateEvent; // Stream specific event for stream state changes + EndpointSelectionModeT endpointSelMode; // Automatic (priority based) or manual endpoint selection + char * pRoleName; // Role string identifier (from role config but could be programatically overriden later) + int iPriority; // Role normalized priority (0-100) (from role config but could be programatically overriden later) + InterruptBehaviorT eInterruptBehavior; // Role behavior when interrupting lower priority streams (from role config but could be programatically overriden later) } StreamInfoT; +typedef struct RoleInfo { + char * pRoleName; // Role string identifier + int iPriority; // Role normalized priority (0-100) + InterruptBehaviorT eInterruptBehavior; // Role behavior when interrupting lower priority streams + GPtrArray * pActionList; // List of supported actions for the role (gchar*) + GPtrArray * pSourceEndpoints; // Source endpoints info (EndpointInfoT*) + GPtrArray * pSinkEndpoints; // Sink endpoints info (EndpointInfoT*) +} RoleInfoT; + // Parts of the context that are visible to the policy (for state based decisions) typedef struct AHLPolicyCtx { - GPtrArray * pSourceEndpoints; // Array of source end points for each audio role (GArray*) - GPtrArray * pSinkEndpoints; // Array of sink end points for each audio role (GArray*) - GPtrArray * pEventList; // Event list per audio roles (GArray*) - GHashTable * pRolePriority; // List of role priorities (int). - GArray * pInterruptBehavior; // List of interrupt behavior per audio role (int/enum). - GArray * pAudioRoles; // List of audio roles (GString) - GArray * pActiveStreams; // List of active streams (StreamInfoT) - int iNumberRoles; // Number of audio roles from configuration - struct afb_event propertyEvent; // AGL event used when property changes - struct afb_event volumeEvent; // AGL event used when volume changes - struct afb_event postEvent; // AGL event used on post event call + GHashTable * pRoleInfo; // Hash table of role information structure (RoleInfoT*) accessed by role name + GHashTable * pStreams; // List of active streams (StreamInfoT*) accessed by streamID + GPtrArray * pHALList; // List of HAL dependencies + // TODO: Events need to be sent directly by HLB when separation with policy complete + struct afb_event propertyEvent; // AGL event used when property changes + struct afb_event volumeEvent; // AGL event used when volume changes + struct afb_event postActionEvent; // AGL event used on post action call } AHLPolicyCtxT; // Global binding context @@ -113,14 +190,11 @@ typedef struct AHLCtx { endpointID_t nextSourceEndpointID; // Counter to assign new ID endpointID_t nextSinkEndpointID; // Counter to assign new ID endpointID_t nextStreamID; // Counter to assign new ID - GArray * pHALList; // List of HAL dependencies - int iNumActiveClients; // Number of clients with active stream(s) } AHLCtxT; // Client specific binding context typedef struct AHLClientCtx { - GArray * pEndpointAccessList; // List of endpoints that client has control over - GArray * pStreamAccessList; // List of streams that client has control over + GArray * pStreamAccessList; // List of streams that client has control over } AHLClientCtxT; // ahl-binding.c @@ -128,24 +202,14 @@ PUBLIC int AhlBindingInit(); PUBLIC void AhlOnEvent(const char *evtname, json_object *eventJ); // ahl-deviceenum.c -int EnumerateSources(json_object * in_jSourceArray, int in_iRoleIndex, char * in_pRoleName); -int EnumerateSinks(json_object * in_jSinkArray, int in_iRoleIndex, char * in_pRoleName); -void TermEndpoints(); +int EnumerateDevices(json_object * in_jDeviceArray, char * in_pAudioRole, EndpointTypeT in_deviceType, GPtrArray * out_pEndpointArray); +EndpointInfoT * InitEndpointInfo(); +void TermEndpointInfo( EndpointInfoT * out_pEndpointInfo ); // ahl-config.c int ParseHLBConfig(); // ahl-policy.c -int Policy_Endpoint_Property_Init(EndpointInfoT * io_pEndpointInfo); -int Policy_OpenStream(StreamInfoT * pStreamInfo); -int Policy_CloseStream(StreamInfoT * pStreamInfo); -int Policy_SetStreamState(StreamInfoT * pStreamInfo, int AudioRoleIndex, StreamStateT streamState); -int Policy_SetStreamMute(StreamInfoT * pStreamInfo, StreamMuteT streamMute); -int Policy_PostEvent(char *eventName, char *audioRole, char *mediaName, void *audioContext); -int Policy_AudioDeviceChange(); -int Policy_SetVolume(EndpointInfoT * f_pEndpointInfo, char *volumeStr); -//Todo -int Policy_SetProperty(EndpointInfoT * f_pEndpointInfo, char *propertyName, json_object *propValue); -int Policy_Init(); -void Policy_Term(); -void Policy_OnEvent(const char *evtname, json_object *eventJ); +#ifndef AHL_DISCONNECT_POLICY +PUBLIC void audiohlapi_raise_event(json_object *EventDataJ); +#endif #endif // AHL_BINDING_INCLUDE |