restructure into modules, etc.

.gitignore

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

Cargo.toml

@@ -1,14 +1,21 @@
 [package]
 name = "lull"
-description = "a looping sound player for generating aural atmospheres"
+description = "a looping sound player for generating atmospheric soundscapes"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["Max Bradbury <max@tinybird.info>"]
+repository = "https://tinybird.dev/max/lull"
 license = "MIT"
 edition = "2018"
-crate_type = "bin"
 
 [dependencies]
 dirs = "^3.0.1"
-iced = "^0.1.1"
+eframe = "^0.11.0"
+egui = "^0.11.0"
+gdk = "^0.13.2"
+gio = "^0"
+gtk = "^0"
+orbtk = "^0.2.31"
 rodio = "^0.11.0"
-env_logger = "^0.8.1"
+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
+mkdir dist
-cp target/release/lull .
-strip lull
-zip -r lull.zip README.md lull
-rm lull
 
-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,5 @@
 #!/usr/bin/env bash
 
-butler push lull.zip ruin/lull:linux
+butler push dist/linux ruin/lull:linux
-butler push sounds.zip ruin/lull:sounds
+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,198 +1,112 @@
 #![windows_subsystem = "windows"]
 
-use iced::{Settings, Application, Element, executor, Length, Container, Column, Scrollable, Slider};
+mod config;
-use rodio::{Sink, Source};
+mod ui;
-use std::env::args;
+
-use std::fs::File;
-use std::io::BufReader;
 use std::path::PathBuf;
+use std::io::BufReader;
+use std::fs::File;
+
+use rodio::{Sink, Source};
 use std::process::Command;
 
+const SOUNDS_BUTTON_LABEL: &'static str = "open sounds folder";
 const SPACING: i32 = 16;
 
-struct Sound {
+#[cfg(target_os = "windows")]
-    name: String,
+fn file_manager() -> &'static str {
-    path: String, // bytes instead?
+    "explorer"
-    sink: Sink,
-    volume: f32,
 }
 
-/// todo: maybe add a play/pause state or global volume? saved presets?
+#[cfg(not(target_os = "windows"))]
-struct State {
+fn file_manager() -> &'static str {
-    sounds: Vec<Sound>
+    "xdg-open"
 }
 
-enum Lull {
+fn get_sounds_dir() -> PathBuf {
-    Loading,
-    Loaded(State),
-}
-
-impl Application for Lull {
-    type Executor = executor::Default;
-    type Message = Message;
-    type Flags = ();
-
-    fn new(_flags: Self::Flags) -> (Self, Command) {
-        (
-            Lull {sounds: Vec::new()},
-            Command::none(),
-        )
-    }
-
-    fn title(&self) -> String {
-        String::from("lull")
-    }
-
-    fn update(&mut self, message: Self::Message) -> Command {
-        match self {
-            self::Loading => {},
-            self::Loaded => {},
-        }
-
-        Command::none()
-    }
-
-    fn view(&mut self) -> Element<'_, Self::Message> {
-        unimplemented!()
-    }
-}
-
-fn get_data_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");
+
+    // on windows, data dir and config dir are both User\AppData\Roaming
+    #[cfg(target_os = "windows")] {
+        data_dir.push("sounds");
+    }
 
     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
 }
 
