Add playSound(), Reduce debug output - sound on collide works

currently plays sound when snake crashes (leaderboard shown)

- shorten example audio file
- Add sound.c: abstract function to play .wav files
- config:
    - Add config option RENDER_GAME_TO_CONSOLE
    - disable debug output

CMakeLists.txt

@@ -38,6 +38,7 @@ set(SOURCES
     src/snake.c
     src/map.c
     src/common.c
+    src/sound.c
 )
 
 

include/config.h

@@ -5,8 +5,9 @@
 #define MAX_MAP_FIELDS (MAX_MAP_SIZE*MAX_MAP_SIZE)
 
 // logging settings
-#define DEBUG_OUTPUT_ENABLED
+//#define DEBUG_OUTPUT_ENABLED
 #define INFO_OUTPUT_ENABLED
+//#define RENDER_GAME_TO_CONSOLE
 
 
 

include/sound.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <stdbool.h>
+
+
+//===========================
+//======== playSound ========
+//===========================
+//abstract function that plays sound with provided path to .wav file
+//wait parameter blocks program until playback finished
+int playSound(const char * filePath, bool wait);

src/game.c

@@ -92,8 +92,6 @@ void runGameCycle()
         // show leaderboard when collided
         // TODO consider game.lifesRemaining and reset if still good?
         LOGI("game: collided with wall or self! => show leaderboard\n");
-        LOGI("DEBUG: collision currently disabled, game will continue in 1s...\n");
-        DELAY(800);
         //game.gameState = MENU; //TODO add config.collisionEnabled option?
         showLeaderboard();
         return;
@@ -112,6 +110,8 @@ void runGameCycle()
 
     //--- update frame ---
     renderGame();
+#ifdef RENDER_GAME_TO_CONSOLE
     printMap(game.map); //render game to console
+#endif
     return;
 }

src/menu.c

@@ -1,61 +1,39 @@
 #include "menu.h"
 #include "game.h"
+#include "sound.h"
+#include "common.h"
 #include <stdio.h>
-#include <Windows.h>
+//#include <Windows.h>
 
 
 void showStartScreen(){
+    LOGI("menu: showing start-screen\n");
     game.gameState = RUNNING;
     return;
 }
 
 void showLeaderboard(){
+    LOGI("menu: showing leaderboard\n");
 
+    //--- play crash sound ---
+    //play audio file, wait until playback is finished
+    //note: when displaying actual leaderboard, the second parameter should be 'false' to not block the program
+    playSound("../sounds/crash_rock-cinematic.wav", true); 
+    DELAY(100);
+
+    //--- quit game ---
     game.gameState = EXIT;
-
-//____________Ton abspielen_________________
-
-    // Lade die Audiodatei
-    SDL_AudioSpec wavSpec;
-    Uint32 wavLength;
-    Uint8 *wavBuffer;
-
-    //Prüfung, ob Datei geladen wurde
-    //Alternativ ("../sounds/rock-cinematic-161648.wav") -> beide Ordner sind angelegt und die Datei befindet sich in beiden Ordnern
-    if (SDL_LoadWAV("../SDL2/sounds/rock-cinematic-161648.wav", &wavSpec, &wavBuffer, &wavLength) == NULL) {
-        printf("Die Audiodatei konnte nicht geladen werden: %s\n", SDL_GetError());
-        return;
-    }
-
-    // Spiel die Audiodatei ab
-    SDL_AudioDeviceID deviceId = SDL_OpenAudioDevice(NULL, 0, &wavSpec, NULL, 0); //(Standard-Audiogerät,1 für Aufnahme/ 0 für Wiedergabe,Zeiger auf eine SDL_AudioSpec-Struktur,NULL: In diesem Fall wird kein Zeiger auf eine SDL_AudioSpec-Struktur übergeben, die die tatsächlich verwendeten Audio-Eigenschaften speichert,0: allowed_changes ist ein Bitfeld, das Änderungen an den geöffneten Eigenschaften erlaubt)
-    SDL_QueueAudio(deviceId, wavBuffer, wavLength);
-    SDL_PauseAudioDevice(deviceId, 0);
-    printf("Audiodatei wird abgespielt");
-
-    // Warte, bis die Wiedergabe abgeschlossen ist
-    while (SDL_GetQueuedAudioSize(deviceId) > 0) {
-        SDL_Delay(100);
-    }
-
-    // Aufräumen
-    SDL_CloseAudioDevice(deviceId);
-    SDL_FreeWAV(wavBuffer);
-
-    printf("\n\aalarm sound mit a\n");
-    printf("\7alarm sound mit 7\n");
-    // Spiele einen System-Sound ab (Exclamation-Sound)
-    MessageBeep(MB_ICONEXCLAMATION);    //nur dieser Ton wird bei mir abgespielt
-
     return;
 }
 
 void showPauseScreen(){
+    LOGI("menu: showing leaderboard\n");
     game.gameState = PAUSED;
     return;
 }
 
 void showSettings(){
+    LOGI("menu: showing settings\n");
     return;
 }
 

src/sound.c

@@ -0,0 +1,73 @@
+#include <stdint.h>
+#include "sound.h"
+#include "SDL.h"
+
+#include "common.h"
+#include "sound.h"
+
+
+
+//===========================
+//======== playSound ========
+//===========================
+//abstract function that plays sound with provided path to .wav file
+//wait parameter blocks program until playback finished
+int playSound(const char *filePath, bool wait)
+{
+    //TODO add volume % option
+
+    //--- variables ---
+    static bool soundInitialized = false;
+    static bool deviceExists = false;
+    static uint8_t *wavBuffer;
+    static SDL_AudioDeviceID deviceId;
+    SDL_AudioSpec wavSpec;
+    uint32_t wavLength;
+    
+
+    //--- initialize SDL audio ---
+    if (!soundInitialized)
+    {
+        if (SDL_Init(SDL_INIT_AUDIO) < 0)
+        {
+            printf("SDL: could not init audio!\n");
+            return 1;
+        }
+        LOGI("sound: initialized SDL audio\n");
+    }
+
+
+    //--- close device and free memory of previous sound ---
+    //note: also cancels currently playing sound
+    if (deviceExists)
+    {
+        SDL_CloseAudioDevice(deviceId);
+        // free memory of previously played file
+        SDL_FreeWAV(wavBuffer);
+    }
+
+
+    //--- load file ---
+    if (SDL_LoadWAV(filePath, &wavSpec, &wavBuffer, &wavLength) == NULL)
+    {
+        printf("sound: file '%s' could not be loaded E:'%s'\n", filePath, SDL_GetError());
+        return 1;
+    }
+
+
+    //--- play file ---
+    deviceId = SDL_OpenAudioDevice(NULL, 0, &wavSpec, NULL, 0);
+    deviceExists = true;
+    SDL_QueueAudio(deviceId, wavBuffer, wavLength);
+    SDL_PauseAudioDevice(deviceId, 0);
+    LOGI("sound: success, playing file '%s'\n", filePath);
+
+
+    //--- wait until playback is finished --- (if desired)
+    while (wait && SDL_GetQueuedAudioSize(deviceId) > 0)
+    {
+        SDL_Delay(100);
+    }
+
+    return 0;
+}