#!/bin/bash
#
# Author: Alan J. Pippin (apippin@pippins.net)
# Date: 05/17/2009
#
  REV=2.5
#
# Description: This script wraps a number of linux utilities to
# create a recipe for ripping protected DVDs, circumventing 
# ARcoSS and CRC checksum error protection schemes used on many
# newer DVDs. Edit as appropriate for your needs. I use this to
# backup DVDs I own, and do not condone any other activity it
# may be used for.
#
# Known Issues/Limitations:
# - Mirror mode is always done in ISO mode
#
# See the README file for information about the dependencies
# this script has.

##############################################################################################
# Global Variables
##############################################################################################
typeset cmd="$0 $*"
typeset dvdname=""
typeset debug=""
typeset dest=""
typeset isofile=""
typeset vobfile=""
typeset dvdpath=""
typeset aspect=""
typeset SCALE=""
typeset CROP=""
typeset profile="xvidhq"
typeset extension=""
typeset mailto=""
typeset encoder=""
typeset ripper=""
typeset default_alang="en"
typeset track=""
typeset drc="0.0"
typeset handbrake_xvid=""
typeset handbrake_mp4=""
typeset makemkv=""
typeset makemkv_disc_id=""
typeset mkvextract=""
typeset mkvpropedit=""
typeset mkvmerge=""
typeset mp4box=""
typeset dvdxchap=""
typeset eject_opts="-T"
typeset -i default_aid=128
typeset -i aid_override=-1
typeset -i force_onepass_mode=0
typeset -i eject_disk=1
typeset -i keep_isofile=0
typeset -i keep_vobfile=0
typeset -i keep_dvdfolder=0
typeset -i keep_intermediate_files=0
typeset -i make_final_dest_vob=0
typeset -i make_final_dest_iso=0
typeset -i make_final_dest_folder=0
typeset -i make_final_dest_comp=0
typeset -i errors=0
typeset -i show_usage=0
typeset -i mirror_mode=0
typeset -i target_video_bitrate=2000
typeset -i target_audio_bitrate=224
typeset -i target_size=0
typeset -i audio_2ch=0
typeset -i audio_6ch=0
typeset -i invalid_feature_title=0
typeset -i feature_title_override=0
typeset -i mplayer_dumpstream_incompatibility=0
typeset -i lsdvd_incompatibility=0
typeset -i custom_video_bitrate=0
typeset -i custom_audio_bitrate=0
typeset -i custom_audio_2ch=0
typeset -i custom_audio_6ch=0
typeset -i minimum_feature_title_length=60
typeset -i lsdvd_timeout=10
typeset -i makemkv_copy_largest_title_only=1

##############################################################################
# Local Machine Settings:
# Sources both the "default" conf file tracked by GIT (rip_dvd.conf.dist)
# and the local conf file created by each local machine (rip_dvd.conf)
# Copy the rip_dvd.conf.dist file to rip_dvd.conf and edit the later.
# This will allow you to override all the default values to meet your needs
# in a way that won't get clobbered when you pull updates from my GIT repo.
##############################################################################
config="${0%/*}/rip_dvd.conf"

# The config file will be searched for in the following location order:
found_config=0

# 1) /path/to/rip_dvd/script/rip_dvd.conf.dist
[ -e "${config}.dist" ] && found_config=1 && . "${config}.dist"

# 2) /path/to/rip_dvd/script/rip_dvd.conf
[ -e "${config}" ] && found_config=1 && . "${config}"

# 3) /etc/rip_dvd.conf
[ -e "/etc/rip_dvd.conf" ] && found_config=1 && . "/etc/rip_dvd.conf"

# 4) $PWD/rip_dvd.conf
[ -e "$PWD/rip_dvd.conf" ] && found_config=1 && . "$PWD/rip_dvd.conf"

# Check to make sure we found the config file
if [ $found_config -eq 0 ]; then
  echo "-E- Unable to find the rip_dvd.conf file: $config"
  exit 1
fi

##############################################################################################
# Command line processing
##############################################################################################
while (($#)) && getopts 162wmvifkzx:hT:t:n:d:b:B:s:t:a:p:e:j:l:r:R: opt "$@"
do
    case $opt in
        (n)     dvdname=$OPTARG;;
        (d)     dest=$OPTARG;;
        (b)     target_video_bitrate=$OPTARG; custom_video_bitrate=1;;
        (B)     target_audio_bitrate=$OPTARG; custom_audio_bitrate=1;;
	(s)     target_size=$OPTARG;;
        (2)     audio_2ch=1; custom_audio_2ch=1;;
        (6)     audio_6ch=1; custom_audio_6ch=1;;
        (1)     force_onepass_mode=1;;
        (v)     make_final_dest_vob=1;;
        (i)     make_final_dest_iso=1;;
        (f)     make_final_dest_folder=1;; 
        (z)     make_final_dest_comp=1;;
	(R)     ripper=$OPTARG;;
	(e)     encoder=$OPTARG;;
        (m)     mirror_mode=1;;
        (k)     keep_intermediate_files=1;;
        (t)     feature_title_override=$OPTARG;;
	(a)     aspect=$OPTARG;;
	(p)     profile=$OPTARG;;
	(x)     extension=$OPTARG;;
	(j)     eject_disk=$OPTARG;;
	(l)     aid_override=$OPTARG;;
	(r)     drc=$OPTARG;;
        (w)     set -x;;
	(T)     minimum_feature_title_length=$OPTARG;;
        (h)     show_usage=1;;
        (:)     echo >&2 "$0: $OPTARG requires a value"; errors=errors+1;;
        (\?)    echo >&2 "$0: invalid option '$OPTARG'"; errors=errors+1;;
    esac
done

shift $((OPTIND-1))

function usage() {
    echo >&2 "Usage: ${0##*/} -d <destdir> [ <options> ]"
    echo >&2 "Revision $REV"
    echo >&2 "Options:"
    echo >&2 "   -d <destdir>  Specify the destination directory to store the ripped DVD to"
    echo >&2 "   -n <dvdname>  Specify a path to a DVD folder or file to process:"
    echo >&2 "                 1) If this option is not specified, the DVD will be ripped from $dev"
    echo >&2 "                 2) If dvdname is a full path to a DVD folder, it will be ripped as a DVD instead of $dev"
    echo >&2 "                 3) If dvdname is a full path to an MPG2 file, it will be ripped as a DVD instead of $dev"
    echo >&2 "                 4) If dvdname is a full path to an ISO file, it will be ripped as a DVD instead of $dev"
    echo >&2 "                 5) If dvdname is a full path to a VOB file, it will be ripped as a DVD instead of $dev"
    echo >&2 "   -p <profile>  Specify which encoding profile to use in -w mode as shown below:"
    echo >&2 "                 Mencoder and Handbrake Encoder Profiles:"
    echo >&2 "                 - xvidvhq = AVI, very high quality encoding, Xvid codec, 2 pass encoding"
    echo >&2 "                 - xvidhq = AVI, high quality encoding, Xvid codec, 2 pass encoding (default)"
    echo >&2 "                 - xvid = AVI, fast encoding, Xvid codec, 2 pass encoding"
    echo >&2 "                 - iphone = MP4, x264 codec, 2 pass encoding, forced 480:320 scaling"
    echo >&2 "                 - ipod = MP4, x264 codec, 2 pass encoding, forced 320:240 scaling"
    echo >&2 "                 Handbrake Only Encoder Profiles:"
    echo >&2 "                 - mkvvhq = MKV, very high quality encoding, x264 codec, 2 pass encoding"
    echo >&2 "                 - mkvhq = MKV, high quality encoding, x264 codec, 2 pass encoding"
    echo >&2 "                 - mkv = MKV, high quality encoding, x264 codec, 2 pass encoding"
    echo >&2 "                 - mp4vhq = MP4, very high quality encoding, x264 codec, 2 pass encoding"
    echo >&2 "                 - mp4hq = MP4, high quality encoding, x264 codec, 2 pass encoding"
    echo >&2 "                 - mp4 = MP4, fast encoding, x264 codec, 2 pass encoding"
    echo >&2 "                 - hb_<profile> = Any predefined HandBrake profile (run HandBrakeCLI -z and replace spaces with underscores) "
    echo >&2 "   -x <ext>      Specify a suffix extension to apply to the end of the final image filename (like .xvid, .ipod, etc)"
    echo >&2 "                 If you run multiple instances of this script ripping the same DVD, you need to specify this option."
    echo >&2 "   -m            Make a mirror image of the DVD and save it as a DVD ISO file"
    echo >&2 "                 The default operation is non-mirror mode where only the main"
    echo >&2 "                 feature title will be ripped."
    echo >&2 "   -v            Make the final image a DVD VOB file"
    echo >&2 "   -i            Make the final image a DVD ISO file"
    echo >&2 "   -f            Make the final image a DVD folder"
    echo >&2 "   -z            Make the final image a compressed fi[[ ! -e "$vobfile" ]]le based on your profile selection and encoder"
    echo >&2 "   -R <ripper>   Specify the ripper to use to make the DVD image (valid rippers=ddrescue|makemkv|handbrake|mplayer) (default=makemkv if found)"
    echo >&2 "   -e <encoder>  Specify the encoder to use to make the compressed file (valid encoders=mencoder|handbrake) (default=handbrake if found)"
    echo >&2 "                 You must also specify the target size or bitrate using the '-s' or '-b' options with xvid profiles"
    echo >&2 "   -s <size>     Set the target size of the compressed file in MB (ex: 700, 1000, etc)"
    echo >&2 "   -b <bitrate>  Set the video bitrate desired in the compressed file in kbits/sec (ex: 1500, 2000 (default), etc)"    
    echo >&2 "   -B <bitrate>  Set the audio bitrate desired in the compressed file in kbits/sec (ex: 96, 128, 160, 224 (default), 300, etc)"    
    echo >&2 "   -a <W:H>      Specify the width x height aspect ratio to scale the DVD to (only used in -z mode)"
    echo >&2 "      <W>        If only the width is given, it will autoset the height to a value which preserves the aspect ratio"
    echo >&2 "                 The default behavior is autoaspect mode, which preserves the original aspect, with no scaling being done"
    echo >&2 "   -j <n>        Eject the disk:"
    echo >&2 "                 - 0 = do not eject the disk"
    echo >&2 "                 - 1 = eject after the entire script is done (default)"
    echo >&2 "                 - 2 = eject after the disk is no longer needed (prior to starting the encode process)"
    echo >&2 "                 The last option will allow you to start ripping another disk while the encoding process is running on a previous"
    echo >&2 "   -1            Force 1-pass encoding mode across all profiles"
    echo >&2 "   -2            Use 2 channel MP3 audio encoding when making a compressed file (default is 6 channel AC3)"
    echo >&2 "   -6            Use 6 channel AC3 audio encoding when making a compressed file (default)"
    echo >&2 "   -r <x.x>      Apply extra dynamic range compression to the audio, making soft sounds louder. "
    echo >&2 "                 Range is 1.0 to 4.0 with 1.5 - 2.5 being a useful range (HandBrake Only) (default value is 0.0)"
    echo >&2 "   -k            Keep the intermediate files (good for debugging)"
    echo >&2 "                 In -z mode, run with this option to keep the original .VOB file"
    echo >&2 "                 By default, all intermediary files are deleted. Only the final image is kept"
    echo >&2 "   -l <aid>      Specify the audio AID language ID to rip from the source DVD"
    echo >&2 "   -t <title>    Specify the main feature title to pull from the DVD (only required if this script can't figure it out)"
    echo >&2 "   -T <length>   Specify the minimum feature title length in minutes. This is used when picking which title to rip."
    echo >&2 "   -w            Set the sh Execute/Verbose flag (causes every command to be echoed)"
    echo >&2 ""
    exit 2
}

if (($errors)) || (($show_usage))
then
  usage
fi

# Sanity Check - Command Line Options 
if [ "$dest" == "" ]; then
  echo "-E- You must specify a destination directory with '-d'" | tee -a $logfile
  usage
fi

if [ $make_final_dest_vob -eq 0 ] && [ $make_final_dest_iso -eq 0 ] && 
   [ $make_final_dest_folder -eq 0 ] && [ $make_final_dest_comp -eq 0 ] && [ $mirror_mode -eq 0 ]; then
    # Make our default dest type a compressed movie if the user didn't ask for anything else to be done
    make_final_dest_comp=1
fi

if ([ $target_size -ne 0 ] || [ "$aspect" != "" ]) && [ $make_final_dest_comp -ne 1 ]; then
  echo "-E- You can't specify a target_size, or aspect in non compressed file mode. You must specify '-z' when using '-b' or '-s' or '-a'" | tee -a $logfile
  usage
fi

if [ $target_video_bitrate -eq 0 ] && [ $target_size -eq 0 ] && [ $make_final_dest_comp -eq 1 ]; then
  echo "-E- You must specify a bitrate in compressed file mode. You must specify '-b' or '-s' when using '-z'" | tee -a $logfile
  usage
fi

if [ $mirror_mode -eq 1 ]; then
  if [ $make_final_dest_vob -eq 1 ] || [ $make_final_dest_iso -eq 1 ] || 
     [ $make_final_dest_folder -eq 1 ] || [ $make_final_dest_comp -eq 1 ]; then
    echo "-E- You can't specify '-v' or '-i' or '-f' or '-z' when operating in mirror mode with '-m'" | tee -a $logfile
    usage
  fi
fi

# If audio channel requirements weren't given, assume a default value of 6channel audio
if [ $audio_2ch -eq 0 ] && [ $audio_6ch -eq 0 ]; then
  audio_6ch=1
  custom_audio_6ch=1
fi

# Make makemkv the default ripper if not specified and we can find it
if [ -z "$ripper" ]; then
  ripper="makemkv"
  [[ ! -x `which $makemkv` ]] && ripper="ddrescue";
fi

# Make handbrake the default encoder if not specified and we can find it
if [ -z "$encoder" ]; then
  encoder="mencoder"; # If we can't find handbrake, set mencoder as the default
  [[ -x `which $handbrake_xvid` ]] && [[ "$profile" =~ "xvid" ]] && encoder="handbrake";
  [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "mp4" ]] && encoder="handbrake";
  [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "mkv" ]] && encoder="handbrake";
  [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "ip" ]] && encoder="handbrake";
  [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "hb" ]] && encoder="handbrake";
