X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fexceptions.h;h=78d0943e6eac7b6d5b683abd6ee8d156f0dc5089;hb=4bd57fbbac67ac04ec47a9765b9f278aa1691851;hp=76a66808d3a83caa524576081380e8b9913b1382;hpb=ea454d8c6eabe0dfa3e82b36e5813012cf93395c;p=libdcp.git diff --git a/src/exceptions.h b/src/exceptions.h index 76a66808..78d0943e 100644 --- a/src/exceptions.h +++ b/src/exceptions.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2020 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of libdcp. @@ -31,19 +31,24 @@ files in the program, then also delete it here. */ + +/** @file src/exceptions.h + * @brief Exceptions thrown by libdcp + */ + + #ifndef LIBDCP_EXCEPTIONS_H #define LIBDCP_EXCEPTIONS_H + #include #include -/** @file src/exceptions.h - * @brief Exceptions thrown by libdcp. - */ namespace dcp { + /** @class FileError * @brief An exception related to a file */ @@ -69,6 +74,7 @@ private: int _number; }; + /** @class MXFFileError * @brief An exception related to an MXF file */ @@ -80,6 +86,7 @@ public: {} }; + /** @class MiscError * @brief A miscellaneous exception */ @@ -93,7 +100,7 @@ public: /** @class ReadError - * @brief Any error that occurs when reading data from a DCP. + * @brief Any error that occurs when reading data from a DCP */ class ReadError : public std::runtime_error { @@ -122,7 +129,7 @@ private: /** @class J2KDecompressionError - * @brief An error that occurs during decompression of JPEG2000 data. + * @brief An error that occurs during decompression of JPEG2000 data */ class J2KDecompressionError : public ReadError { @@ -139,6 +146,17 @@ public: BadContentKindError (std::string content_kind); }; + +/** @class MissingAssetmapError + * @brief Thrown when no ASSETMAP was found when trying to read a DCP + */ +class MissingAssetmapError : public ReadError +{ +public: + explicit MissingAssetmapError (boost::filesystem::path dir); +}; + + /** @class XMLError * @brief An XML error */ @@ -150,6 +168,7 @@ public: {} }; + /** @class UnresolvedRefError * @brief An exception caused by a reference (by UUID) to something which is not known */ @@ -159,8 +178,9 @@ public: explicit UnresolvedRefError (std::string id); }; + /** @class TimeFormatError - * @brief A an error with a string passed to LocalTime. + * @brief A an error with a string passed to LocalTime */ class TimeFormatError : public std::runtime_error { @@ -168,9 +188,10 @@ public: explicit TimeFormatError (std::string bad_time); }; + /** @class NotEncryptedError * @brief An error raised when creating a DecryptedKDM object for assets that are not - * encrypted. + * encrypted */ class NotEncryptedError : public std::runtime_error { @@ -179,8 +200,9 @@ public: ~NotEncryptedError () throw () {} }; + /** @class ProgrammingError - * @brief An exception thrown when a DCP_ASSERT fails; something that should not happen. + * @brief An exception thrown when a DCP_ASSERT fails; something that should not happen */ class ProgrammingError : public std::runtime_error { @@ -188,30 +210,35 @@ public: ProgrammingError (std::string file, int line); }; + class KDMDecryptionError : public std::runtime_error { public: KDMDecryptionError (std::string message, int cipher_length, int modulus_dmax); }; + class KDMFormatError : public std::runtime_error { public: KDMFormatError (std::string message); }; + class CertificateChainError : public std::runtime_error { public: CertificateChainError (std::string message); }; + class MissingSubtitleImageError : public std::runtime_error { public: MissingSubtitleImageError (std::string id); }; + class BadKDMDateError : public std::runtime_error { public: @@ -289,6 +316,8 @@ public: NoReelsError (); }; + } + #endif