src/verify.h

   1 /*
   2     Copyright (C) 2018-2021 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 <vector>
  42
  43 namespace dcp {
  44
  45 class VerificationNote
  46 {
  47 public:
  48         /* I've been unable to make mingw happy with ERROR as a symbol, so
  49            I'm using a VERIFY_ prefix here.
  50         */
  51         enum Type {
  52                 VERIFY_ERROR,
  53                 VERIFY_BV21_ERROR, ///< may not always be considered an error, but violates a "shall" requirement of Bv2.1
  54                 VERIFY_WARNING
  55         };
  56
  57         enum Code {
  58                 /** An error when reading the DCP.  note contains (probably technical) details. */
  59                 GENERAL_READ,
  60                 /** The hash of the CPL in the PKL does not agree with the CPL file */
  61                 CPL_HASH_INCORRECT,
  62                 /** Frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60 */
  63                 INVALID_PICTURE_FRAME_RATE,
  64                 /** The hash of a main picture asset does not agree with the PKL file.  file contains the picture asset filename. */
  65                 PICTURE_HASH_INCORRECT,
  66                 /** The hash of a main picture is different in the CPL and PKL */
  67                 PKL_CPL_PICTURE_HASHES_DIFFER,
  68                 /** The hash of a main sound asset does not agree with the PKL file.  file contains the sound asset filename. */
  69                 SOUND_HASH_INCORRECT,
  70                 /** The hash of a main sound is different in the CPL and PKL */
  71                 PKL_CPL_SOUND_HASHES_DIFFER,
  72                 /** An assetmap's <Path> entry is empty */
  73                 EMPTY_ASSET_PATH,
  74                 /** A file mentioned in an asset map cannot be found */
  75                 MISSING_ASSET,
  76                 /** The DCP contains both SMPTE and Interop-standard components */
  77                 MISMATCHED_STANDARD,
  78                 /** Some XML fails to validate against the XSD/DTD */
  79                 XML_VALIDATION_ERROR,
  80                 /** No ASSETMAP{.xml} was found */
  81                 MISSING_ASSETMAP,
  82                 /** An asset's IntrinsicDuration is less than 1 second */
  83                 INTRINSIC_DURATION_TOO_SMALL,
  84                 /** An asset's Duration is less than 1 second */
  85                 DURATION_TOO_SMALL,
  86                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s */
  87                 PICTURE_FRAME_TOO_LARGE_IN_BYTES,
  88                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s */
  89                 PICTURE_FRAME_NEARLY_TOO_LARGE_IN_BYTES,
  90                 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF */
  91                 EXTERNAL_ASSET,
  92                 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
  93                 NOT_SMPTE,
  94                 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1] */
  95                 BAD_LANGUAGE,
  96                 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1] */
  97                 PICTURE_ASSET_INVALID_SIZE_IN_PIXELS,
  98                 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1] */
  99                 PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K,
 100                 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1] */
 101                 PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K,
 102                 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1] */
 103                 PICTURE_ASSET_4K_3D,
 104                 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1] */
 105                 CLOSED_CAPTION_XML_TOO_LARGE_IN_BYTES,
 106                 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1] */
 107                 TIMED_TEXT_ASSET_TOO_LARGE_IN_BYTES,
 108                 /** The total size of all a timed text asset's fonts is larger than 10MB [Bv2.1_7.2.1] */
 109                 TIMED_TEXT_FONTS_TOO_LARGE_IN_BYTES,
 110                 /** Some SMPTE subtitle XML has no <Language> tag [Bv2.1_7.2.2] */
 111                 MISSING_SUBTITLE_LANGUAGE,
 112                 /** Not all subtitle assets specify the same <Language> tag [Bv2.1_7.2.2] */
 113                 SUBTITLE_LANGUAGES_DIFFER,
 114                 /** Some SMPTE subtitle XML has no <StartTime> tag [Bv2.1_7.2.3] */
 115                 MISSING_SUBTITLE_START_TIME,
 116                 /** Some SMPTE subtitle XML has a non-zero <StartTime> tag [Bv2.1_7.2.3] */
 117                 SUBTITLE_START_TIME_NON_ZERO,
 118                 /** The first subtitle or closed caption happens before 4s into the first reel [Bv2.1_7.2.4] */
 119                 FIRST_TEXT_TOO_EARLY,
 120                 /** At least one subtitle is less than the minimum of 15 frames suggested by [Bv2.1_7.2.5] */
 121                 SUBTITLE_TOO_SHORT,
 122                 /** At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by [Bv2.1_7.2.5] */
 123                 SUBTITLE_TOO_CLOSE,
 124                 /** There are more than 3 subtitle lines in at least one place [Bv2.1_7.2.7] */
 125                 TOO_MANY_SUBTITLE_LINES,
 126                 /** There are more than 52 characters in at least one subtitle line [Bv2.1_7.2.7] */
 127                 SUBTITLE_LINE_LONGER_THAN_RECOMMENDED,
 128                 /** There are more than 79 characters in at least one subtitle line [Bv2.1_7.2.7] */
 129                 SUBTITLE_LINE_TOO_LONG,
 130                 /** There are more than 3 closed caption lines in at least one place [Bv2.1_7.2.6] */
 131                 TOO_MANY_CLOSED_CAPTION_LINES,
 132                 /** There are more than 32 characters in at least one closed caption line [Bv2.1_7.2.6] */
 133                 CLOSED_CAPTION_LINE_TOO_LONG,
 134                 /** The audio sampling rate must be 48kHz [Bv2.1_7.3] */
 135                 INVALID_SOUND_FRAME_RATE,
 136                 /** The CPL has no <AnnotationText> tag [Bv2.1_8.1] */
 137                 MISSING_ANNOTATION_TEXT_IN_CPL,
 138                 /** The <AnnotationText> is not the same as the <ContentTitleText> [Bv2.1_8.1] */
 139                 CPL_ANNOTATION_TEXT_DIFFERS_FROM_CONTENT_TITLE_TEXT,
 140                 /** At least one asset in a reel does not have the same duration as the others */
 141                 MISMATCHED_ASSET_DURATION,
 142                 /** If one reel has a MainSubtitle, all must have them */
 143                 MAIN_SUBTITLE_NOT_IN_ALL_REELS,
 144                 /** If one reel has at least one ClosedCaption, all reels must have the same number of ClosedCaptions */
 145                 CLOSED_CAPTION_ASSET_COUNTS_DIFFER,
 146                 /** MainSubtitle in reels must have <EntryPoint> Bv2.1_8.3.2 */
 147                 MISSING_SUBTITLE_ENTRY_POINT,
 148                 /** MainSubtitle <EntryPoint> must be zero Bv2.1_8.3.2 */
 149                 SUBTITLE_ENTRY_POINT_NON_ZERO,
 150                 /** Closed caption in reels must have <EntryPoint> Bv2.1_8.3.2 */
 151                 MISSING_CLOSED_CAPTION_ENTRY_POINT,
 152                 /** Closed caption MainSubtitle <EntryPoint> must be zero Bv2.1_8.3.2 */
 153                 CLOSED_CAPTION_ENTRY_POINT_NON_ZERO,
 154                 /** <Hash> must be present for assets in CPLs */
 155                 MISSING_HASH,
 156                 /** If ContentKind is Feature there must be a FFEC marker */
 157                 MISSING_FFEC_IN_FEATURE,
 158                 /** If ContentKind is Feature there must be a FFMC marker */
 159                 MISSING_FFMC_IN_FEATURE,
 160                 /** There should be a FFOC */
 161                 MISSING_FFOC,
 162                 /** There should be a LFOC */
 163                 MISSING_LFOC,
 164                 /** The FFOC should be 1 */
 165                 INCORRECT_FFOC,
 166                 /** The LFOC should be the last frame in the reel */
 167                 INCORRECT_LFOC,
 168         };
 169
 170         VerificationNote (Type type, Code code)
 171                 : _type (type)
 172                 , _code (code)
 173         {}
 174
 175         VerificationNote (Type type, Code code, std::string note)
 176                 : _type (type)
 177                 , _code (code)
 178                 , _note (note)
 179         {}
 180
 181         VerificationNote (Type type, Code code, boost::filesystem::path file)
 182                 : _type (type)
 183                 , _code (code)
 184                 , _file (file)
 185         {}
 186
 187         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
 188                 : _type (type)
 189                 , _code (code)
 190                 , _note (note)
 191                 , _file (file)
 192         {}
 193
 194         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
 195                 : _type (type)
 196                 , _code (code)
 197                 , _note (note)
 198                 , _file (file)
 199                 , _line (line)
 200         {}
 201
 202         Type type () const {
 203                 return _type;
 204         }
 205
 206         Code code () const {
 207                 return _code;
 208         }
 209
 210         boost::optional<std::string> note () const {
 211                 return _note;
 212         }
 213
 214         boost::optional<boost::filesystem::path> file () const {
 215                 return _file;
 216         }
 217
 218         boost::optional<uint64_t> line () const {
 219                 return _line;
 220         }
 221
 222 private:
 223         Type _type;
 224         Code _code;
 225         /** Further information about the error, if applicable */
 226         boost::optional<std::string> _note;
 227         /** Path of file containing the error, if applicable */
 228         boost::optional<boost::filesystem::path> _file;
 229         /** Error line number within _file, if applicable */
 230         uint64_t _line;
 231 };
 232
 233 std::vector<VerificationNote> verify (
 234         std::vector<boost::filesystem::path> directories,
 235         boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
 236         boost::function<void (float)> progress,
 237         boost::filesystem::path xsd_dtd_directory
 238         );
 239
 240 std::string note_to_string (dcp::VerificationNote note);
 241
 242 }
 243
 244 #endif