tMus

NOTE

This project is in active development and therefore not suitable for day to day use at the moment. Expect bugs

tMus - terminal music player

Overview

tMus is a keyboard driven terminal based music player, it was originally inspired by cmus.

Roadmap

• Recognise .cue files and alike for proper album support.
• Add configuration system so that preferences are saved between runs.
  • Color configuration, to change away from the boring grey.
• Visualization, it would be cool to see what sound waves do.

Features

• Notcurses Library: The user interface is built using the Notcurses library, providing a rich and responsive terminal UI.
• Pipewire: Sound output is handled by pipewire, a low latency sound API, used by default on most linux distros nowadays.
• FFmpeg: Audio processing is done using FFmpeg, a robust and versatile library to handle multimedia data.

Installation

Arch linux

$ pacman --needed -S ffmpeg pipewire notcurses make gcc

Ubuntu/Debian

TODO

Building

Make is used as a simple solution for automatic compilation.

make

To make a debug build

make clean
make DEBUG=true

Testing

For purposes of testing ut is used. To compile and run tests

make test

Usage

Please note that the user documentation is not yet complete as of this writing. However, the design of this project is inspired by a Vim-like style, so if you’re familiar with Vim, you might find some similarities.

tMus has :add which accepts the path to the folder with audio files, this command will add audio files to the user interface. Afer that you can use arrow keys to move around and TAB key to switch between two views. Enter starts the playback and space pauses.