[CR] Add audio support for curses mode (#78880)

* works! sound should be functional within ncurses without TILES=1

* style changes

* updated CMake and cleaned up Makefile to support new feature

* updated docs to reflect new feature

---------

Co-authored-by: Jodi McJodson <[email protected]>

CMakeLists.txt

@@ -366,14 +366,6 @@ if (CURSES)
 endif ()
 
 if (SOUND)
-    # You need TILES to be able to use SOUND
-    if (NOT TILES)
-        message(FATAL_ERROR
-                "You must enable graphical support with -DTILES=1 \
-                 to be able to enable sound support. \
-                 See doc/COMPILING/COMPILING-CMAKE.md for details and more info.")
-    endif ()
-
     # Sound requires SDL_mixer library
     message(STATUS "Searching for SDL2_mixer library --")
     find_package(SDL2_mixer)

Makefile

@@ -835,9 +835,6 @@ else
 endif # TILES
 
 ifeq ($(SOUND), 1)
-  ifneq ($(TILES),1)
-    $(error "SOUND=1 only works with TILES=1")
-  endif
   ifeq ($(NATIVE),osx)
     ifndef FRAMEWORK # libsdl build
       ifeq ($(MACPORTS), 1)
@@ -1271,7 +1268,6 @@ ifdef LANGUAGES
 	mkdir -p $(APPRESOURCESDIR)/lang/mo/
 	cp -pR lang/mo/* $(APPRESOURCESDIR)/lang/mo/
 endif
-ifeq ($(TILES), 1)
 ifeq ($(SOUND), 1)
 	cp -R data/sound $(APPDATADIR)
 endif  # ifeq ($(SOUND), 1)
@@ -1284,7 +1280,6 @@ ifeq ($(SOUND), 1)
 	cp -R $(FRAMEWORKSDIR)/SDL2_mixer.framework $(APPRESOURCESDIR)/
 endif  # ifeq ($(SOUND), 1)
 endif  # ifdef FRAMEWORK
-endif  # ifdef TILES
 	dylibbundler -of -b -x $(APPRESOURCESDIR)/$(APPTARGET) -d $(APPRESOURCESDIR)/ -p @executable_path/
 
 dmgdistclean:

doc/COMPILING/COMPILING.md

@@ -79,7 +79,7 @@ Given you're building from source you have a number of choices to make:
   * `RELEASE=1` - without this you'll get a debug build (see note below)
   * `LTO=1` - enables link-time optimization with GCC/Clang
   * `TILES=1` - with this you'll get the tiles version, without it the curses version
-  * `SOUND=1` - if you want sound; this requires `TILES=1`
+  * `SOUND=1` - if you want sound
   * `LOCALIZE=0` - this disables localizations so `gettext` is not needed
   * `CLANG=1` - use Clang instead of GCC
   * `CCACHE=1` - use ccache

src/main.cpp

@@ -75,7 +75,7 @@
 
 class ui_adaptor;
 
-#if defined(TILES)
+#if defined(TILES) || defined(SDL_SOUND)
 #   if defined(_MSC_VER) && defined(USE_VCPKG)
 #      include <SDL2/SDL_version.h>
 #   else
@@ -738,7 +738,7 @@ int main( int argc, const char *argv[] )
     DebugLog( D_INFO, DC_ALL ) << "[main] C locale set to " << setlocale( LC_ALL, nullptr );
     DebugLog( D_INFO, DC_ALL ) << "[main] C++ locale set to " << std::locale().name();
 
-#if defined(TILES)
+#if defined(TILES) || defined(SDL_SOUND)
     SDL_version compiled;
     SDL_VERSION( &compiled );
     DebugLog( D_INFO, DC_ALL ) << "SDL version used during compile is "

src/ncurses_def.cpp

@@ -41,6 +41,10 @@
 #include <langinfo.h>
 #endif
 
+#if defined(SDL_SOUND)
+#include "sdlsound.h"
+#endif
+
 std::unique_ptr<cataimgui::client> imclient;
 
 static void curses_check_result( const int result, const int expected, const char *const /*name*/ )
@@ -361,6 +365,14 @@ void catacurses::init_interface()
     // The below line tries to force the mouse pointer events to be turned on anyway. ImTui misbehaves without them.
     printf( "\033[?1003h\n" );
 #endif
+
+#if defined(SDL_SOUND)
+    initSDLAudioOnly();
+    init_sound();
+    if( sound_init_success ) {
+        load_soundset();
+    }
+#endif
 }
 
 bool catacurses::supports_256_colors()

src/sdl_wrappers.cpp

@@ -1,4 +1,4 @@
-#if defined(TILES)
+#if defined(TILES) || defined(SDL_SOUND)
 
 #include "sdl_wrappers.h"
 
@@ -35,6 +35,8 @@ void throwErrorIf( const bool condition, const char *const message )
     throw std::runtime_error( std::string( message ) + ": " + SDL_GetError() );
 }
 
+#if defined(TILES)
+
 void RenderCopy( const SDL_Renderer_Ptr &renderer, const SDL_Texture_Ptr &texture,
                  const SDL_Rect *srcrect, const SDL_Rect *dstrect )
 {
@@ -191,5 +193,5 @@ SDL_Surface_Ptr CreateRGBSurface( const Uint32 flags, const int width, const int
     throwErrorIf( !surface, "Failed to create surface" );
     return surface;
 }
-
-#endif
+#endif // defined(TILES)
+#endif // defined(TILES) || defined(SDL_SOUND)

src/sdlsound.cpp

@@ -912,4 +912,14 @@ void load_soundset()
     }
 }
 
+// capitalized to mirror cata_tiles::InitSDL()
+void initSDLAudioOnly()
+{
+    const int ret = SDL_Init( SDL_INIT_AUDIO );
+    throwErrorIf( ret != 0, "SDL_Init failed" );
+    if( atexit( SDL_Quit ) ) {
+        debugmsg( "atexit failed to register SDL_Quit" );
+    }
+}
+
 #endif

src/sdlsound.h

@@ -9,6 +9,7 @@
  * Attempt to initialize an audio device.  Returns false if initialization fails.
  */
 bool init_sound();
+void initSDLAudioOnly();
 void shutdown_sound();
 void play_music( const std::string &playlist );
 void stop_music();

src/wincurse.cpp

@@ -30,6 +30,11 @@
 #include "ui_manager.h"
 #include "wcwidth.h"
 
+
+#if defined(SDL_SOUND)
+#include "sdlsound.h"
+#endif
+
 //***********************************
 //Globals                           *
 //***********************************
@@ -654,6 +659,14 @@ void catacurses::init_interface()
     //newwin calls `new WINDOW`, and that will throw, but not return nullptr.
 
     initialized = true;
+
+#if defined(SDL_SOUND)
+    initSDLAudioOnly();
+    init_sound();
+    if( sound_init_success ) {
+        load_soundset();
+    }
+#endif
 }
 
 bool catacurses::supports_256_colors()