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         /** Codes for errors or warnings from verifying DCPs.
  58          *
  59          *  The names should (in general) answer the question "what is wrong?" with an answer that begins "There is a ..."
  60          *  e.g. "There is a INCORRECT_CPL_HASH"
  61          *       "There is a MISSING_ASSET"
  62          *
  63          *  In general the pattern should be <negative-adjective> <noun>.
  64          *  Some <negative-adjective>s are:
  65          *
  66          *  - INCORRECT: something, which could have any value, is wrong.
  67          *  - INVALID: something, which should only be one of a set of values, is not in the set, or some preformatted
  68          *             quantity (e.g. XML) is in the wrong format.
  69          *  - MISMATCHED: two things, which should be the same, are not.
  70          *  - EMPTY: something, which should have a value, has no value.
  71          *  - MISSING: something, which should be present, is not.
  72          *  - FAILED: some part of the verification failed in some serious way.
  73          *
  74          *  Comments should clarify meaning and also say which of the optional fields (e.g. file)
  75          *  are filled in when this code is used.
  76          *  XXX: this needs checking.
  77          */
  78         enum Code {
  79                 /** An error when reading the DCP.  note contains (probably technical) details. */
  80                 FAILED_READ,
  81                 /** The hash of the CPL in the PKL does not agree with the CPL file */
  82                 MISMATCHED_CPL_HASHES,
  83                 /** Frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60 */
  84                 INVALID_PICTURE_FRAME_RATE,
  85                 /** The hash of a main picture asset does not agree with the PKL file.  file contains the picture asset filename. */
  86                 INCORRECT_PICTURE_HASH,
  87                 /** The hash of a main picture is different in the CPL and PKL */
  88                 MISMATCHED_PICTURE_HASHES,
  89                 /** The hash of a main sound asset does not agree with the PKL file.  file contains the sound asset filename. */
  90                 INCORRECT_SOUND_HASH,
  91                 /** The hash of a main sound is different in the CPL and PKL */
  92                 MISMATCHED_SOUND_HASHES,
  93                 /** An assetmap's <Path> entry is empty */
  94                 EMPTY_ASSET_PATH,
  95                 /** A file mentioned in an asset map cannot be found */
  96                 MISSING_ASSET,
  97                 /** The DCP contains both SMPTE and Interop-standard components */
  98                 MISMATCHED_STANDARD,
  99                 /** Some XML fails to validate against the XSD/DTD */
 100                 INVALID_XML,
 101                 /** No ASSETMAP{.xml} was found */
 102                 MISSING_ASSETMAP,
 103                 /** An asset's IntrinsicDuration is less than 1 second */
 104                 INVALID_INTRINSIC_DURATION,
 105                 /** An asset's Duration is less than 1 second */
 106                 INVALID_DURATION,
 107                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s */
 108                 INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
 109                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s */
 110                 NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
 111                 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF */
 112                 EXTERNAL_ASSET,
 113                 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
 114                 INVALID_STANDARD,
 115                 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1] */
 116                 INVALID_LANGUAGE,
 117                 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1] */
 118                 INVALID_PICTURE_SIZE_IN_PIXELS,
 119                 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1] */
 120                 INVALID_PICTURE_FRAME_RATE_FOR_2K,
 121                 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1] */
 122                 INVALID_PICTURE_FRAME_RATE_FOR_4K,
 123                 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1] */
 124                 INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
 125                 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1] */
 126                 INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES,
 127                 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1] */
 128                 INVALID_TIMED_TEXT_SIZE_IN_BYTES,
 129                 /** The total size of all a timed text asset's fonts is larger than 10MB [Bv2.1_7.2.1] */
 130                 INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES,
 131                 /** Some SMPTE subtitle XML has no <Language> tag [Bv2.1_7.2.2] */
 132                 MISSING_SUBTITLE_LANGUAGE,
 133                 /** Not all subtitle assets specify the same <Language> tag [Bv2.1_7.2.2] */
 134                 MISMATCHED_SUBTITLE_LANGUAGES,
 135                 /** Some SMPTE subtitle XML has no <StartTime> tag [Bv2.1_7.2.3] */
 136                 MISSING_SUBTITLE_START_TIME,
 137                 /** Some SMPTE subtitle XML has a non-zero <StartTime> tag [Bv2.1_7.2.3] */
 138                 INVALID_SUBTITLE_START_TIME,
 139                 /** The first subtitle or closed caption happens before 4s into the first reel [Bv2.1_7.2.4] */
 140                 INVALID_SUBTITLE_FIRST_TEXT_TIME,
 141                 /** At least one subtitle is less than the minimum of 15 frames suggested by [Bv2.1_7.2.5] */
 142                 INVALID_SUBTITLE_DURATION,
 143                 /** At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by [Bv2.1_7.2.5] */
 144                 INVALID_SUBTITLE_SPACING,
 145                 /** There are more than 3 subtitle lines in at least one place [Bv2.1_7.2.7] */
 146                 INVALID_SUBTITLE_LINE_COUNT,
 147                 /** There are more than 52 characters in at least one subtitle line [Bv2.1_7.2.7] */
 148                 NEARLY_INVALID_SUBTITLE_LINE_LENGTH,
 149                 /** There are more than 79 characters in at least one subtitle line [Bv2.1_7.2.7] */
 150                 INVALID_SUBTITLE_LINE_LENGTH,
 151                 /** There are more than 3 closed caption lines in at least one place [Bv2.1_7.2.6] */
 152                 INVALID_CLOSED_CAPTION_LINE_COUNT,
 153                 /** There are more than 32 characters in at least one closed caption line [Bv2.1_7.2.6] */
 154                 INVALID_CLOSED_CAPTION_LINE_LENGTH,
 155                 /** The audio sampling rate must be 48kHz [Bv2.1_7.3] */
 156                 INVALID_SOUND_FRAME_RATE,
 157                 /** The CPL has no <AnnotationText> tag [Bv2.1_8.1] */
 158                 MISSING_CPL_ANNOTATION_TEXT,
 159                 /** The <AnnotationText> is not the same as the <ContentTitleText> [Bv2.1_8.1] */
 160                 MISMATCHED_CPL_ANNOTATION_TEXT,
 161                 /** At least one asset in a reel does not have the same duration as the others */
 162                 MISMATCHED_ASSET_DURATION,
 163                 /** If one reel has a MainSubtitle, all must have them */
 164                 MISSING_MAIN_SUBTITLE_FROM_SOME_REELS,
 165                 /** If one reel has at least one ClosedCaption, all reels must have the same number of ClosedCaptions */
 166                 MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS,
 167                 /** MainSubtitle in reels must have <EntryPoint> Bv2.1_8.3.2 */
 168                 MISSING_SUBTITLE_ENTRY_POINT,
 169                 /** MainSubtitle <EntryPoint> must be zero Bv2.1_8.3.2 */
 170                 INCORRECT_SUBTITLE_ENTRY_POINT,
 171                 /** Closed caption in reels must have <EntryPoint> Bv2.1_8.3.2 */
 172                 MISSING_CLOSED_CAPTION_ENTRY_POINT,
 173                 /** Closed caption MainSubtitle <EntryPoint> must be zero Bv2.1_8.3.2 */
 174                 INCORRECT_CLOSED_CAPTION_ENTRY_POINT,
 175                 /** <Hash> must be present for assets in CPLs */
 176                 MISSING_HASH,
 177                 /** If ContentKind is Feature there must be a FFEC marker */
 178                 MISSING_FFEC_IN_FEATURE,
 179                 /** If ContentKind is Feature there must be a FFMC marker */
 180                 MISSING_FFMC_IN_FEATURE,
 181                 /** There should be a FFOC */
 182                 MISSING_FFOC,
 183                 /** There should be a LFOC */
 184                 MISSING_LFOC,
 185                 /** The FFOC should be 1 */
 186                 INCORRECT_FFOC,
 187                 /** The LFOC should be the last frame in the reel */
 188                 INCORRECT_LFOC,
 189                 /** There must be a <CompositionMetadataAsset> */
 190                 MISSING_CPL_METADATA,
 191                 /** CPL metadata should contain <VersionNumber> of 1, at least */
 192                 MISSING_CPL_METADATA_VERSION_NUMBER,
 193                 /** There must be an <ExtensionMetadata> in <CompositionMetadataAsset> Bv2.1_8.6.3 */
 194                 MISSING_EXTENSION_METADATA,
 195                 /** <ExtensionMetadata> must have a particular form Bv2.1_8.6.3 */
 196                 INVALID_EXTENSION_METADATA,
 197                 /** CPLs containing encrypted content must be signed Bv2.1_8.7 */
 198                 UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT,
 199                 /** PKLs containing encrypted content must be signed Bv2.1_8.7 */
 200                 UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT,
 201                 /** If a PKL has one CPL its <ContentTitleText> must be the same as the PKL's <AnnotationText> */
 202                 MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL,
 203                 /** If any content is encrypted, everything must be encrypted */
 204                 PARTIALLY_ENCRYPTED,
 205         };
 206
 207         VerificationNote (Type type, Code code)
 208                 : _type (type)
 209                 , _code (code)
 210         {}
 211
 212         VerificationNote (Type type, Code code, std::string note)
 213                 : _type (type)
 214                 , _code (code)
 215                 , _note (note)
 216         {}
 217
 218         VerificationNote (Type type, Code code, boost::filesystem::path file)
 219                 : _type (type)
 220                 , _code (code)
 221                 , _file (file)
 222         {}
 223
 224         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
 225                 : _type (type)
 226                 , _code (code)
 227                 , _note (note)
 228                 , _file (file)
 229         {}
 230
 231         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
 232                 : _type (type)
 233                 , _code (code)
 234                 , _note (note)
 235                 , _file (file)
 236                 , _line (line)
 237         {}
 238
 239         Type type () const {
 240                 return _type;
 241         }
 242
 243         Code code () const {
 244                 return _code;
 245         }
 246
 247         boost::optional<std::string> note () const {
 248                 return _note;
 249         }
 250
 251         boost::optional<boost::filesystem::path> file () const {
 252                 return _file;
 253         }
 254
 255         boost::optional<uint64_t> line () const {
 256                 return _line;
 257         }
 258
 259 private:
 260         Type _type;
 261         Code _code;
 262         /** Further information about the error, if applicable */
 263         boost::optional<std::string> _note;
 264         /** Path of file containing the error, if applicable */
 265         boost::optional<boost::filesystem::path> _file;
 266         /** Error line number within _file, if applicable */
 267         boost::optional<uint64_t> _line;
 268 };
 269
 270 std::vector<VerificationNote> verify (
 271         std::vector<boost::filesystem::path> directories,
 272         boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
 273         boost::function<void (float)> progress,
 274         boost::filesystem::path xsd_dtd_directory
 275         );
 276
 277 std::string note_to_string (dcp::VerificationNote note);
 278
 279 }
 280
 281 #endif