Prototype of providing feedback using sounds

installer/mac/build.sh

@@ -12,6 +12,8 @@ cp ../../../../build/reaper_osara.dylib .
 cp ../../../../config/mac/reaper-kb.ini OSARA.ReaperKeyMap
 mkdir locale
 cp ../../../../locale/*.po locale/
+mkdir sounds
+cp ../../../../sounds/*.mp3 sounds/
 cd ../..
 rm -f $dmg
 # We seem to need a delay here to avoid an "hdiutil: create failed - Resource busy" error.

installer/mac/content/Install OSARA.command

@@ -48,6 +48,8 @@ function run(argv) {
 	s(`cp '${source}/OSARA.ReaperKeyMap' '${target}/KeyMaps/'`);
 	s(`mkdir -p '${target}/osara/locale'`);
 	s(`cp '${source}/locale/'* '${target}/osara/locale/'`);
+	s(`mkdir -p '${target}/osara/sounds'`);
+	s(`cp '${source}/sounds/'* '${target}/osara/sounds/'`);
 	var res = app.displayDialog(
 		"Do you want to replace the existing keymap with the Osara keymap?", {
 		buttons: ["Yes", "No"],

installer/osara.nsi

@@ -93,6 +93,9 @@ Section "OSARA plug-in" SecPlugin
 	CreateDirectory "$INSTDIR\osara\locale"
 	SetOutPath "$INSTDIR\osara\locale"
 	File "..\locale\*.po"
+	CreateDirectory "$INSTDIR\osara\sounds"
+	SetOutPath "$INSTDIR\osara\sounds"
+	File "..\sounds\*.mp3"
 	${Unless} $portable = ${BST_CHECKED}
 		WriteUninstaller "$INSTDIR\osara\uninstall.exe"
 		WriteRegStr HKCU "Software\Microsoft\Windows\CurrentVersion\Uninstall\OSARA" "DisplayName" "OSARA"

src/archBuild_sconscript

@@ -32,6 +32,7 @@ sources = [
 	"midiEditorCommands.cpp",
 	"envelopeCommands.cpp",
 	"controlSurface.cpp",
+	"coreUtils.cpp",
 	"exports.cpp",
 	"fxChain.cpp",
 	"translation.cpp",

src/coreUtils.cpp

@@ -0,0 +1,116 @@
+/*
+ * OSARA: Open Source Accessibility for the REAPER Application
+ * Core utilities code
+ * Copyright 2024 James Teh
+ * License: GNU General Public License version 2.0
+ */
+
+#include "coreUtils.h"
+
+#include <string>
+
+#include "osara.h"
+#include "config.h"
+
+using namespace std;
+
+namespace {
+preview_register_t soundPreviewReg = {0};
+double lastSoundCursorPos = 0.0;
+
+bool isMarkerOrRegionBetween(double start, double end) {
+	int count = CountProjectMarkers(nullptr, nullptr, nullptr);
+	for (int i = 0; i < count; ++i) {
+		double markerPos, regionEnd;
+		bool isRegion;
+		EnumProjectMarkers(i, &isRegion, &markerPos, &regionEnd, nullptr, nullptr);
+		if (markerPos > end) {
+			break;
+		}
+		if ((start <= markerPos && markerPos <= end) ||
+				(isRegion && start <= regionEnd && regionEnd <= end)) {
+			return true;
+		}
+	}
+	return false;
+}
+
+bool isPassingItemEdge(double start, double end) {
+	if (end - start > 0.020) {
+		// The cursor jumped more than 20 ms. We only want to report when passing
+		// close to an item edge.
+		return false;
+	}
+	MediaTrack* track = GetLastTouchedTrack();
+	if (!track) {
+		return false;
+	}
+	int count = CountTrackMediaItems(track);
+	for (int i = 0; i < count; ++i) {
+		MediaItem* item = GetTrackMediaItem(track, i);
+		double itemStart = *(double*)GetSetMediaItemInfo(item, "D_POSITION", nullptr);
+		if (itemStart > end) {
+			break;
+		}
+		double length = *(double*)GetSetMediaItemInfo(item, "D_LENGTH", nullptr);
+		double itemEnd = itemStart + length;
+		if ((start <= itemStart && itemStart <= end) ||
+				(start <= itemEnd && itemEnd <= end)) {
+			return true;
+		}
+	}
+	return false;
+}
+
+} // namespace
+
+void playSound(const char* fileName) {
+	if (!settings::playSounds) {
+		return;
+	}
+	if (soundPreviewReg.src) {
+		StopPreview(&soundPreviewReg);
+		PCM_Source_Destroy(soundPreviewReg.src);
+	} else {
+		// Initialise preview.
+#ifdef _WIN32
+		InitializeCriticalSection(&soundPreviewReg.cs);
+#else
+		pthread_mutex_init(&soundPreviewReg.mutex, nullptr);
+#endif
+		soundPreviewReg.volume = 1.0;
+	}
+	string path(GetResourcePath());
+	path += "/osara/sounds/";
+	path += fileName;
+	soundPreviewReg.src = PCM_Source_CreateFromFile(path.c_str());
+	soundPreviewReg.curpos = 0.0;
+	PlayPreview(&soundPreviewReg);
+}
+
+void playSoundForCursorMovement() {
+	if (!settings::playSounds) {
+		return;
+	}
+	double cursor = GetCursorPosition();
+	if (cursor == lastSoundCursorPos) {
+		return; // No movement, nothing to do.
+	}
+	double start, end;
+	if (cursor > lastSoundCursorPos) {
+		// Moving forward.
+		start = lastSoundCursorPos;
+		end = cursor;
+	} else {
+		// Moving backward.
+		start = cursor;
+		end = lastSoundCursorPos;
+	}
+	if (isMarkerOrRegionBetween(start, end)) {
+		playSound("marker.mp3");
+	}
+	if (isPassingItemEdge(start, end)) {
+		playSound("item.mp3");
+	}
+	lastSoundCursorPos = cursor;
+}