fi

# Sanity check the profile selection
if [[ "$encoder" == "mencoder" ]]; then
  [[ "$profile" =~ "mp4" ]] && echo "-E- invalid encoder $encoder selected for mp4 profile: $profile" && exit
  [[ "$profile" =~ "mkv" ]] && echo "-E- invalid encoder $encoder selected for mkv profile: $profile" && exit
fi

if [[ "$encoder" != "mencoder" ]] && [[ "$encoder" != "handbrake" ]]; then
  echo "-E- Invalid encoder specified: $encoder"
  exit 1
fi

# If the aspect ratio option was specified, set the scale variable appropriately for mencoder
if [ "$aspect" != "" ]; then
  echo "$aspect" | grep -q "x"
  if [ $? == 0 ]; then
    echo "-E- You must specify the aspect option with a value whose format is W:H"
    exit 1
  fi
  echo "$aspect" | grep -q ":"
  if [ $? != 0 ]; then
    [ "$encoder" == "mencoder" ] && SCALE=",scale -zoom -sws 9 -xy $aspect"
    [ "$encoder" == "handbrake" ] && SCALE="-w $aspect"
  else
    [ "$encoder" == "mencoder" ] && SCALE=",scale=$aspect"
    if [ "$encoder" == "handbrake" ]; then
       WIDTH=`echo "$aspect" | awk -F ':' '{ print $1; }'`
       HEIGHT=`echo "$aspect" | awk -F ':' '{ print $2; }'`
       SCALE="-w $WIDTH -l $HEIGHT"
    fi
  fi
fi

# Sanity Check - Key executables
[[ ! -x `which lsdvd` ]] && echo "-E- missing dependency: lsdvd" && exit
[[ ! -x `which volname` ]] && echo "-E- missing dependency: volname" && exit
[[ ! -x `which ddrescue` ]] && echo "-E- missing dependency: ddrescue" && exit
[[ ! -x `which dvdbackup` ]] && echo "-E- missing dependency: dvdbackup" && exit
[[ ! -x `which mencoder` ]] && echo "-E- missing dependency: mencoder" && exit
[[ ! -x `which makexml` ]] && echo "-E- missing dependency: makexml" && exit
[[ ! -x `which dvdauthor` ]] && echo "-E- missing dependency: dvdauthor" && exit
[[ ! -x `which mkisofs` ]] && echo "-E- missing dependency: mkisofs" && exit
[[ -n "$handbrake_xvid" ]] && [[ ! -x `which $handbrake_xvid` ]] && echo "-E- missing handbrake xvid encoder, set in rip_dvd.conf to: $handbrake_xvid" && exit
[[ -n "$handbrake_mp4" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing handbrake mp4 encoder, set in rip_dvd.conf to: $handbrake_mp4" && exit
[[ -n "$makemkv" ]] && [[ ! -x `which $makemkv` ]] && echo "-E- missing makemkv ripper, set in rip_dvd.conf to: $makemkv" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "xvid" ]] && [[ ! -x `which $handbrake_xvid` ]] && echo "-E- missing HandBrake encoder: $handbrake_xvid" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "mp4" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing HandBrake encoder: $handbrake_mp4" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "ip" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing HandBrake encoder: $handbrake_mp4" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "hb" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing HandBrake encoder: $handbrake_mp4" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "mkv" ]] && [[ ! -x `which $mkvextract` ]] && echo "-E- missing mkvextract: $mkvextract" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "mkv" ]] && [[ ! -x `which $mkvpropedit` ]] && echo "-E- missing mkvpropedit: $mkvpropedit" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "mkv" ]] && [[ ! -x `which $mkvmerge` ]] && echo "-E- missing mkvmerge: $mkvmerge" && exit
[[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "mp4" ]] && [[ ! -x `which $mp4box` ]] && echo "-E- missing mp4box: $mp4box" && exit
[[ "$encoder" == "handbrake" ]] && [[ ! -x `which ffmpeg` ]] && echo "-E- missing dependency: ffmpeg" && exit

##############################################################################################

typeset -i ripdvd
if [ -z "$dvdname" ]; then

  # make sure the DVD device is accessible
  volname $dev > /dev/null 2>&1
  if [ $? != 0 ]; then
    echo "-E- Can't access the DVD device $dev"
    exit 1
  fi

  # now capture the volume name from the device
  dvdname=`volname $dev | awk '{ print $1 }'`
  ripdvd=1
 
  # if the dvdname is still blank, go about it a different way (for BluRays)
  if [[ -z "$dvdname" ]]; then
    echo "-> Using makemkv to obtain disk label"
    dvdname=`$makemkv info --noscan --robot disc:$makemkv_disc_id | grep "CINFO:2," | awk -F "," '{ print $3; }' | tr ' ' '_' | sed 's/\"//g'`
    echo "   Found disk label: $dvdname"
    ripdvd=1
  fi

else 

  # check to see if dvdname is a full path to a real directory
  # if it is, set dvdname and dvdpath appropriately
  if [ -d "$dvdname" ]; then
    dvdpath="$dvdname"
    dvdname=`basename "$dvdname"`
    keep_dvdfolder=1
    if [ -z "$dvdname" ]; then
     echo "-E- Unable to extract dvdname from path: $dvdpath"
     exit 1
    fi
    if [ ! -d "$dvdpath/VIDEO_TS" ]; then
      echo "-E- You must supply a full path to a valid DVD folder with this option"
      exit 1
    fi
  fi

  # Check to see if dvdname is a full path to a file
  if [ -f "$dvdname" ]; then
    valid_file=0

    # check to see if dvdname is a full path to an MPG2 (VOB) file
    # if it is, set dvdname and vobfile appropriately
    file "$dvdname" | grep -q "MPEG"
    if [ $? == 0 ]; then
      # It is a valid MPEG2 file, now strip the extension off our dvdname
      # An MPEG file is like a VOB file (intermediate format of the DVD movie)
      vobfile="$dvdname"
      dvdname=`basename "$dvdname"`
      dvdname=${dvdname%.[^.]*}
      keep_vobfile=1
      valid_file=1
    fi

    # check to see if dvdname is a full path to an ISO file
    # if it is, set dvdname and isofile appropriately
    file "$dvdname" | grep -q -e "ISO" -e "UDF"
    if [ $? == 0 ]; then
      # It is a valid ISO file, now strip the extension off our dvdname
      # An ISO file is treated as a disc or DVD image that needs to be converted
      # to an intermediate vobfile before it can be compressed.
      isofile="$dvdname"
      dvdname=`basename "$dvdname"`
      dvdname=${dvdname%.[^.]*}
      keep_isofile=1
      valid_file=1
    fi    

    # check to see if dvdname is a full path to a VOB file
    # if it is, set dvdname and isofile appropriately
    file "$dvdname" | grep -q -e "VOB"
    if [ $? == 0 ]; then
      # It is a valid VOB file, now strip the extension off our dvdname
      # A VOB file is an intermediate format of the DVD movie
      vobfile="$dvdname"
      dvdname=`basename "$dvdname"`
      dvdname=${dvdname%.[^.]*}
      keep_vobfile=1
      valid_file=1
    fi  
    
    # check to see if dvdname is a full path to an MKV file
    # if it is, set dvdname and isofile appropriately
    file "$dvdname" | grep -q -e "mkv"
    if [ $? == 0 ]; then
      # It is a valid MKV file, now strip the extension off our dvdname
      # An MKV file is like a VOB file (intermediate format of the DVD movie)
      vobfile="$dvdname"
      dvdname=`basename "$dvdname"`
      dvdname=${dvdname%.[^.]*}
      keep_vobfile=1
      valid_file=1
    fi    


    # If we didn't find a handler for the file above, complain
    if [ $valid_file -eq 0 ]; then
      echo "-E- Unsupported file type: $vobfile"
      exit 1
    fi

  # Throw an error if we can't find what the -n option is pointing to
  else 
    echo "-E- Unable to find the directory or file specified by the '-n $dvdname' option. Please make sure the path is valid."
    exit 1
  fi

  # Set the ripdvd flag to false since we aren't ripping a DVD disk
  ripdvd=0

  # Since we aren't ripping a DVD disk, don't eject anything either
  eject_disk=0

fi

# remove bad characters from the dvdname
dvdname=${dvdname%.} # remove trailing '.' character

# add the suffix extension to the end of the dvdname
dvdname=$dvdname$extension

# make a "safe" dvdname (remove special characters)
safedvdname=`basename "$dvdname" | sed 's/[ !&*\\$?]/_/g'`

# Make sure we have a non-empty dvdname
if [ -z "$dvdname" ]; then
  echo "-E- unable to determine dvdname"
  exit 1
fi

# make sure our vobfile value is set
if [ -z "$vobfile" ]; then
  vobfile="$dest/$dvdname.VOB"
fi

# set up some variables to hold various logfiles
logfile="$logdir/$dvdname.log"
passlogfile="$tmpdir/$safedvdname.log"
ddrescuelog=`tempfile`
dvdauthorlog=`tempfile`
encodelog=`tempfile`
dumplog=`tempfile`

# create the tmpdir if it doesn't already exist
if [ ! -d "$tmpdir" ]; then
  mkdir -p "$tmpdir"
  if [ $? != 0 ]; then
    echo "-E- Unable to create the tmpdir: $tmpdir"
    exit 1
  fi
fi

# create the logdir if it doesn't already exist
if [ ! -d "$logdir" ]; then
  mkdir -p "$logdir"
  if [ $? != 0 ]; then
    echo "-E- Unable to create the logdir: $logdir"
    exit 1
  fi
fi

