/*
- Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
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
*/
int _number;
};
+
/** @class MXFFileError
* @brief An exception related to an MXF file
*/
{}
};
+
/** @class MiscError
* @brief A miscellaneous exception
*/
{}
};
-/** @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;
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
- };
+ explicit J2KDecompressionError (std::string message)
+ : ReadError (message)
+ {}
+};
+
- MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
- ~MissingAssetError () throw () {}
+class BadContentKindError : public ReadError
+{
+public:
+ BadContentKindError (std::string content_kind);
};
+
/** @class XMLError
* @brief An XML error
*/
{}
};
+
/** @class UnresolvedRefError
* @brief An exception caused by a reference (by UUID) to something which is not known
*/
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
{
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
{
~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
{
ProgrammingError (std::string file, int line);
};
-class MismatchedStandardError : public DCPReadError
-{
-public:
- MismatchedStandardError ();
-};
class KDMDecryptionError : public std::runtime_error
{
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