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