add --embed

add-synced-lyrics.sh

@@ -74,15 +74,15 @@ process_inputs() {
         fi
 
         output=''
-        output="$(set_lyric_file_name "${input}")"
+        if ! output="$(set_lyric_file_name "${input}")"; then
+            echo_fail "could not determine lyric file name for ${input}"
+            ret=1
+            continue
+        fi
 
-        if [[ -f "${output}" ]]; then
-            if is_valid_lrc "${output}"; then
-                echo_pass "${input} already has lyrics, skipping"
-                continue
-            else
-                rm "${output}" || return 1
-            fi
+        if validate_song_lyrics "${input}" "${output}"; then
+            echo_pass "${input} already has lyrics, skipping"
+            continue
         fi
 
         isrc=''
@@ -91,26 +91,34 @@ process_inputs() {
             continue
         fi
 
-        local tmpOutput="${TMPDIR}/tmp.lrc"
+        local tmpOutput="${TMPDIR}/$(bash_basename "${output}")"
         for func in "${downloadFuncs[@]}"; do
-            "${func}" "${isrc}" "${tmpOutput}" && break
+            # try to download
+            if ! "${func}" "${isrc}" "${tmpOutput}"; then
+                continue
+            fi
+
+            # validate
+            if validate_lrc "${tmpOutput}"; then
+                # passed download and validation, stop processing
+                break
+            fi
         done
 
-        if [[ -f "${tmpOutput}" ]]; then
-            if is_valid_lrc "${tmpOutput}"; then
-                mv "${tmpOutput}" "${output}" &>/dev/null || return 1
-            else
-                rm "${tmpOutput}" || return 1
-            fi
-        fi
+        # skip processing since no files should be modified
+        [[ ${DRY_RUN} == true ]] && continue
 
-        if ! void test -f "${output}"; then
+        if [[ -f "${tmpOutput}" ]]; then
+            add_lyrics_to_song \
+                "${input}" \
+                "${tmpOutput}" \
+                "${output}" &&
+                echo_pass "added lyrics for ${input}"
+        else
             echo_fail "could not find lyrics for ${input}"
             ret=1
-            continue
-        else
-            void echo_pass "added lyrics for ${input}"
         fi
+
     done
 
     return ${ret}

lib/0-utils.sh

@@ -32,7 +32,7 @@ stderr() {
     local word="${WORD:-}"
     local color="${COLOR:-}"
     local function="${FUNCNAME[2]}"
-    if [[ "${function}" =~ void ]]; then
+    if [[ "${function}" =~ debug|void ]]; then
         function="${FUNCNAME[3]}"
     fi
     echo \
@@ -44,7 +44,7 @@ stderr() {
 echo_info() { WORD=INFO COLOR="${CYAN}" stderr "$@"; }
 echo_fail() { WORD=FAIL COLOR="${RED}" stderr "$@"; }
 echo_pass() { WORD=PASS COLOR="${GREEN}" stderr "$@"; }
-echo_dbug() { WORD=DBUG COLOR="${PURPLE}" stderr "$@"; }
+echo_debug() { WORD=DBUG COLOR="${PURPLE}" stderr "$@"; }
 
 # only perform the command given if ${DEBUG} is enabled
 debug() {
@@ -55,7 +55,7 @@ debug() {
     "$@"
 }
 
-# only perform the command given if ${DRY_RUN} is enabled
+# only perform the command given if ${DRY_RUN} is disabled
 void() {
     if [[ ${DRY_RUN} == true ]]; then
         return 0
@@ -111,6 +111,20 @@ check_required_utils() {
     fi
 }
 
+echo_if_fail() {
+    local cmd=("$@")
+    local output
+    output="$("${cmd[@]}" 2>&1)"
+    local ret=$?
+
+    if [[ ${ret} -ne 0 ]]; then
+        echo_fail "${cmd[*]}"
+        echo_fail "${output}"
+    fi
+
+    return ${ret}
+}
+
 cache_command() {
     local cmd=("$@")
     local hash cacheFile cmdOut contents ret
@@ -138,6 +152,8 @@ cache_command() {
 }
 
 create_tmp_dir() {
+    [[ -n "${TMPDIR:-}" ]] && return
+
     TMPDIR="$(mktemp -d)" || return 1
     readonly TMPDIR
     trap 'rm -rf ${TMPDIR}' EXIT
@@ -147,8 +163,10 @@ check_tmp_dir_empty() {
     for f in "${TMPDIR}"/*; do
         if [[ -f "${f}" ]]; then
             echo_fail "tempdir ${TMPDIR} is not empty!"
+            echo_fail "contains ${f}"
             echo_fail "aborting operation"
-            return 1
+            # execution becomes undefined if TMPDIR is not empty
+            exit 1
         fi
     done
 
@@ -253,28 +271,134 @@ get_file_isrc() {
     echo "${jqResult}"
 }
 
+get_file_lyrics() {
+    local file="$1"
+    local probe='' jqResult=''
+
+    local probe=''
+    probe="$(
+        ffprobe \
+            -v error \
+            -show_entries stream \
+            -of json \
+            "${file}"
+    )" || return 1
+
+    local jqFilter='.streams[] | select(.codec_type == "audio") | .tags | with_entries(.key |= ascii_downcase) | .lyrics'
+    jqResult="$(jq -r "${jqFilter}" <<<"${probe}")"
+
+    if [[ "${jqResult}" == 'null' ]]; then
+        debug echo_fail "could not find lyrics for ${file}"
+        return 1
+    fi
+    echo "${jqResult}"
+}
+
+is_music_file() {
+    local file="$1"
+    [[ "${file}" =~ ${MUSIC_EXTENSION_REGEX} ]]
+}
+
+is_lrc_file() {
+    local file="$1"
+    [[ "${file}" == *'.lrc' ]]
+}
+
 set_lyric_file_name() {
     local file="$1"
-    if [[ ! "${file}" =~ ${MUSIC_EXTENSION_REGEX} ]]; then
-        echo "${file} is not a music file"
+    if ! is_music_file "${file}"; then
+        echo_fail "${file} is not a music file"
         return 1
     fi
 
     echo "${file%.opus}.lrc"
 }
 
-is_valid_lrc() {
+validate_lrc() {
     local file="$1"
 
+    # file does not exist, invalid
+    if [[ ! -f "${file}" ]]; then
+        return 1
+    fi
+
+    # file is not lyric file, invalid
+    if ! is_lrc_file "${file}"; then
+        return 1
+    fi
+
+    mapfile -t fileContents <"${file}"
+
     local valid=1
-    while read -r line; do
+    for line in "${fileContents[@]}"; do
         [[ "${#line}" -eq 0 ]] && continue
-        if [[ "${line}" != '['* ]]; then
+        if [[ "${line}" != '['* && "${line}" != '#'* ]]; then
             valid=1
             break
         fi
         valid=0
-    done <"${file}"
+    done
+
+    if [[ ${valid} -eq 1 ]]; then
+        debug echo_fail "${file} is not valid lrc file"
+        dry rm "${file}" || return 1
+    fi
 
     return ${valid}
 }
+
+validate_song_lyrics() {
+    local songFile="$1"
+    local lyricsDestination="$2"
+
+    # embed or not both get validated
+    validate_lrc "${lyricsDestination}"
+    local validateDestination=$?
+
+    # only continue to validate for embed
+    if [[ ${EMBED} == false ]]; then
+        return ${validateDestination}
+    fi
+
+    local tmpLyricsFile="${TMPDIR}/$(bash_basename "${lyricsDestination}")"
+    get_file_lyrics "${songFile}" >"${tmpLyricsFile}"
+    validate_lrc "${tmpLyricsFile}"
+    local validateRet=$?
+    [[ ${validateRet} -eq 0 ]] && rm "${tmpLyricsFile}"
+
+    return ${validateRet}
+}
+
+add_lyrics_to_song() {
+    local songFile="$1"
+    local lyricsToAdd="$2"
+    local lyricsDestination="$3"
+
+    # this function removes file so be extra certain
+    is_music_file "${songFile}" &&
+        is_lrc_file "${lyricsToAdd}" &&
+        is_lrc_file "${lyricsDestination}" || return 1
+
+    if [[ ${EMBED} == false ]]; then
+        mv "${lyricsToAdd}" "${lyricsDestination}" &>/dev/null
+        return $?
+    fi
+
+    local tmpSongFile="${TMPDIR}/$(bash_basename "${songFile}")"
+    echo_if_fail \
+        ffmpeg \
+        -hide_banner \
+        -i "${songFile}" \
+        -metadata "LYRICS=$(<"${lyricsToAdd}")" \
+        -c copy \
+        "${tmpSongFile}"
+    local ffmpegRet=$?
+    rm "${lyricsToAdd}"
+
+    if [[ ${ffmpegRet} -eq 0 ]]; then
+        mv "${tmpSongFile}" "${songFile}" &>/dev/null || return 1
+        if [[ -f "${lyricsDestination}" ]]; then
+            rm "${lyricsDestination}" || return 1
+        fi
+    fi
+}

lib/options.sh

@@ -10,14 +10,15 @@ OPTIONS:
   -d, --dir       process files in directory
   -r, --recurse   recursively process directory
   -f, --file      process one file
-  -n, --dry-run   do not actually add synced lyrics,
+  -e, --embed     embed lyrics directly into the song file
+  -n, --dry-run   do not add synced lyrics,
                   just show the files that would be processed
-  -e, --eval      output bash functions that can be directly processed
-                  by eval for use with testing this script.
   -i, --ignore    ignore errors, and continue attempting to find lyrics
                   even in the case of errors
   -h, --help      show this output
-  --debug         extra information useful for debugging"
+  --debug         extra information useful for debugging
+  --eval          output bash functions that can be directly processed
+                  by eval for use with testing this script."
     exit "${EXIT_CODE:-1}"
 }
 
@@ -27,6 +28,7 @@ set_default_options() {
     RECURSE=${RECURSE:-false}
     DRY_RUN=${DRY_RUN:-false}
     IGNORE=${IGNORE:-false}
+    EMBED=${EMBED:-false}
     DEBUG=${DEBUG:-false}
 
     # cache
@@ -64,14 +66,10 @@ process_options() {
             readonly IGNORE=true
             shift 1
             ;;
-        --debug)
-            readonly DEBUG=true
+        -e | --embed)
+            readonly EMBED=true
             shift 1
             ;;
-        -e | --eval)
-            output_eval_functions
-            exit 0
-            ;;
         -f | --file)
             if [[ ! -f "${value}" ]]; then
                 echo "file ${value} does not exist"
@@ -80,6 +78,14 @@ process_options() {
             readonly FILE="${value}"
             shift 2
             ;;
+        --debug)
+            readonly DEBUG=true
+            shift 1
+            ;;
+        --eval)
+            output_eval_functions
+            exit 0
+            ;;
         -h | --help)
             EXIT_CODE=0 usage
             ;;

test-add-synced-lyrics.sh

@@ -74,7 +74,7 @@ run_test_cmd() {
     fi
 
     local output
-    output="$("${cmd[@]}")"
+    output="$("${cmd[@]}" 2>&1)"
     local actualRetval=$?
 
     declare -g CMD_OUTPUT="${output}"
@@ -88,6 +88,10 @@ run_test_cmd() {
 
 }
 
+test_help_option() {
+    add-synced-lyrics --help
+}
+
 test_bad_input() {
     # incomplete args
     run_test_cmd \
@@ -114,6 +118,11 @@ test_bad_input() {
         1 \
         add-synced-lyrics --file "${PROGPATH}" --dir "${PROGDIR}" --recurse
 
+    # non-existent flag
+    run_test_cmd \
+        1 \
+        add-synced-lyrics --this-flag-does-not-exist
+
     return 0
 }
 
@@ -149,27 +158,73 @@ test_determine_inputs_recurse() {
     RECURSE=true test_determine_inputs
 }
 
+test_determine_inputs_find() {
+    local utils=(
+        base64
+        cat
+        ffprobe
+        jq
+        librelyrics
+        spotify
+    )
+    local path=()
+    for util in "${utils[@]}"; do
+        path+=("$(bash_dirname "$(command -v "${util}")")")
+    done
+    IFS=':' moddedPath="${path[*]}"
+    PATH="${moddedPath}" \
+        add-synced-lyrics \
+        --dir "${TEST_DIR}" \
+        --dry-run "$@"
+}
+
+test_determine_inputs_find_recurse() {
+    test_determine_inputs_find --recurse
+}
+
 test_file_dry() {
+    setup_test_data
     add-synced-lyrics --file "${GOOD_SONG}" --dry-run
 }
 
 test_directory_dry() {
+    setup_test_data
     add-synced-lyrics --dir "${TEST_DIR}" --dry-run
 }
 
 test_directory_recurse_dry() {
+    setup_test_data
     add-synced-lyrics --dir "${TEST_DIR}" --recurse --dry-run
 }
 
 test_good_file() {
-    add-synced-lyrics --file "${GOOD_SONG}"
+    setup_test_data
+    add-synced-lyrics --file "${GOOD_SONG}" --debug
     test -f "${GOOD_LYRICS}"
 }
 
-test_bad_file() {
+test_good_file_embed() {
+    test_good_file
+    # rm "${GOOD_LYRICS}"
+    add-synced-lyrics --file "${GOOD_SONG}" --embed
     run_test_cmd \
         1 \
-        add-synced-lyrics --file "${BAD_SONG}"
+        test -f "${GOOD_LYRICS}"
+
+    # do it again to test that embedded is picked up and valid
+    run_test_cmd \
+        0 \
+        add-synced-lyrics --file "${GOOD_SONG}" --embed
+    [[ "${CMD_OUTPUT}" == *'already has lyrics, skipping'* ]]
+}
+
+test_bad_file() {
+    setup_test_data
+    run_test_cmd \
+        1 \
+        add-synced-lyrics \
+        --file "${BAD_SONG}" \
+        --debug
     run_test_cmd \
         1 \
         test -f "${BAD_LYRICS}"
@@ -196,6 +251,12 @@ test_directory_recurse_ignore() {
     return 0
 }
 
+test_missing_utils() {
+    PATH="$(bash_dirname "$(command -v bash)")" run_test_cmd \
+        1 \
+        add-synced-lyrics
+}
+
 setup_test_data() {
     test -d "${TEST_DIR}" && rm -rf "${TEST_DIR}"
     mkdir -p "${TEST_DIR}/subdir"
@@ -216,16 +277,21 @@ setup_test_data() {
 }
 
 TESTS=(
+    test_help_option
     test_determine_inputs
     test_determine_inputs_recurse
+    test_determine_inputs_find
+    test_determine_inputs_find_recurse
     test_bad_input
     test_directory_dry
     test_directory_recurse_dry
     test_file_dry
     test_good_file
+    test_good_file_embed
     test_bad_file
     test_directory_recurse
     test_directory_recurse_ignore
+    test_missing_utils
 )
 
 # make sure no test is accidentally missed
@@ -338,7 +404,9 @@ if [[ $# -eq 0 ]]; then
         fi
     done
 
+    echo
     analyze_coverage
 else
+    setup_coverage
     "$@"
 fi