Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
103 lines (73 loc) · 3.06 KB

GETTING_STARTED.md

File metadata and controls

103 lines (73 loc) · 3.06 KB

Getting started with hrmp

First of all, make sure that hrmp is installed and in your path by using hrmp -?. You should see

hrmp 0.16.0
  High resolution music player

Usage:
  hrmp <FILES>

Options:
  -c, --config CONFIG_FILE   Set the path to the hrmp.conf file
                             Default: $HOME/.hrmp/hrmp.conf
  -D, --device               Set the device name
  -p, --playlist PLAYLIST    Load files/directories from a playlist file (.hrmp)
  -R, --recursive            Add files recursive of the directory
  -M, --mode MODE            Playback mode: once, repeat, shuffle
  -C, --convert              Convert .dsf files to 24bit .flac
  -I, --sample-configuration Generate a sample configuration
  -i, --interactive          Text UI mode
  -m, --metadata             Display metadata of the files
  -e, --extract              Extract ISO file
  -s, --status               Status of the devices
      --dop                  Use DSD over PCM
  -q, --quiet                Quiet the player
  -V, --version              Display version information
  -?, --help                 Display help

hrmp: https://hrmp.github.io/
Report bugs: https://github.com/HighResMusicPlayer/hrmp/issues

If you don't have hrmp in your path see README on how to compile and install hrmp in your system.

Configuration

Lets create a simple configuration file called hrmp.conf with the content generated by hrmp -I which will look like

[hrmp]

device=FIIO K19

log_type = file
log_level = info
log_path = /tmp/hrmp.log

[FIIO K19]
device=iec958:CARD=K19,DEV=0
description=USB Audio IEC958 (S/PDIF) Digital Audio Output

In our main section called [hrmp] we setup logging will be performed at info level and put in a file called /tmp/hrmp.log. The default device will be "FIIO K19".

Next we create a section called [FIIO K19] which has the information about our device with its device address.

We are now ready to run hrmp.

See Configuration for all configuration options.

Running

We will run hrmp using the command

hrmp -c hrmp.conf <directory|files>

To convert DSF files to 24-bit FLAC at the matching PCM rate instead of playing them:

hrmp -C my-track.dsf

See CLI for all key commands.

The default configuration of hrmp is loaded from ~/.hrmp/hrmp.conf.

Closing

The hrmp community hopes that you find the project interesting.

Feel free to

All contributions are most welcome !

Please, consult our Code of Conduct policies for interacting in our community.

Consider giving the project a star on GitHub if you find it useful.