Upped the revision
[rip_dvd/.git] / README
1 ----------------------------------------------
2 DEPENDENCIES
3 ----------------------------------------------
4 The following packages need to be installed on your system:
5
6 Package Dependencies (apt-get install these for example):
7 lsdvd dvdauthor gddrescue dvdbackup tovid mencoder mplayer genisoimage libdvdcss2
8
9 NOTE:  In Ubuntu, depending on your version, replace libdvdcss2 with what you find on this page.
10   https://help.ubuntu.com/community/RestrictedFormats/PlayingDVDs
11
12 NOTE:  After apt-get install on Ubuntu you may need to run this:
13   sudo /usr/share/doc/libdvdread4/install-css.sh
14
15 Specific Executable (program) Dependencies (must be found in $PATH):
16 volname makexml lsdvd dvdauthor ddrescue dvdbackup mencoder mplayer mkisofs
17
18 NOTE:  The script puts /usr/share/tovid on your path which should contain makexml
19
20 Optional Dependencies:
21 lookup imdb info/posters for mythvideo: http://www.mythtv.org/wiki/Fill_mythvideo_metadata.pl
22 HandBrake CLI video encoder (version 0.9.3 required for xvid encoding): google to find it
23 HandBrake CLI video encoder (version >=0.9.4 required for mp4 encoding): http://handbrake.fr/
24 You can also get these HandBrake versions from here: https://www.pippins.net/cgi-bin/index.pl?/www/files/video_utils/handbrake
25
26 Windows Dependencies:
27 To play back the videos in windows that use the divx encoding profiles, you'll
28 need to download and install the xvid codec:
29 http://www.koepi.info/xvid.html
30
31 ----------------------------------------------
32 INSTALL
33 ----------------------------------------------
34 The following steps should be followed to pull this code project
35 into a local GIT repository (local directory):
36
37 This command will create a directory called "rip_dvd" in the CWD and pull the code for this project:
38 > git clone http://git.pippins.net/rip_dvd/.git rip_dvd
39
40 To pull updates in the future of this project into your local directory:
41 > cd rip_dvd
42 > git pull origin
43
44 To see the changelog for what you have pulled, run this command:
45 > git whatchanged
46
47 -------------------------------------------------
48 ENABLING MENCODER XVID TO ENCODE USING MULTICORES
49 -------------------------------------------------
50 The libxvidcore4 package that you can get through ubuntu or debian
51 is version 1.1.0. They didn't enable multi-core encoding using this
52 library until version 1.2.0. Since you can't get that in a package,
53 you can build it from source easily. Since the xvid codec (this lib)
54 is used by mencoder by rip_dvd in all of its xvid profiles (the default),
55 you can speed up the encode process quite a bit if you enable multi-cores.
56 Follow these instructions to enable the xvid encoding to use multi-cores:
57
58 > wget http://downloads.xvid.org/downloads/xvidcore-1.2.1.tar.gz
59 > gunzip xvidcore-1.2.1.tar.gz
60 > tar xvf xvidcore-1.2.1.tar
61 > cd xvidcore/build/generic
62 > ./configure --prefix=/usr
63 > make
64 > sudo make install
65 > cd /usr/lib
66 > sudo rm libxvidcore.so.4
67 > sudo ln -s libxvidcore.so.4.2 libxvidcore.so.4
68
69 After you do these steps, when rip_dvd is running using any xvid profile,
70 you will note with 'top' that the mencoder process is using > 100% of your CPU.
71
72 ----------------------------------------------
73 CONFIGURATION
74 ----------------------------------------------
75 You'll need to copy the rip_dvd.conf.dist file to a local copy of the
76 file called rip_dvd.conf. This way, you can customize the settings
77 needed by the script in a file that isn't tracked by GIT. The conf
78 file tracked by GIT (rip_dvd.conf.dist) will then contain the defaults
79 the script needs to run. You can override these in your own rip_dvd.conf
80 file you create locally.  This will allow you to get updates from my
81 GIT repository at a later point in time without blowing away your 
82 local settings. You can put your copy of the rip_dvd.conf file in 
83 any of the following locations:
84
85  1) /path/to/rip_dvd/script/rip_dvd.conf.dist
86  2) /path/to/rip_dvd/script/rip_dvd.conf
87  3) /etc/rip_dvd.conf
88  4) /path/to/where/rip_dvd/is/run/from/rip_dvd.conf
89
90 ----------------------------------------------
91 MYTHTV MENU SETUP
92 ----------------------------------------------
93 Copy the menu files provided in the GIT repository to your mythtv
94 menu location:
95
96 > cp optical_menu.xml /usr/share/mythtv/
97 > cp rip_dvd_menu.xml /usr/share/mythtv/
98
99 You'll also need to edit the rip_dvd_menu.xml file so that the paths,
100 commands, buttons, actions, meet your needs to accomplish the common
101 encoding tasks you will want to do.
102
103 The optical_menu.xml file was modified with a single entry for the
104 rip_dvd_menu.xml file. You can take a look at this entry in this file
105 and place it in any xml file you want to get it on the menu you want.
106 I choose to place it on the optical menu.
107
108 The menu items in these examples call the rip_dvd.wrap script.
109 This is a simple script I wrote to implementation hide the full
110 command line options for rip_dvd from the mythtv menu system.
111 I also use this wrapper script to determine where to put the
112 ripped DVD images. You can copy this example and call it something
113 else on your system and change it appropriately to meet your needs.
114
115 ----------------------------------------------
116 COMMAND LINE EXAMPLES
117 ----------------------------------------------
118
119 Rip a DVD into a compressed AVI file with default xvidhq profile:
120 > rip_dvd -d /path/to/dest/dir -b 2000 -z
121
122 Rip a DVD into a compressed AVI file with default xvidhq profile scaling to 320x240 compressed video size:
123 > rip_dvd -d /path/to/dest/dir -b 2000 -z -a 320:240
124
125 Rip a DVD into a compressed AVI file with default xvidhq profile targetting a certain compressed video filesize (in MB):
126 > rip_dvd -d /path/to/dest/dir -b 2000 -z -s 650
127
128 Rip a DVD into a VOB file:
129 > rip_dvd -d /path/to/dest/dir -v
130
131 Rip a DVD into an ISO file:
132 > rip_dvd -d /path/to/dest/dir -m
133
134 Rip a DVD into a burnable DVD compliant folder (creating VIDEO_TS and AUDIO_TS folders):
135 > rip_dvd -d /path/to/dest/dir -f
136
137 Rip a VOB file into a compressed AVI file:
138 > rip_dvd -d /path/to/dest/dir -b 2000 -z -n /path/to/file.vob
139
140 Rip a DVD Folder into a compressed AVI file:
141 > rip_dvd -d /path/to/dest/dir -b 2000 -z -n /path/to/dvd/folder/that/contains/a/VIDEO_TS
142
143 Rip a DVD into a compressed MP4 file for an ipod:
144 > rip_dvd -d /path/to/dest/dir -b 2000 -z -p ipod
145
146 Rip a DVD into a compressed MP4 file for an ipod AND again for a compressed AVI file:
147 > dvdname=`volname /dev/dvd | awk '{ print $1 }'`
148 > rip_dvd -d /path/to/dest/dir -v
149 > rip_dvd -d /path/to/dest/dir/ipod -b 2000 -z -p ipod -n /path/to/dest/dir/$dvdname.VOB
150 > rip_dvd -d /path/to/dest/dir/xvid -b 2000 -z -p xvidhq -n /path/to/dest/dir/$dvdname.VOB
151 > rm /path/to/dest/dir/$dvdname.VOB
152