provide an info popup when opening sounds folder

.gitignore

@@ -6,3 +6,7 @@
 /sounds/*.wav
 /sounds.zip
 /lull.zip
+/dist/
+/package/
+/*.kra
+/*.png

Cargo.toml

@@ -1,17 +1,18 @@
 [package]
 name = "lull"
-description = "a looping sound player for generating aural atmospheres"
-version = "1.0.0"
+description = "a looping sound player for generating atmospheric soundscapes"
+version = "1.0.4"
 authors = ["Max Bradbury <max@tinybird.info>"]
+repository = "https://tinybird.dev/max/lull"
 license = "MIT"
 edition = "2018"
-crate_type = "bin"
 
 [dependencies]
-clipboard = "^0.5.0"
 dirs = "^3.0.1"
-glium = "^0.27.0"
-imgui = "^0.5.0"
-imgui-glium-renderer = "^0.5.0"
-imgui-winit-support = "^0.5.0"
+gdk = "^0.14.3"
+gio = "^0.14.8"
+gtk = "^0.14.3"
 rodio = "^0.11.0"
+serde = "^1.0.125"
+serde_derive = "^1.0.125"
+toml = "^0.5.8"

README.md

@@ -8,20 +8,3 @@ add your own favourite noises and blend them to create your ideal ambience.
 created by [Max Bradbury](mailto:max@tinybird.info).
 
 released under the MIT license.
-
-## to do
-
-* save volume preferences to disk
-* cross-compile to Windows?
-* watch data dir for new sounds?
-* disown file manager subcommand
-* get some good nature sounds
-    * rain on tin roof
-    * wind
-    * tape hiss
-    * vinyl crackle
-    * white noise?
-    * fan
-    * birdsong
-* set a window icon
-    * create a nice icon?

SOUNDS.md

@@ -17,3 +17,7 @@ you can skip/remove any unwanted sounds, and add your own.
 *campfire* by [sagetyrtle](https://freesound.org/people/sagetyrtle/)
 
 *rain on glass* by [Benboncan](https://freesound.org/people/Benboncan/)
+
+*birdsong* by [reinsamba](https://freesound.org/people/reinsamba/)
+
+*fireplace* by [aunrea](https://freesound.org/people/aunrea/)

TODO.md

@@ -0,0 +1,17 @@
+# to do
+
+* save volume preferences to disk
+* cross-compile to Windows?
+* watch data dir for new sounds?
+* disown file manager subcommand
+* get some good nature sounds
+    * wind
+    * tape hiss
+    * vinyl crackle
+    * white noise?
+    * fan
+    * cat purr
+    * café
+    * rustling leaves
+* set a window icon
+    * create a nice icon?

build.sh

@@ -1,9 +1,16 @@
 #!/usr/bin/env bash
 
-cargo build --release
-cp target/release/lull .
-strip lull
-zip -r lull.zip README.md lull
-rm lull
+mkdir dist
 
-zip -r sounds.zip SOUNDS.md sounds/*.mp3
+cargo build --release
+
+mkdir dist/linux
+
+cp target/release/lull dist/linux
+cp README.md dist/linux
+cp LICENSE dist/linux
+strip dist/linux/lull
+
+mkdir dist/sounds
+
+cp sounds/*.mp3 SOUNDS.md dist/sounds

deploy.sh

@@ -1,4 +1,8 @@
 #!/usr/bin/env bash
 
-butler push lull.zip ruin/lull:linux
-butler push sounds.zip ruin/lull:sounds
+rm -rf dist/windows
+mv package dist/windows
+
+butler push dist/linux ruin/lull:linux
+butler push dist/windows ruin/lull:windows
+butler push dist/sounds ruin/lull:sounds

src/config.rs

@@ -0,0 +1,59 @@
+use std::fs::File;
+use std::io::{Write, Read};
+
+use serde_derive::{Serialize, Deserialize};
+
+#[derive(Debug, Eq, PartialEq, Serialize, Deserialize)]
+pub(crate) struct Config {
+    pub(crate) position: (i32, i32),
+    pub(crate) size:     (i32, i32),
+}
+
+pub(crate) fn save_config(config: Config) {
+    let mut config_path = dirs::config_dir()
+        .expect("Couldn't find user config directory");
+
+    config_path.push("ruin");
+    config_path.push("lull");
+
+    if !config_path.exists() {
+        std::fs::create_dir_all(&config_path)
+            .expect("Couldn't create lull config directory");
+    }
+
+    let toml = toml::to_string(&config)
+        .expect("Couldn't convert config to toml");
+
+    config_path.push("lull.toml");
+
+    let mut config_file = File::create(config_path)
+        .expect("Couldn't create config file");
+
+    config_file.write(&toml.into_bytes())
+        .expect("Couldn't write config file");
+}
+
+pub(crate) fn load_config() -> Option<Config> {
+    let mut config_path = dirs::config_dir()
+        .expect("Couldn't find user config directory");
+
+    config_path.push("ruin");
+    config_path.push("lull");
+    config_path.push("lull.toml");
+
+    let file = File::open(config_path);
+
+    if file.is_err() {
+        return None;
+    }
+
+    let mut toml = String::new();
+
+    file.unwrap().read_to_string(&mut toml)
+        .expect("Couldn't read config file");
+
+    let config = toml::from_str(&toml)
+        .expect("Couldn't parse config");
+
+    Some(config)
+}

src/main.rs

@@ -1,167 +1,35 @@
 #![windows_subsystem = "windows"]
 
-use rodio::{Sink, Source};
-use std::env::args;
-use std::fs::File;
-use std::io::BufReader;
+mod config;
+mod ui_gtk;
+
 use std::path::PathBuf;
-use std::process::Command;
-use imgui::*;
 
-mod support;
+#[cfg(target_os = "windows")]
+fn file_manager() -> &'static str {
+    "explorer"
+}
 
-const SPACING: i32 = 16;
-//
-// fn error_popup(message: &str) {
-//     let popup = gtk::Window::new(gtk::WindowType::Toplevel);
-//     popup.set_title("error");
-//     popup.set_border_width(SPACING as u32);
-//     popup.set_position(gtk::WindowPosition::Center);
-//     popup.set_default_size(256, 64);
-//
-//     let vertical = gtk::Box::new(Orientation::Vertical, SPACING);
-//     popup.add(&vertical);
-//
-//     let message = gtk::Label::new(Some(message));
-//     vertical.add(&message);
-//
-//     let button_ok = gtk::Button::with_label("OK");
-//     vertical.add(&button_ok);
-//
-//     popup.show_all();
-//
-//     button_ok.connect_clicked(move |_| unsafe {
-//         popup.destroy();
-//     });
-// }
+#[cfg(not(target_os = "windows"))]
+fn file_manager() -> &'static str {
+    "xdg-open"
+}
 
-fn get_data_dir() -> PathBuf {
+fn get_sounds_dir() -> PathBuf {
     let mut data_dir = dirs::data_dir().expect("Couldn't find user data directory");
 
-    data_dir.push("ruin/lull");
+    data_dir.push("ruin");
+    data_dir.push("lull");
 
     if !data_dir.exists() {
-        std::fs::create_dir_all(&data_dir).expect("Couldn't create lull data directory");
+        std::fs::create_dir_all(&data_dir)
+            .expect("Couldn't create lull sounds directory");
     }
 
     data_dir
 }
-//
-// fn build_ui(application: &gtk::Application) {
-//     let window = gtk::ApplicationWindow::new(application);
-//
-//     window.set_title("lull");
-//     window.set_border_width(SPACING as u32);
-//     window.set_position(gtk::WindowPosition::Center);
-//     window.set_default_size(256, 256);
-//
-//     let vertical = gtk::Box::new(Orientation::Vertical, SPACING);
-//     vertical.set_homogeneous(true);
-//
-//     window.add(&vertical);
-//
-//     let device = rodio::default_output_device().unwrap();
-//
-//     let paths = std::fs::read_dir(get_data_dir())
-//         .expect("Couldn't read from lull data directory");
-//
-//     for path in paths {
-//         let path = path.unwrap().path();
-//         let name: &str = path.file_stem().unwrap().to_str().unwrap();
-//
-//         let file = File::open(&path)
-//             .expect("Couldn't open audio file");
-//
-//         let source = rodio::Decoder::new(
-//             BufReader::new(file)
-//         );
-//
-//         if source.is_err() {
-//             error_popup(&format!(
-//                 "Couldn't parse file {}. \n{}.",
-//                 path.to_str().unwrap(),
-//                 source.err().unwrap()
-//             ));
-//             continue;
-//         }
-//
-//         let source = source.unwrap().repeat_infinite();
-//
-//         let sink = Sink::new(&device);
-//         sink.append(source);
-//         sink.pause();
-//
-//         let row = gtk::Box::new(Orientation::Horizontal, SPACING);
-//         row.set_homogeneous(true);
-//
-//         let label = gtk::Label::new(Some(name));
-//         row.add(&label);
-//
-//         let adjustment = gtk::Adjustment::new(
-//             0.0,
-//             0.0,
-//             1.0,
-//             0.0,
-//             0.0,
-//             0.0
-//         );
-//
-//         let slider = gtk::Scale::new(
-//             Orientation::Horizontal,
-//             Some(&adjustment)
-//         );
-//
-//         slider.set_draw_value(false);
-//
-//         slider.connect_value_changed(move |scale| {
-//             let volume = scale.get_value();
-//
-//             if volume == 0. {
-//                 sink.pause();
-//             } else {
-//                 sink.play();
-//                 sink.set_volume(volume as f32);
-//             }
-//         });
-//
-//         row.add(&slider);
-//
-//         vertical.add(&row);
-//     }
-//
-//     let row_add = gtk::Box::new(Orientation::Horizontal, SPACING);
-//     row_add.set_homogeneous(true);
-//
-//     let button_manage_sounds = gtk::Button::with_label("manage sounds");
-//
-//     button_manage_sounds.connect_clicked(|_| {
-//         let mut file_manager = Command::new("xdg-open");
-//         file_manager.arg(get_data_dir());
-//         file_manager.output().unwrap();
-//     });
-//
-//     row_add.add(&button_manage_sounds);
-//     vertical.add(&row_add);
-//
-//     window.show_all();
-// }
 
+//#[cfg(not(target_os = "windows"))]
 fn main() {
-    let system = support::init(file!());
-
-    system.main_loop(move |_, ui| {
-        Window::new(im_str!("Hello world"))
-            .size([300.0, 100.0], Condition::FirstUseEver)
-            .build(&ui, || {
-                ui.text(im_str!("Hello world!"));
-                ui.text(im_str!("こんにちは世界！"));
-                ui.text(im_str!("This...is...imgui-rs!"));
-                ui.separator();
-                let mouse_pos = ui.io().mouse_pos;
-                ui.text(format!(
-                    "Mouse Position: ({:.1},{:.1})",
-                    mouse_pos[0], mouse_pos[1]
-                ));
-            });
-    });
+    ui_gtk::instantiate();
 }

src/support/clipboard.rs

@@ -1,19 +0,0 @@
-use clipboard::{ClipboardContext, ClipboardProvider};
-use imgui::{ClipboardBackend, ImStr, ImString};
-
-pub struct ClipboardSupport(ClipboardContext);
-
-pub fn init() -> Option<ClipboardSupport> {
-    ClipboardContext::new()
-        .ok()
-        .map(|ctx| ClipboardSupport(ctx))
-}
-
-impl ClipboardBackend for ClipboardSupport {
-    fn get(&mut self) -> Option<ImString> {
-        self.0.get_contents().ok().map(|text| text.into())
-    }
-    fn set(&mut self, text: &ImStr) {
-        let _ = self.0.set_contents(text.to_str().to_owned());
-    }
-}

src/support/mod.rs

@@ -1,140 +0,0 @@
-use glium::glutin;
-use glium::glutin::event::{Event, WindowEvent};
-use glium::glutin::event_loop::{ControlFlow, EventLoop};
-use glium::glutin::window::WindowBuilder;
-use glium::{Display, Surface};
-use imgui::{Context, FontConfig, FontGlyphRanges, FontSource, Ui};
-use imgui_glium_renderer::Renderer;
-use imgui_winit_support::{HiDpiMode, WinitPlatform};
-use std::time::Instant;
-
-mod clipboard;
-
-pub struct System {
-    pub event_loop: EventLoop<()>,
-    pub display: glium::Display,
-    pub imgui: Context,
-    pub platform: WinitPlatform,
-    pub renderer: Renderer,
-    pub font_size: f32,
-}
-
-pub fn init(title: &str) -> System {
-    let title = match title.rfind('/') {
-        Some(idx) => title.split_at(idx + 1).1,
-        None => title,
-    };
-    let event_loop = EventLoop::new();
-    let context = glutin::ContextBuilder::new().with_vsync(true);
-    let builder = WindowBuilder::new()
-        .with_title(title.to_owned())
-        .with_inner_size(glutin::dpi::LogicalSize::new(1024f64, 768f64));
-    let display =
-        Display::new(builder, context, &event_loop).expect("Failed to initialize display");
-
-    let mut imgui = Context::create();
-    imgui.set_ini_filename(None);
-
-    if let Some(backend) = clipboard::init() {
-        imgui.set_clipboard_backend(Box::new(backend));
-    } else {
-        eprintln!("Failed to initialize clipboard");
-    }
-
-    let mut platform = WinitPlatform::init(&mut imgui);
-    {
-        let gl_window = display.gl_window();
-        let window = gl_window.window();
-        platform.attach_window(imgui.io_mut(), &window, HiDpiMode::Rounded);
-    }
-
-    let hidpi_factor = platform.hidpi_factor();
-    let font_size = (13.0 * hidpi_factor) as f32;
-    imgui.fonts().add_font(&[
-        FontSource::DefaultFontData {
-            config: Some(FontConfig {
-                size_pixels: font_size,
-                ..FontConfig::default()
-            }),
-        },
-        FontSource::TtfData {
-            data: include_bytes!("helsinki.ttf"),
-            size_pixels: font_size,
-            config: Some(FontConfig {
-                rasterizer_multiply: 1.75,
-                glyph_ranges: FontGlyphRanges::japanese(),
-                ..FontConfig::default()
-            }),
-        },
-    ]);
-
-    imgui.io_mut().font_global_scale = (1.0 / hidpi_factor) as f32;
-
-    let renderer = Renderer::init(&mut imgui, &display)
-        .expect("Failed to initialize renderer");
-
-    System {
-        event_loop,
-        display,
-        imgui,
-        platform,
-        renderer,
-        font_size,
-    }
-}
-
-impl System {
-    pub fn main_loop<F: FnMut(&mut bool, &mut Ui) + 'static>(self, mut run_ui: F) {
-        let System {
-            event_loop,
-            display,
-            mut imgui,
-            mut platform,
-            mut renderer,
-            ..
-        } = self;
-        let mut last_frame = Instant::now();
-
-        event_loop.run(move |event, _, control_flow| match event {
-            Event::NewEvents(_) => {
-                let now = Instant::now();
-                imgui.io_mut().update_delta_time(now - last_frame);
-                last_frame = now;
-            }
-            Event::MainEventsCleared => {
-                let gl_window = display.gl_window();
-                platform
-                    .prepare_frame(imgui.io_mut(), &gl_window.window())
-                    .expect("Failed to prepare frame");
-                gl_window.window().request_redraw();
-            }
-            Event::RedrawRequested(_) => {
-                let mut ui = imgui.frame();
-
-                let mut run = true;
-                run_ui(&mut run, &mut ui);
-                if !run {
-                    *control_flow = ControlFlow::Exit;
-                }
-
-                let gl_window = display.gl_window();
-                let mut target = display.draw();
-                target.clear_color_srgb(1.0, 1.0, 1.0, 1.0);
-                platform.prepare_render(&ui, gl_window.window());
-                let draw_data = ui.render();
-                renderer
-                    .render(&mut target, draw_data)
-                    .expect("Rendering failed");
-                target.finish().expect("Failed to swap buffers");
-            }
-            Event::WindowEvent {
-                event: WindowEvent::CloseRequested,
-                ..
-            } => *control_flow = ControlFlow::Exit,
-            event => {
-                let gl_window = display.gl_window();
-                platform.handle_event(imgui.io_mut(), gl_window.window(), &event);
-            }
-        })
-    }
-}

src/ui_gtk.rs

@@ -0,0 +1,180 @@
+use std::fs::File;
+use std::io::{BufReader};
+use std::process::Command;
+
+use gio::prelude::*;
+use gtk::prelude::*;
+use gtk::Orientation;
+use rodio::{Sink, Source};
+
+const SPACING: i32 = 16;
+
+fn popup(title: &str, message: &str) -> gtk::Window {
+    let popup = gtk::Window::new(gtk::WindowType::Toplevel);
+    popup.set_title(title);
+    popup.set_border_width(SPACING as u32);
+    popup.set_position(gtk::WindowPosition::Center);
+    popup.set_default_size(256, 64);
+    popup.set_type_hint(gdk::WindowTypeHint::Dialog);
+    popup.set_resizable(false);
+
+    let message = gtk::Label::new(Some(message));
+    popup.add(&message);
+
+    popup
+}
+
+fn build_ui(application: &gtk::Application) {
+    let window = gtk::ApplicationWindow::new(application);
+
+    window.set_title("lull");
+    window.set_border_width(SPACING as u32);
+    window.set_position(gtk::WindowPosition::Center);
+    window.set_default_size(256, 128);
+
+    if let Some(config) = crate::config::load_config() {
+        window.move_(config.position.0, config.position.1);
+        window.resize(config.size.0, config.size.1);
+    }
+
+    let button_manage_sounds = gtk::Button::with_label("open sounds folder");
+
+    button_manage_sounds.connect_clicked(|_| {
+        popup(
+            "info",
+            concat!(
+                "after changing the sounds in this folder, ",
+                "you will need to restart lull to see your changes."
+            )
+        );
+
+        let mut file_manager = Command::new(crate::file_manager());
+        file_manager.arg(crate::get_sounds_dir());
+        file_manager.output().unwrap();
+    });
+
+    let sounds_manage  = gtk::Box::new(Orientation::Vertical,   SPACING);
+    let columns        = gtk::Box::new(Orientation::Horizontal, SPACING);
+    let column_labels  = gtk::Box::new(Orientation::Vertical,   SPACING);
+    let column_sliders = gtk::Box::new(Orientation::Vertical,   SPACING);
+
+    columns.set_homogeneous(false);
+    column_labels.set_homogeneous(true);
+    column_sliders.set_homogeneous(true);
+    column_labels.set_expand(false);
+    column_sliders.set_expand(true);
+    column_sliders.set_width_request(128);
+
+    window.add(&sounds_manage);
+    sounds_manage.add(&columns);
+    sounds_manage.add(&button_manage_sounds);
+    columns.add(&column_labels);
+    columns.add(&column_sliders);
+
+    let device = rodio::default_output_device().unwrap();
+
+    let mut paths = std::fs::read_dir(crate::get_sounds_dir())
+        .expect("Couldn't read lull sounds directory")
+        .map(|res| res.map(|e| e.path()))
+        .collect::<Result<Vec<_>, std::io::Error>>()
+        .expect("Couldn't read files from lull sounds directory");
+
+    paths.sort();
+
+    for path in paths {
+        let name      = path.file_stem().unwrap().to_str().unwrap();
+        let extension = path.extension().unwrap().to_str().unwrap();
+
+        // on Windows the data dir and config dir are the same,
+        // so avoid parsing the config file as an audio file
+        if extension == "toml" {
+            continue;
+        }
+
+        let file = File::open(&path)
+            .expect("Couldn't open audio file");
+
+        let source = rodio::Decoder::new(
+            BufReader::new(file)
+        );
+
+        if source.is_err() {
+            popup("error", &format!(
+                "Couldn't parse file {}. \n{}.",
+                path.to_str().unwrap(),
+                source.err().unwrap()
+            )).show_all();
+
+            continue;
+        }
+
+        let source = source.unwrap().repeat_infinite();
+
+        let sink = Sink::new(&device);
+        sink.append(source);
+        sink.pause();
+
+        let label = gtk::Label::new(Some(name));
+        label.set_halign(gtk::Align::End);
+        column_labels.add(&label);
+
+        let adjustment = gtk::Adjustment::new(
+            0.0,
+            0.0,
+            1.0,
+            0.0,
+            0.0,
+            0.0
+        );
+
+        let slider = gtk::Scale::new(
+            Orientation::Horizontal,
+            Some(&adjustment)
+        );
+
+        slider.set_draw_value(false);
+
+        slider.connect_value_changed(move |scale| {
+            let volume = scale.value();
+
+            if volume == 0. {
+                sink.pause();
+            } else {
+                sink.play();
+                sink.set_volume(volume as f32);
+            }
+        });
+
+        column_sliders.add(&slider);
+    }
+
+    window.show_all();
+
+    window.connect_delete_event(|window, _event| {
+        crate::config::save_config(crate::config::Config {
+            position: window.position(),
+            size:     window.size()
+        });
+
+        Inhibit(false)
+    });
+}
+
+pub(crate) fn instantiate() {
+    #[cfg(target_os = "windows")] {
+        // instantiate rodio before gtk and don't do anything with it
+        // this is silly but it's the easiest way to prevent cpal crashing on windows
+        rodio::default_output_device().unwrap();
+    }
+
+    let application = gtk::Application::new(
+        Some("dev.tinybird.max.lull"),
+        Default::default()
+    );
+
+    application.connect_activate(|app| {
+        build_ui(app);
+    });
+
+    application.run();
+}

windows.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+export PKG_CONFIG_ALLOW_CROSS=1
+export PKG_CONFIG_PATH=/usr/i686-w64-mingw32/lib/pkgconfig
+rm -rf package
+docker start lull-build-3 -ai | less
+
+# gtk icons to keep:
+# Adwaita/16x16/ui/window-*
+# Adwaita/24x24/ui/window-*
+# Adwaita/48x48/ui/window-*
+# Adwaita/64x64/ui/window-*
+# Adwaita/96x96/ui/window-*
+# Adwaita/scalable/ui/window-*
+# Adwaita/cursors
+# (are all of these sizes necessary?)