Crate chilen_daemon 

Chilen Daemon library

Warning

The project is under active development, so please be wary of any bugs you may find, and expect breaking API changes in the upcoming updates!

This library contains data types and functions used to start and control the Chilen daemon.

Unlike MPD, the Chilen daemon can be bundled in your player’s executable file instead of bundling it as a separate one or relying on the user to install and additional program on their system.

Chilen supports a wide range of audio formats, including AAC, ADPCM, AIFF, ALAC, CAF, FLAC, MKV, MP1, MP2, MP3, MP4, OGG, Vorbis, WAV, and WebM. Support is provided via the Symphonia crate.

The daemon uses a local socket to connect to its clients. The type of socket used depends on your platform and the startup configuration of the daemon. Under the hood, [interprocess] and [rmp_serde] crates are used for handling clients connections, and chilen_ipc for providing common data types.

This crate does not provide direct access to the daemon over the local socket. For such functionality, please refer to the chilen_ipc crate.

Certain interfaces with the daemon are only available through the use of this library, and are not available to regular clients connecting over the IPC socket. The program controlling the daemon can, for instance:

• Stop the daemon without having to connect to it over the local socket
• Modify certain properties set at launch

Examples

Starting the daemon with default config:

let config = chilen_daemon::Config::try_default().unwrap();
let (_, handle) = chilen_daemon::start(config);
match handle.join().unwrap() {
    Ok(_) => println!("Daemon exited"),
    Err(e) => {
        panic!("Daemon failed: {e}");
    }
}

Starting the daemon with a custom config:

let home = std::env::home_dir().unwrap();
let name = "test-player";

let mut cache_dir = home.clone();
cache_dir.push("cache");
cache_dir.push(name);

let mut data_dir = home.clone();
data_dir.push(".local/share");
data_dir.push(name);

let mut music_dir = home.clone();
music_dir.push("Music");

let config = chilen_daemon::Config {
    cache_dir,
    data_dir,
    music_dir,
    socket_name: "TEST_PLAYER.socket".to_string(),
    addr_claim_mode: AddrClaimMode::default(),
    socket_type: SocketType::default(),
    can_raise: false,
    can_set_fullscreen: false,
    can_quit: true,
    #[cfg(feature = "mpris")]
    desktop_entry: None,
    playback_config: playback::Config {
        #[cfg(feature = "mpris")]
        identity: "Test Player".to_string(), // Human-readable name for the player
        #[cfg(feature = "mpris")]
        bus_name_suffix: "com.dev.test-player".to_string(),
        allow_rate_modification: true,
    },
};

// The daemon usually takes around 100ms to start listening
let (_, handle) = chilen_daemon::start(config);
match handle.join().unwrap() {
    Ok(_) => println!("Daemon exited"),
    Err(e) => {
        panic!("Daemon failed: {e}");
    }
}

Modules

playback

Structs

Config

Configuration options for the daemon.

Enums

AddrClaimMode

Defines under which conditions should the daemon claim an occupied socket address.

ConfigError

Error originating from the Config struct.

Error

Request

Request sent from a client forwarded to the daemon.

Functions

quit

Stop a running daemon instance.

set_can_quit

Set whether the daemon should accept quit requests from clients.

set_can_raise

Set whether clients can send raise requests to the daemon.

set_can_set_fullscreen

start

Start the daemon with the given config.

Type Aliases

SocketType

Defines the socket type to use when starting the daemon.