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 "audio_analyser.h"
  22 #include "signaller.h"
  23 #include "player_text.h"
  24 #include "types.h"
  25 #include "dcp_text_track.h"
  26 #include "dcpomatic_time.h"
  27 #include "weak_film.h"
  28 #include <boost/signals2.hpp>
  29 #include <boost/atomic.hpp>
  30 #include <vector>
  31 #include <string>
  32
  33
  34 class Film;
  35 class Writer;
  36
  37
  38 class Hints : public Signaller, public ExceptionStore, public WeakConstFilm
  39 {
  40 public:
  41         explicit Hints (std::weak_ptr<const Film> film);
  42         ~Hints ();
  43
  44         void start ();
  45
  46         boost::signals2::signal<void (std::string)> Hint;
  47         boost::signals2::signal<void (std::string)> Progress;
  48         boost::signals2::signal<void (void)> Pulse;
  49         boost::signals2::signal<void (void)> Finished;
  50
  51         /* For tests only */
  52         void join ();
  53
  54 private:
  55         friend struct hint_subtitle_too_early;
  56
  57         void thread ();
  58         void hint (std::string h);
  59         void audio (std::shared_ptr<AudioBuffers> audio, dcpomatic::DCPTime time);
  60         void text (PlayerText text, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period);
  61         void closed_caption (PlayerText text, dcpomatic::DCPTimePeriod period);
  62         void open_subtitle (PlayerText text, dcpomatic::DCPTimePeriod period);
  63
  64         void check_interop ();
  65         void check_big_font_files ();
  66         void check_few_audio_channels ();
  67         void check_upmixers ();
  68         void check_incorrect_container ();
  69         void check_unusual_container ();
  70         void check_high_j2k_bandwidth ();
  71         void check_frame_rate ();
  72         void check_4k_3d ();
  73         void check_speed_up ();
  74         void check_vob ();
  75         void check_3d_in_2d ();
  76         bool check_loudness ();
  77         void check_ffec_and_ffmc_in_smpte_feature ();
  78         void check_out_of_range_markers ();
  79         void check_text_languages ();
  80
  81         boost::thread _thread;
  82         /** This is used to make a partial DCP containing only the subtitles and closed captions that
  83          *  our final DCP will have.  This means we can see how big the files will be and warn if they
  84          *  will be too big.
  85          */
  86         std::shared_ptr<Writer> _writer;
  87
  88         AudioAnalyser _analyser;
  89
  90         bool _long_ccap = false;
  91         bool _overlap_ccap = false;
  92         bool _too_many_ccap_lines = false;
  93         boost::optional<dcpomatic::DCPTimePeriod> _last_ccap;
  94
  95         bool _early_subtitle = false;
  96         bool _short_subtitle = false;
  97         bool _subtitles_too_close = false;
  98         bool _too_many_subtitle_lines = false;
  99         bool _long_subtitle = false;
 100         bool _very_long_subtitle = false;
 101         boost::optional<dcpomatic::DCPTimePeriod> _last_subtitle;
 102
 103         boost::atomic<bool> _stop;
 104 };