src/verify.h

   1 /*
   2     Copyright (C) 2018-2020 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #ifndef LIBDCP_VERIFY_H
  35 #define LIBDCP_VERIFY_H
  36
  37 #include <boost/filesystem.hpp>
  38 #include <boost/function.hpp>
  39 #include <boost/optional.hpp>
  40 #include <string>
  41 #include <list>
  42 #include <vector>
  43
  44 namespace dcp {
  45
  46 class VerificationNote
  47 {
  48 public:
  49         /* I've been unable to make mingw happy with ERROR as a symbol, so
  50            I'm using a VERIFY_ prefix here.
  51         */
  52         enum Type {
  53                 VERIFY_ERROR,
  54                 VERIFY_BV21_ERROR, ///< may not always be considered an error, but violates a "shall" requirement of Bv2.1
  55                 VERIFY_WARNING
  56         };
  57
  58         enum Code {
  59                 /** An error when reading the DCP.  note contains (probably technical) details. */
  60                 GENERAL_READ,
  61                 /** The hash of the CPL in the PKL does not agree with the CPL file */
  62                 CPL_HASH_INCORRECT,
  63                 /** Frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60 */
  64                 INVALID_PICTURE_FRAME_RATE,
  65                 /** The hash of a main picture asset does not agree with the PKL file.  file contains the picture asset filename. */
  66                 PICTURE_HASH_INCORRECT,
  67                 /** The hash of a main picture is different in the CPL and PKL */
  68                 PKL_CPL_PICTURE_HASHES_DISAGREE,
  69                 /** The hash of a main sound asset does not agree with the PKL file.  file contains the sound asset filename. */
  70                 SOUND_HASH_INCORRECT,
  71                 /** The hash of a main sound is different in the CPL and PKL */
  72                 PKL_CPL_SOUND_HASHES_DISAGREE,
  73                 /** An assetmap's <Path> entry is empty */
  74                 EMPTY_ASSET_PATH,
  75                 /** A file mentioned in an asset map cannot be found */
  76                 MISSING_ASSET,
  77                 /** The DCP contains both SMPTE and Interop-standard components */
  78                 MISMATCHED_STANDARD,
  79                 /** Some XML fails to validate against the XSD/DTD */
  80                 XML_VALIDATION_ERROR,
  81                 /** No ASSETMAP{.xml} was found */
  82                 MISSING_ASSETMAP,
  83                 /** An asset's IntrinsicDuration is less than 1 second */
  84                 INTRINSIC_DURATION_TOO_SMALL,
  85                 /** An asset's Duration is less than 1 second */
  86                 DURATION_TOO_SMALL,
  87                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s */
  88                 PICTURE_FRAME_TOO_LARGE_IN_BYTES,
  89                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s */
  90                 PICTURE_FRAME_NEARLY_TOO_LARGE_IN_BYTES,
  91                 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF */
  92                 EXTERNAL_ASSET,
  93                 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
  94                 NOT_SMPTE,
  95                 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1] */
  96                 BAD_LANGUAGE,
  97                 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1] */
  98                 PICTURE_ASSET_INVALID_SIZE_IN_PIXELS,
  99                 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1] */
 100                 PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K,
 101                 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1] */
 102                 PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K,
 103                 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1] */
 104                 PICTURE_ASSET_4K_3D,
 105                 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1] */
 106                 CLOSED_CAPTION_XML_TOO_LARGE_IN_BYTES,
 107                 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1] */
 108                 TIMED_TEXT_ASSET_TOO_LARGE_IN_BYTES,
 109         };
 110
 111         VerificationNote (Type type, Code code)
 112                 : _type (type)
 113                 , _code (code)
 114         {}
 115
 116         VerificationNote (Type type, Code code, std::string note)
 117                 : _type (type)
 118                 , _code (code)
 119                 , _note (note)
 120         {}
 121
 122         VerificationNote (Type type, Code code, boost::filesystem::path file)
 123                 : _type (type)
 124                 , _code (code)
 125                 , _file (file)
 126         {}
 127
 128         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
 129                 : _type (type)
 130                 , _code (code)
 131                 , _note (note)
 132                 , _file (file)
 133         {}
 134
 135         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
 136                 : _type (type)
 137                 , _code (code)
 138                 , _note (note)
 139                 , _file (file)
 140                 , _line (line)
 141         {}
 142
 143         Type type () const {
 144                 return _type;
 145         }
 146
 147         Code code () const {
 148                 return _code;
 149         }
 150
 151         boost::optional<std::string> note () const {
 152                 return _note;
 153         }
 154
 155         boost::optional<boost::filesystem::path> file () const {
 156                 return _file;
 157         }
 158
 159         boost::optional<uint64_t> line () const {
 160                 return _line;
 161         }
 162
 163 private:
 164         Type _type;
 165         Code _code;
 166         /** Further information about the error, if applicable */
 167         boost::optional<std::string> _note;
 168         /** Path of file containing the error, if applicable */
 169         boost::optional<boost::filesystem::path> _file;
 170         /** Error line number within _file, if applicable */
 171         uint64_t _line;
 172 };
 173
 174 std::list<VerificationNote> verify (
 175         std::vector<boost::filesystem::path> directories,
 176         boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
 177         boost::function<void (float)> progress,
 178         boost::filesystem::path xsd_dtd_directory
 179         );
 180
 181 std::string note_to_string (dcp::VerificationNote note);
 182
 183 }
 184
 185 #endif