Add some hints for violations of SMPTE Bv2.1 with subtitles and closed
[dcpomatic.git] / src / lib / hints.h
1 /*
2     Copyright (C) 2016-2020 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 #include "signaller.h"
22 #include "player_text.h"
23 #include "types.h"
24 #include "dcp_text_track.h"
25 #include "dcpomatic_time.h"
26 #include <boost/weak_ptr.hpp>
27 #include <boost/signals2.hpp>
28 #include <boost/atomic.hpp>
29 #include <vector>
30 #include <string>
31
32 class Film;
33
34 class Hints : public Signaller, public ExceptionStore
35 {
36 public:
37         explicit Hints (boost::weak_ptr<const Film> film);
38         ~Hints ();
39
40         void start ();
41
42         boost::signals2::signal<void (std::string)> Hint;
43         boost::signals2::signal<void (std::string)> Progress;
44         boost::signals2::signal<void (void)> Pulse;
45         boost::signals2::signal<void (void)> Finished;
46
47         /* For tests only */
48         void join ();
49
50 private:
51         friend struct hint_subtitle_too_early;
52
53         void thread ();
54         void hint (std::string h);
55         void text (PlayerText text, TextType type, dcpomatic::DCPTimePeriod period);
56         void closed_caption (PlayerText text, dcpomatic::DCPTimePeriod period);
57         void open_subtitle (PlayerText text, dcpomatic::DCPTimePeriod period);
58         boost::shared_ptr<const Film> film () const;
59
60         void check_big_font_files ();
61         void check_few_audio_channels ();
62         void check_upmixers ();
63         void check_incorrect_container ();
64         void check_unusual_container ();
65         void check_high_j2k_bandwidth ();
66         void check_frame_rate ();
67         void check_speed_up ();
68         void check_vob ();
69         void check_3d_in_2d ();
70         void check_loudness ();
71         void check_ffec_and_ffmc_in_smpte_feature ();
72
73         boost::weak_ptr<const Film> _film;
74         boost::thread _thread;
75
76         bool _long_ccap;
77         bool _overlap_ccap;
78         bool _too_many_ccap_lines;
79         boost::optional<dcpomatic::DCPTimePeriod> _last_ccap;
80
81         bool _early_subtitle;
82         bool _short_subtitle;
83         bool _subtitles_too_close;
84         bool _too_many_subtitle_lines;
85         bool _long_subtitle;
86         boost::optional<dcpomatic::DCPTimePeriod> _last_subtitle;
87
88         boost::atomic<bool> _stop;
89 };