##############################################################################################
# cleanup functions
##############################################################################################
cleanup() { 
  if [ $keep_intermediate_files -eq 0 ]; then
    [[ -e "$dvdauthorlog" ]] && rm -f "$dvdauthorlog"
    [[ -e "$ddrescuelog" ]] && rm -f "$ddrescuelog"
    [[ -e "$encodelog" ]] && rm -f "$encodelog"
    [[ -e "$dumplog" ]] && rm -f "$dumplog"
  else
    [[ -e "$dvdauthorlog" ]] && echo "-> Keeping dvdauthor log: $dvdauthorlog" | tee -a "$logfile"
    [[ -e "$ddrescuelog" ]] && echo "-> Keeping ddrescue log: $ddrescuelog" | tee -a "$logfile"
    [[ -e "$encodelog" ]] && echo "-> Keeping encode log: $encodelog" | tee -a "$logfile"
    [[ -e "$dumplog" ]] && echo "-> Keeping dump log: $dumplog" | tee -a "$logfile"
  fi
  echo ""
}

fatal_and_exit() {
  if [[ -z "$1" ]]; then
    msg="-E- control-c killed us"
  else
    msg=$1
  fi
  echo -e 2>&1 "$msg" | tee -a "$logfile"
  if [[ -n "$mailto" ]]; then
    echo -e "$msg" | mailx -s "dvd rip of $dvdname FAILED" "$mailto"
  fi
  keep_intermediate_files=1
  exit 1
}

# Call our cleanup functions on INT and EXIT signals
trap fatal_and_exit INT
trap cleanup EXIT

##############################################################################################
# processing functions
##############################################################################################

function alarm() { perl -e 'alarm shift; exec @ARGV' "$@"; }

function lsdvd_longest_title {
  dev="$1"

  # Only use lsdvd to extract the longest feature title if we didn't detect an incompatibility earlier
  if [ $lsdvd_incompatibility -eq 1 ]; then
    invalid_feature_title=1
    return
  fi

  # Try the normal lsdvd command to see if it works
  alarm $lsdvd_timeout lsdvd $dev >> "$logfile" 2>&1
  if [ $? != 0 ]; then
    # lsdvd didn't work
    invalid_feature_title=1
    lsdvd_incompatibility=1
    return
  fi
 
  # lsdvd is good to go, use it
  feature_title=`lsdvd $dev 2>/dev/null | awk '/Longest/ { print $NF }'`
}

function lsdvd_css {
  dev="$1"

  # Try the normal lsdvd command to see if it works
  alarm $lsdvd_timeout lsdvd $dev >> "$logfile" 2>&1

  if [ $? != 0 ]; then
    # lsdvd didn't work. Try VLC.
    lsdvd_incompatibility=1
    if [[ -x `which cvlc` ]]; then 
      echo "-> lsdvd failed to DeCSS the DVD. Trying VLC: $dev" | tee -a "$logfile"
      alarm $lsdvd_timeout cvlc --no-video --no-audio $dev  >> "$logfile" 2>&1
      # Once you get a DVD that VLC can't handle, figure out how 
      # to detect that here and abort.
      #if [ $? != 1 ]; then
      #  echo "-> VLC failed to decss the DVD."
      #  return 1
      #fi
    else
      fatal_and_exit "-E- lsdvd failed to DeCSS the DVD. VLC not found, but required to rip this DVD."
    fi
  fi
  return 0
}

# reduce the size of the mkv src file using handbrake
function encode_mkv_file_makemkv {
    src="$1"
    dst="$2"
    tmpdst=""

    # Convert our ISO to a MKV if it is a real iso
    if [[ $real_isofile -eq 1 ]]; then
	tmpdst="$tmpdir/$dvdname.mkv"
	make_dvd_mkv_image "$tmpdst" "iso" "$src"
	src="$tmpdst"
    fi

    # Set a variable that we will use later to determine if we found a handler for $profile or not
    typeset -i found_profile=0 
  
    # Globals
    typeset quality=""
    typeset handbrake_audio_opts=""
    typeset handbrake_cli=""

    # Predefined Handbrake Profile Handling
    if [[ "$profile" =~ "mkvvhq" ]]; then
	found_profile=1
	handbrake_cli="$handbrake_mp4"
	final_output_file="$dst"
	quality="0.9"
    fi
    if [[ "$profile" =~ "mkvhq" ]]; then
	found_profile=1
	handbrake_cli="$handbrake_mp4"
	final_output_file="$dst"
	quality="0.85"
    fi

    # setup our audio option
    if [ $audio_2ch -eq 1 ] && [ $audio_6ch -eq 1 ]; then
	handbrake_audio_opts="-E faac,ac3 -6 dpl2,auto"
    fi
    if [ $audio_6ch -eq 1 ] && [ $audio_2ch -eq 0 ]; then
	handbrake_audio_opts="-E ac3 -6 auto"
    fi
    if [ $audio_2ch -eq 1 ] && [ $audio_6ch -eq 0 ]; then
	handbrake_audio_opts="-E faac -6 dpl2"
    fi

    # find out what our audio track is
    get_audio_track_from_mkv "$src" "$handbrake_cli"
    if [ -n "$track" ]; then
	handbrake_audio_opts="$handbrake_audio_opts -a $track"
	track="" 
    fi
    
    # Execute the handbrake command to encode the video
    echo -e "\n   Encoding: $handbrake_cli -i \"$src\" -o \"$dst\" --strict-anamorphic --crop 0:0:0:0 -q $quality $handbrake_audio_opts -v 1 -m"
    $handbrake_cli -i "$src" -o "$dst" --strict-anamorphic --crop 0:0:0:0 -q $quality $handbrake_audio_opts -v 1 | tee -a $encodelog 2>&1
    handbrake_retval=$?

    if [ $handbrake_retval != 0 ]; then
	fatal_and_exit "-E- Unhandled handbrake error"
    fi

    # Extract the chapters from the src and apply to the dst
    chapter_tmpfile="$tmpdir/$dvdname.xml"
    $mkvextract chapters "$src" > "$chapter_tmpfile"
    $mkvpropedit -c "$chapter_tmpfile" "$dst"

    # find out what our default_alang subtitle track is in the src
    get_subtitle_track_from_mkv "$src" "$handbrake_cli"

    # Extract the subtitles from the src and apply to the dst
    srt_tmpfile="$tmpdir/$dvdname.srt"
    sub_tmpfile="$tmpdir/$dvdname.sub"
    idx_tmpfile="$tmpdir/$dvdname.idx"
    $mkvextract tracks "$src" $track:$srt_tmpfile
    $mkvmerge -o "$dst.subs" "$dst" $idx_tmpfile
    mv "$dst.subs" "$dst"

    # Set the default subtitle track to "no subtitles" in the dst
    $mkvpropedit "$dst" --edit track:s1 --set flag-default=0

    # Concatenate the encode log to our main log file, greping out unwanted lines
    cat $encodelog | grep -v "Encoding:" | grep -v "hb_demux_ps" >> "$logfile" 
    cat $encodelog | grep "Encoding:" | sed 's/
/\n/g' | grep "Encoding:" | grep "ETA" | head -1 >> "$logfile"
    cat $encodelog | grep "Encoding:" | sed 's/
/\n/g' | grep "Encoding:" | grep "ETA" | tail -1 >> "$logfile"  

    # Remove intermediary file if we created one   
    if [ $keep_intermediate_files -eq 0 ]; then
	[[ -e "$tmpdst" ]] && rm -f "$tmpdst"
	rm "$chapter_tmpfile"
	rm "$idx_tmpfile" "$sub_tmpfile"
    else
	echo "-> Keeping intermediate chapter file: $chapter_tmpfile" | tee -a "$logfile"
	echo "-> Keeping intermediate subtitle files: $idx_tmpfile $sub_tmpfile" | tee -a "$logfile"
	[[ -e "$tmpdst" ]] && echo "-> Keeping intermediate MKV file: $tmpdst" | tee -a "$logfile"
    fi
}

