Merge pull request #119 from aryanchoudharypro/main

Wrap wxSound for WAV playback

Author: AllenDang

rust/wxdragon-sys/cpp/CMakeLists.txt

@@ -118,6 +118,7 @@ endif()
 
 # --- wxDragon Library Sources ---
 set(WXDRAGON_SOURCES
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/core/sound.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/core/timer.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/about.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/src/activity_indicator.cpp

rust/wxdragon-sys/cpp/include/core/wxd_sound.h

@@ -0,0 +1,41 @@
+#ifndef WXD_SOUND_H
+#define WXD_SOUND_H
+
+#include "../wxd_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Sound play flags
+typedef enum {
+    WXD_SOUND_SYNC = 0x0000,
+    WXD_SOUND_ASYNC = 0x0001,
+    WXD_SOUND_LOOP = 0x0002
+} wxd_SoundFlags;
+
+// --- Sound Functions ---
+
+WXD_EXPORTED wxd_Sound_t*
+wxd_Sound_Create(const char* fileName, bool isResource);
+
+WXD_EXPORTED void
+wxd_Sound_Destroy(wxd_Sound_t* self);
+
+WXD_EXPORTED bool
+wxd_Sound_IsOk(wxd_Sound_t* self);
+
+WXD_EXPORTED bool
+wxd_Sound_Play(wxd_Sound_t* self, unsigned int flags);
+
+WXD_EXPORTED bool
+wxd_Sound_PlayFile(const char* filename, unsigned int flags);
+
+WXD_EXPORTED void
+wxd_Sound_Stop(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // WXD_SOUND_H

rust/wxdragon-sys/cpp/include/wxd_types.h

@@ -1,6 +1,14 @@
 #ifndef WXD_TYPES_H
 #define WXD_TYPES_H
 
+// Define WXDRAGON_API for export/import
+#define WXDRAGON_API
+
+// Define export macro
+#ifndef WXD_EXPORTED
+#define WXD_EXPORTED WXDRAGON_API
+#endif
+
 // Use standard C types
 #include <stdbool.h>
 #include <stdint.h> // For integer types if needed
@@ -664,6 +672,7 @@ typedef struct wxd_StyledTextCtrl_t wxd_StyledTextCtrl_t;
 
 // AppProgressIndicator type
 typedef struct wxd_AppProgressIndicator_t wxd_AppProgressIndicator_t;
+typedef struct wxd_Sound_t wxd_Sound_t;
 
 // --- Appearance Support (wxWidgets 3.3.0+) ---
 

rust/wxdragon-sys/cpp/include/wxdragon.h

@@ -1,14 +1,6 @@
 #ifndef WXDRAGON_H
 #define WXDRAGON_H
 
-// Define WXDRAGON_API for export/import
-#define WXDRAGON_API
-
-// Define export macro (used by all sub-headers indirectly via wxd_types.h or if they need it themselves)
-#ifndef WXD_EXPORTED
-#define WXD_EXPORTED WXDRAGON_API
-#endif
-
 // Include all fundamental types first
 #include "wxd_types.h"     // Contains all basic C types and opaque struct typedefs
 #include "array_string.h"  // ArrayString helper functions
@@ -127,6 +119,9 @@ extern "C" {
 // IPC (Inter-Process Communication)
 #include "core/wxd_ipc.h"
 
+// Sound support
+#include "core/wxd_sound.h"
+
 // Other categories
 #include "sizers/wxd_sizers.h"
 #include "dialogs/wxd_dialogs.h"

rust/wxdragon-sys/cpp/src/core/sound.cpp

@@ -0,0 +1,46 @@
+#include <wx/sound.h>
+#include "../../include/core/wxd_sound.h"
+#include "../wxd_utils.h"
+
+extern "C" {
+
+wxd_Sound_t*
+wxd_Sound_Create(const char* fileName, bool isResource) {
+    wxSound* sound = new wxSound(wxString::FromUTF8(fileName), isResource);
+    return (wxd_Sound_t*)sound;
+}
+
+void
+wxd_Sound_Destroy(wxd_Sound_t* self) {
+    if (self) {
+        delete (wxSound*)self;
+    }
+}
+
+bool
+wxd_Sound_IsOk(wxd_Sound_t* self) {
+    if (self) {
+        return ((wxSound*)self)->IsOk();
+    }
+    return false;
+}
+
+bool
+wxd_Sound_Play(wxd_Sound_t* self, unsigned int flags) {
+    if (self) {
+        return ((wxSound*)self)->Play(flags);
+    }
+    return false;
+}
+
+bool
+wxd_Sound_PlayFile(const char* filename, unsigned int flags) {
+    return wxSound::Play(wxString::FromUTF8(filename), flags);
+}
+
+void
+wxd_Sound_Stop(void) {
+    wxSound::Stop();
+}
+
+} // extern "C"

rust/wxdragon/src/lib.rs

@@ -30,6 +30,7 @@ pub mod prelude;
 pub mod scrollable;
 pub mod single_instance_checker;
 pub mod sizers;
+pub mod sound;
 pub mod sysopt;
 pub mod timer;
 pub mod translations;

rust/wxdragon/src/prelude.rs

@@ -19,6 +19,7 @@ pub use crate::geometry::{Point, Rect, Size};
 pub use crate::id::{ID_ANY, ID_CANCEL, ID_HIGHEST, ID_NO, ID_OK, ID_YES, Id};
 pub use crate::language::Language;
 pub use crate::sizers::WxSizer;
+pub use crate::sound::{Sound, SoundFlags};
 pub use crate::sysopt::SystemOptions;
 pub use crate::types::Style;
 pub use crate::utils::{ArrayString, BrowserLaunchFlags, bell, launch_default_browser};

rust/wxdragon/src/sound.rs

@@ -0,0 +1,73 @@
+use std::ffi::CString;
+use wxdragon_sys as ffi;
+
+widget_style_enum!(
+    name: SoundFlags,
+    doc: "Flags for playing sounds.",
+    variants: {
+        Sync: ffi::wxd_SoundFlags_WXD_SOUND_SYNC as i64, "Play sound synchronously (waits for sound to finish).",
+        Async: ffi::wxd_SoundFlags_WXD_SOUND_ASYNC as i64, "Play sound asynchronously (doesn't wait).",
+        Loop: ffi::wxd_SoundFlags_WXD_SOUND_LOOP as i64, "Loop the sound until stopped."
+    },
+    default_variant: Async
+);
+
+/// Represents a sound that can be played.
+///
+/// wxSound is typically limited to WAV files.
+pub struct Sound {
+    ptr: *mut ffi::wxd_Sound_t,
+}
+
+impl Sound {
+    /// Creates a new sound from a file.
+    ///
+    /// # Arguments
+    /// * `file_name` - Path to the sound file (usually .wav).
+    /// * `is_resource` - If true, file_name is a resource name (Windows only).
+    pub fn new(file_name: &str, is_resource: bool) -> Self {
+        let c_file = CString::new(file_name).expect("CString::new failed");
+        let ptr = unsafe { ffi::wxd_Sound_Create(c_file.as_ptr(), is_resource) };
+        Self { ptr }
+    }
+
+    /// Returns true if the sound was created successfully.
+    pub fn is_ok(&self) -> bool {
+        if self.ptr.is_null() {
+            return false;
+        }
+        unsafe { ffi::wxd_Sound_IsOk(self.ptr) }
+    }
+
+    /// Plays the sound with given flags.
+    pub fn play(&self, flags: SoundFlags) -> bool {
+        if self.ptr.is_null() {
+            return false;
+        }
+        unsafe { ffi::wxd_Sound_Play(self.ptr, flags.bits() as u32) }
+    }
+
+    /// Plays a sound file directly without creating a Sound object.
+    pub fn play_file(file_name: &str, flags: SoundFlags) -> bool {
+        let c_file = match CString::new(file_name) {
+            Ok(s) => s,
+            Err(_) => return false,
+        };
+        unsafe { ffi::wxd_Sound_PlayFile(c_file.as_ptr(), flags.bits() as u32) }
+    }
+
+    /// Stops any currently playing sound.
+    pub fn stop() {
+        unsafe { ffi::wxd_Sound_Stop() }
+    }
+}
+
+impl Drop for Sound {
+    fn drop(&mut self) {
+        if !self.ptr.is_null() {
+            unsafe { ffi::wxd_Sound_Destroy(self.ptr) };
+        }
+    }
+}
+
+unsafe impl Send for Sound {}