Allow configuration of default value of upload-to-TMS button.
[dcpomatic.git] / src / lib / config.h
1 /*
2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 /** @file src/config.h
22  *  @brief Class holding configuration.
23  */
24
25 #ifndef DCPOMATIC_CONFIG_H
26 #define DCPOMATIC_CONFIG_H
27
28 #include "isdcf_metadata.h"
29 #include "types.h"
30 #include <dcp/name_format.h>
31 #include <dcp/certificate_chain.h>
32 #include <dcp/encrypted_kdm.h>
33 #include <boost/shared_ptr.hpp>
34 #include <boost/signals2.hpp>
35 #include <boost/filesystem.hpp>
36 #include <vector>
37
38 class CinemaSoundProcessor;
39 class DCPContentType;
40 class Ratio;
41 class Cinema;
42 class Film;
43 class DKDMGroup;
44
45 /** @class Config
46  *  @brief A singleton class holding configuration.
47  */
48 class Config : public boost::noncopyable
49 {
50 public:
51         /** @return number of threads which a master DoM should use for J2K encoding on the local machine */
52         int master_encoding_threads () const {
53                 return _master_encoding_threads;
54         }
55
56         /** @return number of threads which a server should use for J2K encoding on the local machine */
57         int server_encoding_threads () const {
58                 return _server_encoding_threads;
59         }
60
61         boost::optional<boost::filesystem::path> default_directory () const {
62                 return _default_directory;
63         }
64
65         boost::optional<boost::filesystem::path> default_kdm_directory () const {
66                 return _default_kdm_directory;
67         }
68
69         boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
70         boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
71
72         enum Property {
73                 USE_ANY_SERVERS,
74                 SERVERS,
75                 CINEMAS,
76                 SOUND,
77                 SOUND_OUTPUT,
78                 OTHER
79         };
80
81         /** @return base port number to use for J2K encoding servers */
82         int server_port_base () const {
83                 return _server_port_base;
84         }
85
86         void set_use_any_servers (bool u) {
87                 _use_any_servers = u;
88                 changed (USE_ANY_SERVERS);
89         }
90
91         bool use_any_servers () const {
92                 return _use_any_servers;
93         }
94
95         /** @param s New list of servers */
96         void set_servers (std::vector<std::string> s) {
97                 _servers = s;
98                 changed (SERVERS);
99         }
100
101         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
102         std::vector<std::string> servers () const {
103                 return _servers;
104         }
105
106         bool only_servers_encode () const {
107                 return _only_servers_encode;
108         }
109
110         Protocol tms_protocol () const {
111                 return _tms_protocol;
112         }
113
114         /** @return The IP address of a TMS that we can copy DCPs to */
115         std::string tms_ip () const {
116                 return _tms_ip;
117         }
118
119         /** @return The path on a TMS that we should changed DCPs to */
120         std::string tms_path () const {
121                 return _tms_path;
122         }
123
124         /** @return User name to log into the TMS with */
125         std::string tms_user () const {
126                 return _tms_user;
127         }
128
129         /** @return Password to log into the TMS with */
130         std::string tms_password () const {
131                 return _tms_password;
132         }
133
134         /** @return The cinema sound processor that we are using */
135         CinemaSoundProcessor const * cinema_sound_processor () const {
136                 return _cinema_sound_processor;
137         }
138
139         std::list<boost::shared_ptr<Cinema> > cinemas () const {
140                 return _cinemas;
141         }
142
143         std::list<int> allowed_dcp_frame_rates () const {
144                 return _allowed_dcp_frame_rates;
145         }
146
147         bool allow_any_dcp_frame_rate () const {
148                 return _allow_any_dcp_frame_rate;
149         }
150
151         ISDCFMetadata default_isdcf_metadata () const {
152                 return _default_isdcf_metadata;
153         }
154
155         boost::optional<std::string> language () const {
156                 return _language;
157         }
158
159         int default_still_length () const {
160                 return _default_still_length;
161         }
162
163         Ratio const * default_container () const {
164                 return _default_container;
165         }
166
167         Ratio const * default_scale_to () const {
168                 return _default_scale_to;
169         }
170
171         DCPContentType const * default_dcp_content_type () const {
172                 return _default_dcp_content_type;
173         }
174
175         int default_dcp_audio_channels () const {
176                 return _default_dcp_audio_channels;
177         }
178
179         std::string dcp_issuer () const {
180                 return _dcp_issuer;
181         }
182
183         std::string dcp_creator () const {
184                 return _dcp_creator;
185         }
186
187         int default_j2k_bandwidth () const {
188                 return _default_j2k_bandwidth;
189         }
190
191         int default_audio_delay () const {
192                 return _default_audio_delay;
193         }
194
195         bool default_interop () const {
196                 return _default_interop;
197         }
198
199         bool default_upload_after_make_dcp () {
200                 return _default_upload_after_make_dcp;
201         }
202
203         void set_default_kdm_directory (boost::filesystem::path d) {
204                 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
205                         return;
206                 }
207                 _default_kdm_directory = d;
208                 changed ();
209         }
210
211         std::string mail_server () const {
212                 return _mail_server;
213         }
214
215         int mail_port () const {
216                 return _mail_port;
217         }
218
219         std::string mail_user () const {
220                 return _mail_user;
221         }
222
223         std::string mail_password () const {
224                 return _mail_password;
225         }
226
227         std::string kdm_subject () const {
228                 return _kdm_subject;
229         }
230
231         std::string kdm_from () const {
232                 return _kdm_from;
233         }
234
235         std::vector<std::string> kdm_cc () const {
236                 return _kdm_cc;
237         }
238
239         std::string kdm_bcc () const {
240                 return _kdm_bcc;
241         }
242
243         std::string kdm_email () const {
244                 return _kdm_email;
245         }
246
247         boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
248                 return _signer_chain;
249         }
250
251         boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
252                 return _decryption_chain;
253         }
254
255         bool check_for_updates () const {
256                 return _check_for_updates;
257         }
258
259         bool check_for_test_updates () const {
260                 return _check_for_test_updates;
261         }
262
263         int maximum_j2k_bandwidth () const {
264                 return _maximum_j2k_bandwidth;
265         }
266
267         int log_types () const {
268                 return _log_types;
269         }
270
271         bool analyse_ebur128 () const {
272                 return _analyse_ebur128;
273         }
274
275         bool automatic_audio_analysis () const {
276                 return _automatic_audio_analysis;
277         }
278
279 #ifdef DCPOMATIC_WINDOWS
280         bool win32_console () const {
281                 return _win32_console;
282         }
283 #endif
284
285         std::vector<boost::filesystem::path> history () const {
286                 return _history;
287         }
288
289         boost::shared_ptr<DKDMGroup> dkdms () const {
290                 return _dkdms;
291         }
292
293         boost::filesystem::path cinemas_file () const {
294                 return _cinemas_file;
295         }
296
297         bool show_hints_before_make_dcp () const {
298                 return _show_hints_before_make_dcp;
299         }
300
301         bool confirm_kdm_email () const {
302                 return _confirm_kdm_email;
303         }
304
305         dcp::NameFormat kdm_container_name_format () const {
306                 return _kdm_container_name_format;
307         }
308
309         dcp::NameFormat kdm_filename_format () const {
310                 return _kdm_filename_format;
311         }
312
313         dcp::NameFormat dcp_metadata_filename_format () const {
314                 return _dcp_metadata_filename_format;
315         }
316
317         dcp::NameFormat dcp_asset_filename_format () const {
318                 return _dcp_asset_filename_format;
319         }
320
321         bool jump_to_selected () const {
322                 return _jump_to_selected;
323         }
324
325         enum Nag {
326                 NAG_DKDM_CONFIG,
327                 NAG_ENCRYPTED_METADATA,
328                 NAG_REMAKE_DECRYPTION_CHAIN,
329                 NAG_COUNT
330         };
331
332         bool nagged (Nag nag) const {
333                 return _nagged[nag];
334         }
335
336         bool sound () const {
337                 return _sound;
338         }
339
340         std::string cover_sheet () const {
341                 return _cover_sheet;
342         }
343
344         boost::optional<std::string> sound_output () const {
345                 return _sound_output;
346         }
347
348         boost::optional<boost::filesystem::path> last_player_load_directory () const {
349                 return _last_player_load_directory;
350         }
351
352         enum KDMWriteType {
353                 KDM_WRITE_FLAT,
354                 KDM_WRITE_FOLDER,
355                 KDM_WRITE_ZIP
356         };
357
358         boost::optional<KDMWriteType> last_kdm_write_type () const {
359                 return _last_kdm_write_type;
360         }
361
362         int frames_in_memory_multiplier () const {
363                 return _frames_in_memory_multiplier;
364         }
365
366         void set_master_encoding_threads (int n) {
367                 maybe_set (_master_encoding_threads, n);
368         }
369
370         void set_server_encoding_threads (int n) {
371                 maybe_set (_server_encoding_threads, n);
372         }
373
374         void set_default_directory (boost::filesystem::path d) {
375                 if (_default_directory && *_default_directory == d) {
376                         return;
377                 }
378                 _default_directory = d;
379                 changed ();
380         }
381
382         /** @param p New server port */
383         void set_server_port_base (int p) {
384                 maybe_set (_server_port_base, p);
385         }
386
387         void set_only_servers_encode (bool o) {
388                 maybe_set (_only_servers_encode, o);
389         }
390
391         void set_tms_protocol (Protocol p) {
392                 maybe_set (_tms_protocol, p);
393         }
394
395         /** @param i IP address of a TMS that we can copy DCPs to */
396         void set_tms_ip (std::string i) {
397                 maybe_set (_tms_ip, i);
398         }
399
400         /** @param p Path on a TMS that we should changed DCPs to */
401         void set_tms_path (std::string p) {
402                 maybe_set (_tms_path, p);
403         }
404
405         /** @param u User name to log into the TMS with */
406         void set_tms_user (std::string u) {
407                 maybe_set (_tms_user, u);
408         }
409
410         /** @param p Password to log into the TMS with */
411         void set_tms_password (std::string p) {
412                 maybe_set (_tms_password, p);
413         }
414
415         void add_cinema (boost::shared_ptr<Cinema> c) {
416                 _cinemas.push_back (c);
417                 changed (CINEMAS);
418         }
419
420         void remove_cinema (boost::shared_ptr<Cinema> c) {
421                 _cinemas.remove (c);
422                 changed (CINEMAS);
423         }
424
425         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
426                 maybe_set (_allowed_dcp_frame_rates, r);
427         }
428
429         void set_allow_any_dcp_frame_rate (bool a) {
430                 maybe_set (_allow_any_dcp_frame_rate, a);
431         }
432
433         void set_default_isdcf_metadata (ISDCFMetadata d) {
434                 maybe_set (_default_isdcf_metadata, d);
435         }
436
437         void set_language (std::string l) {
438                 if (_language && _language.get() == l) {
439                         return;
440                 }
441                 _language = l;
442                 changed ();
443         }
444
445         void unset_language () {
446                 if (!_language) {
447                         return;
448                 }
449
450                 _language = boost::none;
451                 changed ();
452         }
453
454         void set_default_still_length (int s) {
455                 maybe_set (_default_still_length, s);
456         }
457
458         void set_default_container (Ratio const * c) {
459                 maybe_set (_default_container, c);
460         }
461
462         void set_default_scale_to (Ratio const * c) {
463                 maybe_set (_default_scale_to, c);
464         }
465
466         void set_default_dcp_content_type (DCPContentType const * t) {
467                 maybe_set (_default_dcp_content_type, t);
468         }
469
470         void set_default_dcp_audio_channels (int c) {
471                 maybe_set (_default_dcp_audio_channels, c);
472         }
473
474         void set_dcp_issuer (std::string i) {
475                 maybe_set (_dcp_issuer, i);
476         }
477
478         void set_dcp_creator (std::string c) {
479                 maybe_set (_dcp_creator, c);
480         }
481
482         void set_default_j2k_bandwidth (int b) {
483                 maybe_set (_default_j2k_bandwidth, b);
484         }
485
486         void set_default_audio_delay (int d) {
487                 maybe_set (_default_audio_delay, d);
488         }
489
490         void set_default_interop (bool i) {
491                 maybe_set (_default_interop, i);
492         }
493
494         void set_default_upload_after_make_dcp (bool u) {
495                 maybe_set (_default_upload_after_make_dcp, u);
496         }
497
498         void set_mail_server (std::string s) {
499                 maybe_set (_mail_server, s);
500         }
501
502         void set_mail_port (int p) {
503                 maybe_set (_mail_port, p);
504         }
505
506         void set_mail_user (std::string u) {
507                 maybe_set (_mail_user, u);
508         }
509
510         void set_mail_password (std::string p) {
511                 maybe_set (_mail_password, p);
512         }
513
514         void set_kdm_subject (std::string s) {
515                 maybe_set (_kdm_subject, s);
516         }
517
518         void set_kdm_from (std::string f) {
519                 maybe_set (_kdm_from, f);
520         }
521
522         void set_kdm_cc (std::vector<std::string> f) {
523                 maybe_set (_kdm_cc, f);
524         }
525
526         void set_kdm_bcc (std::string f) {
527                 maybe_set (_kdm_bcc, f);
528         }
529
530         void set_kdm_email (std::string e) {
531                 maybe_set (_kdm_email, e);
532         }
533
534         void reset_kdm_email ();
535
536         void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
537                 maybe_set (_signer_chain, s);
538         }
539
540         void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
541                 maybe_set (_decryption_chain, c);
542         }
543
544         void set_check_for_updates (bool c) {
545                 maybe_set (_check_for_updates, c);
546                 if (!c) {
547                         set_check_for_test_updates (false);
548                 }
549         }
550
551         void set_check_for_test_updates (bool c) {
552                 maybe_set (_check_for_test_updates, c);
553         }
554
555         void set_maximum_j2k_bandwidth (int b) {
556                 maybe_set (_maximum_j2k_bandwidth, b);
557         }
558
559         void set_log_types (int t) {
560                 maybe_set (_log_types, t);
561         }
562
563         void set_analyse_ebur128 (bool a) {
564                 maybe_set (_analyse_ebur128, a);
565         }
566
567         void set_automatic_audio_analysis (bool a) {
568                 maybe_set (_automatic_audio_analysis, a);
569         }
570
571 #ifdef DCPOMATIC_WINDOWS
572         void set_win32_console (bool c) {
573                 maybe_set (_win32_console, c);
574         }
575 #endif
576
577         void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
578                 _dkdms = dkdms;
579                 changed ();
580         }
581
582         void set_cinemas_file (boost::filesystem::path file);
583
584         void set_show_hints_before_make_dcp (bool s) {
585                 maybe_set (_show_hints_before_make_dcp, s);
586         }
587
588         void set_confirm_kdm_email (bool s) {
589                 maybe_set (_confirm_kdm_email, s);
590         }
591
592         void set_sound (bool s) {
593                 maybe_set (_sound, s, SOUND);
594         }
595
596         void set_sound_output (std::string o) {
597                 maybe_set (_sound_output, o, SOUND_OUTPUT);
598         }
599
600         void set_last_player_load_directory (boost::filesystem::path d) {
601                 maybe_set (_last_player_load_directory, d);
602         }
603
604         void set_last_kdm_write_type (KDMWriteType t) {
605                 maybe_set (_last_kdm_write_type, t);
606         }
607
608         void unset_sound_output () {
609                 if (!_sound_output) {
610                         return;
611                 }
612
613                 _sound_output = boost::none;
614                 changed ();
615         }
616
617         void set_kdm_container_name_format (dcp::NameFormat n) {
618                 maybe_set (_kdm_container_name_format, n);
619         }
620
621         void set_kdm_filename_format (dcp::NameFormat n) {
622                 maybe_set (_kdm_filename_format, n);
623         }
624
625         void set_dcp_metadata_filename_format (dcp::NameFormat n) {
626                 maybe_set (_dcp_metadata_filename_format, n);
627         }
628
629         void set_dcp_asset_filename_format (dcp::NameFormat n) {
630                 maybe_set (_dcp_asset_filename_format, n);
631         }
632
633         void set_frames_in_memory_multiplier (int m) {
634                 maybe_set (_frames_in_memory_multiplier, m);
635         }
636
637         void clear_history () {
638                 _history.clear ();
639                 changed ();
640         }
641
642         void add_to_history (boost::filesystem::path p);
643
644         void set_jump_to_selected (bool j) {
645                 maybe_set (_jump_to_selected, j);
646         }
647
648         void set_nagged (Nag nag, bool nagged) {
649                 maybe_set (_nagged[nag], nagged);
650         }
651
652         void set_cover_sheet (std::string s) {
653                 maybe_set (_cover_sheet, s);
654         }
655
656         void reset_cover_sheet ();
657
658         void changed (Property p = OTHER);
659         boost::signals2::signal<void (Property)> Changed;
660         /** Emitted if read() failed on an existing Config file.  There is nothing
661             a listener can do about it: this is just for information.
662         */
663         static boost::signals2::signal<void ()> FailedToLoad;
664         /** Emitted if read() issued a warning which the user might want to know about */
665         static boost::signals2::signal<void (std::string)> Warning;
666
667         void write () const;
668         void write_config () const;
669         void write_cinemas () const;
670         void link (boost::filesystem::path new_file) const;
671         void copy_and_link (boost::filesystem::path new_file) const;
672
673         void save_template (boost::shared_ptr<const Film> film, std::string name) const;
674         bool existing_template (std::string name) const;
675         std::list<std::string> templates () const;
676         boost::filesystem::path template_path (std::string name) const;
677         void rename_template (std::string old_name, std::string new_name) const;
678         void delete_template (std::string name) const;
679
680         static Config* instance ();
681         static void drop ();
682         static void restore_defaults ();
683         static bool have_existing (std::string);
684         static boost::filesystem::path config_file ();
685
686         static boost::optional<boost::filesystem::path> test_path;
687
688 private:
689         Config ();
690         static boost::filesystem::path path (std::string file, bool create_directories = true);
691         void read ();
692         void set_defaults ();
693         void set_kdm_email_to_default ();
694         void set_cover_sheet_to_default ();
695         void read_cinemas (cxml::Document const & f);
696         boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
697         boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
698
699         template <class T>
700         void maybe_set (T& member, T new_value, Property prop = OTHER) {
701                 if (member == new_value) {
702                         return;
703                 }
704                 member = new_value;
705                 changed (prop);
706         }
707
708         template <class T>
709         void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
710                 if (member && member.get() == new_value) {
711                         return;
712                 }
713                 member = new_value;
714                 changed (prop);
715         }
716
717         /** number of threads which a master DoM should use for J2K encoding on the local machine */
718         int _master_encoding_threads;
719         /** number of threads which a server should use for J2K encoding on the local machine */
720         int _server_encoding_threads;
721         /** default directory to put new films in */
722         boost::optional<boost::filesystem::path> _default_directory;
723         /** base port number to use for J2K encoding servers;
724          *  this port and the two above it will be used.
725          */
726         int _server_port_base;
727         /** true to broadcast on the `any' address to look for servers */
728         bool _use_any_servers;
729         /** J2K encoding servers that should definitely be used */
730         std::vector<std::string> _servers;
731         bool _only_servers_encode;
732         Protocol _tms_protocol;
733         /** The IP address of a TMS that we can copy DCPs to */
734         std::string _tms_ip;
735         /** The path on a TMS that we should write DCPs to */
736         std::string _tms_path;
737         /** User name to log into the TMS with */
738         std::string _tms_user;
739         /** Password to log into the TMS with */
740         std::string _tms_password;
741         /** Our cinema sound processor */
742         CinemaSoundProcessor const * _cinema_sound_processor;
743         std::list<int> _allowed_dcp_frame_rates;
744         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
745         bool _allow_any_dcp_frame_rate;
746         /** Default ISDCF metadata for newly-created Films */
747         ISDCFMetadata _default_isdcf_metadata;
748         boost::optional<std::string> _language;
749         /** Default length of still image content (seconds) */
750         int _default_still_length;
751         Ratio const * _default_container;
752         Ratio const * _default_scale_to;
753         DCPContentType const * _default_dcp_content_type;
754         int _default_dcp_audio_channels;
755         std::string _dcp_issuer;
756         std::string _dcp_creator;
757         int _default_j2k_bandwidth;
758         int _default_audio_delay;
759         bool _default_interop;
760         /** Default directory to offer to write KDMs to; if it's not set,
761             the home directory will be offered.
762         */
763         boost::optional<boost::filesystem::path> _default_kdm_directory;
764         bool _default_upload_after_make_dcp;
765         std::list<boost::shared_ptr<Cinema> > _cinemas;
766         std::string _mail_server;
767         int _mail_port;
768         std::string _mail_user;
769         std::string _mail_password;
770         std::string _kdm_subject;
771         std::string _kdm_from;
772         std::vector<std::string> _kdm_cc;
773         std::string _kdm_bcc;
774         std::string _kdm_email;
775         boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
776         /** Chain used to decrypt KDMs; the leaf of this chain is the target
777          *  certificate for making KDMs given to DCP-o-matic.
778          */
779         boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
780         /** true to check for updates on startup */
781         bool _check_for_updates;
782         bool _check_for_test_updates;
783         /** maximum allowed J2K bandwidth in bits per second */
784         int _maximum_j2k_bandwidth;
785         int _log_types;
786         bool _analyse_ebur128;
787         bool _automatic_audio_analysis;
788 #ifdef DCPOMATIC_WINDOWS
789         bool _win32_console;
790 #endif
791         std::vector<boost::filesystem::path> _history;
792         boost::shared_ptr<DKDMGroup> _dkdms;
793         boost::filesystem::path _cinemas_file;
794         bool _show_hints_before_make_dcp;
795         bool _confirm_kdm_email;
796         dcp::NameFormat _kdm_filename_format;
797         dcp::NameFormat _kdm_container_name_format;
798         dcp::NameFormat _dcp_metadata_filename_format;
799         dcp::NameFormat _dcp_asset_filename_format;
800         bool _jump_to_selected;
801         bool _nagged[NAG_COUNT];
802         bool _sound;
803         /** name of a specific sound output stream to use, or empty to use the default */
804         boost::optional<std::string> _sound_output;
805         std::string _cover_sheet;
806         boost::optional<boost::filesystem::path> _last_player_load_directory;
807         boost::optional<KDMWriteType> _last_kdm_write_type;
808         int _frames_in_memory_multiplier;
809
810         /** Singleton instance, or 0 */
811         static Config* _instance;
812 };
813
814 #endif