https://github.com/ljufa/rsplayer
RSPlayer - Diy-friendly Music Player
https://github.com/ljufa/rsplayer
ak4497 audio music music-player raspberry-pi raspberry-pi-4 rust wasm
Last synced: 10 days ago
JSON representation
RSPlayer - Diy-friendly Music Player
- Host: GitHub
- URL: https://github.com/ljufa/rsplayer
- Owner: ljufa
- License: mit
- Created: 2020-08-13T06:46:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-15T17:15:09.000Z (12 days ago)
- Last Synced: 2026-01-15T20:07:40.779Z (11 days ago)
- Topics: ak4497, audio, music, music-player, raspberry-pi, raspberry-pi-4, rust, wasm
- Language: Rust
- Homepage: https://ljufa.github.io/rsplayer/
- Size: 62.2 MB
- Stars: 15
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RSPlayer
RSPlayer is open-source music player designed specifically for headless computing environments. It shines on devices like the Raspberry Pi and other Linux-powered Single Board Computers (SBCs).
Operating as a system service, RSPlayer offers a web-based user interface, making it a perfect fit for devices without dedicated monitors or input peripherals. The UI is meticulously designed to be responsive and intuitive, delivering a seamless user experience across mobile devices, tablets, and PCs.
Under the hood, RSPlayer harnesses the power of the [Symphonia](https://github.com/pdeljanov/Symphonia) and [Cpal](https://github.com/rustaudio/cpal) crates. These allow RSPlayer to handle audio decoding and playback efficiently, leveraging Rust's native capabilities for high-performance audio playback.
For DIY enthusiasts seeking a customizable, high-performance music player for their projects, RSPlayer is the go-to choice. Its lightweight design and efficient resource usage make it ideal for transforming your Raspberry Pi or other SBCs into a dedicated music station.
### Online demo -> https://rsplayer.dlj.freemyip.com/
## Features
- **Low Latency Output**: Direct output to ALSA minimizes latency.
- **Adjustable Playback Thread Priority**: Customize the priority of the playback thread up to a real-time rating of 99 via the settings page.
- **Dedicated CPU Core for Playback**: By default, the playback thread is pinned to a single CPU core for optimized performance.
- **Web UI Remote Control**: Manage your playback remotely with an intuitive web interface.
- **Flexible Volume Control**: Control the volume using software (alsa mixer) or hardware control (Dac chip instuctions via GPIO).
- **Written in Rust**: Enjoy the benefits of minimal dependencies and high performance, thanks to the Rust native implementation.
- **Comprehensive Music Library Management**: Scan, search, and browse your music library and online radio stations with ease.
- **Dynamic Playlists**: Automaticaly create dynamic playlists for personalized listening experiences.
### Planed features
- **Expanded Audio Codec Support**: Compatibility with a wider range of audio codecs.
- **Intelligent Dynamic Playlists**: Advanced dynamic playlists that adapt based on user likes or playback counts for a personalized listening experience.
- **Windows Compatibility**: Development of a Windows build to extend platform support.
- **MacOS Compatibility**: Development of a MacOS build to extend platform support.
- **DSP Support**: Integration of Digital Signal Processing (DSP) capabilities for enhanced audio effects and manipulations.
- **Remote file system management**: Ability to mount and use remote file storage (nfs and samba) from UI.
## Installation
To install RSPlayer on debian based linux distro, execute the following script (requires curl):
```bash
bash <(curl -s https://raw.githubusercontent.com/ljufa/rsplayer/master/install.sh)
```
The installation script will install all the necessary files, configure and start the systemd service.
To stop RSPlayer, run the following command:
```bash
sudo systemctl stop rsplayer
```
To start RSPlayer service again, run the following command:
```bash
sudo systemctl start rsplayer
```
## Run as docker container
```bash
docker run -p 8000:80 -v ${MUSIC_DIR}:/music -v rsplayer_data:/opt/rsplayer --device /dev/snd -it --rm ljufa/rsplayer:latest
```
or [docker compose](docker-compose.yaml)
```yaml
services:
rsplayer:
image: ljufa/rsplayer:latest
devices:
- /dev/snd
ports:
- 8000:80
volumes:
- ${MUSIC_DIR}:/music:ro
- 'rsplayer_volume:/opt/rsplayer'
restart: unless-stopped
volumes:
rsplayer_volume:
driver: local
```
## Usage
Once RSPlayer is installed, you can access the web user interface by navigating to http://localhost or the IP address of the machine on which it is installed. From the web user interface, you can finish configuration following steps described [here](https://ljufa.github.io/rsplayer/#/?id=basic-configuration).
For minimal working configuration it is required to select *Audio interface*, *PCM device*, *Music directory path* followed by *Update library*.
#### Detailed documentation -> https://ljufa.github.io/rsplayer/
## Requirements
* x86(Amd64) or Arm(64 and 32bit) computer with debian based linux distribution.
## Tested on
* Rpi4 - RpiOS bookworm and bullseye
* Rpi Zero WH - RpiOS bookworm and bullseye
* Various x86_64 laptop/pc with ubuntu and debian based distros
## DIY Hardware
For DIY enthusiasts, `rsplayer` offers the flexibility to integrate with custom hardware components.
All KiCad files and hardware documentation are now located in the [rsplayer_hardware](https://github.com/ljufa/rsplayer_hardware) repository.
The firmware for hardware control has been moved to the [rsplayer_firmware](https://github.com/ljufa/rsplayer_firmware) repository.
This separation allows for more focused development and easier maintenance of both the software and hardware aspects of the project.
## Contributing
If you would like to contribute to RSPlayer, please submit a pull request or open an issue on the GitHub repository.
For instructions on how to build the project from source, please see the [BUILD.md](BUILD.md) file.
## License
RSPlayer is licensed under the MIT license. See the LICENSE file for more information.