Merge branch 'dev' - Sound effects work

Sounds play when eating, entering portals, or colliding

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,20 @@
+#pragma once
+
+#include <stdbool.h>
+
+
+//===========================
+//======== playSound ========
+//===========================
+//abstract function that plays sound with provided path to .wav file
+//'wait' parameter blocks program until playback is finished (otherwise launched in another thread)
+int playSound(const char * filePath, bool wait);
+
+
+//==========================
+//===== playSoundAsync =====
+//==========================
+//launches playSound in another thread to prevent delay
+//due to loading of wav file taking up to 300ms
+//(equivalent to playsound() with parameter wait=false)
+int playSoundAsync(const char *filePath);

src/game.c

@@ -4,6 +4,7 @@
 #include "menu.h"
 #include "food.h"
 #include "render.h"
+#include "sound.h"
 
 
 // global struct for storing all game data
@@ -19,6 +20,14 @@ gameData_t game = {
 };
 
 
+// list of audio files randomly played when food eaten
+const char *eatSounds[] = {
+    "../sounds/eat-bite1.wav",
+    "../sounds/eat-bite2.wav",
+    "../sounds/eat-crunch1.wav",
+    "../sounds/eat-crunch2.wav"};
+#define EAT_SOUNDS_COUNT 4
+
 
 //========================
 //======= gameInit =======
@@ -60,8 +69,15 @@ void handlePortals()
         portal_t p = game.map.portals[i]; //copy curren portal (code more readable)
         // is at portal
         if (game.snake.headX == p.posX && game.snake.headY == p.posY){
+            //-- update head pos ---
             snakeSetHeadPos(p.targetX, p.targetY);
             LOGI("game: entered portal i=%d at x=%d, y=%d -> set head to x=%d y=%d\n", i, p.posX, p.posY, p.targetX, p.targetY);
+            //--- play sound ---
+            //playSoundAsync("../sounds/portal1_short.wav"); //too short
+            //playSoundAsync("../sounds/portal2_oscillate.wav"); //too much bass
+            //playSoundAsync("../sounds/space-gun.wav"); //too loud
+            playSoundAsync("../sounds/portal3_in-out.wav");
+            //playSoundAsync("../sounds/portal4_ramp.wav");
             return;
         }
     }
@@ -92,8 +108,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;
@@ -105,6 +119,8 @@ void runGameCycle()
     //--- handle food ---
     if (checkEaten()) {
         LOGI("game: picked up food at x=%d y=%d -> growing, placing food\n", game.foodX, game.foodY);
+        //play eat sound (picks random file from above list)
+        playSound(eatSounds[rand() % EAT_SOUNDS_COUNT], false);
         // NOTE: order of place and grow is relevant, otherwise function in food.c will access invalid memory
         placeFood(); 
         snakeGrow();
@@ -112,6 +128,8 @@ void runGameCycle()
 
     //--- update frame ---
     renderGame();
+#ifdef RENDER_GAME_TO_CONSOLE
     printMap(game.map); //render game to console
+#endif
     return;
 }

src/menu.c

@@ -1,23 +1,39 @@
 #include "menu.h"
 #include "game.h"
+#include "sound.h"
+#include "common.h"
+#include <stdio.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;
     return;
 }
 
 void showPauseScreen(){
+    LOGI("menu: showing leaderboard\n");
     game.gameState = PAUSED;
     return;
 }
 
 void showSettings(){
+    LOGI("menu: showing settings\n");
     return;
 }
 

src/snake.c

@@ -63,6 +63,34 @@ void snakeMove()
 
 void snakeSetDir(snakeDirection_t dir)
 {   
+    // check, if snake should be move in opposite direction -> new direction stays old direction
+    switch(dir)
+    {
+        case DOWN:
+            if(game.snake.direction == UP)
+                return;
+            else    
+                break;
+
+        case UP:
+            if(game.snake.direction == DOWN)
+                return;
+            else    
+                break;
+
+        case LEFT:
+            if(game.snake.direction == RIGHT)
+                return;
+            else    
+                break;
+
+        case RIGHT:
+            if(game.snake.direction == LEFT)
+                return;
+            else    
+                break;
+
+    }
     game.snake.direction = dir;
     return;
 }

