Reduce voice RAM and ROM needs

doc/Extended-audio.txt

@@ -2,9 +2,6 @@ A.	Voice Feedback on the following are supported.  For additional details, refer
 	- Changing Switch Positions.
 	- Turning of Auxiliary Knobs.
 	  Different voice files can be specified for turning up & turning down of knobs.
-	- Trim buttons as virtual switches.
-	  Different voice files can be specified for the same trim button when used as
-          Momentary or Toggle switch.
 
 B.	Following options have been added to media/sound.ini file.
 1)	Specify a different playback device for each alert message.

src/config/model.c

@@ -19,6 +19,7 @@
 #include "tx.h"
 #include "music.h"
 #include "extended_audio.h"
+#include "voice.h"
 
 #include <stdlib.h>
 #include <string.h>
@@ -1076,7 +1077,8 @@ int assign_int(void* ptr, const struct struct_map *map, int map_size)
 
     if (MATCH_SECTION(SECTION_VOICE)) {
         u16 val = atoi(value);
-        if(val>MAX_VOICEMAP_ENTRIES-1 || voice_map[val].duration == 0 || val < CUSTOM_ALARM_ID) {
+        CONFIG_VoiceParse(val);
+        if (current_voice_mapping.duration == 0 || val < CUSTOM_ALARM_ID) {
             printf("%s: Music %s not found in voice.ini or below ID %d\n", section, value, CUSTOM_ALARM_ID);
             return 0;
         }
@@ -1106,6 +1108,8 @@ int assign_int(void* ptr, const struct struct_map *map, int map_size)
         for (int i = 0; i < NUM_TIMERS; i++) {
             if (MATCH_KEY(VOICE_TIMER[i])) {
                 m->voice.timer[i].music = val;
+                CONFIG_VoiceParse(MUSIC_ALARM1+i);
+                m->timer[i].duration = current_voice_mapping.duration;
                 return 1;
             }
         }
@@ -1494,6 +1498,12 @@ static void clear_model(u8 full)
     }
     Model.ppmin_centerpw = 1500;
     Model.ppmin_deltapw = 400;
+#if HAS_EXTENDED_AUDIO
+    for (int i = 0; i < NUM_TIMERS; i++) {
+        CONFIG_VoiceParse(MUSIC_ALARM1 + i);
+        Model.timer[i].duration = current_voice_mapping.duration;
+    }
+#endif
 }
 
 u8 CONFIG_ReadModel(u8 model_num) {

src/config/tx.c

@@ -338,6 +338,7 @@ void CONFIG_LoadTx()
 #if HAS_EXTENDED_AUDIO
     Transmitter.audio_player = AUDIO_NONE;
     Transmitter.audio_vol = 10;
+    Transmitter.voice_ini_entries = VOICE_INI_EMPTY;
 #endif
 #if HAS_AUDIO_UART
     Transmitter.audio_uart = 0;
@@ -349,7 +350,7 @@ void CONFIG_LoadTx()
     CONFIG_LoadHardware();
     CONFIG_IniParse("tx.ini", ini_handler, (void *)&Transmitter);
     crc32 = Crc(&Transmitter, sizeof(Transmitter));
-#if HAS_EXTENDED_AUDIO
+#if HAS_MUSIC_CONFIG
     CONFIG_VoiceParse(MAX_VOICEMAP_ENTRIES);
 #endif
     return;

src/config/tx.h

@@ -64,6 +64,7 @@ struct Transmitter {
 #if HAS_EXTENDED_AUDIO
     enum AudioPlayers audio_player;
     u8 audio_vol;
+    s16 voice_ini_entries;
 #endif
 #if HAS_AUDIO_UART
     u8 audio_uart;

src/config/voice.c

@@ -32,7 +32,7 @@ const char SECTION_VOICE_CUSTOM[] = "custom";
 
 static int ini_handler(void* user, const char* section, const char* name, const char* value)
 {
-    // ini_handler returns a requested mp3 label passed at *user to tempstring
+    (void) section;
     u16 req_id = *((long*)user);
     u16 id = atoi(name);
     const char* ptr = value;
@@ -47,32 +47,24 @@ static int ini_handler(void* user, const char* section, const char* name, const
         duration = atoi(ptr + 1);
         }
 
-#if HAS_MUSIC_CONFIG
     if ( k && (req_id != MAX_VOICEMAP_ENTRIES) && (req_id == id) ) {
-        strlcpy(tempstring, value, k+1);
-        tempstring[MAX_VOICE_LABEL] = '\0';  // limit label length
+        current_voice_mapping.duration = duration;
+        if (HAS_MUSIC_CONFIG)
+            strlcpy(tempstring, value, k+1);  // return a requested mp3 label passed at *user to tempstring
         return 1;
     }
-#endif
-    if ( req_id == MAX_VOICEMAP_ENTRIES ) {
-        if (MATCH_SECTION(SECTION_VOICE_GLOBAL)) {
-            for (int i = 0; i < CUSTOM_ALARM_ID; i++) {
-                snprintf(tempstring, 4, "%d", i);
-                if (MATCH_KEY(tempstring)) {
-                    voice_map[i].duration = duration;
-                    voice_map[i].id = i;
-                    return 1;
-                }
+    if (HAS_MUSIC_CONFIG) {
+        if ( req_id == MAX_VOICEMAP_ENTRIES ) {
+            if (MATCH_SECTION(SECTION_VOICE_GLOBAL)) {
+                Transmitter.voice_ini_entries = VOICE_INI_GLOBAL_ONLY;
             }
+            if (MATCH_SECTION(SECTION_VOICE_CUSTOM)) {
+                // Initial count of custom voicemap entries
+                Transmitter.voice_ini_entries++;
+                return 1;
+            }
+            return 0;
         }
-        if (MATCH_SECTION(SECTION_VOICE_CUSTOM)) {
-            voice_map[voice_map_entries].duration = duration;
-            voice_map[voice_map_entries].id = id;
-            voice_map_entries++;
-            return 1;
-        }
-        printf("Unknown entry in voice.ini: %s\n", value);
-        return 0;
     }
     return 1;  // voice label ignored
 }
@@ -95,16 +87,16 @@ const char* CONFIG_VoiceParse(unsigned id)
     char filename[] = "media/voice.ini";
     #endif
     if (id == MAX_VOICEMAP_ENTRIES) {  // initial parse of voice.ini
-        voice_map_entries = CUSTOM_ALARM_ID;  // Reserve space in map for global alerts
-        if (CONFIG_IniParse(filename, ini_handler, &id)) {
-            printf("Failed to parse voice.ini\n");
-            Transmitter.audio_player = AUDIO_NONE;  // disable external voice output
+        if (CONFIG_IniParse(filename, ini_handler, &id))
             tempstring[0] = '\0';
+        if (Transmitter.voice_ini_entries == VOICE_INI_EMPTY) {
+            printf("Failed to parse voice.ini\n");
+            Transmitter.audio_player = AUDIO_NONE;  // disable external voice when no global voices are found in voice.ini
         }
     }
-    if ( (id < MAX_VOICEMAP_ENTRIES) && (id >= CUSTOM_ALARM_ID) ) {
+    if ( (id < MAX_VOICEMAP_ENTRIES) ) {
         if (CONFIG_IniParse(filename, ini_handler, &id)) {
-            // ini handler will return tempstring with label of id
+            // ini handler will return tempstring with label of id and fill current_voice_mapping
         }
     }
     return tempstring;

src/config/voice.h

@@ -1 +1,6 @@
-const char* CONFIG_VoiceParse();
+#ifndef _VOICE_H_
+#define _VOICE_H_
+
+const char* CONFIG_VoiceParse(unsigned id);
+
+#endif

src/extended_audio.c

@@ -17,6 +17,7 @@
 #include "music.h"
 #include "config/tx.h"
 #include "config/model.h"
+#include "config/voice.h"
 #include "extended_audio.h"
 #include "stdlib.h"
 
@@ -25,9 +26,8 @@
 #endif // EMULATOR
 
 #if HAS_EXTENDED_AUDIO
-u16 voice_map_entries;
-struct VoiceMap voice_map[MAX_VOICEMAP_ENTRIES];
-u16 audio_queue[AUDIO_QUEUE_LENGTH];
+struct QueueEntry current_voice_mapping;
+struct QueueEntry audio_queue[AUDIO_QUEUE_LENGTH];
 u8 next_audio;
 u8 num_audio;
 u32 audio_queue_time;
@@ -75,51 +75,48 @@ void AUDIO_Init() {
 
 #ifndef EMULATOR
 // Send a block of len bytes to the Audio device.
-void
-AUDIO_Send(u8 *data, int len) {
+static void AUDIO_Send(u8 *data, int len) {
   void AUDIO_send_char(char c);
   for (u16 iter = 0; iter < len; iter += 1) {
     AUDIO_send_char(data[iter]);
   }
 }
 
 // Send a string  to the Audio device.
-void
-AUDIO_Print(char *string) {
+static void AUDIO_Print(char *string) {
   AUDIO_Send((u8 *)string, strlen(string));
 }
 #endif // EMULATOR
 
-void u16ToArray(u16 value, u8 *array){
+static void u16ToArray(u16 value, u8 *array) {
     *array = (u8)(value>>8);
     *(array+1) = (u8)value;
 }
 
 // generate Checksum for DFPlyer commands
-u16 AUDIO_CalculateChecksum(u8 *buffer) {
+static u16 AUDIO_CalculateChecksum(u8 *buffer) {
     u16 sum = 0;
     for (int i=1; i < 7; i += 1)
         sum += buffer[i];
     return -sum;
 }
 
 // Generate a string to play.
-int AUDIO_Play(u16 music) {
-
+static int AUDIO_Play(u16 id) {
     // If we are just playing beeps....
-    if (music == MUSIC_KEY_PRESSING || music == MUSIC_MAXLEN) {
+    if (id == MUSIC_KEY_PRESSING || id == MUSIC_MAXLEN) {
         printf("Voice: beep only\n");
         return 0;
     }
-    printf("Voice: Playing mp3 #%d\n", voice_map[music].id);
+    printf("Voice: Playing mp3 #%d\n", id);
 
 #ifdef EMULATOR     // On emulators call mpg123 to play mp3s
     char cmd[70];
     u16 vol_val = Transmitter.audio_vol * 32786/10;
 #ifdef _WIN32
-    sprintf(cmd, "start /B ..\\..\\mpg123 -f %d -q ..\\..\\mp3\\%04d*.mp3 > nul 2>&1", vol_val, voice_map[music].id);
+    snprintf(cmd, sizeof(cmd), "start /B ..\\..\\mpg123 -f %d -q ..\\..\\mp3\\%04d*.mp3 > nul 2>&1", vol_val, id);
 #else
-    sprintf(cmd, "mpg123 -f %d -q ../../mp3/%04d*.mp3 > /dev/null 2>&1 &", vol_val, voice_map[music].id);
+    snprintf(cmd, sizeof(cmd), "mpg123 -f %d -q ../../mp3/%04d*.mp3 > /dev/null 2>&1 &", vol_val, id);
 #endif // _WIN32
     system(cmd);
     return 1;
@@ -132,14 +129,14 @@ int AUDIO_Play(u16 music) {
     case AUDIO_NONE: return 0;	// Play beeps...
     case AUDIO_AUDIOFX: {
       char buffer[5];
-      snprintf(buffer, sizeof(buffer), "#%d\n", voice_map[music].id);
+      snprintf(buffer, sizeof(buffer), "#%d\n", id);
       AUDIO_Print(buffer);
       break;
     }
     case AUDIO_DF_PLAYER:
         // Fill in track number and checksum
         player_buffer[3] = 0x12;
-        u16ToArray(voice_map[music].id, player_buffer+5);
+        u16ToArray(id, player_buffer+5);
         u16ToArray(AUDIO_CalculateChecksum(player_buffer), player_buffer+7);
         AUDIO_Send(player_buffer, sizeof(player_buffer));
         break;
@@ -188,32 +185,35 @@ void AUDIO_SetVolume() {
     }
 #endif
 }
+static void AUDIO_ResetQueue() {
+    num_audio = 0;
+    next_audio = 0;
+    printf("Voice: Resetting queue.\n");
+}
 
 void AUDIO_CheckQueue() {
     u32 t = CLOCK_getms();
     if (next_audio < num_audio) {
         if (t > audio_queue_time) {
-            AUDIO_Play(audio_queue[next_audio]);
-            audio_queue_time = CLOCK_getms() + voice_map[audio_queue[next_audio]].duration;
+            AUDIO_Play(audio_queue[next_audio].id);
+            audio_queue_time = CLOCK_getms() + audio_queue[next_audio].duration;
             next_audio++;
         }
     } else if (num_audio && t > audio_queue_time) {
-        printf("Voice: Queue finished, resetting.\n");
-        num_audio = 0;
-        next_audio = 0;
+        printf("Voice: Queue finished.\n");
+        AUDIO_ResetQueue();
         AUDIO_SetVolume();
     }
 }
 
-int AUDIO_VoiceAvailable() {
+static int AUDIO_VoiceAvailable() {
 #if defined BUILDTYPE_DEV
 #if HAS_AUDIO_UART
     if (!Transmitter.audio_uart)
 #endif
     {
         printf("Voice: Dev mode enabled, cannot set volume\n");
-        num_audio = 0;  // Reset queue when audio not available
-        next_audio = 0;
+        AUDIO_ResetQueue();
         return 0;
     }
 #endif  // BUILDTYPE_DEV
@@ -224,32 +224,33 @@ int AUDIO_VoiceAvailable() {
     if ( PPMin_Mode() || Model.protocol == PROTOCOL_PPM ) { // don't send play command when using PPM port
 #endif
         printf("Voice: PPM port in use\n");
-        num_audio = 0;  // Reset queue when audio not available
-        next_audio = 0;
+        AUDIO_ResetQueue();
         return 0;
     }
 #endif // _DEVO12_TARGET_H_
 
     if ( (Transmitter.audio_player == AUDIO_NONE) || (Transmitter.audio_player == AUDIO_DISABLED) || !Transmitter.audio_vol ) {
-        num_audio = 0; // Reset queue when audio not available
-        next_audio = 0;
+        AUDIO_ResetQueue();
         return 0;
     }
 
     return 1;
 }
 
 int AUDIO_AddQueue(u16 music) {
-    if (num_audio == AUDIO_QUEUE_LENGTH) {
-        printf("Voice: Queue full, cannot add new mp3 #%d\n",music);
+    if (!AUDIO_VoiceAvailable() || num_audio == AUDIO_QUEUE_LENGTH) {
+        printf("Voice: queue full or voice not available, cannot add new mp3 #%d\n", music);
         return 0;
     }
-    if (!voice_map[music].duration) {
+    CONFIG_VoiceParse(music);
+    if (!current_voice_mapping.duration) {
         printf("Voice: mp3 length is zero\n");
         return 0;
     }
-
-    audio_queue[num_audio++] = music;
+    audio_queue[num_audio].duration = current_voice_mapping.duration;
+    audio_queue[num_audio].id = music;
+    printf("Voice: added ID %d with duration %d to queue position %d.\n", music, current_voice_mapping.duration, num_audio);
+    num_audio++;
     return 1;
 }
 

src/extended_audio.h

@@ -6,13 +6,12 @@
 #define AUDIO_QUEUE_LENGTH 20 // arbitraty chosen, do we need more?
 
 void AUDIO_Init();
-int AUDIO_Play(u16 music);
 void AUDIO_SetVolume();
 void AUDIO_CheckQueue();
 int AUDIO_AddQueue(u16 music);
-int AUDIO_VoiceAvailable();
 
-extern u16 audio_queue[AUDIO_QUEUE_LENGTH];
+extern struct QueueEntry audio_queue[AUDIO_QUEUE_LENGTH];
+extern struct QueueEntry current_voice_mapping;
 extern u8 next_audio;
 extern u8 num_audio;
 extern u32 audio_queue_time;

src/main.c

@@ -232,15 +232,12 @@ void EventLoop()
         }
     	if(Transmitter.music_shutdown) {
 #if HAS_EXTENDED_AUDIO
-        if(AUDIO_VoiceAvailable()) {
             MUSIC_Play(MUSIC_SHUTDOWN);
             while (CLOCK_getms() < audio_queue_time) {
                 // Wait for voice to finished
                 CLOCK_ResetWatchdog();
             }
-        } else {
 #else
-        {
             // We wait ~1sec for shutdown buzzer music finished
             unsigned int time;
             MUSIC_Play(MUSIC_SHUTDOWN);
@@ -250,8 +247,6 @@ void EventLoop()
             }
 #endif
         }
-	}
-
         PWR_Shutdown();
     }
 #endif