Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/hinto-janai/festival

Music player
https://github.com/hinto-janai/festival

audio audio-player cli daemon gui linux macos music music-player player rust shukusai web windows

Last synced: 24 days ago
JSON representation

Music player

Lists

README 

        



# Festival




![CI](https://github.com/hinto-janai/festival/actions/workflows/ci.yml/badge.svg)



Festival is a music player for local album collections.



https://github.com/hinto-janai/festival/assets/101352116/586e37e7-762d-4dc6-a9c4-9bdc45396961






## Frontends

Festival comes in a few different forms.



Click on the frontend to see more information.



| Frontend | Description | Released | Documentation |

|----------|-------------|----------|---------------|

| [`festival-gui`](https://github.com/hinto-janai/festival/tree/main/gui) | GUI        | 🟢 2023-06-28 | https://docs.festival.pm/gui

| [`festivald`](https://github.com/hinto-janai/festival/tree/main/daemon) | Daemon     | 🟢 2023-08-24 | https://docs.festival.pm/daemon

| [`festival-cli`](https://github.com/hinto-janai/festival/tree/main/cli) | CLI client | 🟢 2023-08-24 | https://docs.festival.pm/cli

| [`festival-web`](https://github.com/hinto-janai/festival/tree/main/web) | Web server | 🔴            | https://docs.festival.pm/web

| [`festival-tui`](https://github.com/hinto-janai/festival/tree/main/tui) | TUI        | 🔴            | https://docs.festival.pm/tui



## Comparison

For a comparison between Festival and other music players, see [`comparison/`](https://github.com/hinto-janai/festival/tree/main/comparison/README.md).



## Build



General Info



---



You need [`cargo`](https://www.rust-lang.org/learn/get-started) and at least `rustc 1.70`.



You also need to clone the `submodules` that include patched libraries found in [`external/`](https://github.com/hinto-janai/festival/tree/main/external):

```bash

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

```



Built binaries are found in `target/release/${FRONTEND_BINARY_NAME}` by default.



The repo is a workspace, with some packages shared between all `Frontend`'s, including the internals: [`shukusai`](https://github.com/hinto-janai/festival/tree/main/shukusai).



To build one of the `Frontend`'s, you must pass the `--package ` option.



Each frontend's release has a git tag, so to build the latest _stable_ `festival-gui`:

```bash

git checkout gui-v1.3.3

cargo build --release --package festival-gui

```



The [`x.sh`](https://github.com/hinto-janai/festival/tree/main/x.sh) script at the repo root is a convenience script for linting/testing/building all `Festival` frontends.



For example, to build all packages in `--release` mode, from the current commit:

```bash

./x.sh build

```

Use `./x.sh help` to see more options.



---



Linux



---



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

```

# Shared packages.

sudo apt install build-essential pkg-config libdbus-1-dev libasound2-dev libjack-dev libpulse-dev



# Only for `festival-gui`.

sudo apt install libgtk-3-dev



# Only for `festivald` & `festival-cli`.

sudo apt install libssl-dev

```



To build [`festival-gui`](https://github.com/hinto-janai/festival/tree/main/gui):

```bash

git checkout gui-v1.3.3

cargo build --release --package festival-gui

```

To build [`festivald`](https://github.com/hinto-janai/festival/tree/main/daemon):

```bash

git checkout daemon-v1.0.0

cargo build --release --package festivald

```

To build [`festival-cli`](https://github.com/hinto-janai/festival/tree/main/cli):

```bash

git checkout cli-v1.0.0

cargo build --release --package festival-cli

```



---



macOS



---



To build [`festival-gui`](https://github.com/hinto-janai/festival/tree/main/gui):

```bash

git checkout gui-v1.3.3

cargo build --release --package festival-gui

```

To build [`festivald`](https://github.com/hinto-janai/festival/tree/main/daemon):

```bash

git checkout daemon-v1.0.0

cargo build --release --package festivald

```

To build [`festival-cli`](https://github.com/hinto-janai/festival/tree/main/cli):

```bash

git checkout cli-v1.0.0

cargo build --release --package festival-cli

```



---



Windows



---



To build [`festival-gui`](https://github.com/hinto-janai/festival/tree/main/gui):

```bash

git checkout gui-v1.3.3

cargo build --release --package festival-gui

```



There is a [`build.rs`](https://github.com/hinto-janai/festival/blob/main/gui/build.rs) file in `gui/` solely for Windows-specific things:



1. It sets the icon in `File Explorer`

2. It sets some miscellaneous metadata

3. It statically links `VCRUNTIME140.dll` (the binary will not be portable without this)



To build [`festivald`](https://github.com/hinto-janai/festival/tree/main/daemon):

```bash

git checkout daemon-v1.0.0

cargo build --release --package festivald

```

To build [`festival-cli`](https://github.com/hinto-janai/festival/tree/main/cli):

```bash

git checkout cli-v1.0.0

cargo build --release --package festival-cli

```



---



## License

Festival is licensed under the [MIT License](https://github.com/hinto-janai/festival/blob/main/LICENSE).



However, its dependency tree includes many other licenses.



## FAQ



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:

```bash

./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`](https://kid3.kde.org)

- [`mp3tag`](https://www.mp3tag.de/en)

- [`puddletag`](https://docs.puddletag.net)

- [`MusicBrainz Picard`](https://picard.musicbrainz.org)



---



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   |



---