Trez/docker-mods-uptime-kuma-timeout-fix
4
0
Fork 0
mirror of https://github.com/TrezOne/docker-mods-uptime-kuma-timeout-fix.git synced 2026-07-18 08:48:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #751 from TheCaptain989/lidarr-flac2mp3

Browse Source 
Lidarr: flac2mp3 Release 2.3
This commit is contained in:
aptalca
2023-09-02 15:48:57 -04:00
committed by GitHub
parent 3dca0f6e65 7c16d430d4
commit 34326056f0
4 changed files with 465 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Dockerfile
+4 -1
View File
@@ -1,11 +1,14 @@
# syntax=docker/dockerfile:1 # syntax=docker/dockerfile:1
## Buildstage ##
FROM ghcr.io/linuxserver/baseimage-alpine:3.17 as buildstage FROM ghcr.io/linuxserver/baseimage-alpine:3.17 as buildstage
ARG MOD_VERSION ARG MOD_VERSION
# copy local files
COPY root/ /root-layer/ COPY root/ /root-layer/
# Add version to script
RUN \ RUN \
MOD_VERSION="${MOD_VERSION:-unknown}" && \ MOD_VERSION="${MOD_VERSION:-unknown}" && \
sed -i -e "s/{{VERSION}}/$MOD_VERSION/" \ sed -i -e "s/{{VERSION}}/$MOD_VERSION/" \
@@ -17,5 +20,5 @@ FROM scratch
LABEL maintainer="TheCaptain989" LABEL maintainer="TheCaptain989"
# Copy local files # Add files from buildstage
COPY --from=buildstage /root-layer/ / COPY --from=buildstage /root-layer/ /
README.md
+19 -19
View File
@@ -5,20 +5,20 @@ A [Batch Mode](./README.md#batch-mode) is also supported that allows usage outsi
>**NOTE:** This mod supports Linux OSes only. >**NOTE:** This mod supports Linux OSes only.
Production Container info: ![Docker Image Size](https://img.shields.io/docker/image-size/linuxserver/mods/lidarr-flac2mp3 "Container Size")
Development Container info: Development Container info:
![Docker Image Size](https://img.shields.io/docker/image-size/thecaptain989/lidarr-flac2mp3 "Container Size") ![Docker Image Size](https://img.shields.io/docker/image-size/thecaptain989/lidarr-flac2mp3 "Container Size")
![Docker Pulls](https://img.shields.io/docker/pulls/thecaptain989/lidarr-flac2mp3 "Container Pulls") ![Docker Pulls](https://img.shields.io/docker/pulls/thecaptain989/lidarr-flac2mp3 "Container Pulls")
Production Container info: ![Docker Image Size](https://img.shields.io/docker/image-size/linuxserver/mods/lidarr-flac2mp3 "Container Size")
# Installation # Installation
1. Pull the [linuxserver/lidarr](https://hub.docker.com/r/linuxserver/lidarr "LinuxServer.io's Lidarr container") docker image from Docker Hub: 1. Pull the [linuxserver/lidarr](https://hub.docker.com/r/linuxserver/lidarr "LinuxServer.io's Lidarr container") docker image from GitHub Container Registry or Docker Hub:
`docker pull linuxserver/lidarr:latest` `docker pull lscr.io/linuxserver/lidarr:latest`
2. Configure the Docker container with all the port, volume, and environment settings from the *original container documentation* here: 2. Configure the Docker container with all the port, volume, and environment settings from the *original container documentation* here:
**[linuxserver/lidarr](https://hub.docker.com/r/linuxserver/lidarr "Docker container")** **[linuxserver/lidarr](https://hub.docker.com/r/linuxserver/lidarr "Docker container")**
1. Add a **DOCKER_MODS** environment variable to the `docker run` command, as follows: 1. Add a **DOCKER_MODS** environment variable to the `docker run` command, as follows:
- Dev/test release: `-e DOCKER_MODS=thecaptain989/lidarr-flac2mp3:latest`
- Stable release: `-e DOCKER_MODS=linuxserver/mods:lidarr-flac2mp3` - Stable release: `-e DOCKER_MODS=linuxserver/mods:lidarr-flac2mp3`
- Dev/test release: `-e DOCKER_MODS=thecaptain989/lidarr-flac2mp3:latest`
*Example Docker CLI Configuration* *Example Docker CLI Configuration*
```shell ```shell
@@ -33,7 +33,7 @@ Production Container info: ![Docker Image Size](https://img.shields.io/docker/im
-v /path/to/music:/music \ -v /path/to/music:/music \
-v /path/to/downloads:/downloads \ -v /path/to/downloads:/downloads \
--restart unless-stopped \ --restart unless-stopped \
ghcr.io/linuxserver/lidarr lscr.io/linuxserver/lidarr
``` ```
*Example Synology Configuration* *Example Synology Configuration*
@@ -72,15 +72,15 @@ Where:
Option|Argument|Description Option|Argument|Description
---|---|--- ---|---|---
-d, --debug|\[\<level\>\]|Enables debug logging. Level is optional.<br/>Default of 1 (low).<br/>2 includes API and FFmpeg output. -d, --debug|\[\<level\>\]|Enables debug logging. Level is optional.<br/>Default of 1 (low).<br/>2 includes JSON and FFmpeg output.<br/>3 contains even more JSON output.
-b, --bitrate|\<bitrate\>|Sets the output quality in constant bits per second (CBR).<br/>Examples: 160k, 240k, 300000<br/>**Note:** May not be specified with `-v`, `-a`, or `-e`. -b, --bitrate|\<bitrate\>|Sets the output quality in constant bits per second (CBR).<br/>Examples: 160k, 240k, 300000<br/>**Note:** May not be specified with `-v`, `-a`, or `-e`.
-v, --quality|\<quality\>|Sets the output variable bit rate (VBR).<br/>Specify a value between 0 and 9, with 0 being the highest quality.<br/>See the [FFmpeg MP3 Encoding Guide](https://trac.ffmpeg.org/wiki/Encode/MP3) for more details.<br/>**Note:** May not be specified with `-b`, `-a`, or `-e`. -v, --quality|\<quality\>|Sets the output variable bit rate (VBR).<br/>Specify a value between 0 and 9, with 0 being the highest quality.<br/>See the [FFmpeg MP3 Encoding Guide](https://trac.ffmpeg.org/wiki/Encode/MP3) for more details.<br/>**Note:** May not be specified with `-b`, `-a`, or `-e`.
-a, --advanced|\"\<options\>\"|Advanced ffmpeg options.<br/>The specified `options` replace all script defaults and are sent directly to ffmpeg.<br/>The `options` value must be enclosed in quotes.<br/>See [FFmpeg Options](https://ffmpeg.org/ffmpeg.html#Options) for details on valid options, and [Guidelines for high quality audio encoding](https://trac.ffmpeg.org/wiki/Encode/HighQualityAudio) for suggested usage.<br/>**Note:** Requires the `-e` option to also be specified. May not be specified with `-v` or `-b`.<br/>![warning] **WARNING:** You must specify an audio codec (by including a `-c:a <codec>` ffmpeg option) or the resulting file will contain no audio!<br/>![warning] **WARNING:** Invalid `options` could result in script failure! -a, --advanced|\"\<options\>\"|Advanced ffmpeg options.<br/>The specified `options` replace all script defaults and are sent directly to ffmpeg.<br/>The `options` value must be enclosed in quotes.<br/>See [FFmpeg Options](https://ffmpeg.org/ffmpeg.html#Options) for details on valid options, and [Guidelines for high quality audio encoding](https://trac.ffmpeg.org/wiki/Encode/HighQualityAudio) for suggested usage.<br/>**Note:** Requires the `-e` option to also be specified. May not be specified with `-v` or `-b`.<br/>![warning] **WARNING:** You must specify an audio codec (by including a `-c:a <codec>` ffmpeg option) or the resulting file will contain no audio!<br/>![warning] **WARNING:** Invalid `options` could result in script failure!
-e, --extension|\<extension\>|Sets the output file extension.<br/>The extension may be prefixed by a dot (".") or not.<br/>Example: .ogg<br/>**Note:** Requires the `-a` option to also be specified. May not be specified with `-v` or `-b`. -e, --extension|\<extension\>|Sets the output file extension.<br/>The extension may be prefixed by a dot (".") or not.<br/>Example: .ogg<br/>**Note:** Requires the `-a` option to also be specified. May not be specified with `-v` or `-b`.
-f, --file|<audio_file>|If included, the script enters **[Batch Mode](./README.md#batch-mode)** and converts the specified audio file.<br/>![warning] **WARNING:** Do not use this argument when called from Lidarr! -f, --file|<audio_file>|If included, the script enters **[Batch Mode](./README.md#batch-mode)** and converts the specified audio file.<br/>![warning] **WARNING:** Do not use this argument when called from Lidarr!
-o, --output|\<directory\>|Converted audio file(s) are saved to `directory` instead of being located in the same directory as the source audio file.<br/>The path will be created if it does not exist. -o, --output|\<directory\>|Converted audio file(s) are saved to `directory` instead of being located in the same directory as the source audio file.<br/>The path will be created if it does not exist.
-k, --keep-file| |Do not delete the source file or move it to the Lidarr Recycle bin.<br/>**Note:** This also disables triggering a Lidarr rescan after conversion. -k, --keep-file| |Do not delete the source file or move it to the Lidarr Recycle bin.<br/>**Note:** This also disables importing the new files into Lidarr after conversion.
-r, --regex|'\<regex\>'|Sets the regular expression used to select input files.<br/>The `regex` value should be enclosed in single quotes and escaped properly.<br/>Defaults to `"\.flac$"`. -r, --regex|'\<regex\>'|Sets the regular expression used to select input files.<br/>The `regex` value should be enclosed in single quotes and escaped properly.<br/>Defaults to `[.]flac$`.
-t, --tags|\<taglist\>|Comma separated list of metadata tags to apply automated corrections to.<br/>See [Metadata Corrections](./README.md#metadata-corrections) section. -t, --tags|\<taglist\>|Comma separated list of metadata tags to apply automated corrections to.<br/>See [Metadata Corrections](./README.md#metadata-corrections) section.
--help| |Display help and exit. --help| |Display help and exit.
--version| |Display version and exit. --version| |Display version and exit.
@@ -100,11 +100,11 @@ By default, the script only matches and interacts with FLAC files (specifically,
Files are passed to the script with the full Linux path intact. (Ex: `/path/to/audio/a-ha/Hunting High and Low/01 Take on Me.mp3`). Craft your regex with this in mind. Files are passed to the script with the full Linux path intact. (Ex: `/path/to/audio/a-ha/Hunting High and Low/01 Take on Me.mp3`). Craft your regex with this in mind.
![warning] **NOTE:** Escaping special regex characters (like a dot `.`) requires a double backslash, _even when single quoted!_ This is because **awk** (the program that processes audio files in the script) in most cases [strips a single backslash](https://www.gnu.org/software/gawk/manual/html_node/Escape-Sequences.html "GNU awk reference") from strings. Double quoted or unquoted strings require _four_ backslashes to preserve a regex escape because the bash shell will process the escapes first. ![warning] **NOTE:** Escaping special regex characters (like a dot `.`) requires a double backslash or a character class. A character class (i.e. `[.]`) is recommended because backslashes can be stripped by the bash shell and getting this right can be confusing.
For example, to convert all audio files to AAC audio files, use the following options: For example, to convert all audio files to AAC audio files, use the following options:
``` ```
-a "-y -map 0 -c:a aac -b:a 240k -c:v copy" -e m4a --regex '\\.[^.]*$' -a "-y -map 0 -c:a aac -b:a 240k -c:v copy" -e m4a --regex '[.][^.]*$'
``` ```
Regular expression syntax is beyond the scope of this document. See this [tutorial](https://www.regular-expressions.info/tutorial.html "Regular Expressions Tutorial") for more information. Regex patterns may be tested [here](http://regexstorm.net/tester "regex tester"). Regular expression syntax is beyond the scope of this document. See this [tutorial](https://www.regular-expressions.info/tutorial.html "Regular Expressions Tutorial") for more information. Regex patterns may be tested [here](http://regexstorm.net/tester "regex tester").
@@ -114,13 +114,13 @@ Regular expression syntax is beyond the scope of this document. See this [tutor
-b 320k # Output 320 kbit/s MP3 (non-VBR; same as default behavior) -b 320k # Output 320 kbit/s MP3 (non-VBR; same as default behavior)
-v 0 # Output variable bitrate MP3, VBR 220-260 kbit/s -v 0 # Output variable bitrate MP3, VBR 220-260 kbit/s
-d -b 160k # Enable debugging level 1, and output a 160 kbit/s MP3 -d -b 160k # Enable debugging level 1, and output a 160 kbit/s MP3
-r '\\.[^.]*$' # Convert any file to MP3 (not just FLAC) -r '[.][^.]*$' # Convert any file to MP3 (not just FLAC)
-a "-c:v libtheora -map 0 -q:v 10 -c:a libopus -b:a 192k" -e .opus -a "-c:v libtheora -map 0 -q:v 10 -c:a libopus -b:a 192k" -e .opus
# Convert to Opus format, 192 kbit/s, cover art # Convert to Opus format, 192 kbit/s, cover art
-a "-vn -c:a libopus -b:a 192K" -e .opus -r '\.mp3$' -a "-vn -c:a libopus -b:a 192K" -e .opus -r '[.]mp3$'
# Convert .mp3 files to Opus format, 192 kbit/s, no cover art # Convert .mp3 files to Opus format, 192 kbit/s, no cover art
-a "-y -map 0 -c:a aac -b:a 240k -c:v copy" -e mp4 -a "-y -map 0 -c:a aac -b:a 240k -c:v copy" -e m4a
# Convert to MP4 format, using AAC 240 kbit/s audio, cover art, overwrite file # Convert to M4A format, using AAC 240 kbit/s audio, cover art, overwrite file
--file "/path/to/audio/a-ha/Hunting High and Low/01 Take on Me.flac" --file "/path/to/audio/a-ha/Hunting High and Low/01 Take on Me.flac"
# Batch Mode # Batch Mode
# Output 320kbit/s MP3 # Output 320kbit/s MP3
@@ -161,14 +161,14 @@ The `flac2mp3.sh` script also allows the use of arguments provided by the `FLAC2
For example, the following value would convert any .mp3 to Opus: For example, the following value would convert any .mp3 to Opus:
``` ```
-e FLAC2MP3_ARGS='-a "-vn -c:a libopus -b:a 192k" -e .opus -r "\\.mp3$"' -e FLAC2MP3_ARGS='-a "-vn -c:a libopus -b:a 192k" -e .opus -r "[.]mp3$"'
``` ```
Make sure to correctly use quotes and/or escape special characters when using this method. (See [regex notes](./README.md#technical-notes-on-regex) above.) Make sure to correctly use quotes and/or escape special characters when using this method. (See [regex notes](./README.md#technical-notes-on-regex) above.)
In Docker Compose, the previous command would need an extra `$` to match the end-of-line: In Docker Compose, the previous command would need an extra `$` to match the end-of-line:
```yaml ```yaml
environment: environment:
- FLAC2MP3_ARGS=-a "-vn -c:a libopus -b:a 192k" -e .opus -r '\\.mp3$$' - FLAC2MP3_ARGS=-a "-vn -c:a libopus -b:a 192k" -e .opus -r '[.]mp3$$'
``` ```
*Example Synology Configuration* *Example Synology Configuration*
@@ -187,7 +187,7 @@ Using this function, you can easily process all of your audio files in any subdi
#### Script Execution Differences in Batch Mode #### Script Execution Differences in Batch Mode
Because the script is not called from within Lidarr, expect the following behavior while in Batch Mode: Because the script is not called from within Lidarr, expect the following behavior while in Batch Mode:
* *The file name must be specified on the command line*<br/>(The `-f` option places the script in Batch Mode) * *The file name must be specified on the command line*<br/>(The `-f` option places the script in Batch Mode)
* *Lidarr APIs are not called and its database is not updated.*<br/>This may require a manual rescan of converted music files. * *Lidarr APIs are not called and its database is not updated.*<br/>This may require a manual import of converted music files or an artist rescan.
* *Original audio files are deleted.*<br/>The Recycle Bin function is not available. (Modifiable using the `-k` option.) * *Original audio files are deleted.*<br/>The Recycle Bin function is not available. (Modifiable using the `-k` option.)
#### Batch Example #### Batch Example
@@ -226,7 +226,7 @@ This would not be possible without the following:
[Lidarr](https://lidarr.audio/ "Lidarr homepage") [Lidarr](https://lidarr.audio/ "Lidarr homepage")
[LinuxServer.io Lidarr](https://hub.docker.com/r/linuxserver/lidarr "Lidarr Docker container") container [LinuxServer.io Lidarr](https://hub.docker.com/r/linuxserver/lidarr "Lidarr Docker container") container
[LinuxServer.io Docker Mods](https://hub.docker.com/r/linuxserver/mods "Docker Mods containers") project [LinuxServer.io Docker Mods](https://github.com/linuxserver/docker-mods "Docker Mods containers") project
[ffmpeg](https://ffmpeg.org/ "FFmpeg homepage") [ffmpeg](https://ffmpeg.org/ "FFmpeg homepage")
Icons made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com/) Icons made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com/)
SECURITY.md
+2 -2
View File
@@ -6,8 +6,8 @@ Only the latest major and minor version are supported.
| Version | Supported | | Version | Supported |
| ------- | ------------------ | | ------- | ------------------ |
| 2.2.x | :heavy_check_mark: | | 2.3.x | :heavy_check_mark: |
| < 2.2 | :x: | | < 2.3 | :x: |
## Reporting a Vulnerability ## Reporting a Vulnerability
root/usr/local/bin/flac2mp3.sh
+440 -265
View File
@@ -16,6 +16,7 @@
# basename # basename
# printenv # printenv
# chmod # chmod
# tr
# Exit codes: # Exit codes:
# 0 - success; or test # 0 - success; or test
@@ -25,7 +26,15 @@
# 5 - specified audio file not found # 5 - specified audio file not found
# 6 - error when creating output directory # 6 - error when creating output directory
# 7 - unknown eventtype environment variable # 7 - unknown eventtype environment variable
# 10 - awk script generated an error # 10 - a general error occurred in file conversion loop; check log
# 11 - source and destination have the same file name
# 12 - ffprobe returned an error
# 13 - ffmpeg returned an error
# 14 - the new file could not be found or is zero bytes
# 15 - could not set permissions and/or owner on new file
# 16 - could not delete the original file
# 17 - Lidarr API error
# 18 - Lidarr job timeout
# 20 - general error # 20 - general error
### Variables ### Variables
@@ -103,14 +112,14 @@ Examples:
kbit/s kbit/s
$flac2mp3_script -d -b 160k # Enable debugging level 1 and output a $flac2mp3_script -d -b 160k # Enable debugging level 1 and output a
160 kbit/s MP3 160 kbit/s MP3
$flac2mp3_script -r '\\\\.[^.]*$' # Convert any file to MP3 (not just FLAC) $flac2mp3_script -r '\\\\.[^.]*\$' # Convert any file to MP3 (not just FLAC)
$flac2mp3_script -a \"-c:v libtheora -map 0 -q:v 10 -c:a libopus -b:a 192k\" -e .opus $flac2mp3_script -a \"-c:v libtheora -map 0 -q:v 10 -c:a libopus -b:a 192k\" -e .opus
# Convert to Opus format, 192 kbit/s, cover art # Convert to Opus format, 192 kbit/s, cover art
$flac2mp3_script -a \"-vn -c:a libopus -b:a 192K\" -e .opus -r '\.mp3$' $flac2mp3_script -a \"-vn -c:a libopus -b:a 192K\" -e .opus -r '\.mp3\$'
# Convert .mp3 files to Opus format, 192 kbit/s # Convert .mp3 files to Opus format, 192 kbit/s
no cover art no cover art
$flac2mp3_script -a \"-y -map 0 -c:a aac -b:a 240K -c:v copy\" -e mp4 $flac2mp3_script -a \"-y -map 0 -c:a aac -b:a 240K -c:v copy\" -e m4a
# Convert to MP4 format, using AAC 240 kbit/s # Convert to M4A format, using AAC 240 kbit/s
audio, cover art, overwrite file audio, cover art, overwrite file
$flac2mp3_script -f \"/path/to/audio/a-ha/Hunting High and Low/01 Take on Me.flac\" $flac2mp3_script -f \"/path/to/audio/a-ha/Hunting High and Low/01 Take on Me.flac\"
# Batch Mode # Batch Mode
@@ -145,15 +154,15 @@ while (( "$#" )); do
export flac2mp3_debug=1 export flac2mp3_debug=1
shift shift
fi fi
;; ;;
--help ) # Display usage --help ) # Display usage
usage usage
exit 0 exit 0
;; ;;
--version ) # Display version --version ) # Display version
echo "$flac2mp3_script $flac2mp3_ver" echo "$flac2mp3_script $flac2mp3_ver"
exit 0 exit 0
;; ;;
-f|--file ) # Batch Mode -f|--file ) # Batch Mode
if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then
# Overrides detected *_eventtype # Overrides detected *_eventtype
@@ -165,7 +174,7 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
;; ;;
-b|--bitrate ) # Set constant bit rate -b|--bitrate ) # Set constant bit rate
if [ -n "$flac2mp3_vbrquality" ]; then if [ -n "$flac2mp3_vbrquality" ]; then
echo "Error|Both -b and -v options cannot be set at the same time." >&2 echo "Error|Both -b and -v options cannot be set at the same time." >&2
@@ -183,7 +192,7 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
;; ;;
-v|--quality ) # Set variable quality -v|--quality ) # Set variable quality
if [ -n "$flac2mp3_bitrate" ]; then if [ -n "$flac2mp3_bitrate" ]; then
echo "Error|Both -v and -b options cannot be set at the same time." >&2 echo "Error|Both -v and -b options cannot be set at the same time." >&2
@@ -201,7 +210,7 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
;; ;;
-a|--advanced ) # Set advanced options -a|--advanced ) # Set advanced options
if [ -n "$flac2mp3_vbrquality" -o -n "$flac2mp3_bitrate" ]; then if [ -n "$flac2mp3_vbrquality" -o -n "$flac2mp3_bitrate" ]; then
echo "Error|The -a and -e options cannot be set at the same time as either -v or -b options." >&2 echo "Error|The -a and -e options cannot be set at the same time as either -v or -b options." >&2
@@ -215,7 +224,7 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
;; ;;
-e|--extension ) # Set file extension -e|--extension ) # Set file extension
if [ -n "$flac2mp3_vbrquality" -o -n "$flac2mp3_bitrate" ]; then if [ -n "$flac2mp3_vbrquality" -o -n "$flac2mp3_bitrate" ]; then
echo "Error|The -a and -e options cannot be set at the same time as either -v or -b options." >&2 echo "Error|The -a and -e options cannot be set at the same time as either -v or -b options." >&2
@@ -231,7 +240,7 @@ while (( "$#" )); do
fi fi
# Test for dot prefix # Test for dot prefix
[ "${flac2mp3_extension:0:1}" != "." ] && flac2mp3_extension=".${flac2mp3_extension}" [ "${flac2mp3_extension:0:1}" != "." ] && flac2mp3_extension=".${flac2mp3_extension}"
;; ;;
-o|--output ) # Set output directory -o|--output ) # Set output directory
if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then
export flac2mp3_output="$2" export flac2mp3_output="$2"
@@ -241,13 +250,13 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
# Test for trailing backslash # Test for trailing slash
[ "${flac2mp3_output: -1:1}" != "/" ] && flac2mp3_output="${flac2mp3_output}/" [ "${flac2mp3_output: -1:1}" != "/" ] && flac2mp3_output="${flac2mp3_output}/"
;; ;;
-k|--keep-file ) # Do not delete source file(s) -k|--keep-file ) # Do not delete source file(s)
export flac2mp3_keep=1 export flac2mp3_keep=1
shift shift
;; ;;
-r|--regex ) # Sets the regex used to match input files -r|--regex ) # Sets the regex used to match input files
if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then
export flac2mp3_regex="$2" export flac2mp3_regex="$2"
@@ -257,7 +266,7 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
;; ;;
-t|--tags ) # Metadata tags to correct -t|--tags ) # Metadata tags to correct
if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then if [ -n "$2" ] && [ ${2:0:1} != "-" ]; then
export flac2mp3_tags="$2" export flac2mp3_tags="$2"
@@ -267,15 +276,15 @@ while (( "$#" )); do
usage usage
exit 3 exit 3
fi fi
;; ;;
-*|--*=) # Unknown option -*|--*=) # Unknown option
echo "Error|Unknown option: $1" >&2 echo "Error|Unknown option: $1" >&2
usage usage
exit 20 exit 20
;; ;;
*) # Remove unknown positional parameters *) # Remove unknown positional parameters
shift shift
;; ;;
esac esac
done done
@@ -289,6 +298,9 @@ fi
# Set default bit rate # Set default bit rate
[ -z "$flac2mp3_vbrquality" -a -z "$flac2mp3_bitrate" -a -z "$flac2mp3_ffmpegadv" -a -z "$flac2mp3_extension" ] && flac2mp3_bitrate="320k" [ -z "$flac2mp3_vbrquality" -a -z "$flac2mp3_bitrate" -a -z "$flac2mp3_ffmpegadv" -a -z "$flac2mp3_extension" ] && flac2mp3_bitrate="320k"
# Set default new track extension
flac2mp3_extension="${flac2mp3_extension:-.mp3}"
## Mode specific variables ## Mode specific variables
if [[ "${flac2mp3_type,,}" = "batch" ]]; then if [[ "${flac2mp3_type,,}" = "batch" ]]; then
# Batch mode # Batch mode
@@ -327,50 +339,191 @@ function read_xml {
local IFS=\> local IFS=\>
read -d \< flac2mp3_xml_entity flac2mp3_xml_content read -d \< flac2mp3_xml_entity flac2mp3_xml_content
} }
# Initiate API Rescan request # Check Lidarr version
function rescan { function get_version {
flac2mp3_message="Info|Calling Lidarr API to rescan artist" local url="$flac2mp3_api_url/system/status"
echo "$flac2mp3_message" | log [ $flac2mp3_debug -ge 1 ] && echo "Debug|Getting Lidarr version. Calling Lidarr API using GET and URL '$url'" | log
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Forcing rescan of artist '$lidarr_artist_id'. Calling Lidarr API 'RefreshArtist' using POST and URL '$flac2mp3_api_url/command'" | log unset flac2mp3_result
flac2mp3_result=$(curl -s -H "X-Api-Key: $flac2mp3_apikey" \ flac2mp3_result=$(curl -s --fail-with-body -H "X-Api-Key: $flac2mp3_apikey" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d "{\"name\": \"RefreshArtist\", \"artistId\": $lidarr_artist_id}" \ -H "Accept: application/json" \
-X POST "$flac2mp3_api_url/command") --get "$url")
local flac2mp3_curlret=$?; [ $flac2mp3_curlret -ne 0 ] && {
local flac2mp3_message=$(echo -e "[$flac2mp3_curlret] curl error when calling: \"$url\"\nWeb server returned: $(echo $flac2mp3_result | jq -crM .message?)" | awk '{print "Error|"$0}')
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log [ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
flac2mp3_jobid="$(echo $flac2mp3_result | jq -crM .id)" if [ "$(echo $flac2mp3_result | jq -crM '.version?')" != "null" ]; then
if [ "$flac2mp3_jobid" != "null" ]; then
local flac2mp3_return=0 local flac2mp3_return=0
else else
local flac2mp3_return=1 local flac2mp3_return=1
fi fi
return $flac2mp3_return return $flac2mp3_return
} }
# Check result of rescan job # Check result of command job
function check_rescan { function check_job {
# Exit codes:
# 0 - success
# 1 - queued
# 2 - failed
# 3 - loop timed out
# 10 - curl error
local i=0 local i=0
local url="$flac2mp3_api_url/command/$flac2mp3_jobid"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Checking job $flac2mp3_jobid completion. Calling Lidarr API using GET and URL '$url'" | log
for ((i=1; i <= 15; i++)); do for ((i=1; i <= 15; i++)); do
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Checking job $flac2mp3_jobid completion, try #$i. Calling Lidarr API using GET and URL '$flac2mp3_api_url/command/$flac2mp3_jobid'" | log unset flac2mp3_result
flac2mp3_result=$(curl -s -H "X-Api-Key: $flac2mp3_apikey" \ flac2mp3_result=$(curl -s --fail-with-body -H "X-Api-Key: $flac2mp3_apikey" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-X GET "$flac2mp3_api_url/command/$flac2mp3_jobid") -H "Accept: application/json" \
--get "$url")
local flac2mp3_curlret=$?; [ $flac2mp3_curlret -ne 0 ] && {
local flac2mp3_message=$(echo -e "[$flac2mp3_curlret] curl error when calling: \"$url\"\nWeb server returned: $(echo $flac2mp3_result | jq -crM .message?)" | awk '{print "Error|"$0}')
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
local flac2mp3_return=10
break
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log [ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
# Guard clauses
if [ "$(echo $flac2mp3_result | jq -crM .status)" = "failed" ]; then
local flac2mp3_return=2
break
fi
if [ "$(echo $flac2mp3_result | jq -crM .status)" = "queued" ]; then
local flac2mp3_return=1
break
fi
if [ "$(echo $flac2mp3_result | jq -crM .status)" = "completed" ]; then if [ "$(echo $flac2mp3_result | jq -crM .status)" = "completed" ]; then
local flac2mp3_return=0 local flac2mp3_return=0
break break
else
if [ "$(echo $flac2mp3_result | jq -crM .status)" = "failed" ]; then
local flac2mp3_return=2
break
else
# It may have timed out, so let's wait a second
local flac2mp3_return=1
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Job not done. Waiting 1 second." | log
sleep 1
fi
fi fi
# It may have timed out, so let's wait a second
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Job not done. Waiting 1 second." | log
local flac2mp3_return=3
sleep 1
done done
return $flac2mp3_return return $flac2mp3_return
} }
# Get all track files from album
function get_trackfile_info {
local url="$flac2mp3_api_url/trackFile"
local data="albumId=$lidarr_album_id"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Getting track file info for album id $lidarr_album_id. Calling Lidarr API using GET and URL '$url?$data'" | log
unset flac2mp3_result
flac2mp3_result=$(curl -s --fail-with-body -H "X-Api-Key: $flac2mp3_apikey" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d "$data" \
--get "$url")
local flac2mp3_curlret=$?; [ $flac2mp3_curlret -ne 0 ] && {
local flac2mp3_message=$(echo -e "[$flac2mp3_curlret] curl error when calling: \"$url?$data\"\nWeb server returned: $(echo $flac2mp3_result | jq -crM .message?)" | awk '{print "Error|"$0}')
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
if [ $flac2mp3_curlret -eq 0 -a "$(echo $flac2mp3_result | jq -crM '.[].id?')" != "null" ]; then
local flac2mp3_return=0
else
local flac2mp3_return=1
fi
return $flac2mp3_return
}
# Delete track
function delete_track {
local url="$flac2mp3_api_url/trackFile/$1"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Deleting or recycling \"$flac2mp3_track\". Calling Lidarr API using DELETE and URL '$url'" | log
unset flac2mp3_result
flac2mp3_result=$(curl -s --fail-with-body -H "X-Api-Key: $flac2mp3_apikey" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-X DELETE "$url")
local flac2mp3_curlret=$?; [ $flac2mp3_curlret -ne 0 ] && {
local flac2mp3_message=$(echo -e "[$flac2mp3_curlret] curl error when calling: \"$url\"\nWeb server returned: $(echo $flac2mp3_result | jq -crM .message?)" | awk '{print "Error|"$0}')
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
if [ $flac2mp3_curlret -eq 0 ]; then
local flac2mp3_return=0
else
local flac2mp3_return=1
fi
return $flac2mp3_return
}
# Get file details on possible files to import into Lidarr
function get_import_info {
local url="$flac2mp3_api_url/manualimport"
local data="artistId=$lidarr_artist_id&folder=$lidarr_artist_path&filterExistingFiles=true&replaceExistingFiles=false"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Getting list of files that can be imported. Calling Lidarr API using GET and URL '$url?$data'" | log
unset flac2mp3_result
flac2mp3_result=$(curl -s --fail-with-body -H "X-Api-Key: $flac2mp3_apikey" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data-urlencode "artistId=$lidarr_artist_id" \
--data-urlencode "folder=$lidarr_artist_path" \
-d "filterExistingFiles=true" \
-d "replaceExistingFiles=false" \
--get "$url")
local flac2mp3_curlret=$?; [ $flac2mp3_curlret -ne 0 ] && {
local flac2mp3_message=$(echo -e "[$flac2mp3_curlret] curl error when calling: \"$url?$data\"\nWeb server returned: $(echo $flac2mp3_result | jq -crM .message?)" | awk '{print "Error|"$0}')
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 3 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
if [ $flac2mp3_curlret -eq 0 ]; then
local flac2mp3_return=0
else
local flac2mp3_return=1
fi
return $flac2mp3_return
}
# Import new track into Lidarr
function import_tracks {
local url="$flac2mp3_api_url/command"
local data="{\"name\":\"ManualImport\",\"files\":$flac2mp3_json,\"importMode\":\"auto\",\"replaceExistingFiles\":false}"
echo "Info|Calling Lidarr API to import tracks" | log
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Importing $flac2mp3_import_count new files into Lidarr. Calling Lidarr API using POST and URL '$url' with data $data" | log
unset flac2mp3_result
flac2mp3_result=$(curl -s --fail-with-body -H "X-Api-Key: $flac2mp3_apikey" \
--json "{\"name\":\"ManualImport\"," \
--json "\"files\":$flac2mp3_json," \
--json "\"importMode\":\"auto\",\"replaceExistingFiles\":false}" \
"$url")
local flac2mp3_curlret=$?; [ $flac2mp3_curlret -ne 0 ] && {
local flac2mp3_message=$(echo -e "[$flac2mp3_curlret] curl error when calling: \"$url\" with data $data\nWeb server returned: $(echo $flac2mp3_result | jq -crM .message?)" | awk '{print "Error|"$0}')
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
if [ $flac2mp3_curlret -eq 0 -a "$(echo $flac2mp3_result | jq .id?)" != "null" ]; then
local flac2mp3_return=0
else
local flac2mp3_return=1
fi
return $flac2mp3_return
}
# Get track media info from ffprobe
function ffprobe {
[ $flac2mp3_debug -ge 2 ] && echo "Debug|Executing: /usr/bin/ffprobe -hide_banner -loglevel $flac2mp3_ffmpeg_log -print_format json=compact=1 -show_format -show_entries \"format=tags : format_tags=disc,genre\" -i \"$1\"" | log
unset flac2mp3_ffprobe_json
flac2mp3_ffprobe_json=$(/usr/bin/ffprobe -hide_banner -loglevel $flac2mp3_ffmpeg_log -print_format json=compact=1 -show_format -show_entries "format=tags : format_tags=disc,genre" -i "$1")
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] ffprobe error when inspecting track: \"$1\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "ffprobe returned: $flac2mp3_ffprobe_json" | awk '{print "Debug|"$0}' | log
if [ "$flac2mp3_ffprobe_json" != "" ]; then
local flac2mp3_return=0
else
local flac2mp3_return=1
fi
return $flac2mp3_return
}
### End Functions ### End Functions
# Check for required binaries # Check for required binaries
@@ -404,6 +557,15 @@ fi
# Log environment # Log environment
[ $flac2mp3_debug -ge 2 ] && printenv | sort | sed 's/^/Debug|/' | log [ $flac2mp3_debug -ge 2 ] && printenv | sort | sed 's/^/Debug|/' | log
# Handle Lidarr Test event
if [[ "$lidarr_eventtype" = "Test" ]]; then
echo "Info|Lidarr event: $lidarr_eventtype" | log
flac2mp3_message="Info|Script was test executed successfully."
echo "$flac2mp3_message" | log
echo "$flac2mp3_message"
exit 0
fi
# Log Batch mode # Log Batch mode
if [ "$flac2mp3_type" = "batch" ]; then if [ "$flac2mp3_type" = "batch" ]; then
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Switching to batch mode. Input filename: ${flac2mp3_tracks}" | log [ $flac2mp3_debug -ge 1 ] && echo "Debug|Switching to batch mode. Input filename: ${flac2mp3_tracks}" | log
@@ -422,54 +584,25 @@ elif [ -f "$flac2mp3_config" ]; then
[[ $flac2mp3_xml_entity = "ApiKey" ]] && flac2mp3_apikey=$flac2mp3_xml_content [[ $flac2mp3_xml_entity = "ApiKey" ]] && flac2mp3_apikey=$flac2mp3_xml_content
done < $flac2mp3_config done < $flac2mp3_config
# Check for localhost
[[ $flac2mp3_bindaddress = "*" ]] && flac2mp3_bindaddress=localhost [[ $flac2mp3_bindaddress = "*" ]] && flac2mp3_bindaddress=localhost
# Build URL to Lidarr API # Build URL to Lidarr API
flac2mp3_api_url="http://$flac2mp3_bindaddress:$flac2mp3_port$flac2mp3_urlbase/api/v1" flac2mp3_api_url="http://$flac2mp3_bindaddress:$flac2mp3_port$flac2mp3_urlbase/api/v1"
# Check Lidarr version # Check Lidarr version
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Getting Lidarr version. Calling Lidarr API using GET and URL '$flac2mp3_api_url/system/status'" | log if get_version; then
flac2mp3_result=$(curl -s -H "X-Api-Key: $flac2mp3_apikey" \ flac2mp3_version="$(echo $flac2mp3_result | jq -crM .version)"
-H "Content-Type: application/json" \ [ $flac2mp3_debug -ge 1 ] && echo "Debug|Detected Lidarr version $flac2mp3_version" | log
-X GET "$flac2mp3_api_url/system/status") fi
flac2mp3_return=$?; [ "$flac2mp3_return" != 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] curl error when parsing: \"$flac2mp3_api_url/system/status\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
flac2mp3_version="$(echo $flac2mp3_result | jq -crM .version)"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Detected Lidarr version $flac2mp3_version" | log
# Get RecycleBin # Get album trackfile info. Need the IDs to delete the old tracks.
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Getting Lidarr RecycleBin. Calling Lidarr API using GET and URL '$flac2mp3_api_url/config/mediamanagement'" | log if get_trackfile_info; then
flac2mp3_result=$(curl -s -H "X-Api-Key: $flac2mp3_apikey" \ flac2mp3_trackfiles="$flac2mp3_result"
-H "Content-Type: application/json" \ else
-X GET "$flac2mp3_api_url/config/mediamanagement") flac2mp3_message="Warn|Unable to get trackfile info for album ID $lidarr_album_id"
flac2mp3_return=$?; [ "$flac2mp3_return" != 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] curl error when parsing: \"$flac2mp3_api_url/config/mediamanagement\""
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
flac2mp3_recyclebin="$(echo $flac2mp3_result | jq -crM .recycleBin)"
# Test for trailing backslash
[ ${#flac2mp3_recyclebin} -ne 0 -a "${flac2mp3_recyclebin: -1:1}" != "/" ] && flac2mp3_recyclebin="${flac2mp3_recyclebin}/"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Detected Lidarr RecycleBin '$flac2mp3_recyclebin'" | log
# Get root folder path from Artist info
if [ "$lidarr_artist_id" != "" ]; then
flac2mp3_result=$(curl -s -H "X-Api-Key: $flac2mp3_apikey" \
-H "Content-Type: application/json" \
-X GET $flac2mp3_api_url/artist/$lidarr_artist_id)
flac2mp3_return=$?; [ "$flac2mp3_return" != 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] curl error when parsing: \"$flac2mp3_api_url/artist/$lidarr_artist_id\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
[ $flac2mp3_debug -ge 2 ] && echo "API returned: $flac2mp3_result" | awk '{print "Debug|"$0}' | log
flac2mp3_root="$(echo $flac2mp3_result | jq -crM .rootFolderPath)"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Detected Lidarr Root Folder '$flac2mp3_root'" | log
fi fi
else else
# No config file means we can't call the API. Best effort at this point. # No config file means we can't call the API. Best effort at this point.
@@ -478,15 +611,6 @@ else
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
fi fi
# Handle Lidarr Test event
if [[ "$lidarr_eventtype" = "Test" ]]; then
echo "Info|Lidarr event: $lidarr_eventtype" | log
flac2mp3_message="Info|Script was test executed successfully."
echo "$flac2mp3_message" | log
echo "$flac2mp3_message"
exit 0
fi
# Check if source audio file exists # Check if source audio file exists
if [ "$flac2mp3_type" = "batch" -a ! -f "$flac2mp3_tracks" ]; then if [ "$flac2mp3_type" = "batch" -a ! -f "$flac2mp3_tracks" ]; then
flac2mp3_message="Error|Input file not found: \"$flac2mp3_tracks\"" flac2mp3_message="Error|Input file not found: \"$flac2mp3_tracks\""
@@ -495,7 +619,7 @@ if [ "$flac2mp3_type" = "batch" -a ! -f "$flac2mp3_tracks" ]; then
exit 5 exit 5
fi fi
# Check for empty track variable # Check for empty tracks variable
if [ -z "$flac2mp3_tracks" ]; then if [ -z "$flac2mp3_tracks" ]; then
flac2mp3_message="Error|No audio tracks were detected or specified!" flac2mp3_message="Error|No audio tracks were detected or specified!"
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
@@ -506,8 +630,8 @@ fi
# If specified, check if destination folder exists and create if necessary # If specified, check if destination folder exists and create if necessary
if [ "$flac2mp3_output" -a ! -d "$flac2mp3_output" ]; then if [ "$flac2mp3_output" -a ! -d "$flac2mp3_output" ]; then
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Destination directory does not exist. Creating: $flac2mp3_output" | log [ $flac2mp3_debug -ge 1 ] && echo "Debug|Destination directory does not exist. Creating: $flac2mp3_output" | log
mkdir -p "$flac2mp3_output" mkdir -p "$flac2mp3_output" >&2
flac2mp3_return=$?; [ "$flac2mp3_return" != 0 ] && { flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] mkdir returned an error. Unable to create output directory." flac2mp3_message="Error|[$flac2mp3_return] mkdir returned an error. Unable to create output directory."
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
@@ -532,191 +656,238 @@ fi
if [ -n "$flac2mp3_output" ]; then if [ -n "$flac2mp3_output" ]; then
flac2mp3_message+=", Output: ${flac2mp3_output}" flac2mp3_message+=", Output: ${flac2mp3_output}"
fi fi
if [ $flac2mp3_keep = 1 ]; then if [ $flac2mp3_keep -eq 1 ]; then
flac2mp3_message+=", Keep source" flac2mp3_message+=", Keep source"
fi fi
if [ -n "$flac2mp3_regex" ]; then flac2mp3_message+=", Matching regex: '${flac2mp3_regex:=[.]flac$}'"
flac2mp3_message+=", Matching regex: '${flac2mp3_regex}'"
fi
flac2mp3_message+=", Track(s): ${flac2mp3_tracks}" flac2mp3_message+=", Track(s): ${flac2mp3_tracks}"
echo "${flac2mp3_message}" | log echo "${flac2mp3_message}" | log
# Process tracks # Set ffmpeg parameters
echo -n "$flac2mp3_tracks" | awk -v Debug=$flac2mp3_debug \ case "$flac2mp3_debug" in
-v Recycle="$flac2mp3_recyclebin" \ 0) flac2mp3_ffmpeg_log="error" ;;
-v Bitrate="$flac2mp3_bitrate" \ 1) flac2mp3_ffmpeg_log="warning" ;;
-v VBR="$flac2mp3_vbrquality" \ 2) flac2mp3_ffmpeg_log="info" ;;
-v FFmpegADV="$flac2mp3_ffmpegadv" \ *) flac2mp3_ffmpeg_log="debug" ;;
-v Ext="$flac2mp3_extension" \ esac
-v Output="$flac2mp3_output" \ if [ -n "$flac2mp3_bitrate" ]; then
-v Keep=$flac2mp3_keep \ [ $flac2mp3_debug -ge 1 ] && echo "Debug|Using constant bitrate of $flac2mp3_bitrate" | log
-v Pat="$flac2mp3_regex" \ flac2mp3_ffmpeg_brCommand="-b:a $flac2mp3_bitrate "
-v Root="$flac2mp3_root" \ elif [ -n "$flac2mp3_vbrquality" ]; then
-v Taglist="$flac2mp3_tags" ' [ $flac2mp3_debug -ge 1 ] && echo "Debug|Using variable quality of $flac2mp3_vbrquality" | log
BEGIN { flac2mp3_ffmpeg_brCommand="-q:a $flac2mp3_vbrquality "
FFmpeg = "/usr/bin/ffmpeg" elif [ -n "$flac2mp3_ffmpegadv" ]; then
FS = "|" [ $flac2mp3_debug -ge 1 ] && echo "Debug|Using advanced ffmpeg options \"$flac2mp3_ffmpegadv\"" | log
RS = "|" [ $flac2mp3_debug -ge 1 ] && echo "Debug|Exporting with file extension \"$flac2mp3_extension\"" | log
IGNORECASE = 1 flac2mp3_ffmpeg_opts="$flac2mp3_ffmpegadv"
# Set default extension, pattern, and logging values
if (Ext == "") Ext = ".mp3"
if (Pat == "") Pat = "\\.flac$"
if (Debug == 0) FFmpegLOG = "error"
else if (Debug == 1) FFmpegLOG = "warning"
else if (Debug >= 2) FFmpegLOG = "info"
if (Bitrate) {
if (Debug >= 1) print "Debug|Using constant bitrate of "Bitrate
BrCommand = "-b:a "Bitrate
} else if (VBR >= 0) {
if (Debug >= 1) print "Debug|Using variable quality of "VBR
BrCommand = "-q:a "VBR
} else if (FFmpegADV) {
if (Debug >= 1) print "Debug|Using advanced ffmpeg options \""FFmpegADV"\""
if (Debug >= 1) print "Debug|Exporting with file extension \""Ext"\""
FFmpegOPTS = FFmpegADV
}
if (Debug >= 1) print "Debug|Matching tracks against regex \""Pat"\""
# Set default ffmpeg options
if (FFmpegOPTS == "") FFmpegOPTS = "-c:v copy -map 0 -y -acodec libmp3lame "BrCommand" -write_id3v1 1 -id3v2_version 3"
}
$0 !~ Pat {
if (Debug >= 1) print "Debug|Skipping track that did not match regex: "$0
}
$0 ~ Pat {
# Get each audio file name and create a new track name with the given extension
Track = $0
Last = split(Track, Parts, ".")
NewTrack = substr(Track, 1, length(Track) - length(Parts[Last]) - 1) Ext
# Redirect output if asked
if (Output) sub(/^.*\//, Output, NewTrack)
# Check for same track name
if (Track == NewTrack) {
print "Error|The original track name and new name are the same! Skipping track: "Track
next
}
# Set metadata options to fix tags if asked
if (Taglist) {
Metadata = ""; JSON = ""
NumTags = split(Taglist, Tag, ",")
if (Debug >= 1) print "Debug|Detecting and fixing common problems with the following metadata tags: "Taglist
Command = "/usr/bin/ffprobe -hide_banner -loglevel fatal -print_format json=compact=1 -show_format -show_entries \"format=tags : format_tags=disc,genre\" -i \""Track"\" 2>&1"
if (Debug >= 2) print "Debug|Executing: "Command
# Concatenate FFprobe output into one line
while (Command | getline Line) JSON = JSON Line
for (i = 1; i <= NumTags; i++) {
if (Tag[i] == "disc") {
# Fix one disc by itself (\47 is single quote in octal)
Command = "echo \47"JSON"\47 | jq -crM \47.format.tags.disc\47 2>&1"
if (Debug >= 2) print "Debug|Executing: "Command
Command | getline Disc
sub(/\n/, "", Disc) # I do not yet know why this is needed
if (Debug >= 1) print "Debug|Discovered disc: "Disc
if (Disc ~ /^1$/) Metadata = "-metadata disc=\"1/1\" "Metadata
}
if (Tag[i] == "genre") {
# Fix multiple genres
Command = "echo \47"JSON"\47 | jq -crM \47.format.tags | to_entries[] | select(.key | match(\"genre\";\"i\")).value\47 2>&1"
if (Debug >= 2) print "Debug|Executing: "Command
Command | getline Genre
sub(/\n/, "", Genre) # I do not yet know why this is needed
if (Debug >= 1) print "Debug|Discovered genre: "Genre
if (Genre ~ /;/) {
if (Genre ~ /Pop/) Metadata = "-metadata genre=\"Pop\" "Metadata
else if (Genre ~ /Indie/) Metadata = "-metadata genre=\"Alternative & Indie\" "Metadata
else if (Genre ~ /Industrial/) Metadata = "-metadata genre=\"Industrial Rock\" "Metadata
else if (Genre ~ /Electronic/) Metadata = "-metadata genre=\"Electronica & Dance\" "Metadata
else if (Genre ~ /Punk|Alternative/) Metadata = "-metadata genre=\"Alternative & Punk\" "Metadata
else if (Genre ~ /Rock/) Metadata = "-metadata genre=\"Rock\" "Metadata
}
}
if (Debug >= 2) print "Debug|Metadata on pass "i"/"NumTags": "Metadata
}
}
print "Info|Writing: "NewTrack
# Convert the track
Command = "nice "FFmpeg" -loglevel "FFmpegLOG" -nostdin -i \""Track"\" "FFmpegOPTS" "Metadata"\""NewTrack"\" 2>&1"
if (Debug >= 1) print "Debug|Executing: "Command
Result = system(Command)
if (Debug >= 2) print "Debug|ffmpeg exited"
if (Result) {
print "Error|Exit code "Result" converting \""Track"\""
} else {
# Build system command to set owner and permissions, etc.
if (Keep == 1) {
# Do not delete the source file
if (Debug >= 1) print "Debug|Keeping original: \""Track"\" and setting permissions on \""NewTrack"\""
Command = "if [ -s \""NewTrack"\" ]; then if [ -f \""Track"\" ]; then chown --reference=\""Track"\" \""NewTrack"\"; chmod --reference=\""Track"\" \""NewTrack"\"; fi; fi"
} else {
if (Recycle == "") {
# No Recycle Bin, so check for non-zero size new file and delete the old one
if (Debug >= 1) print "Debug|Deleting: \""Track"\" and setting permissions on \""NewTrack"\""
Command = "if [ -s \""NewTrack"\" ]; then if [ -f \""Track"\" ]; then chown --reference=\""Track"\" \""NewTrack"\"; chmod --reference=\""Track"\" \""NewTrack"\"; rm \""Track"\"; fi; fi"
} else {
# Recycle Bin is configured, so check if it exists, append a relative path to it from the track, check for non-zero size new file, and move the old one to the Recycle Bin
if (Root == "") {
# Legacy way in case the Root music folder cannot be determined
print "Warning|Root music folder is blank. Falling back to legacy split method."
match(Track, /^\/?[^\/]+\//)
} else {
# The following logic tests that the Root folder is a substring of the Track folder, though based on the observed Lidarr behavior this should be a safe assumption. A warning is displayed just in case.
RSTART = index(Track, Root)
if (RSTART) {
RLENGTH = length(Root)
} else {
print "Warning|The root music folder \""Root"\" is not part of \""Track"\". Recycled tracks may not appear as expected."
RLENGTH = 0
}
}
if (Debug >= 2) print "Debug|Splitting track name on RSTART: "RSTART", RLENGTH: "RLENGTH" to prepend recycle path."
RecPath = substr(Track, RSTART + RLENGTH)
sub(/^\/+/, "", RecPath) # remove trailing track name
sub(/[^\/]+$/, "", RecPath) # remove leading backslash
RecPath = Recycle RecPath
if (Debug >= 1) print "Debug|Recycling: \""Track"\" to \""RecPath"\" and setting permissions on \""NewTrack"\""
Command = "if [ ! -e \""RecPath"\" ]; then mkdir -p \""RecPath"\"; fi; if [ -s \""NewTrack"\" ]; then if [ -f \""Track"\" ]; then chown --reference=\""Track"\" \""NewTrack"\"; chmod --reference=\""Track"\" \""NewTrack"\"; mv -t \""RecPath"\" \""Track"\"; fi; fi"
}
}
# Set owner, permissions, etc.
if (Debug >= 2) print "Debug|Executing: "Command
Result = system(Command)
if (Result) {
print "Error|Exit code "Result" setting permissions and/or recycling on \""NewTrack"\""
}
}
}
' | log
#### END MAIN
# Check for awk script completion
flac2mp3_return="${PIPESTATUS[1]}" # captures awk exit status
[ $flac2mp3_debug -ge 2 ] && echo "Debug|awk exited with code: $flac2mp3_return" | log
if [ "$flac2mp3_return" != 0 ]; then
flac2mp3_message="Error|[$flac2mp3_return] Script exited abnormally. File permissions issue?"
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
exit 10
fi fi
# Call Lidarr API to RescanArtist # Set default ffmpeg options
[ -z "$flac2mp3_ffmpeg_opts" ] && flac2mp3_ffmpeg_opts="-c:v copy -map 0 -y -acodec libmp3lame ${flac2mp3_ffmpeg_brCommand}-write_id3v1 1 -id3v2_version 3"
# Process tracks
# Changing the input field separator to split track string
declare -x flac2mp3_import_list=""
IFS=\|
for flac2mp3_track in $flac2mp3_tracks; do
# Guard clause: regex not match
if [[ ! $flac2mp3_track =~ $flac2mp3_regex ]]; then
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Skipping track that did not match regex: $flac2mp3_track" | log
continue
fi
# Check that track exists
if [ ! -f "$flac2mp3_track" ]; then
flac2mp3_message="Error|Track file does not exist: \"$flac2mp3_track\" to \"$flac2mp3_newTrack\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
continue
fi
# Create a new track name with the given extension
flac2mp3_newTrack="${flac2mp3_track%.*}${flac2mp3_extension}"
# Redirect output if asked
[ -n "$flac2mp3_output" ] && flac2mp3_newTrack="${flac2mp3_output}${flac2mp3_newTrack##*/}"
# Check for same track name
if [ "$flac2mp3_newTrack" == "$flac2mp3_track" ]; then
echo "Error|The original track name and new name are the same! Skipping track: $flac2mp3_track" | log
flac2mp3_exitstatus=11
continue
fi
# Set metadata options to fix tags if asked
if [ -n "$flac2mp3_tags" ]; then
flac2mp3_ffmpeg_metadata=""
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Detecting and fixing common problems with the following metadata tags: $flac2mp3_tags" | log
# Get track metadata
if ffprobe "$flac2mp3_track"; then
for flac2mp3_tag in $(echo $flac2mp3_tags | tr ',' '|'); do
case "$flac2mp3_tag" in
disc ) # Fix one disc by itself
flac2mp3_tag_disc=$(echo "$flac2mp3_ffprobe_json" | jq -crM '.format.tags.disc')
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Original metadata: disc=$flac2mp3_tag_disc" | log
if [ "$flac2mp3_tag_disc" == "1" ]; then
flac2mp3_ffmpeg_metadata+='-metadata disc="1/1" '
fi
;;
genre ) # Fix multiple genres
flac2mp3_tag_genre=$(echo "$flac2mp3_ffprobe_json" | jq -crM '.format.tags | to_entries[] | select(.key | match("genre";"i")).value')
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Original metadata: genre=$flac2mp3_tag_genre" | log
# Only trigger on multiple genres
if [[ $flac2mp3_tag_genre =~ \; ]]; then
case "$flac2mp3_tag_genre" in
*Synth-Pop*) flac2mp3_ffmpeg_metadata+='-metadata genre="Electronica & Dance" ' ;;
*Pop*) flac2mp3_ffmpeg_metadata+='-metadata genre="Pop" ' ;;
*Indie*) flac2mp3_ffmpeg_metadata+='-metadata genre="Alternative & Indie" ' ;;
*Industrial*) flac2mp3_ffmpeg_metadata+='-metadata genre="Industrial Rock" ' ;;
*Electronic*) flac2mp3_ffmpeg_metadata+='-metadata genre="Electronica & Dance" ' ;;
*Punk*|*Alternative*) flac2mp3_ffmpeg_metadata+='-metadata genre="Alternative & Punk" ' ;;
*Rock*) flac2mp3_ffmpeg_metadata+='-metadata genre="Rock" ' ;;
esac
fi
;;
esac
done
else
echo "Warn|ffprobe did not return any data when querying track: \"$flac2mp3_track\"" | log
flac2mp3_exitstatus=12
fi
fi
# Convert the track
echo "Info|Writing: $flac2mp3_newTrack" | log
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Executing: nice /usr/bin/ffmpeg -loglevel $flac2mp3_ffmpeg_log -nostdin -i \"$flac2mp3_track\" $flac2mp3_ffmpeg_opts $flac2mp3_ffmpeg_metadata\"$flac2mp3_newTrack\"" | log
eval nice /usr/bin/ffmpeg -loglevel $flac2mp3_ffmpeg_log -nostdin -i \"$flac2mp3_track\" $flac2mp3_ffmpeg_opts $flac2mp3_ffmpeg_metadata\"$flac2mp3_newTrack\" 2>&1 | log
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] ffmpeg error when converting track: \"$flac2mp3_track\" to \"$flac2mp3_newTrack\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=13
continue
}
# Check for non-zero size file
if [ ! -s "$flac2mp3_newTrack" ]; then
flac2mp3_message="Error|The new track does not exist or is zero bytes: \"$flac2mp3_newTrack\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=14
continue
fi
# Set owner and permissions
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Changing ownership and permissions of \"$flac2mp3_newTrack\"" | log
chown --reference="$flac2mp3_track" "$flac2mp3_newTrack" >&2
chmod --reference="$flac2mp3_track" "$flac2mp3_newTrack" >&2
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] Error when changing ownership or permissions of track: \"$flac2mp3_newTrack\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=15
}
# Do not delete the source file if asked. Skip import.
if [ $flac2mp3_keep -eq 1 ]; then
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Keeping original: \"$flac2mp3_track\"" | log
continue
fi
# Skip the rest of the loop if in batch mode, just delete the track
if [ "$flac2mp3_type" = "batch" ]; then
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Deleting: \"$flac2mp3_track\"" | log
rm "$flac2mp3_track" >&2
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] Error when deleting track: \"$flac2mp3_track\""
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=16
}
continue
fi
# Call Lidarr to delete the original file, or recycle if configured.
flac2mp3_track_id=$(echo $flac2mp3_trackfiles | jq -crM ".[] | select(.path == \"$flac2mp3_track\") | .id")
delete_track $flac2mp3_track_id
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] Lidarr error when deleting the original track: \"$flac2mp3_track\". Not importing new track into Lidarr."
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=17
continue
}
# Add new track to list of tracks to import
flac2mp3_import_list+="${flac2mp3_newTrack}|"
done
IFS=$' \t\n'
# Remove trailing pipe
flac2mp3_import_list="${flac2mp3_import_list%|}"
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Track import list: \"$flac2mp3_import_list\"" | log
#### END MAIN
#### Call Lidarr API to update database
# Check for URL
if [ "$flac2mp3_type" = "batch" ]; then if [ "$flac2mp3_type" = "batch" ]; then
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Cannot use API in batch mode." | log [ $flac2mp3_debug -ge 1 ] && echo "Debug|Cannot use API in batch mode." | log
elif [ $flac2mp3_keep -eq 1 ]; then elif [ $flac2mp3_keep -eq 1 ]; then
echo "Info|Original audio file(s) kept, no rescan performed." | log echo "Info|Original audio file(s) kept, no database update performed." | log
elif [ -n "$flac2mp3_api_url" ]; then elif [ -n "$flac2mp3_api_url" ]; then
# Check for artist ID # Check for artist ID
if [ "$lidarr_artist_id" ]; then if [ -n "$lidarr_artist_id" ]; then
# Scan the disk for the new audio tracks # Scan for files to import into Lidarr
if rescan; then export flac2mp3_import_count=$(echo $flac2mp3_import_list | awk -F\| '{print NF}')
# Check that the rescan completed if [ $flac2mp3_import_count -ne 0 ]; then
if ! check_rescan; then echo "Info|Preparing to import $flac2mp3_import_count new files. This make take a long time for large libraries." | log
# Timeout or failure if get_import_info; then
flac2mp3_message="Warn|Lidarr job ID $flac2mp3_jobid timed out or failed." # Build JSON data for all tracks
# NOTE: Tracks with empty track IDs will not appear in the resulting JSON and will therefore not be imported into Lidarr
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Building JSON data to import" | log
export flac2mp3_json=$(echo $flac2mp3_result | jq -jcrM "
map(
select(.path | inside(\"$flac2mp3_import_list\")) |
{path, \"artistId\":$lidarr_artist_id, \"albumId\":$lidarr_album_id, albumReleaseId,\"trackIds\":[.tracks[].id], quality, \"disableReleaseSwitching\":false}
)
")
# Import new files into Lidarr
import_tracks
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
flac2mp3_message="Error|[$flac2mp3_return] Lidarr error when importing the new tracks!"
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=17
}
flac2mp3_jobid="$(echo $flac2mp3_result | jq -crM .id)"
# Check status of job
check_job
flac2mp3_return=$?; [ $flac2mp3_return -ne 0 ] && {
case $flac2mp3_return in
1) flac2mp3_message="Info|Lidarr job ID $flac2mp3_jobid is queued. Trusting this will complete and exiting."
flac2mp3_exitstatus=0
;;
2) flac2mp3_message="Warn|Lidarr job ID $flac2mp3_jobid failed."
flac2mp3_exitstatus=17
;;
3) flac2mp3_message="Warn|Script timed out waiting on Lidarr job ID $flac2mp3_jobid. Last status was: $(echo $flac2mp3_result | jq -crM .status)"
flac2mp3_exitstatus=18
;;
10) flac2mp3_message="Error|Lidarr job ID $flac2mp3_jobid returned a curl error."
flac2mp3_exitstatus=17
;;
esac
echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2
}
else
flac2mp3_message="Error|Lidarr error getting import file list in \"$lidarr_artist_path\" for artist ID $lidarr_artist_id"
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=17
fi fi
else else
# Error from API flac2mp3_message="Warn|Didn't find any tracks to import."
flac2mp3_message="Error|The 'RefreshArtist' API with artist $lidarr_artist_id failed."
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
fi fi
@@ -725,14 +896,18 @@ elif [ -n "$flac2mp3_api_url" ]; then
flac2mp3_message="Warn|Missing environment variable lidarr_artist_id" flac2mp3_message="Warn|Missing environment variable lidarr_artist_id"
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=20
fi fi
else else
# No URL means we can't call the API # No URL means we can't call the API
flac2mp3_message="Warn|Unable to determine Lidarr API URL." flac2mp3_message="Warn|Unable to determine Lidarr API URL."
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
echo "$flac2mp3_message" >&2 echo "$flac2mp3_message" >&2
flac2mp3_exitstatus=20
fi fi
# Cool bash feature # Cool bash feature
flac2mp3_message="Info|Completed in $(($SECONDS/60))m $(($SECONDS%60))s" flac2mp3_message="Info|Completed in $(($SECONDS/60))m $(($SECONDS%60))s"
echo "$flac2mp3_message" | log echo "$flac2mp3_message" | log
[ $flac2mp3_debug -ge 1 ] && echo "Debug|Exit code ${flac2mp3_exitstatus:-0}" | log
exit ${flac2mp3_exitstatus:-0}