lossy-music-mirror v0.2.0

lossy-music-mirror

Create a lossy mirror of your lossless music library.

Usage

Prerequisites

In order to use the package, node (tested with version 8 and higher), npm and ffmpeg are required.

Installation

The package is installed by issuing the following command:

npm install -g lossy-music-mirror

Usage

For minimal usage the output path is required. Then the input directory will be the directory you are currently positioned in. For example, the following command will transcode every lossless file (of codec Flac, Ape, Apple lossless, WMA lossless, WavPack or TrueAudio) in the source directory (and its subdirectories) into vorbis and output the resulting files in /home/output keeping the directory and file structure of the source:

lossy-music-mirror /home/output

All the available options are:

usage: lossy-music-mirror [-h] [-v] [-q QUALITY] [-i INPUT]
                          [-c {vorbis,mp3,opus}] [--delete]
                          output

Positional arguments:
  output                The output directory path

Optional arguments:
  -h, --help            Show this help message and exit.
  -v, --version         Show program's version number and exit.
  -q QUALITY, --quality QUALITY
                        The output quality (0-10 [default = 3] for vorbis, 
                        0-9 [default = 4] (lower value is higher quality) for 
                        mp3 or 500-256000 [default = 64000] for opus
  -i INPUT, --input INPUT
                        The input directory path [default = ./]
  -c {vorbis,mp3,opus}, --codec {vorbis,mp3,opus}
                        The output codec [default = vorbis]
  --delete              Delete files in output that does not have a 
                        corresponding lossless file in input

Development

Install dependencies

node (at least version 8), npm and ffmpeg are required. The remaining dependencies is installed by running

npm install

in the source directory.

Build

The project is built by issuing:

npm run compile

Running the tests

The following command will compile the project, run all the tests and display the resulting code coverage report:

npm test

Contributing

If you find any issues, or have any feature suggestions, please add an issue on github.

If you want to contribute to this repository, please make a pull request on the develop branch. In order to increase the chance that the pull request will be accepted, please see if the change is requested in the issue list and/or contact the repository owner before implementing the change.

Authors

• Samuel Nilsson - Initial work - samuelnilsson

License

This project is licensed under the MIT License - see the LICENSE file for details