README.md

   1 ------------------------------------------------------------------------
   2 AGL-UNICENS binding expose UNICENS-V2 APIs through AGL framework
   3 ------------------------------------------------------------------------
   4
   5 Cloning Audio-Binding from Git
   6 -------------------------------------------------------
   7
   8 ```
   9 git clone --recurse-submodules https://github.com/iotbzh/unicens2-binding
  10 cd  unicens2-binding
  11 ```
  12
  13 AFB_daemon dependency on Standard Linux Distributions
  14 -------------------------------------------------------
  15     # handle dependencies > (OpenSuse-42.2, Fedora-25, Ubuntu 16.04.2LTS)
  16     gcc > 4.8
  17     systemd-devel (libsystemd-dev>=222)
  18     libuuid-devel
  19     file-devel(OpenSuSe) or libmagic-dev(Ubuntu)
  20     libjson-c-devel
  21     alsa-devel
  22     ElectricFence (BUG should not be mandatory)
  23     libopenssl-devel libgcrypt-devel libgnutls-devel (optional but requested by libmicrohttpd for https)
  24     libxml2-devel
  25
  26     OpenSuse >=42.2
  27       zypper in gcc5 gdb gcc5-c++ git cmake make ElectricFence systemd-devel libopenssl-devel  libuuid-devel alsa-devel libgcrypt-devel libgnutls-devel libjson-c-devel file-devel libxml2-devel
  28
  29     Ubuntu >= 16.4 libuuid-devel
  30       apt-get install cmake git electric-fence libsystemd-dev libssl-dev uuid-dev libasound2-dev libgcrypt20-dev libgnutls-dev libgnutls-dev libjson-c-dev libmagic-dev libxml2-dev
  31
  32     libmicrohttpd>=0.9.55 (as today OpenSuse-42.2 or Ubuntu-.16.4 ship older versions)
  33     afb-daemon from AGL Gerrit git clone https://gerrit.automotivelinux.org/gerrit/src/app-framework-binder
  34
  35 ```
  36     # Might want to add following variables into ~/.bashrc
  37     echo "#----------  AGL options Start ---------" >>~/.bashrc
  38     echo "# Object: AGL cmake option for  binder/bindings" >>~/.bashrc
  39     echo "# Date: `date`" >>~/.bashrc
  40     echo 'export CC=gcc-5; export CXX=g++-5' >>~/.bashrc   # if using gcc5
  41     echo 'export INSTALL_PREFIX=$HOME/opt' >>~/.bashrc
  42     echo 'export LD_LIBRARY_PATH=$INSTALL_PREFIX/lib64:$INSTALL_PREFIX/lib' >>~/.bashrc
  43     echo 'export LIBRARY_PATH=$INSTALL_PREFIX/lib64:$INSTALL_PREFIX/lib' >>~/.bashrc
  44     echo 'export PKG_CONFIG_PATH=$INSTALL_PREFIX/lib64/pkgconfig:$INSTALL_PREFIX/lib/pkgconfig' >>~/.bashrc
  45     echo 'export PATH=$INSTALL_PREFIX/bin:$PATH' >>~/.bashrc
  46     echo 'export RSYNC_TARGET=MY_TARGET_HOSTNAME' >>~/.bashrc
  47     echo 'export RSYNC_PREFIX=./opt' >>~/.bashrc
  48
  49     echo "#----------  AGL options End ---------" >>~/.bashrc
  50     source ~/.bashrc
  51
  52     # install LibMicroHttpd
  53     LIB_MH_VERSION=0.9.55
  54     wget https://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-${LIB_MH_VERSION}.tar.gz
  55     tar -xzf libmicrohttpd-${LIB_MH_VERSION}.tar.gz
  56     cd libmicrohttpd-${LIB_MH_VERSION}
  57     ./configure --prefix=${INSTALL_PREFIX}
  58     make
  59     sudo make install-strip
  60
  61     # retrieve last AFB_daemon from AGL
  62     git clone https://gerrit.automotivelinux.org/gerrit/src/app-framework-binder
  63
  64     # Warning: previous GCC options should be set before initial cmake (clean Build/*)
  65     cd app-framework-binder; mkdir -p build; cd build
  66     cmake -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX ..
  67     make
  68     make install
  69 ```
  70
  71
  72 # Compile binding
  73
  74 ```
  75     source ~/.bashrc  # or any other file where your have place your compilation preferences
  76     mkdir -p build
  77     cd build
  78     cmake -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX ..
  79     make
  80
  81     afb-daemon --workdir=.. --ldpaths=build --port=1234  --roothttp=./htdocs --token="" --verbose
  82
  83     speaker-test -twav -D hw:ep01 -c 2
  84     firefox http://localhost:1234
  85 ```
  86
  87 # Archive
  88
  89 ```
  90 VERSION=0.1
  91 GIT_TAG=master
  92 PKG_NAME=UNICENS-agent
  93 git archive --format=tar.gz --prefix=${PKG_NAME}-${VERSION}/ ${GIT_TAG} -o ${PKG_NAME}_${VERSION}.orig.tar.gz
  94 ```
  95
  96 # Local Source Debug with GDB
  97
  98 Warning: technically AGL bindings are shared libraries loaded thought 'dlopen'. GDB supports source debug of dynamically
  99 loaded libraries, but user should be warn that the actual path to sharelib symbols is directly inherited from DLOPEN.
 100 As a result if you change your directory after binder start with --workdir=xxx then GDB will not find symbols anymore
 101
 102 ```
 103     Examples:
 104
 105     # WORK when running in direct
 106     afb-daemon --workdir=.. --ldpaths=build --port=1234 --roothttp=./htdocs
 107
 108     # FAIL when using GDB with warning: Could not load shared library ....
 109     gdb -args afb-daemon --workdir=.. --ldpaths=build --port=1234 --roothttp=./htdocs
 110     ...
 111     warning: Could not load shared library symbols for ./build/ucs2-afb/afb-ucs2.so.
 112     Do you need "set solib-search-path" or "set sysroot"?
 113     ...
 114 ```
 115
 116 To debug sharelib symbol path: start your binder under GDB. Then break your session after the binder has
 117 loaded its bindings. Finally use "info sharedlibrary" and check 'SymsRead'. If equal to 'No' then either you start GDB
 118 from the wrong relative directory, either you have to use 'set solib-search-path' to force the path.
 119
 120 ```
 121     gdb -args afb-daemon --workdir=.. --ldpaths=build --port=1234 --roothttp=./htdocs
 122     run
 123         ...
 124         NOTICE: API UNICENS added
 125         NOTICE: Waiting port=1234 rootdir=.
 126         NOTICE: Browser URL= http://localhost:1234
 127     (hit Ctrl-C to break the execution)
 128     info sharedlibrary afb-*
 129 ```
 130
 131 # Running an debugging on a target
 132
 133 ```
 134 export RSYNC_TARGET=root@xx.xx.xx.xx
 135 export RSYNC_PREFIX=/opt    # WARNING: installation directory should exist
 136
 137 mkdir $RSYNC_TARGET
 138 cd    $RSYNC_TARGET
 139
 140 cmake -DRSYNC_TARGET=$RSYNC_TARGET -DRSYNC_PREFIX=$RSYNC_PREFIX ..
 141 make remote-target-populate
 142
 143     ./build/target/start-${RSYNC_TARGET}.sh
 144     firefox http://localhost:1234    # WARNING: do not forget firewall if any
 145
 146     ssh -tt ${RSYNC_TARGET} speaker-test -twav -D hw:ep01 -c 2
 147 ```
 148
 149 Note: remote-target-populate will
 150  - create a script to remotely start the binder on the target in ./build/target/start-on-target-name.sh
 151  - create a gdbinit file to transparently debug remotely in source code with gdb -x ./build/target/gdb-on-target-name.ini
 152  - to run and debug directly from your IDE just configure the run and debug properties with the corresponding filename
 153
 154 Note that Netbeans impose to set debug directory to ./build/pkgout or it won't find binding symbols for source debugging
 155
 156 # Default Volume of Amplifiers
 157 The binding currently supports two use cases for amplifiers.
 158 1. Amplifiers are initialized with a default volume. The head unit uses software volume
 159    to change the volume of streaming data.
 160 2. Amplifiers are initialized muted. The head unit uses hardware volume (e.g. HAL-MOST-UNICENS)
 161    to change the volume of amplifiers remotely.
 162
 163 Use case 2 is the default use case. If you like to use this binding without hardware volume support
 164 please adopt the ```config_multichannel_audio_kit.xml``` as explained below.
 165
 166 ```
 167 <!-- Register 7: Master Volume (Max Volume=07 00 00 and Min Volume=07 03 FF) -->
 168 <!--   - together with HAL-MOST-UNICENS binding use "07 03 FF" = muted after start -->
 169 <!--   - otherwise use "07 01 50" = default volume -->
 170 <I2CPortWrite Address="0x2A" Payload="07 03 FF"/>
 171 ```