Merge branch 'master' of /home/carl/git/dvdomatic
[dcpomatic.git] / README
1 dvd-o-matic
2 -----------
3
4 Hello!
5
6
7 Building for Linux
8 ------------------
9
10 ./waf configure
11 ./waf
12 sudo ./waf install
13
14
15 Building for Windows
16 --------------------
17
18 ...is quite involved.  You need to build (or download) all the dependencies.
19 I'll put my scripts up at some point.
20
21
22 Dependencies
23 ------------
24
25 You will need these libraries:
26
27     libdcp (from http://carlh.net/software/libdcp)
28     FFmpeg version 0.9.x or higher
29     libtiff
30     boost thread and filesystem
31     libopenjpeg 1.5.0 or higher
32     wxWidgets
33     libsndfile
34     libssh
35
36 and also the command line tool:
37
38     vobcopy (if you want to rip DVDs straight into DVD-o-matic)
39
40
41 Documentation
42 -------------
43
44 There is a manual available at http://carlh.net/software/dvdomatic
45 The DocBook source for this is in doc/manual.
46
47
48 In a nutshell
49 -------------
50
51 The `dvdomatic' program is a GTK front-end which is probably easiest
52 to use.  It will create a directory for a particular project, and write
53 its data to that directory.  The basic approach is:
54
55 "File->New"; specify a directory.
56 Choose "Jobs->Copy from DVD" to read a DVD from your drive, if you have one.
57 Fill in the fields in the window (most importantly the `content' field:
58   specify your video, and the `Name' field: give your project [and hence DCP]
59   a name.)
60 Move the slider to see thumbnails; adjust crop if necessary.
61 Select "Jobs->Make DCP" and go and make a really strong cup of tea.
62 The DCP will be written to the project's directory; copy this to your
63   media server and ingest.
64
65 The `Format' field dictates what size your image will be:
66
67 - 4:3 within Flat: 1.33:1 images inside a flat (1.85:1) frame; play
68   back using the DCI 1.85 / DCI Flat preset on your projector.
69 - Academy: 1.37:1; play using DCI 1.37 if you have such a thing.
70 - 16:9 within Flat: 1.78:1 images inside a 1.85:1 frame.
71 - Flat: 1.85:1 images to the DCI spec.
72 - Scope: 2.39:1 images to the DCI spec.
73
74
75 Server/client
76 -------------
77
78 Running the `servomatic' program on a remote machine will make it
79 listen on port 6192 (by default) and process requests from a dvdomatic
80 instance.  This has been written with no thought to security, so don't
81 do it over the public internet!  The connection will probably need to
82 be 1 Gb/s to make it worthwhile.
83
84 To tell the client about available servers you will need to go to
85 Edit->Preferences and add the server's IP address and the number of
86 parallel threads that the server should execute (make it equal to the
87 number of CPUs or cores).
88
89
90
91 Problems
92 --------
93
94 Email me at cth@carlh.net in the first instance.
95
96
97 Carl Hetherington
98 August 2012