test/test.h

   1 /*
   2     Copyright (C) 2013-2021 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
  22 #include "lib/types.h"
  23 #include <dcp/verify.h>
  24 #include <boost/filesystem.hpp>
  25 #include <vector>
  26
  27
  28 class Film;
  29 class Image;
  30 class Log;
  31
  32
  33 class TestPaths
  34 {
  35 public:
  36         static boost::filesystem::path private_data();
  37         static boost::filesystem::path xsd();
  38 };
  39
  40
  41 class Cleanup
  42 {
  43 public:
  44         void add (boost::filesystem::path path);
  45
  46         /* Remove everything passed to add().  We don't do this
  47          * in a destructor so that results of failed tests aren't
  48          * deleted.
  49          */
  50         void run ();
  51
  52 private:
  53         std::vector<boost::filesystem::path> _paths;
  54 };
  55
  56
  57 extern bool wait_for_jobs ();
  58 extern std::shared_ptr<Film> new_test_film (std::string);
  59 extern std::shared_ptr<Film> new_test_film2 (std::string, std::vector<std::shared_ptr<Content>> content = {}, Cleanup* cleanup = nullptr);
  60 extern void check_dcp (boost::filesystem::path, boost::filesystem::path);
  61 extern void check_dcp (boost::filesystem::path, std::shared_ptr<const Film>);
  62 extern void check_file (boost::filesystem::path ref, boost::filesystem::path check);
  63 extern void check_text_file (boost::filesystem::path ref, boost::filesystem::path check);
  64 extern void check_wav_file (boost::filesystem::path ref, boost::filesystem::path check);
  65 extern void check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check);
  66 extern bool mxf_atmos_files_same (boost::filesystem::path ref, boost::filesystem::path check, bool verbose = false);
  67 extern void check_xml (boost::filesystem::path, boost::filesystem::path, std::list<std::string>);
  68 extern void check_ffmpeg (boost::filesystem::path, boost::filesystem::path, int audio_tolerance);
  69 extern void check_image (boost::filesystem::path, boost::filesystem::path, double threshold = 4);
  70 extern boost::filesystem::path test_film_dir (std::string);
  71 extern void write_image (std::shared_ptr<const Image> image, boost::filesystem::path file);
  72 boost::filesystem::path dcp_file (std::shared_ptr<const Film> film, std::string prefix);
  73 void check_one_frame (boost::filesystem::path dcp, int64_t index, boost::filesystem::path ref);
  74 extern boost::filesystem::path subtitle_file (std::shared_ptr<Film> film);
  75 extern void make_random_file (boost::filesystem::path path, size_t size);
  76 extern void make_and_verify_dcp (std::shared_ptr<Film> film, std::vector<dcp::VerificationNote::Code> ignore = {});
  77 extern void check_int_close (int a, int b, int d);
  78 extern void check_int_close (std::pair<int, int>, std::pair<int, int>, int d);
  79 extern boost::filesystem::path find_file (boost::filesystem::path dir, std::string filename_part);
  80
  81
  82 class LogSwitcher
  83 {
  84 public:
  85         LogSwitcher (std::shared_ptr<Log> log);
  86         ~LogSwitcher ();
  87
  88 private:
  89         std::shared_ptr<Log> _old;
  90 };
  91
  92
  93 class ConfigRestorer
  94 {
  95 public:
  96         ~ConfigRestorer();
  97 };
  98
  99
 100 namespace dcp {
 101
 102 std::ostream& operator<< (std::ostream& s, dcp::Size i);
 103 std::ostream& operator<< (std::ostream& s, dcp::Standard t);
 104
 105 }
 106
 107 std::ostream& operator<< (std::ostream& s, VideoFrameType f);