Update for GNU find, README cleanup

AAXC support, audible-cli integration

.gitignore

@@ -1,2 +1,6 @@
 ACTIVATION
 .authcode
+*aax
+*jpg
+*json
+Audiobook/*

AAXtoMP3

@@ -1,100 +1,908 @@
 #!/usr/bin/env bash
 
+
+# ========================================================================
+# Command Line Options
+
+# Usage Synopsis.
+usage=$'\nUsage: AAXtoMP3 [--flac] [--aac] [--opus ] [--single] [--level <COMPRESSIONLEVEL>]
+[--chaptered] [-e:mp3] [-e:m4a] [-e:m4b] [--authcode <AUTHCODE>] [--no-clobber]
+[--target_dir <PATH>] [--complete_dir <PATH>] [--validate] [--loglevel <LOGLEVEL>]
+[--keep-author <N>] [--author <AUTHOR>] [--{dir,file,chapter}-naming-scheme <STRING>]  
+[--use-audible-cli-data] [--continue <CHAPTERNUMBER>] {FILES}\n'
+codec=libmp3lame            # Default encoder.
+extension=mp3               # Default encoder extension.
+level=-1                    # Compression level. Can be given for mp3, flac and opus. -1 = default/not specified.
+mode=chaptered              # Multi file output
+auth_code=                  # Required to be set via file or option.
+targetdir=                  # Optional output location.  Note default is basedir of AAX file.
+dirNameScheme=              # Custom directory naming scheme, default is $genre/$author/$title
+customDNS=0
+fileNameScheme=             # Custom file naming scheme, default is $title
+customFNS=0
+chapterNameScheme=          # Custom chapter naming scheme, default is '$title-$(printf %0${#chaptercount}d $chapternum) $chapter' (BookTitle-01 Chapter 1)
+customCNS=0
+completedir=                # Optional location to move aax files once the decoding is complete.
+container=mp3               # Just in case we need to change the container.  Used for M4A to M4B
+VALIDATE=0                  # Validate the input aax file(s) only.  No Transcoding of files will occur
+loglevel=1                  # Loglevel: 0: Show progress only; 1: default; 2: a little more information, timestamps; 3: debug
+noclobber=0                 # Default off, clobber only if flag is enabled
+continue=0                  # Default off, If set Transcoding is skipped and chapter splitting starts at chapter continueAt.
+continueAt=1                # Optional chapter to continue splitting the chapters.
+keepArtist=-1               # Default off, if set change author metadata to use the passed argument as field
+authorOverride=             # Override the author, ignoring the metadata           
+audibleCli=0                # Default off, Use additional data gathered from mkb79/audible-cli
+aaxc_key=                   # Initialize variables, in case we need them in debug_vars
+aaxc_iv=                    # Initialize variables, in case we need them in debug_vars
+
+# -----
+# Code tip Do not have any script above this point that calls a function or a binary.  If you do
+# the $1 will no longer be a ARGV element.  So you should only do basic variable setting above here.
+#
+# Process the command line options.  This allows for un-ordered options. Sorta like a getops style
+while true; do
+  case "$1" in
+                      # Flac encoding
+    -f | --flac       ) codec=flac; extension=flac; mode=single; container=flac;        shift ;;
+                      # Apple m4a music format.
+    -a | --aac        ) codec=copy; extension=m4a; mode=single; container=m4a;          shift ;;
+                      # Ogg Format
+    -o | --opus       ) codec=libopus; extension=opus; container=ogg;                   shift ;;
+                      # If appropriate use only a single file output.
+    -s | --single     ) mode=single;                                                    shift ;;
+                      # If appropriate use only a single file output.
+    -c | --chaptered  ) mode=chaptered;                                                 shift ;;
+                      # This is the same as --single option.
+    -e:mp3            ) codec=libmp3lame; extension=mp3; mode=single; container=mp3;    shift ;;
+                      # Identical to --acc option.
+    -e:m4a            ) codec=copy; extension=m4a; mode=single; container=mp4;          shift ;;
+                      # Similar to --aac but specific to audio books
+    -e:m4b            ) codec=copy; extension=m4b; mode=single; container=mp4;          shift ;;
+                      # Change the working dir from AAX directory to what you choose.
+    -t | --target_dir ) targetdir="$2";                                                 shift 2 ;;
+                      # Use a custom directory naming scheme, with variables.
+    -D | --dir-naming-scheme ) dirNameScheme="$2"; customDNS=1;                         shift 2 ;;
+                      # Use a custom file naming scheme, with variables.
+    -F | --file-naming-scheme ) fileNameScheme="$2"; customFNS=1;                       shift 2 ;;
+                       # Use a custom chapter naming scheme, with variables.
+    --chapter-naming-scheme ) chapterNameScheme="$2"; customCNS=1;                      shift 2 ;;
+                      # Move the AAX file to a new directory when decoding is complete.
+    -C | --complete_dir ) completedir="$2";                                             shift 2 ;;
+                      # Authorization code associate with the AAX file(s)
+    -A | --authcode   ) auth_code="$2";                                                 shift 2 ;;
+                      # Don't overwrite the target directory if it already exists
+    -n | --no-clobber ) noclobber=1;                                                    shift ;;
+                      # Extremely verbose output.
+    -d | --debug      ) loglevel=3;                                                     shift ;;
+                      # Set loglevel.
+    -l | --loglevel   ) loglevel="$2";                                                  shift 2 ;;
+                      # Validate ONLY the aax file(s) No transcoding occurs
+    -V | --validate   ) VALIDATE=1;                                                     shift ;;
+                      # continue splitting chapters at chapter continueAt
+    --continue        ) continueAt="$2"; continue=1;                                    shift 2 ;;
+                      # Use additional data got with mkb79/audible-cli
+    --use-audible-cli-data ) audibleCli=1;                                              shift ;;
+                      # Compression level
+    --level           ) level="$2";                                                     shift 2 ;;
+                      # Keep author number n
+    --keep-author     ) keepArtist="$2";                                                shift 2 ;;
+                      # Author override
+    --author          ) authorOverride="$2";                                            shift 2 ;;
+                      # Command synopsis.
+    -h | --help       ) printf "$usage" $0 ;                                            exit ;;
+                      # Standard flag signifying the end of command line processing.
+    --                )                                                                 shift; break ;;
+                      # Anything else stops command line processing.
+    *                 )                                                                 break ;;
+
+  esac
+done
+
+# -----
+# Empty argv means we have nothing to do so lets bark some help.
+if [ "$#" -eq 0 ]; then
+  printf "$usage" $0
+  exit 1
+fi
+
+# Setup safer bash script defaults.
 set -o errexit -o noclobber -o nounset -o pipefail
 
-codec=libmp3lame
-extension=mp3
-mode=chaptered
-
-if [ "$#" -eq 0 ]; then
-        echo "Usage: bash AAXtoMP3.sh [--flac] [--single] AUTHCODE {FILES}"
-        exit 1
-fi
-
-if [[ "$1" = '--flac' ]]
-then
-    codec=flac
-    extension=flac
-    shift
-fi
-
-if [[ "$1" == '--single' ]]
-then
-    mode=single
-    shift
-fi
-
-if [ ! -f .authcode ]; then
-    auth_code=$1
-    shift
-else
-    auth_code=`head -1 .authcode`
-fi
+# ========================================================================
+# Utility Functions
 
+# -----
+# debug
+# debug "Some longish message"
 debug() {
-    echo "$(date "+%F %T%z") ${1}"
+  if [ $loglevel == 3 ] ; then
+    echo "$(date "+%F %T%z") DEBUG ${1}"
+  fi
 }
 
+# -----
+# debug dump contents of a file to STDOUT
+# debug "<full path to file>"
+debug_file() {
+  if [ $loglevel == 3 ] ; then
+    echo "$(date "+%F %T%z") DEBUG"
+    echo "=Start=========================================================================="
+    cat "${1}"
+    echo "=End============================================================================"
+  fi
+}
+
+# -----
+# debug dump a list of internal script variables to STDOUT
+# debug_vars "Some Message" var1 var2 var3 var4 var5
+debug_vars() {
+  if [ $loglevel == 3 ] ; then
+    msg="$1"; shift ; # Grab the message
+    args=("$@")       # Grab the rest of the args
+
+    # determine the length of the longest key
+    l=0
+    for (( n=0; n<${#args[@]}; n++ )) ; do
+      (( "${#args[$n]}" > "$l" )) && l=${#args[$n]}
+    done
+
+    # Print the Debug Message
+    echo "$(date "+%F %T%z") DEBUG ${msg}"
+    echo "=Start=========================================================================="
+
+    # Using the max length of a var name we dynamically create the format.
+    fmt="%-"${l}"s = %s\n"
+
+    for (( n=0; n<${#args[@]}; n++ )) ; do
+      eval val="\$${args[$n]}"              ; # We save off the value of the var in question for ease of coding.
+
+      echo "$(printf "${fmt}" ${args[$n]} "${val}" )"
+    done
+    echo "=End============================================================================"
+  fi
+}
+
+# -----
+# log
+log() {
+  if [ "$((${loglevel} > 1))" == "1" ] ; then
+    echo "$(date "+%F %T%z") ${1}"
+  else
+    echo "${1}"
+  fi
+}
+
+# -----
+#progressbar produces a progressbar in the style of
+# process: |#######             |  XX% (part/total unit)
+# which is gonna be overwritten by the next line.
+
+progressbar() {
+  #get input
+  part=${1}
+  total=${2}
+
+  #compute percentage and make print_percentage the same length regardless of the number of digits.
+  percentage=$((part*100/total))
+  if [ "$((percentage<10))" = "1" ]; then print_percentage="  $percentage"
+  elif [ "$((percentage<100))" = "1" ]; then print_percentage=" $percentage"
+  else print_percentage="$percentage"; fi
+
+  #draw progressbar with one # for every 5% and blank spaces for the missing part.
+  progressbar=""
+  for (( n=0; n<(percentage/5); n++ )) ; do progressbar="$progressbar#"; done
+  for (( n=0; n<(20-(percentage/5)); n++ )) ; do progressbar="$progressbar "; done
+
+  #print progressbar
+  echo -ne "Chapter splitting: |$progressbar| $print_percentage% ($part/$total chapters)\r"
+}
+# Print out what we have already after command line processing.
+debug_vars "Command line options as set" codec extension mode container targetdir completedir auth_code keepArtist authorOverride audibleCli
+
+# ========================================================================
+# Variable validation
+
+if [ $(uname) = 'Linux' ]; then
+    GREP="grep"
+    FIND="find"
+    SED="sed"
+else
+    GREP="ggrep"
+    FIND="gfind"
+    SED="gsed"
+fi
+
+
+# -----
+# Detect which annoying version of grep we have
+if ! [[ $(type -P "$GREP") ]]; then
+  echo "$GREP (GNU grep) is not in your PATH"
+  echo "Without it, this script will break."
+  echo "On macOS, you may want to try: brew install grep"
+  exit 1
+fi
+
+# -----
+# Detect which annoying version of find we have
+if ! [[ $(type -P "$FIND") ]]; then
+  echo "$FIND (GNU find) is not in your PATH"
+  echo "Without it, this script will break."
+  echo "On macOS, you may want to try: brew install findutils"
+  exit 1
+fi
+
+# -----
+# Detect which annoying version of sed we have
+if ! [[ $(type -P "$SED") ]]; then
+  echo "$SED (GNU sed) is not in your PATH"
+  echo "Without it, this script will break."
+  echo "On macOS, you may want to try: brew install gnu-sed"
+  exit 1
+fi
+
+# -----
+# Detect ffmpeg and ffprobe
+if [[ "x$(type -P ffmpeg)" == "x" ]]; then
+  echo "ERROR ffmpeg was not found on your env PATH variable"
+  echo "Without it, this script will break."
+  echo "INSTALL:"
+  echo "MacOS:           brew install ffmpeg"
+  echo "Ubuntu:          sudo apt-get update; sudo apt-get install ffmpeg libav-tools x264 x265 bc"
+  echo "Ubuntu (20.04):  sudo apt-get update; sudo apt-get install ffmpeg x264 x265 bc"
+  echo "RHEL:            yum install ffmpeg"
+  exit 1
+fi
+
+# -----
+# Detect ffmpeg and ffprobe
+if [[ "x$(type -P ffprobe)" == "x" ]]; then
+  echo "ERROR ffprobe was not found on your env PATH variable"
+  echo "Without it, this script will break."
+  echo "INSTALL:"
+  echo "MacOS:   brew install ffmpeg"
+  echo "Ubuntu:  sudo apt-get update; sudo apt-get install ffmpeg libav-tools x264 x265 bc"
+  echo "RHEL:    yum install ffmpeg"
+  exit 1
+fi
+
+
+# -----
+# Detect if we need mp4art for cover additions to m4a & m4b files.
+if [[ "x${container}" == "xmp4" && "x$(type -P mp4art)" == "x" ]]; then
+  echo "WARN mp4art was not found on your env PATH variable"
+  echo "Without it, this script will not be able to add cover art to"
+  echo "m4b files. Note if there are no other errors the AAXtoMP3 will"
+  echo "continue. However no cover art will be added to the output."
+  echo "INSTALL:"
+  echo "MacOS:   brew install mp4v2"
+  echo "Ubuntu:  sudo apt-get install mp4v2-utils"
+fi
+
+# -----
+# Detect if we need mp4chaps for adding chapters to m4a & m4b files.
+if [[ "x${container}" == "xmp4" && "x$(type -P mp4chaps)" == "x" ]]; then
+  echo "WARN mp4chaps was not found on your env PATH variable"
+  echo "Without it, this script will not be able to add chapters to"
+  echo "m4a/b files. Note if there are no other errors the AAXtoMP3 will"
+  echo "continue. However no chapter data will be added to the output."
+  echo "INSTALL:"
+  echo "MacOS:   brew install mp4v2"
+  echo "Ubuntu:  sudo apt-get install mp4v2-utils"
+fi
+
+# -----
+# Detect if we need mediainfo for adding description and narrator
+if [[ "x$(type -P mediainfo)" == "x" ]]; then
+  echo "WARN mediainfo was not found on your env PATH variable"
+  echo "Without it, this script will not be able to add the narrator"
+  echo "and description tags. Note if there are no other errors the AAXtoMP3"
+  echo "will continue. However no such tags will be added to the output."
+  echo "INSTALL:"
+  echo "MacOS:   brew install mediainfo"
+  echo "Ubuntu:  sudo apt-get install mediainfo"
+fi
+
+# -----
+# Obtain the authcode from either the command line,  local directory or home directory.
+# See Readme.md for details on how to acquire your personal authcode for your personal
+# audible AAX files.
+if [ -z $auth_code ]; then
+  if [ -r .authcode ]; then
+    auth_code=`head -1 .authcode`
+  elif [ -r ~/.authcode ]; then
+    auth_code=`head -1 ~/.authcode`
+  fi
+fi
+
+# -----
+# Check the target dir for if set if it is writable
+if [[ "x${targetdir}" != "x"  ]]; then
+  if [[ ! -w "${targetdir}" || ! -d "${targetdir}" ]] ; then
+    echo "ERROR Target Directory does not exist or is not writable: \"$targetdir\""
+    echo "$usage"
+    exit 1
+  fi
+fi
+
+# -----
+# Check the completed dir for if set if it is writable
+if [[ "x${completedir}" != "x"  ]]; then
+  if [[ ! -w "${completedir}" || ! -d "${completedir}" ]] ; then
+    echo "ERROR Complete Directory does not exist or is not writable: \"$completedir\""
+    echo "$usage"
+    exit 1
+  fi
+fi
+
+# -----
+# Check whether the loglevel is valid
+if [ "$((${loglevel} < 0 || ${loglevel} > 3 ))" = "1" ]; then
+  echo "ERROR loglevel has to be in the range from 0 to 3!"
+  echo "      0: Show progress only"
+  echo "      1: default"
+  echo "      2: a little more information, timestamps"
+  echo "      3: debug"
+  echo "$usage"
+  exit 1
+fi
+# -----
+# If a compression level is given, check whether the given codec supports compression level specifiers and whether the level is valid.
+if [ "${level}" != "-1" ]; then
+  if [ "${codec}" == "flac" ]; then
+    if [ "$((${level} < 0 || ${level} > 12 ))" = "1" ]; then
+      echo "ERROR Flac compression level has to be in the range from 0 to 12!"
+      echo "$usage"
+      exit 1
+    fi
+  elif [ "${codec}" == "libopus" ]; then
+    if [ "$((${level} < 0 || ${level} > 10 ))" = "1" ]; then
+      echo "ERROR Opus compression level has to be in the range from 0 to 10!"
+      echo "$usage"
+      exit 1
+    fi
+  elif [ "${codec}" == "libmp3lame" ]; then
+    if [ "$((${level} < 0 || ${level} > 9 ))" = "1" ]; then
+      echo "ERROR MP3 compression level has to be in the range from 0 to 9!"
+      echo "$usage"
+      exit 1
+    fi
+  else
+    echo "ERROR This codec doesnt support compression levels!"
+    echo "$usage"
+    exit 1
+  fi
+fi
+
+# -----
+# Clean up if someone hits ^c or the script exits for any reason.
 trap 'rm -r -f "${working_directory}"' EXIT
+
+# -----
+# Set up some basic working files ASAP.  Note the trap will clean this up no matter what.
 working_directory=`mktemp -d 2>/dev/null || mktemp -d -t 'mytmpdir'`
 metadata_file="${working_directory}/metadata.txt"
 
+# -----
+# Validate the AAX and extract the metadata associated with the file.
+validate_aax() {
+  local media_file
+  media_file="$1"
+
+  # Test for existence
+  if [[ ! -r "${media_file}" ]] ; then
+    log "ERROR File NOT Found: ${media_file}"
+    return 1
+  else
+    if [[ "${VALIDATE}" == "1" ]]; then
+      log "Test 1 SUCCESS: ${media_file}"
+    fi
+  fi
+
+  # Clear the errexit value we want to capture the output of the ffprobe below.
+  set +e errexit
+
+  # Take a look at the aax file and see if it is valid. If the source file is aaxc, we give ffprobe additional flags
+  output="$(ffprobe -loglevel warning ${decrypt_param} -i "${media_file}" 2>&1)"
+
+  # If invalid then say something.
+  if [[ $? != "0" ]] ; then
+    # No matter what lets bark that something is wrong.
+    log "ERROR: Invalid File: ${media_file}"
+  elif [[ "${VALIDATE}" == "1" ]]; then
+    # If the validate option is present then lets at least state what is valid.
+    log "Test 2 SUCCESS: ${media_file}"
+  fi
+
+  # This is a big test only performed when the --validate switch is passed.
+  if [[ "${VALIDATE}" == "1" ]]; then
+    output="$(ffmpeg -hide_banner ${decrypt_param} -i "${media_file}" -vn -f null - 2>&1)"
+    if [[ $? != "0" ]] ; then
+      log "ERROR: Invalid File: ${media_file}"
+    else
+      log "Test 3 SUCCESS: ${media_file}"
+    fi
+  fi
+
+  # Dump the output of the ffprobe command.
+  debug "$output"
+
+  # Turn it back on.  ffprobe is done.
+  set -e errexit
+}
+
+validate_extra_files() {
+  local extra_media_file extra_find_command
+  extra_media_file="$1"
+  # Bash trick to delete, non greedy, from the end up until the first '-'
+  extra_title="${extra_media_file%-*}"
+
+  # Using this is not ideal, because if the naming scheme is changed then
+  # this part of the script will break
+  # AAX file: BookTitle-LC_128_44100_stereo.aax
+  # Cover file: BookTitle_(1215).jpg
+  # Chapter file: BookTitle-chapters.json
+
+  # Chapter
+  extra_chapter_file="${extra_title}-chapters.json"
+
+  # Cover
+  extra_dirname="$(dirname "${extra_media_file}")"
+  extra_find_command='$FIND "${extra_dirname}" -maxdepth 1 -regex ".*/${extra_title##*/}_([0-9]+)\.jpg"'
+  # We want the output of the find command, we will turn errexit on later
+  set +e errexit
+  extra_cover_file="$(eval ${extra_find_command})"
+  extra_eval_comm="$(eval echo ${extra_find_command})"
+  set -e errexit
+
+  if [[ "${aaxc}" == "1" ]]; then
+    # bash trick to get file w\o extention (delete from end to the first '.')
+    extra_voucher="${extra_media_file%.*}.voucher"
+    if [[ ! -r "${extra_voucher}" ]] ; then
+      log "ERROR File NOT Found: ${extra_voucher}"
+      return 1
+    fi
+    aaxc_key=$(jq -r '.content_license.license_response.key' "${extra_voucher}")
+    aaxc_iv=$(jq -r '.content_license.license_response.iv' "${extra_voucher}")
+  fi
+
+  debug_vars "Audible-cli variables" extra_media_file extra_title extra_chapter_file extra_cover_file extra_find_command extra_eval_comm extra_dirname extra_voucher aaxc_key aaxc_iv
+
+  # Test for chapter file existence
+  if [[ ! -r "${extra_chapter_file}" ]] ; then
+    log "ERROR File NOT Found: ${extra_chapter_file}"
+    return 1
+  fi
+  if [[ "x${extra_cover_file}" == "x" ]] ; then
+    log "ERROR Cover File NOT Found"
+    return 1
+  fi
+
+  debug "All expected audible-cli related file are here"
+}
+
+# -----
+# Inspect the AAX and extract the metadata associated with the file.
 save_metadata() {
-    local media_file
-    media_file="$1"
-    ffprobe -i "$media_file" 2> "$metadata_file"
+  local media_file
+  media_file="$1"
+  ffprobe -i "$media_file" 2> "$metadata_file"
+  if [[ $(type -P mediainfo) ]]; then
+    echo "Mediainfo data START" >> "$metadata_file"
+    # Mediainfo output is structured like ffprobe, so we append it to the metadata file and then parse it with get_metadata_value()
+    # mediainfo "$media_file" >> "$metadata_file"
+    # Or we only get the data we are intrested in:
+    # Description
+    echo "Track_More :" "$(mediainfo --Inform="General;%Track_More%" "$media_file")" >> "$metadata_file"
+    # Narrator
+    echo "nrt :" "$(mediainfo --Inform="General;%nrt%" "$media_file")" >> "$metadata_file"
+    # Publisher
+    echo "pub :" "$(mediainfo --Inform="General;%pub%" "$media_file")" >> "$metadata_file"
+    echo "Mediainfo data END" >> "$metadata_file"
+  fi
+  if [[ "${audibleCli}" == "1" ]]; then
+    # If we use data we got with audible-cli, we delete conflicting chapter infos
+    $SED -i '/^    Chapter #/d' "${metadata_file}"
+    # Some magic: we parse the .json generated by audible-cli.
+    # to get the output structure like the one generated by ffprobe, 
+    # we use some characters (#) as placeholder, add some new lines,
+    # put a ',' after the start value, we calculate the end of each chapter
+    # as start+length, and we convert (divide) the time stamps from ms to s.
+    # Then we delete all ':' since they make a filename invalid.
+    jq -r '.content_metadata.chapter_info.chapters[] | "Chapter # start: \(.start_offset_ms/1000), end: \((.start_offset_ms+.length_ms)/1000) \n#\n# Title: \(.title)"' "${extra_chapter_file}" \
+      | tr -d ':' >> "$metadata_file"
+  fi
+  debug "Metadata file $metadata_file"
+  debug_file "$metadata_file"
 }
 
