db19cfd9eb95923ddabcd0fd6f6e356752941be4
[dcpomatic.git] / doc / manual / dvdomatic.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book [
3 <!ENTITY % sgml.features "IGNORE">
4 <!ENTITY % xml.features "INCLUDE">
5 <!ENTITY % dbcent PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN"
6    "/usr/share/xml/docbook/schema/dtd/4.5/dbcentx.mod">
7 %dbcent;
8 <!ENTITY % extensions SYSTEM "extensions.ent">
9 %extensions;
10 ]>
11 <book xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
12
13 <bookinfo>
14 <title>DVD-o-matic</title>
15 <author><firstname>Carl</firstname><surname>Hetherington</surname></author>
16 </bookinfo>
17
18 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
19 <title>Introduction</title>
20
21 <para>
22 Hello, and welcome to DVD-o-matic!
23 </para>
24
25 <section>
26 <title>What is DVD-o-matic?</title>
27
28 <para>
29 DVD-o-matic is a program to generate <ulink
30 url="http://en.wikipedia.org/wiki/Digital_Cinema_Package">Digital
31 Cinema Packages</ulink> (DCPs) from DVDs, Blu-Rays, video files such as MP4
32 and AVI, or still images.  The resulting DCPs will play on modern digital
33 cinema projectors.
34 </para>
35
36 <para>
37 You might find it useful to make DVDs easier to present, to encode
38 independently-shot feature films, or to generate local advertising for
39 your cinema.
40 </para>
41
42 </section>
43
44 <section>
45 <title>Licence</title>
46
47 <para>
48 DVD-o-matic is licensed under the <ulink url="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU GPL</ulink>.
49 </para>
50
51 </section>
52
53 </chapter>
54
55 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
56 <title>Installation</title>
57
58 <section>
59 <title>Windows</title>
60
61 <para>
62 To install DVD-o-matic on Windows, simply download the installer from
63 <ulink url="http://carlh.net/software/dvdomatic">http://carlh.net</ulink>
64 and double-click it.  Click through the installer wizard, and
65 DVD-o-matic will be installed onto your machine.
66 </para>
67
68 <para>
69 If you are using a 32-bit version of Windows, you will need the 32-bit
70 installer.  For 64-bit Windows, either installer will work, but I
71 suggest you used the 64-bit version as it will allow DVD-o-matic to
72 use more memory.  You may find that DVD-o-matic crashes if you run
73 many parallel encoding threads (more than 4) on the 32-bit
74 version.
75 </para>
76
77 </section>
78
79 <section>
80 <title>Ubuntu Linux</title>
81
82 <para>
83 You can install DVD-o-matic on Ubuntu 12.04 (&lsquo;Precise
84 Pangolin&rsquo;) or 12.10 (&lsquo;Quantal Quetzal&rsquo;) using
85 <code>.deb</code> packages: download the appropriate package from
86 <ulink
87 url="http://carlh.net/software/dvdomatic">http://carlh.net</ulink> and
88 double-click it.  Ubuntu will install the necessary bits and pieces
89 and set DVD-o-matic up for you.
90 </para>
91
92 </section>
93
94 <section>
95 <title>Other Linux distributions</title>
96
97 <para>
98 Installation on non-Ubuntu Linux is currently a little involved, as
99 there are no packages available (yet); you will have to compile it
100 from source.  If you are using a non-Ubuntu distribution, do let me
101 know via the <ulink url="mailto:dvdomatic@carlh.net">mailing
102 list</ulink> and I will see about building some packages.
103 </para>
104
105 <para>
106 The following dependencies are required:
107 <itemizedlist>
108 <listitem><ulink url="http://ffmpeg.org/">FFmpeg</ulink></listitem>
109 <listitem><ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink></listitem>
110 <listitem><ulink url="http://www.openssl.org/">OpenSSL</ulink></listitem>
111 <listitem><ulink url="http://www.openjpeg.org/">libopenjpeg</ulink></listitem>
112 <listitem><ulink url="http://www.imagemagick.org/script/index.php">ImageMagick</ulink></listitem>
113 <listitem><ulink url="http://www.boost.org/">Boost</ulink></listitem>
114 <listitem><ulink url="http://www.libssh.org/">libssh</ulink></listitem>
115 <listitem><ulink url="http://www.gtk.org/">GTK</ulink></listitem>
116 <listitem><ulink url="http://www.wxwidgets.org/">wxWidgets</ulink></listitem>
117 <listitem><ulink url="http://carlh.net/software/libdcp/">libdcp</ulink></listitem>
118 </itemizedlist>
119 </para>
120
121 <para>
122 Once you have installed the development packages for the dependencies,
123 download the source code from <ulink
124 url="http://carlh.net/software/dvdomatic">http://carlh.net</ulink>,
125 unpack it and run the following commands from inside the source
126 directory:
127 </para>
128
129 <programlisting>
130 ./waf configure
131 ./waf build
132 sudo ./waf install
133 </programlisting>
134
135 <para>
136 With any luck, this will build and install DVD-o-matic on your system.  To run it, enter:
137 </para>
138
139 <programlisting>
140 dvdomatic
141 </programlisting>
142
143 <para>
144 in a shell.
145 </para>
146
147 </section>
148 </chapter>
149
150 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
151 <title>Creating a video DCP</title>
152
153 <para>
154 In this chapter we will see how to create a video DCP using
155 DVD-o-matic.  We will gloss over some of the finer details, which are
156 explained in later chapters.
157 </para>
158
159 <section>
160 <title>Creating a new film</title>
161
162 <para>
163 Let's make a very simple DCP to see how DVD-o-matic works.  First, we
164 need some content.  Download the low-resolution trailer for the open
165 movie <ulink url="http://sintel.org/">Sintel</ulink> from <ulink
166 url="http://ftp.nluug.nl/ftp/graphics/blender/apricot/trailer/Sintel_Trailer1.480p.DivX_Plus_HD.mkv">their
167 website</ulink>.  Generally, of course, one would want to use the
168 highest-resolution material available, but for this test we will use
169 the low-resolution version to save everyone's bandwidth bills.
170 </para>
171
172 <para>
173 Now, start DVD-o-matic and its window will open.  First, we will
174 create a new &lsquo;film&rsquo;.  A &lsquo;film&rsquo; is how DVD-o-matic refers to
175 a piece of content, along with some settings, which we will make into
176 a DCP.  DVD-o-matic stores its data in a folder on your disk while it
177 creates the DCP.  You can create a new film by selecting
178 <guilabel>New</guilabel> from the <guilabel>File</guilabel> menu, as
179 shown in <xref linkend="fig-file-new"/>.
180 </para>
181
182 <figure id="fig-file-new"> 
183   <title>Creating a new film</title> 
184   <mediaobject>
185     <imageobject> 
186       <imagedata fileref="screenshots/file-new&scs;"/>
187     </imageobject> 
188   </mediaobject>
189 </figure>
190
191 <para>
192 This will open a dialogue box for the new film, as shown in <xref
193 linkend="fig-video-new-film"/>.
194 </para>
195
196 <figure id="fig-video-new-film"> 
197   <title>Dialogue box for creating a new film</title> 
198   <mediaobject>
199     <imageobject> 
200       <imagedata fileref="screenshots/video-new-film&scs;"/>
201     </imageobject> 
202   </mediaobject>
203 </figure>
204
205 <para>
206 In this dialogue box you can choose a name for the film.  This will be
207 used to name the folder to store its data in, and also as the initial
208 name for the DCP itself.  You can also choose whereabouts you want to create
209 the film.  In the example from the figure, DVD-o-matic will create a
210 folder called &lsquo;DCP Test&rsquo; inside my home folder (carl) into which it
211 will write its working files.
212 </para>
213
214 <para>
215 If you always create your DCPs in a particular folder, you can use
216 DVD-o-matic's <guilabel>Preferences</guilabel> to make life a little
217 easier by setting the default folder that DVD-o-matic will offer in this dialogue.
218 See <xref linkend="ch-preferences"/>.
219 </para>
220
221 </section>
222
223 <section>
224 <title>Selecting content</title>
225
226 <para>
227 The next step is to set the content that you want to use.  Click the
228 content selector, as shown in <xref
229 linkend="fig-click-content-selector"/>, and a file chooser will
230 open for you to select the content file to use, as shown in <xref
231 linkend="fig-video-select-content-file"/>.
232 </para>
233
234 <figure id="fig-click-content-selector">
235   <title>Opening the content selector</title> 
236   <mediaobject>
237     <imageobject> 
238       <imagedata fileref="screenshots/click-content-selector&scs;"/>
239     </imageobject> 
240   </mediaobject>
241 </figure>
242
243 <figure id="fig-video-select-content-file"> 
244   <title>Selecting a video content file</title> 
245   <mediaobject>
246     <imageobject> 
247       <imagedata fileref="screenshots/video-select-content-file&scs;"/>
248     </imageobject> 
249   </mediaobject>
250 </figure>
251
252 <para>
253 Select your content file and click <guilabel>Open</guilabel>.  In this
254 case we are using the Sintel trailer that we downloaded earlier.
255 </para>
256
257 <para>
258 When you do this, DVD-o-matic will take a look at your file.  After a
259 short while (when the progress bar at the bottom right of the window
260 has finished), you can look through your content using the slider to
261 the right of the window, as shown in <xref linkend="fig-examine-thumbs"/>.
262 </para>
263
264 <figure id="fig-examine-thumbs"> 
265   <title>Examining the content</title>
266   <mediaobject>
267     <imageobject> 
268       <imagedata fileref="screenshots/examine-thumbs&scs;"/>
269     </imageobject> 
270   </mediaobject>
271 </figure>
272
273 <para>
274 Dragging the slider will move through your video.  You can also click
275 the <guilabel>Play</guilabel> button to play the content back.  Note
276 that there will be no sound, and playback might not be entirely
277 accurate (it may be slightly slower or faster than it should be, for
278 example).  This player is really only intended for brief inspection of
279 content; if you need to check it more thoroughly, use another player
280 such as Totem, mplayer or VLC.
281 </para>
282
283 </section>
284
285 <section>
286 <title>Setting up</title>
287
288 <para>
289 Now there are a few things to set up to describe how the DCP should be
290 created.  The settings are divided into four tabs: film, video, audio and subtitles.
291 </para>
292
293 <section>
294 <title>Film tab</title>
295
296 <para>
297 The &lsquo;film&rsquo; tab contains settings that pertain to the whole film, as shown in <xref linkend="fig-film-tab"/>.
298 </para>
299
300 <figure id="fig-film-tab"> 
301   <title>Film settings tab</title>
302   <mediaobject>
303     <imageobject> 
304       <imagedata fileref="screenshots/film-tab&scs;"/>
305     </imageobject> 
306   </mediaobject>
307 </figure>
308
309 <para>
310 The first thing here is the name.  This is generally set to the title
311 of the film that is being encoded.  If <guilabel>Use DCI
312 name</guilabel> is not ticked, the name that you specify will be used
313 as-is for the name of the DCP.  If <guilabel>Use DCI name</guilabel>
314 is ticked, the name that you enter will be used as part of a
315 DCI-compliant name.
316 </para>
317
318 <para>
319 Underneath the name field is a preview of the name that the DCP will
320 get.  To use a DCI-compliant name, tick the <guilabel>Use DCI
321 name</guilabel> checkbox.  The DCI name will be composed using details
322 of your content's soundtrack, the current date and other things that
323 can be specified in the DCI name details dialogue box, which you can
324 open by clicking on the <guilabel>Details</guilabel> button.
325 </para>
326
327 <para>
328 The <guilabel>Trust content's header</guilabel> button starts off
329 checked, and this means that DVD-o-matic will use the content's header
330 information to determine its length.  If, for some reason, this header
331 length is wrong, uncheck the <guilabel>Trust content's
332 header</guilabel> button and DVD-o-matic will run through the content
333 to find its exact length.  This may take a while for large pieces of content.
334 </para>
335
336 <para>
337 Next up is the content type.  This can be
338 &lsquo;feature&rsquo;, &lsquo;trailer&rsquo; or whatever; select the
339 required type from the drop-down list.
340 </para>
341
342 <para>
343 The <guilabel>trim frames</guilabel> settings allow you to trim frames
344 from the beginning and end of the content; any trimmed frames will not
345 be included in the DCP.
346 </para>
347
348 </section>
349
350 <section>
351 <title>Video tab</title>
352
353 <para>
354 This tab contains settings related to the picture in your DCP, as shown in <xref linkend="fig-video-tab"/>.
355 </para>
356
357 <figure id="fig-video-tab"> 
358   <title>Video settings tab</title>
359   <mediaobject>
360     <imageobject> 
361       <imagedata fileref="screenshots/video-tab&scs;"/>
362     </imageobject> 
363   </mediaobject>
364 </figure>
365
366 <para>
367 The first option on this tab is the format.  This will govern the
368 shape that DVD-o-matic will make your image into.  Select the aspect
369 ratio that your content should be presented in.  The &lsquo;4:3 within
370 Flat&rsquo; and &lsquo;16:9 within Flat&rsquo; settings will put the
371 image at the specified ratio within a Flat (1.85:1) frame, so that you
372 can project the DCP using your projector's Flat preset.
373 </para>
374
375 <para>
376 The remaining options can often be left alone, but may sometimes be
377 useful.  The &lsquo;crop&rsquo; settings can be used to crop your
378 content, which can be used to remove black borders from round the
379 edges of DVD images, for example.  The <guilabel>L</guilabel>,
380 <guilabel>R</guilabel>, <guilabel>T</guilabel> and
381 <guilabel>B</guilabel> settings correspond to the left, right, top and
382 bottom of the image respectively.  The specified number of pixels will
383 be trimmed from each edge, and the content image in the right of the
384 window will be updated to show the cropping in action.
385 </para>
386
387 <para>
388 The &lsquo;filters&rsquo; settings allow you to apply various video
389 filters to the image.  These may be useful to try to improve
390 poor-quality sources like DVDs.  We will discuss filtering later in the manual.
391 <!-- XXX: link -->
392 </para>
393
394 <para>
395 The &lsquo;scaler&rsquo; is the method that will be used to scale up
396 your content to the required size for the DCP, if required.  We will
397 discuss the options in more detail later; Bicubic is a fine choice in
398 most situations.
399 <!-- XXX: link -->
400 </para>
401
402 </section>
403
404 <section>
405 <title>Audio tab</title>
406
407 <para>
408 This tab contains settings related to the sound in your DCP, as shown in <xref linkend="fig-audio-tab"/>.
409 </para>
410
411 <figure id="fig-audio-tab"> 
412   <title>Audio settings tab</title>
413   <mediaobject>
414     <imageobject> 
415       <imagedata fileref="screenshots/audio-tab&scs;"/>
416     </imageobject> 
417   </mediaobject>
418 </figure>
419
420
421 <para>
422 &lsquo;Audio Gain&rsquo; is used to alter the volume of the
423 soundtrack.  The specified gain (in dB) will be applied to each sound
424 channel before it is written to the DCP.
425 </para>
426
427 <para>
428 If you use a sound processor that DVD-o-matic knows about, it can help
429 you calculate changes in gain that you should apply.  Say, for
430 example, that you make a test DCP and find that you have to run it at
431 volume 5 instead of volume 7 to get a good sound level in the screen.
432 If this is the case, click the <guilabel>Calculate...</guilabel>
433 button next to the audio gain entry, and the dialogue box in <xref
434 linkend="fig-calculate-audio-gain"/> will open.
435 </para>
436
437 <figure id="fig-calculate-audio-gain"> 
438   <title>Calculating audio gain</title>
439   <mediaobject>
440     <imageobject> 
441       <imagedata fileref="screenshots/calculate-audio-gain&scs;"/>
442     </imageobject> 
443   </mediaobject>
444 </figure>
445
446 <para>
447 For our example, put 5 in the first box and 7 in the second and click
448 <guilabel>OK</guilabel>.  DVD-o-matic will calculate the audio gain
449 that it should apply to make this happen.  Then you can re-make the
450 DCP (this will be reasonably fast, as the video data will already have
451 been done) and it should play back at the correct volume with 7 on
452 your sound-rack fader.
453 </para>
454
455 <para>
456 Current versions of DVD-o-matic only know about the Dolby CP750.  If
457 you use a different sound processor, and know the gain curve of its
458 volume control, <ulink url="mailto:cth@carlh.net">get in
459 touch</ulink>.
460 </para>
461
462 <para>
463 &lsquo;Audio Delay&rsquo; is used to adjust the synchronisation
464 between audio and video.  A positive delay will move the audio later
465 with respect to the video, and a negative delay will move it earlier.
466 </para>
467
468 <para>
469 By default the <guilabel>Use content&lsquo;s audio</guilabel> button
470 will be selected.  This means that the DCP will use one of the
471 soundtracks from your content file; you can select the soundtrack that
472 you wish to use from the drop-down box.
473 </para>
474
475 <para>
476 Alternatively, you can supply different sound files by clicking the
477 <guilabel>Use external audio</guilabel> button and choosing a WAV file
478 for any channels that you want to appear in the DCP.  These files can
479 be any bit depth and sampling rate, and will be re-sampled and
480 bit-depth converted if required.
481 </para>
482
483 </section>
484 <section>
485 <title>Subtitles tab</title>
486
487 <para>
488 This tab contains settings related to subtitles in your DCP, as shown in <xref linkend="fig-subtitles-tab"/>.
489 </para>
490
491 <figure id="fig-subtitles-tab"> 
492   <title>Subtitle settings tab</title>
493   <mediaobject>
494     <imageobject> 
495       <imagedata fileref="screenshots/subtitles-tab&scs;"/>
496     </imageobject> 
497   </mediaobject>
498 </figure>
499
500 <para>
501 DVD-o-matic will extract subtitles from the content, if present, and
502 they can be &lsquo;burnt into&rsquo; the DCP (that is, they are
503 included in the image and not overlaid by the projector).  Note that
504 DVD and Blu-Ray subtitles are stored as bitmaps, so it is not possible
505 (automatically) to use non-burnt-in subtitles with these sources.
506 Select the <guilabel>With Subtitles</guilabel> checkbox to enable
507 subtitles.  The <guilabel>offset</guilabel> control moves the
508 subtitles up and down the image, and the <guilabel>scale</guilabel>
509 control changes their size.
510 </para>
511
512 <para>
513 Future versions of DVD-o-matic will hopefully include the option to
514 use text subtitles (as is the norm with most professionally-mastered
515 DCPs).
516 </para>
517
518 </section>
519 </section>
520
521 <section>
522 <title>Making the DCP</title>
523
524 <para>
525 Now that we have set everything up, choose <guilabel>Make
526 DCP</guilabel> from the <guilabel>Jobs</guilabel> menu.  DVD-o-matic
527 will encode your DCP.  This may take some time (many hours in some
528 cases).  While the job is in progress, DVD-o-matic will update you on
529 how it is getting on with the progress bar in the bottom right hand
530 corner of its window, as shown in <xref linkend="fig-making-dcp"/>.
531 </para>
532
533 <figure id="fig-making-dcp">
534   <title>Making the DCP</title>
535   <mediaobject>
536     <imageobject> 
537       <imagedata fileref="screenshots/making-dcp&scs;"/>
538     </imageobject> 
539   </mediaobject>
540 </figure>
541
542 <para>
543 When it has finished, the DCP will end up on your disk inside the
544 film's directory.  You can then copy this to a projector via a USB
545 stick, hard-drive or network connection.
546 </para>
547
548 <para>
549 Alternatively, if you have a projector or TMS that is accessible via
550 SCP across your network, you can upload the content directly from
551 DVD-o-matic.  See <xref linkend="sec-tms-upload"/>.
552 </para>
553
554 </section>
555 </chapter>
556
557
558 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
559 <title>Creating a still-image DCP</title>
560
561 <para>
562 DVD-o-matic can also be used to create DCPs of a still image, perhaps
563 for an advertisement or an on-screen announcement.  This chapter shows you
564 how to do it.
565 </para>
566
567 <para>
568 As with video DCPs, the first step is to create a new
569 &lsquo;Film&rsquo;; select <guilabel>New</guilabel> from the
570 <guilabel>File</guilabel> menu and the new film dialogue will open as
571 shown in <xref linkend="fig-still-new-film"/>.
572 </para>
573
574 <figure id="fig-still-new-film"> 
575   <title>Dialogue box for creating a new film</title> 
576   <mediaobject>
577     <imageobject> 
578       <imagedata fileref="screenshots/still-new-film&scs;"/>
579     </imageobject> 
580   </mediaobject>
581 </figure>
582
583 <para>
584 Enter a name and click <guilabel>OK</guilabel>.  Then we set up the
585 content; click the content selector as before, and this time we will
586 choose an image file, as shown in <xref
587 linkend="fig-still-select-content-file"/>.
588 </para>
589
590 <figure id="fig-still-select-content-file"> 
591   <title>Selecting a still content file</title> 
592   <mediaobject>
593     <imageobject> 
594       <imagedata fileref="screenshots/still-select-content-file&scs;"/>
595     </imageobject> 
596   </mediaobject>
597 </figure>
598
599 <para>
600 Setting up for a still image DCP is somewhat simpler than for a video;
601 the tabs are all the same, but many options are removed and a few are added.
602 </para>
603
604 <para>
605 As with video, you can select a content type and the format (ratio)
606 that your image should be presented in.  It will be scaled and padded
607 to fit the selected ratio, but in such a way that the pixel aspect
608 ratio is preserved.  In other words, the image will not be stretched,
609 merely scaled; if you want to stretch your image, you will need to do
610 so in a separate program before importing it into DVD-o-matic.  You
611 can also crop your image, if you so choose, and then set a duration
612 (in seconds) that the image should appear on screen.
613 </para>
614
615 <para>
616 Still-image DCPs can include sound; this can be added from the
617 <guilabel>Audio</guilabel> tab.  If your specified duration is shorter
618 than the audio, the audio will be cut off at the duration; if it is
619 longer, silence will be added after your audio.
620 </para>
621
622 <para>
623 Finally, as with video, you can choose <guilabel>Make DCP</guilabel>
624 from the <guilabel>Jobs</guilabel> menu to create your DCP.  This will
625 be much quicker than creating a video DCP, as DVD-o-matic only needs
626 to encode a single frame which it can then repeat.
627 </para>
628
629 </chapter>
630
631
632 <chapter xml:id="ch-preferences" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
633 <title>Preferences</title>
634
635 <para>
636 DVD-o-matic provides a few preferences which can be used to modify its
637 behaviour.  This chapter explains those options.
638 </para>
639
640 <section>
641 <title>The preferences dialogue</title>
642
643 <para>
644 The preferences dialogue is opened by choosing
645 <guilabel>Preferences...</guilabel> from the <guilabel>Edit</guilabel>
646 menu.  The dialogue is shown in <xref linkend="fig-prefs"/>.
647 </para>
648
649 <figure id="fig-prefs"> 
650   <title>Preferences</title> 
651   <mediaobject>
652     <imageobject> 
653       <imagedata fileref="screenshots/prefs&scs;"/>
654     </imageobject> 
655   </mediaobject>
656 </figure>
657
658 <section>
659 <title>TMS setup</title>
660
661 <para>
662 The first part of the dialogue gives some options for specifying
663 details about your TMS.  If you do this, and your TMS accepts SSH
664 connections, you can upload DCPs directly from DVD-o-matic to the TMS.
665 This is discussed in <xref linkend="sec-tms-upload"/>.
666 </para>
667
668 <para>
669 <guilabel>TMS IP address</guilabel> should be set to the IP address of
670 your TMS, <guilabel>TMS target path</guilabel> to the place that DCPs
671 should be uploaded to (which will be relative to the home directory of
672 the SSH user).  Finally, the user name and password are the
673 credentials required to log into the TMS via SSH.
674 </para>
675 </section>
676
677 <section>
678 <title>Threads</title>
679
680 <para>
681 When DVD-o-matic is encoding DCPs it can use multiple parallel threads
682 to speed things up.  Set this value to the number of threads
683 DVD-o-matic should use.  This would typically be set to the number of
684 processors (or processor cores) in your machine.
685 </para>
686
687 </section>
688
689 <section>
690 <title>Default directory for new films</title>
691
692 <para>
693 This is the directory which DVD-o-matic will suggest initially as a place to put new films.
694 </para>
695
696 </section>
697
698 <section>
699 <title>Colour look-up table</title>
700
701 <para>
702 This specifies the colour space that your input content will be
703 expected to be in.  If in doubt, leave it set to &lsquo;sRGB&rsquo;.
704 </para>
705
706 </section>
707
708 <section>
709 <title>A/B options</title>
710
711 <para>
712 These options are for DVD-o-matic's special mode of making A/B
713 comparison DCPs for checking the performance of video filters.  Their
714 use is described in <xref linkend="sec-ab"/>.
715 </para>
716
717 </section>
718
719 <section>
720 <title>Encoding servers</title>
721
722 <para>
723 If you have spare machines sitting around on your network not doing
724 much, they can be pressed into service to speed up DCP encodes.  This
725 is done by running a small server program on the machine, which will
726 encode video sent to it by the &lsquo;master&rsquo; DVD-o-matic.  This
727 option is described in more detail in <xref linkend="sec-servers"/>.
728 Use these preferences to specify the encoding servers that should be
729 used.
730 </para>
731
732 </section>
733
734 </section>
735 </chapter>
736
737 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en">
738 <title>Advanced topics</title>
739
740 <para>This chapter describes some parts of DVD-o-matic that are
741 probably not essential, but which you might find useful in some
742 circumstances.
743 </para>
744
745 <section>
746 <title>Filtering</title>
747
748 <para>
749 DVD-o-matic offers a variety of filters that can be applied to your
750 video content.  You can set up the filters by clicking the
751 <guilabel>Edit</guilabel> button next to the filters entry in the
752 setup area of the DVD-o-matic window; this opens the filters selector
753 as shown in <xref linkend="fig-filters"/>.
754 </para>
755
756 <figure id="fig-filters"> 
757   <title>Filters selector</title> 
758   <mediaobject>
759     <imageobject> 
760       <imagedata fileref="screenshots/filters&scs;"/>
761     </imageobject> 
762   </mediaobject>
763 </figure>
764
765 <para>
766 As it stands, these filters are somewhat disorganised!  Work is
767 ongoing to test them with various content and choose a selection which
768 work well for cinema applications.
769 </para>
770
771 <para>
772 If you want to examine them yourself, you may find the A/B option (see
773 <xref linkend="sec-ab"/>) useful.
774 </para>
775
776 <para>
777 After changing the filters setup, you will need to regenerate the DCP
778 to see the effect on the cinema screen.  The preview in DVD-o-matic
779 will update itself whenever filters are changed, though of course this
780 image is much smaller and of lower resolution than a projected image!
781 </para>
782
783 </section>
784
785 <section>
786 <title>Scaling</title>
787
788 <para>
789 If your source material is not of the DCI-specified size, or if it
790 uses non-square pixels, DVD-o-matic will need to scale it.  The
791 algorithm used to scale is set up by the <guilabel>Scaler</guilabel>
792 entry in the film setup area.  We think &lsquo;Bicubic&rsquo; is the
793 best all-round option, but tests are ongoing.
794 </para>
795
796 </section>
797
798 <section xml:id="sec-tms-upload">
799 <title>TMS upload</title>
800
801 <para>
802 If you have configured details of a TMS in the preferences dialogue
803 (<xref linkend="ch-preferences"/>) you can upload a completed DCP
804 straight to your TMS buy choosing <guilabel>Send DCP to TMS</guilabel>
805 from the <guilabel>Jobs</guilabel> menu.
806 </para>
807
808 </section>
809
810
811 <section xml:id="sec-ab">
812 <title>A/B comparison</title>
813
814 <para>
815 When evaluating the effects of different filters or scalers on the
816 image quality, A/B mode might be useful.  In this mode, DVD-o-matic
817 will generate a DCP where the left half of the image uses some
818 &lsquo;reference&rsquo; filtering and scaling, and the right half of
819 the image uses a different set of filters and a different scaler.
820 This DCP can then be played back on a projector and the image quality
821 evaluated.
822 </para>
823
824 <para>
825 To enable A/B mode, click the A/B checkbox in the setup area of the
826 DVD-o-matic window.  When you generate your DCP, the left half of the
827 screen will use the filters and scaler specified in the <xref
828 linkend="ch-preferences">preferences</xref> dialogue, and the right
829 half will use the filters and scaler specified in the film setup.
830 </para>
831
832 </section>
833
834 <section xml:id="sec-servers">
835 <title>Encoding servers</title>
836
837 <para>
838 One way to increase the speed of DCP encoding is to use more
839 than one machine at the same time.  An instance of DVD-o-matic can
840 offload some of the time-consuming JPEG2000 encoding to any number of
841 other machines on a network.  To do this, one &lsquo;master&rsquo;
842 machine runs DVD-o-matic, and the &lsquo;server&rsquo; machines run
843 a small program called &lsquo;servomatic&rsquo;.
844 </para>
845
846 <section>
847 <title>Running the servers</title>
848
849 <para>
850 There are two options for the encoding server;
851 <code>servomatic_cli</code>, which runs on the command line, and
852 <code>servomatic_gui</code>, which has a simple GUI.  The command line
853 version is well-suited to headless servers, especially on Linux, and
854 the GUI version works best on Windows where it will put an icon in the
855 system tray.
856 </para>
857
858 <para>
859 To run the command line version, simply enter:
860 </para>
861
862 <programlisting>
863 servomatic_cli
864 </programlisting>
865
866 <para>
867 at a command prompt.  If you are running the program on a machine with
868 a multi-core processor, you can run multiple parallel encoding threads
869 by doing something like:
870 </para>
871
872 <programlisting>
873 servomatic_cli -t 4
874 </programlisting>
875
876 <para>
877 to run 4 threads in parallel.
878 </para>
879
880 <para>
881 To run the GUI version on windows, run the &lsquo;DVD-o-matic encode
882 server&rsquo; from the start menu.  An icon will appear in the system
883 tray; right-click it to open a menu from whence you can quit the
884 server or open a window to show its status.
885 </para>
886
887 </section>
888 <section>
889 <title>Setting up DVD-o-matic</title>
890
891 <para>
892 Once your servers are running, you need to tell your master
893 DVD-o-matic instance about them.  Start DVD-o-matic and open the
894 <guilabel>Preferences</guilabel> dialog from the
895 <guilabel>Edit</guilabel> menu.  At the bottom of this dialog is a
896 section where you can add, edit and remove encoding servers.  For each
897 encoding server you need only specify its IP address and the number of
898 threads that it is running, so that DVD-o-matic knows how many
899 parallel encode jobs to send to the server.
900 </para>
901
902 <para>
903 Once this is done, any encodes that you start will split the workload
904 up between the master machine and the servers.
905 </para>
906
907 </section>
908 <section>
909 <title>Some notes about encode servers</title>
910
911 <para>
912 DVD-o-matic does not mind if servers come and go; if a server
913 disappears, DVD-o-matic will stop sending work to it, and will check
914 it every minute or so in case it has come back online.
915 </para>
916
917 <para>
918 You will probably find that using a 1Gb/s or faster network will
919 provide a significant speed-up compared to a 100Mb/s network.
920 </para>
921
922 <para>
923 Making changes to the server configuration in the master DVD-o-matic
924 will have no effect while an encode is running; the changes will only
925 be noticed when a new encode is started.
926 </para>
927
928 </section>
929 </section>
930
931 </chapter>
932
933
934 </book>