Play a sound file as the alarm instead of using the terminal bell and migrate to cmake

Author: W-A-James

.gitignore

@@ -1 +1,4 @@
 build
+*.gen.h
+.cache
+compile_commands.json

CMakeLists.txt

@@ -0,0 +1,55 @@
+cmake_minimum_required(VERSION 3.16)
+
+project(term-timer)
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIGURATION>")
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/$<CONFIGURATION>")
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+find_package(Threads REQUIRED)
+
+add_custom_command(
+  PRE_BUILD
+  OUTPUT src/sound.gen.h
+  COMMAND ${PROJECT_SOURCE_DIR}/scripts/read_wav_to_bytes.py
+  ${PROJECT_SOURCE_DIR}/src/sfx_alarm_loop6.wav ${PROJECT_SOURCE_DIR}/src/sound.gen.h
+  DEPENDS src/sfx_alarm_loop6.wav
+)
+
+add_subdirectory(vendored/CSFML-2.6.1 EXCLUDE_FROM_ALL)
+
+add_executable(term-timer 
+  src/main.c
+  src/common.c
+  src/clock.c
+  src/duration-parser.c
+  src/raw_term.c
+  src/play_sound.c
+  src/sound.gen.h
+)
+
+add_executable(duration-parser.test
+   src/duration-parser.c
+   test/duration-parser.test.c
+   test/common.h
+)
+
+add_executable(clock.test
+  src/clock.c
+  src/common.c
+  src/raw_term.c
+  src/play_sound.c
+  test/clock.test.c
+  test/common.h
+)
+
+target_link_libraries(clock.test PRIVATE
+  m
+  csfml-audio
+)
+
+target_link_libraries(term-timer PRIVATE
+                      Threads::Threads
+                      m
+                      csfml-audio)

Makefile

@@ -0,0 +1,36 @@
+#!/bin/env python3
+
+import sys
+
+in_file = sys.argv[1]
+out_file = sys.argv[2]
+
+print(sys.argv[0], f"Generating {in_file} -> {out_file}")
+
+OUT_FILE_START = f"""// DO NOT EDIT THIS FILE
+// This file has been generated by read_wav_to_bytes.py
+// USING {in_file} as its input
+#include <inttypes.h>\n""" 
+
+DATA_START = "static const uint8_t soundWavData[] = {"
+
+OUT_FILE_END = "};\n"
+
+if in_file is None or out_file is None:
+    print(f"Must invoke as:\n {sys.argv[0]} <in_file> <out_file>")
+    exit(1)
+
+with open(out_file, "w") as out:
+    with open(in_file, "rb") as f:
+        data = f.read()
+        dataLen = len(data)
+        out.write(OUT_FILE_START)
+        out.write(f"#define SOUND_WAVDATA_LEN {dataLen}\n")
+        out.write(DATA_START)
+        for i,b in enumerate(data):
+            if i % 19 == 0:
+                out.write('\n    ')
+            out.write(f"{b:>3}") # print exactly 3 characters with potential whitespace to the left
+            if i != dataLen -1:
+                out.write(', ')
+    out.write(OUT_FILE_END)

scripts/read_wav_to_bytes.py

@@ -3,6 +3,7 @@
 #include "./clock.h"
 #include "./common.h"
 #include "./raw_term.h"
+#include "./play_sound.h"
 
 #include <pthread.h>
 #include <stdio.h>
@@ -35,7 +36,7 @@ void *clock_run(void *durationP) {
   }
 
   if (durationS == 0) { // Timer expired
-    printf("\x07");
+    play_sound();
     set_done();
   }
   return NULL;

src/clock.c

@@ -11,14 +11,14 @@ void die(const char *s) {
   exit(1);
 }
 
-void init_done() {
+void init_done(void) {
   done.done = 0;
 
   pthread_mutex_init(&done.lock, NULL);
   done.done = 0;
 }
 
-void free_done() {
+void free_done(void) {
   pthread_mutex_lock(&done.lock);
   pthread_mutex_unlock(&done.lock);
 

src/common.c

@@ -15,18 +15,18 @@ extern Done_t done;
 /**
  * initialize done struct
  */
-void init_done();
+void init_done(void);
 
 /**
  * frees resources captured by initialized done struct
  */
-void free_done();
+void free_done(void);
 
 /**
  * blocks trying to acquire lock on done struct and returns whether or not the
  * program is ending
  * */
-int is_done();
+int is_done(void);
 
 /**
  * Blocks trying to acquire lock on done struct and marks the program as ending

src/common.h

@@ -2,6 +2,7 @@
 #include "./common.h"
 #include "./duration-parser.h"
 #include "./raw_term.h"
+#include "./play_sound.h"
 
 #include <errno.h>
 #include <pthread.h>
@@ -62,21 +63,25 @@ int main(int argc, char **argv) {
     exit(1);
   }
 
+
   int duration_s = parse_duration(argc - 1, argv + 1);
   if (duration_s < 0)
     handle_parse_error(duration_s, USAGE);
 
   enable_raw_mode();
-  init_done(done);
+  init_done();
   // Start clock thread and input processing thread
   pthread_t clock_thread, input_processing_thread;
 
+  load_sound();
+
   pthread_create(&clock_thread, NULL, clock_run, (void *)&duration_s);
   pthread_create(&input_processing_thread, NULL, process_input, NULL);
 
   pthread_join(clock_thread, NULL);
   pthread_join(input_processing_thread, NULL);
 
-  free_done(done);
+  free_sound();
+  free_done();
   return 0;
 }

src/main.c

@@ -0,0 +1,34 @@
+#include "play_sound.h"
+
+#include <unistd.h>
+
+sfSound *sound;
+
+int load_sound(void) {
+  soundBuffer = sfSoundBuffer_createFromMemory(soundWavData, SOUND_WAVDATA_LEN);
+  if (!soundBuffer) {
+    return -1;
+  }
+  return 0;
+}
+
+int play_sound(void) {
+  sfTime duration = sfSoundBuffer_getDuration(soundBuffer);
+
+  sound = sfSound_create();
+  sfSound_setBuffer(sound, soundBuffer);
+  sfSound_setLoop(sound, sfFalse);
+
+  for (int i = 0; i < 3; i++) {
+    sfSound_play(sound);
+    usleep(duration.microseconds + (duration.microseconds >> 1));
+    sfSound_stop(sound);
+  }
+
+  return 0;
+}
+
+void free_sound(void) {
+  sfSound_destroy(sound);
+  sfSoundBuffer_destroy(soundBuffer);
+}

src/play_sound.c

@@ -0,0 +1,12 @@
+#include <inttypes.h>
+#include "./sound.gen.h"
+#include <SFML/Audio/Sound.h>
+#include <SFML/Audio.h>
+
+int load_sound(void);
+
+int play_sound(void); 
+
+void free_sound(void);
+
+static struct sfSoundBuffer* soundBuffer;