+# -----
+# Reach into the meta data and extract a specific value.
+#   This is a long pipe of transforms.
+#   This finds the first occurrence of the key : value pair.
 get_metadata_value() {
-    local key
-    key="$1"
-    normalize_whitespace "$(grep --max-count=1 --only-matching "${key} *: .*" "$metadata_file" | cut -d : -f 2 | sed -e 's#/##g;s/ (Unabridged)//' | tr -s '[:blank:]' ' ')"
+  local key
+  key="$1"
+        # Find the key in the meta data file                                  # Extract field value     # Remove the following /'s  "(Unabridged)  <blanks> at start end and multiples.
+  echo "$($GREP --max-count=1 --only-matching "${key} *: .*" "$metadata_file" | cut -d : -f 2- | $SED -e 's#/##g;s/ (Unabridged)//;s/^[[:blank:]]\+//g;s/[[:blank:]]\+$//g' | $SED 's/[[:blank:]]\+/ /g')"
 }
 
+# -----
+# specific variant of get_metadata_value bitrate is important for transcoding.
 get_bitrate() {
-    get_metadata_value bitrate | grep --only-matching '[0-9]\+'
+  get_metadata_value bitrate | $GREP --only-matching '[0-9]\+'
 }
 
-normalize_whitespace() {
-    echo $*
-}
-
-for path
+# Save the original value, since in the for loop we overwrite
+# $audibleCli in case the file is aaxc. If the file is the
+# old aax, reset the variable to be the one passed by the user
+originalAudibleCliVar=$audibleCli
+# ========================================================================
+# Main Transcode Loop
+for aax_file
 do
