X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fmanual%2Fdcpomatic.xml;h=f56c005d68bcd492acf2445ecedddd543bacdb53;hb=25043fac5a810cc7d906f1b3d88d0ae90f2a2299;hp=1ee817b5d6171ad75c8870657c0fc33e1dc05fdd;hpb=8433b9097fb44a965b47f8a8f40bc49fc8d2913e;p=dcpomatic.git diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 1ee817b5d..f56c005d6 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -107,7 +107,8 @@ version. If you are still using Windows XP, download the specific XP version as it should be more stable on your machine than the ‘normal’ -Windows version. +Windows version. Be aware, though, that support for Windows XP will +not last forever and you should plan to upgrade if at all possible. @@ -224,7 +225,7 @@ directory: -./waf configure +./waf configure --disable-tests ./waf build sudo ./waf install @@ -240,11 +241,40 @@ dcpomatic2 in a shell. + + + +
+‘Simple’ and ‘Full’ modes + +When you start DCP-o-matic for the first time it will ask you if +you want to use ‘simple’ or ‘full’ mode. + + +The difference between these two is that some of DCP-o-matic's +more complex or less-used controls are hidden from view in +‘Simple’ mode. This makes the interface simpler to +navigate. You may wish to choose this mode if you do not have much +experience with video processing. + + +Even if you choose ‘Simple’ mode you can always go +back to ‘Full’ mode by changing the Interface +complexity setting in the General tab +of Preferences. + + + +All the screenshots in this manual are from a copy of DCP-o-matic in ‘Full’ mode. +
+ + + Creating a DCP from a video @@ -496,25 +526,25 @@ to encode a single frame which it can then repeat. - + Manipulating existing DCPs -Frequently DCP-o-matic is used to take content in formats such as MP4 -and convert it to JPEG2000 for a DCP. It can also be used -to take existing DCPs and modify them in various ways. +DCP-o-matic is often used to take content in formats such as MP4 and +make it into a DCP. It can also be used to take existing DCPs and +modify them in various ways.
Importing a DCP into DCP-o-matic -If you want to do something to an existing DCP the first step is to -import it. Click Add DCP... and select your -DCP's folder. It will be added to the DCP-o-matic project. If the -DCP is unencrypted you can preview it in the normal way, though -playback will be very slow as decoding of DCPs is almost as -computationally intensive as encoding them. +The first step in manipulating an existing DCP is to import it. Click +Add DCP... and select your DCP's folder. It will +be added to the DCP-o-matic project. If the DCP is unencrypted you +can preview it in the normal way, though playback will be slow as +decoding of DCPs is almost as computationally intensive as encoding +them. @@ -602,8 +632,8 @@ the following content settings: -If you do change any of these settings on a piece of DCP content -DCP-o-matic will decode and then re-encode the JPEG2000 data. +DCP-o-matic will be forced to decode and re-encode your JPEG2000 data +if you change any of these settings on a piece of DCP content.
@@ -989,7 +1019,7 @@ linkend="tab-colour-conversion"/>. -sRGBStill images in RGB, e.g. photographs. +sRGBStill images in RGB, e.g. photographs. Rec. 601Standard-definition content (fewer than about 1000 pixels across) including DVD rips. @@ -1276,29 +1306,37 @@ with respect to the video, and a negative delay will move it earlier.
-Subtitles +Timed text (subtitles and closed captions) -The subtitles tab contains settings related to subtitles in your -content, as shown in . +The timed text tab contains settings related to subtitles and closed captions in your +content, as shown in . -
- Subtitle settings tab +
+ Timed text settings tab - +
+ +Depending on where timed text comes from it can sometimes be used as +either an open subtitle (to be overlaid onto the cinema screen and so +seen by everybody) or as a closed caption (to be displayed to +individual viewers using a special system such as the Doremi +CaptiView™) + + DCP-o-matic can either: - Extract subtitles that are embedded in video files, or - Use subtitles from SubRip (.srt), SubStation + Extract timed text that is embedded in video files, or + Use timed text from SubRip (.srt), SubStation Alpha (.ssa or .ass) or DCP XML files. You may find the great free program Subtitle Edit useful @@ -1306,15 +1344,18 @@ DCP-o-matic can either: -Embedded subtitles are usually represented using a set of bitmaps, -especially on files that have come from DVD or BluRay. Such subtitles -can (currently) only be ‘burnt’ into the DCP (that is, -they are included in the image and not overlaid by the projector). +Embedded timed text is usually represented using a set of bitmaps, +especially on files that have come from DVD or BluRay. Such text can +be used as a subtitle, but not a closed caption (since the closed +captioning system requires the text to be delivered as +character codes rather than an image). +In contrast, SubRip, SubStation Alpha or DCP text can be used as either a subtitle or a closed caption. + -With SubRip, SubStation Alpha or DCP subtitles you have the choice to -either burn-in or include the subtitles as separate subtitle +With subtitles you have the further choice of whether to burn the +subtitles into the image or include them as a separate subtitle ‘asset’ within your DCP (in which case the projector overlays them onto the image on playback). The difference between burn-in and overlay is illustrated by @@ -1349,42 +1390,44 @@ every language. -Select the Use Subtitles check-box to enable -the subtitles in the selected content. +Select the Use as check-box to enable the timed +text in the selected content, then choose what you want to use the +text for: open subtitles or closed captions. Select the Burn subtitles into image check-box to -burn these subtitles into the image; if this is not ticked the +burn subtitles into the image; if this is not ticked the subtitles will be included separately in the DCP to be rendered by the -projector. This check-box will always be ticked if you are using -embedded ‘image’ subtitles. +projector. The X Offset and Y Offset -controls move the subtitles around within the image. The offsets are -expressed as a percentage of the video frame size; 100% X offset is -the entire width of the frame, and 100% Y offset is the entire height. -Hence, to move the subtitles down by half the frame height you would -use a Y offset of 50%. +controls move subtitles around within the image. These controls have +no effect for closed captions. The offsets are expressed as a +percentage of the video frame size; 100% X offset is the entire width +of the frame, and 100% Y offset is the entire height. Hence, to move +the subtitles down by half the frame height you would use a Y offset +of 50%. The X Scale and Y Scale -controls scale the subtitles. Scale values of 1 make the subtitles -the same size (relative to the size of the image) as they are on the -original. Values lower than 1 make them smaller, and values higher -make them larger. You can stretch the subtitles in either direction -by specifying different values for X and Y scale. Subtitles from DVD -and Blu Ray sources are frequently larger (relative to the video -frame) than those typically used for DCP, so it is often useful to -scale such subtitles down using these controls. +controls scale subtitles. These controls have no effect for closed +captions. Scale values of 1 make the subtitles the same size +(relative to the size of the image) as they are on the original. +Values lower than 1 make them smaller, and values higher make them +larger. You can stretch the subtitles in either direction by +specifying different values for X and Y scale. Subtitles from DVD and +Blu Ray sources are frequently larger (relative to the video frame) +than those typically used for DCP, so it is often useful to scale such +subtitles down using these controls. The Line spacing control adjusts the line spacing -of the subtitles. This only works for non-embedded (text) subtitles. +of the subtitles. This only works for subtitles that did not come from bitmaps. @@ -1393,14 +1436,17 @@ that is used when the content has more than one. -If you are using non-embedded (text) subtitles you can see the +If you are using non-image (text) subtitles or closed captions you can see the subtitle text and timings by clicking the View... button, or specify the fonts that should be used by clicking Fonts.... With any subtitles you can click Appearance... to -change how the subtitles look. +change how the subtitles look. Some of the controls in the +Apperance only apply to burnt-in subtitles, as +only limited control is available for subtitles rendered by the +projection system.
@@ -1490,6 +1536,54 @@ any changes to the corresponding timecode. + +
+ Timeline + + + The timeline window gives an overview of all the pieces of content + in your film, and how they are arranged. You can open the + timeline by clicking the Timeline... button + next to the content list. This will open a window like the one in . + + +
+ Timeline + + + + + +
+ + + The X axis represents time, and you can see the time codes (in + hours:minutes:seconds) along the bottom of the window. Pieces of + content are represented with rectangles in the main part of the + window. Content containing different types of data (e.g. a MP4 + file with video, audio and subtitles) have a rectangle for each + type. + + + + Within the timeline you can select content by clicking, and drag + it to change its position. Right-clicking a piece of content will + open the content menu. + + + + The toolbar at the top of the window offers the following tools: + + + + Select — to select and move content. + Zoom in — to drag out an area that you want to see more closely. + Zoom out — to zoom out so that the window shows the whole film. + Snap — when enabled, content will snap to other content when you drag it close. + Sequence — when enabled, content will be kept in sequence, without gaps, even if some content is removed. + +
+
Video processing pipeline @@ -2019,6 +2113,43 @@ from the timeline is also preserved. + + + Export + + + As well as creating DCPs from the content you specify, DCP-o-matic + can also export projects to ProRes and MP4 files. This is most + often useful to convert DCPs to a file that is smaller and easier to play back. + + + + To convert a DCP to ProRes or MP4, the first step is start a new + project and import the DCP (see ). Then, choose + Export... from the Jobs + menu to open the export dialogue, as shown in . + + +
+ Export dialogue + + + + + +
+ + + From this dialogue you can select the required output format, + output file and, in the case of MP4, the quality of the output + file. Higher quality files will, of course, be larger. + + + + You can also choose whether to mix down multichannel sources to stereo and whether you want to write separate reels to separate files. + + @@ -2177,7 +2308,7 @@ linkend="fig-kdm"/>. KDM dialog - + @@ -2317,7 +2448,7 @@ DCP-o-matic. Its window is shown in . The KDM creator - + @@ -3137,8 +3268,8 @@ The Frame Rate control in the DCP tab sets the video frame rate that the DCP will use. Clicking Use best sets the rate to what DCP-o-matic thinks is the best for your content. With this -button, DCP-o-matic assumes that the whole range of frame rates (24, -25, 30 and 48fps) are allowable. +button, DCP-o-matic assumes that the most commonly-working frame rates (24, +25 and 30fps) are allowed. @@ -3362,7 +3493,7 @@ to the cinema which is showing your DCP. - dcpomatic2_create [OPTION] [CONTENT] [<CONTENT> ...] + dcpomatic2_create [OPTION] <CONTENT> [[OPTION] <CONTENT> ...] @@ -3380,20 +3511,7 @@ to the cinema which is showing your DCP. The options are: - - -v, --version — show DCP-o-matic version - -h, --help — show this help - -n, --name — <name> film name - -t, --template <name> — template name - -c, --dcp-content-type <type> — FTR, SHR, TLR, TST, XSN, RTG, TSR, POL, PSA or ADV - --container-ratio <ratio> — 119, 133, 137, 138, 166, 178, 185 or 239 - --content-ratio <ratio> — 119, 133, 137, 138, 166, 178, 185 or 239 - -s, --still-length <n> — number of seconds that still content should last - --standard <standard> — SMPTE or interop (default SMPTE) - --no-use-isdcf-name> — do not use an ISDCF name; use the specified name unmodified - --no-sign— do not sign the DCP - -o, --output <dir> — output directory - + For example, to setup a film using a MP4 file you might do: @@ -3423,21 +3541,7 @@ to the cinema which is showing your DCP. dcpomatic2_cli [OPTION] [FILM] - - - -v, --version — show DCP-o-matic version - -h, --help — show this help - -f, --flags — show flags passed to C++ compiler on build - -n, --no-progress — do not print progress to stdout - -r, --no-remote — do not use any remote servers - -t, --threads — specify number of local encoding threads (overriding configuration) - -j, --json <port> — run a JSON server on the specified port - -k, --keep-going — keep running even when the job is complete - -s, --servers — just display a list of encoding servers that DCP-o-matic is configured to use; don't encode - -d, --dcp-path — echo DCP's path to stdout on successful completion (implies -n) - --dump — just dump a summary of the film's settings; don't encode - - + For example, to encode a film called my_film you might do: @@ -3459,21 +3563,7 @@ to the cinema which is showing your DCP. dcpomatic2_kdm_cli [OPTION] <FILM|CPL-ID> - - - -o, --output — output file or directory - -f, --valid-from — valid from time (in local time zone of the cinema) (e.g. "2013-09-28 01:41:51") or "now" - -t, --valid-to — valid to time (in local time zone of the cinema) (e.g. "2014-09-28 01:41:51") - -d, --valid-duration — valid duration (e.g. "1 day", "4 hours", "2 weeks") - --formulation — modified-transitional-1, dci-any or dci-specific [default modified-transitional-1] - -z, --zip — ZIP each cinema's KDMs into its own file - -v, --verbose — be verbose - -c, --cinema — specify a cinema, either by name or email address - --certificate — file containing projector certificate - --cinemas — list known cinemas from the DCP-o-matic settings - --dkdm-cpls — list CPLs for which DCP-o-matic has DKDMs - - +