src/coreUtils.h

@@ -0,0 +1,11 @@
+/*
+ * OSARA: Open Source Accessibility for the REAPER Application
+ * Core utilities header
+ * Copyright 2024 James Teh
+ * License: GNU General Public License version 2.0
+ */
+
+#pragma once
+
+void playSound(const char* fileName);
+void playSoundForCursorMovement();

src/osara.h

@@ -8,6 +8,8 @@
 #ifndef _OSARA_H
 #define _OSARA_H
 
+// We need to include sstream first to avoid issues with SWELL.
+#include <sstream>
 #ifdef _WIN32
 # include <windows.h>
 #else
@@ -17,10 +19,9 @@
 # include <windows.h>
 # pragma clang diagnostic pop
 #endif
+#include <string>
 #include <functional>
 #include <memory>
-#include <string>
-#include <sstream>
 
 #define REAPERAPI_MINIMAL
 #define REAPERAPI_WANT_GetLastTouchedTrack
@@ -219,6 +220,10 @@
 #define REAPERAPI_WANT_format_timestr_len
 #define REAPERAPI_WANT_parse_timestr_len
 #define REAPERAPI_WANT_TimeMap_GetTimeSigAtTime
+#define REAPERAPI_WANT_PCM_Source_CreateFromFile
+#define REAPERAPI_WANT_PCM_Source_Destroy
+#define REAPERAPI_WANT_PlayPreview
+#define REAPERAPI_WANT_StopPreview
 
 #include <reaper/reaper_plugin.h>
 #include <reaper/reaper_plugin_functions.h>

src/reaper_osara.cpp

@@ -41,6 +41,7 @@
 #include "fxChain.h"
 #include "translation.h"
 #include "updateCheck.h"
+#include "coreUtils.h"
 
 using namespace std;
 using namespace fmt::literals;
@@ -1180,6 +1181,7 @@ void postCursorMovement(int command) {
 	if (shouldReportTimeMovement()) {
 		outputMessage(formatCursorPosition().c_str());
 	}
+	playSoundForCursorMovement();
 }
 
 void postCursorMovementScrub(int command) {

src/settings.h

@@ -47,3 +47,6 @@ BoolSetting(reportNotes, MIDI_EDITOR_SECTION,
 BoolSetting(reportSurfaceChanges, MAIN_SECTION,
 	"Report changes made via &control surfaces",
 	false)
+BoolSetting(playSounds, MAIN_SECTION,
+	"Provide feedback using s&ounds",
+	false)