# encode the vob file into a compressed file format using handbrake
function encode_vob_file_handbrake {
  
  # declare some globals
  typeset handbrake_cli=""
  typeset handbrake_video_encoder_opts=""
  typeset filetype=""
  typeset handbrake_audio_opts=""
  typeset hb_profile=""
  typeset SIZE=""
  typeset AUDIO_BITRATE=""

  # Set a variable that we will use later to determine if we found a handler for $profile or not
  typeset -i found_profile=0    

  # Default is 2 pass mode. Profiles can override this. Command line can override this as well.
  PASSES="-2"
  if [ $force_onepass_mode -eq 1 ]; then
      PASSES=""
  fi

  # Set our DRC option
  DRC="-D $drc"

  if [ $target_size -ne 0 ]; then
    SIZE="-S $target_size"
  fi 

  if [ $custom_audio_bitrate -eq 1 ]; then
    AUDIO_BITRATE="-B $target_audio_bitrate"
  fi

  if [ $force_onepass_mode -eq 1 ]; then
    PASSES=""
  fi

  # get our audio track from the vobfile (requires mp4 version of handbrake to extract)
  if [[ "$vobfile" =~ /mkv/ ]]; then
      get_subtitle_track_from_mkv "$vobfile" "$handbrake_mp4"
  else
      get_audio_track_from_vob "$vobfile" "$handbrake_mp4"
  fi

  # XVID profile
  if [[ "$profile" =~ "xvid" ]]; then
    found_profile=1
    handbrake_cli="$handbrake_xvid"
    final_output_file="$dest/$dvdname.avi"
    filetype="avi"

    # Very High Quality (16fps)
    if [ "$profile" == "xvidvhq" ]; then
      handbrake_opts[0]="-f avi"
      handbrake_opts[1]="-b $target_video_bitrate"
      handbrake_opts[2]="-e xvid"
      handbrake_opts[3]="-T"
      handbrake_opts[4]="-5"
      handbrake_opts[5]="-8"
    fi
    # High Quality (20fps)
    if [ "$profile" == "xvidhq" ]; then
      handbrake_opts[0]="-f avi"
      handbrake_opts[1]="-b $target_video_bitrate"
      handbrake_opts[2]="-e ffmpeg"
      handbrake_opts[3]="-T"
      handbrake_opts[4]="-5"
    fi
    # Fast (28fps)
    if [ "$profile" == "xvid" ]; then
      handbrake_opts[0]="-f avi"
      handbrake_opts[1]="-b $target_video_bitrate"
      handbrake_opts[2]="-e ffmpeg"
      handbrake_opts[3]="-T"
    fi
  fi

  # MP4 || MKV profile
  if [[ "$profile" =~ "mp4" ]] || [[ "$profile" =~ "mkv" ]]; then
    found_profile=1
    handbrake_cli="$handbrake_mp4"
    [[ "$profile" =~ "mp4" ]] && final_output_file="$dest/$dvdname.mp4"
    [[ "$profile" =~ "mkv" ]] && final_output_file="$dest/$dvdname.mkv"	
    PASSES="$PASSES -T"

    # Handle custom parameter overrides
    if [ $custom_video_bitrate == 1 ]; then
      handbrake_opts[0]="-b $target_video_bitrate"
    fi
    if [ $custom_audio_2ch == 0 ]; then
      audio_2ch=0
    fi
    if [ $custom_audio_6ch == 0 ]; then
      audio_6ch=0
    fi

    # Very High Quality
    if [ "$profile" == "mp4vhq" ]; then
      profile="hb_High_Profile"
    fi
    # High Quality
    if [ "$profile" == "mp4hq" ]; then
      profile="hb_Normal"
    fi
    # Fast
    if [ "$profile" == "mp4" ]; then
      profile="hb_Classic"
    fi
  fi

  # iphone and ipod MP4 profiles
  if [ "$profile" == "iphone" ] || [ "$profile" == "ipod" ]; then
    found_profile=1
    handbrake_cli="$handbrake_mp4"
    final_output_file="$dest/$dvdname.mp4"
    PASSES=""

    # Handle custom parameter overrides
    if [ $custom_video_bitrate == 1 ]; then
      handbrake_opts[0]="-b $target_video_bitrate"
    fi
    if [ $custom_audio_2ch == 0 ]; then
      audio_2ch=0
    fi
    if [ $custom_audio_6ch == 0 ]; then
      audio_6ch=0
    fi

    # iphone
    if [ "$profile" == "iphone" ]; then
      profile="hb_iPhone_&_iPod_Touch"
    fi
    # ipod
    if [ "$profile" == "ipod" ]; then
      profile="hb_iPod"
    fi

  fi
  
  # Predefined Handbrake Profile Handling
  if [[ "$profile" =~ "hb" ]]; then
    found_profile=1
    handbrake_cli="$handbrake_mp4"
    final_output_file="$dest/$dvdname.mp4"

    # Handle custom parameter overrides
    if [ $custom_video_bitrate == 1 ]; then
      handbrake_opts[0]="-b $target_video_bitrate"
    fi
    if [ $custom_audio_2ch == 0 ]; then
      audio_2ch=0
    fi
    if [ $custom_audio_6ch == 0 ]; then
      audio_6ch=0
    fi
    
    # extract the HandBrake Profile name from $profile
    hb_profile=`echo "$profile" | sed 's/hb_//g' | sed 's/_/ /g'`
  fi

  # Make sure we found a handler for the given profile
  if [ $found_profile -eq 0 ]; then
    fatal_and_exit "-E- Unable to find a profile handler for profile: $profile"
  fi

  # setup our audio option
  if [ $audio_2ch -eq 1 ] && [ $audio_6ch -eq 1 ]; then
    handbrake_audio_opts="-E faac,ac3 -6 dpl2,auto"
  fi
  if [ $audio_6ch -eq 1 ] && [ $audio_2ch -eq 0 ]; then
    handbrake_audio_opts="-E ac3 -6 auto"
  fi
  if [ $audio_2ch -eq 1 ] && [ $audio_6ch -eq 0 ]; then
    handbrake_audio_opts="-E faac -6 dpl2"
  fi
  if [ -n "$track" ]; then
    handbrake_audio_opts="$handbrake_audio_opts -a $track"
  fi

  # Convert our array of opts into a string
  for OPTS in "${video_encoder_opts[@]}"; do 
    handbrake_video_encoder_opts="$handbrake_video_encoder_opts:$OPTS"
  done
  if [ -n "$handbrake_video_encoder_opts" ]; then
    handbrake_video_encoder_opts="-x $handbrake_video_encoder_opts"
  fi
  for OPTS in "${handbrake_opts[@]}"; do 
    handbrake_cmd_line_opts="$handbrake_cmd_line_opts $OPTS"
  done

  # Append "global" command line options
  handbrake_cmd_line_opts="$handbrake_cmd_line_opts -v 1 -m"
  handbrake_cmd_line_opts="$handbrake_cmd_line_opts $PASSES"
  handbrake_cmd_line_opts="$handbrake_cmd_line_opts $DRC"
  handbrake_cmd_line_opts="$handbrake_cmd_line_opts $SCALE"
  handbrake_cmd_line_opts="$handbrake_cmd_line_opts $SIZE"
  handbrake_cmd_line_opts="$handbrake_cmd_line_opts $AUDIO_BITRATE"

  # Execute the handbrake command to encode the video
  # I have to copy-n-paste the code below to handle the 2 conditions, 1) hb_profile (mp4) 2) no hb_profile (xvid)
  # The problem is the -Z "$hb_profile" option. I have to quote the "$hb_profile" due to spaces in it, forcing me to call it out explicity.
  if [ -n "$hb_profile" ]; then
    echo -e "\n   Encoding: $handbrake_cli -i \"$vobfile\" -o \"$final_output_file\" -Z \"$hb_profile\" $handbrake_cmd_line_opts $handbrake_audio_opts $handbrake_video_encoder_opts >> $encodelog 2>&1" >> "$logfile"
    $handbrake_cli -i "$vobfile" -o "$final_output_file" -Z "$hb_profile" $handbrake_cmd_line_opts $handbrake_audio_opts $handbrake_video_encoder_opts >> $encodelog 2>&1
    handbrake_retval=$?
  else 
    echo -e "\n   Encoding: $handbrake_cli -i \"$vobfile\" -o \"$final_output_file\" $handbrake_cmd_line_opts $handbrake_audio_opts $handbrake_video_encoder_opts >> $encodelog 2>&1" >> "$logfile"
    $handbrake_cli -i "$vobfile" -o "$final_output_file" $handbrake_cmd_line_opts $handbrake_audio_opts $handbrake_video_encoder_opts >> $encodelog 2>&1
    handbrake_retval=$?
  fi
  if [ $handbrake_retval != 0 ]; then
    fatal_and_exit "-E- Unhandled handbrake error"
  fi

  
  # SRC = ISO and FINAL = MP4
  # Extract the chapters from the ISO/VOB so we can add them to the MP4 file. 
  # We can only do this if we have an ISO file and we made an MP4 file.
  if [[ "$final_output_file" =~ "mp4" ]] && [[ -e "$isofile" ]]; then
    chapter_tmpfile="$tmpdir/$dvdname.chapters"
    $dvdxchap -t $feature_title "$isofile" > "$chapter_tmpfile"
    $mp4box -chap "$chapter_tmpfile" "$final_output_file"

    # We could also add subtitles, but we would need to follow this guide to do it:
    # http://ubuntuforums.org/showthread.php?t=1253635
    # http://en.gentoo-wiki.com/wiki/Ripping_DVD_to_Matroska_and_H.264

  fi

  # SRC = ISO and FINAL = MKV
  if [[ "$final_output_file" =~ "mkv" ]] && [[ -e "$isofile" ]]; then
    chapter_tmpfile="$tmpdir/$dvdname.chapters"
    $dvdxchap -t $feature_title "$isofile" > "$chapter_tmpfile"
    $mkvpropedit -c "$chapter_tmpfile" "$final_output_file"
  fi

  # SRC = MKV and FINAL = MP4
  if [[ "$final_output_file" =~ "mp4" ]] && [[ "$vobfile" =~ "mkv" ]]; then
    # Extract the chapters from the src and apply to the dst
    chapter_tmpfile="$tmpdir/$dvdname.xml"
    $mkvextract chapters "$vobfile" > "$chapter_tmpfile"
    $mp4box -chap "$chapter_tmpfile" "$final_output_file"
  fi

  # SRC = MKV and FINAL = MKV
  # If our original src file was an MKV, extract the chapters and subtitles from it
  if [[ "$final_output_file" =~ "mkv" ]] && [[ "$vobfile" =~ "mkv" ]]; then
    # Extract the chapters from the src and apply to the dst
    chapter_tmpfile="$tmpdir/$dvdname.xml"
    $mkvextract chapters "$vobfile" > "$chapter_tmpfile"
    $mkvpropedit -c "$chapter_tmpfile" "$final_output_file"

    # find out what our default_alang subtitle track is in the src
    get_subtitle_track_from_mkv "$vobfile" "$handbrake_mp4"

    # Extract the subtitles from the src and apply to the dst
    srt_tmpfile="$tmpdir/$dvdname.srt"
    sub_tmpfile="$tmpdir/$dvdname.sub"
    idx_tmpfile="$tmpdir/$dvdname.idx"
    $mkvextract tracks "$vobfile" $track:$srt_tmpfile
    $mkvmerge -o "$final_output_file.subs" "$final_output_file" "$idx_tmpfile"
    mv "$final_output_file.subs" "$final_output_file"

    # Set the default subtitle track to "no subtitles" in the dst
    $mkvpropedit "$final_output_file" --edit track:s1 --set flag-default=0 
  fi

  # Remove intermediary file if we created one   
  if [ $keep_intermediate_files -eq 0 ]; then
      [[ -e "$chapter_tmpfile" ]] && rm "$chapter_tmpfile"
      [[ -e "$idx_tmpfile" ]] && rm "$idx_tmpfile" 
      [[ -e "$sub_tmpfile" ]] && rm "$sub_tmpfile"
  else
      [[ -e "$chapter_tmpfile" ]] && echo "-> Keeping intermediate chapter file: $chapter_tmpfile" | tee -a "$logfile"
      [[ -e "$idx_tmpfile" ]] && echo "-> Keeping intermediate subtitle files: $idx_tmpfile $sub_tmpfile" | tee -a "$logfile"
  fi

  # Concatenate the encode log to our main log file, greping out unwanted lines
  cat $encodelog | grep -v "Encoding:" | grep -v "hb_demux_ps" >> "$logfile" 
  cat $encodelog | grep "Encoding:" | sed 's/
/\n/g' | grep "Encoding:" | grep "ETA" | head -1 >> "$logfile"
  cat $encodelog | grep "Encoding:" | sed 's/
/\n/g' | grep "Encoding:" | grep "ETA" | tail -1 >> "$logfile"
}

