3 # Author: Alan J. Pippin (apippin@pippins.net)
8 # Description: This script wraps a number of linux utilities to
9 # create a recipe for ripping protected DVDs, circumventing
10 # ARcoSS and CRC checksum error protection schemes used on many
11 # newer DVDs. Edit as appropriate for your needs. I use this to
12 # backup DVDs I own, and do not condone any other activity it
15 # Known Issues/Limitations:
16 # - Mirror mode is always done in ISO mode
18 # See the README file for information about the dependencies
21 ##############################################################################################
23 ##############################################################################################
34 typeset profile="xvidhq"
38 typeset default_alang="en"
41 typeset -i default_aid=128
42 typeset -i aid_override=-1
43 typeset -i force_onepass_mode=0
44 typeset -i eject_disk=1
45 typeset -i keep_isofile=0
46 typeset -i keep_vobfile=0
47 typeset -i keep_dvdfolder=0
48 typeset -i keep_intermediate_files=0
49 typeset -i make_final_dest_vob=0
50 typeset -i make_final_dest_iso=0
51 typeset -i make_final_dest_folder=0
52 typeset -i make_final_dest_comp=0
54 typeset -i show_usage=0
55 typeset -i mirror_mode=0
56 typeset -i target_bitrate=2000
57 typeset -i target_size=0
58 typeset -i audio_2ch=0
59 typeset -i audio_6ch=1
60 typeset -i invalid_feature_title=0
61 typeset -i feature_title_override=0
62 typeset -i mplayer_dumpstream_incompatibility=0
63 typeset -i custom_bitrate=0
64 typeset -i custom_audio_2ch=0
65 typeset -i custom_audio_6ch=0
67 ##############################################################################
68 # Local Machine Settings:
69 # Sources both the "default" conf file tracked by GIT (rip_dvd.conf.dist)
70 # and the local conf file created by each local machine (rip_dvd.conf)
71 # Copy the rip_dvd.conf.dist file to rip_dvd.conf and edit the later.
72 # This will allow you to override all the default values to meet your needs
73 # in a way that won't get clobbered when you pull updates from my GIT repo.
74 ##############################################################################
75 config="${0%/*}/rip_dvd.conf"
77 # The config file will be searched for in the following location order:
80 # 1) /path/to/rip_dvd/script/rip_dvd.conf.dist
81 [ -e "${config}.dist" ] && found_config=1 && . "${config}.dist"
83 # 2) /path/to/rip_dvd/script/rip_dvd.conf
84 [ -e "${config}" ] && found_config=1 && . "${config}"
86 # 3) /etc/rip_dvd.conf
87 [ -e "/etc/rip_dvd.conf" ] && found_config=1 && . "/etc/rip_dvd.conf"
89 # 4) $PWD/rip_dvd.conf
90 [ -e "$PWD/rip_dvd.conf" ] && found_config=1 && . "$PWD/rip_dvd.conf"
92 # Check to make sure we found the config file
93 if [ $found_config -eq 0 ]; then
94 echo "-E- Unable to find the rip_dvd.conf file: $config"
98 ##############################################################################################
99 # Command line processing
100 ##############################################################################################
101 while (($#)) && getopts 162wmvifkzx:ht:n:d:b:s:t:a:p:e:j:l:r: opt "$@"
104 (n) dvdname=$OPTARG;;
106 (b) target_bitrate=$OPTARG; custom_bitrate=1;;
107 (s) target_size=$OPTARG;;
108 (2) audio_2ch=1; custom_audio_2ch=1;;
109 (6) audio_6ch=1; custom_audio_6ch=1;;
110 (1) force_onepass_mode=1;;
111 (v) make_final_dest_vob=1;;
112 (i) make_final_dest_iso=1;;
113 (f) make_final_dest_folder=1;;
114 (z) make_final_dest_comp=1;;
115 (e) encoder=$OPTARG;;
117 (k) keep_intermediate_files=1;;
118 (t) feature_title_override=$OPTARG;;
120 (p) profile=$OPTARG;;
121 (x) extension=$OPTARG;;
122 (j) eject_disk=$OPTARG;;
123 (l) aid_override=$OPTARG;;
127 (:) echo >&2 "$0: $OPTARG requires a value"; errors=errors+1;;
128 (\?) echo >&2 "$0: invalid option '$OPTARG'"; errors=errors+1;;
135 echo >&2 "Usage: ${0##*/} -d <destdir> [ <options> ]"
136 echo >&2 "Revision $REV"
138 echo >&2 " -d <destdir> Specify the destination directory to store the ripped DVD to"
139 echo >&2 " -n <dvdname> Specify a path to a DVD folder or file to process:"
140 echo >&2 " 1) If this option is not specified, the DVD will be ripped from $dev"
141 echo >&2 " 2) If dvdname is a full path to a DVD folder, it will be ripped as a DVD instead of $dev"
142 echo >&2 " 3) If dvdname is a full path to an MPG2 file, it will be ripped as a DVD instead of $dev"
143 echo >&2 " 4) If dvdname is a full path to an ISO file, it will be ripped as a DVD instead of $dev"
144 echo >&2 " 5) If dvdname is a full path to a VOB file, it will be ripped as a DVD instead of $dev"
145 echo >&2 " -p <profile> Specify which encoding profile to use in -w mode as shown below:"
146 echo >&2 " Mencoder and Handbrake Encoder Profiles:"
147 echo >&2 " - xvidvhq = AVI, very high quality encoding, Xvid codec, 2 pass encoding"
148 echo >&2 " - xvidhq = AVI, high quality encoding, Xvid codec, 2 pass encoding (default)"
149 echo >&2 " - xvid = AVI, fast encoding, Xvid codec, 2 pass encoding"
150 echo >&2 " - iphone = MP4, x264 codec, 2 pass encoding, forced 480:320 scaling"
151 echo >&2 " - ipod = MP4, x264 codec, 2 pass encoding, forced 320:240 scaling"
152 echo >&2 " Handbrake Only Encoder Profiles:"
153 echo >&2 " - mp4vhq = MP4, very high quality encoding, x264 codec, 2 pass encoding"
154 echo >&2 " - mp4hq = MP4, high quality encoding, x264 codec, 2 pass encoding"
155 echo >&2 " - mp4 = MP4, fast encoding, x264 codec, 2 pass encoding"
156 echo >&2 " - hb_<profile> = Any predefined HandBrake profile (run HandBrakeCLI -z and replace spaces with underscores) "
157 echo >&2 " -x <ext> Specify a suffix extension to apply to the end of the final image filename (like .xvid, .ipod, etc)"
158 echo >&2 " If you run multiple instances of this script ripping the same DVD, you need to specify this option."
159 echo >&2 " -m Make a mirror image of the DVD and save it as a DVD ISO file"
160 echo >&2 " The default operation is non-mirror mode where only the main"
161 echo >&2 " feature title will be ripped."
162 echo >&2 " -v Make the final image a DVD VOB file"
163 echo >&2 " -i Make the final image a DVD ISO file"
164 echo >&2 " -f Make the final image a DVD folder"
165 echo >&2 " -z Make the final image a compressed file based on your profile selection and encoder"
166 echo >&2 " -e <encoder> Specify the encoder to use to make the compressed file (valid encoders=mencoder|handbrake) (default=handbrake if found)"
167 echo >&2 " You must also specify the target size or bitrate using the '-s' or '-b' options with xvid profiles"
168 echo >&2 " -s <size> Set the target size of the compressed file in MB (ex: 700, 1000, etc)"
169 echo >&2 " -b <bitrate> Set the bitrate desired in the compressed file in kbits/sec (ex: 1500, 2000 (default), etc)"
170 echo >&2 " -a <W:H> Specify the width x height aspect ratio to scale the DVD to (only used in -z mode)"
171 echo >&2 " <W> If only the width is given, it will autoset the height to a value which preserves the aspect ratio"
172 echo >&2 " The default behavior is autoaspect mode, which preserves the original aspect, with no scaling being done"
173 echo >&2 " -j <n> Eject the disk:"
174 echo >&2 " - 0 = do not eject the disk"
175 echo >&2 " - 1 = eject after the entire script is done (default)"
176 echo >&2 " - 2 = eject after the disk is no longer needed (prior to starting the encode process)"
177 echo >&2 " The last option will allow you to start ripping another disk while the encoding process is running on a previous"
178 echo >&2 " -1 Force 1-pass encoding mode across all profiles"
179 echo >&2 " -2 Use 2 channel MP3 audio encoding when making a compressed file (default is 6 channel AC3)"
180 echo >&2 " -6 Use 6 channel AC3 audio encoding when making a compressed file (default)"
181 echo >&2 " -r <x.x> Apply extra dynamic range compression to the audio, making soft sounds louder. "
182 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)"
183 echo >&2 " -k Keep the intermediate files (good for debugging)"
184 echo >&2 " In -z mode, run with this option to keep the original .VOB file"
185 echo >&2 " By default, all intermediary files are deleted. Only the final image is kept"
186 echo >&2 " -l <aid> Specify the audio AID language ID to rip from the source DVD"
187 echo >&2 " -t <title> Specify the main feature title to pull from the DVD (only required if this script can't figure it out)"
188 echo >&2 " -w Set the sh Execute/Verbose flag (causes every command to be echoed)"
193 if (($errors)) || (($show_usage))
198 # Sanity Check - Command Line Options
199 if [ "$dest" == "" ]; then
200 echo "-E- You must specify a destination directory with '-d'" | tee -a $logfile
204 if [ $make_final_dest_vob -eq 0 ] && [ $make_final_dest_iso -eq 0 ] &&
205 [ $make_final_dest_folder -eq 0 ] && [ $make_final_dest_comp -eq 0 ] && [ $mirror_mode -eq 0 ]; then
206 # Make our default dest type a compressed movie if the user didn't ask for anything else to be done
207 make_final_dest_comp=1
210 if ([ $target_size -ne 0 ] || [ "$aspect" != "" ]) && [ $make_final_dest_comp -ne 1 ]; then
211 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
215 if [ $target_bitrate -eq 0 ] && [ $target_size -eq 0 ] && [ $make_final_dest_comp -eq 1 ]; then
216 echo "-E- You must specify a bitrate in compressed file mode. You must specify '-b' or '-s' when using '-z'" | tee -a $logfile
220 if [ $mirror_mode -eq 1 ]; then
221 if [ $make_final_dest_vob -eq 1 ] || [ $make_final_dest_iso -eq 1 ] ||
222 [ $make_final_dest_folder -eq 1 ] || [ $make_final_dest_comp -eq 1 ]; then
223 echo "-E- You can't specify '-v' or '-i' or '-f' or '-z' when operating in mirror mode with '-m'" | tee -a $logfile
228 # Make handbrake the default encoder if not specified and we can find it
229 if [ -z "$encoder" ]; then
230 encoder="mencoder"; # If we can't find handbrake, set mencoder as the default
231 [[ -x `which $handbrake_xvid` ]] && [[ "$profile" =~ "xvid" ]] && encoder="handbrake";
232 [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "mp4" ]] && encoder="handbrake";
233 [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "ip" ]] && encoder="handbrake";
234 [[ -x `which $handbrake_mp4` ]] && [[ "$profile" =~ "hb" ]] && encoder="handbrake";
237 # Sanity check the profile selection
238 if [[ "$encoder" == "mencoder" ]]; then
239 [[ "$profile" =~ "mp4" ]] && echo "-E- invalid encoder $encoder selected for mp4 profile: $profile" && exit
242 if [[ "$encoder" != "mencoder" ]] && [[ "$encoder" != "handbrake" ]]; then
243 echo "-E- Invalid encoder specified: $encoder"
247 # If the aspect ratio option was specified, set the scale variable appropriately for mencoder
248 if [ "$aspect" != "" ]; then
249 echo "$aspect" | grep -q "x"
251 echo "-E- You must specify the aspect option with a value whose format is W:H"
254 echo "$aspect" | grep -q ":"
256 [ "$encoder" == "mencoder" ] && SCALE=",scale -zoom -sws 9 -xy $aspect"
257 [ "$encoder" == "handbrake" ] && SCALE="-w $aspect"
259 [ "$encoder" == "mencoder" ] && SCALE=",scale=$aspect"
260 if [ "$encoder" == "handbrake" ]; then
261 WIDTH=`echo "$aspect" | awk -F ':' '{ print $1; }'`
262 HEIGHT=`echo "$aspect" | awk -F ':' '{ print $2; }'`
263 SCALE="-w $WIDTH -l $HEIGHT"
268 # Sanity Check - Key executables
269 [[ ! -x `which lsdvd` ]] && echo "-E- missing dependency: lsdvd" && exit
270 [[ ! -x `which volname` ]] && echo "-E- missing dependency: volname" && exit
271 [[ ! -x `which ddrescue` ]] && echo "-E- missing dependency: ddrescue" && exit
272 [[ ! -x `which dvdbackup` ]] && echo "-E- missing dependency: dvdbackup" && exit
273 [[ ! -x `which mencoder` ]] && echo "-E- missing dependency: mencoder" && exit
274 [[ ! -x `which makexml` ]] && echo "-E- missing dependency: makexml" && exit
275 [[ ! -x `which dvdauthor` ]] && echo "-E- missing dependency: dvdauthor" && exit
276 [[ ! -x `which mkisofs` ]] && echo "-E- missing dependency: mkisofs" && exit
277 [[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "xvid" ]] && [[ ! -x `which $handbrake_xvid` ]] && echo "-E- missing encoder: $handbrake_xvid" && exit
278 [[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "mp4" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing encoder: $handbrake_mp4" && exit
279 [[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "ip" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing encoder: $handbrake_mp4" && exit
280 [[ "$encoder" == "handbrake" ]] && [[ "$profile" =~ "hb" ]] && [[ ! -x `which $handbrake_mp4` ]] && echo "-E- missing encoder: $handbrake_mp4" && exit
281 [[ "$encoder" == "handbrake" ]] && [[ ! -x `which ffmpeg` ]] && echo "-E- missing dependency: ffmpeg" && exit
283 ##############################################################################################
286 if [ -z "$dvdname" ]; then
288 # make sure the DVD device is accessible
289 volname $dev > /dev/null 2>&1
291 echo "-E- Can't access the DVD device $dev"
294 # now capture the volume name from the device
295 dvdname=`volname $dev | awk '{ print $1 }'`
300 # check to see if dvdname is a full path to a real directory
301 # if it is, set dvdname and dvdpath appropriately
302 if [ -d "$dvdname" ]; then
304 dvdname=`basename "$dvdname"`
306 if [ -z "$dvdname" ]; then
307 echo "-E- Unable to extract dvdname from path: $dvdpath"
310 if [ ! -d "$dvdpath/VIDEO_TS" ]; then
311 echo "-E- You must supply a full path to a valid DVD folder with this option"
316 # Check to see if dvdname is a full path to a file
317 if [ -f "$dvdname" ]; then
320 # check to see if dvdname is a full path to an MPG2 (VOB) file
321 # if it is, set dvdname and vobfile appropriately
322 file "$dvdname" | grep -q "MPEG"
324 # It is a valid MPEG2 file, now strip the extension off our dvdname
326 dvdname=`basename "$dvdname"`
327 dvdname=${dvdname%.[^.]*}
332 # check to see if dvdname is a full path to an ISO file
333 # if it is, set dvdname and isofile appropriately
334 file "$dvdname" | grep -q -e "ISO" -e "UDF"
336 # It is a valid ISO file, now strip the extension off our dvdname
338 dvdname=`basename "$dvdname"`
339 dvdname=${dvdname%.[^.]*}
344 # check to see if dvdname is a full path to an ISO file
345 # if it is, set dvdname and isofile appropriately
346 file "$dvdname" | grep -q -e "VOB"
348 # It is a valid VOB file, now strip the extension off our dvdname
350 dvdname=`basename "$dvdname"`
351 dvdname=${dvdname%.[^.]*}
356 # If we didn't find a handler for the file above, complain
357 if [ $valid_file -eq 0 ]; then
358 echo "-E- Unsupported file type: $vobfile"
362 # Throw an error if we can't find what the -n option is pointing to
364 echo "-E- Unable to find the directory or file specified by the '-n $dvdname' option. Please make sure the path is valid."
368 # Set the ripdvd flag to false since we aren't ripping a DVD disk
371 # Since we aren't ripping a DVD disk, don't eject anything either
376 # remove bad characters from the dvdname
377 dvdname=${dvdname%.} # remove trailing '.' character
379 # add the suffix extension to the end of the dvdname
380 dvdname=$dvdname$extension
382 # make a "safe" dvdname (remove special characters)
383 safedvdname=`basename "$dvdname" | sed 's/[ !&*\\$?]/_/g'`
385 # Make sure we have a non-empty dvdname
386 if [ -z "$dvdname" ]; then
387 echo "-E- unable to determine dvdname"
391 # make sure our vobfile value is set
392 if [ -z "$vobfile" ]; then
393 vobfile="$dest/$dvdname.VOB"
396 # set up some variables to hold various logfiles
397 logfile="$logdir/$dvdname.log"
398 passlogfile="$tmpdir/$safedvdname.log"
399 ddrescuelog=`tempfile`
400 dvdauthorlog=`tempfile`
404 # create the tmpdir if it doesn't already exist
405 if [ ! -d "$tmpdir" ]; then
408 echo "-E- Unable to create the tmpdir: $tmpdir"
413 # create the logdir if it doesn't already exist
414 if [ ! -d "$logdir" ]; then
417 echo "-E- Unable to create the logdir: $logdir"
422 ##############################################################################################
424 ##############################################################################################
426 if [ $keep_intermediate_files -eq 0 ]; then
427 [[ -e "$dvdauthorlog" ]] && rm -f "$dvdauthorlog"
428 [[ -e "$ddrescuelog" ]] && rm -f "$ddrescuelog"
429 [[ -e "$encodelog" ]] && rm -f "$encodelog"
430 [[ -e "$dumplog" ]] && rm -f "$dumplog"
432 [[ -e "$dvdauthorlog" ]] && echo "-> Keeping dvdauthor log: $dvdauthorlog" | tee -a "$logfile"
433 [[ -e "$ddrescuelog" ]] && echo "-> Keeping ddrescue log: $ddrescuelog" | tee -a "$logfile"
434 [[ -e "$encodelog" ]] && echo "-> Keeping encode log: $encodelog" | tee -a "$logfile"
435 [[ -e "$dumplog" ]] && echo "-> Keeping dump log: $dumplog" | tee -a "$logfile"
441 if [[ -z "$1" ]]; then
442 msg="-E- control-c killed us"
446 echo -e 2>&1 "$msg" | tee -a "$logfile"
447 if [[ -n "$mailto" ]]; then
448 echo -e "$msg" | mailx -s "dvd rip of $dvdname FAILED" "$mailto"
450 keep_intermediate_files=1
454 # Call our cleanup functions on INT and EXIT signals
455 trap fatal_and_exit INT
458 ##############################################################################################
459 # processing functions
460 ##############################################################################################
462 # encode the vob file into a compressed file format using handbrake
463 function encode_vob_file_handbrake {
465 # declare some globals
466 typeset handbrake_cli=""
467 typeset handbrake_video_encoder_opts=""
469 typeset handbrake_audio_opts=""
470 typeset hb_profile=""
473 # Set a variable that we will use later to determine if we found a handler for $profile or not
474 typeset -i found_profile=0
476 # For a given profile, to override the 2 pass behavior to be single pass,
477 # simply set the PASSES variable below to "2" instead of "1 2" inside your profile handler.
478 # It indicates which PASS numbers to loop over. PASSES="2" means just do pass 2 => single pass mode.
484 if [ $target_size -ne 0 ]; then
485 SIZE="-S $target_size"
488 # Check the global force_onepass_mode. If it is set, change our variables appropriately
489 # to force 1-pass encoding across all profiles.
490 if [ $force_onepass_mode -eq 1 ]; then
494 # get our audio track from the VOB file (requires mp4 version of handbrake to extract)
495 get_audio_track_from_vob "$vobfile" "$handbrake_mp4"
498 if [[ "$profile" =~ "xvid" ]]; then
500 handbrake_cli="$handbrake_xvid"
501 final_output_file="$dest/$dvdname.avi"
504 # Very High Quality (16fps)
505 if [ "$profile" == "xvidvhq" ]; then
506 handbrake_opts[0]="-f avi"
507 handbrake_opts[1]="-b $target_bitrate"
508 handbrake_opts[2]="-e xvid"
509 handbrake_opts[3]="-T"
510 handbrake_opts[4]="-5"
511 handbrake_opts[5]="-8"
513 # High Quality (20fps)
514 if [ "$profile" == "xvidhq" ]; then
515 handbrake_opts[0]="-f avi"
516 handbrake_opts[1]="-b $target_bitrate"
517 handbrake_opts[2]="-e ffmpeg"
518 handbrake_opts[3]="-T"
519 handbrake_opts[4]="-5"
522 if [ "$profile" == "xvid" ]; then
523 handbrake_opts[0]="-f avi"
524 handbrake_opts[1]="-b $target_bitrate"
525 handbrake_opts[2]="-e ffmpeg"
526 handbrake_opts[3]="-T"
531 if [[ "$profile" =~ "mp4" ]]; then
533 handbrake_cli="$handbrake_mp4"
534 final_output_file="$dest/$dvdname.mp4"
537 # Handle custom parameter overrides
538 if [ $custom_bitrate == 1 ]; then
539 handbrake_opts[0]="-b $target_bitrate"
541 if [ $custom_audio_2ch == 0 ]; then
544 if [ $custom_audio_6ch == 0 ]; then
549 if [ "$profile" == "mp4vhq" ]; then
550 profile="hb_High_Profile"
553 if [ "$profile" == "mp4hq" ]; then
557 if [ "$profile" == "mp4" ]; then
562 # iphone and ipod MP4 profiles
563 if [ "$profile" == "iphone" ] || [ "$profile" == "ipod" ]; then
565 handbrake_cli="$handbrake_mp4"
566 final_output_file="$dest/$dvdname.mp4"
569 # Handle custom parameter overrides
570 if [ $custom_bitrate == 1 ]; then
571 handbrake_opts[0]="-b $target_bitrate"
573 if [ $custom_audio_2ch == 0 ]; then
576 if [ $custom_audio_6ch == 0 ]; then
581 if [ "$profile" == "iphone" ]; then
582 profile="hb_iPhone_&_iPod_Touch"
585 if [ "$profile" == "ipod" ]; then
591 # Predefined Handbrake Profile Handling
592 if [[ "$profile" =~ "hb" ]]; then
594 handbrake_cli="$handbrake_mp4"
595 final_output_file="$dest/$dvdname.mp4"
598 # Handle custom parameter overrides
599 if [ $custom_bitrate == 1 ]; then
600 handbrake_opts[0]="-b $target_bitrate"
602 if [ $custom_audio_2ch == 0 ]; then
605 if [ $custom_audio_6ch == 0 ]; then
609 # extract the HandBrake Profile name from $profile
610 hb_profile=`echo "$profile" | sed 's/hb_//g' | sed 's/_/ /g'`
613 # Make sure we found a handler for the given profile
614 if [ $found_profile -eq 0 ]; then
615 fatal_and_exit "-E- Unable to find a profile handler for profile: $profile"
618 # setup our audio option
619 if [ $audio_2ch -eq 1 ] && [ $audio_6ch -eq 1 ]; then
620 handbrake_audio_opts="-E faac,ac3 -6 dpl2,auto"
622 if [ $audio_6ch -eq 1 ] && [ $audio_2ch -eq 0 ]; then
623 handbrake_audio_opts="-E ac3 -6 auto"
625 if [ $audio_2ch -eq 1 ] && [ $audio_6ch -eq 0 ]; then
626 handbrake_audio_opts="-E faac -6 dpl2"
628 if [ -n "$track" ]; then
629 handbrake_audio_opts="$handbrake_audio_opts -a $track"
632 # Convert our array of opts into a string
633 for OPTS in "${video_encoder_opts[@]}"; do
634 handbrake_video_encoder_opts="$handbrake_video_encoder_opts:$OPTS"
636 if [ -n "$handbrake_video_encoder_opts" ]; then
637 handbrake_video_encoder_opts="-x $handbrake_video_encoder_opts"
639 for OPTS in "${handbrake_opts[@]}"; do
640 handbrake_cmd_line_opts="$handbrake_cmd_line_opts $OPTS"
643 # Append "global" command line options
644 handbrake_cmd_line_opts="$handbrake_cmd_line_opts -v 1"
645 handbrake_cmd_line_opts="$handbrake_cmd_line_opts $PASSES"
646 handbrake_cmd_line_opts="$handbrake_cmd_line_opts $DRC"
647 handbrake_cmd_line_opts="$handbrake_cmd_line_opts $SCALE"
648 handbrake_cmd_line_opts="$handbrake_cmd_line_opts $SIZE"
650 # Execute the handbrake command to encode the video
651 if [ -n "$hb_profile" ]; then
652 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"
653 $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
656 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"
657 $handbrake_cli -i "$vobfile" -o "$final_output_file" $handbrake_cmd_line_opts $handbrake_audio_opts $handbrake_video_encoder_opts >> $encodelog 2>&1
660 if [ $handbrake_retval != 0 ]; then
661 fatal_and_exit "-E- Unhandled handbrake error"
664 # Concatenate the encode log to our main log file, greping out unwanted lines
665 cat $encodelog | grep -v "Encoding:" | grep -v "hb_demux_ps" >> "$logfile"
666 cat $encodelog | grep "Encoding:" | sed 's/
\r/\n/g' | grep "Encoding:" | grep "ETA" | head -1 >> "$logfile"
667 cat $encodelog | grep "Encoding:" | sed 's/
\r/\n/g' | grep "Encoding:" | grep "ETA" | tail -1 >> "$logfile"
670 # encode the vob file into a compressed file format using mencoder
671 function encode_vob_file_mencoder {
673 # Set a variable that we will use later to determine if we found a handler for $profile or not
674 typeset -i found_profile=0
676 # For a given profile, to override the 2 pass behavior to be single pass,
677 # simply set the PASSES variable below to "2" instead of "1 2" inside your profile handler.
678 # It indicates which PASS numbers to loop over. PASSES="2" means just do pass 2 => single pass mode.
681 # Declare our default 2 pass variables
682 passlogfile_opt="-passlogfile $passlogfile"
683 pass_opt="pass=%PASS"
685 # Check the global force_onepass_mode. If it is set, change our variables appropriately
686 # to force 1-pass encoding across all profiles.
687 if [ $force_onepass_mode -eq 1 ]; then
694 if [[ "$profile" =~ "xvid" ]]; then
696 final_output_file="$dest/$dvdname.avi"
697 mencoder_general_opts="$lang_opts $passlogfile_opt"
698 mencoder_output_opts="-ofps 30000/1001 -ffourcc DIVX"
699 mencoder_video_filter_opts="-vf pullup,softskip,hqdn3d=2:1:2$CROP$SCALE"
700 mencoder_video_encoder_opts="-ovc xvid -xvidencopts $pass_opt"
702 # Very High Quality (16fps)
703 if [ "$profile" == "xvidvhq" ]; then
704 video_encoder_opts[0]="bitrate=$target_bitrate"
705 video_encoder_opts[1]="threads=$mencoder_threads"
706 video_encoder_opts[2]="chroma_opt"
707 video_encoder_opts[3]="vhq=4"
708 video_encoder_opts[4]="bvhq=1"
709 video_encoder_opts[5]="quant_type=mpeg"
710 video_encoder_opts[6]="autoaspect"
712 # High Quality (20fps)
713 if [ "$profile" == "xvidhq" ]; then
714 video_encoder_opts[0]="bitrate=$target_bitrate"
715 video_encoder_opts[1]="threads=$mencoder_threads"
716 video_encoder_opts[2]="chroma_opt"
717 video_encoder_opts[3]="vhq=2"
718 video_encoder_opts[4]="bvhq=1"
719 video_encoder_opts[5]="quant_type=mpeg"
720 video_encoder_opts[6]="autoaspect"
723 if [ "$profile" == "xvid" ]; then
724 video_encoder_opts[0]="bitrate=$target_bitrate"
725 video_encoder_opts[1]="threads=$mencoder_threads"
726 video_encoder_opts[2]="vhq=0"
727 video_encoder_opts[3]="turbo"
728 video_encoder_opts[4]="autoaspect"
731 for OPTS in "${video_encoder_opts[@]}"; do
732 mencoder_video_encoder_opts="$mencoder_video_encoder_opts:$OPTS"
735 if [ $audio_2ch -eq 0 ]; then
736 # These options produce good 6 channel audio for linux and windows
737 mencoder_audio_opts="-oac copy"
738 # There are 3 different ways to specify 6 channel encoding. We'll try the other ones in order if one of them fails.
739 mencoder_audioch_opts[0]="-channels 6 -af channels=6"
740 mencoder_audioch_opts[1]="-af channels=6"
741 mencoder_audioch_opts[2]=""
743 # These options produce good 2 channel audio for linux and windows (including the internal mythvideo player)
744 mencoder_audio_opts="-oac mp3lame -lameopts cbr:br=$audio_bitrate"
745 mencoder_audioch_opts[0]=""
750 # iphone and ipod MP4 profiles
751 if [ "$profile" == "iphone" ] || [ "$profile" == "ipod" ]; then
753 if [ "$profile" == "iphone" ]; then
755 # scale width to 480, set height appropriately, but keep a multiple of 16
756 #SCALE=",scale=480:-10"
757 # scale the video down however far is necessary to fit in 480x320
758 SCALE=",dsize=480:320:0,scale=-8:-8"
761 # scale width to 320, set height appropriately, but keep a multiple of 16
762 #SCALE=",scale=320:-10"
763 # scale the video down however far is necessary to fit in 320x240
764 SCALE=",dsize=320:240:0,scale=-8:-8"
766 final_output_file="$dest/$dvdname.mp4"
767 mencoder_general_opts="$lang_opts $passlogfile_opt"
768 mencoder_output_opts="-ofps 30000/1001 -sws 9 -of lavf -lavfopts format=mp4"
769 mencoder_video_filter_opts="-vf harddup$CROP$SCALE";
770 mencoder_video_encoder_opts="-ovc x264 -x264encopts $pass_opt"
771 video_encoder_opts[0]="bitrate=$target_bitrate"
772 video_encoder_opts[1]="threads=$mencoder_threads"
773 video_encoder_opts[2]="vbv_maxrate=1500"
774 video_encoder_opts[3]="vbv_bufsize=2000"
775 video_encoder_opts[4]="nocabac"
776 video_encoder_opts[5]="me=umh"
777 video_encoder_opts[6]="subq=6"
778 video_encoder_opts[7]="frameref=6"
779 video_encoder_opts[8]="trellis=1"
780 video_encoder_opts[9]="level_idc=30"
781 video_encoder_opts[10]="global_header"
782 video_encoder_opts[11]="bframes=0"
783 video_encoder_opts[12]="partitions=all"
784 for OPTS in "${video_encoder_opts[@]}"; do
785 mencoder_video_encoder_opts="$mencoder_video_encoder_opts:$OPTS"
788 mencoder_audio_opts="-oac faac -faacopts mpeg=4:object=2:br=$audio_bitrate:raw"
789 mencoder_audioch_opts[0]="-channels 2 -srate 48000"
792 if [ $found_profile -eq 0 ]; then
793 fatal_and_exit "-E- Unable to find a profile handler for profile: $profile"
796 # Do not edit this line. $mencoder_video_encoder_opts must be last
797 mencoder_opts="$mencoder_general_opts $mencoder_output_opts $mencoder_audio_opts $mencoder_video_filter_opts $mencoder_video_encoder_opts"
802 # Set some options based on which pass we are in
803 mencoder_opts_for_pass=$(echo "$mencoder_opts" | sed "s,%PASS,$PASS,g")
804 [ $PASS -eq 1 ] && mencoder_opts_for_pass="$mencoder_opts_for_pass:turbo"
805 [ $PASS -eq 1 ] && output_file="/dev/null"
806 [ $PASS -eq 2 ] && output_file="$final_output_file"
808 # It's possible that the audio channel encoding may not work. Cycle through all our different audioch_opts until we find one that works.
809 for CH_OPTS in "${mencoder_audioch_opts[@]}";
811 echo -e " Encoding pass $PASS"
812 echo -e "\n Encoding pass $PASS: mencoder $CH_OPTS $mencoder_opts_for_pass \"$vobfile\" -o \"$output_file\" >> $encodelog 2>&1" >> "$logfile"
813 mencoder $CH_OPTS $mencoder_opts_for_pass "$vobfile" -o "$output_file" > $encodelog 2>&1
815 grep -q "\[channels\] Invalid" $encodelog
819 echo -e "\n-W- Audio channel encoding error. Falling back to next audio channel encoding scheme." >> "$logfile"
823 if [ $mencoder_retval != 0 ]; then
824 fatal_and_exit "-E- Unhandled mencoder error"
827 # Concatenate the encode log to our main log file, greping out unwanted lines
828 cat $encodelog | grep -v "^Pos:" | grep -v "duplicate" >> "$logfile"
833 function make_dvd_iso_image {
837 # check to see if we have a dvdpath to rip from instead of $dev
838 if [ -z "$dvdpath" ]; then
839 # load the CSS codes in the DVD drive
840 lsdvd $dev >> "$logfile"
842 fatal_and_exit "-E- lsdvd $dev failed"
845 # read the DVD, ignoring/skipping CRC errors
846 ddrescue -n -b 2048 $dev "$isofile" "$ddrescuelog"
848 fatal_and_exit "-E- ddrescue -n -b 2048 $dev \"$isofile\" failed"
850 cat "$ddrescuelog" >> "$logfile"
852 # rip from a path instead
853 make_dvd_iso_image_from_folder "$dvdpath" "$isofile" 1
857 function make_dvd_iso_image_from_folder {
863 echo "-> Creating ISO image of DVD video: $src -> $dst" | tee -a "$logfile"
865 # make an iso image out of our directory
866 echo " mkisofs -dvd-video \"$src\" 2>> \"$dumplog\" | dd of=\"$dst\" obs=32k seek=0 > /dev/null 2>> $dumplog" >> "$logfile"
867 mkisofs -dvd-video "$src" 2>> "$dumplog" | dd of="$dst" obs=32k seek=0 > /dev/null 2>> "$dumplog"
869 # set the audio languages from the iso if it exists and is non-zero in size
870 if [ -s "$dst" ]; then
871 get_feature_title "$dst"
872 get_audio_id_from_iso "$dst"
875 # make sure we were able to create the iso image from the folder given to us
876 if [ ! -s "$dst" ] && [ $handle_error -eq 1 ]; then
877 echo "-> Unable to make an iso image from the DVD folder: $dvdpath"
878 echo " Falling back to mplayer to create a main feature VOB from the folder instead: $dvdpath"
879 # remove the bad iso file
880 [[ -e "$dst" ]] && rm -f "$dst"
881 # get the feature title from the DVD folder
882 get_feature_title "$dvdpath"
883 # create our main VOB file from the ISO
884 create_main_vob_with_mplayer "$dvdpath"
885 # get our audio id from the VOB file
886 get_audio_id_from_vob "$vobfile"
890 function make_dvdbackup_folder_image {
891 # extract the feature title from the DVD image
892 echo "-> Extracting feature title using dvdbackup" | tee -a "$logfile"
893 [[ -d "$tmpdir/$dvdname" ]] && rm -rf "$tmpdir/$dvdname"
894 dvdbackup -F -i "$isofile" -o "$tmpdir" >> "$logfile"
896 fatal_and_exit '-E- dvdbackup -F -i "$isofile" -o "$tmpdir" failed'
900 function make_dvdauthor_folder_image {
901 # create a new DVD video of the feature title
902 echo "-> Creating DVD video $dest/$dvdname" | tee -a "$logfile"
903 [[ -d "$dest/$dvdname" ]] && rm -rf "$dest/$dvdname"
904 dvdauthor -o "$dest/$dvdname" -x dvd.xml > $dvdauthorlog 2>&1
905 cat $dvdauthorlog | grep -v "VOBU" >> "$logfile"
907 # There is a chance that dvdauthor won't like some of the VOBs.
908 # We can't tell ahead of time which ones it will choke on.
909 # So, we need to run it over and over again until it can process
910 # all the VOBs. If it can't handle one of them, run it through
911 # mencoder to fix it and try again. These errors are typically
912 # present due to the copy protection that ddrescue removed.
913 grep -q "SCR moves" $dvdauthorlog
914 while [ $? == 0 ]; do
915 # fix bad vobs that get the "SCR moves backwards" error:
916 # STAT: Processing VTS_01_0.VOB...
917 # ERR: SCR moves backwards, remultiplex input.
918 badvob=`grep -v "^WARN:" $dvdauthorlog | grep -B 1 "SCR moves" | grep "Processing" | awk '{ print $3 }' | sed -e 's/\.\.\.//'`
919 if [[ ! -f "$badvob" ]]; then
920 fatal_and_exit "-E- Found a bad VOB, but could not extract it's name properly: $badvob"
922 echo "-> Fixing SCR errors in DVD video file $badvob" | tee -a "$logfile"
923 cat $badvob | mencoder $lang_opts -quiet -of mpeg -mpegopts format=dvd -oac copy -ovc copy - -o $badvob.fixed >> "$logfile" 2>&1
924 mv -f $badvob.fixed $badvob
925 echo "-> Creating DVD video $dest/$dvdname"
926 dvdauthor -o "$dest/$dvdname" -x dvd.xml > $dvdauthorlog 2>&1
927 cat $dvdauthorlog | grep -v "VOBU" >> "$logfile"
928 grep -q "SCR moves" $dvdauthorlog
932 function get_feature_title {
934 # if a feature title was given on the command line, use it
935 if [ $feature_title_override -ne 0 ]; then
936 feature_title=$feature_title_override
939 # otherwise, use lsdvd to figure it out
940 if [ $ripdvd -eq 1 ]; then
941 feature_title=`lsdvd $dev | awk '/Longest/ { print $NF }'`
943 feature_title=`lsdvd "$source" 2>/dev/null | awk '/Longest/ { print $NF }'`
947 function create_main_vob_with_cat {
948 # cd to the feature title DVD folder
949 pushd "$tmpdir/$dvdname/VIDEO_TS" > /dev/null 2>&1
951 fatal_and_exit "-E- Unable to cd to $tmpdir/$dvdname/VIDEO_TS"
954 # concatenate all the VOBs together into 1 giant VOB
955 vobs=`/bin/ls -1 VTS*.VOB | grep -v "0.VOB" | tr '\n' ' '`
956 cat $vobs > "$tmpdir/$dvdname.VOB"
958 # cd back to the dir we started from
959 popd > /dev/null 2>&1
962 function create_main_vob_with_mplayer {
964 # argument processing
968 # make sure we have a valid feature title
969 if [ $invalid_feature_title -eq 1 ] && [ $feature_title_override -eq 0 ]; then
970 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."
973 # check to make sure we didn't detect an mplayer dumpstream incompatibility earlier
974 if [ $mplayer_dumpstream_incompatibility -eq 1 ]; then
975 msg="-E- We detected an mplayer dumpstream incompatibility earlier."
976 msg="$msg We also detected another condition that requires us to use dumpstream. "
977 msg="$msg\n Unable to rip this DVD in the mode you requested."
978 fatal_and_exit "$msg"
981 # use mplayer to create the main VOB file
982 echo "-> Using mplayer to dump the DVD feature title $feature_title to a VOB file directly: $vobfile" | tee -a "$logfile"
983 echo " mplayer $lang_opts -dumpstream -dumpfile \"$vobfile\" -dvd-device \"$source\" dvd://$feature_title > $dumplog 2>&1" >> "$logfile"
984 mplayer $lang_opts -dumpstream -dumpfile "$vobfile" -dvd-device "$source" dvd://$feature_title > $dumplog 2>&1
986 cat $dumplog | grep -v "^A:" >> "$logfile"
987 fatal_and_exit "-E- Mplayer Failed"
989 cat $dumplog | grep -v "^A:" >> "$logfile"
990 [[ -e "$dumplog" ]] && [[ $remove_dumplog -eq 1 ]] && rm -f $dumplog
993 function get_audio_id_from_iso {
994 # Adjust our audio ID to find the english audio stream
995 # This should be 128. However, if 128 is not there, pick the next one that incrementally is.
1000 if [ $aid_override -lt 0 ]; then
1001 mplayer -v -endpos 0 -dvd-device "$iso" dvd://$feature_title > $aidcheck 2>&1
1002 grep -q "aid: $aid" $aidcheck
1003 while [ $? == 1 ] && [ $aid -lt 159 ]; do
1005 grep -q "aid: $aid" $aidcheck
1007 [[ -e "$aidcheck" ]] && rm -f "$aidcheck"
1011 echo "-> Setting the audio stream ID to $aid" | tee -a "$logfile"
1012 # mencoder default DVD audio track language selection (english)
1013 lang_opts="-aid $aid -alang $alang"
1016 function get_crop_from_iso {
1018 echo "-> Detecting black frame border crop value from ISO file"
1019 echo " mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark -dvd-device \"$isofile\" dvd://$feature_title > $dumplog 2>&1" >> "$logfile"
1020 mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark -dvd-device "$isofile" dvd://$feature_title > $dumplog 2>&1
1021 [[ -e "md5sums" ]] && rm -f "md5sums"
1022 CROP=`cat $dumplog | grep CROP | tail -1`
1023 echo " Found crop value of $CROP" >> "$logfile"
1024 CROP=${CROP#* crop=}
1026 typeset -i CROPCHECK
1027 CROPCHECK=`echo "$CROP" | awk -F ':' '{ print $1 }'`
1028 echo " Final crop value of $CROP with cropcheck value of $CROPCHECK" >> "$logfile"
1029 if [ -z "$CROP" ]; then
1030 echo "-W- Unable to extract CROP value from iso: $isofile" | tee -a "$logfile"
1033 if [ $CROPCHECK -lt 0 ]; then
1038 echo " Setting mencoder crop filter to: $CROP"
1041 function get_crop_from_vob {
1043 echo "-> Detecting black frame border crop value from VOB file"
1044 echo " mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark \"$vobfile\" > $dumplog 2>&1" >> "$logfile"
1045 mplayer -vf cropdetect -frames $FRAMES -nosound -vo md5sum -benchmark "$vobfile" > $dumplog 2>&1
1046 [[ -e "md5sums" ]] && rm -f "md5sums"
1047 CROP=`cat $dumplog | grep CROP | tail -1`
1048 echo " Found crop value of $CROP" >> "$logfile"
1049 CROP=${CROP#* crop=}
1051 typeset -i CROPCHECK
1052 CROPCHECK=`echo "$CROP" | awk -F ':' '{ print $1 }'`
1053 echo " Final crop value of $CROP with cropcheck value of $CROPCHECK" >> "$logfile"
1054 if [ -z "$CROP" ]; then
1055 echo "-W- Unable to extract CROP value from iso: $isofile" | tee -a "$logfile"
1058 if [ $CROPCHECK -lt 0 ]; then
1063 echo " Setting mencoder crop filter to: $CROP"
1066 function get_audio_track_from_vob {
1067 # Adjust our audio ID to find the english audio stream
1068 # This should be 128. However, if 128 is not there, pick the next one that incrementally is.
1073 alang=$default_alang
1074 if [ $aid_override -lt 0 ]; then
1075 mplayer -v -endpos 0 "$vob" > $aidcheck 2>&1
1076 grep -q "Found audio stream: $aid" $aidcheck
1077 while [ $? == 1 ] && [ $aid -lt 159 ]; do
1079 grep -q "Found audio stream: $aid" $aidcheck
1081 [[ -e "$aidcheck" ]] && rm -f "$aidcheck"
1085 # Now that we've found the right audio id, find the corresponding audio track in HandBrake
1087 # convert the aid we found into hex
1088 aid_hex=`echo "obase=16; $aid" | bc`
1090 # extract the audio streams in the vob
1091 #ffmpeg -i "$vob" > $aidcheck 2>&1
1092 $handbrake_cli --stop-at 0 -i "$vob" -o /dev/null -v 100 > $aidcheck 2>&1
1094 # find the stream that matches our aid
1095 #stream=`grep "Stream.*\[0x$aid_hex\]" $aidcheck`
1096 #stream=`grep "scan: audio" $aidcheck | grep -n "" | grep "scan: audio 0x$aid_hex"`
1097 stream=`grep "add_audio_to_title:" $aidcheck | grep -n "" | grep "add_audio_to_title:.* stream 0x$aid_hex"`
1099 # extract the track number that handbrake uses
1100 #track=`expr match "$stream" '.*#[0-9]\.\([0-9]*\)'`
1101 track=`expr match "$stream" '^\([0-9]*\):'`
1103 if [ -n "$track" ]; then
1104 echo " Setting the audio ID to $aid. Setting the audio track to $track." | tee -a "$logfile"
1108 function get_audio_id_from_vob {
1109 # Adjust our audio ID to find the english audio stream
1110 # This should be 128. However, if 128 is not there, pick the next one that incrementally is.
1114 alang=$default_alang
1115 if [ $aid_override -lt 0 ]; then
1116 mplayer -v -endpos 0 "$vob" > $aidcheck 2>&1
1117 grep -q "Found audio stream: $aid" $aidcheck
1118 while [ $? == 1 ] && [ $aid -lt 159 ]; do
1120 grep -q "Found audio stream: $aid" $aidcheck
1122 [[ -e "$aidcheck" ]] && rm -f "$aidcheck"
1126 echo "-> Setting the audio stream ID to $aid" | tee -a "$logfile"
1127 # mencoder default DVD audio track language selection (english)
1128 lang_opts="-aid $aid -alang $alang"
1131 function check_vob_for_corrupted_start {
1132 # check to see if the beginning of the DVD has a form of copy protection
1133 # where they have deliberately broken the first X number of frames of the DVD.
1134 # If we don't skip these, our resulting VOB file will not play.
1135 badvobcheck=`tempfile`
1138 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
1139 if [ $? != 0 ]; then
1140 fatal_and_exit "-E- Mencoder Failed"
1142 grep "Writing header" -A `wc $badvobcheck | awk '{ print $1 }'` $badvobcheck | grep -q "Too many video packets in the buffer"
1143 while [ $? == 0 ] && [ $skip -lt $endpos ]; do
1144 (( skip = skip + 5 ))
1145 echo "-> Bad VOB copy protection detected. Trying new skip value of $skip" | tee -a "$logfile"
1146 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
1147 if [ $? != 0 ]; then
1148 fatal_and_exit "-E- Mencoder Failed"
1150 grep "Writing header" -A `wc $badvobcheck | awk '{ print $1 }'` $badvobcheck | grep -q "Too many video packets in the buffer"
1152 [[ -e "$badvobcheck" ]] && rm -f "$badvobcheck";
1154 # cat the giant VOB into mencoder to create a playable VOB file
1155 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
1156 if [ $? != 0 ]; then
1157 fatal_and_exit "-E- Mencoder Failed"
1161 function check_vob_for_completeness {
1162 # check to make sure we got out a complete VOB.
1163 # there is another kind of copy protection where the VOB's may
1164 # have "MPG EOF" frames in the middle of the stream.
1165 # this causes mencoder to not process the entire VOB, and exit without any errors.
1166 # detect this by seeing how much smaller the dst vob is from the src vob.
1167 MAX_FILESIZE_DELTA_PERCENT=70
1168 SRC_VOB_FILESIZE=$(stat -c%s "$tmpdir/$dvdname.VOB")
1169 DST_VOB_FILESIZE=$(stat -c%s "$vobfile")
1170 FILESIZE_DELTA=`echo "scale=2; $DST_VOB_FILESIZE / $SRC_VOB_FILESIZE * 100" | bc | awk -F '.' '{ print $1 }'`
1171 if [ $FILESIZE_DELTA -lt $MAX_FILESIZE_DELTA_PERCENT ]; then
1172 # Try one other way to get the VOB using mplayer directly to rip the feature titleset.
1173 echo "-> Detected bad VOB size copy protection after processing concatenated VOB file." | tee -a "$logfile"
1174 create_main_vob_with_mplayer "$isofile"
1175 [[ -e "$dumplog" ]] && rm -f $dumplog
1176 DST_VOB_FILESIZE=$(stat -c%s "$vobfile")
1177 FILESIZE_DELTA=`echo "scale=2; $DST_VOB_FILESIZE / $SRC_VOB_FILESIZE * 100" | bc | awk -F '.' '{ print $1 }'`
1178 if [ $FILESIZE_DELTA -lt $MAX_FILESIZE_DELTA_PERCENT ]; then
1179 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'"
1184 function check_vob_for_too_many_video_packets {
1185 # If our earlier algorithm to work around this failed, throw an error.
1186 # check to see if this DVD has a protection scheme we don't know how to work around
1187 # when I tried to burn the CARS DVD for example, you can't play the resulting VOB file.
1188 # for some reason, the video is black, while the audio rolls, then the video finally comes
1189 # in, but it is WAY off the audio. This appears to be due to some bad frames at the beginning of
1190 # the 1st VOB. Until I figure out how to work around this, detect it, and error out.
1191 # instead of pulling the image from the disk again, you can pull it directly from the iso: -dvd-device $iso_path
1192 grep -q "Too many video packets in the buffer:" "$logfile"
1193 if [ $? == 0 ]; then
1194 # Try one other way to get the VOB using mplayer directly to rip the feature titleset.
1195 echo "-> Detected corrupt audio stream copy protection after processing concatenated VOB file." | tee -a "$logfile"
1196 create_main_vob_with_mplayer "$isofile"
1197 grep -q "Too many video packets in the buffer:" $dumplog
1198 if [ $? == 0 ]; then
1199 [[ -e "$dumplog" ]] && rm -f $dumplog
1200 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'"
1202 [[ -e "$dumplog" ]] && rm -f $dumplog
1206 function check_vob_for_a52_crc_errors {
1207 # Let's see if we can playback our newly created VOB file without any errors.
1208 # if there are issues, let's detect them now, and try to recreate the VOB
1209 # there are some forms of copy protection that have missed above, that evidence
1210 # themselves when we try to playback the VOB file. This was added to deal with
1211 # the "a52: CRC check failed" copy protection scheme.
1214 echo "-> Checking for a52 audio stream CRC errors" | tee -a "$logfile"
1215 mplayer -endpos $ENDPOS -ao null -vo null "$vobfile" > $dumplog 2>&1
1216 cat $dumplog | grep -v "^A:" >> "$logfile"
1217 errors=`grep "a52: CRC check failed" $dumplog | wc | awk '{ print $1 }'`
1218 if [ $errors -gt $MAX_ERRORS ]; then
1219 echo "-> Detected a52 audio stream CRC errors copy protection after processing concatenated VOB file." | tee -a "$logfile"
1220 create_main_vob_with_mplayer "$isofile"
1221 echo "-> Checking for a52 audio stream CRC errors" | tee -a "$logfile"
1222 mplayer -endpos $ENDPOS -ao null -vo null "$vobfile" > $dumplog 2>&1
1223 if [ $? != 0 ]; then
1224 cat $dumplog | grep -v "^A:" >> "$logfile"
1225 fatal_and_exit "-E- Mplayer Failed"
1227 cat $dumplog | grep -v "^A:" >> "$logfile"
1228 errors=`grep "a52: CRC check failed" $dumplog | wc | awk '{ print $1 }'`
1229 if [ $errors -gt $MAX_ERRORS ]; then
1230 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'"
1233 [[ -e "$dumplog" ]] && rm -f $dumplog
1236 function calculate_bitrate_from_target_size {
1237 # determine what our bitrate needs to be if a target size was specified instead
1238 if [ $target_size -ne 0 ]; then
1239 vob_length=`mplayer -identify -v "$vobfile" -endpos 0 2>&1 | grep ID_LENGTH | awk -F '=' '{ print $2 }' | awk -F '.' '{ print $1 }'`
1240 ((target_bitrate = (target_size * 1024 * 8) / vob_length ))
1242 echo " With a given target size of $target_size MB, the estimated bit rate will need to be $target_bitrate kbits/sec"
1246 function create_dvdauthor_dvd_xml_file {
1247 # make a dvdauthor xml menu file to create a valid DVD video from
1248 # this script does a good job, but we'll still need to clean it up a bit after it runs
1249 echo "-> Creating dvdauthor XML menu file" | tee -a "$logfile"
1250 makexml -overwrite -dvd *.VOB -out dvd >> "$logfile" 2>&1
1251 if [ $? != 0 ]; then
1252 fatal_and_exit '-E- makexml -dvd *.VOB -out dvd failed'
1255 # replace the first line of the xml file to remove the bad dest path
1256 awk -v line=1 -v new_content="<dvdauthor>" '{
1262 }' dvd.xml > dvd.xml.new
1263 mv -f dvd.xml.new dvd.xml
1264 if [ $? != 0 ]; then
1265 fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
1268 # remove the "<video " property line from the xml file
1269 cat dvd.xml | grep -v "<video" > dvd.xml.new
1270 mv -f dvd.xml.new dvd.xml
1271 if [ $? != 0 ]; then
1272 fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
1275 # remove the extra <pgc>..</pgc> pairs
1276 cat dvd.xml | awk 'BEGIN {x=1}
1278 if ($0~"</pgc>") {x=0}
1279 if (x==1) {print $0}
1280 if ($0~"<pgc>") {x=1}
1282 echo -e "</pgc>\n</titles>\n</titleset>\n</dvdauthor>" >> dvd.xml.new
1283 mv -f dvd.xml.new dvd.xml
1284 if [ $? != 0 ]; then
1285 fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
1288 # remove the VTS_*_0.VOB file as this is just the main menu video clip
1289 cat dvd.xml | grep -v "VTS_.*_0.VOB" > dvd.xml.new
1290 mv -f dvd.xml.new dvd.xml
1291 if [ $? != 0 ]; then
1292 fatal_and_exit '-E- mv dvd.xml.new dvd.xml failed'
1296 function check_for_mplayer_dumpstream_incompatibility {
1298 echo "-> Checking for mplayer dumpstream incompatibilities" | tee -a "$logfile"
1300 if [ ! -e "$vobfile" ]; then
1301 # mplayer dumpstream does not work on DVDs that obscure the feature title.
1302 # A DVD that has 99 titles, where the longest title isn't the main feature
1303 # breaks mplayer dumpstream. We have to fallback to using dvdbackup to figure
1304 # out what the feature title is. This script will run through that flow if we
1305 # set use_mplayer_dumpstream to 0. Check for this here.
1306 if [ $ripdvd -eq 1 ]; then
1307 lsdvd $dev | grep -q "Title: 99"
1309 lsdvd "$isofile" | grep -q "Title: 99"
1311 # If we have 99 titles and a feature title wasn't given on the command line, switch modes.
1312 if [ $? == 0 ] && [ $feature_title_override -eq 0 ]; then
1313 if [ $trust_feature_title_autodetect_when_uncertain -eq 0 ]; then
1314 echo "-E- Unable to determine the feature title due to the 99 title copy protection scheme" | tee -a "$logfile"
1315 echo " You will need to determine this yourself and rerun the script with the -t option" | tee -a "$logfile"
1316 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"
1317 invalid_feature_title=1
1319 echo " Falling back to non mplayer dumpstream methods to copy the DVD" | tee -a "$logfile"
1320 echo "-W- We still may not be able to autodetect the right feature title" | tee -a "$logfile"
1321 echo " You may need to determine this yourself and rerun the script with the -t option" | tee -a "$logfile"
1322 use_mplayer_dumpstream=0
1323 invalid_feature_title=1
1329 # There is another form of protection that causes the mplayer dumpstream to fail.
1330 # This can be detected by telling mplayer to parse the VOB file by copying its audio
1331 # video streams to a dummy output file (/dev/null). Do that here to check for that
1332 # problem before continuing.
1333 if [ -e "$vobfile" ]; then
1334 mplayer_opts="-quiet -ofps 30000/1001 -ffourcc DIVX -oac copy -ovc copy"
1335 mencoder $mplayer_opts "$vobfile" -o "/dev/null" > $dumplog 2>&1
1336 grep -q "Too many audio packets in the buffer" $dumplog
1337 if [ $? == 0 ]; then
1338 echo "-> The VOB dumped by mplayer is invalid. Falling back to non mplayer dumpstream to copy the DVD" | tee -a "$logfile"
1339 use_mplayer_dumpstream=0
1340 mplayer_dumpstream_incompatibility=1
1342 [[ -e "$dumplog" ]] && rm -f $dumplog
1346 function fill_mythvideo_metadata {
1348 # This function must be passed the filename as an argument
1349 # The filename must be a full path to the file
1352 # Make sure the fill mythvideo metadata option has been set to 1
1353 if [ $fill_mythvideo_metadata -eq 0 ]; then
1354 echo "-> fill_mythvideo_metadata=0 therefore not updating mythvideo metadata for this rip" | tee -a "$logfile"
1358 # If the fill mythvideo metadata script is present, run it
1359 # fill_mythvideo_metadata.plThis will download the metadata for the DVD we ripped.
1360 if [[ -x `which fill_mythvideo_metadata.pl` ]]; then
1361 echo "-> Running fill_mythvideo_metadata.pl to lookup/add/update the metadata for this DVD: $filename" | tee -a "$logfile"
1362 fill_mythvideo_metadata.pl -N 0 -F "$filename" >> "$logfile" 2>&1
1364 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"
1365 echo " Set the fill_mythvideo_metadata variable to 0 in the script to avoid running this step." | tee -a "$logfile"
1369 # remove the intermediate VOB file
1370 function remove_intermediate_vob_file {
1371 if [ $keep_intermediate_files -eq 0 ]; then
1372 [[ -e "$tmpdir/$dvdname.VOB" ]] && rm -f "$tmpdir/$dvdname.VOB"
1374 echo "-> Keeping intermediate concatenated VOB file: $tmpdir/$dvdname.VOB" | tee -a "$logfile"
1378 # remove the original DVD image
1379 function remove_intermediate_iso_file {
1380 [[ $keep_isofile -eq 1 ]] && return 1
1381 if [ $keep_intermediate_files -eq 0 ]; then
1382 [[ -e "$isofile" ]] && rm "$isofile"
1384 echo "-> Keeping ddrescue intermediate iso file: $isofile" | tee -a "$logfile"
1388 # remove the intermediate dvdbackup folder
1389 function remove_intermediate_dvdbackup_folder {
1390 if [ $keep_intermediate_files -eq 0 ]; then
1391 [[ -d "$tmpdir/$dvdname" ]] && rm -rf "$tmpdir/$dvdname"
1393 echo "-> Keeping intermediate dvdbackup folder: $tmpdir/$dvdname" | tee -a "$logfile"
1397 ##############################################################################################
1399 ##############################################################################################
1401 # Make a note of when this DVD rip started
1403 echo -e "\n$date DVD rip started" >> "$logfile"
1404 echo "$cmd" >> "$logfile"
1406 # Rip the DVD - Mirror Mode
1407 if [ $mirror_mode -eq 1 ]; then
1408 echo "-> Ripping DVD $dvdname to $dest"
1410 # use ddrescue to make an ISO image of the disk
1411 make_dvd_iso_image "$dest/$dvdname.iso"
1413 # add this video data to the mythtv DB
1414 fill_mythvideo_metadata "$dest/$dvdname.iso"
1416 # eject the disk upon completion
1417 if [ $eject_disk -ne 0 ]; then
1422 echo "$date DVD rip completed" | tee -a "$logfile"
1424 if [[ -n "$mailto" ]]; then
1425 cat "$logfile" | mailx -s "dvd rip of $dvdname DONE" "$mailto"
1430 # Rip the DVD - Main Title Feature Only
1431 if [ $mirror_mode -eq 0 ]; then
1433 # Rip image from DVD
1434 if [ $ripdvd -eq 1 ]; then
1435 echo "-> Ripping DVD $dvdname to $dest" | tee -a "$logfile"
1436 # use ddrescue to make an ISO image of the disk
1437 make_dvd_iso_image "$tmpdir/$dvdname.iso"
1440 # Rip image from DVD path
1441 if [ -n "$dvdpath" ]; then
1442 echo "-> Ripping DVD $dvdpath to $dest" | tee -a "$logfile"
1443 make_dvd_iso_image_from_folder "$dvdpath" "$tmpdir/$dvdname.iso" 1
1446 # make sure our isofile value is set
1447 if [ -z "$isofile" ]; then
1448 isofile="$tmpdir/$dvdname.iso"
1451 if [ $make_final_dest_vob -eq 1 ] || [ $make_final_dest_comp -eq 1 ]; then
1453 if [ ! -e "$vobfile" ]; then
1454 echo "-> Creating DVD video $vobfile" | tee -a "$logfile"
1456 # get the feature title from the ISO
1457 get_feature_title "$isofile"
1459 # get the crop value from the ISO
1462 # check for mplayer dumpstream incompatibilities
1463 # if they exist, this method will set this mode to 0.
1464 check_for_mplayer_dumpstream_incompatibility
1466 if [ $use_mplayer_dumpstream -eq 1 ]; then
1468 # get our audio id from the ISO file
1469 get_audio_id_from_iso "$isofile"
1471 # create our main VOB file from the ISO
1472 create_main_vob_with_mplayer "$isofile"
1474 # remove the intermediate VOB file
1475 remove_intermediate_vob_file
1477 # it's possible that our VOB is still corrupted in some manner
1478 # check to make sure it is still a good VOB before continuing.
1479 check_for_mplayer_dumpstream_incompatibility
1483 if [ $use_mplayer_dumpstream -eq 0 ]; then
1485 # use dvdbackup to make a DVD folder of the feature title
1486 make_dvdbackup_folder_image
1488 # create our main VOB file
1489 create_main_vob_with_cat
1491 # get our audio id from the VOB file
1492 get_audio_id_from_vob "$tmpdir/$dvdname.VOB"
1494 # check for corrupted VOB start
1495 check_vob_for_corrupted_start
1497 # check to make sure our VOB is complete
1498 check_vob_for_completeness
1500 # check to make sure our VOB doesn't have too many video packets
1501 check_vob_for_too_many_video_packets
1503 # check to make sure our VOB doesn't have a52 crc errors
1504 check_vob_for_a52_crc_errors
1506 # remove the intermediate VOB file
1507 remove_intermediate_vob_file
1511 # remove the intermediate ISO file
1512 remove_intermediate_iso_file
1515 if [ "$encoder" != "handbrake" ]; then
1516 echo "-> Skipping VOB creation. VOB DVD video already exists: $vobfile" | tee -a "$logfile"
1517 # get our audio id from the VOB file
1518 get_audio_id_from_vob "$vobfile"
1519 # get the crop value from the VOB
1524 # eject the DVD disk since we are finished with it
1525 [ $eject_disk -eq 2 ] && eject -T $dev
1527 # encode the VOB file to a compressed file format
1528 if [ $make_final_dest_comp -eq 1 ]; then
1529 echo "-> Encoding the DVD video to a compressed file using $encoder" | tee -a "$logfile"
1531 # determine what our bitrate needs to be if a target size was specified instead
1532 calculate_bitrate_from_target_size
1534 # encode the vob file into a compressed file format
1535 if [[ "$encoder" == "mencoder" ]]; then
1536 encode_vob_file_mencoder
1538 if [[ "$encoder" == "handbrake" ]]; then
1539 encode_vob_file_handbrake
1542 if [ $keep_intermediate_files -eq 0 ] && [ $make_final_dest_vob -eq 0 ]; then
1543 [[ -e "$vobfile" ]] && [[ $keep_vobfile -eq 0 ]] && rm -f "$vobfile";
1544 [[ -e "$passlogfile" ]] && rm -f "$passlogfile";
1546 echo "-> Keeping VOB file: $vobfile" | tee -a "$logfile"
1547 echo "-> Keeping mencoder 2pass logfile: $passlogfile"
1551 # add this video data to the mythtv DB
1552 [ $make_final_dest_comp -eq 1 ] && fill_mythvideo_metadata "$final_output_file"
1553 [ $make_final_dest_vob -eq 1 ] && fill_mythvideo_metadata "$vobfile"
1557 # use dvdbackup to make a DVD folder of the feature title
1558 make_dvdbackup_folder_image
1560 # cd to the feature title DVD folder
1561 pushd "$tmpdir/$dvdname/VIDEO_TS" > /dev/null 2>&1
1562 if [ $? != 0 ]; then
1563 fatal_and_exit "-E- Unable to cd to $tmpdir/$dvdname/VIDEO_TS"
1566 # create the dvd.xml file for dvdauthor
1567 create_dvdauthor_dvd_xml_file
1569 # make the final DVD folder image
1570 make_dvdauthor_folder_image
1572 # add this video data to the mythtv DB
1573 fill_mythvideo_metadata "$dest/$dvdname/VIDEO_TS"
1575 # cd back to the dir we started from
1576 popd > /dev/null 2>&1
1578 if [ $make_final_dest_iso -eq 1 ]; then
1580 # make an iso image out of our directory
1581 make_dvd_iso_image_from_folder "$dest/$dvdname" "$dest/$dvdname.iso" 0
1583 # If the mkisofs was unable to make a .iso file for us, don't remove the DVD directory
1584 if [ -s "$dest/$dvdname.iso" ]; then
1585 if [ $make_final_dest_folder -eq 0 ]; then
1586 echo "-> Removing DVD folder since ISO was created: $dest/$dvdname" | tee -a "$logfile"
1587 # remove the folder of the DVD image now that we have a .iso version of it
1588 [[ -d "$dest/$dvdname" ]] && rm -rf "$dest/$dvdname"
1591 # we created an empty iso file, remove it
1592 echo "-> Removing empty ISO image: $dest/$dvdname.iso" | tee -a "$logfile"
1593 echo "-> Keeping the DVD folder since the ISO image couldn't be created properly: $dest/$dvdname"
1594 [[ -e "$dest/$dvdname.iso" ]] && rm "$dest/$dvdname.iso"
1597 # add this video data to the mythtv DB
1598 fill_mythvideo_metadata "$dest/$dvdname.iso"
1604 # remove the ddrescue DVD ISO image
1605 remove_intermediate_iso_file
1607 # remove the tmp dvdbackup folder of the DVD image
1608 remove_intermediate_dvdbackup_folder
1610 # eject the DVD disk upon completion
1611 [ $eject_disk -eq 1 ] && eject -T $dev
1614 echo "$date DVD rip completed" | tee -a "$logfile"
1616 if [[ -n "$mailto" ]]; then
1617 cat "$logfile" | mailx -s "dvd rip of $dvdname DONE" "$mailto"
1622 ##############################################################################################