From: Carl Hetherington Date: Fri, 7 May 2021 20:15:15 +0000 (+0200) Subject: Manual updates. X-Git-Tag: v2.15.144~5 X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=53eafe5571b7c09ab859493577dbaad36e5d9183 Manual updates. --- diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 0f4a46b0f..6e2c12d41 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -1,5 +1,8 @@ # DCP-o-matic manual makefile +INKSCAPE = ~/Applications/inkscape + + all: html pdf DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg timecode.svg pipeline1.svg pipeline2.svg \ @@ -14,7 +17,7 @@ SCREENSHOTS := file-new.pdf new-film.pdf video-select-content-file.pdf \ prefs-notifications.pdf timeline1.pdf timed-text-tab.pdf \ making-dcp.pdf filters.pdf video-tab.pdf audio-tab.pdf \ audio-plot.pdf audio-map-eg1.pdf audio-map-eg2.pdf audio-map-eg3.pdf kdm.pdf \ - kdm-creator.pdf export.pdf + kdm-creator.pdf export.pdf advanced-content.pdf XML := dcpomatic.xml @@ -55,16 +58,16 @@ screenshots/examine-content.pdf: raw-screenshots/examine-content.pdf python3 pdf_crop_by.py $< $@ 460 270 200 580 screenshots/audio-tab.pdf: raw-screenshots/audio-tab.pdf - python3 pdf_crop_by.py $< $@ 0 0 1230 380 + python3 pdf_crop_by.py $< $@ 0 0 1480 420 screenshots/timing-tab.pdf: raw-screenshots/timing-tab.pdf - python3 pdf_crop_by.py $< $@ 0 0 1230 380 + python3 pdf_crop_by.py $< $@ 0 100 1475 420 screenshots/timed-text-tab.pdf: raw-screenshots/timed-text-tab.pdf - python3 pdf_crop_by.py $< $@ 0 200 1230 380 + python3 pdf_crop_by.py $< $@ 0 50 1480 420 screenshots/video-tab.pdf: raw-screenshots/video-tab.pdf - python3 pdf_crop_by.py $< $@ 0 0 1230 295 + python3 pdf_crop_by.py $< $@ 0 0 1480 365 screenshots/add-file.pdf: raw-screenshots/add-file.pdf python3 pdf_crop_by.py $< $@ 0 600 1210 0 @@ -82,16 +85,16 @@ screenshots/audio-map-eg3.pdf: raw-screenshots/audio-map-eg3.pdf python3 pdf_crop_by.py $< $@ 10 75 1350 630 screenshots/dcp-tab.pdf: raw-screenshots/dcp-tab.pdf - python3 pdf_crop_by.py $< $@ 0 200 1230 30 + python3 pdf_crop_by.py $< $@ 0 250 1480 30 # For HTML: convert diagrams from SVG to PNG diagrams/%.png: diagrams/%.svg - inkscape $< --export-type=png --export-filename=$@ --export-area-drawing + $(INKSCAPE) $< --export-type=png --export-filename=$@ --export-area-drawing # For LaTeX/PDF: convert diagrams from SVG to PDF diagrams/%.pdf: diagrams/%.svg - inkscape $< --export-type=pdf --export-filename=$@ --export-area-drawing + $(INKSCAPE) $< --export-type=pdf --export-filename=$@ --export-area-drawing config.xml: ../../src/lib/config.cc config.py python3 config.py ../../src/lib/config.cc > config.xml diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml index 11376f876..22d566af8 100644 --- a/doc/manual/dcpomatic.xml +++ b/doc/manual/dcpomatic.xml @@ -128,23 +128,10 @@ with the first (main) part.
-Debian, Ubuntu or Mint Linux +Debian, Ubuntu and Mint Linux - - You can install DCP-o-matic on: - - - - Debian 9 (‘squeeze’), 10 (‘buster’) and unstable (‘sid’) - Ubuntu 16.04, 18.04, 20.04 and 20.10 - Mint 18 and 19 - - - -using .deb packages: download the appropriate package -from https://dcpomatic.com/ -and double-click it. Debian, Ubuntu or Mint will install the necessary bits and -pieces and set DCP-o-matic up for you. +There are .deb packages for Debian, Ubuntu and Mint on + https://dcpomatic.com/
@@ -154,7 +141,7 @@ pieces and set DCP-o-matic up for you.
Fedora, Centos and Mageia Linux - There are .rpm packages for Fedora 31, 32 and 33, Centos 7 and 8 and Mageia 7 on + There are .rpm packages for Fedora, Centos and Mageia on https://dcpomatic.com/
@@ -170,72 +157,17 @@ thanks to Stefan Karner. - -
-Other Linux distributions - - -Installation on other Linux systems (for which no packages are -available) is quite hard as it must be compiled from source. If you -can't download packages for your distribution, do let me know by -email and I will look -into providing packages on the website. - - - -The following dependencies are required: - -FFmpeg -libsndfile -libsamplerate -OpenSSL -libopenjpeg -Boost -libssh -GTK (on Linux) -wxWidgets -libxml++ -xmlsec -curl -libzip -asdcplib with some patches -libdcp -libsub -libcxml -locked_sstream -rtaudio -libicu - - - - -Once you have installed the development packages for the dependencies, -download the source code from https://dcpomatic.com/, -unpack it and run the following commands from inside the source -directory: - - - -./waf configure --disable-tests -./waf build -sudo ./waf install - - - -With any luck, this will build and install DCP-o-matic on your system. To run it, enter: - - - -dcpomatic2 - - - -in a shell. + + Building from source + + + Since DCP-o-matic is open-source you can also build it yourself, though this can be quite a difficult process (especially on Windows and macOS). There are instructions for how to do it on + + https://dcpomatic.com/ +
- @@ -927,38 +859,6 @@ and DCP-o-matic will pick up the appropriate frames from each. - -
-Filtering - - -The ‘filters’ settings allow you to apply various video -filters to the image. These may be useful to try to improve -poor-quality sources like DVDs. You can set up the filters by clicking the -Edit button next to the filters entry in the -setup area of the DCP-o-matic window; this opens the filters selector -as shown in . - - -
- Filters selector - - - - - -
- - -After changing the filters setup, you will need to regenerate the DCP -to see the effect on the cinema screen. The preview in DCP-o-matic -will update itself whenever filters are changed, though of course this -image may be smaller and of lower resolution than a projected image! - -
- - -
Colour conversion @@ -1688,6 +1588,107 @@ open to allow you to choose which settings you want to copy. Clicking
+
+Advanced content settings + + +There are a few more content settings that you can change by right-clicking a piece of content in the list and choosing Advanced settings... +This opens the dialogue box shown in . + + +
+ Advanced content dialogue + + + + + +
+ + + +
+Video filters + + +The Video filters setting allows you to apply various +filters to the image. These may be useful to try to improve +poor-quality sources like DVDs. You can set up the filters by clicking the +Edit button next to the filters entry; this opens the filters selector +as shown in . + + +
+ Filters selector + + + + + +
+ +
+ + +
+Override frame rate + + +The Override detected video frame rate setting has some different effects depending on the type of content +you use it on. + + + +For video content, it sets the frame rate that DCP-o-matic will run the video at. This is useful if DCP-o-matic has mis-detected +the video frame rate. For example, if DCP-o-matic says your content is 24fps when you know for a fact it's 25fps, you can set the +override value to 25 to force DCP-o-matic to do the right thing. + + + +On audio, subtitle and caption content this setting behaves slightly differently. It sets the video frame rate that the content +in question was intended to work with. As an example, consider a project with a 23.976fps video source and some separate audio files. +Perhaps those audio files have been mastered alongside a 24fps version of your video. By default, DCP-o-matic will see the 23.976fps +video file and decide to run it slightly fast at 24fps to fit the DCP standard. It will then also run the audio slightly fast so that +it stays in sync with the video. + + + +In this case, though, that is not what you want, since the audio is already ‘fixed’ to work alongside 24fps video. If you +override the video frame rate of the audio content to 24fps this will stop DCP-o-matic altering it. + + + +A similar situation can occur if you have video at one rate and a subtitle file that was prepared with its timing at a different rate. +In that case, you should override the video frame rate of the subtitle content to the one that it was prepared for. +This will mean that DCP-o-matic can get the relative timing right. + + + +Do not use this setting to change the DCP frame rate. Doing so will result in strange effects and sync problems. + +
+ + +
+Video has burnt-in subtitles + +Details about subtitle language are stored in various places within the DCP metadata. If a piece of video content already has subtitles +burnt into the image you can tell DCP-o-matic the language that they are in by clicking the Edit... button. + +
+ + +
+Ignore this content's video + +Tick this if you have some content which includes video along with other things (such as audio or subtitles) and you do +not want the video to appear in the DCP. + +
+ + +
+ diff --git a/doc/manual/raw-screenshots/advanced-content.pdf b/doc/manual/raw-screenshots/advanced-content.pdf new file mode 100644 index 000000000..9363738fc Binary files /dev/null and b/doc/manual/raw-screenshots/advanced-content.pdf differ diff --git a/doc/manual/raw-screenshots/audio-plot.pdf b/doc/manual/raw-screenshots/audio-plot.pdf index 5d52733fa..9c0efe520 100644 Binary files a/doc/manual/raw-screenshots/audio-plot.pdf and b/doc/manual/raw-screenshots/audio-plot.pdf differ diff --git a/doc/manual/raw-screenshots/audio-tab.pdf b/doc/manual/raw-screenshots/audio-tab.pdf index 1d4a4e234..7696bb7e3 100644 Binary files a/doc/manual/raw-screenshots/audio-tab.pdf and b/doc/manual/raw-screenshots/audio-tab.pdf differ diff --git a/doc/manual/raw-screenshots/dcp-tab.pdf b/doc/manual/raw-screenshots/dcp-tab.pdf index 389825eb9..ff835ef2f 100644 Binary files a/doc/manual/raw-screenshots/dcp-tab.pdf and b/doc/manual/raw-screenshots/dcp-tab.pdf differ diff --git a/doc/manual/raw-screenshots/export.pdf b/doc/manual/raw-screenshots/export.pdf index fb008434d..abbed15e5 100644 Binary files a/doc/manual/raw-screenshots/export.pdf and b/doc/manual/raw-screenshots/export.pdf differ diff --git a/doc/manual/raw-screenshots/timed-text-tab.pdf b/doc/manual/raw-screenshots/timed-text-tab.pdf index a96e8a1ec..d4d090ed4 100644 Binary files a/doc/manual/raw-screenshots/timed-text-tab.pdf and b/doc/manual/raw-screenshots/timed-text-tab.pdf differ diff --git a/doc/manual/raw-screenshots/timing-tab.pdf b/doc/manual/raw-screenshots/timing-tab.pdf index 5eeae390b..7adf0fadd 100644 Binary files a/doc/manual/raw-screenshots/timing-tab.pdf and b/doc/manual/raw-screenshots/timing-tab.pdf differ diff --git a/doc/manual/raw-screenshots/video-tab.pdf b/doc/manual/raw-screenshots/video-tab.pdf index 730c23bbf..964f0c2f6 100644 Binary files a/doc/manual/raw-screenshots/video-tab.pdf and b/doc/manual/raw-screenshots/video-tab.pdf differ