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