sashakoshka
/
gomp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:aditya-K2/goMP into cache

This commit is contained in:
aditya-K2 2021-12-13 00:10:55 +05:30
parent 0bd47c5d3f 9190d37c64
commit 2e1e0938c0
6 changed files with 236 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
README.md
View File

@ -4,21 +4,7 @@
MPD client inspired by ncmpcpp written in GO
https://user-images.githubusercontent.com/51816057/142734222-c211eae5-e497-4f1a-8f3f-9288f5375a8e.mp4
# Table Of Contents
- [goMP](#gomp)
- [Table Of Contents](#table-of-contents)
- [Roadmap](#roadmap)
- [Setting Up](#setting-up)
- [Installing / Building](#installing--building)
- [Configuration](#configuration)
- [Image Rendering :](#image-rendering-)
- [Setting Up Cache Directory and Cache File](#setting-up-cache-directory-and-cache-file)
- [Key Mappings](#key-mappings)
- [Getting Album Art from LastFm API](#getting-album-art-from-lastfm-api)
- [Tested on following terminals:](#tested-on-following-terminals)
https://user-images.githubusercontent.com/51816057/144759799-b9eecf9e-93ad-43a7-a076-0ae47f03d03c.mp4
# Roadmap
@ -33,119 +19,4 @@ https://user-images.githubusercontent.com/51816057/142734222-c211eae5-e497-4f1a-
# Setting Up
- Music Player Daemon must be setup
- Go Should Be Installed ( for building )
- Make a YAML/TOML file in ``$HOME/.config/goMP`` named config.yml / config.toml
- Read the sample_config.yml for config options
# Installing / Building
```bash
git clone https://github.com/aditya-K2/goMP &&
cd goMP &&
go build
```
# Configuration
## Image Rendering :
The Default Position of the Image without any configuration assumes that you have no padding or margin so Image will
be rendered at different places in different terminals, Also the TUI calculates positions with the help of rows and columns
and the image is rendered at pixel positions so the exact position can't be defined [ the app tries its best by calculating
the font width and then predicting the position but it is best that you define extra padding and own image width ratio
in config.yml. Please Read more about it in the [sample_config](https://github.com/aditya-K2/goMP/blob/master/sample_config.yml)
# Setting Up Cache Directory and Cache File
The Images that are extracted are cached.
In the `config.yml` file add the following
```yml
CACHE_DIR : "/path/to/the/cache/Directory"
CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. )
```
## Key Mappings
Following Keys can be used for Mappings
| Keys | Using them in Config |
|-----------------|-----------------------|
| a-z | a-z |
| A-Z | A-z |
| {,},(,),[,],<,> | {,},(,),[,],<,> |
| Enter(Return) | ENTER/RETURN |
| Tab | TAB |
| Space | SPACE |
See config/kMap.go for more information
For mapping a key to some function use the following format:
```yml
Function: [ firstMapping, secondMapping, thirdMapping]
```
for.eg
```yml
togglePlayBack : [ "p", "TAB", "[" ] # using the quotes is neccessary.
```
Following functions are provided :
| Functions |
|------------------------------------|
| showChildrenContent |
| togglePlayBack |
| showParentContent |
| nextSong |
| clearPlaylist |
| previousSong |
| addToPlaylist |
| toggleRandom |
| toggleRepeat |
| decreaseVolume |
| increaseVolume |
| navigateToFiles |
| navigateToPlaylist |
| navigateToMostPlayed |
| navigateToSearch |
| quit |
| stop |
| updateDB |
| deleteSongFromPlaylist |
| FocusSearch |
## Getting Album Art from [LastFm API](https://www.last.fm/api)
1. Generate API Key [here](https://www.last.fm/login?next=%2Fapi%2Faccount%2Fcreate%3F_pjax%3D%2523content)
![Screenshot from 2021-11-13 21-54-54](https://user-images.githubusercontent.com/51816057/141651276-f76a5c7f-65fe-4a1a-b130-18cdf67dd471.png)
2. Add the api key and api secret to config.yml
```yml
GET_COVER_ART_FROM_LAST_FM : "TRUE" # Turn On Getting Album art from lastfm api
LASTFM_API_KEY: "YOUR API KEY HERE"
LASTFM_API_SECRET: "YOUR API SECRET HERE"
```
3. Auto correct
![Screenshot from 2021-11-13 21-59-46](https://user-images.githubusercontent.com/51816057/141651414-1586577a-cab2-48e2-a24b-1053f8634fbe.png)
:
```yml
LASTFM_AUTO_CORRECT: 1 # 0 means it is turned off
```
### Tested on following terminals:
- Alacritty
- ST
- URXVT ( URXVT sometimes crashes when downloading coverart from lastfm )
Read how to setup goMP in the Setting-Up Guide [here](https://github.com/aditya-K2/goMP/blob/master/docs/settingup.md)

BIN
docs/assets/default.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

BIN
docs/assets/padding.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

BIN
docs/assets/width.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 69 KiB

203
docs/settingup.md Normal file
View File

@ -0,0 +1,203 @@
* [Prerequisites](#prerequisites)
* [Installing / Building](#installing--building)
* [Configuration](#configuration)
* [MPD Port](#mpd-port)
* [Music Directory](#music-directory)
* [Default Image Path](#default-image-path)
* [Additional Padding and Extra Image Width](#additional-padding-and-extra-image-width)
* [Image Rendering](#image-rendering)
* [Cache Directory](#cache-directory)
* [Key Mappings](#key-mappings)
* [Getting Album Art from LastFm API](#getting-album-art-from-lastfm-api)
# Prerequisites
- Music Player Daemon must be setup and Running
- Go Should Be Installed ( For Building )
- After Reading this it is highly recommended to read the [sample_config](https://github.com/aditya-K2/goMP/blob/master/sample_config.yml)
# Installing / Building
```bash
git clone https://github.com/aditya-K2/goMP &&
cd goMP &&
go build
```
# Configuration
Configuration of goMP is done through a `config.yml` file in `$HOME/config/goMP/`
It is essential to have some config options defined in order to have a smooth experience.
## MPD Port
This is the port where your Music Player Daemon Is Running
```yml
MPD_PORT : "6600"
```
## Music Directory
The Most Essential config option is `MUSIC_DIRECTORY` It is the path to your Music Folder that you have provided to mpd
in the `mpd.conf` file. If you do not provide the path to the `MUSIC_DIRECTORY` then goMP parses the mpd.conf file for
the `music_directory` option ( It is to be noted that goMP assumes that your mpd.conf file is at
`$HOME/.config/mpd/mpd.conf`
```yml
MUSIC_DIRECTORY : "~/Music" # Adding the / at the end is neccessary
```
The reason why you need to setup `MUSIC_DIRECTORY` manually because the paths to the songs received from mpd are relative the `MUSIC_DIRECTORY`.
## Default Image Path
This is the Fallback Image that will be rendered if goMP doesn't find the embedded cover art or LastFM Cover Art.
```yml
DEFAULT_IMAGE_PATH : "/path/to/default/image"
```
## Additional Padding and Extra Image Width
### Image Rendering
The Default Position of the Image without any configuration assumes that you have no font or terminal padding or margin so Image will
be rendered at different places in different terminals, Also the TUIs calculates positions with the according to rows and columns
and the image is rendered at pixel positions so the exact position can't be defined [ the app tries its best by calculating
the font width and then predicting the position but it is best that you define some extra padding and your own image width ratio
in config.yml. Please Read more about it in the [sample_config](https://github.com/aditya-K2/goMP/blob/master/sample_config.yml)
for e.g
```yml
# Default Values. Might be different than sample_config.yml
ADDITIONAL_PADDING_X : 11
ADDITIONAL_PADDING_Y : 18
IMAGE_WIDTH_EXTRA_X : -0.7
IMAGE_WIDTH_EXTRA_Y : -2.6
```
![Cover Art Position](./assets/default.png)
Let's say upon opening goMP for the first time and your image is rendered this way.
Here the `Y` Position is too low hence we have to decrease the `ADDITIONAL_PADDING_Y` so that image will be rendered
in a better position so we decrement the `ADDITIONAL_PADDING_Y` by `9`
Now the configuration becomes
```yml
ADDITIONAL_PADDING_Y : 9
```
and the image appears like this:
![Padding](./assets/padding.png)
One might be happy the way things turn out but for the perfectionist like me this is not enough.
You can notice that the Height of the image is a little bit more than the box height and hence the image is flowing outside the box. Now it's time to change the `WIDTH_Y`.
Width can be changed by defining the `IMAGE_WIDTH_EXTRA_Y` and `IMAGE_WIDTH_EXTRA_X` it act's a little differently think of it like a chunk which is either added or subtracted from the image's original width. We can look at the configuration and realize that the chunk `IMAGE_WIDTH_EXTRA_Y` when subtracted from the original `IMAGE_WIDTH` doesn't get us the proper result and is a little to low. We need to subtract a more bigger chunk, Hence we will increase the magnitude of `IMAGE_WIDTH_EXTRA_Y` or decrease `IMAGE_WIDTH_EXTRA_Y`
Now the Configuration becomes:
```yml
IMAGE_WIDTH_EXTRA_Y : - 3.2
```
and the image appears like this:
![Width](./assets/width.png)
Which looks perfect. 🎉
Read More about Additional Padding and Image Width in the [sample_config](https://github.com/aditya-K2/goMP/blob/master/sample_config.yml)
Please change the configuration according to your needs.
## Cache Directory
By Default Images are cached to avoid re-extracting images and making redundant API Calls. The Extracted Images are copied to the `CACHE_DIR` and a reference is added to the `CACHE_FILE`
```yml
CACHE_DIR : "/path/to/the/cache/Directory/" # Adding the / at the end is neccessary
CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. )
```
This Technique has some drawbacks and the `CACHE_FILE` mechanism will soon be deprecated but for now add this lines to your `config.yml`. Don't Worry after changing the mechanism you won't have to make a single change to `config.yml` file the changes would be under the hood ( you won't even notice ).
Read More about Caching in the [sample_config](https://github.com/aditya-K2/goMP/blob/master/sample_config.yml)
## Key Mappings
Following Keys can be used for Mappings
| Keys | Using them in Config |
|-----------------|-----------------------|
| a-z | a-z |
| A-Z | A-z |
| {,},(,),[,],<,> | {,},(,),[,],<,> |
| Enter(Return) | ENTER/RETURN |
| Tab | TAB |
| Space | SPACE |
See config/kMap.go for more information
For mapping a key to some function use the following format:
```yml
Function: [ firstMapping, secondMapping, thirdMapping]
```
for.eg
```yml
togglePlayBack : [ "p", "TAB", "[" ] # using the quotes is neccessary.
```
Following functions are provided :
| Functions |
|------------------------------------|
| showChildrenContent |
| togglePlayBack |
| showParentContent |
| nextSong |
| clearPlaylist |
| previousSong |
| addToPlaylist |
| toggleRandom |
| toggleRepeat |
| decreaseVolume |
| increaseVolume |
| navigateToFiles |
| navigateToPlaylist |
| navigateToMostPlayed |
| navigateToSearch |
| quit |
| stop |
| updateDB |
| deleteSongFromPlaylist |
| FocusSearch |
## Getting Album Art from [LastFm API](https://www.last.fm/api)
1. Generate API Key [here](https://www.last.fm/login?next=%2Fapi%2Faccount%2Fcreate%3F_pjax%3D%2523content)
![Screenshot from 2021-11-13 21-54-54](https://user-images.githubusercontent.com/51816057/141651276-f76a5c7f-65fe-4a1a-b130-18cdf67dd471.png)
2. Add the api key and api secret to config.yml
```yml
GET_COVER_ART_FROM_LAST_FM : "TRUE" # Turn On Getting Album art from lastfm api
LASTFM_API_KEY: "YOUR API KEY HERE"
LASTFM_API_SECRET: "YOUR API SECRET HERE"
```
3. Auto correct
![Screenshot from 2021-11-13 21-59-46](https://user-images.githubusercontent.com/51816057/141651414-1586577a-cab2-48e2-a24b-1053f8634fbe.png)
:
```yml
LASTFM_AUTO_CORRECT: 1 # 0 means it is turned off
```

32
sample_config.yml
View File

@ -49,4 +49,34 @@ MPD_PORT : "6600"
DEFAULT_IMAGE_PATH: "default.jpg"
COVER_IMAGE_PATH: "cover.jpg" # path to store the embedded cover art
GET_COVER_ART_FROM_LAST_FM : "TRUE" # Turn On Getting Album art from lastfm api
LASTFM_API_KEY: "YOUR API KEY HERE"
LASTFM_API_SECRET: "YOUR API SECRET HERE"
LASTFM_AUTO_CORRECT: 1 # 0 means it is turned off
# according to lastfm documentation
# autocorrect[0|1] (Optional) : Transform misspelled artist names into correct artist names, returning the correct version instead.
# Mappings
#
# Mapping works in the following way:
# Function: [ firstMapping, secondMapping, thirdMapping, ...... ]
# for e.g
togglePlayBack : [ "p", "SPACE", "]" ] # using the quotes is neccessary.
# all the three keys now have the same function.
# To see Availabe Keys and Functions : https://github.com/aditya-K2/goMP#key-mappings
# Caching
#
# The Covert arts that are extracted from the file or downloaded from lastfm are cached.
# It Is neccessary to define a cache directory to store all the cover arts.
# The Caching works as follows
# 1. Check if there is an embedded cover art if not then 2
# 2. Check if lastfm has album art if not then 3
# 3. Fallback to the default image.
#
#
CACHE_DIR : "/path/to/the/cache/Directory" # for e.g "~/.config/goMP/cache/" Please Note that adding a / at the end is neccessary.
# You will have to manually create this directory.
CACHE_FILE : "/path/to/the/cache/file" # Cache file stores the path to all the images ( think of it like a database. )
# Soon will be deprecated.