src/sound.c

@@ -0,0 +1,141 @@
+#include <stdint.h>
+#include <pthread.h>
+#include "SDL.h"
+
+#include "common.h"
+#include "sound.h"
+
+
+//--- global variables in sound.c ---
+// mutex to prevent segfaults while working with multiple threads
+pthread_mutex_t mutexSoundPlaying;
+// initialize audio only once
+static bool audioIsInitialized = false;
+
+
+
+//---------------------------
+//-------- initAudio --------
+//---------------------------
+// initialize SDL audio and mutex if not done already
+int initAudio()
+{
+    if (!audioIsInitialized)
+    {
+        //--- initialize mutex ---
+        pthread_mutex_init(&mutexSoundPlaying, NULL);
+        //--- initialize SDL audio ---
+        if (SDL_Init(SDL_INIT_AUDIO) < 0)
+        {
+            printf("SDL: could not init audio!\n");
+            return 1;
+        }
+        audioIsInitialized = true;
+        LOGI("sound: initialized SDL audio\n");
+    }
+    return 0;
+}
+
+
+//===========================
+//======== 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)
+{
+    //--- variables ---
+    static bool deviceExists = false;
+    static uint8_t *wavBuffer;
+    static SDL_AudioDeviceID deviceId;
+    SDL_AudioSpec wavSpec;
+    uint32_t wavLength;
+
+    //--- initialize audio --- 
+    // initializes if not done already, exit if failed
+    if (initAudio()) return 1;
+
+    //--- run async when wait is not set ---
+    if (!wait){
+        return playSoundAsync(filePath);
+    }
+
+    //=== lock mutex ===
+    pthread_mutex_lock(&mutexSoundPlaying);
+
+    //--- 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: playing file '%s'\n", filePath);
+
+    //--- wait until playback is finished ---
+    while (SDL_GetQueuedAudioSize(deviceId) > 0)
+    {
+        SDL_Delay(100);
+    }
+
+    //--- close device and free memory ---
+    SDL_CloseAudioDevice(deviceId);
+    SDL_FreeWAV(wavBuffer);
+
+    //=== unlock mutex ===
+    pthread_mutex_unlock(&mutexSoundPlaying);
+
+    return 0;
+}
+
+
+
+
+//-------------------------------
+//------- playSoundThread -------
+//-------------------------------
+// thread that runs playSound() and exits when done
+void *playSoundThread(void *filePath) {
+    // run (slow) playSound function
+    playSound((const char *)filePath, true);
+    // Clean up and exit the thread
+    free(filePath);
+    pthread_exit(NULL);
+}
+
+
+//==========================
+//===== playSoundAsync =====
+//==========================
+// play audio file asynchronously
+// creates separate thread which runs playSound 
+// -> program does not get blocked by up to 300ms for loading the file
+int playSoundAsync(const char *filePath) {
+    //--- initialize audio --- 
+    // initializes if not done already, exit if failed
+    if (initAudio()) return 1;
+
+    //--- allocate memory for filePath ---
+    char *filePathCopy = strdup(filePath);
+    if (filePathCopy == NULL) {
+        fprintf(stderr, "Memory allocation failed\n");
+        return 1;
+    }
+
+    //--- create new thread ---
+    pthread_t thread;
+    if (pthread_create(&thread, NULL, playSoundThread, filePathCopy) != 0) {
+        fprintf(stderr, "Failed to create thread\n");
+        free(filePathCopy);
+        return 1;
+    } else {
+        // detach the thread to clean up automatically when it exits
+        pthread_detach(thread);
+        return 0;
+    }
+}