Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): improve docs to be explicit about sourcing from YouTube #142

Merged
merged 1 commit into from
Feb 17, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 38 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable MD001 MD007 MD041 MD023 -->
<!-- markdownlint-disable MD001 MD007 MD023 MD041 -->

<div align="center">
<a href="https://github.com/miraclx/freyr-js">
Expand All @@ -8,7 +8,7 @@
# Freyr

<h4>
A versatile, service-agnostic music downloader and manager
Download songs from Spotify, Apple Music and Deezer.
</h4>

[![GitHub](https://img.shields.io/badge/by-miraclx-gray&plastic)](https://github.com/miraclx)
Expand All @@ -28,12 +28,46 @@

<sub>Built with ❤︎ by
<a href="https://github.com/miraclx">Miraculous Owonubi</a>

</div>

## Demo

[![ASCII Demo](https://github.com/miraclx/freyr-js/raw/master/media/demo.gif)](https://asciinema.org/a/KH5xyBq9G8Wf5Dyvj6AfqXwYr?autoplay=1 "Click to view ASCII")

## Overview

### What freyr does

Depending on the URLs you provide freyr, it will;

1. Extract track metadata (`title`, `album`, `artist`, etc.) from the streaming service (Spotify if you provide a Spotify URL).
2. Then, it queries sources (e.g. YouTube), classifies the results to find you the best sounding, most accurate audio and downloads that in the raw format.
3. Next, it processes each track, encoding them in an [Apple AAC](https://en.wikipedia.org/wiki/Advanced_Audio_Coding) format (`.m4a` file extension) at a bitrate of `320kbps` for high quality.
4. Then, it embeds all the metadata and the album art into each track.
5. And finally, it organizes all the files into a structured library.

### Metadata Availability

Here's a list of the metadata that freyr can extract from each streaming service:

| Meta | Spotify | Apple Music | Deezer |
| :------------: | :-----: | :---------: | :----: |
| `Title` | ✔ | ✔ | ✔ |
| `Artist` | ✔ | ✔ | ✔ |
| `Composer` | ✗ | ✔ | ✔ |
| `Album` | ✔ | ✔ | ✔ |
| `Genre` | ✗ | ✔ | ✔ |
| `Track Number` | ✔ | ✔ | ✔ |
| `Disk Number` | ✔ | ✔ | ✔ |
| `Release Date` | ✔ | ✔ | ✔ |
| `Rating` | ✔ | ✔ | ✔ |
| `Album Artist` | ✔ | ✔ | ✔ |
| `ISRC` | ✔ | ✔ | ✔ |
| `Label` | ✔ | ✔ | ✔ |
| `Copyright` | ✔ | ✔ | ✗ |
| `Cover Art` | ✔ | ✔ | ✔ |

## Support the project

#### Donate via
Expand Down Expand Up @@ -136,6 +170,8 @@

</details>

> _Please note that [YouTube Music](https://music.youtube.com/) must be available in your region for freyr to successfully work, this is because freyr sources raw audio from [YouTube Music](https://music.youtube.com/)._

---
</details>

Expand Down Expand Up @@ -883,25 +919,6 @@ To preview filter rules specification, use the `filter` subcommand.
| YouTube Music (See [#6](https://github.com/miraclx/freyr-js/issues/6)) | ✗ | ✗ | ✗ | ✗ | ✗ |
| Tidal (See [#33](https://github.com/miraclx/freyr-js/issues/33)) | ✗ | ✗ | ✗ | ✗ | ✗ |

### Metadata Availability

| Meta | Spotify | Apple Music | Deezer |
| :------------: | :-----: | :---------: | :----: |
| `Title` | ✔ | ✔ | ✔ |
| `Artist` | ✔ | ✔ | ✔ |
| `Composer` | ✗ | ✔ | ✔ |
| `Album` | ✔ | ✔ | ✔ |
| `Genre` | ✗ | ✔ | ✔ |
| `Track Number` | ✔ | ✔ | ✔ |
| `Disk Number` | ✔ | ✔ | ✔ |
| `Release Date` | ✔ | ✔ | ✔ |
| `Rating` | ✔ | ✔ | ✔ |
| `Album Artist` | ✔ | ✔ | ✔ |
| `ISRC` | ✔ | ✔ | ✔ |
| `Label` | ✔ | ✔ | ✔ |
| `Copyright` | ✔ | ✔ | ✗ |
| `Cover Art` | ✔ | ✔ | ✔ |

<details>
<summary id="ssue"> <strong> Short Service URI Examples </strong> </summary>
<table>
Expand Down