Integration with AlsaHookPlugin (work in progress)

6 files changed, 255 insertions, 1 deletions

diff --git a/conf.d/cmake/config.cmake b/conf.d/cmake/config.cmake
index ba56110..ff824cf 100644
--- a/conf.d/cmake/config.cmake
+++ b/conf.d/cmake/config.cmake
@@ -54,6 +54,7 @@ set(CONTROL_SUPPORT_LUA 1 CACHE BOOL "Active or not LUA Support")
 # PKG_CONFIG required packages
 # -----------------------------
 set (PKG_REQUIRED_LIST
+        glib-2.0
 	alsa>=1.1.2
 	libsystemd>=222
 	libmicrohttpd>=0.9.55
@@ -86,6 +87,7 @@ set(COMPILE_OPTIONS
 -DMAX_LINEAR_DB_SCALE=24 # until 24db volume normalisation use a simple linear scale
 -DTLV_BYTE_SIZE=256      # Alsa use 4096 as default but 256 should fit most sndcards
 -DCONTROL_MAXPATH_LEN=255
+-DCONTROL_CONFIG_PATH="${CMAKE_SOURCE_DIR}/conf.d/project:${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}"
  CACHE STRING "Compilation flags")
 #set(C_COMPILE_OPTIONS "" CACHE STRING "Compilation flags for C language.")
 #set(CXX_COMPILE_OPTIONS "" CACHE STRING "Compilation flags for C++ language.")
@@ -100,7 +102,7 @@ if(IS_DIRECTORY $ENV{HOME}/opt/afb-monitoring)
 set(MONITORING_ALIAS "--alias=/monitoring:$ENV{HOME}/opt/afb-monitoring")
 endif()
 
-set(CLOSING_MESSAGE "Debug: afb-daemon --name=afb-aaaa --port=1234 --ws-server=unix:/var/tmp/ahl-4a --cntxtimeout=1 ${MONITORING_ALIAS} --ldpaths=package/lib:../../alsa-4a/build/package/lib:../../hal-sample-4a/build/package/lib --workdir=. --roothttp=../htdocs --token= --verbose ")
+set(CLOSING_MESSAGE "Debug: afb-daemon --name=afb-audiok4a --port=1234 --ws-server=unix:/var/tmp/ahl-4a --cntxtimeout=1 ${MONITORING_ALIAS} --binding=package/lib/afb-audiohighlevel.so --ldpaths=../../alsa-4a/build/package/lib:../../hal-sample-4a/build/package/lib --workdir=. --roothttp=../htdocs --token= --verbose ")
 
 
 # Optional location for config.xml.in
diff --git a/conf.d/project/.asoundrc b/conf.d/project/.asoundrc-audiok
index cba88e5..cba88e5 100644
--- a/conf.d/project/.asoundrc
+++ b/conf.d/project/.asoundrc-audiok
diff --git a/conf.d/project/.asounrc-fulup b/conf.d/project/.asounrc-fulup
new file mode 100644
index 0000000..c98d5a8
--- /dev/null
+++ b/conf.d/project/.asounrc-fulup
@@ -0,0 +1,198 @@
+# 
+# Author: Fulup Ar Foll
+# Object: PCM hook type 
+#
+# Test  :  Note: Jabra_USB=hw:v1340
+#  Check SoundCard ==> speaker-test -Dhw:v1340   -c2 -twav
+#  Check MixerPCM  ==> speaker-test -DSpeakers   -c2 -twav 
+#  Check SoftVol   ==> speaker-test -DMusicPCM   -c2 -twav 
+#  Check Plugin    ==> speaker-test -DMultimedia -c2 -twav
+#  Check Plugin    ==> speaker-test -DNavigation -c2 -twav
+#
+#  MultiMedia aplay -DDMyNavPCM /usr/share/sounds/alsa/test.wav
+#
+# Bug/Feature: when softvol control is initialised from plugin and not
+#    from AGL binding. At 1st run ctl has invalid TLV and cannot be
+#    use. Bypass Solution: 
+#     * start audio-binder before playing sound (binding create control before softvol plugin)
+#     * run a dummy aplay -DMyNavPCM "" to get a clean control
+#
+# References: https://www.spinics.net/lists/alsa-devel/msg54235.html
+# --------------------------------------------------------------------
+
+# ------------------------------------------------------
+# Mixer PCM allow to play multiple stream simultaneously
+# ------------------------------------------------------
+pcm.Speakers { 
+    type dmix            
+    slave {pcm "hw:v1340"}  #Jabra Solmate 1
+    ipc_key 1001          # ipc_key should be unique to each dmix
+} 
+
+# -----------------------------------------------------
+#  Register ControllerHookPlugin (ToiBeFix fullpath)
+# -----------------------------------------------------
+pcm_hook_type.CtlHookPlugin {
+    install "AlsaInstallHook" 
+    lib "/home/fulup/Workspace/Audio-4a/alsa-4a/build/alsa-hook/policy_alsa_hook.so"
+}
+
+
+# -------------------------------------------------------
+# Define one Audio Virtual Channel per Audio Roles
+# -------------------------------------------------------
+pcm.MusicPCM {
+    type softvol
+
+    # Point Slave on HOOK for policies control
+    slave.pcm "Speakers"
+
+    # name should match with HAL definition
+    control.name  "Playback Multimedia"
+}
+
+pcm.NaviPCM {
+    type softvol
+
+    # Point Slave on HOOK for policies control
+    slave.pcm "Speakers"
+
+    # name should match with HAL definition
+    control.name  "Playback Navigation"
+}
+
+pcm.UrgentPCM {
+    type softvol
+
+    # Point Slave on HOOK for policies control
+    slave.pcm "Speakers"
+
+    # name should match with HAL definition
+    control.name  "Playback Emergency"
+}
+
+# ----------------------------------------------------
+# Define one hooked PCM channel per Audio Roles
+# ----------------------------------------------------
+pcm.Multimedia {
+    type hooks
+    slave {pcm "MusicPCM"}
+    hooks.0 {
+        comment "Defined used hook sharelib and provide arguments/config to install func"
+        type "CtlHookPlugin"
+        hook_args {
+
+            # print few log messages (default false)
+            verbose true 
+
+            # uri to audio-4a policy engine
+            uri="unix:/var/tmp/ahl-4a"
+
+            # timeout in ms (default 500)
+            timeout 5000
+
+            # force API synchronous mode
+            synchronous true
+
+            # api subcall to request a role
+            request {
+                stream_open "{'audio_role':'Entertainment', 'endpoint_type': 'sink'}"
+                set_stream_state  "{'state': 'running'}"
+            } 
+
+            # api subcall to request a role
+            release {
+                stream_close "{}"
+            } 
+   
+            # map AGL event on Unix signal. Search in event for json key=value
+            events {   
+                sig-02 {search music, value quit}
+                sig-31 {search event, value start}
+                sig-32 {search event, value start}
+            }
+        }
+    }
+}
+
+pcm.Navigation {
+    type hooks
+    slave {pcm "NaviPCM"}
+    hooks.0 {
+        comment "Defined used hook sharelib and provide arguments/config to install func"
+        type "CtlHookPlugin"
+        hook_args {
+
+            # print few log messages (default false)
+            verbose true 
+
+            # uri to audio-4a policy engine
+            uri="unix:/var/tmp/ahl-4a"
+
+            # timeout in ms (default 500)
+            timeout 5000
+
+            # force API synchronous mode
+            synchronous true
+
+            # api subcall to request a role
+            request {
+                stream_open "{'audio_role':'Guidance', 'endpoint_type': 'sink'}"
+                set_stream_state  "{'state': 'running'}"
+            } 
+
+            # api subcall to request a role
+            release {
+                release-role "{'uid':'alsa-hook-client'}"
+            } 
+   
+            # map AGL event on Unix signal. Search in event for json key=value
+            events {   
+                sig-02 {search navi, value quit}
+                sig-31 {search event, value start}
+                sig-32 {search event, value start}
+            }
+        }
+    }
+}
+
+pcm.Emergency {
+    type hooks
+    slave {pcm "UrgentPCM"}
+    hooks.0 {
+        comment "Defined used hook sharelib and provide arguments/config to install func"
+        type "CtlHookPlugin"
+        hook_args {
+
+            # print few log messages (default false)
+            verbose true 
+
+            # uri to audio-4a policy engine
+            uri="unix:/var/tmp/ahl-4a"
+
+            # timeout in ms (default 500)
+            timeout 5000
+
+            # force API synchronous mode
+            synchronous true
+
+            # api subcall to request a role
+            request {
+                stream_open "{'audio_role':'Emergency', 'endpoint_type': 'sink'}"
+                set_stream_state  "{'state': 'running'}"
+            } 
+
+            # api subcall to request a role
+            release {
+                release-role "{'uid':'alsa-hook-client'}"
+            } 
+   
+            # map AGL event on Unix signal. Search in event for json key=value
+            events {   
+                sig-02 {search navi, value quit}
+                sig-31 {search event, value start}
+                sig-32 {search event, value start}
+            }
+        }
+    }
+}
diff --git a/conf.d/project/README.md b/conf.d/project/README.md
new file mode 100644
index 0000000..00e3c2f
--- /dev/null
+++ b/conf.d/project/README.md
@@ -0,0 +1,15 @@
+
+1) $HOME/.asoundrc or /etc/asound.conf should match you hardware audio configuration.
+2) ahl-xxxxxx-config.json should match your .asoundrc config
+
+Note: config file is search within with following rules:
+ - default search path is $PROJECT_ROOT/conf.d/project:${CMAKE_INSTALL_PREFIX}/${PROJECT_NAME}
+ - if environment variable "AAAA_CONFIG_PATH" is defined that it is used as search path
+ - config file should match "ahl-BINDERNAME-config.json" where BINDERNAME is provided through "--name=BINDERNAME" in afb-daemon commande line.
+
+Note: you may debug Audio-4A from your development tree with:
+
+  afb-daemon --name=afb-audio4a --port=1234 --ws-server=unix:/var/tmp/ahl-4a --cntxtimeout=1 \
+             --alias=/monitoring:/home/fulup/opt/afb-monitoring --binding=package/lib/afb-audiohighlevel.so \
+             --ldpaths=../../alsa-4a/build/package/lib:../../hal-sample-4a/build/package/lib --workdir=. \
+             --roothttp=../htdocs --token= --verbose --verbose
\ No newline at end of file
diff --git a/conf.d/project/agl-ahl-config.json b/conf.d/project/ahl-audiok4a-config.json
index f49c0be..f49c0be 100644
--- a/conf.d/project/agl-ahl-config.json
+++ b/conf.d/project/ahl-audiok4a-config.json
diff --git a/conf.d/project/ahl-fulup4a-config.json b/conf.d/project/ahl-fulup4a-config.json
new file mode 100644
index 0000000..1a851a5
--- /dev/null
+++ b/conf.d/project/ahl-fulup4a-config.json
@@ -0,0 +1,39 @@
+{
+    "version": "0.2.0",
+    "policy_module": "AudioPolicy_v1",
+    "description": "High-level binding configuration file",
+    "note": "Devices and routings are always listed in order of priority (for device selection rules)",
+    "hal_list": ["jabra-usb"],
+    "audio_roles": [
+        {
+            "name": "Guidance",
+            "id": 1,
+            "description": "Important user information where user action is expected (e.g. navigation instruction)",
+            "priority": 25,
+            "output": [
+                "alsa.plug:NaviPCM"
+            ],
+            "interupt_behavior": "continue"
+        },
+        {
+            "name": "Emergency",
+            "id": 2,
+            "description": "HMI or else notifications (e.g. touchscreen events, speech recognition on/off,...)",
+            "priority": 100,
+            "output": [
+                "alsa.plug:UrgentPCM"
+            ],
+            "interupt_behavior": "pause"
+        },
+        {
+            "name": "Entertainment",
+            "id": 3,
+            "description": "Multimedia content (e.g. tuner, media player, etc.)",
+            "priority": 0,
+            "output": [
+                "alsa.plug:MusicPCM"
+            ],
+            "interupt_behavior": "pause"
+        }
+    ]
+}