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