-    debug "Decoding ${path} with auth code ${auth_code}..."
+  # If the file is in aaxc format, set the proper variables
+  if [[ ${aax_file##*.} == "aaxc" ]]; then
+    # File is the new .aaxc
+    aaxc=1
+    audibleCli=1
+  else
+    # File is the old .aax
+    aaxc=0
+    # If some previous file in the loop are aaxc, the $audibleCli variable has been overwritten, so we reset it to the original one
+    audibleCli=$originalAudibleCliVar
+  fi
 
-    save_metadata "${path}"
-    genre=$(get_metadata_value genre)
-    artist=$(get_metadata_value artist)
-    title=$(get_metadata_value title)
-    output_directory="$(dirname "${path}")/${genre}/${artist}/${title}"
-    mkdir -p "${output_directory}"
-    full_file_path="${output_directory}/${title}.${extension}"
+  debug_vars "Variables set based on file extention" aaxc originalAudibleCliVar audibleCli
 
-    </dev/null ffmpeg -loglevel error -stats -activation_bytes "${auth_code}" -i "${path}" -vn -codec:a "${codec}" -ab "$(get_bitrate)k" -map_metadata -1 -metadata title="${title}" -metadata artist="${artist}" -metadata album_artist="$(get_metadata_value album_artist)" -metadata album="$(get_metadata_value album)" -metadata date="$(get_metadata_value date)" -metadata track="1/1" -metadata genre="${genre}" -metadata copyright="$(get_metadata_value copyright)" "${full_file_path}"
+  # No point going on if no authcode found and the file is aax.
+  # If we use aaxc as input, we do not need it
+  # if the string $auth_code is null and the format is not aaxc; quit. We need the authcode
+  if [ -z $auth_code ] && [ "${aaxc}" = "0" ]; then
+    echo "ERROR Missing authcode, can't decode $aax_file"
+    echo "$usage"
+    exit 1
+  fi
 
-    debug "Created ${full_file_path}."
+  # Validate the input aax file.  Note this happens no matter what.
+  # It's just that if the validate option is set then we skip to next file.
+  # If however validate is not set and we proceed with the script any errors will
+  # case the script to stop.
 
-    if [ "${mode}" == "chaptered" ]; then
-        debug "Extracting chapter files from ${full_file_path}..."
+  # If the input file is aaxc, we need to first get the audible_key and audible_iv
+  # We get them in the function validate_extra_files
 
-        while read -r -u9 first _ _ start _ end
-        do
-            if [[ "${first}" = "Chapter" ]]
-            then
-                read -r -u9 _
-                read -r -u9 _ _ chapter
-                chapter_file="${output_directory}/${title} - ${chapter}.${extension}"
-                </dev/null ffmpeg -loglevel error -stats -i "${full_file_path}" -ss "${start%?}" -to "${end}" -codec:a copy -metadata track="${chapter}" "${chapter_file}"
-            fi
-        done 9< "$metadata_file"
-        rm "${full_file_path}"
-        debug "Done creating chapters. Chaptered files contained in ${output_directory}."
+  if [[ ${audibleCli} == "1" ]] ; then
+    # If we have additional files (obtained via audible-cli), be sure that they
+    # exists and they are in the correct location.
+    validate_extra_files "${aax_file}"
+  fi
+
+  # Set the needed params to decrypt the file. Needed in all command that require ffprobe or ffmpeg
+  # After validate_extra_files, since the -audible_key and -audible_iv are read in that function
+  if [[ ${aaxc} == "1" ]] ; then
+    decrypt_param="-audible_key ${aaxc_key} -audible_iv ${aaxc_iv}"
+  else
+    decrypt_param="-activation_bytes ${auth_code}"
+  fi
+
+  validate_aax "${aax_file}"
+  if [[ ${VALIDATE} == "1" ]] ; then
+    # Don't bother doing anything else with this file.
+    continue
+  fi
+
+  # -----
+  # Make sure everything is a variable.  Simplifying Command interpretation
+  save_metadata "${aax_file}"
+  genre=$(get_metadata_value genre)
+  if [ "x${authorOverride}" != "x" ]; then
+    #Manual Override
+    artist="${authorOverride}"
+    album_artist="${authorOverride}"
+  else
+    if [ "${keepArtist}" != "-1" ]; then
+      # Choose artist from the one that are present in the metadata. Comma separated list of names
+      #                                                                 remove leading space;     'C. S. Lewis' -> 'C.S. Lewis'
+      artist="$(get_metadata_value artist | cut -d',' -f"$keepArtist" | $SED -E 's|^ ||g; s|\. +|\.|g; s|((\w+\.)+)|\1 |g')"
+      album_artist="$(get_metadata_value album_artist | cut -d',' -f"$keepArtist" | $SED -E 's|^ ||g; s|\. +|\.|g; s|((\w+\.)+)|\1 |g')"
+    else
+      # The default
+      artist=$(get_metadata_value artist)
+      album_artist="$(get_metadata_value album_artist)"
+    fi
+  fi
+  title=$(get_metadata_value title)
+  title=${title:0:128}
+  bitrate="$(get_bitrate)k"
+  album="$(get_metadata_value album)"
+  album_date="$(get_metadata_value date)"
+  copyright="$(get_metadata_value copyright)"
+
+  # Get more tags with mediainfo
+  if [[ $(type -P mediainfo) ]]; then
+    narrator="$(get_metadata_value nrt)"
+    description="$(get_metadata_value Track_More)"
+    publisher="$(get_metadata_value pub)"
+  else
+    narrator=""
+    description=""
+    publisher=""
+  fi
+
+  # Define the output_directory
+  if [ "${customDNS}" == "1" ]; then
+    currentDirNameScheme="$(eval echo "${dirNameScheme}")"
+  else
+    # The Default
+    currentDirNameScheme="${genre}/${artist}/${title}"
+  fi
+
+  # If we defined a target directory, use it. Otherwise use the location of the AAX file
+  if [ "x${targetdir}" != "x" ] ; then
+    output_directory="${targetdir}/${currentDirNameScheme}/"
+  else
+    output_directory="$(dirname "${aax_file}")/${currentDirNameScheme}/"
+  fi
+
+  # Define the output_file
+  if [ "${customFNS}" == "1" ]; then
+    currentFileNameScheme="$(eval echo "${fileNameScheme}")"
+  else
+    # The Default
+    currentFileNameScheme="${title}"
+  fi
+  output_file="${output_directory}/${currentFileNameScheme}.${extension}"
+
+  if [[ "${noclobber}" = "1" ]] && [[ -d "${output_directory}" ]]; then
+    log "Noclobber enabled but directory '${output_directory}' exists. Exiting to avoid overwriting"
+    exit 0
+  fi
+  mkdir -p "${output_directory}"
+
+  if [ "$((${loglevel} > 0))" = "1" ]; then
+    # Fancy declaration of which book we are decoding.  Including the AUTHCODE.
+    dashline="----------------------------------------------------"
+    log "$(printf '\n----Decoding---%s%s--%s--' "${title}" "${dashline:${#title}}" "${auth_code}")"
+    log "Source: ${aax_file}"
+  fi
+
+  # Big long DEBUG output. Fully describes the settings used for transcoding.
+  # Note this is a long debug command. It's not critical to operation. It's purely for people debugging
+  # and coders wanting to extend the script.
+  debug_vars "Book and Variable values" title auth_code aaxc aaxc_key aaxc_iv mode aax_file container codec bitrate artist album_artist album album_date genre copyright narrator description publisher currentDirNameScheme output_directory currentFileNameScheme output_file metadata_file working_directory
+
+
+  # Display the total length of the audiobook in format hh:mm:ss
+  # 10#$var force base-10 interpretation. By default it's base-8, so values like 08 or 09 are not octal numbers
+  total_length="$(ffprobe -v error ${decrypt_param} -show_entries format=duration -of default=noprint_wrappers=1:nokey=1 "${aax_file}" | cut -d . -f 1)"
+  hours="$((total_length/3600))"
+  if [ "$((hours<10))" = "1" ]; then hours="0$hours"; fi
+  minutes="$((total_length/60-60*10#$hours))"
+  if [ "$((minutes<10))" = "1" ]; then minutes="0$minutes"; fi
+  seconds="$((total_length-3600*10#$hours-60*10#$minutes))"
+  if [ "$((seconds<10))" = "1" ]; then seconds="0$seconds"; fi
+  log "Total length: $hours:$minutes:$seconds"
+  
+  # If level != -1 specify a compression level in ffmpeg.
+  compression_level_param=""
+  if [ "${level}" != "-1" ]; then
+    compression_level_param="-compression_level ${level}"
+  fi
+  
+  # -----
+  if [ "${continue}" == "0" ]; then
+    # This is the main work horse command.  This is the primary transcoder.
+    # This is the primary transcode. All the heavy lifting is here.
+    debug 'ffmpeg -loglevel error -stats ${decrypt_param} -i "${aax_file}" -vn -codec:a "${codec}" -ab ${bitrate} -map_metadata -1 -metadata title="${title}" -metadata artist="${artist}" -metadata album_artist="${album_artist}" -metadata album="${album}" -metadata date="${album_date}" -metadata track="1/1" -metadata genre="${genre}" -metadata copyright="${copyright}" "${output_file}"'
+    </dev/null ffmpeg -loglevel error \
+      -stats \
+      ${decrypt_param} \
+      -i "${aax_file}" \
+      -vn \
+      -codec:a "${codec}" \
+      ${compression_level_param} \
+      -ab ${bitrate} \
+      -map_metadata -1 \
+      -metadata title="${title}" \
+      -metadata artist="${artist}" \
+      -metadata album_artist="${album_artist}" \
+      -metadata album="${album}" \
+      -metadata date="${album_date}" \
+      -metadata track="1/1" \
+      -metadata genre="${genre}" \
+      -metadata copyright="${copyright}" \
+      -metadata description="${description}" \
+      -metadata composer="${narrator}" \
+      -metadata publisher="${publisher}" \
+      -f ${container} \
+      "${output_file}"
+    if [ "$((${loglevel} > 0))" == "1" ]; then
+      log "Created ${output_file}."
+    fi
+    # -----
+  fi
+  # Grab the cover art if available.
+  cover_file="${output_directory}/cover.jpg"
+  extra_crop_cover=''
+  if [ "${continue}" == "0" ]; then
+    if [ "${audibleCli}" == "1" ]; then
+      # We have a better quality cover file, copy it.
+      if [ "$((${loglevel} > 1))" == "1" ]; then
+        log "Copy cover file to ${cover_file}..."
+      fi
+      cp "${extra_cover_file}" "${cover_file}"
+
+      # We now set a variable, ${extra_crop_cover}, which contains an additional
+      # ffmpeg flag. It crops the cover so the width and the height is divisible by two.
+      # Since the standard (in the aax file) image resolution is 512, we set the flag
+      # only if we use a custom cover art.
+      extra_crop_cover='-vf crop=trunc(iw/2)*2:trunc(ih/2)*2'
+    else
+      # Audible-cli not used, extract the cover from the aax file
+      if [ "$((${loglevel} > 1))" == "1" ]; then
+        log "Extracting cover into ${cover_file}..."
+      fi
+      </dev/null ffmpeg -loglevel error -activation_bytes "${auth_code}" -i "${aax_file}" -an -codec:v copy "${cover_file}"
+    fi
+  fi
+
+  # -----
+  # If mode=chaptered, split the big converted file by chapter and remove it afterwards.
+  # Not all audio encodings make sense with multiple chapter outputs (see options section)
+  if [ "${mode}" == "chaptered" ]; then
+    # Playlist m3u support
+    playlist_file="${output_directory}/${currentFileNameScheme}.m3u"
+    if [ "${continue}" == "0" ]; then
+      if [ "$((${loglevel} > 0))" == "1" ]; then
+        log "Creating PlayList ${currentFileNameScheme}.m3u"
+      fi
+      echo '#EXTM3U' > "${playlist_file}"
     fi
 
-    cover_path="${output_directory}/cover.jpg"
-    debug "Extracting cover into ${cover_path}..."
-    </dev/null ffmpeg -loglevel error -activation_bytes "${auth_code}" -i "${path}" -an -codec:v copy "${cover_path}"
-    debug "Done."
-    rm "${metadata_file}"
+    # Determine the number of chapters.
+    chaptercount=$($GREP -Pc "Chapter.*start.*end" $metadata_file)
+    if [ "$((${loglevel} > 0))" == "1" ]; then
+      log "Extracting ${chaptercount} chapter files from ${output_file}..."
+      if [ "${continue}" == "1" ]; then
+        log "Continuing at chapter ${continueAt}:"
+      fi
+    fi
+    chapternum=1
+    #start progressbar for loglevel 0 and 1
+    if [ "$((${loglevel} < 2))" == "1" ]; then
+      progressbar 0 ${chaptercount}
+    fi
+    # We pipe the metadata_file in read.
+    # Example of the section that we are interested in:
+    #
+    # Chapter #0:0: start 0.000000, end 1928.231474
+    # Metadata:
+    # title           : Chapter 1
+    #
+    # Then read the line in these variables:
+    # first            Chapter
+    # _                #0:0:
+    # _                start
+    # chapter_start    0.000000,
+    # _                end
+    # chapter_end      1928.231474
+    while read -r -u9 first _ _ chapter_start _ chapter_end
+    do
+      # Do things only if the line starts with 'Chapter'
+      if [[ "${first}" = "Chapter" ]]; then
+        # The next line (Metadata:...) gets discarded
+        read -r -u9 _
+        # From the line 'title  :  Chapter 1' we save the third field and those after in chapter
+        read -r -u9 _ _ chapter
+
+        # The formatting of the chapters names and the file names.
+        # Chapter names are used in a few place.
+        # Define the chapter_file
+        if [ "${customCNS}" == "1" ]; then
+          chapter_title="$(eval echo "${chapterNameScheme}")"
+        else
+          # The Default
+          chapter_title="${title}-$(printf %0${#chaptercount}d $chapternum) ${chapter}"
+        fi
+        chapter_file="${output_directory}/${chapter_title}.${extension}"
+
+        # Since the .aax file allready got converted we can use
+        # -acodec copy, which is much faster than a reencodation.
+        # Since there is an issue when using copy on flac, where
+        # the duration of the chapters gets shown as if they where
+        # as long as the whole audiobook.
+        chapter_codec=""
+        if test "${extension}" = "flac"; then
+          chapter_codec="flac "${compression_level_param}""
+        else
+          chapter_codec="copy"
+        fi
+
+        #Since there seems to be a bug in some older versions of ffmpeg, which makes, that -ss and -to
+        #have to be apllied to the output file, this makes, that -ss and -to get applied on the input for
+        #ffmpeg version 4+ and on the output for all older versions.
+        split_input=""
+        split_output=""
+        if [ "$(($(ffmpeg -version | $SED -E 's/[^0-9]*([0-9]).*/\1/g;1q') > 3))" = "1" ]; then
+          split_input="-ss ${chapter_start%?} -to ${chapter_end}"
+        else
+          split_output="-ss ${chapter_start%?} -to ${chapter_end}"
+        fi
+
+        # Big Long chapter debug
+        debug_vars "Chapter Variables:" cover_file chapter_start chapter_end chapternum chapter chapterNameScheme chapter_title chapter_file
+        if [ "$((${continueAt} > ${chapternum}))" = "0" ]; then
+          # Extract chapter by time stamps start and finish of chapter.
+          # This extracts based on time stamps start and end.
+          if [ "$((${loglevel} > 1))" == "1" ]; then
+            log "Splitting chapter ${chapternum}/${chaptercount} start:${chapter_start%?}(s) end:${chapter_end}(s)"
+          fi
+          </dev/null ffmpeg -loglevel quiet \
+            -nostats \
+            ${split_input} \
+            -i "${output_file}" \
+            -i "${cover_file}" \
+            ${extra_crop_cover} \
+            ${split_output} \
+            -map 0:0 \
+            -map 1:0 \
+            -acodec ${chapter_codec} \
+            -metadata:s:v title="Album cover" \
+            -metadata:s:v comment="Cover (Front)" \
+            -metadata track="${chapternum}" \
+            -metadata title="${chapter}" \
+            -metadata:s:a title="${chapter}" \
+            -metadata:s:a track="${chapternum}" \
+            -map_chapters -1 \
+            -f ${container} \
+            "${chapter_file}"
+          # -----
+          if [ "$((${loglevel} < 2))" == "1" ]; then
+            progressbar ${chapternum} ${chaptercount}
+          fi
+          # OK lets get what need for the next chapter in the Playlist m3u file.
+          # Playlist creation.
+          duration=$(echo "${chapter_end} - ${chapter_start%?}" | bc)
+          echo "#EXTINF:${duration%.*},${title} - ${chapter}" >>  "${playlist_file}"
+          echo "${chapter_title}.${extension}" >> "${playlist_file}"
+        fi
+        chapternum=$((chapternum + 1 ))
+      fi
+    done 9< "$metadata_file"
+
+    # Clean up of working directory stuff.
+    rm "${output_file}"
+    if [ "$((${loglevel} > 1))" == "1" ]; then
+      log "Done creating chapters for ${output_directory}."
+    else
+      #ending progress bar
+      echo ""
+    fi
+  else
+    # Perform file tasks on output file.
+    # ----
+    # ffmpeg seems to copy only chapter position, not chapter names.
+    if [[ ${container} == "mp4" && $(type -P mp4chaps) ]]; then
+      ffprobe -i "${aax_file}" -print_format csv -show_chapters 2>/dev/null | awk -F "," '{printf "CHAPTER%02d=%02d:%02d:%02.3f\nCHAPTER%02dNAME=%s\n", NR, $5/60/60, $5/60%60, $5%60, NR, $8}' > "${output_directory}/${currentFileNameScheme}.chapters.txt"
+      mp4chaps -i "${output_file}"
+    fi
+  fi
+
+  # -----
+  # Announce that we have completed the transcode
+  if [ "$((${loglevel} > 0))" == "1" ]; then
+    log "Complete ${title}"
+  fi
+  # Lastly get rid of any extra stuff.
+  rm "${metadata_file}"
+
+  # Move the aax file if the decode is completed and the --complete_dir is set to a valid location.
+  # Check the target dir for if set if it is writable
+  if [[ "x${completedir}" != "x"  ]]; then
+    if [ "$((${loglevel} > 0))" == "1" ]; then
+      log "Moving Transcoded ${aax_file} to ${completedir}"
+    fi
+    mv "${aax_file}" "${completedir}"
+  fi
+
 done

README.md

@@ -1,8 +1,8 @@
 # AAXtoMP3
-The purpose of this software is to convert AAX files to a more common MP3 format
+The purpose of this software is to convert AAX (or AAXC) files to common MP3, M4A, M4B, flac and ogg formats
 through a basic bash script frontend to FFMPEG.
 
-Audible uses this file format to maintain DRM restrictions on their audio
+Audible uses the AAX file format to maintain DRM restrictions on their audio
 books and if you download your book through your library it will be
 stored in this format.
 
@@ -12,48 +12,264 @@ your **personal** Audible account. The purpose of this software is to
 create a method for you to download and store your books just in case
 Audible fails for some reason.
 
-## Setup
-You will need your four byte authentication code that comes from Audible's
-servers. This will be used by ffmpeg to perform the initial audio convert. You
-can obtain this string from a tool like [audible-activator](https://github.com/inAudible-NG/audible-activator).
-
 ## Requirements
-* bash 4.3.42 or later tested
-* ffmpeg version 2.8.3 or later
-* libmp3lame (came from lame package on Arch, not sure where else this is stored)
+* bash 3.2.57 or later tested
+* ffmpeg version 2.8.3 or later (4.4 or later if the input file is `.aaxc`)
+* libmp3lame - (typically 'lame' in your system's package manager)
+* GNU grep - macOS or BSD users may need to install through package manager
+* GNU sed - see above
+* GNU find - see above
+* jq - only if `--use-audible-cli-data` is set or if converting an .aaxc file
+* mp4art used to add cover art to m4a and m4b files. Optional
+* mediainfo used to add additional media tags like narrator. Optional
 
-## OSX
-Thanks to thibaudcolas, this script has been tested on OSX 10.11.6 El Capitan. YMMV, but it should work for 
-conversions in OSX.
-
-## AUR
-Thanks to kbabioch, this script has also been packaged in the [AUR](https://aur.archlinux.org/packages/aaxtomp3-git/). Note that you will still need to extract your activation bytes before use.
-
-## Usage
+## Usage(s)
 ```
-bash AAXtoMP3 <AUTHCODE> {INPUT_FILES}
+bash AAXtoMP3 [-f|--flac] [-o|--opus] [-a|-aac] [-s|--single] [--level <COMPRESSIONLEVEL>] [-c|--chaptered] [-e:mp3] [-e:m4a] [-e:m4b] [-A|--authcode <AUTHCODE>] [-n|--no-clobber] [-t|--target_dir <PATH>] [-C|--complete_dir <PATH>] [-V|--validate] [--use-audible-cli-data]] [-d|--debug] [-h|--help] [--continue <CHAPTERNUMBER>] <AAX/AAXC INPUT_FILES>...
+```
+or if you want to get guided through the options
+```
+bash interactiveAAXtoMP3 [-a|--advanced] [-h|--help]
 ```
-* AUTHCODE: **your** Audible auth code (it won't correctly decode otherwise) (required)
-* Everything else is considered an input file, useful for batching!
 
-You can also convert the output to FLAC encoding instead of MP3 by doing the following *in order*:
-```
-bash AAXtoMP3 --flac <AUTHCODE> {INPUT_FILES}
-```
-Note that FLAC encoding is typically a little faster, at the cost of compatibility with some players.
+* **&lt;AAX INPUT_FILES&gt;**... are considered input file(s), useful for batching!
 
-If you wish to convert to a single file you can add --single to the input. This will prevent chaptered content from being extracted.
+## Options for AAXtoMP3
+* **-f** or **--flac**   Flac Encoding and as default produces a single file.
+* **-o** or **--opus**   Ogg/Opus Encoding defaults to multiple file output by chapter. The extension is .ogg
+* **-a** or **--aac**    AAC Encoding and produce a m4a single files output.
+* **-A** or **--authcode &lt;AUTHCODE&gt;** for this execution of the command use the provided &lt;AUTHCODE&gt; to decode the AAX file. Not needed if the source file is .aaxc.
+* **-n** or **--no-clobber** If set and the target directory already exists, AAXtoMP3 will exit without overwriting anything.
+* **-t** or **--target_dir &lt;PATH&gt;** change the default output location to the named &lt;PATH&gt;. Note the default location is ./Audiobook of the directory to which each AAX file resides.
+* **-C** or **--complete_dir &lt;PATH&gt;** a directory to place aax files after they have been decoded successfully. Note make a back up of your aax files prior to using this option. Just in case something goes wrong.
+* **-V** or **--validate** Perform 2 validation tests on the supplied aax files. This is more extensive than the normal validation as we attempt to transcode the aax file to a null file.  This can take a long period of time. However it is useful when inspecting a large set of aax files prior to transcoding. As download errors are common with Audible servers.
+* **-e:mp3**         Identical to defaults.
+* **-e:m4a**         Create a m4a audio file. This is identical to --aac
+* **-e:m4b**         Create a m4b audio file. This is the book version of the m4a format.
+* **-s** or **--single**    Output a single file for the entire book. If you only want a single ogg file for instance.
+* **-c** or **--chaptered** Output a single file per chapter. The `--chaptered` will only work if it follows the `--aac -e:m4a -e:m4b --flac` options.
+* **--continue &lt;CHAPTERNUMBER&gt;**      If the splitting into chapters gets interrupted (e.g. by a weak battery on your laptop) you can go on where the process got interrupted. Just delete the last chapter (which was incompletely generated) and redo the task with "--continue &lt;CHAPTERNUMBER&gt;" where CHAPTERNUMBER is the chapter that got interrupted.
+* **--level &lt;COMPRESSIONLEVEL&gt;**      Set compression level. May be given for mp3, flac and opus.
+* **--keep-author &lt;FIELD&gt;**           If a book has multiple authors and you don't want all of them in the metadata, with this flag you can specify a specific author (1 is the first, 2 is the second...) to keep while discarding the others.
+* **--author &lt;AUTHOR&gt;**               Manually set the author metadata field, useful if you have multiple books of the same author but the name reported is different (eg. spacing, accents..). Has precedence over `--keep-author`.
+* **-l** or **--loglevel &lt;LOGLEVEL&gt;** Set loglevel: 0 = progress only, 1 (default) = more information, output of chapter splitting progress is limitted to a progressbar, 2 = more information, especially on chapter splitting, 3 = debug mode
+* **--dir-naming-scheme &lt;STRING&gt;** or **-D**      Use a custom directory naming scheme, with variables. See [below](#custom-naming-scheme) for more info.
+* **--file-naming-scheme &lt;STRING&gt;** or **-F**    Use a custom file naming scheme, with variables. See [below](#custom-naming-scheme) for more info.
+* **--chapter-naming-scheme &lt;STRING&gt;**  Use a custom chapter naming scheme, with variables. See [below](#custom-naming-scheme) for more info.
+* **--use-audible-cli-data** Use additional data got with mkb79/audible-cli. See [below](#audible-cli-integration) for more info. Needed for the files in the `aaxc` format.
 
-Additionally, if you have a .authcode file available in the current working directory, it will read the first line of
-that line and treat it like your auth_code. When you do this you do not need to specify an AUTHCODE input.
+## Options for interactiveAAXtoMP3
+* **-a** or **--advanced** Get more options to choose. Not used right now.
+* **-h** or **--help** Get a help prompt.
+This script presents you the options you chose last time as default.
+When you get asked for the aax-file you may just drag'n'drop it to the terminal.
 
-Here is the full usage (NOTE: Order matters!)
+### AUTHCODE
+**Your** Audible auth code (it won't correctly decode otherwise) (not required to decode the `aaxc` format).
+
+#### Determining your own AUTHCODE
+You will need your authentication code that comes from Audible's servers. This 
+will be used by ffmpeg to perform the initial audio convert. You can obtain 
+this string from a tool like 
+[audible-activator](https://github.com/inAudible-NG/audible-activator) or like [audible-cli](https://github.com/mkb79/audible-cli).
+
+#### Specifying the AUTHCODE.
+In order of __precidence__.
+1. __--authcode [AUTHCODE]__ The command line option. With the highest precedence.
+2. __.authcode__ If this file is placed in the current working directory and contains only the authcode it is used if the above is not.
+3. __~/.authcode__ a global config file for all the tools. And is used as the default if none of the above are specified.
+__Note:__ At least one of the above must be exist if converting `aax` files. The code must also match the encoding for the user that owns the AAX file(s). If the authcode does not match the AAX file no transcoding will occur.
+
+### MP3 Encoding
+* This is the **default** encoding
+* Produces 1 or more mp3 files for the AAX title.
+* The default mode is **chaptered**
+* If you want a mp3 file per chapter do not use the **--single** option. 
+* A m3u playlist file will also be created in this instance in the case of **default** chaptered output.
+* **--level** has to be in range 0-9, where 9 is fastest and 0 is highest quality. Please note: The quality can **never** become higher than the qualitiy of the original aax file!
+
+### Ogg/Opus Encoding
+* Can be done by using the **-o** or **--opus** command line switches
+* The default mode is **chaptered**
+* Opus coded files are stored in the ogg container format for better compatibility.
+* **--level** has to be in range 0-10, where 0 is fastest and 10 is highest quality. Please note: The quality can **never** become higher than the qualitiy of the original aax file!
+
+### AAC Encoding
+* Can be done by using the **-a** or **--aac** command line switches
+* The default mode is **single**
+* Designed to be the successor of the MP3 format
+* Generally achieves better sound quality than MP3 at the same bit rate.
+* This will only produce 1 audio file as output.
+
+### FLAC Encoding
+* Can be done by using the **-f** or **--flac** command line switches
+* The default mode is **single**
+* FLAC is an open format with royalty-free licensing
+* This will only produce 1 audio file as output. If you want a flac file per chapter do use **-c** or **--chaptered**.
+* **--level** has to be in range 0-12, where 0 is fastest and 12 is highest compression. Since flac is lossless, the quality always remains the same.
+
+### M4A and M4B Containers
+* These containers were created by Apple Inc. They were meant to be the successor to mp3.
+* M4A is a container that is meant to hold music and is typically of a higher bitrate.
+* M4B is a container that is meant to hold audiobooks and is typically has bitrates of 64k and 32k.
+* Both formats are chaptered
+* Both support coverart internal
+* The default mode is **single**
+
+### Validating AAX files
+* The **--validate** option will result in only a validation pass over the supplied aax file(s). No transcoding will occur. This is useful when you wish to ensure you have a proper download of your personal Audible audio books. With this option all supplied books are validated.
+* If you do NOT supply the **--validate** option all audio books are still validated when they are processed. However if there is an invalid audio book in the supplied list of books the processing will stop at that point.
+* A third test is performed on the file where the entire file is inspected to see if it is valid. This is a lengthy process. However it will not break the script when an invalid file is found.
+* The 3 test current are:
+    1. aax present
+    1. meta data header in file is valid and complete
+    1. entire file is valid and complete.  _only executed with the **--validate** option._
+
+### Defaults
+* Default out put directory is the base directory of each file listed. Plus the genre, Artist and Title of the Audio Book.
+* The default codec is mp3
+* The default output is by chapter.
+
+### Custom naming scheme
+The following flags can modify the default naming scheme:
+* **--dir-naming-scheme** or **-D**  
+* **--file-naming-scheme** or **-F** 
+* **--chapter-naming-scheme** 
+
+Each flag takes a string as argument. If the string contains a variable defined in the script (eg. artist, title, chapter, narrator...), the corresponding value is used.
+The default options correspond to the following flags:
+* `--dir-naming-scheme '$genre/$artist/$title'`
+* `--file-naming-scheme '$title'`
+* `--chapter-naming-scheme '$title-$(printf %0${#chaptercount}d $chapternum) $chapter'`
+
+Additional notes:
+* If a command substitution is present in the passed string, (for example `$(printf %0${#chaptercount}d $chapternum)`, used to pad with zeros the chapter number), the commands are executed.
+So you can use `--dir-naming-scheme '$(date +%Y)/$artist'`, but using `--file-naming-scheme '$(rm -rf /)'` is a really bad idea. Be careful.
+* You can use basic text, like `--dir-naming-scheme 'Converted/$title'`
+* You can also use shell variables as long as you escape them properly: `CustomGenre=Horror ./AAXtoMP3 --dir-naming-scheme "$CustomGenre/\$artist/\$title" *.aax`
+* If you want shorter chapter names, use `--chapter-naming-scheme '$(printf %0${#chaptercount}d $chapternum) $chapter'`: only chapter number and chapter name
+* If you want to append the narrator name to the title, use `--dir-naming-scheme '$genre/$artist/$title-$narrator' --file-naming-scheme '$title-$narrator'`
+* If you don't want to have the books separated by author, use `--dir-naming-scheme '$genre/$title'`
+
+### Installing Dependencies.
+In general, take a look at [command-not-found.com](https://command-not-found.com/)
+#### FFMPEG,FFPROBE
+__Ubuntu, Linux Mint, Debian__
 ```
-bash AAXtoMP3 [--flac] [--single] AUTHCODE {FILES}
+sudo apt-get update
+sudo apt-get install ffmpeg libav-tools x264 x265 bc
 ```
 
+__Fedora__
+
+Fedora users need to enable the rpm fusion repository to install ffmpeg. Version 22 and upwards are currently supported. The following command works independent of your current version:
+```
+sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm https://download1.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm
+```
+Afterwards use the package manager to install ffmpeg:
+```
+sudo dnf install ffmpeg
+```
+
+__RHEL or compatible like CentOS__
+
+RHEL version 6 and 7 are currently able to use rpm fusion.
+In order to use rpm fusion you have to enable EPEL, see http://fedoraproject.org/wiki/EPEL
+
+Add the rpm fusion repositories in version 6
+```
+sudo yum localinstall --nogpgcheck https://download1.rpmfusion.org/free/el/rpmfusion-free-release-6.noarch.rpm https://download1.rpmfusion.org/nonfree/el/rpmfusion-nonfree-release-6.noarch.rpm
+```
+or version 7:
+```
+sudo yum localinstall --nogpgcheck https://download1.rpmfusion.org/free/el/rpmfusion-free-release-7.noarch.rpm https://download1.rpmfusion.org/nonfree/el/rpmfusion-nonfree-release-7.noarch.rpm
+```
+then install ffmpeg:
+```
+sudo yum install ffmpeg
+```
+
+__MacOS__
+```
+brew install ffmpeg
+brew install gnu-sed
+brew install grep
+brew install findutils
+```
+
+#### mp4art/mp4chaps
+_Note: This is an optional dependency._
+
+__Ubuntu, Linux Mint, Debian__
+```
+sudo apt-get update
+sudo apt-get install mp4v2-utils
+```
+__CentOS, RHEL & Fedora__
+```
+# CentOS/RHEL and Fedora users make sure that you have enabled atrpms repository in system. Let’s begin installing FFmpeg as per your operating system.
+yum install mp4v2-utils
+```
+__MacOS__
+```
+brew install mp4v2
+```
+
+#### mediainfo
+_Note: This is an optional dependency._
+
+__Ubuntu, Linux Mint, Debian__
+```
+sudo apt-get update
+sudo apt-get install mediainfo
+```
+__CentOS, RHEL & Fedora__
+```
+yum install mediainfo
+```
+__MacOS__
+```
+brew install mediainfo
+```
+## AAXC files
+The AAXC format is a new Audible encryption format, meant to replace the old AAX.
+The encryption has been updated, and now to decrypt the file the authcode
+is not sufficient, we need two "keys" which are unique for each audiobook.
+Since getting those keys is not simple, for now the method used to get them
+is handled by the package audible-cli, that stores
+them in a file when downloading the aaxc file. This means that in order to
+decrypt the aaxc files, they must be downloaded with audible-cli.
+
+## Audible-cli integration
+Some information are not present in the AAX file. For example the chapters's
+title, additional chapters division (Opening and End credits, Copyright and
+more).  Those information are avaiable via a non-public audible API. This
+[repo](https://github.com/mkb79/Audible) provides a python API wrapper, and the
+[audible-cli](https://github.com/mkb79/audible-cli) packege makes easy to get
+more info. In particular the flags **--cover --cover-size 1215 --chapter**
+downloads a better-quality cover (.jpg) and detailed chapter infos (.json).
+More info are avaiable on the package page.
+
+Some books might not be avaiable in the old `aax` format, but only in the newer
+`aaxc` format. In that case, you can use [audible-cli](https://github.com/mkb79/audible-cli)
+to download them. For example, to download all the books in your library in the newer `aaxc` format, as well as
+chapters's title and an HQ cover: `audible download --all --aaxc --cover --cover-size 1215 --chapter`.
+
+To make AAXtoMP3 use the additional data, specify the **--use-audible-cli-data**
+flag: it expects the cover and the chapter files (and the voucher, if converting
+an aaxc file) to be in the same location of the AAX file.  The naming of these
+files must be the one set by audible-cli. When converting aaxc files, the variable
+is automatically set, so be sure to follow the instructions in this paragraph.
+
+For more information on how to use the `audible-cli` package, check out the git page [audible-cli](https://github.com/mkb79/audible-cli).
+
+Please note that right now audible-cli is in dev stage, so keep in mind that the
+naming scheme of the additional files, the flags syntax and other things can
+change without warning.
+ 
+
 ## Anti-Piracy Notice
-Note that this project does NOT ‘crack’ the DRM. It simply allows the user to
+Note that this project **does NOT ‘crack’** the DRM. It simply allows the user to
 use their own encryption key (fetched from Audible servers) to decrypt the
 audiobook in the same manner that the official audiobook playing software does.
 

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

interactiveAAXtoMP3

@@ -0,0 +1,159 @@
+#!/usr/bin/env bash
+
+# ===Note for contributors========================================================================================================================
+
+# This script interactively asks the user for the options to call AAXtoMP3 with. This first version does not include all options of AAXtoMP3
+# since I tried to keep the dialog short, but I added an --advanced option, which is unused right now, but might be used in the future to add
+# more options which only show up if explicitely wanted.
+# If you want to add functionality please consider, whether the functionality you add might belong to the advanced options.
+
+# ===Variables====================================================================================================================================
+
+# Help message
+help=$'\nUsage: interactiveAAXtoMP3 [--advanced] [--help]\n
+--advanced	More options
+--help		Print this message\n'
+summary=""         # This will contain a summary of the options allready set.
+call="./AAXtoMP3"  # This will contain the call for AAXtoMP3.
+advanced=0         # Toggles advanced options on or off.
+
+# ===Options======================================================================================================================================
+
+while true; do
+  case "$1" in
+                     # Advanced options.
+    -a | --advanced  ) advanced=1;      shift ;;
+                     # Command synopsis.
+    -h | --help      ) echo -e "$help"; exit ;;
+                     # Anything else stops command line processing.
+    *                )                  break ;;
+  esac
+done
+
+# ===Cross platform compatible use grep and sed===================================================================================================
+
+# ===Detect which annoying version of grep we have===
+GREP=$(grep --version | grep -q GNU && echo "grep" || echo "ggrep")
+if ! [[ $(type -P "$GREP") ]]; then
+  echo "$GREP (GNU grep) is not in your PATH"
+  echo "Without it, this script will break."
+  echo "On macOS, you may want to try: brew install grep"
+  exit 1
+fi
+
+# ===Detect which annoying version of sed we have===
+SED=$(sed --version 2>&1 | $GREP -q GNU && echo "sed" || echo "gsed")
+if ! [[ $(type -P "$SED") ]]; then
+  echo "$SED (GNU sed) is not in your PATH"
+  echo "Without it, this script will break."
+  echo "On macOS, you may want to try: brew install gnu-sed"
+  exit 1
+fi
+
+# ===Get options from last time===================================================================================================================
+
+# ===Set default values===
+lastcodec="mp3"
+lastcompression="4"
+lastchapters="yes"
+lastauthcode=""
+lastloglevel="1"
+
+# ===Get Values from last time===
+if [ -f ".interactivesave" ]; then
+  for ((i=1;i<=$(wc -l .interactivesave | cut -d " " -f 1);i++)) do
+    line=$(head -$i .interactivesave | tail -1)
+    case $(echo $line | cut -d " " -f 1 | $SED 's/.$//') in
+      codec        ) lastcodec="$(echo $line | cut -d " " -f 2)";;
+      compression  ) lastcompression="$(echo $line | cut -d " " -f 2)";;
+      chapters     ) lastchapters="$(echo $line | cut -d " " -f 2)";;
+      authcode     ) lastauthcode="$(echo $line | cut -d " " -f 2)";;
+      loglevel     ) lastloglevel="$(echo $line | cut -d " " -f 2)";;
+      *            ) rm .interactivesave; exit 1;;
+    esac
+  done
+fi
+
+# ===Get options for AAXtoMP3=====================================================================================================================
+
+# ===Codec===
+while true; do
+  clear;
+  read -e -p "codec (mp3/m4a/m4b/flac/aac/opus): " -i "$lastcodec" codec
+  case "$codec" in
+    mp3   ) summary="$summary""codec: $codec"; call="$call -e:mp3"; break;;
+    m4a   ) summary="$summary""codec: $codec"; call="$call -e:m4a"; break;;
+    m4b   ) summary="$summary""codec: $codec"; call="$call -e:m4b"; break;;
+    flac  ) summary="$summary""codec: $codec"; call="$call --flac"; break;;
+    aac   ) summary="$summary""codec: $codec"; call="$call --aac";  break;;
+    opus  ) summary="$summary""codec: $codec"; call="$call --opus"; break;;
+  esac
+done
+
+# ===Compression===
+while true; do
+  clear; echo -e "$summary"
+  case "$codec" in
+    mp3   ) maxlevel=9;;
+    flac  ) maxlevel=12;;
+    opus  ) maxlevel=10;;
+    *     ) break;;
+  esac
+  read -e -p "compression level (0-$maxlevel): " -i "$lastcompression" compression
+  if [[ $compression =~ ^[0-9]+$ ]] && [[ "$compression" -ge "0" ]] && [[ "$compression" -le "$maxlevel" ]]; then
+    summary="$summary""\ncompression level: $compression"
+    call="$call --level $compression"
+    break
+  fi
+done
+
+# ===Chapters===
+while true; do
+  clear; echo -e "$summary"
+  read -e -p "chapters (yes/no/chapternumber to continue with): " -i "$lastchapters" chapters
+  case "$chapters" in
+    ^[0-9]+$  ) summary="$summary""\nchapters: $chapters"; call="$call -c --continue ${chapters}"; break;;
+    yes       ) summary="$summary""\nchapters: $chapters"; call="$call -c"; break;;
+    no        ) summary="$summary""\nchapters: $chapters"; call="$call -s"; break;;
+  esac
+done
+
+# ===Authcode===
+if ! [ -r .authcode ] || [ -r ~/.authcode ]; then
+  clear; echo -e "$summary"
+  read -e -p "Authcode: " -i "$lastauthcode" authcode
+  summary="$summary""\nauthcode: $authcode"
+  call="$call -A $authcode"
+fi
+
+# ===Loglevel===
+while true; do
+  clear; echo -e "$summary"
+  read -e -p "loglevel (0/1/2/3): " -i "$lastloglevel" loglevel
+  if [[ $loglevel =~ ^[0-9]+$ ]] && [[ "$loglevel" -ge "0" ]] && [[ "$loglevel" -le "3" ]]; then
+    summary="$summary""\nloglevel: $loglevel"
+    call="$call -l $loglevel"
+    break
+  fi
+done
+
+# ===File===
+clear; echo -e "$summary"
+read -p "aax-file: " file
+file="${file%\'}" #remove suffix ' if file is given via drag'n'drop
+file="${file#\'}" #remove prefix ' if file is given via drag'n'drop
+savefile="$summary"
+summary="$summary""\naax-file: $file"
+call="$call $(echo $file | $SED "s;~;$HOME;")"
+
+# ===Summerize chosen options and call AAXtoMP3===================================================================================================
+
+# ===Summary===
+clear; echo -e "$summary\n"
+echo -e "$call\n"
+
+# ===Save chosen options===
+echo -e $savefile | $SED "s;\ level:;:;" > .interactivesave
+
+# ===Call AAXtoMP3===
+$call