Skip to content

Commit 8d7bf2e

Browse files
committed
update README
1 parent d68dd31 commit 8d7bf2e

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,45 @@
1-
# python-flac-to-wav-audioconverter
1+
# Rekordbox Audio Converter
2+
This is a python audio converter that uses ffmpeg to convert audio files from one format to Rekordbox audio formats (as listed here: https://cdn.rekordbox.com/files/20210302175909/rekordbox6.4.2_introduction_de.pdf [p.23]). Currently the converter is only configured to convert to:
3+
* WAV
4+
* AIFF
5+
6+
But those are the main formats I see as important anyway.
7+
Other formats can be added in the `audio_converter.py` AudioConverter class
8+
This is how the config looks like:
9+
```
10+
self.allowed_formats = ['aiff', 'wav']
11+
self.allowed_quality = ['normal', 'high']
12+
self.ffmpeg_type_arguments = {
13+
"aiff_normal": {
14+
"codec": 'pcm_s16be',
15+
"sampling_rate": '44100',
16+
"bit_rate": None,
17+
"custom": [],
18+
},
19+
"aiff_high": {
20+
"codec": 'pcm_s24be',
21+
"sampling_rate": '96000',
22+
"bit_rate": None,
23+
"custom": [],
24+
},
25+
...
26+
}
27+
```
28+
29+
* `allowed_formats` are the out formats
30+
* `allowed_quality` is the output quality
31+
* `ffmpeg_type_arguments` are the ffmpeg arguments for audio codec, sampling rate, bit rate and other custom ffmpeg arguments. The key of an configuration should be: `"<OUT_FILE_TYPE>_<OUT_QUALITY>"`. So in this example the file type aiff with settings for normal and high quality is configured
232

333
## Prerequisites
4-
The Python scripts are made to run on windows devices only!
34+
The Python scripts are made to run on windows devices only, but may work on other OS too (did not test).
535

6-
If you have not installed **ffmpeg** then do so, because it is required. Also don't forget to add it to you PATH environment variables.
36+
If you have not installed **ffmpeg** then do so, because it is required. Also don't forget to add it to your PATH environment variables.
737

838
## Setup
39+
### First Steps
940
1. run `install_requirements.bat` to install required python packages
10-
2. run `make_spec.bat` to create a spec file with pyinstaller (if you want the config file to be copied automatically, please read the instructions in the make_spec batch script!, otherwise you can copy the `config.ini` file manually into the folder where the executable will be build)
11-
3. run `build.bat` to build the executable from the spec file
41+
2. run `make_spec.bat` to create a spec file with pyinstaller
42+
3. run `build.bat` to build the executable from the spec file
43+
44+
### Build
45+
execute step 3 of previous chapter

0 commit comments

Comments
 (0)