Terminal Music and Podcast Player written in Rust

Listen to music and podcasts freely as both in freedom and free of charge!

Freedom: As time goes by, online service providers control pretty much everything we listen to. Complicated copyright issues make things worse. If my favorite song cannot be found on a website, I'll probably just not listen to them for years.

Free of charge: You can download from YouTube, NetEase, Migu and KuGou for free. No need to register for monthly paid memberships.

As a contributor of GOMU, I met serious problems during development. The main problem is data race condition. So I rewrote the player in rust, and hope to solve the problem.

Supported Formats

Below are the audio formats supported by the various backends.

In the case that metadata is not supported, an attempt will still be made to play the file.

*1: Opus codec is supported in rusty backend if feature rusty-libopus is enabled.

Installation

Requirements

MSRV

The minimal Rust version required to build this project is 1.85.0.

Note that using non-default features might increase the MSRV.

Dependencies

Linux

Windows

All the packages here can be installed via various sources, for ease of install the winget package name is listed.

• See MSVC Prerequisites: only the required components for a minimal install

Backends

Default backend: rusty

There are extra features for some backends: Note that they are not enabled by default and potentially increase non-rust dependencies.

Album cover support

To display covers in the terminal itself, feature cover can be enabled. To only enable specific protocols for cover support, see tui/Cargo.toml#features.

Feature cover-ueberzug will require some ueberzug implementation to be present at runtime.

Files

Configuration

Configuration files can be found in:

Files & Folders:

Logs

By default logs can be found in:

Files:

The default log level is WARNING (can be changed via RUST_LOG).

Note that log files are only created on the first log line to be saved.

Official Install Sources

Cargo

cargo install termusic termusic-server --locked

From Source

git clone https://github.com/tramhao/termusic.git
cd termusic
make

Then install with:

make install

By default, termusic can display album covers in Kitty or iTerm2. If you need album covers displayed on other terminals, you can enable the sixel protocol or use a ueberzug implementation(x11/xwayland only).

To build all backends and all cover protocols and install them in your home:

make full

Finally, you can run it with:

~/.local/share/cargo/bin/termusic

To build with all backends and all cover protocols without copying binaries elsewhere:

make all-backends

Unofficial Install Sources

The following are ways to install termusic, but may differ in configuration and support.

They are not maintained by the termusic project itself.

Arch Linux

Arch Linux users can install termusic from the official repositories using pacman.

pacman -S termusic

Arch Linux GIT (AUR)

Arch Linux users can install termusic-git from the AUR using pamac.

pamac install termusic-git

NetBSD

NetBSD users can install termusic from the official repositories.

pkgin install termusic

Nix/NixOS

Either in the user's environment:

nix-env --install termusic

Or declaratively in /etc/nixos/configuration.nix:

{
    environment.systemPackagess = with pkgs; [
      ...
      termusic
    ];
}

TODO

• Better interface to adjust timestamp of lyric.
• Rating and sync support.
• Multiple root and easy switch.
• Save playlists.
• Listen to rss feeds/Podcasts. Need a new layout.

Contributing and issues 🤝🏻

Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve termusic, feel free to open an issue or a PR.

Please follow our contributing guidelines

Contributors

hasezoey

Thanks

• tui-realm
• termscp
• netease-cloud-music-gtk
• alacritty-themes
• shellcaster
• stream-download

License

MIT License for main part of code. GPLv3 for Podcast code under lib/src/podcast/mod.rs. Comes from shellcaster.