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