Ygg01 / festival

Music player

Festival

Festival is a music player for local album collections.

Festival.mp4

Frontends

All the frontends are built on top of the internals, shukusai.

Currently, the most full frontend implementation is festival-gui (or just called Festival).

Frontend	Description	Released
festival-gui	GUI (egui)	🟢 2023-06-28
festivald	Daemon (mpd-like)	🔴
festival-cli	CLI client	🔴
festival-web	WASM client	🔴
festival-tui	Standalone TUI	🔴

Documentation

For a user guide on Festival, see gui/.

For a broad overview of the internals, see shukusai/.

For a comparison between Festival and other music players, see comparison/.

Build

General Info

---

You need cargo and at least rustc 1.70.

You also need to clone the submodules that include patched libraries found in external/:

git clone --recursive https://github.com/hinto-janai/festival

The repo is a workspace, with shukusai and the Frontend's all having a top-level directory, e.g:

• shukusai/
• gui/

Building at the root will build all binaries.

Currently, the only packages in the workspace are shukusai and festival-gui, which gets built as festival[.exe].

---

Linux

---

The pre-compiled Linux binaries are built on Ubuntu 20.04, you'll need these packages to build:

sudo apt install libgtk-3-dev libasound2-dev libjack-dev libpulse-dev

To build:

cargo build --release

Optionally, to create an AppImage after building, at the repo root, run:

cd utils/
./mk_appimage.sh

This will create Festival-v${VERSION}-x86_64.AppImage.

This requires appimagetool. If not detected, it will wget the latest release to /tmp and use that instead.

---

macOS

---

To build:

cargo build --release

Optionally, to create a Festival.app after building, at the repo root, run:

cd utils/
./mk_app.sh

This will create Festival.app.

Optionally, to create a .dmg after that, run:

./mk_dmg.sh

This will create Festival-v${VERSION}-macos-(x64|arm64).dmg, x64 or arm64 depending on your cargo target.

---

Windows

---

To build:

cargo build --release

There is a build.rs file in gui/ solely for Windows-specific things:

1. It sets the icon in File Explorer
2. It statically links VCRUNTIME140.dll (the binary will not be portable without this)

---

License

Festival is licensed under the MIT License.

Symphonia, the audio decoding/demuxing/metadata library used by Festival is licensed under MPL-2.0.

FAQ

Playlists

---

Festival does not support playlists at the moment.

---

Compilations

---

Festival does not directly support compilations (a single album, but with various artists) at the moment.

It will still load the album, but it will be spread out for each different artist.

---

Missing music

---

Your audio files must have proper metadata for Festival to detect it.

The required tags are:

• Artist
• Album

If the song title tag does not exist, the filename will be used instead.

For more details on metadata related errors, start Festival in a console:

./festival

and look for yellow W (Warn) log messages during a Collection reset.

---

Missing album art

---

If your audio file has embedded album art, Festival will use it.

If no embedded album art metadata is found, Festival will:

• Search in the same directory as the file for an image file
• Search in the file's parent directory for an image file

If an image file is not found, a default ? album art will be used.

The supported image file formats are:

• JPG/JPEG
• PNG
• BMP
• ICO
• TIFF
• WebP

---

Missing date

---

Festival will look for a date metadata tag generally resembling the YYYY-MM-DD format.

Some examples of dates that will work:

• 2022-12-31 (YYYY-MM-DD)
• 2022 (YYYY)
• 31-12-2022 (DD-MM-YYYY)
• 12-31-2022 (MM-DD-YYYY)
• 2022/12/31 (YYYY-MM-DD but with a different separator)
• 20221231 (YYYY-MM-DD but with no separator)
• 2022-1-1 (YYYY-MM-DD)
• 2022-01-01 (YYYY-MM-DD)

As long as the year exists, the date will be parsed correctly. This means MM-DD metadata will be not parsed, so:

• 12-31 (MM-DD)
• 31-12 (DD-MM)

will not work. These will show up as ????-??-?? in Festival.

To fix your music metadata, see below for metadata editors.

---

Metadata editing

---

Festival is only a music player, not a metadata editor.

Some metadata editors you could use:

• Kid3
• mp3tag
• puddletag
• MusicBrainz Picard

---

Supported audio codecs

---

The supported audio codecs are:

• AAC
• ADPCM
• ALAC
• FLAC
• MP3/MP2/MP1/MPA/MPEG
• Ogg/Vorbis
• Opus
• WAV
• WavPack

---

Supported metadata formats

---

Format	Status
ID3v1	Great
ID3v2	Great
ISO/MP4	Great
RIFF	Great
Vorbis comment (FLAC)	Perfect
Vorbis comment (OGG)	Perfect

---