https://github.com/ckaznable/oto
A picky, unstable, yet simple music player.
https://github.com/ckaznable/oto
music-player ratatui rust tui
Last synced: 5 months ago
JSON representation
A picky, unstable, yet simple music player.
- Host: GitHub
- URL: https://github.com/ckaznable/oto
- Owner: ckaznable
- License: mit
- Created: 2025-09-11T08:26:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-02-21T08:26:07.000Z (5 months ago)
- Last Synced: 2026-02-21T15:48:25.004Z (5 months ago)
- Topics: music-player, ratatui, rust, tui
- Language: Rust
- Homepage:
- Size: 943 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# おと(Oto)
A picky, unstable, yet simple music player.
[](https://ratatui.rs/)
OTO is designed for audiophiles who prefer direct hardware access (ALSA) for bit-perfect playback. This means:
1. **Exclusive Access**: It requires exclusive control of the audio device. Other applications may not be able to play sound while OTO is running.
2. **Minimalist**: It focuses on high-quality playback and does not include "fancy" features like visualizers, streaming integration, or complex library management.
If you need a more general-purpose MPD client or a feature-rich player, consider using [rmpc](https://github.com/mierak/rmpc).
> **Note**: Due to personal interest in minimizing allocations during TUI rendering, the rendering code prioritizes performance over readability.
## Features
- **High-Resolution Audio**: Native DSD (DSF) playback and Hi-Res PCM support
- **Multiple Formats**: FLAC, MP3, WAV, OGG, AAC, DSD/DSF
- **ALSA Backend**: Direct hardware access for optimal audio quality
- **TUI Interface**: Simple terminal UI built with ratatui
- **MPRIS Support**: D-Bus integration for media controls
- **Fuzzy Search**: Quick track search with Japanese romaji support
- **Album Art**: Display cover art in supported terminals
## Installation
```bash
# Standard installation
cargo install --git https://github.com/ckaznable/oto
# Install without Japanese dictionary support (no romaji search)
cargo install --git https://github.com/ckaznable/oto --no-default-features
```
### Dependencies
- Rust 1.92.0+ (nightly recommended for `let_chains` feature)
- ALSA development libraries (`libasound2-dev` on Debian/Ubuntu)
- D-Bus development libraries (`libdbus-1-dev` on Debian/Ubuntu)
- Chafa (`libchafa-dev` or `chafa` package) for image rendering
```bash
# Debian/Ubuntu
sudo apt install libasound2-dev libdbus-1-dev libchafa-dev
# Arch Linux
sudo pacman -S alsa-lib dbus chafa
# Fedora
sudo dnf install alsa-lib-devel dbus-devel chafa-devel
```
## Usage
### TUI Mode (Interactive)
```bash
# Play music from a directory
oto tui --path /path/to/music
# Use default device
oto tui --path ~/Music
# Specify audio device
oto tui --path ~/Music --device hw:1,0
```
### Headless Mode
```bash
# Play without UI
oto play --path /path/to/music
```
### Initialize Japanese Dictionary (Optional)
```bash
# Download and build dictionary for Japanese track search
oto init
```
## Audio Device Selection
OTO automatically detects USB DACs and prioritizes them. To list available devices:
```bash
aplay -l
```
Use the `--device` flag to specify a device:
```bash
oto tui --path ~/Music --device hw:2,0
```
## Feature Flags
| Feature | Description |
|---------|-------------|
| `dict-jp` | Japanese dictionary for romaji search (default) |
| `dict-jp-embed` | Embed dictionary into binary. No download needed, but increases binary size by ~15MB. |
```bash
# Build without Japanese support
cargo build --release --no-default-features
# Build with embedded dictionary
cargo build --release --features dict-jp-embed
```
## Inspired By
- [Amberol](https://gitlab.gnome.org/World/amberol) - A small and simple music player for GNOME
- [rmpc](https://github.com/mierak/rmpc) - A beautiful MPD client for the terminal
- [inori](https://github.com/eshrh/inori) - A beautiful MPD client for the terminal and support fuzzy search
## License
MIT License - see [LICENSE](LICENSE) for details.
## Acknowledgments
- [ratatui](https://github.com/ratatui-org/ratatui) - Terminal UI framework
- [symphonia](https://github.com/pdeljanov/Symphonia) - Audio decoding
- [souvlaki](https://github.com/Sinono3/souvlaki) - MPRIS support