crab-dlna

crab-dlna is a minimal UPnP/DLNA media streamer, available both as a standlone CLI (command line interface) application and a Rust library.

It allows you to play a local video file in your TV (or any other DLNA compatible device).

Features

- Searching available DLNA devices in the local network - Streaming audio - Streaming video, with subtitle support

Installation

In the GitHub Releases of this repository we provide archives of precompiled binaries of crab-dlna, available for Linux, Windows, and macOS.

cargo

Installation via cargo is done by installing the crab-dlna crate:

# If required, update Rust on the stable channel rustup update stable
cargo install crab-dlna
Alternatively, --locked may be required due to how cargo install works
cargo install crab-dlna --locked

Usage (CLI)

You can list all the CLI commands by running:

crab-dlna --help

List

Scan compatible devices and list the available ones:

crab-dlna list

If your device is not being listed, you might need to increase the search timeout:

crab-dlna -t 20 list

Play

Play a video, automatically loading the subtitles if available, selecting a random device:

crab-dlna play That.Movie.mkv

Play a video, specifying the device through query (scan devices before playing):

crab-dlna play That.Movie.mkv -q "osmc"

Play a video, specifying the device through its exact location (no scan, faster):

crab-dlna play That.Movie.mkv -d "http://192.168.1.13:1082/"

Usage (library)

Add crab-dlna and tokio to your dependencies:

[dependencies]  tokio = { version = "1", features = ["full"] } crab-dlna = "0.2"

Example: discover and list devices

crab-dlna provides a function to discover a list devices in the network.

use crab_dlna::Render;
#[tokio::main] async fn main() {     let discovertimeoutsecs = 5;     let rendersdiscovered = Render::discover(discovertimeout_secs).await.unwrap();     for render in renders_discovered {         println!("{}", render);     } }

Example: play a video in a device

We can specify a DLNA device render trough a query string, and then play a certain video in it, automatically detecting the subtitle file.

use std::path::PathBuf;
use crab_dlna::{
    Render,
    RenderSpec,
    MediaStreamingServer,
    STREAMINGPORTDEFAULT,
    getlocalip,
    infersubtitlefrom_video,
    Error,
    play,
};
#[tokio::main] async fn main() -> Result<(), Error> {     let discovertimeoutsecs = 5;     let renderspec = RenderSpec::Query(discovertimeoutsecs, "Kodi".tostring());     let render = Render::new(render_spec).await?;     let hostip = getlocal_ip().await?;     let hostport = STREAMINGPORT_DEFAULT;     let videopath = PathBuf::from("/home/crab/Videos/myvideo.mp4");     let inferredsubtitlepath = infersubtitlefromvideo(&videopath);     let mediastreamingserver = MediaStreamingServer::new(         &video_path,         &inferredsubtitlepath,         &host_ip,         &host_port,     )?;     play(render, mediastreamingserver).await }

You can access the full documentation to see more details about the library.

License

crab-dlna is made available under the terms of either the MIT License or the Apache License 2.0, at your option.

See the LICENSE-APACHE and LICENSE-MIT files for license details.

🔗 More in this category