-pub fn main() -> iced::Result {
+fn open_file_manager() {
-    env_logger::init();
+    let mut file_manager = Command::new(file_manager());
-
+    file_manager.arg(crate::get_sounds_dir());
-    Lull::run(Settings::default())
+    file_manager.output().unwrap();
 }
 
-// fn error_popup(message: &str) {
+struct Sound {
-//     let popup = gtk::Window::new(gtk::WindowType::Toplevel);
+    name: String,
-//     popup.set_title("error");
+    sink: Sink,
-//     popup.set_border_width(SPACING as u32);
+    volume: f64,
-//     popup.set_position(gtk::WindowPosition::Center);
+}
-//     popup.set_default_size(256, 64);
+
-//
+fn get_sounds(device: &rodio::Device) -> Vec<Sound> {
-//     let vertical = gtk::Box::new(Orientation::Vertical, SPACING);
+    let mut sounds = Vec::new();
-//     popup.add(&vertical);
+
-//
+    let mut paths = std::fs::read_dir(get_sounds_dir())
-//     let message = gtk::Label::new(Some(message));
+        .expect("Couldn't read lull sounds directory")
-//     vertical.add(&message);
+        .map(|res| res.map(|e| e.path()))
-//
+        .collect::<Result<Vec<_>, std::io::Error>>()
-//     let button_ok = gtk::Button::with_label("OK");
+        .expect("Couldn't read files from lull sounds directory");
-//     vertical.add(&button_ok);
+
-//
+    paths.sort();
-//     popup.show_all();
+
-//
+    for path in paths {
-//     button_ok.connect_clicked(move |_| unsafe {
+        let name = path.file_stem().unwrap().to_str().unwrap().into();
-//         popup.destroy();
+
-//     });
+        let file = File::open(&path)
+            .expect("Couldn't open audio file");
+
+        let source = rodio::Decoder::new(
+            BufReader::new(file)
+        );
+
+        #[cfg(not(target_os = "windows"))]
+        if source.is_err() {
+            ui::gtk::error_popup(&format!(
+                "Couldn't parse file {}. \n{}.",
+                path.to_str().unwrap(),
+                source.err().unwrap()
+            ));
+            continue;
+        }
+
+        let source = source.unwrap().repeat_infinite();
+
+        let sink = rodio::Sink::new(&device);
+        sink.append(source);
+        sink.pause();
+
+        sounds.push(Sound { name, sink, volume: 0.0 });
+    }
+
+    sounds
+}
+
+// #[cfg(not(target_os = "windows"))]
+fn main() {
+    crate::ui::gtk::instantiate();
+}
+
+// #[cfg(target_os = "windows")]
+// fn main() {
+//     eframe::run_native(Box::new(lull::ui::egui::State::default()));
 // }
 
-// fn build_ui(application: &gtk::Application) {
+// fn main() {
-//     let window = gtk::ApplicationWindow::new(application);
+//     crate::ui::orbtk::instantiate();
-//
-//     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();
 // }

src/ui/egui.rs

@@ -0,0 +1,79 @@
+use eframe::{egui, epi};
+
+pub(crate) use crate::{Sound, get_sounds, open_file_manager};
+use egui::{Color32, Stroke, Vec2};
+
+const COLOUR_BG: Color32 = Color32::from_rgb(76, 58, 78);
+const COLOUR_FG: Color32 = Color32::from_rgb(156, 143, 109);
+
+pub struct State {
+    device: rodio::Device,
+    sounds: Vec<Sound>,
+}
+
+impl Default for State {
+    fn default() -> Self {
+        let device = rodio::default_output_device().unwrap();
+        let sounds = get_sounds(&device);
+
+        Self { device, sounds }
+    }
+}
+
+impl epi::App for State {
+    fn update(&mut self, ctx: &egui::CtxRef, _frame: &mut epi::Frame<'_>) {
+        let State { device: _device, sounds} = self;
+
+        for sound in sounds.into_iter() {
+            if sound.volume > 0.0 {
+                sound.sink.set_volume(sound.volume as f32);
+                sound.sink.play();
+            } else {
+                sound.sink.pause();
+            }
+        }
+
+        egui::CentralPanel::default().frame(egui::Frame {
+            margin: Vec2 { x: crate::SPACING as f32, y: crate::SPACING as f32 },
+            corner_radius: 0.0,
+            shadow: Default::default(),
+            fill: COLOUR_BG,
+            stroke: Stroke {
+                width: 1.0,
+                color: COLOUR_FG,
+            }
+        }).show(ctx, |ui| {
+            egui::Grid::new("grid")
+                .spacing([crate::SPACING as f32; 2])
+                .show(ui, |ui| {
+                    for sound in sounds {
+                        ui.add(
+                            egui::Label::new(&sound.name).text_color(COLOUR_FG)
+                        );
+
+                        ui.add(
+                            egui::Slider::new(
+                                &mut sound.volume,
+                                0.0..=1.0
+                            ).show_value(false)
+                        );
+
+                        ui.end_row();
+                    }
+
+                    if ui.add(
+                        egui::Button::new(crate::SOUNDS_BUTTON_LABEL)
+                            .text_color(COLOUR_FG)
+                    ).clicked() {
+                        open_file_manager();
+                    }
+
+                    ui.end_row();
+                });
+        });
+    }
+
+    fn name(&self) -> &str {
+        "lull"
+    }
+}

src/ui/gtk.rs

@@ -0,0 +1,130 @@
+use std::env::args;
+
+use gio::prelude::*;
+use gtk::prelude::*;
+use gtk::Orientation;
+
+use crate::open_file_manager;
+use crate::config::load_config;
+
+pub(crate) fn error_popup(message: &str) {
+    let popup = gtk::Window::new(gtk::WindowType::Toplevel);
+    popup.set_title("error");
+    popup.set_border_width(crate::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.show_all();
+}
+
+fn build_ui(application: &gtk::Application) {
+    let window = gtk::ApplicationWindow::new(application);
+
+    window.set_title("lull");
+    window.set_border_width(crate::SPACING as u32);
+    window.set_position(gtk::WindowPosition::Center);
+    window.set_default_size(256, 128);
+
+    if let Some(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(crate::SOUNDS_BUTTON_LABEL);
+
+    button_manage_sounds.connect_clicked(|_| {
+        open_file_manager();
+    });
+
+    let sounds_manage  = gtk::Box::new(Orientation::Vertical,   crate::SPACING);
+    let columns        = gtk::Box::new(Orientation::Horizontal, crate::SPACING);
+    let column_labels  = gtk::Box::new(Orientation::Vertical,   crate::SPACING);
+    let column_sliders = gtk::Box::new(Orientation::Vertical,   crate::SPACING);
+
+    columns.set_homogeneous(false);
+    column_labels.set_homogeneous(true);
+    column_sliders.set_homogeneous(true);
+    column_labels.set_property_expand(false);
+    column_sliders.set_property_expand(true);
+    column_sliders.set_property_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 sounds = crate::get_sounds(&device);
+
+    for sound in sounds {
+        let label = gtk::Label::new(Some(sound.name.as_ref()));
+        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.get_value();
+
+            if volume == 0. {
+                sound.sink.pause();
+            } else {
+                sound.sink.play();
+                sound.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.get_position(),
+            size:     window.get_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()
+    ).expect("Initialisation failed...");
+
+    application.connect_activate(|app| {
+        build_ui(app);
+    });
+
+    application.run(&args().collect::<Vec<_>>());
+}

src/ui/mod.rs

@@ -0,0 +1,3 @@
+// pub mod egui;
+pub mod gtk;
+// pub mod orbtk;

src/ui/orbtk.rs

@@ -0,0 +1,15 @@
+use orbtk::{prelude::*, widgets::themes::*};
+
+pub(crate) fn instantiate() {
+    Application::new()
+        .window(|ctx| {
+            Window::new()
+                .title("OrbTk - showcase example")
+                .position((100, 100))
+                .size(1000, 730)
+                .resizeable(true)
+                .child(MainView::new().build(ctx))
+                .build(ctx)
+        })
+        .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?)