Chapter 24. Configuration files
Prev

Chapter 24. Configuration files

Most of DCP-o-matic's configuration is stored in an XML file called config.xml. This is stored in different places depending on your operating system:

Windows: c:\Users\your_user_name\AppData\Local\dcpomatic
OS X: /Users/your_user_Name/Library/Preferences/com.dcpomatic/2
Linux: ~/.config/dcpomatic2

Possible XML tags are as follows:

<Version> — The version number of the configuration file format.
<MasterEncodingThreads> — Number of encoding threads to use when running as master.
<ServerEncodingThreads> — Number of encoding threads to use when running as server.
<DefaultDirectory> (optional) — Default directory when creating a new film in the GUI.
<ServerPortBase> — Port number to use for frame encoding requests. ServerPortBase + 1 and ServerPortBase + 2 are used for querying servers. ServerPortBase + 3 is used by the batch converter to listen for job requests.
<UseAnyServers> — 1 to broadcast to look for encoding servers to use, 0 to use only those configured.
<Server> (optional) — IP address or hostname of an encoding server to use; you can use as many of these tags as you like.
<OnlyServersEncode> — 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
<TMSProtocol> — Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP.
<TMSPassive> — True to use PASV mode with TMS FTP connections.
<TMSIP> — IP address of TMS.
<TMSPath> — Path on the TMS to copy files to.
<TMSUser> — Username to log into the TMS with.
<TMSPassword> — Password to log into the TMS with.
<Language> (optional) — Language to use in the GUI e.g. fr_FR.
<DCPIssuer> — Issuer text to write into CPL files.
<DCPCreator> — Creator text to write into CPL files.
<Company> — name to write into MXF files.
<Product> — name to write into MXF files.
<Product> — version to write into MXF files.
<Comment> — to write into JPEG2000 data.
<UploadAfterMakeDCP> — 1 to upload to a TMS after making a DCP, 0 for no upload.
<DefaultStillLength> — Default length (in seconds) for still images in new films.
<DefaultAudioDelay> — Default delay to apply to audio (positive moves audio later) in milliseconds.
<DefaultAudioLanguage> — Default audio language to use for new films
<DefaultKDMDirectory> (optional) — Default directory to write KDMs to.
<MailServer> — Hostname of SMTP server to use.
<MailPort> — Port number to use on SMTP server.
<MailProtocol> — Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL)
<MailUser> — Username to use on SMTP server.
<MailPassword> — Password to use on SMTP server.
<KDMSubject> — Subject to use for KDM emails.
<KDMFrom> — From address to use for KDM emails.
<KDMCC> — CC address to use for KDM emails; you can use as many of these tags as you like.
<KDMBCC> — BCC address to use for KDM emails.
<KDMEmail> — Text of KDM email.
<NotificationSubject> — Subject to use for notification emails.
<NotificationFrom> — From address to use for notification emails.
<NotificationFrom> — To address to use for notification emails.
<NotificationCC> — CC address to use for notification emails; you can use as many of these tags as you like.
<NotificationBCC> — BCC address to use for notification emails.
<NotificationEmail> — Text of notification email.
<CheckForUpdates> — 1 to check dcpomatic.com for new versions, 0 to check only on request.
<CheckForUpdates> — 1 to check dcpomatic.com for new text versions, 0 to check only on request.
<MaximumJ2KVideoBitRate> — Maximum video bit rate (in bits per second) that can be specified in the GUI for JPEG2000 encodes.
<MaximumMPEG2VideoBitRate> — Maximum video bit rate (in bits per second) that can be specified in the GUI for MPEG2 encodes.
<AllowAnyDCPFrameRate> — 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates.
<AllowAnyContainer> — 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope
<Allow96kHzAudio> — 1 to allow users to make DCPs with 96kHz audio, 0 to always make 48kHz DCPs
<UseAllAudioChannels> — 1 to allow users to map audio to all 16 DCP channels, 0 to limit to the channels used in standard DCPs
<ShowExperimentalAudioProcessors> — 1 to offer users the (experimental) audio upmixer processors, 0 to hide them
<LogTypes> — Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information related to the player, 1024 debug information related to audio analyses.
<AnalyseEBUR128> — 1 to do EBUR128 analyses when analysing audio, otherwise 0.
<AutomaticAudioAnalysis> — 1 to run audio analysis automatically when audio content is added to the film, otherwise 0.
<Win32Console> — 1 to open a console when running on Windows, otherwise 0. * We only write this if it's true, which is a bit of a hack to allow unit tests to work * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
<Signer> — Certificate chain and private key to use when signing DCPs and KDMs. Should contain <Certificate> tags in order and a <PrivateKey> tag all containing PEM-encoded certificates or private keys as appropriate.
<Decryption> — Certificate chain and private key to use when decrypting KDMs
<History> — Filename of DCP to present in the File menu of the GUI; there can be more than one of these tags.
<History> — Filename of DCP to present in the File menu of the player; there can be more than one of these tags.
<DKDMGroup> — A group of DKDMs, each with a Name attribute, containing other <DKDMGroup> or <DKDM> tags.
<DKDM> — A DKDM as XML
<CinemasFile> — Filename of cinemas list file.
<DKDMRecipientsFile> — Filename of DKDM recipients list file.
<ShowHintsBeforeMakeDCP> — 1 to show hints in the GUI before making a DCP, otherwise 0.
<ConfirmKDMEmail> — 1 to confirm before sending KDM emails in the GUI, otherwise 0.
<KDMFilenameFormat> — Format for KDM filenames.
<KDMFilenameFormat> — Format for DKDM filenames.
<KDMContainerNameFormat> — Format for KDM containers (directories or ZIP files).
<DCPMetadataFilenameFormat> — Format for DCP metadata filenames.
<DCPAssetFilenameFormat> — Format for DCP asset filenames.
<JumpToSelected> — 1 to make the GUI jump to the start of content when it is selected, otherwise 0.
<Nagged> — 1 if a particular nag screen has been shown and should not be shown again, otherwise 0.
<PreviewSound> — 1 to use sound in the GUI preview and player, otherwise 0.
<PreviewSoundOutput> (optional) — Name of the audio output to use.
<CoverSheet> — Text of the cover sheet to write when making DCPs.
<LastKDMWriteType> — Last type of KDM-write: flat for a flat file, folder for a folder or zip for a ZIP file.
<LastDKDMWriteType> — Last type of DKDM-write: file for a file, internal to add to DCP-o-matic's list.
<FramesInMemoryMultiplier> — value to multiply the encoding threads count by to get the maximum number of frames to be held in memory at once.
<DecodeReduction> — power of 2 to reduce DCP images by before decoding in the player.
<DefaultNotify> — 1 to default jobs to notify when complete, otherwise 0.
<Notification> — 1 if a notification type is enabled, otherwise 0.
<BarcoUsername> — Username for logging into Barco's servers when downloading server certificates.
<BarcoPassword> — Password for logging into Barco's servers when downloading server certificates.
<ChristieUsername> — Username for logging into Christie's servers when downloading server certificates.
<ChristiePassword> — Password for logging into Christie's servers when downloading server certificates.
<GDCUsername> — Username for logging into GDC's servers when downloading server certificates.
<GDCPassword> — Password for logging into GDC's servers when downloading server certificates.
<PlayerMode> — window for a single window, full for full-screen and dual for full screen playback with separate (advanced) controls.
<ImageDisplay> — Screen number to put image on in dual-screen player mode.
<RespectKDMValidityPeriods> — 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates.
<PlayerLogFile> — Filename to use for player debug logs.
<PlayerContentDirectory> — Directory to use for player content in the dual-screen mode.
<PlayerPlaylistDirectory> — Directory to use for player playlists in the dual-screen mode.
<PlayerKDMDirectory> — Directory to use for player KDMs in the dual-screen mode.
<AllowSMPTEBv20> — 1 to allow the user to choose SMPTE (Bv2.0 only) as a standard, otherwise 0
<ISDCFNamePartLength> — Maximum length of the "name" part of an ISDCF name, which should be 14 according to the standard
<EnablePlayerHTTPServer> — 1 to enable a HTTP server to control the player, otherwise 0
<PlayerHTTPServerPort> — Port to use for player HTTP server (if enabled)
<RelativePaths> — 1 to write relative paths to project metadata files, 0 to use absolute paths

Prev
Chapter 23. Keyboard shortcuts	Home