diff options
| author | Carl Hetherington <cth@carlh.net> | 2015-12-08 14:08:56 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2015-12-08 14:08:56 +0000 |
| commit | 61db7cbb5e384eaa0560c3cda05e6a7850355ed3 (patch) | |
| tree | f1ba54f76a6e6cea9eb3a15d6284ffdbc2520e4e | |
| parent | 3477cca6d971aed79b50b6c3445ff5ecfd3d3c38 (diff) | |
Manual updates.
| -rw-r--r-- | doc/manual/Makefile | 2 | ||||
| -rw-r--r-- | doc/manual/dcpomatic.xml | 84 | ||||
| -rw-r--r-- | doc/manual/diagrams/reels-by-video.svg | 311 | ||||
| -rw-r--r-- | doc/manual/screenshots/dcp-tab.png | bin | 37745 -> 42592 bytes |
4 files changed, 396 insertions, 1 deletions
diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 83dfb17c5..ed7bf133f 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -3,7 +3,7 @@ all: html pdf DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg timecode.svg pipeline1.svg pipeline2.svg \ - pipeline3.svg pipeline4.svg burn-in.svg discrete.svg dcp-copy.svg dcp-refer.svg + pipeline3.svg pipeline4.svg burn-in.svg discrete.svg dcp-copy.svg dcp-refer.svg reels-by-video.svg SCREENSHOTS := file-new.png video-new-film.png still-new-film.png video-select-content-file.png \ still-select-content-file.png examine-thumbs.png examine-content.png timing-tab.png \ diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 312e3324b..6d3299f7e 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -1542,6 +1542,12 @@ key for you. To specify your own key, click the </para> <para> +The <guilabel>Reels</guilabel> and <guilabel>Reel length</guilabel> +controls specify how the DCP will be split up into +‘reels’. See <xref linkend="sec-reels"/> below. +</para> + +<para> The <guilabel>Standard</guilabel> option specifies which of the two DCP standards DCP-o-matic should use. If in doubt, use SMPTE (the more modern of the two). @@ -1646,6 +1652,84 @@ This upmixing algorithm is due to GĂ©rald Maruccia. </itemizedlist> <!-- ============================================================== --> +<section xml:id="sec-reels"> +<title>Reels</title> + +<para> +A ‘reel’ in a DCP is a subsection of the DCP, in the same +way as a 35mm reel is a section of a film. A DCP can be split up into +any number of reels and the joins (the equivalent to 35mm splices) +between the reels are seamless. +</para> + +<para> +There is no reason why you can't just use a single reel for the whole +of your DCP, as there is no limit on their length. Many people choose +to do this. +</para> + +<para> +There are, however, some possible advantages of splitting things up +into reels: +</para> + +<itemizedlist> +<listitem> +The picture, sound and subtitle data of the DCP will be +split up into more smaller files on disk, rather than fewer larger +files. This can be useful if the DCP is to be transferred on storage +that have file size limits. The FAT32 filesystem, for example, can +only hold files smaller than 4Gb. A 6Gb DCP with a single reel could +not be transferred using a FAT32-formatted disk. If that DCP were +split up into two 3Gb reels it could be transferred. +</listitem> +<listitem> +It is easier to re-use DCP components if they are in reels. Consider, +for example, a film company who wants to put a 5 second ident onto the +beginning of DCPs that they distribute. If they receive a feature +film DCP they can modify it to add their ident as a separate reel. +This is easier than attaching the picture data in the DCP. +</listitem> +</itemizedlist> + +<para> +DCP-o-matic offers three options for setting up the reels in your DCP: +single reel, split by video content or custom. +</para> + +<para> +<guilabel>Single reel</guilabel>, as its name suggests, keeps the whole DCP as one reel. +This is a perfectly good option if you have no particular reason to +need reels. +</para> + +<para> +<guilabel>Split by video content</guilabel> puts each piece of source +video content in its own reel, as shown in <xref linkend="fig-reels-by-video"/>. +</para> + +<figure id="fig-reels-by-video"> +<title>Making reels using split by video content</title> +<mediaobject><imageobject><imagedata scale="100" fileref="diagrams/reels-by-video&dia;"/></imageobject></mediaobject> +</figure> + +<para> +Here we have three video files (<code>ident.mp4</code>, +<code>feature.ts</code> and <code>cred.mov</code>). With +<guilabel>split by video content</guilabel> DCP-o-matic makes a new +reel to hold each video file. +</para> + +<para> +<guilabel>Custom</guilabel> splits reels by the size of the files that +will make up their video content. With <guilabel>Custom</guilabel> +you must specify a reel length in Gb. Then no file in the DCP will be larger than this reel length. +</para> + +</section> + + +<!-- ============================================================== --> <section> <title>Show audio</title> diff --git a/doc/manual/diagrams/reels-by-video.svg b/doc/manual/diagrams/reels-by-video.svg new file mode 100644 index 000000000..f1887cb2b --- /dev/null +++ b/doc/manual/diagrams/reels-by-video.svg @@ -0,0 +1,311 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + version="1.1" + inkscape:version="0.91 r13725" + sodipodi:docname="reels-by-video.svg"> + <defs + id="defs4"> + <marker + inkscape:stockid="Arrow1Mend" + orient="auto" + refY="0.0" + refX="0.0" + id="marker4782" + style="overflow:visible;" + inkscape:isstock="true"> + <path + id="path4533" + d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z " + style="fill-rule:evenodd;stroke:#0000ff;stroke-width:1pt;stroke-opacity:1;fill:#0000ff;fill-opacity:1" + transform="scale(0.4) rotate(180) translate(10,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mstart" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow1Mstart" + style="overflow:visible" + inkscape:isstock="true"> + <path + id="path4530" + d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z " + style="fill-rule:evenodd;stroke:#0000ff;stroke-width:1pt;stroke-opacity:1;fill:#0000ff;fill-opacity:1" + transform="scale(0.4) translate(10,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mend" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow1Mend" + style="overflow:visible;"> + <path + id="path3997" + d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z " + style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;" + transform="scale(0.4) rotate(180) translate(10,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mstart" + orient="auto" + refY="0" + refX="0" + id="Arrow1Mstart-9" + style="overflow:visible" + inkscape:isstock="true"> + <path + inkscape:connector-curvature="0" + id="path4530-8" + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#0000ff;fill-opacity:1;fill-rule:evenodd;stroke:#0000ff;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mend" + orient="auto" + refY="0" + refX="0" + id="marker4782-7" + style="overflow:visible" + inkscape:isstock="true"> + <path + inkscape:connector-curvature="0" + id="path4533-0" + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#0000ff;fill-opacity:1;fill-rule:evenodd;stroke:#0000ff;stroke-width:1pt;stroke-opacity:1" + transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mstart" + orient="auto" + refY="0" + refX="0" + id="Arrow1Mstart-9-2" + style="overflow:visible" + inkscape:isstock="true"> + <path + inkscape:connector-curvature="0" + id="path4530-8-0" + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#0000ff;fill-opacity:1;fill-rule:evenodd;stroke:#0000ff;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mend" + orient="auto" + refY="0" + refX="0" + id="marker4782-7-6" + style="overflow:visible" + inkscape:isstock="true"> + <path + inkscape:connector-curvature="0" + id="path4533-0-2" + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#0000ff;fill-opacity:1;fill-rule:evenodd;stroke:#0000ff;stroke-width:1pt;stroke-opacity:1" + transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mstart" + orient="auto" + refY="0" + refX="0" + id="Arrow1Mstart-4" + style="overflow:visible" + inkscape:isstock="true"> + <path + inkscape:connector-curvature="0" + id="path4530-4" + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Mend" + orient="auto" + refY="0" + refX="0" + id="marker4782-2" + style="overflow:visible" + inkscape:isstock="true"> + <path + inkscape:connector-curvature="0" + id="path4533-01" + d="M 0,0 5,-5 -12.5,0 5,5 0,0 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + </marker> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="0.0" + inkscape:pageshadow="2" + inkscape:zoom="1.3941383" + inkscape:cx="217.65713" + inkscape:cy="732.6202" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + inkscape:window-width="1280" + inkscape:window-height="995" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" /> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title></dc:title> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <rect + style="color:#000000;display:inline;overflow:visible;visibility:visible;fill:#87deaa;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;enable-background:accumulate;clip-rule:nonzero;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill-rule:nonzero;filter-blend-mode:normal;filter-gaussianBlur-deviation:0;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto" + id="rect2985-7-63" + width="69.733307" + height="21.849802" + x="115.18209" + y="242.16774" /> + <text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:14px;line-height:125%;font-family:Inconsolata;-inkscape-font-specification:'Inconsolata Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none" + x="118.18475" + y="257.89865" + id="text3788" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3790" + x="118.18475" + y="257.89865">ident.mp4</tspan></text> + <rect + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#e9afaf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + id="rect2985-7-63-3" + width="182.72185" + height="21.849802" + x="184.91786" + y="242.16774" /> + <rect + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#e5ff80;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + id="rect2985-7-63-3-8" + width="63.054306" + height="21.849802" + x="367.6893" + y="242.16774" /> + <text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:14px;line-height:125%;font-family:Inconsolata;-inkscape-font-specification:'Inconsolata Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none" + x="371.65491" + y="257.89865" + id="text3788-5" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3790-7" + x="371.65491" + y="257.89865">cred.mov</tspan></text> + <text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:14px;line-height:125%;font-family:Inconsolata;-inkscape-font-specification:'Inconsolata Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none" + x="241.27179" + y="257.89865" + id="text3788-90" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3790-5" + x="241.27179" + y="257.89865">feature.ts</tspan></text> + <path + style="fill:#0000ff;fill-rule:evenodd;stroke:#0000ff;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Mstart);marker-end:url(#marker4782)" + d="m 116.26098,234.74588 66.49126,0" + id="path4518" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cc" /> + <text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:14px;line-height:125%;font-family:Inconsolata;-inkscape-font-specification:'Inconsolata Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none" + x="129.52161" + y="213.06122" + id="text3788-60" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3790-9" + x="129.52161" + y="213.06122"></tspan><tspan + sodipodi:role="line" + x="129.52161" + y="230.56122" + id="tspan4821">Reel 1</tspan></text> + <path + style="fill:#0000ff;fill-rule:evenodd;stroke:#0000ff;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Mstart-9);marker-end:url(#marker4782-7)" + d="m 186.50058,234.74588 179.03519,0" + id="path4518-1" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cc" /> + <text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:14px;line-height:125%;font-family:Inconsolata;-inkscape-font-specification:'Inconsolata Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none" + x="255.05318" + y="213.06122" + id="text3788-60-3" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3790-9-1" + x="255.05318" + y="213.06122" /><tspan + sodipodi:role="line" + x="255.05318" + y="230.56122" + id="tspan4821-0">Reel 2</tspan></text> + <path + style="fill:#0000ff;fill-rule:evenodd;stroke:#0000ff;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Mstart-9-2);marker-end:url(#marker4782-7-6)" + d="m 369.14142,234.74588 59.83117,0" + id="path4518-1-0" + inkscape:connector-curvature="0" + sodipodi:nodetypes="cc" /> + <text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:14px;line-height:125%;font-family:Inconsolata;-inkscape-font-specification:'Inconsolata Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none" + x="378.19699" + y="213.06122" + id="text3788-60-3-9" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3790-9-1-6" + x="378.19699" + y="213.06122" /><tspan + sodipodi:role="line" + x="378.19699" + y="230.56122" + id="tspan4821-0-4">Reel 3</tspan></text> + <rect + style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#0000ff;fill-opacity:1;fill-rule:nonzero;stroke:#0000ff;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;color-rendering:auto;image-rendering:auto;shape-rendering:auto;text-rendering:auto;enable-background:accumulate" + id="rect4895" + width="0" + height="0" + x="0" + y="0" /> + </g> +</svg> diff --git a/doc/manual/screenshots/dcp-tab.png b/doc/manual/screenshots/dcp-tab.png Binary files differindex b5d22330f..cad6c3959 100644 --- a/doc/manual/screenshots/dcp-tab.png +++ b/doc/manual/screenshots/dcp-tab.png |
