#music-player #scanner #grpc-api #media-player #tui #scan

bin+lib music-player-scanner

The music library scanner for the music player

9 releases

0.1.9 May 7, 2023
0.1.8 Apr 2, 2023
0.1.6 Jan 12, 2023
0.1.5 Nov 13, 2022
0.1.4 Sep 23, 2022

#950 in Audio

40 downloads per month
Used in 6 crates (4 directly)

MIT license

160KB
3.5K SLoC

Music Player (written in Rust)

License: MIT GitHub all releases release rust-clippy discord-server

Note: This is a work in progress. 🏗️🚧

This is a simple music player that I made for my own use. It is written in Rust and uses rodio, symphonia, and gRPC libraries.
Music is played through the server's audio device. The daemon stores info about all available music, and this info can be easily searched and retrieved. Like mpd or Mopidy but written in Rust.

Installation

Compiling from source, without Nix:

# Install dependencies
brew install protobuf # macOS
sudo apt-get install -y libasound2-dev protobuf-compiler # Ubuntu/Debian
choco install protoc # Windows using Chocolatey Package Manager
# Compile
git clone https://github.com/tsirysndr/music-player.git
cd music-player/webui/musicplayer
nvm install # install node version specified in .nvmrc (optional on windows)
bun install && bun run build # build webui
cd ../..
cargo install --path .

With Nix:

git clone https://github.com/tsirysndr/music-player.git
cd music-player
nix develop --experimental-features "nix-command flakes"
cd webui/musicplayer
bun install && bun run build # build webui
cd ../..
cargo install --path .

macOS/Linux

Using Homebrew:

brew install tsirysndr/tap/musicplayer

Using Nix:

nix profile install --experimental-features "nix-command flakes" github:tsirysndr/music-player

Or download the latest release for your platform here.

📦 Downloads

Latest (Desktop):

Latest (CLI):

Other version...

Start the server

music-player

Usage

USAGE:
    music-player [SUBCOMMAND]

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    albums      List all albums
    artists     List all artists
    help        Print this message or the help of the given subcommand(s)
    next        Play the next song
    pause       Pause the current song
    open        Open audio file
    playlist    Manage playlists
    prev        Play the previous song
    queue       Manage the queue
    play        Resume the current song
    scan        Scan music library: $HOME/Music
    search      Search for a song, album, artist or playlist
    stop        Stop the current song
    tracks      List all tracks

GraphQL API

# Start the server
music-player

Open http://localhost:5053/graphiql in your browser.

Features

  • Play music from specified path
  • Configuration file support
  • gRPC API for controlling the player
  • Scan music library
  • Play/Pause/Stop music
  • Next/Previous track
  • Create/Delete playlists
  • Music Player Client
  • Terminal UI (using tui-rs)
  • GraphQL API
  • Web UI
  • Desktop version (using gtk-rs)
  • Android Library (See songbird-android and songbird-android-rs)
  • iOS Library
  • Mobile version (React Native)
  • Stream to Chromecast
  • Stream to Airplay
  • Stream to Kodi
  • Stream to UPnP Media Renderer
  • Stream from Youtube (audio only)
  • Stream from Spotify
  • Stream from Soundcloud
  • Stream from Deezer
  • Stream from DatPiff
  • Stream from Tidal
  • Stream from MyVazo

✨ Star History

Star History Chart

Dependencies

~92MB
~1.5M SLoC