# encode the vob file into a compressed file format using mencoder
function encode_vob_file_mencoder {

  # Set a variable that we will use later to determine if we found a handler for $profile or not
  typeset -i found_profile=0

  # For a given profile, to override the 2 pass behavior to be single pass,
  # simply set the PASSES variable below to "2" instead of "1 2" inside your profile handler. 
  # It indicates which PASS numbers to loop over. PASSES="2" means just do pass 2 => single pass mode.
  PASSES="1 2"

  # Declare our default 2 pass variables
  passlogfile_opt="-passlogfile $passlogfile"
  pass_opt="pass=%PASS"

  # Check the global force_onepass_mode. If it is set, change our variables appropriately
  # to force 1-pass encoding across all profiles.
  if [ $force_onepass_mode -eq 1 ]; then
    PASSES="2"
    passlogfile_opt=""
    pass_opt=""    
  fi

  # XVID profile
  if [[ "$profile" =~ "xvid" ]]; then
    found_profile=1
    final_output_file="$dest/$dvdname.avi"
    mencoder_general_opts="$lang_opts $passlogfile_opt"
    mencoder_output_opts="-ofps 30000/1001 -ffourcc DIVX"
    mencoder_video_filter_opts="-vf pullup,softskip,hqdn3d=2:1:2$CROP$SCALE"
    mencoder_video_encoder_opts="-ovc xvid -xvidencopts $pass_opt"

    # Very High Quality (16fps)
    if [ "$profile" == "xvidvhq" ]; then
      video_encoder_opts[0]="bitrate=$target_video_bitrate"
      video_encoder_opts[1]="threads=$mencoder_threads"
      video_encoder_opts[2]="chroma_opt"
      video_encoder_opts[3]="vhq=4"
      video_encoder_opts[4]="bvhq=1"
      video_encoder_opts[5]="quant_type=mpeg"
      video_encoder_opts[6]="autoaspect"
    fi
    # High Quality (20fps)
    if [ "$profile" == "xvidhq" ]; then
      video_encoder_opts[0]="bitrate=$target_video_bitrate"
      video_encoder_opts[1]="threads=$mencoder_threads"
      video_encoder_opts[2]="chroma_opt"
      video_encoder_opts[3]="vhq=2"
      video_encoder_opts[4]="bvhq=1"
      video_encoder_opts[5]="quant_type=mpeg"
      video_encoder_opts[6]="autoaspect"
    fi
    # Fast (28fps)
    if [ "$profile" == "xvid" ]; then
      video_encoder_opts[0]="bitrate=$target_video_bitrate"
      video_encoder_opts[1]="threads=$mencoder_threads"
      video_encoder_opts[2]="vhq=0"
      video_encoder_opts[3]="turbo"
      video_encoder_opts[4]="autoaspect"
    fi

    for OPTS in "${video_encoder_opts[@]}"; do 
      mencoder_video_encoder_opts="$mencoder_video_encoder_opts:$OPTS"
    done

    if [ $audio_2ch -eq 0 ]; then
      # These options produce good 6 channel audio for linux and windows
      mencoder_audio_opts="-oac copy"
      # There are 3 different ways to specify 6 channel encoding. We'll try the other ones in order if one of them fails.
      mencoder_audioch_opts[0]="-channels 6 -af channels=6"
      mencoder_audioch_opts[1]="-af channels=6"
      mencoder_audioch_opts[2]=""
    else
      # These options produce good 2 channel audio for linux and windows (including the internal mythvideo player)
      mencoder_audio_opts="-oac mp3lame -lameopts cbr:br=$target_audio_bitrate"
      mencoder_audioch_opts[0]=""
    fi
 
  fi

  # iphone and ipod MP4 profiles
  if [ "$profile" == "iphone" ] || [ "$profile" == "ipod" ]; then
    found_profile=1
    if [ "$profile" == "iphone" ]; then
      # SCALE: 480x320
      # scale width to 480, set height appropriately, but keep a multiple of 16
      #SCALE=",scale=480:-10"
      # scale the video down however far is necessary to fit in 480x320
      SCALE=",dsize=480:320:0,scale=-8:-8"
    else
      # SCALE: 320x240
      # scale width to 320, set height appropriately, but keep a multiple of 16
      #SCALE=",scale=320:-10"
      # scale the video down however far is necessary to fit in 320x240
      SCALE=",dsize=320:240:0,scale=-8:-8"
    fi
    final_output_file="$dest/$dvdname.mp4"
    mencoder_general_opts="$lang_opts $passlogfile_opt"
    mencoder_output_opts="-ofps 30000/1001 -sws 9 -of lavf -lavfopts format=mp4"
    mencoder_video_filter_opts="-vf harddup$CROP$SCALE";
    mencoder_video_encoder_opts="-ovc x264 -x264encopts $pass_opt"
    video_encoder_opts[0]="bitrate=$target_video_bitrate"
    video_encoder_opts[1]="threads=$mencoder_threads"
    video_encoder_opts[2]="vbv_maxrate=1500"
    video_encoder_opts[3]="vbv_bufsize=2000"
    video_encoder_opts[4]="nocabac"
    video_encoder_opts[5]="me=umh"
    video_encoder_opts[6]="subq=6"
    video_encoder_opts[7]="frameref=6"
    video_encoder_opts[8]="trellis=1"
    video_encoder_opts[9]="level_idc=30"
    video_encoder_opts[10]="global_header"
    video_encoder_opts[11]="bframes=0"
    video_encoder_opts[12]="partitions=all"
    for OPTS in "${video_encoder_opts[@]}"; do 
      mencoder_video_encoder_opts="$mencoder_video_encoder_opts:$OPTS"
    done

    mencoder_audio_opts="-oac faac -faacopts mpeg=4:object=2:br=$target_audio_bitrate:raw"
    mencoder_audioch_opts[0]="-channels 2 -srate 48000"
  fi

  if [ $found_profile -eq 0 ]; then
    fatal_and_exit "-E- Unable to find a profile handler for profile: $profile"
  fi

  # Do not edit this line. $mencoder_video_encoder_opts must be last
  mencoder_opts="$mencoder_general_opts $mencoder_output_opts $mencoder_audio_opts $mencoder_video_filter_opts $mencoder_video_encoder_opts"
  mencoder_retval=0

  for PASS in $PASSES
  do 
    # Set some options based on which pass we are in
    mencoder_opts_for_pass=$(echo "$mencoder_opts" | sed "s,%PASS,$PASS,g")
    [ $PASS -eq 1 ] && mencoder_opts_for_pass="$mencoder_opts_for_pass:turbo"
    [ $PASS -eq 1 ] && output_file="/dev/null"
    [ $PASS -eq 2 ] && output_file="$final_output_file"
  
    # It's possible that the audio channel encoding may not work. Cycle through all our different audioch_opts until we find one that works.
    for CH_OPTS in "${mencoder_audioch_opts[@]}"; 
    do
      echo -e "   Encoding pass $PASS"
      echo -e "\n   Encoding pass $PASS: mencoder $CH_OPTS $mencoder_opts_for_pass \"$vobfile\" -o \"$output_file\" >> $encodelog 2>&1" >> "$logfile"
      mencoder $CH_OPTS $mencoder_opts_for_pass "$vobfile" -o "$output_file" > $encodelog 2>&1
      mencoder_retval=$? 
      grep -q "\[channels\] Invalid" $encodelog
      if [ $? != 0 ]; then	    
        break;
      else
        echo -e "\n-W- Audio channel encoding error. Falling back to next audio channel encoding scheme." >> "$logfile"
      fi
    done
      
    if [ $mencoder_retval != 0 ]; then
      fatal_and_exit "-E- Unhandled mencoder error"
    fi

    # Concatenate the encode log to our main log file, greping out unwanted lines
    cat $encodelog | grep -v "^Pos:" | grep -v "duplicate" >> "$logfile"

  done
}

