465 lines
15 KiB
Bash
Executable File
465 lines
15 KiB
Bash
Executable File
#!/bin/sh
|
||
|
||
################################################################################
|
||
## User options
|
||
|
||
## You can easily set output folder to current folder with OUTPUT_ROOT=".".
|
||
[ -z "$OUTPUT_ROOT" ] && OUTPUT_ROOT="$HOME/musics"
|
||
|
||
## End of user options
|
||
################################################################################
|
||
|
||
## For the sake of simplicity we convert everything to OGG.
|
||
## OGG quality ranges from -1 to 10.
|
||
## -q-1 45 kbit/s
|
||
## -q0 64 kbit/s
|
||
## -q1 80 kbit/s
|
||
## -q2 96 kbit/s
|
||
## -q3 112 kbit/s
|
||
## -q4 128 kbit/s
|
||
## -q5 160 kbit/s
|
||
## -q6 192 kbit/s
|
||
## -q7 224 kbit/s
|
||
## -q8 256 kbit/s
|
||
## -q9 320 kbit/s
|
||
## -q10 500 kbit/s
|
||
|
||
## Artists: we use same value for artist and album_artist.
|
||
## Genres: since this is not universal by nature, we do not put a genre in tags,
|
||
## except for special cases like Soundtrack.
|
||
## Composer: not universal neither, we prefer ARTIST over COMPOSER, so COMPOSER
|
||
## will be empty.
|
||
|
||
## This script is supposed to work on a per-album basis. Folders will not be
|
||
## accepted as argument. This function will work best if all tracks of a folder
|
||
## belong to the same album. There's is no way to handle covers reliably, so you
|
||
## should remove the undesired covers from the working folder.
|
||
|
||
## TODO: cover resolution check. Should be > 100x100. Above 1000x1000 should
|
||
## give a warning.
|
||
## TODO: extract cover from tags if checksum does not match any from current folder.
|
||
|
||
_printhelp ()
|
||
{
|
||
cat <<EOF | less
|
||
Usage: ${1##*/} [OPTIONS] FILE
|
||
|
||
Options:
|
||
-c : capital case (only first letter in upper case)
|
||
-f : overwrite if file exists
|
||
-p : preview (do not change file)
|
||
-q : hide FFmpeg runtime output.
|
||
-s : skip encoding
|
||
|
||
Tags:
|
||
-a : artist
|
||
-b : bitrate
|
||
-d : date
|
||
-g : genre
|
||
-l : album
|
||
-n : track number
|
||
-r : library root folder
|
||
-t : title
|
||
|
||
You can use the following variables to refer to existing values:
|
||
\$ALBUM
|
||
\$ALBUMARTIST
|
||
\$ARTIST
|
||
\$COMPOSER
|
||
\$DATE
|
||
\$FILENAME
|
||
\$GENRE
|
||
\$TRACK
|
||
\$TYER
|
||
|
||
Default output folder:
|
||
OUTPUT_FOLDER="\$OUTPUT_ROOT/\$OUTPUT_ARTIST/\${OUTPUT_ALBUM:+\${OUTPUT_DATE:+\$OUTPUT_DATE - }\$OUTPUT_ALBUM/}"
|
||
|
||
Default output file:
|
||
OUTPUT_FILE="\$OUTPUT\$OUTPUT_ARTIST - \${OUTPUT_TRACK:+\$OUTPUT_TRACK - }\$OUTPUT_TITLE.\$OUTPUT_EXT"
|
||
|
||
Examples:
|
||
|
||
Set the 'artist' tag and reencode:
|
||
${1##*/} -a 'Franz Liszt' file.mp3
|
||
|
||
Set 'artist' to be 'composer', and 'title' to be preceded by 'artist', do not reencode:
|
||
${1##*/} -s -a '\$COMPOSER' -t '\$ARTIST - \$TITLE' file.ogg
|
||
|
||
Set track number to first field in file name:
|
||
${1##*/} -n '${FILENAME%% }'
|
||
|
||
IMPORTANT: you *must* use single quotes when using variables. Also note that the
|
||
string parameters are all evaluated using 'eval', which means that some
|
||
characters may need escaping with '\'. Since parenthesis '()' are often used, a
|
||
backslash is prepended before eval is called.
|
||
EOF
|
||
}
|
||
|
||
## OPTIONS
|
||
CAPITAL=0
|
||
OVERWRITE="-n"
|
||
PREVIEW=false
|
||
SKIP=false
|
||
LOGLEVEL=""
|
||
|
||
## TAGS
|
||
OUTPUT_ALBUM='$ALBUM'
|
||
OUTPUT_ARTIST='$ARTIST'
|
||
OUTPUT_DATE='$DATE'
|
||
OUTPUT_GENRE='$GENRE'
|
||
OUTPUT_TITLE='$TITLE'
|
||
OUTPUT_TRACK='$TRACK'
|
||
|
||
## PROPERTIES
|
||
OUTPUT_BITRATE=-1
|
||
|
||
## Non-CLI-option data. Modifying these imply modifications in code below.
|
||
OUTPUT_EXT="ogg"
|
||
OGG_PARAM='-c:a libvorbis -b:a ${OUTPUT_BITRATE}k'
|
||
|
||
## These ones are not CLI-options either, but this could be easily changed.
|
||
OUTPUT_FOLDER='$OUTPUT_ROOT/$OUTPUT_ARTIST${OUTPUT_ALBUM:+/${OUTPUT_DATE:+$OUTPUT_DATE - }$OUTPUT_ALBUM}'
|
||
OUTPUT_FILE='$OUTPUT_ARTIST - ${OUTPUT_PADDEDTRACK:+$OUTPUT_PADDEDTRACK - }$OUTPUT_TITLE'
|
||
|
||
while getopts ":a:b:cd:fg:l:n:r:t:hpsq" opt; do
|
||
case $opt in
|
||
|
||
a) OUTPUT_ARTIST=$OPTARG ;;
|
||
b) OUTPUT_BITRATE=$OPTARG ;;
|
||
d) OUTPUT_DATE=$OPTARG ;;
|
||
g) OUTPUT_GENRE=$OPTARG ;;
|
||
l) OUTPUT_ALBUM=$OPTARG ;;
|
||
n) OUTPUT_TRACK=$OPTARG ;;
|
||
r) OUTPUT_ROOT=$OPTARG ;;
|
||
t) OUTPUT_TITLE=$OPTARG ;;
|
||
|
||
h)
|
||
_printhelp "$0"
|
||
exit 1
|
||
;;
|
||
c)
|
||
CAPITAL=1 ;;
|
||
f)
|
||
OVERWRITE="-y" ;;
|
||
p)
|
||
PREVIEW=true ;;
|
||
s)
|
||
SKIP=true ;;
|
||
|
||
q)
|
||
LOGLEVEL="-v fatal" ;;
|
||
|
||
?)
|
||
_printhelp "$0"
|
||
exit 1
|
||
;;
|
||
:)
|
||
echo "Missing argument."
|
||
_printhelp "$0"
|
||
exit 1
|
||
;;
|
||
esac
|
||
done
|
||
|
||
shift $(($OPTIND - 1))
|
||
if [ $# -eq 0 ]; then
|
||
_printhelp "$0"
|
||
exit
|
||
fi
|
||
|
||
if [ -z "$(command -v ffmpeg)" ]; then
|
||
echo "ffmpeg required for transcoding."
|
||
exit
|
||
fi
|
||
|
||
if [ -z "$(command -v realpath)" ]; then
|
||
echo "realpath required to get input file folder."
|
||
exit
|
||
fi
|
||
|
||
OUTPUT_ROOT="$(realpath "$OUTPUT_ROOT")"
|
||
if [ ! -d "$OUTPUT_ROOT" ]; then
|
||
echo "Output folder '$OUTPUT_ROOT' does not exist."
|
||
exit
|
||
fi
|
||
|
||
TITLECASE_SCRIPT="${0%/*}/titlecase.awk"
|
||
if [ ! -f "$TITLECASE_SCRIPT" ]; then
|
||
echo "AWK titlecase script required."
|
||
exit
|
||
fi
|
||
|
||
##================================================================================
|
||
## Get metadata.
|
||
STREAM=$(ffmpeg -i "$1" 2>&1)
|
||
|
||
if [ -z "$(echo $STREAM | grep "Stream")" ]; then
|
||
echo "ERROR: Non-audio file [$1]."
|
||
exit
|
||
fi
|
||
|
||
METADATA=$(echo "$STREAM" | sed -n '/Metadata/ ! d; /Metada/{b cont}; :cont ; {n;p;b cont}')
|
||
|
||
## Filename without extension nor path.
|
||
INPUT_FILE="${1%.*}"
|
||
INPUT_FILE="${INPUT_FILE##*/}"
|
||
## Folder of the file. Needed for cover.
|
||
INPUT_FOLDER="$(realpath "$1")"
|
||
INPUT_FOLDER="${INPUT_FOLDER%/*}"
|
||
INPUT_EXT="${1##*.}"
|
||
INPUT_BITRATE=$(echo "$STREAM" | sed -n '/Duration/ {s|.* \([[:digit:]]\+\) kb/s|\1|;p;q}')
|
||
## CODEC is unused for now.
|
||
# CODEC=$(echo "$STREAM" | sed -n '/Stream.*Audio:/ {s/.*Audio: \([^,]*\),.*/\1/;p}')
|
||
|
||
## Extension needs to be set in case we skip encoding so that ffmpeg will not be
|
||
## disturbed by unappropriate extension.
|
||
if $SKIP &&[ -z "$INPUT_EXT" ]; then
|
||
echo "ERROR: Extension missing [$1]."
|
||
exit
|
||
fi
|
||
|
||
## This function greps for one match only, so if several metadata are present,
|
||
## this may not be the desired values.
|
||
_metadata_filter()
|
||
{
|
||
echo "$METADATA" | grep -im1 "\<$1\>" | sed 's/[^:]* : //g'
|
||
}
|
||
|
||
INPUT_TITLE=$(_metadata_filter "title")
|
||
INPUT_ARTIST=$(_metadata_filter "artist")
|
||
INPUT_ALBUM=$(_metadata_filter "album")
|
||
INPUT_ALBUMARTIST=$(_metadata_filter "album_artist")
|
||
INPUT_COMPOSER=$(_metadata_filter "composer")
|
||
INPUT_DISC=$(_metadata_filter "disc")
|
||
INPUT_GENRE=$(_metadata_filter "genre")
|
||
INPUT_TRACK=$(_metadata_filter "track")
|
||
INPUT_DATE=$(_metadata_filter "date")
|
||
INPUT_TYER=$(_metadata_filter "TYER")
|
||
|
||
##==============================================================================
|
||
## Variable cleansing.
|
||
|
||
## We use the AWK script to set title case. The script contains
|
||
## exceptions that can be configured. We fix some chars with sed.
|
||
# ’ => '
|
||
# : => -
|
||
# / => -
|
||
_string_cleanser()
|
||
{
|
||
echo "$@" | awk -v capital=$CAPITAL -f "$TITLECASE_SCRIPT" \
|
||
| sed -n -e "s/’/'/g ; s/ *: */ - /g ; s| */ *| - |g; p; q"
|
||
}
|
||
|
||
## These are the user-accessible variables.
|
||
TITLE=$(_string_cleanser "$INPUT_TITLE")
|
||
ARTIST=$(_string_cleanser "$INPUT_ARTIST")
|
||
ALBUM=$(_string_cleanser "$INPUT_ALBUM")
|
||
ALBUMARTIST=$(_string_cleanser "$INPUT_ALBUMARTIST")
|
||
COMPOSER=$(_string_cleanser "$INPUT_COMPOSER")
|
||
DISC=$(_string_cleanser "$INPUT_DISC")
|
||
GENRE=$(_string_cleanser "$INPUT_GENRE")
|
||
TRACK=$(_string_cleanser "$INPUT_TRACK")
|
||
DATE=$(_string_cleanser "$INPUT_DATE")
|
||
TYER=$(_string_cleanser "$INPUT_TYER")
|
||
|
||
FILENAME=$(_string_cleanser "$INPUT_FILE")
|
||
|
||
##================================================================================
|
||
## OUTPUT variables.
|
||
|
||
## In this part we prepend backslashes to parentheses when there is an 'eval'
|
||
## call to prevent parsing error.
|
||
OUTPUT_TITLE=$(eval echo $(echo ${OUTPUT_TITLE:-Unknown Title} | sed 's/[()]/\\&/g'))
|
||
OUTPUT_ALBUM=$(eval echo $(echo ${OUTPUT_ALBUM:-Unknown Album} | sed 's/[()]/\\&/g'))
|
||
|
||
## We use album artist if artist is empty.
|
||
[ -z "$OUTPUT_ARTIST" ] && [ -n "$ALBUMARTIST" ] && OUTPUT_ARTIST="$ALBUMARTIST"
|
||
OUTPUT_ARTIST=$(eval echo $(echo ${OUTPUT_ARTIST:-Unknown Artist} | sed 's/[()]/\\&/g'))
|
||
|
||
## If OUTPUT_GENRE is set from command-line parameters, we use the
|
||
## string. Otherwise we put GENRE in lower case and underscore to ease matching.
|
||
## If it matches, we use the Title Case match. If it does not, we set it to
|
||
## empty.
|
||
if [ ! "$OUTPUT_GENRE" = '$GENRE' ]; then
|
||
OUTPUT_GENRE=$(eval echo $(echo $OUTPUT_GENRE | sed 's/[()]/\\&/g'))
|
||
else
|
||
## We also convert spaces to underscores.
|
||
GENRE=$(echo "$GENRE" | tr '[:upper:] ' '[:lower:]_')
|
||
case $GENRE in
|
||
ost) OUTPUT_GENRE="Soundtrack" ;;
|
||
soundtrack) OUTPUT_GENRE="Soundtrack";;
|
||
original_soundtrack) OUTPUT_GENRE="Soundtrack";;
|
||
classical) OUTPUT_GENRE="Classical";;
|
||
classics) OUTPUT_GENRE="Classical";;
|
||
classic) OUTPUT_GENRE="Classical";;
|
||
humour) OUTPUT_GENRE="Humour";;
|
||
*) OUTPUT_GENRE="";;
|
||
esac
|
||
fi
|
||
|
||
## We remove the track count if any, we suppress leading zeros, we suppress all
|
||
## non-digit characters.
|
||
OUTPUT_TRACK=$(eval _string_cleanser $(echo $OUTPUT_TRACK | sed 's/[()]/\\&/g') | sed -e 's/^0*//' -e 's|[^[:digit:]].*||')
|
||
|
||
## We extract the four-digits number from the date.
|
||
OUTPUT_DATE=$(eval _string_cleanser $(echo $OUTPUT_DATE | sed 's/[()]/\\&/g'))
|
||
OUTPUT_DATE=$(echo "$OUTPUT_DATE" | sed -n 's/.*\([[:digit:]]\{4\}\).*/\1/p')
|
||
## If DATE is not a year, we use TYER if it is a year.
|
||
TYER_REG=$(echo "$TYER" | sed -n 's/.*\([[:digit:]]\{4\}\).*/\1/p')
|
||
if [ ${#DATE} -ne 4 ] && [ ${#TYER_REG} -eq 4 ]; then
|
||
OUTPUT_DATE="$TYER_REG"
|
||
fi
|
||
|
||
## QUALITY
|
||
## If bitrate argument is not provided, we use INPUT_BITRATE value.
|
||
## If bitrate argument is 0, we leave FFmpeg chose the value.
|
||
[ $OUTPUT_BITRATE -lt 0 ] && OUTPUT_BITRATE=${INPUT_BITRATE}
|
||
[ $OUTPUT_BITRATE -eq 0 ] && OGG_PARAM="-c:a libvorbis"
|
||
## If OUTPUT_BITRATE is beyond OGG's limit, we trim it.
|
||
[ $OUTPUT_BITRATE -gt 500 ] && OUTPUT_BITRATE=500
|
||
|
||
|
||
## Only reencode if not in OGG and if SKIP not set.
|
||
INPUT_EXT_LOW="$(echo $INPUT_EXT | tr [:upper:] [:lower:])"
|
||
if $SKIP; then
|
||
OGG_PARAM="-c:a copy"
|
||
OUTPUT_EXT="$INPUT_EXT_LOW"
|
||
fi
|
||
[ "$INPUT_EXT_LOW" = "ogg" ] && OGG_PARAM="-c:a copy"
|
||
OGG_PARAM=$(eval echo "$OGG_PARAM")
|
||
|
||
## Make sure track number has two digits for file name only.
|
||
OUTPUT_PADDEDTRACK=$OUTPUT_TRACK
|
||
if [ -n "$OUTPUT_PADDEDTRACK" ]; then
|
||
[ ${OUTPUT_PADDEDTRACK} -lt 10 ] && OUTPUT_PADDEDTRACK="0$OUTPUT_PADDEDTRACK"
|
||
fi
|
||
|
||
OUTPUT_FOLDER=$(eval echo $OUTPUT_FOLDER)
|
||
OUTPUT_FILE=$(eval echo $OUTPUT_FILE)
|
||
unset OUTPUT_FILE_ORIGINAL
|
||
|
||
if [ -e "$OUTPUT_FOLDER/$OUTPUT_FILE.$OUTPUT_EXT" ]; then
|
||
if [ $OVERWRITE = "-n" ]; then
|
||
## If file exist, we append a unique timestamp to the name.
|
||
OUTPUT_FILE="$OUTPUT_FILE-$(date '+%F-%H%M%S')"
|
||
OUTPUT_MSG="$(tput setf 1)$(tput bold)(Warning: destination exists, appending timestamp.)$(tput sgr0)"
|
||
else
|
||
## WARNING: here it is important that no folder are suffixed by slashes.
|
||
if [ "$INPUT_FOLDER/$INPUT_FILE.$INPUT_EXT" = "$OUTPUT_FOLDER/$OUTPUT_FILE.$OUTPUT_EXT" ]; then
|
||
OUTPUT_FILE_ORIGINAL="$OUTPUT_FILE"
|
||
OUTPUT_FILE="$OUTPUT_FILE-$(date '+%F-%H%M%S')"
|
||
fi
|
||
OUTPUT_MSG="$(tput setf 4)$(tput bold)(Warning: overwriting destination!)$(tput sgr0)"
|
||
fi
|
||
fi
|
||
|
||
##==============================================================================
|
||
## PREVIEW
|
||
|
||
## Note: most (all?) shell printf have an alignment issue when strings contain
|
||
## wide characters. We need to use AWK for proper alignment. Hence the 'aprint'
|
||
## function.
|
||
|
||
ATTR_WIDTH="%-13.13s" # Length of longest attribute +2
|
||
## INPUT_WIDTH = COLUNMS - ATTR_WIDTH -2 (for |))
|
||
INPUT_WIDTH=$((($(tput cols)-15)/2))
|
||
INPUT_WIDTH="%$INPUT_WIDTH.${INPUT_WIDTH}s"
|
||
|
||
## This function is somewhat weak if the separator is found in tags.
|
||
aprint()
|
||
{
|
||
awk -F' *;; *' -v FMT="$INPUT_WIDTH | $ATTR_WIDTH| %s\n" '{printf FMT, $1, $2, $3 }'
|
||
}
|
||
|
||
aprint <<EOF
|
||
:: INTPUT :: ;; ;; :: OUTPUT ::
|
||
[$INPUT_ARTIST] ;; Artist ;; [$OUTPUT_ARTIST]
|
||
[$INPUT_ALBUM] ;; Album ;; [$OUTPUT_ALBUM]
|
||
[$INPUT_TRACK] ;; Track ;; [$OUTPUT_TRACK]
|
||
[$INPUT_TITLE] ;; Title ;; [$OUTPUT_TITLE]
|
||
[$INPUT_DATE] ;; Date ;; [$OUTPUT_DATE]
|
||
[$INPUT_GENRE] ;; Genre ;; [$OUTPUT_GENRE]
|
||
[$INPUT_EXT] ;; Ext ;; [$OUTPUT_EXT]
|
||
[$INPUT_BITRATE] ;; Bitrate ;; [$OUTPUT_BITRATE]
|
||
[$INPUT_ALBUMARTIST] ;; Albumartist ;;
|
||
[$INPUT_COMPOSER] ;; Composer ;;
|
||
[$INPUT_DISC] ;; Disc ;;
|
||
[$INPUT_TYER] ;; Tyer ;;
|
||
EOF
|
||
|
||
cat <<EOF
|
||
:: OUTPUT $OUTPUT_MSG
|
||
[$OUTPUT_FOLDER/$OUTPUT_FILE.$OUTPUT_EXT]
|
||
EOF
|
||
|
||
$PREVIEW && exit
|
||
|
||
##==============================================================================
|
||
## RUN PROCESS
|
||
|
||
## Make sure directory exists.
|
||
mkdir -p "$OUTPUT_FOLDER"
|
||
if [ $? -ne 0 ]; then
|
||
echo "ERROR: could not create output folder [$OUTPUT]."
|
||
exit
|
||
fi
|
||
|
||
## COVER. We copy cover only if it does not already exist. Only files found in
|
||
## the folder where the music is located will be taken into account.
|
||
while read -r i; do
|
||
[ -z "$i" ] && break
|
||
OUTPUT_COVER="$OUTPUT_FOLDER/${OUTPUT_ALBUM:+$OUTPUT_ALBUM - }Cover"
|
||
OUTPUT_COVERFILE="$OUTPUT_COVER.${i##*.}"
|
||
COVER_COUNTER=1
|
||
|
||
## Same cover is already in target folder.
|
||
if [ -e "$OUTPUT_COVERFILE" ] && \
|
||
[ "$(sha1sum "$OUTPUT_COVERFILE" | cut -f1 -d' ')" = "$(sha1sum "$i" | cut -f1 -d' ')" ]; then
|
||
continue
|
||
fi
|
||
|
||
## Different cover with same name is in target folder. We append a number.
|
||
while [ -e "$OUTPUT_COVERFILE" ] && \
|
||
[ ! "$(sha1sum "$OUTPUT_COVERFILE" | cut -f1 -d' ')" = "$(sha1sum "$i" | cut -f1 -d' ')" ]; do
|
||
OUTPUT_COVERFILE="${OUTPUT_COVER} $COVER_COUNTER.${i##*.}"
|
||
COVER_COUNTER=$(($COVER_COUNTER+1))
|
||
done
|
||
|
||
echo ":: COVER [$i] from $INPUT_FOLDER"
|
||
cp -nv "$i" "$OUTPUT_COVERFILE"
|
||
echo
|
||
done <<EOF
|
||
$(find "$INPUT_FOLDER" -maxdepth 1 \( -iname '*.png' -o -iname '*.jpg' \) )
|
||
EOF
|
||
|
||
## Zsh compatibility. We need it otherwise word splitting of parameter like
|
||
## OGG_PARAM will not work.
|
||
STATUS="$(set -o | grep 'shwordsplit' | awk '{print $2}')"
|
||
[ "$STATUS" = "off" ] && set -o shwordsplit
|
||
|
||
## TAG/RECODE
|
||
## With the -map_metadata parameter we clear all metadata.
|
||
echo ":: Processing..."
|
||
ffmpeg $LOGLEVEL $OVERWRITE -i "$1" -vn -sn $OGG_PARAM \
|
||
-map_metadata -1 \
|
||
-metadata title="$OUTPUT_TITLE" \
|
||
-metadata artist="$OUTPUT_ARTIST" \
|
||
-metadata track="$OUTPUT_TRACK" \
|
||
-metadata date="$OUTPUT_DATE" \
|
||
-metadata album="$OUTPUT_ALBUM" \
|
||
-metadata album_artist="$OUTPUT_ARTIST" \
|
||
-metadata genre="$OUTPUT_GENRE" \
|
||
"$OUTPUT_FOLDER/$OUTPUT_FILE.$OUTPUT_EXT"
|
||
echo ":: Process finished!"
|
||
|
||
## If we are overwriting inplace.
|
||
if [ -n "$OUTPUT_FILE_ORIGINAL" ]; then
|
||
mv -f "$OUTPUT_FOLDER/$OUTPUT_FILE.$OUTPUT_EXT" "$OUTPUT_FOLDER/$OUTPUT_FILE_ORIGINAL.$OUTPUT_EXT"
|
||
fi
|
||
echo
|
||
|
||
## Restore Zsh previous options. This will not turn off shwordsplit if it
|
||
## was on before calling the function.
|
||
[ "$STATUS" = "off" ] && set +o shwordsplit
|