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