function make_dvd_mkv_image {
    dstmkv="$1"
    srctype="$2"
    srcname="$3"
    dstdir=${dstmkv%.[^.]*}
    ((min_length = minimum_feature_title_length * 60))

    echo -e "\n   Ripping: $makemkv mkv --minlength=$min_length --decrypt --progress=-same $srctype:$srcname all $dstdir"
    mkdir -p "$dstdir"
    $makemkv mkv --minlength=$min_length --decrypt --progress=-same $srctype:$srcname all $dstdir 2>&1 | tee -a "$ddrescuelog"
    makemkv_retval=$?
    
    if [ $makemkv_retval != 0 ]; then
	fatal_and_exit "-E- Unhandled makemkv error"
    fi

    if [ $makemkv_copy_largest_title_only -eq 1 ]; then
      # Move the largest created MKV file to destination
      # There might be multiple ones, so just grab the largest one
      largest_mkv_file=`/bin/ls -1S "$dstdir"/*.mkv | head -1`
      echo -e "\n   Moving largest mkv file $largest_mkv_file -> $dstmkv\n" | tee -a "$ddrescuelog"
      mv "$largest_mkv_file" "$dstmkv"
    else
      # Move all of the created MKV files to destination
      echo "\n" | tee -a "$ddrescuelog"
      dstfile=${dstmkv%.[^.]*}
      typeset -i num=0
      typeset -i titles=0
      for i in `/bin/ls -1 "$dstdir"/*.mkv`; do
	((titles = titles + 1))
      done
      if [[ $titles > 1 ]]; then
        for i in `/bin/ls -1 "$dstdir"/*.mkv`; do
          echo -e "   Moving $i -> $dstfile.$num.mkv" | tee -a "$ddrescuelog"
          mv "$i" "$dstfile.$num.mkv"
          ((num = num + 1 ))
        done
      else 
         echo -e "  Moving $dstdir/*.mkv -> $dstfile.mkv" | tee -a "$ddrescuelog"
         mv "$dstdir"/*.mkv "$dstfile.mkv"
      fi
      echo "\n" | tee -a "$ddrescuelog"
    fi

    if [ $? != 0 ]; then
	fatal_and_exit "-E- Unhandled mv error"
    fi
    if [ $keep_intermediate_files -eq 0 ]; then
	[[ -d "$dstdir" ]] && rm -rf "$dstdir"
    fi

    # Concatenate the encode log to our main log file, greping out unwanted lines
    cat "$ddrescuelog" | grep -v "Current progress:" >> "$logfile"    
}

function make_dvd_mkv_image_from_folder {
    src="$1"
    dst="$2"
    handle_error=$3
    dstdir=${dst%.[^.]*}
    make_dvd_mkv_image "$dst" "file" "$src"
}

function make_dvd_iso_image {

  isofile="$1"

  # check to see if we have a dvdpath to rip from instead of $dev
  if [ -z "$dvdpath" ]; then
    # load the CSS codes in the DVD drive 
    lsdvd_css "$dev"
    if [ $? != 0 ]; then
      fatal_and_exit "-E- lsdvd $dev failed" 
    fi

    # read the DVD, ignoring/skipping CRC errors
    ddrescue -n -b 2048 $dev "$isofile" "$ddrescuelog"
    if [ $? != 0 ]; then
      fatal_and_exit "-E- ddrescue -n -b 2048 $dev \"$isofile\" failed"
    fi
    cat "$ddrescuelog" >> "$logfile"
  else
    # rip from a path instead
    make_dvd_iso_image_from_folder "$dvdpath" "$isofile" 1
  fi
}

function make_dvd_iso_image_from_folder {
  
  src="$1"
  dst="$2"
  handle_error=$3
  
  echo "-> Creating ISO image of DVD video: $src -> $dst" | tee -a "$logfile"

  # make an iso image out of our directory
  echo "   mkisofs -dvd-video \"$src\" 2>> \"$dumplog\" | dd of=\"$dst\" obs=32k seek=0 > /dev/null 2>> $dumplog" >> "$logfile"
  mkisofs -dvd-video "$src" 2>> "$dumplog" | dd of="$dst" obs=32k seek=0 > /dev/null 2>> "$dumplog"

  # set the audio languages from the iso if it exists and is non-zero in size
  if [ -s "$dst" ]; then
    get_feature_title "$dst"
    get_audio_id_from_iso "$dst"
  fi

  # make sure we were able to create the iso image from the folder given to us
  if [ ! -s "$dst" ] && [ $handle_error -eq 1 ]; then
    echo "-> Unable to make an iso image from the DVD folder: $dvdpath"
    echo "   Falling back to mplayer to create a main feature VOB from the folder instead: $dvdpath"
    # remove the bad iso file
    [[ -e "$dst" ]] && rm -f "$dst"
    # get the feature title from the DVD folder
    get_feature_title "$dvdpath"
    # create our main VOB file from the ISO
    create_main_vob_with_mplayer "$dvdpath" 
    # get our audio id from the VOB file
    get_audio_id_from_vob "$vobfile"
  fi
}

function make_dvdbackup_folder_image {
  # extract the feature title from the DVD image
  echo "-> Extracting feature title using dvdbackup" | tee -a "$logfile"
  [[ -d "$tmpdir/$dvdname" ]] && rm -rf "$tmpdir/$dvdname"
  dvdbackup -F -i "$isofile" -o "$tmpdir" >> "$logfile"
  if [ $? != 0 ]; then
    fatal_and_exit '-E- dvdbackup -F -i "$isofile" -o "$tmpdir" failed'
  fi
}

function make_dvdauthor_folder_image {
  # create a new DVD video of the feature title
  echo "-> Creating DVD video $dest/$dvdname" | tee -a "$logfile"
  [[ -d "$dest/$dvdname" ]] && rm -rf "$dest/$dvdname"
  dvdauthor -o "$dest/$dvdname" -x dvd.xml > $dvdauthorlog 2>&1
  cat $dvdauthorlog | grep -v "VOBU" >> "$logfile"

  # There is a chance that dvdauthor won't like some of the VOBs.
  # We can't tell ahead of time which ones it will choke on. 
  # So, we need to run it over and over again until it can process
  # all the VOBs. If it can't handle one of them, run it through
  # mencoder to fix it and try again. These errors are typically
  # present due to the copy protection that ddrescue removed.
  grep -q "SCR moves" $dvdauthorlog
  while [ $? == 0 ]; do
    # fix bad vobs that get the "SCR moves backwards" error:
    #  STAT: Processing VTS_01_0.VOB...
    #  ERR:  SCR moves backwards, remultiplex input.
    badvob=`grep -v "^WARN:" $dvdauthorlog | grep -B 1 "SCR moves" | grep "Processing" | awk '{ print $3 }' | sed -e 's/\.\.\.//'`
    if [[ ! -f "$badvob" ]]; then
      fatal_and_exit "-E- Found a bad VOB, but could not extract it's name properly: $badvob"
    fi
    echo "-> Fixing SCR errors in DVD video file $badvob" | tee -a "$logfile"
    cat $badvob | mencoder $lang_opts -quiet -of mpeg -mpegopts format=dvd -oac copy -ovc copy - -o $badvob.fixed >> "$logfile" 2>&1
    mv -f $badvob.fixed $badvob
    echo "-> Creating DVD video $dest/$dvdname"
    dvdauthor -o "$dest/$dvdname" -x dvd.xml > $dvdauthorlog 2>&1
    cat $dvdauthorlog | grep -v "VOBU" >> "$logfile"
    grep -q "SCR moves" $dvdauthorlog
  done
}

function get_feature_title {
  source="$1"
  # if a feature title was given on the command line, use it
  if [ $feature_title_override -ne 0 ]; then
    feature_title=$feature_title_override
    return 0
  fi
  # otherwise, use lsdvd to figure it out
  if [ $ripdvd -eq 1 ]; then
    lsdvd_longest_title "$dev" 
  else 
    lsdvd_longest_title "$source"
  fi
}

function create_main_vob_with_cat {
  # cd to the feature title DVD folder
  pushd "$tmpdir/$dvdname/VIDEO_TS" > /dev/null 2>&1
  if [ $? != 0 ]; then
    fatal_and_exit "-E- Unable to cd to $tmpdir/$dvdname/VIDEO_TS"
  fi

  # concatenate all the VOBs together into 1 giant VOB
  vobs=`/bin/ls -1 VTS*.VOB | grep -v "0.VOB" | tr '\n' ' '`
  cat $vobs > "$tmpdir/$dvdname.VOB"

  # cd back to the dir we started from
  popd > /dev/null 2>&1
}

function create_main_vob_with_mplayer {

  # argument processing  
  source="$1"
  remove_dumplog=$2

  # make sure we have a valid feature title
  if [ $invalid_feature_title -eq 1 ] && [ $feature_title_override -eq 0 ]; then
    fatal_and_exit "-E- You must have a valid feature title to get the VOB via mplayer dumpstream. We can't determine the feature title for this DVD."
  fi

  # check to make sure we didn't detect an mplayer dumpstream incompatibility earlier
  if [ $mplayer_dumpstream_incompatibility -eq 1 ]; then
    msg="-E- We detected an mplayer dumpstream incompatibility earlier."
    msg="$msg We also detected a condition that may require you to use dumpstream. "
    msg="$msg\n    Unable to rip this DVD in the mode you requested."
    fatal_and_exit "$msg"
  fi

  # use mplayer to create the main VOB file
  echo "-> Using mplayer to dump the DVD feature title $feature_title to a VOB file directly: $vobfile" | tee -a "$logfile"
  echo "   mplayer $lang_opts -dumpstream -dumpfile \"$vobfile\" -dvd-device \"$source\" dvd://$feature_title > $dumplog 2>&1" >> "$logfile"
  mplayer $lang_opts -dumpstream -dumpfile "$vobfile" -dvd-device "$source" dvd://$feature_title > $dumplog 2>&1
  if [ $? != 0 ]; then
    cat $dumplog | grep -v "^A:" >> "$logfile"
    fatal_and_exit "-E- Mplayer Failed"
  fi
  cat $dumplog | grep -v "^A:" >> "$logfile"
  [[ -e "$dumplog" ]] && [[ $remove_dumplog -eq 1 ]] && rm -f $dumplog
}

function get_audio_id_from_iso {
  # Adjust our audio ID to find the english audio stream
  # This should be 128. However, if 128 is not there, pick the next one that incrementally is.
  iso="$1"
  aidcheck=`tempfile`
  aid=$default_aid
  alang=$default_alang
  if [ $aid_override -lt 0 ]; then 
    mplayer -v -endpos 0 -dvd-device "$iso" dvd://$feature_title > $aidcheck 2>&1
    grep -q "aid: $aid" $aidcheck
    while [ $? == 1 ] && [ $aid -lt 159 ]; do
      (( aid = aid + 1 ))
      grep -q "aid: $aid" $aidcheck
    done
    [[ -e "$aidcheck" ]] && rm -f "$aidcheck"
  else
    aid=$aid_override
  fi
  echo "-> Setting the audio stream ID to $aid" | tee -a "$logfile"
  # mencoder default DVD audio track language selection (english)
  lang_opts="-aid $aid -alang $alang"
}

function get_crop_from_iso { 
  FRAMES=10000
  echo "-> Detecting black frame border crop value from ISO file"
  echo "   mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark -dvd-device \"$isofile\" dvd://$feature_title > $dumplog 2>&1" >> "$logfile"
  mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark -dvd-device "$isofile" dvd://$feature_title > $dumplog 2>&1
  [[ -e "md5sums" ]] && rm -f "md5sums"
  CROP=`cat $dumplog | grep CROP | tail -1`
  echo "   Found crop value of $CROP" >> "$logfile"
  CROP=${CROP#* crop=}
  CROP=${CROP%%\).*}
  typeset -i CROPCHECK
  CROPCHECK=`echo "$CROP" | awk -F ':' '{ print $1 }'`
  echo "   Final crop value of $CROP with cropcheck value of $CROPCHECK" >> "$logfile"
  if [ -z "$CROP" ]; then
    echo "-W- Unable to extract CROP value from iso: $isofile" | tee -a "$logfile"
    return
  fi
  if [ $CROPCHECK -lt 0 ]; then 
    CROP=""
  else 
    CROP=",crop=$CROP"
  fi
  echo "   Setting mencoder crop filter to: $CROP"
}

function get_crop_from_vob { 
  FRAMES=10000
  echo "-> Detecting black frame border crop value from VOB file"
  echo "   mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark \"$vobfile\" > $dumplog 2>&1" >> "$logfile"
  mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark "$vobfile" > $dumplog 2>&1
  [[ -e "md5sums" ]] && rm -f "md5sums"
  CROP=`cat $dumplog | grep CROP | tail -1`
  echo "   Found crop value of $CROP" >> "$logfile"
  CROP=${CROP#* crop=}
  CROP=${CROP%%\).*}
  typeset -i CROPCHECK
  CROPCHECK=`echo "$CROP" | awk -F ':' '{ print $1 }'`
  echo "   Final crop value of $CROP with cropcheck value of $CROPCHECK" >> "$logfile"
  if [ -z "$CROP" ]; then
    echo "-W- Unable to extract CROP value from iso: $isofile" | tee -a "$logfile"
    return
  fi
  if [ $CROPCHECK -lt 0 ]; then 
    CROP=""
  else 
    CROP=",crop=$CROP"
  fi
  echo "   Setting mencoder crop filter to: $CROP"
}

function get_audio_track_from_mkv { 
  mkv="$1"
  handbrake_cli="$2"
  aidcheck=`tempfile`
  alang=$default_alang

  # Find out what audio track matches our alang
  $handbrake_cli --stop-at duration:1 -i "$mkv" -o /dev/null -v 100 > $aidcheck 2>&1
  stream=`grep "$alang" $aidcheck | grep "Audio:"`

  # extract the track number that handbrake uses
  track=`echo "$stream" | awk '{ print $2; }' | awk -F '.' '{ print $2; }' | awk -F '(' '{ print $1; }'`
  
  if [ -n "$track" ]; then   
      echo "   Setting the audio track to $track." | tee -a "$logfile"
  fi
}

function get_subtitle_track_from_mkv { 
  mkv="$1"
  handbrake_cli="$2"
  aidcheck=`tempfile`
  alang=$default_alang

  # Find out what audio track matches our alang
  $handbrake_cli --stop-at duration:1 -i "$mkv" -o /dev/null -v 100 > $aidcheck 2>&1
  stream=`grep "$alang" $aidcheck | grep "Subtitle:" | head -n 1`

  # extract the track number that handbrake uses
  track=`echo "$stream" | awk '{ print $2; }' | awk -F '.' '{ print $2; }' | awk -F '(' '{ print $1; }'`

  # add 1 to the track number since mkv tools start at 1, and HandBrake starts at 0
  ((track = track + 1))

  if [ -n "$track" ]; then   
      echo "   Setting the subtitle track to $track." | tee -a "$logfile"
  fi
}

function get_audio_track_from_vob {
  # Adjust our audio ID to find the english audio stream
  # This should be 128. However, if 128 is not there, pick the next one that incrementally is.
  vob="$1"
  handbrake_cli="$2"
  aidcheck=`tempfile`
  aid=$default_aid
  alang=$default_alang
  if [ $aid_override -lt 0 ]; then 
    mplayer -v -endpos 0 "$vob" > $aidcheck 2>&1
    grep -q "Found audio stream: $aid" $aidcheck
    while [ $? == 1 ] && [ $aid -lt 159 ]; do
      (( aid = aid + 1 ))
      grep -q "Found audio stream: $aid" $aidcheck
    done
    [[ -e "$aidcheck" ]] && rm -f "$aidcheck"
  else 
    aid=$aid_override
  fi
  # Now that we've found the right audio id, find the corresponding audio track in HandBrake

  # convert the aid we found into hex
  aid_hex=`echo "obase=16; $aid" | bc`
  
  # extract the audio streams in the vob
  #ffmpeg -i "$vob" > $aidcheck 2>&1
  $handbrake_cli --stop-at duration:1 -i "$vob" -o /dev/null -v 100 > $aidcheck 2>&1
  
  # find the stream that matches our aid
  #stream=`grep "Stream.*\[0x$aid_hex\]" $aidcheck`
  #stream=`grep "scan: audio" $aidcheck | grep -n "" | grep "scan: audio 0x$aid_hex"`
  stream=`grep "add_audio_to_title:" $aidcheck | grep -n "" | grep "add_audio_to_title:.* stream 0x$aid_hex"`
 
  # extract the track number that handbrake uses
  #track=`expr match "$stream" '.*#[0-9]\.\([0-9]*\)'`
  track=`expr match "$stream" '^\([0-9]*\):'`

  if [ -n "$track" ]; then   
    echo "   Setting the audio ID to $aid. Setting the audio track to $track." | tee -a "$logfile"
  fi
}

function get_audio_id_from_vob {
  # Adjust our audio ID to find the english audio stream
  # This should be 128. However, if 128 is not there, pick the next one that incrementally is.
  vob="$1"
  aidcheck=`tempfile`
  aid=$default_aid
  alang=$default_alang
  if [ $aid_override -lt 0 ]; then 
    mplayer -v -endpos 0 "$vob" > $aidcheck 2>&1
    grep -q "Found audio stream: $aid" $aidcheck
    while [ $? == 1 ] && [ $aid -lt 159 ]; do
      (( aid = aid + 1 ))
      grep -q "Found audio stream: $aid" $aidcheck
    done
    [[ -e "$aidcheck" ]] && rm -f "$aidcheck"
  else 
    aid=$aid_override
  fi
  echo "-> Setting the audio stream ID to $aid" | tee -a "$logfile"
  # mencoder default DVD audio track language selection (english)
  lang_opts="-aid $aid -alang $alang"
}

function check_vob_for_corrupted_start {
  # check to see if the beginning of the DVD has a form of copy protection
  # where they have deliberately broken the first X number of frames of the DVD.
  # If we don't skip these, our resulting VOB file will not play.
  badvobcheck=`tempfile`
  endpos=360
  skip=0
  mencoder -ss $skip -endpos $endpos $lang_opts -of mpeg -mpegopts format=dvd:tsaf -oac copy -ovc copy "$tmpdir/$dvdname.VOB" -o /dev/null > $badvobcheck 2>&1
  if [ $? != 0 ]; then
    fatal_and_exit "-E- Mencoder Failed"
  fi
  grep "Writing header" -A `wc $badvobcheck | awk '{ print $1 }'` $badvobcheck | grep -q "Too many video packets in the buffer"
  while [ $? == 0 ] && [ $skip -lt $endpos ]; do
    (( skip = skip + 5 ))
    echo "-> Bad VOB copy protection detected. Trying new skip value of $skip" | tee -a "$logfile"
    mencoder -ss $skip -endpos $endpos $lang_opts -of mpeg -mpegopts format=dvd:tsaf -oac copy -ovc copy "$tmpdir/$dvdname.VOB" -o /dev/null > $badvobcheck 2>&1
    if [ $? != 0 ]; then
      fatal_and_exit "-E- Mencoder Failed"
    fi
    grep "Writing header" -A `wc $badvobcheck | awk '{ print $1 }'` $badvobcheck | grep -q "Too many video packets in the buffer"
  done
  [[ -e "$badvobcheck" ]] && rm -f "$badvobcheck";

  # cat the giant VOB into mencoder to create a playable VOB file
  cat "$tmpdir/$dvdname.VOB" | mencoder -ss $skip -quiet $lang_opts -of mpeg -mpegopts format=dvd:tsaf -oac copy -ovc copy - -o "$vobfile" >> "$logfile" 2>&1
  if [ $? != 0 ]; then
    fatal_and_exit "-E- Mencoder Failed"
  fi
}

function check_vob_for_completeness {
  # check to make sure we got out a complete VOB.
  # there is another kind of copy protection where the VOB's may
  # have "MPG EOF" frames in the middle of the stream. 
  # this causes mencoder to not process the entire VOB, and exit without any errors.
  # detect this by seeing how much smaller the dst vob is from the src vob.
  MAX_FILESIZE_DELTA_PERCENT=70
  SRC_VOB_FILESIZE=$(stat -c%s "$tmpdir/$dvdname.VOB")
  DST_VOB_FILESIZE=$(stat -c%s "$vobfile")
  FILESIZE_DELTA=`echo "scale=2; $DST_VOB_FILESIZE / $SRC_VOB_FILESIZE * 100" | bc | awk -F '.' '{ print $1 }'`
  if [ $FILESIZE_DELTA -lt $MAX_FILESIZE_DELTA_PERCENT ]; then
    # Try one other way to get the VOB using mplayer directly to rip the feature titleset.
    echo "-> Detected bad VOB size copy protection after processing concatenated VOB file." | tee -a "$logfile"
    create_main_vob_with_mplayer "$isofile"
    [[ -e "$dumplog" ]] && rm -f $dumplog
    DST_VOB_FILESIZE=$(stat -c%s "$vobfile")
    FILESIZE_DELTA=`echo "scale=2; $DST_VOB_FILESIZE / $SRC_VOB_FILESIZE * 100" | bc | awk -F '.' '{ print $1 }'`
    if [ $FILESIZE_DELTA -lt $MAX_FILESIZE_DELTA_PERCENT ]; then
      fatal_and_exit "-E- This DVD has a copy protection scheme we can't work around. Sorry.\n    I recommend using another ripping mode like '-m' or '-i'"
    fi
  fi
}

function check_vob_for_too_many_video_packets {
  # If our earlier algorithm to work around this failed, throw an error.
  # check to see if this DVD has a protection scheme we don't know how to work around
  # when I tried to burn the CARS DVD for example, you can't play the resulting VOB file.
  # for some reason, the video is black, while the audio rolls, then the video finally comes
  # in, but it is WAY off the audio. This appears to be due to some bad frames at the beginning of 
  # the 1st VOB. Until I figure out how to work around this, detect it, and error out.
  # instead of pulling the image from the disk again, you can pull it directly from the iso: -dvd-device $iso_path
  grep -q "Too many video packets in the buffer:" "$logfile"
  if [ $? == 0 ]; then
    # Try one other way to get the VOB using mplayer directly to rip the feature titleset.
    echo "-> Detected corrupt audio stream copy protection after processing concatenated VOB file." | tee -a "$logfile"
    create_main_vob_with_mplayer "$isofile"
    grep -q "Too many video packets in the buffer:" $dumplog
    if [ $? == 0 ]; then
      [[ -e "$dumplog" ]] && rm -f $dumplog
      fatal_and_exit "-E- This DVD has a copy protection scheme we can't work around. Sorry.\n   I recommend using another ripping mode like '-m' or '-i'"
    fi
    [[ -e "$dumplog" ]] && rm -f $dumplog
  fi
}

function check_vob_for_a52_crc_errors {
  # Let's see if we can playback our newly created VOB file without any errors.
  # if there are issues, let's detect them now, and try to recreate the VOB
  # there are some forms of copy protection that have missed above, that evidence
  # themselves when we try to playback the VOB file. This was added to deal with
  # the "a52: CRC check failed" copy protection scheme.
  MAX_ERRORS=10
  ENDPOS=120
  echo "-> Checking for a52 audio stream CRC errors" | tee -a "$logfile"
  mplayer -endpos $ENDPOS -ao null -vo null "$vobfile" > $dumplog 2>&1
  cat $dumplog | grep -v "^A:" >> "$logfile"
  errors=`grep "a52: CRC check failed" $dumplog | wc | awk '{ print $1 }'`
  if [ $errors -gt $MAX_ERRORS ]; then
    echo "-> Detected a52 audio stream CRC errors copy protection after processing concatenated VOB file." | tee -a "$logfile"
    create_main_vob_with_mplayer "$isofile"
    echo "-> Checking for a52 audio stream CRC errors" | tee -a "$logfile"
    mplayer -endpos $ENDPOS -ao null -vo null "$vobfile" > $dumplog 2>&1
    if [ $? != 0 ]; then
      cat $dumplog | grep -v "^A:" >> "$logfile"
      fatal_and_exit "-E- Mplayer Failed"
    fi
    cat $dumplog | grep -v "^A:" >> "$logfile"
    errors=`grep "a52: CRC check failed" $dumplog | wc | awk '{ print $1 }'`
    if [ $errors -gt $MAX_ERRORS ]; then
      fatal_and_exit "-E- This DVD has a copy protection scheme we can't work around. Sorry.\n   I recommend using another ripping mode like '-m' or '-i'"
    fi
  fi
  [[ -e "$dumplog" ]] && rm -f $dumplog
}

function calculate_bitrate_from_target_size {
  # determine what our bitrate needs to be if a target size was specified instead
  if [ $target_size -ne 0 ] && [ $custom_video_bitrate -eq 0 ]; then
    vob_length=`mplayer -identify -v "$vobfile" -endpos 0 2>&1 | grep ID_LENGTH | awk -F '=' '{ print $2 }' | awk -F '.' '{ print $1 }'`
    ((min_length = minimum_feature_title_length * 60))
    if [[ $vob_length -gt $min_length ]]; then 
      ((target_video_bitrate = (target_size * 1024 * 8) / vob_length ))
      custom_video_bitrate=1
      echo "   With a given target size of $target_size MB, the estimated bit rate will need to be $target_video_bitrate kbits/sec" | tee -a "$logfile"
    else
      echo "-W- Unable to determine the real length of this DVD feature title." | tee -a "$logfile"
      echo "    A target bitrate from the target_size requested will not be set." | tee -a "$logfile"
      echo "    If using handbrake, only the target_size will be passed to the encoder." | tee -a "$logfile" 
      echo "    If using mencoder, the target_size will be entirely disregarded." | tee -a "$logfile"
      echo "    You may need to rerun with the -b option with a target bitrate to get the desired size." | tee -a "$logfile"
      if [[ $encoder -ne "handbrake" ]] || [[ "$profile" =~ "xvid" ]]; then
        fatal_and_exit "-E- You'll need rip this DVD with the handbrake encoder and an MP4 type profile to get a good rip."
      fi
    fi
  fi
}

function create_dvdauthor_dvd_xml_file {
  # make a dvdauthor xml menu file to create a valid DVD video from 
  # this script does a good job, but we'll still need to clean it up a bit after it runs
  echo "-> Creating dvdauthor XML menu file" | tee -a "$logfile"
  makexml -overwrite -dvd *.VOB -out dvd >> "$logfile" 2>&1
  if [ $? != 0 ]; then
    fatal_and_exit '-E- makexml -dvd *.VOB -out dvd failed'
  fi

  # replace the first line of the xml file to remove the bad dest path
  awk -v line=1 -v new_content="<dvdauthor>" '{
    if (NR == line) {
      print new_content;
    } else {
      print $0;
    }
  }' dvd.xml > dvd.xml.new
  mv -f dvd.xml.new dvd.xml
  if [ $? != 0 ]; then
    fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
  fi

  # remove the "<video " property line from the xml file
  cat dvd.xml | grep -v "<video" > dvd.xml.new
  mv -f dvd.xml.new dvd.xml
  if [ $? != 0 ]; then
    fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
  fi
  
  # remove the extra <pgc>..</pgc> pairs
  cat dvd.xml | awk 'BEGIN {x=1}
  {
    if ($0~"</pgc>") {x=0}
    if (x==1) {print $0}
    if ($0~"<pgc>") {x=1}
  }' > dvd.xml.new
  echo -e "</pgc>\n</titles>\n</titleset>\n</dvdauthor>" >> dvd.xml.new
  mv -f dvd.xml.new dvd.xml
  if [ $? != 0 ]; then
    fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
  fi

  # remove the VTS_*_0.VOB file as this is just the main menu video clip
  cat dvd.xml | grep -v "VTS_.*_0.VOB" > dvd.xml.new
  mv -f dvd.xml.new dvd.xml
  if [ $? != 0 ]; then
    fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
  fi
}

function check_for_mplayer_dumpstream_incompatibility {

  echo "-> Checking for mplayer dumpstream incompatibilities" | tee -a "$logfile"

  # Check to see if the DVD had any lsdvd incompatibilities
  if [ $lsdvd_incompatibility -eq 1 ]; then
    invalid_feature_title=1
    echo "-E- Unable to determine the feature title due to an lsdvd inability to DeCSS" | tee -a "$logfile"
    echo "    You will need to determine this yourself and rerun the script with the -t option" | tee -a "$logfile"
    echo "    You can google this DVD to find out what it's feature title is, or you can play it in a conventional DVD player to find it." | tee -a "$logfile"    
    return
  fi

  if [ ! -e "$vobfile" ]; then
    # mplayer dumpstream does not work on DVDs that obscure the feature title.
    # A DVD that has 99 titles, where the longest title isn't the main feature
    # breaks mplayer dumpstream. We have to fallback to using dvdbackup to figure
    # out what the feature title is. This script will run through that flow if we
    # set use_mplayer_dumpstream to 0. Check for this here.
    if [ $ripdvd -eq 1 ]; then
      alarm $lsdvd_timeout lsdvd $dev | grep -q "Title: 99"
    else
      alarm $lsdvd_timeout lsdvd "$isofile" | grep -q "Title: 99"
    fi
    # If we have 99 titles and a feature title wasn't given on the command line, switch modes.
    if [ $? == 0 ] && [ $feature_title_override -eq 0 ]; then
      if [ $trust_feature_title_autodetect_when_uncertain -eq 0 ]; then
        echo "-E- Unable to determine the feature title due to the 99 title copy protection scheme" | tee -a "$logfile"
        echo "    You will need to determine this yourself and rerun the script with the -t option" | tee -a "$logfile"
        echo "    You can google this DVD to find out what it's feature title is, or you can play it in a conventional DVD player to find it." | tee -a "$logfile"
        invalid_feature_title=1
      else 
        echo "    Falling back to non mplayer dumpstream methods to copy the DVD" | tee -a "$logfile"
        echo "-W- We still may not be able to autodetect the right feature title" | tee -a "$logfile"
        echo "    You may need to determine this yourself and rerun the script with the -t option" | tee -a "$logfile"
        use_mplayer_dumpstream=0
        invalid_feature_title=1
      fi
      return
    fi
  fi

  # There is another form of protection that causes the mplayer dumpstream to fail. 
  # This can be detected by telling mplayer to parse the VOB file by copying its audio
  # video streams to a dummy output file (/dev/null). Do that here to check for that 
  # problem before continuing.
  if [ -e "$vobfile" ]; then
    mplayer_opts="-quiet -ofps 30000/1001 -ffourcc DIVX -oac copy -ovc copy"
    mencoder $mplayer_opts "$vobfile" -o "/dev/null" > $dumplog 2>&1
    grep -q "Too many audio packets in the buffer" $dumplog
    if [ $? == 0 ]; then
      echo "-> The VOB dumped by mplayer is invalid. Falling back to non mplayer dumpstream to copy the DVD" | tee -a "$logfile"
      use_mplayer_dumpstream=0
      mplayer_dumpstream_incompatibility=1
    fi
    [[ -e "$dumplog" ]] && rm -f $dumplog
  fi

  # There is another form of protection that causes the mplayer dumpstream to fail.
  # The resulting VOB file looks complete, but has something in it that causes mplayer/mencoder 
  # to be unable to encode it since it thinks the entire VOB is only a few minutes long in length.
  # Using HandBrake with an MP4 type profile can work around this, but mencoder or Handbrake with XVID profile won't.
  if [ -e "$vobfile" ]; then
    vob_length=`mplayer -identify -v "$vobfile" -endpos 0 2>&1 | grep ID_LENGTH | awk -F '=' '{ print $2 }' | awk -F '.' '{ print $1 }'`
    ((min_length = minimum_feature_title_length * 60))
    if [[ $vob_length -lt $min_length ]]; then 
      if [[ $encoder -ne "handbrake" ]] || [[ "$profile" =~ "xvid" ]]; then
        echo "-E- The main feature title that was ripped from the DVD has an invalid movie length." | tee -a "$logfile"
        echo "    You'll need rip this DVD with the handbrake encoder and an MP4 or MKV type profile instead." | tee -a "$logfile"
        mplayer_dumpstream_incompatibility=1
	fatal_and_exit "-E- Aborting encoding step due to invalid movie length."
      fi
    fi
  fi
}

function fill_mythvideo_metadata {

  # This function must be passed the filename as an argument
  # The filename must be a full path to the file
  filename="$1"

  # Make sure the fill mythvideo metadata option has been set to 1
  if [ $fill_mythvideo_metadata -eq 0 ]; then
    echo "-> fill_mythvideo_metadata=0 therefore not updating mythvideo metadata for this rip" | tee -a "$logfile"
    return 0
  fi

  # If the fill mythvideo metadata script is present, run it
  # fill_mythvideo_metadata.plThis will download the metadata for the DVD we ripped.
  if [[ -x `which fill_mythvideo_metadata.pl` ]]; then
    echo "-> Running fill_mythvideo_metadata.pl to lookup/add/update the metadata for this DVD: $filename" | tee -a "$logfile"
    fill_mythvideo_metadata.pl -N 0 -F "$filename" >> "$logfile" 2>&1
  else
    echo "-W- Unable to find the fill_mythvideo_metadata.pl script in your PATH. Unable to autofill the mythvideo DB for this rip." | tee -a "$logfile"
    echo "    Set the fill_mythvideo_metadata variable to 0 in the script to avoid running this step." | tee -a "$logfile"
  fi
}

# remove the intermediate VOB file
function remove_intermediate_vob_file {
  if [ $keep_intermediate_files -eq 0 ]; then
    [[ -e "$tmpdir/$dvdname.VOB" ]] && rm -f "$tmpdir/$dvdname.VOB"
  else
    echo "-> Keeping intermediate concatenated VOB file: $tmpdir/$dvdname.VOB" | tee -a "$logfile"
  fi
}

# remove the original DVD image 
function remove_intermediate_iso_file {
  [[ $keep_isofile -eq 1 ]] && return 1
  if [ $keep_intermediate_files -eq 0 ]; then
    [[ -e "$isofile" ]] && rm "$isofile"
  else
    echo "-> Keeping ddrescue intermediate iso file: $isofile" | tee -a "$logfile"
  fi
}

# remove the intermediate dvdbackup folder
function remove_intermediate_dvdbackup_folder {
  if [ $keep_intermediate_files -eq 0 ]; then
    [[ -d "$tmpdir/$dvdname" ]] && rm -rf "$tmpdir/$dvdname"
  else
    echo "-> Keeping intermediate dvdbackup folder: $tmpdir/$dvdname" | tee -a "$logfile"
  fi
}

##############################################################################################
# MAIN
##############################################################################################

# Make a note of when this DVD rip started
date=`date`
echo -e "\n$date DVD rip started" >> "$logfile"
echo "$cmd" >> "$logfile"

# Rip the DVD - Mirror Mode
if [ $mirror_mode -eq 1 ]; then
  echo "-> Ripping DVD $dvdname to $dest"

  if [[ "$ripper" == "makemkv" ]]; then
      # use makemkv to make an MKV file of the disk
      make_dvd_mkv_image "$tmpdir/$dvdname.mkv" "disc" "$makemkv_disc_id"
      # move the ripped movies into place
      typeset -i num=0 
      for i in `/bin/ls -1 "$tmpdir/$dvdname"*.mkv`; do
        if [[ "$i" =~ .[[:digit:]].mkv ]]; then
          finaldest="$dest/$dvdname.$num.mkv"
        else
          finaldest="$dest/$dvdname.mkv"
        fi
        while [[ -e "$finaldest" ]]; do
          ((num = num + 1 ))
          finaldest="$dest/$dvdname.$num.mkv"
        done
        echo "   Moving $i -> $finaldest"
        mv "$i" "$finaldest"
      done
      # add this video data to the mythtv DB
      fill_mythvideo_metadata "$dest_filename"
  else       
      # use ddrescue to make an ISO image of the disk
      make_dvd_iso_image "$tmpdir/$dvdname.iso"
      echo "   Moving $tmpdir/$dvdname.iso -> $dest/$dvdname.iso"
      mv "$tmpdir/$dvdname.iso" "$dest/$dvdname.iso"
      # add this video data to the mythtv DB
      fill_mythvideo_metadata "$dest_filename"
  fi

  # eject the disk upon completion
  if [ $eject_disk -ne 0 ]; then
    eject $eject_opts $dev
  fi

  date=`date`
  echo "$date DVD rip completed" | tee -a "$logfile"

  if [[ -n "$mailto" ]]; then
    cat "$logfile" | mailx -s "dvd rip of $dvdname DONE" "$mailto"
  fi

fi

# Rip the DVD - Main Title Feature Only
if [ $mirror_mode -eq 0 ]; then

  # Rip image from DVD
  if [ $ripdvd -eq 1 ]; then
    echo "-> Ripping DVD $dvdname to $dest" | tee -a "$logfile"
    if [[ "$ripper" == "makemkv" ]]; then
	# use makemkv to make an MKV file of the disk
	make_dvd_mkv_image "$tmpdir/$dvdname.mkv" "disc" "$makemkv_disc_id"
	vobfile="$tmpdir/$dvdname.mkv"
    else 
        # use ddrescue to make an ISO image of the disk
	make_dvd_iso_image "$tmpdir/$dvdname.iso"
	isofile="$tmpdir/$dvdname.iso"
    fi
  fi

  # Rip image from DVD path
  if [ -n "$dvdpath" ]; then
    echo "-> Ripping DVD $dvdpath to $dest" | tee -a "$logfile"
    make_dvd_iso_image_from_folder "$dvdpath" "$tmpdir/$dvdname.iso" 1	 
    isofile="$tmpdir/$dvdname.iso"
  fi
 
  if [ $make_final_dest_vob -eq 1 ] || [ $make_final_dest_comp -eq 1 ]; then

    # Create our "vobfile" using makemkv if told to do so
    if [[ "$isofile" =~ "iso" ]] && [[ "$ripper" == "makemkv" ]]; then
	echo "-> Creating VOB/MKV file from $isofile"
	vobfile="$tmpdir/$dvdname.mkv"
	make_dvd_mkv_image "$vobfile" "iso" "$isofile"
    fi

    # get the feature title from the ISO
    if [[ "$isofile" =~ "iso" ]]; then
	get_feature_title "$isofile"
    fi

    # Create our "vobfile" using mplayer if needed
    if [[ ! -e "$vobfile" ]] && [[ "$isofile" =~ "iso" ]]; then
      echo "-> Creating DVD video $vobfile from $isofile" | tee -a "$logfile"
       
      # get the crop value from the ISO
      get_crop_from_iso

      # check for mplayer dumpstream incompatibilities
      # if they exist, this method will set this mode to 0.
      check_for_mplayer_dumpstream_incompatibility

      if [ $use_mplayer_dumpstream -eq 1 ]; then 

        # get our audio id from the ISO file
        get_audio_id_from_iso "$isofile"

        # create our main VOB file from the ISO
        create_main_vob_with_mplayer "$isofile"
     
        # remove the intermediate VOB file
        remove_intermediate_vob_file

        # it's possible that our VOB is still corrupted in some manner
        # check to make sure it is still a good VOB before continuing.
        check_for_mplayer_dumpstream_incompatibility

      fi
 
      if [ $use_mplayer_dumpstream -eq 0 ]; then 

        # use dvdbackup to make a DVD folder of the feature title
        make_dvdbackup_folder_image
  
        # create our main VOB file
        create_main_vob_with_cat

        # get our audio id from the VOB file
        get_audio_id_from_vob "$tmpdir/$dvdname.VOB"
  
        # check for corrupted VOB start
        check_vob_for_corrupted_start
 
        # check to make sure our VOB is complete
        check_vob_for_completeness

        # check to make sure our VOB doesn't have too many video packets
        check_vob_for_too_many_video_packets

        # check to make sure our VOB doesn't have a52 crc errors
        check_vob_for_a52_crc_errors

        # remove the intermediate VOB file
        remove_intermediate_vob_file

      fi

      # remove the intermediate ISO file
      remove_intermediate_iso_file

    else
      if [[ -e "$vobfile" ]] && [[ "$encoder" != "handbrake" ]]; then 
        echo "-> Skipping VOB creation. VOB DVD video already exists: $vobfile" | tee -a "$logfile"
        # get our audio id from the VOB file
        get_audio_id_from_vob "$vobfile"
        # get the crop value from the VOB
        get_crop_from_vob
      fi
    fi

    # eject the DVD disk since we are finished with it
    [ $eject_disk -eq 2 ] && eject $eject_opts $dev

    # encode the VOB file to a compressed file format
    if [ $make_final_dest_comp -eq 1 ]; then
      echo "-> Encoding the DVD video to a compressed file using $encoder" | tee -a "$logfile"

      # determine what our bitrate needs to be if a target size was specified instead
      calculate_bitrate_from_target_size        
     
      # encode the vob file into a compressed file format
      if [[ "$encoder" == "mencoder" ]]; then 
        encode_vob_file_mencoder
      fi
      if [[ "$encoder" == "handbrake" ]]; then
        encode_vob_file_handbrake
      fi

      if [ $keep_intermediate_files -eq 0 ] && [ $make_final_dest_vob -eq 0 ]; then
        [[ -e "$vobfile" ]] && [[ $keep_vobfile -eq 0 ]] && rm -f "$vobfile";
        [[ -e "$passlogfile" ]] && rm -f "$passlogfile";
      else
        echo "-> Keeping VOB file: $vobfile" | tee -a "$logfile"
        echo "-> Keeping mencoder 2pass logfile: $passlogfile"
      fi
    fi

  # add this video data to the mythtv DB
  [ $make_final_dest_comp -eq 1 ] && fill_mythvideo_metadata "$final_output_file" 
  [ $make_final_dest_vob -eq 1 ] && fill_mythvideo_metadata "$vobfile" 
    
  else

  # use dvdbackup to make a DVD folder of the feature title
  make_dvdbackup_folder_image

  # cd to the feature title DVD folder
  pushd "$tmpdir/$dvdname/VIDEO_TS" > /dev/null 2>&1
  if [ $? != 0 ]; then
    fatal_and_exit "-E- Unable to cd to $tmpdir/$dvdname/VIDEO_TS"
  fi
  
  # create the dvd.xml file for dvdauthor
  create_dvdauthor_dvd_xml_file  

  # make the final DVD folder image
  make_dvdauthor_folder_image

  # add this video data to the mythtv DB
  fill_mythvideo_metadata "$dest/$dvdname/VIDEO_TS" 
 
  # cd back to the dir we started from
  popd > /dev/null 2>&1

  if [ $make_final_dest_iso -eq 1 ]; then

    # make an iso image out of our directory
    make_dvd_iso_image_from_folder "$dest/$dvdname" "$dest/$dvdname.iso" 0
   
    # If the mkisofs was unable to make a .iso file for us, don't remove the DVD directory 
    if [ -s "$dest/$dvdname.iso" ]; then
      if [ $make_final_dest_folder -eq 0 ]; then
        echo "-> Removing DVD folder since ISO was created: $dest/$dvdname" | tee -a "$logfile"
        # remove the folder of the DVD image now that we have a .iso version of it
        [[ -d "$dest/$dvdname" ]] && rm -rf "$dest/$dvdname"
      fi
    else
      # we created an empty iso file, remove it
      echo "-> Removing empty ISO image: $dest/$dvdname.iso" | tee -a "$logfile"
      echo "-> Keeping the DVD folder since the ISO image couldn't be created properly: $dest/$dvdname"
      [[ -e "$dest/$dvdname.iso" ]] && rm "$dest/$dvdname.iso"
    fi
 
    # add this video data to the mythtv DB
    fill_mythvideo_metadata "$dest/$dvdname.iso" 

  fi

  fi

  # remove the ddrescue DVD ISO image
  remove_intermediate_iso_file

  # remove the tmp dvdbackup folder of the DVD image
  remove_intermediate_dvdbackup_folder

  # eject the DVD disk upon completion
  [ $eject_disk -eq 1 ] && eject $eject_opts $dev

  date=`date`
  echo "$date DVD rip completed" | tee -a "$logfile"

  if [[ -n "$mailto" ]]; then
    cat "$logfile" | mailx -s "dvd rip of $dvdname DONE" "$mailto"
  fi

fi

##############################################################################################