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
  35 /** @file  src/verify.h
  36  *  @brief dcp::verify() method and associated code
  37  */
  38
  39
  40 #ifndef LIBDCP_VERIFY_H
  41 #define LIBDCP_VERIFY_H
  42
  43
  44 #include "decrypted_kdm.h"
  45 #include <boost/any.hpp>
  46 #include <boost/filesystem.hpp>
  47 #include <boost/function.hpp>
  48 #include <boost/optional.hpp>
  49 #include <map>
  50 #include <string>
  51 #include <vector>
  52
  53
  54 /* windows.h defines this but we want to use it */
  55 #undef ERROR
  56
  57
  58 namespace dcp {
  59
  60
  61 class DCP;
  62
  63
  64 class VerificationNote
  65 {
  66 public:
  67         enum class Type {
  68                 OK,
  69                 ERROR,
  70                 BV21_ERROR, ///< may not always be considered an error, but violates a "shall" requirement of Bv2.1
  71                 WARNING
  72         };
  73
  74         /** Codes for successful checks, errors or warnings from verifying DCPs.
  75          *
  76          *  The names should (in general) answer the question "what is wrong?" with an answer that begins "There is a ..."
  77          *  e.g. "There is a INCORRECT_CPL_HASH"
  78          *       "There is a MISSING_ASSET"
  79          *
  80          *  In general the pattern should be <negative-adjective> <noun>.
  81          *  Some <negative-adjective>s are:
  82          *
  83          *  - INCORRECT: something, which could have any value, is wrong.
  84          *  - INVALID: something, which should only be one of a set of values, is not in the set, or some preformatted
  85          *             quantity (e.g. XML) is in the wrong format.
  86          *  - MISMATCHED: two things, which should be the same, are not.
  87          *  - EMPTY: something, which should have a value, has no value.
  88          *  - MISSING: something, which should be present, is not.
  89          *  - UNEXPECTED: something, which is present, should not be.
  90          *  - FAILED: some part of the verification failed in some serious way.
  91          *
  92          *  Comments should clarify meaning and also say which of the optional fields (e.g. file)
  93          *  are filled in when this code is used.
  94          */
  95
  96         // If you change the next line, also look in doc/manual/verifier.py in DCP-o-matic
  97         // as it looks for it when compiling the manual.  Also, in this enum:
  98         //   [...]  will be taken as a reference to a section of Bv2.1
  99         //   _foo_  means foo should be written as a piece of code
 100         enum class Code {
 101                 /** A general error when reading the DCP
 102                  *  note contains (probably technical) details
 103                  */
 104                 FAILED_READ,
 105                 MATCHING_CPL_HASHES,
 106                 /** The hash of the CPL in the PKL does not agree with the CPL file
 107                  *  note contains CPL ID
 108                  *  file contains CPL filename
 109                  *  calculated_hash contains current hash of the CPL
 110                  *  reference_hash contains the hash written in the PKL
 111                  */
 112                 MISMATCHED_CPL_HASHES,
 113                 /** The frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60
 114                  *  note contains the invalid frame rate as "<numerator>/<denominator>"
 115                  */
 116                 INVALID_PICTURE_FRAME_RATE,
 117                 /** The hash of a main picture asset does not agree with the PKL file
 118                  *  file contains the picture asset filename
 119                  *  calculated_hash contains the current hash of the picture MXF
 120                  *  reference_hash contains the hash from the PKL
 121                  */
 122                 INCORRECT_PICTURE_HASH,
 123                 /** The hash of a main picture is different in the CPL and PKL
 124                  *  file contains the picture asset filename
 125                  */
 126                 MISMATCHED_PICTURE_HASHES,
 127                 /** The hash of a main sound asset does not agree with the PKL file
 128                  *  file contains the sound asset filename
 129                  *  calculated_hash contains the current hash of the picture MXF
 130                  *  reference_hash contains the hash from the PKL
 131                  */
 132                 INCORRECT_SOUND_HASH,
 133                 /** The hash of a main sound is different in the CPL and PKL
 134                  *  file contains the sound asset filename
 135                  */
 136                 MISMATCHED_SOUND_HASHES,
 137                 /** An assetmap's _<Path>_ entry is empty */
 138                 EMPTY_ASSET_PATH,
 139                 /** A file mentioned in an asset map cannot be found
 140                  *  file contains the filename that is missing
 141                  */
 142                 MISSING_ASSET,
 143                 /** The DCP contains both SMPTE and Interop-standard components */
 144                 MISMATCHED_STANDARD,
 145                 /** Some XML fails to validate against its XSD/DTD
 146                  *  note contains the (probably technical) details
 147                  *  file contains the invalid filename
 148                  *  line contains the line number
 149                  */
 150                 INVALID_XML,
 151                 /** No _ASSETMAP_ or _ASSETMAP.xml_ was found */
 152                 MISSING_ASSETMAP,
 153                 /** An asset's _IntrinsicDuration_ is less than 1 second
 154                  *  note contains asset ID
 155                  */
 156                 INVALID_INTRINSIC_DURATION,
 157                 /** An asset's _Duration_ is less than 1 second
 158                  *  note contains asset ID
 159                  */
 160                 INVALID_DURATION,
 161                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s
 162                  *  file contains the picture asset filename
 163                  */
 164                 INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
 165                 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s
 166                  *  file contains the picture asset filename
 167                  */
 168                 NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
 169                 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF
 170                  *  note contains the asset ID
 171                  */
 172                 EXTERNAL_ASSET,
 173                 /** A stereoscopic asset has an MXF which is marked as being monoscopic
 174                  *  file contains the asset filename
 175                  */
 176                 THREED_ASSET_MARKED_AS_TWOD,
 177                 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
 178                 INVALID_STANDARD,
 179                 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1]
 180                  *  note contains the invalid language
 181                  */
 182                 INVALID_LANGUAGE,
 183                 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1]
 184                  *  note contains the incorrect size as "<width>x<height>"
 185                  *  file contains the asset filename
 186                  */
 187                 INVALID_PICTURE_SIZE_IN_PIXELS,
 188                 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1]
 189                  *  note contains the invalid frame rate as "<numerator>/<denominator>"
 190                  *  file contains the asset filename
 191                  */
 192                 INVALID_PICTURE_FRAME_RATE_FOR_2K,
 193                 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1]
 194                  *  note contains the invalid frame rate as "<numerator>/<denominator>"
 195                  *  file contains the asset filename
 196                  */
 197                 INVALID_PICTURE_FRAME_RATE_FOR_4K,
 198                 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1]
 199                  *  note contains the invalid frame rate as "<numerator>/<denominator>"
 200                  *  file contains the asset filename
 201                  */
 202                 INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
 203                 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1]
 204                  *  note contains the invalid size in bytes
 205                  *  file contains the asset filename
 206                  */
 207                 INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES,
 208                 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1]
 209                  *  note contains the invalid size in bytes
 210                  *  file contains the asset filename
 211                  */
 212                 INVALID_TIMED_TEXT_SIZE_IN_BYTES,
 213                 /** The total size of all a timed text asset's fonts is larger than 10MB [Bv2.1_7.2.1]
 214                  *  note contains the invalid size in bytes
 215                  *  file contains the asset filename
 216                  */
 217                 INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES,
 218                 /** Some SMPTE subtitle XML has no _<Language>_ tag [Bv2.1_7.2.2]
 219                  *  file contains the asset filename
 220                  */
 221                 MISSING_SUBTITLE_LANGUAGE,
 222                 /** Not all subtitle assets specify the same _<Language>_ tag [Bv2.1_7.2.2] */
 223                 MISMATCHED_SUBTITLE_LANGUAGES,
 224                 /** Some SMPTE subtitle XML has no _<StartTime>_ tag [Bv2.1_7.2.3]
 225                  *  file contains the asset filename
 226                  */
 227                 MISSING_SUBTITLE_START_TIME,
 228                 /** Some SMPTE subtitle XML has a non-zero _<StartTime>_ tag [Bv2.1_7.2.3]
 229                  *  file contains the asset filename
 230                  */
 231                 INVALID_SUBTITLE_START_TIME,
 232                 /** The first subtitle or closed caption happens before 4s into the first reel [Bv2.1_7.2.4] */
 233                 INVALID_SUBTITLE_FIRST_TEXT_TIME,
 234                 /** At least one subtitle is less than the minimum of 15 frames suggested by [Bv2.1_7.2.5] */
 235                 INVALID_SUBTITLE_DURATION,
 236                 /** At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by [Bv2.1_7.2.5] */
 237                 INVALID_SUBTITLE_SPACING,
 238                 /** A subtitle lasts for longer than the reel which contains it */
 239                 SUBTITLE_OVERLAPS_REEL_BOUNDARY,
 240                 /** There are more than 3 subtitle lines in at least one place [Bv2.1_7.2.7] */
 241                 INVALID_SUBTITLE_LINE_COUNT,
 242                 /** There are more than 52 characters in at least one subtitle line [Bv2.1_7.2.7] */
 243                 NEARLY_INVALID_SUBTITLE_LINE_LENGTH,
 244                 /** There are more than 79 characters in at least one subtitle line [Bv2.1_7.2.7] */
 245                 INVALID_SUBTITLE_LINE_LENGTH,
 246                 /** There are more than 3 closed caption lines in at least one place [Bv2.1_7.2.6] */
 247                 INVALID_CLOSED_CAPTION_LINE_COUNT,
 248                 /** There are more than 32 characters in at least one closed caption line [Bv2.1_7.2.6] */
 249                 INVALID_CLOSED_CAPTION_LINE_LENGTH,
 250                 /** The audio sampling rate must be 48kHz [Bv2.1_7.3]
 251                  *  note contains the invalid frame rate
 252                  *  file contains the asset filename
 253                  */
 254                 INVALID_SOUND_FRAME_RATE,
 255                 /** The CPL has no _<AnnotationText>_ tag [Bv2.1_8.1]
 256                  *  note contains the CPL ID
 257                  *  file contains the CPL filename
 258                  */
 259                 MISSING_CPL_ANNOTATION_TEXT,
 260                 /** The _<AnnotationText>_ is not the same as the _<ContentTitleText>_ [Bv2.1_8.1]
 261                  *  note contains the CPL ID
 262                  *  file contains the CPL filename
 263                  */
 264                 MISMATCHED_CPL_ANNOTATION_TEXT,
 265                 /** At least one asset in a reel does not have the same duration as the others */
 266                 MISMATCHED_ASSET_DURATION,
 267                 /** If one reel has a _MainSubtitle_, all must have them */
 268                 MISSING_MAIN_SUBTITLE_FROM_SOME_REELS,
 269                 /** If one reel has at least one _ClosedCaption_, all reels must have the same number of _ClosedCaptions_ */
 270                 MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS,
 271                 /** MainSubtitle in reels must have _<EntryPoint>_ [Bv2.1_8.3.2]
 272                  *  note contains the asset ID
 273                  */
 274                 MISSING_SUBTITLE_ENTRY_POINT,
 275                 /** MainSubtitle _<EntryPoint>_ must be zero [Bv2.1_8.3.2]
 276                  *  note contains the asset ID
 277                  */
 278                 INCORRECT_SUBTITLE_ENTRY_POINT,
 279                 /** Closed caption in reels must have _<EntryPoint>_ [Bv2.1_8.3.2]
 280                  *  note contains the asset ID
 281                  */
 282                 MISSING_CLOSED_CAPTION_ENTRY_POINT,
 283                 /** Closed caption _MainSubtitle_ _<EntryPoint>_ must be zero [Bv2.1_8.3.2]
 284                  *  note contains the asset ID
 285                  */
 286                 INCORRECT_CLOSED_CAPTION_ENTRY_POINT,
 287                 /** _<Hash>_ must be present for assets in CPLs
 288                  * note contains the asset ID
 289                  */
 290                 MISSING_HASH,
 291                 /** If _ContentKind_ is Feature there must be a FFEC marker */
 292                 MISSING_FFEC_IN_FEATURE,
 293                 /** If _ContentKind_ is Feature there must be a FFMC marker */
 294                 MISSING_FFMC_IN_FEATURE,
 295                 /** There should be a FFOC marker */
 296                 MISSING_FFOC,
 297                 /** There should be a LFOC marker */
 298                 MISSING_LFOC,
 299                 /** The FFOC marker should be 1
 300                  *  note contains the incorrect value.
 301                  */
 302                 INCORRECT_FFOC,
 303                 /** The LFOC marker should be the last frame in the reel
 304                  *  note contains the incorrect value
 305                  */
 306                 INCORRECT_LFOC,
 307                 /** There must be a _<CompositionMetadataAsset>_
 308                  *  note contains the CPL ID
 309                  *  file contains the CPL filename
 310                  */
 311                 MISSING_CPL_METADATA,
 312                 /** CPL metadata should contain _<VersionNumber>_ of 1, at least
 313                  *  note contains the CPL ID
 314                  *  file contains the CPL filename
 315                  */
 316                 MISSING_CPL_METADATA_VERSION_NUMBER,
 317                 /** There must be an _<ExtensionMetadata>_ in _<CompositionMetadataAsset>_ [Bv2.1_8.6.3]
 318                  *  note contains the CPL ID
 319                  *  file contains the CPL filename
 320                  */
 321                 MISSING_EXTENSION_METADATA,
 322                 /** _<ExtensionMetadata>_ does not have the correct form [Bv2.1_8.6.3]
 323                  *  note contains details of what's wrong
 324                  *  file contains the CPL filename
 325                  */
 326                 INVALID_EXTENSION_METADATA,
 327                 /** A CPL containing encrypted content is not signed [Bv2.1_8.7]
 328                  *  note contains the CPL ID
 329                  *  file contains the CPL filename
 330                  */
 331                 UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT,
 332                 /** A PKL containing encrypted content is not signed [Bv2.1_8.7]
 333                  *  note contains the PKL ID
 334                  *  file contains the PKL filename
 335                  */
 336                 UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT,
 337                 /** If a PKL has one CPL its _<ContentTitleText>_ must be the same as the PKL's _<AnnotationText>_
 338                  *  note contains the PKL ID
 339                  *  file contains the PKL filename
 340                  */
 341                 MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL,
 342                 /** All content is encrypted */
 343                 ALL_ENCRYPTED,
 344                 /** No content is encrypted */
 345                 NONE_ENCRYPTED,
 346                 /** Some, but not all content, is encrypted */
 347                 PARTIALLY_ENCRYPTED,
 348                 /** General error during JPEG2000 codestream verification
 349                  *  frame contains the frame index (counted from 0)
 350                  *  note contains details
 351                  */
 352                 INVALID_JPEG2000_CODESTREAM,
 353                 /** Invalid number of guard bits in a 2K JPEG2000 stream (should be 1) [Bv2.1_10.2.1]
 354                  *  note contains the number of guard bits
 355                  */
 356                 INVALID_JPEG2000_GUARD_BITS_FOR_2K,
 357                 /** Invalid number of guard bits in a 4K JPEG2000 stream (should be 2) [Bv2.1_10.2.1]
 358                  *  note contains the number of guard bits
 359                  */
 360                 INVALID_JPEG2000_GUARD_BITS_FOR_4K,
 361                 /** JPEG2000 tile size is not the same as the image size [Bv2.1_10.2.1] */
 362                 INVALID_JPEG2000_TILE_SIZE,
 363                 /** JPEG2000 code block width is not 32 [Bv2.1_10.2.1]
 364                  *  note contains the code block width
 365                  */
 366                 INVALID_JPEG2000_CODE_BLOCK_WIDTH,
 367                 /** JPEG2000 code block height is not 32 [Bv2.1_10.2.1]
 368                  *  note contains the code block height
 369                  */
 370                 INVALID_JPEG2000_CODE_BLOCK_HEIGHT,
 371                 /** There must be no POC markers in a 2K codestream [Bv2.1_10.2.1]
 372                  *  note contains the number of POC markers found
 373                  */
 374                 INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_2K,
 375                 /** There must be exactly one POC marker in a 4K codestream [Bv2.1_10.2.1]
 376                  *  note contains the number of POC markers found
 377                  */
 378                 INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_4K,
 379                 /** A POC marker has incorrect content [Bv2.1_10.2.1]
 380                  *  note contains details
 381                  */
 382                 INCORRECT_JPEG2000_POC_MARKER,
 383                 /** A POC marker was found outside the main head [Bv2.1_10.2.1] */
 384                 INVALID_JPEG2000_POC_MARKER_LOCATION,
 385                 /** Invalid number of tile parts for 2K JPEG2000 stream (should be 3) [Bv2.1_10.2.1]
 386                  *  note contains the number of tile parts
 387                  */
 388                 INVALID_JPEG2000_TILE_PARTS_FOR_2K,
 389                 /** Invalid number of tile parts for 4K JPEG2000 stream (should be 6) [Bv2.1_10.2.1]
 390                  *  note contains the number of tile parts
 391                  */
 392                 INVALID_JPEG2000_TILE_PARTS_FOR_4K,
 393                 /** No TLM marker was found [Bv2.1_10.2.1] */
 394                 MISSING_JPEG200_TLM_MARKER,
 395                 /** The MXF _ResourceID_ of a timed text resource was not the same as that of the contained XML essence [Bv2.1_10.4.3] */
 396                 MISMATCHED_TIMED_TEXT_RESOURCE_ID,
 397                 /** The AssetID of a timed text MXF is the same as its _ResourceID_ or that of the contained XML essence [Bv2.1_10.4.2] */
 398                 INCORRECT_TIMED_TEXT_ASSET_ID,
 399                 /** The ContainerDuration of a timed text MXF is not the same as the _Duration_ in its reel [Bv2.1_10.4.3]
 400                  *  note contains the reel duration, followed by a space, followed by the MXF duration
 401                  *  file contains the asset filename
 402                  */
 403                 MISMATCHED_TIMED_TEXT_DURATION,
 404                 /** Something could not be verified because content is encrypted and no key is available */
 405                 MISSED_CHECK_OF_ENCRYPTED,
 406                 /** Some timed-text XML has an empty <_Text_> node */
 407                 EMPTY_TEXT,
 408                 /** Some closed captions do not have the same vertical alignment within a <_Subtitle_> node */
 409                 MISMATCHED_CLOSED_CAPTION_VALIGN,
 410                 /** Some closed captions are not listed in the XML in the order of their vertical position */
 411                 INCORRECT_CLOSED_CAPTION_ORDERING,
 412                 /** Some <MainMarkers> asset has an <EntryPoint> that should not be there */
 413                 UNEXPECTED_ENTRY_POINT,
 414                 /** Some <MainMarkers> asset has an <Duration> that should not be there */
 415                 UNEXPECTED_DURATION,
 416                 /** A <ContentKind> has been specified with either no scope or the SMPTE 429-7 scope, but which is not one of those allowed */
 417                 INVALID_CONTENT_KIND,
 418                 /** Either the width or height of a <MainPictureActiveArea> in a CPL is either not an even number, or bigger than the corresponding asset dimension.
 419                  *  note contains details of what is wrong
 420                  *  file contains the CPL filename
 421                  */
 422                 INVALID_MAIN_PICTURE_ACTIVE_AREA,
 423                 /** A PKL has more than one asset with the same ID
 424                  *  note contains the PKL ID
 425                  *  file contains the PKL filename
 426                  */
 427                 DUPLICATE_ASSET_ID_IN_PKL,
 428                 /** An ASSETMAP has more than one asset with the same ID
 429                  *  note contains the ASSETMAP ID
 430                  *  file contains the ASSETMAP filename
 431                  */
 432                 DUPLICATE_ASSET_ID_IN_ASSETMAP,
 433                 /** An Interop subtitle asset has no subtitles
 434                  *  note contains the asset ID
 435                  *  file contains the asset filename
 436                  */
 437                 MISSING_SUBTITLE,
 438                 /** A SMPTE subtitle asset as an <IssueDate> which is not of the form yyyy-mm-ddThh:mm:ss
 439                  *  I can find no reference in a standard to this being required, but the Deluxe delivery
 440                  *  specifications require it and their QC will fail DCPs that don't have it.
 441                  *  note contains the incorrect <IssueDate>
 442                  */
 443                 INVALID_SUBTITLE_ISSUE_DATE,
 444                 /** The sound assets in the CPL do not have the same audio channel count.
 445                  *  file contains the filename of the first asset to differ
 446                  */
 447                 MISMATCHED_SOUND_CHANNEL_COUNTS,
 448                 /** The CPL contains a MainSoundConfiguration tag which does not describe the number of
 449                  *  channels in the audio assets.
 450                  *  note contains details of what is wrong
 451                  *  file contains the CPL filename
 452                  */
 453                 INVALID_MAIN_SOUND_CONFIGURATION,
 454                 /** An interop subtitle file has a <LoadFont> node which refers to a font file that is not found.
 455                  *  note contains the <LoadFont> ID
 456                  */
 457                 MISSING_FONT,
 458                 /** A tile part in a JPEG2000 frame is too big.
 459                  *  frame contains the frame index (counted from 0)
 460                  *  component contains the component index (0, 1 or 2)
 461                  *  size contains the invalid size in bytes.
 462                  */
 463                 INVALID_JPEG2000_TILE_PART_SIZE,
 464                 /** A subtitle XML root node has more than one namespace (xmlns) declaration.
 465                  *  note contains the asset ID
 466                  */
 467                 INCORRECT_SUBTITLE_NAMESPACE_COUNT,
 468                 /** A subtitle or closed caption file has a <Font> tag which refers to a font that is not
 469                  *  first introduced with a <LoadFont>.
 470                  *  id contains the ID of the <Font> tag.
 471                  */
 472                 MISSING_LOAD_FONT_FOR_FONT,
 473                 /** A SMPTE subtitle asset has at least one <Text> element but no <LoadFont>
 474                  *  id contains the ID of the subtitle asset.
 475                  */
 476                 MISSING_LOAD_FONT,
 477                 /** An ID in an asset map does not match the ID obtained from reading the actual file.
 478                  *  id contains the ID from the asset map.
 479                  *  other_id contains the ID from the file.
 480                  */
 481                 MISMATCHED_ASSET_MAP_ID,
 482                 /** The <LabelText> inside a <ContentVersion> is empty
 483                  *  note contains the CPL ID
 484                  *  file contains the CPL filename
 485                  */
 486                 EMPTY_CONTENT_VERSION_LABEL_TEXT,
 487         };
 488
 489         VerificationNote (Type type, Code code)
 490                 : _type (type)
 491                 , _code (code)
 492         {}
 493
 494         VerificationNote (Type type, Code code, std::string note)
 495                 : _type (type)
 496                 , _code (code)
 497         {
 498                 _data[Data::NOTE] = note;
 499         }
 500
 501         VerificationNote (Type type, Code code, boost::filesystem::path file)
 502                 : _type (type)
 503                 , _code (code)
 504         {
 505                 _data[Data::FILE] = file;
 506         }
 507
 508         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
 509                 : _type (type)
 510                 , _code (code)
 511         {
 512                 _data[Data::NOTE] = note;
 513                 _data[Data::FILE] = file;
 514         }
 515
 516         VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
 517                 : _type (type)
 518                 , _code (code)
 519         {
 520                 _data[Data::NOTE] = note;
 521                 _data[Data::FILE] = file;
 522                 _data[Data::LINE] = line;
 523         }
 524
 525         Type type () const {
 526                 return _type;
 527         }
 528
 529         Code code () const {
 530                 return _code;
 531         }
 532
 533 private:
 534         enum class Data {
 535                 NOTE,  ///< further information about the error
 536                 FILE,  ///< path of file containing the error
 537                 LINE,  ///< error line number within the FILE
 538                 FRAME,
 539                 COMPONENT,
 540                 SIZE,
 541                 ID,
 542                 OTHER_ID,
 543                 FRAME_RATE,
 544                 CPL_ID,
 545                 CALCULATED_HASH,
 546                 REFERENCE_HASH
 547         };
 548
 549         template <class T>
 550         boost::optional<T> data(Data key) const
 551         {
 552                 auto iter = _data.find(key);
 553                 if (iter == _data.end()) {
 554                         return {};
 555                 }
 556                 return boost::any_cast<T>(iter->second);
 557         }
 558
 559 public:
 560         boost::optional<std::string> note () const {
 561                 return data<std::string>(Data::NOTE);
 562         }
 563
 564         boost::optional<boost::filesystem::path> file () const {
 565                 return data<boost::filesystem::path>(Data::FILE);
 566         }
 567
 568         boost::optional<uint64_t> line () const {
 569                 return data<uint64_t>(Data::LINE);
 570         }
 571
 572         VerificationNote& set_frame(int frame) {
 573                 _data[Data::FRAME] = frame;
 574                 return *this;
 575         }
 576
 577         boost::optional<int> frame() const {
 578                 return data<int>(Data::FRAME);
 579         }
 580
 581         VerificationNote& set_component(int component) {
 582                 _data[Data::COMPONENT] = component;
 583                 return *this;
 584         }
 585
 586         boost::optional<int> component() const {
 587                 return data<int>(Data::COMPONENT);
 588         }
 589
 590         VerificationNote& set_size(int size) {
 591                 _data[Data::SIZE] = size;
 592                 return *this;
 593         }
 594
 595         boost::optional<int> size() const {
 596                 return data<int>(Data::SIZE);
 597         }
 598
 599         VerificationNote& set_id(std::string id) {
 600                 _data[Data::ID] = id;
 601                 return *this;
 602         }
 603
 604         boost::optional<std::string> id() const {
 605                 return data<std::string>(Data::ID);
 606         }
 607
 608         VerificationNote& set_other_id(std::string other_id) {
 609                 _data[Data::OTHER_ID] = other_id;
 610                 return *this;
 611         }
 612
 613         boost::optional<std::string> other_id() const {
 614                 return data<std::string>(Data::OTHER_ID);
 615         }
 616
 617         VerificationNote& set_frame_rate(int frame_rate) {
 618                 _data[Data::FRAME_RATE] = frame_rate;
 619                 return *this;
 620         }
 621
 622         boost::optional<int> frame_rate() const {
 623                 return data<int>(Data::FRAME_RATE);
 624         }
 625
 626         VerificationNote& set_calculated_hash(std::string hash) {
 627                 _data[Data::CALCULATED_HASH] = hash;
 628                 return *this;
 629         }
 630
 631         boost::optional<std::string> calculated_hash() const {
 632                 return data<std::string>(Data::CALCULATED_HASH);
 633         }
 634
 635         VerificationNote& set_reference_hash(std::string hash) {
 636                 _data[Data::REFERENCE_HASH] = hash;
 637                 return *this;
 638         }
 639
 640         boost::optional<std::string> reference_hash() const {
 641                 return data<std::string>(Data::REFERENCE_HASH);
 642         }
 643
 644         VerificationNote& set_cpl_id(std::string id) {
 645                 _data[Data::CPL_ID] = id;
 646                 return *this;
 647         }
 648
 649         boost::optional<std::string> cpl_id() const {
 650                 return data<std::string>(Data::CPL_ID);
 651         }
 652
 653 private:
 654         Type _type;
 655         Code _code;
 656         std::map<Data, boost::any> _data;
 657 };
 658
 659
 660 struct VerificationOptions
 661 {
 662         ///< If set, any assets larger than this number of bytes will not have their hashes checked
 663         boost::optional<boost::uintmax_t> maximum_asset_size_for_hash_check;
 664         ///< true to check asset hashes (except those which match maximum_asset_size_for_hash_check)
 665         ///< false to check no asset hashes.
 666         bool check_asset_hashes = true;
 667 };
 668
 669
 670 struct VerifyResult
 671 {
 672         std::vector<VerificationNote> notes;
 673         std::vector<std::shared_ptr<dcp::DCP>> dcps;
 674 };
 675
 676
 677 VerifyResult verify(
 678         std::vector<boost::filesystem::path> directories,
 679         std::vector<dcp::DecryptedKDM> kdms,
 680         std::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
 681         std::function<void (float)> progress,
 682         VerificationOptions options = {},
 683         boost::optional<boost::filesystem::path> xsd_dtd_directory = boost::optional<boost::filesystem::path>()
 684         );
 685
 686 std::string note_to_string (dcp::VerificationNote note);
 687
 688 bool operator== (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
 689 bool operator!=(dcp::VerificationNote const& a, dcp::VerificationNote const& b);
 690 bool operator< (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
 691
 692 std::ostream& operator<<(std::ostream& s, dcp::VerificationNote const& note);
 693
 694
 695 }
 696
 697
 698 #endif