From 0c926e5d19769ba20fdebe0ca3e2eaf8296153c2 Mon Sep 17 00:00:00 2001
From: reichi <sreichholf@users.noreply.github.com>
Date: Thu, 9 Jun 2016 22:50:06 +0200
Subject: [PATCH] Allow software based volume control (#3556)

* Allow software based volume control
- enable it for AR9X
- rename "HARDWARE_VOLUME" defines to "MASTER_VOLUME"
- adjust build-firmware.py and fwoptions.py

* Software based volume control: Do it right

* whitespace cleanup

* software volume: cleanup/revert some leftovers of undone changes
---
 radio/src/CMakeLists.txt                 |  2 +-
 radio/src/audio_arm.cpp                  | 10 ++++++++++
 radio/src/functions.cpp                  |  2 +-
 radio/src/mixer.cpp                      |  2 +-
 radio/src/opentx.h                       |  2 +-
 radio/src/targets/simu/simpgmspace.cpp   |  2 +-
 radio/src/targets/sky9x/audio_driver.cpp |  2 +-
 radio/util/build-firmware.py             |  1 -
 radio/util/fwoptions.py                  |  1 -
 9 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/radio/src/CMakeLists.txt b/radio/src/CMakeLists.txt
index 5cf2bdb34..16a0a6584 100644
--- a/radio/src/CMakeLists.txt
+++ b/radio/src/CMakeLists.txt
@@ -229,7 +229,7 @@ elseif(PCB STREQUAL SKY9X OR PCB STREQUAL 9XRPRO OR PCB STREQUAL AR9X)
     set(TARGET_SRC ${TARGET_SRC} rtc_driver.cpp)
     set(BOOTLOADER bootflash8.lbm)
   elseif(PCB STREQUAL AR9X)
-    add_definitions(-Dat91sam3s8 -DAR9X)
+    add_definitions(-Dat91sam3s8 -DAR9X -DSOFTWARE_VOLUME)
     set(FLAVOUR ar9x)
     include_directories(${THIRDPARTY_DIR}/xdk-asf-3.31.0/sam/drivers/twi)
     set(SRC ${SRC} ${THIRDPARTY_DIR}/xdk-asf-3.31.0/sam/drivers/twi/twi.c)
diff --git a/radio/src/audio_arm.cpp b/radio/src/audio_arm.cpp
index 1d1bd6f53..f4e9e8db1 100644
--- a/radio/src/audio_arm.cpp
+++ b/radio/src/audio_arm.cpp
@@ -23,6 +23,10 @@
 
 extern OS_MutexID audioMutex;
 
+#if defined(SOFTWARE_VOLUME)
+extern uint8_t currentSpeakerVolume;
+#endif
+
 const int16_t sineValues[] =
 {
     0, 196, 392, 588, 784, 980, 1175, 1370, 1564, 1758,
@@ -784,6 +788,12 @@ void AudioQueue::wakeup()
       // TRACE("pushing buffer %d\n", bufferWIdx);
       bufferWIdx = nextBufferIdx(bufferWIdx);
       buffer->size = size;
+#if defined(SOFTWARE_VOLUME)
+      for(uint32_t i=0; i<buffer->size; ++i) {
+        int32_t tmpSample = (int32_t) ((uint32_t) (buffer->data[i]) - AUDIO_DATA_SILENCE);  // conversion from uint16_t
+        buffer->data[i] = (int16_t) (((tmpSample * currentSpeakerVolume) / VOLUME_LEVEL_MAX) + AUDIO_DATA_SILENCE);
+      }
+#endif
       audioPushBuffer(buffer);
       __enable_irq();
     }
diff --git a/radio/src/functions.cpp b/radio/src/functions.cpp
index d79ac0a01..a514262b0 100644
--- a/radio/src/functions.cpp
+++ b/radio/src/functions.cpp
@@ -447,7 +447,7 @@ void evalFunctions()
             break;
 #endif
 
-#if defined(HARDWARE_VOLUME)
+#if defined(MASTER_VOLUME)
           case FUNC_VOLUME:
           {
             getvalue_t raw = getValue(CFN_PARAM(cfn));
diff --git a/radio/src/mixer.cpp b/radio/src/mixer.cpp
index 7876bcf6b..9bb4e3bf4 100644
--- a/radio/src/mixer.cpp
+++ b/radio/src/mixer.cpp
@@ -1088,7 +1088,7 @@ void evalMixes(uint8_t tick10ms)
   // must be done after mixing because some functions use the inputs/channels values
   // must be done before limits because of the applyLimit function: it checks for safety switches which would be not initialized otherwise
   if (tick10ms) {
-#if defined(HARDWARE_VOLUME)
+#if defined(MASTER_VOLUME)
     requiredSpeakerVolume = g_eeGeneral.speakerVolume + VOLUME_LEVEL_DEF;
 #endif
 
diff --git a/radio/src/opentx.h b/radio/src/opentx.h
index e0704e88a..b09598d79 100644
--- a/radio/src/opentx.h
+++ b/radio/src/opentx.h
@@ -218,7 +218,7 @@
 #define IS_FAI_FORBIDDEN(idx) (IS_FAI_ENABLED() && idx >= MIXSRC_FIRST_TELEM)
 
 #if defined(CPUARM)
-  #define HARDWARE_VOLUME
+  #define MASTER_VOLUME
 #endif
 
 #if defined(SIMU)
diff --git a/radio/src/targets/simu/simpgmspace.cpp b/radio/src/targets/simu/simpgmspace.cpp
index 799f97fbf..e0b5e8b51 100644
--- a/radio/src/targets/simu/simpgmspace.cpp
+++ b/radio/src/targets/simu/simpgmspace.cpp
@@ -430,7 +430,7 @@ void audioConsumeCurrentBuffer()
 }
 #endif
 
-#if defined(HARDWARE_VOLUME)
+#if defined(MASTER_VOLUME)
 void setScaledVolume(uint8_t volume)
 {
   simuAudio.currentVolume = 127 * volume * simuAudio.volumeGain / VOLUME_LEVEL_MAX / 10;
diff --git a/radio/src/targets/sky9x/audio_driver.cpp b/radio/src/targets/sky9x/audio_driver.cpp
index 9f40141d2..5b2685b9d 100644
--- a/radio/src/targets/sky9x/audio_driver.cpp
+++ b/radio/src/targets/sky9x/audio_driver.cpp
@@ -163,7 +163,7 @@ void audioEnd()
 
 void setScaledVolume(uint8_t volume)
 {
-#if !defined(NO_HARDWARE_VOLUME)
+#if !defined(SOFTWARE_VOLUME)
   volumeRequired = volumeScale[min<uint8_t>(volume, VOLUME_LEVEL_MAX)];
 #ifndef AR9X
   __disable_irq() ;
diff --git a/radio/util/build-firmware.py b/radio/util/build-firmware.py
index 1e7ff6bc5..a0969e4fa 100755
--- a/radio/util/build-firmware.py
+++ b/radio/util/build-firmware.py
@@ -94,7 +94,6 @@ elif options[optcount] == "9xrpro":
 elif options[optcount] == "ar9x":
     command_options["PCB"] = "AR9X"
     command_options["SDCARD"] = "YES"
-    command_options["HARDWARE_VOLUME"] = "NO"
     firmware_options = options_ar9x
     maxsize = 65536 * 4
     board = BOARD_SKY9X
diff --git a/radio/util/fwoptions.py b/radio/util/fwoptions.py
index 5bfa4dde9..0c79de580 100755
--- a/radio/util/fwoptions.py
+++ b/radio/util/fwoptions.py
@@ -235,7 +235,6 @@ options_ar9x = {
     "faichoice": ("FAI", "CHOICE", None),
     "nooverridech": ("OVERRIDE_CHANNEL_FUNCTION", "NO", "YES"),
     # "rtc": ("RTCLOCK", "YES", "NO"),
-    # "volume": ("HARDWARE_VOLUME", "YES", "NO") # Renove HARDWARE_VOLUME=NO in the commandline below when activating!
 }
 
 options_taranis = {