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