Tidying a few things up.

[libdcp.git] / src / exceptions.h

diff --git a/src/exceptions.h b/src/exceptions.h
index d66e89449632eb13a9d8b823464a1b2657446625..78d0943e6eac7b6d5b683abd6ee8d156f0dc5089 100644 (file)
--- a/src/exceptions.h
+++ b/src/exceptions.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     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 <boost/filesystem.hpp>
 #include <boost/optional.hpp>
 
-/** @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
  */
@@ -91,20 +98,21 @@ public:
        {}
 };
 
-/** @class DCPReadError
- *  @brief A DCP read exception
+
+/** @class ReadError
+ *  @brief Any error that occurs when reading data from a DCP
  */
-class DCPReadError : public std::runtime_error
+class ReadError : public std::runtime_error
 {
 public:
-       explicit DCPReadError (std::string message)
+       explicit ReadError (std::string message)
                : std::runtime_error(message)
                , _message(message)
        {}
 
-       DCPReadError (std::string message, std::string detail);
+       ReadError (std::string message, std::string detail);
 
-       ~DCPReadError() throw () {}
+       ~ReadError() throw () {}
 
        std::string message () const {
                return _message;
@@ -119,29 +127,36 @@ private:
        boost::optional<std::string> _detail;
 };
 
-/** @class MissingAssetError
- *  @brief An error of a missing asset.
+
+/** @class J2KDecompressionError
+ *  @brief An error that occurs during decompression of JPEG2000 data
  */
-class MissingAssetError : public DCPReadError
+class J2KDecompressionError : public ReadError
 {
 public:
-       enum AssetType {
-               MAIN_PICTURE,  //< main picture is missing
-               MAIN_SOUND,    //< main sound is missing
-               MAIN_SUBTITLE, //< main subtitle is missing
-               UNKNOWN        //< something is missing but we don't know what
-       };
-
-       MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
-       ~MissingAssetError () throw () {}
+       explicit J2KDecompressionError (std::string message)
+               : ReadError (message)
+       {}
 };
 
-class BadContentKindError : public DCPReadError
+
+class BadContentKindError : public ReadError
 {
 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
  */
@@ -153,6 +168,7 @@ public:
        {}
 };
 
+
 /** @class UnresolvedRefError
  *  @brief An exception caused by a reference (by UUID) to something which is not known
  */
@@ -162,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
 {
@@ -171,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
 {
@@ -182,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
 {
@@ -191,11 +210,6 @@ public:
        ProgrammingError (std::string file, int line);
 };
 
-class MismatchedStandardError : public DCPReadError
-{
-public:
-       MismatchedStandardError ();
-};
 
 class KDMDecryptionError : public std::runtime_error
 {
@@ -203,18 +217,107 @@ 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:
+       BadKDMDateError (bool starts_too_early);
+
+       bool starts_too_early () const {
+               return _starts_too_early;
+       }
+
+private:
+       bool _starts_too_early;
+};
+
+
+class StartCompressionError : public std::runtime_error
+{
+public:
+       explicit StartCompressionError (boost::optional<int> code = boost::optional<int>());
+       ~StartCompressionError () throw () {}
+
+       boost::optional<int> code () const {
+               return _code;
+       }
+
+private:
+       boost::optional<int> _code;
+};
+
+
+class CombineError : public std::runtime_error
+{
+public:
+       explicit CombineError (std::string message);
+};
+
+
+class LanguageTagError : public std::runtime_error
+{
+public:
+       LanguageTagError (std::string message);
+};
+
+
+class BadSettingError : public std::runtime_error
+{
+public:
+       BadSettingError (std::string message);
+};
+
+
+class DuplicateIdError : public std::runtime_error
+{
+public:
+       DuplicateIdError (std::string message);
+};
+
+
+class MainSoundConfigurationError : public std::runtime_error
+{
+public:
+       MainSoundConfigurationError (std::string s);
+};
+
+
+class UnknownChannelIdError : public std::runtime_error
+{
+public:
+       UnknownChannelIdError (std::string s);
+};
+
+
+class NoReelsError : public std::runtime_error
+{
+public:
+       NoReelsError ();
+};
+
+
 }
 
+
 #endif