2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
35 /** @file src/exceptions.h
36 * @brief Exceptions thrown by libdcp
40 #ifndef LIBDCP_EXCEPTIONS_H
41 #define LIBDCP_EXCEPTIONS_H
44 #include <boost/filesystem.hpp>
45 #include <boost/optional.hpp>
53 * @brief An exception related to a file
55 class FileError : public std::runtime_error
58 FileError (std::string message, boost::filesystem::path filename, int number);
59 ~FileError () throw () {}
61 /** @return filename of file that was involved */
62 boost::filesystem::path filename () const {
66 /** @return error number of the error */
72 /** filename of file that was involved */
73 boost::filesystem::path _filename;
78 /** @class MXFFileError
79 * @brief An exception related to an MXF file
81 class MXFFileError : public FileError
84 MXFFileError (std::string message, boost::filesystem::path filename, int number)
85 : FileError (message, filename, number)
91 * @brief A miscellaneous exception
93 class MiscError : public std::runtime_error
96 explicit MiscError (std::string message)
97 : std::runtime_error (message)
103 * @brief Any error that occurs when reading data from a DCP
105 class ReadError : public std::runtime_error
108 explicit ReadError (std::string message)
109 : std::runtime_error(message)
113 ReadError (std::string message, std::string detail);
115 ~ReadError() throw () {}
117 std::string message () const {
121 boost::optional<std::string> detail () const {
126 std::string _message;
127 boost::optional<std::string> _detail;
131 /** @class J2KDecompressionError
132 * @brief An error that occurs during decompression of JPEG2000 data
134 class J2KDecompressionError : public ReadError
137 explicit J2KDecompressionError (std::string message)
138 : ReadError (message)
143 class BadContentKindError : public ReadError
146 BadContentKindError (std::string content_kind);
151 * @brief An XML error
153 class XMLError : public std::runtime_error
156 explicit XMLError (std::string message)
157 : std::runtime_error (message)
162 /** @class UnresolvedRefError
163 * @brief An exception caused by a reference (by UUID) to something which is not known
165 class UnresolvedRefError : public std::runtime_error
168 explicit UnresolvedRefError (std::string id);
172 /** @class TimeFormatError
173 * @brief A an error with a string passed to LocalTime
175 class TimeFormatError : public std::runtime_error
178 explicit TimeFormatError (std::string bad_time);
182 /** @class NotEncryptedError
183 * @brief An error raised when creating a DecryptedKDM object for assets that are not
186 class NotEncryptedError : public std::runtime_error
189 explicit NotEncryptedError (std::string const & what);
190 ~NotEncryptedError () throw () {}
194 /** @class ProgrammingError
195 * @brief An exception thrown when a DCP_ASSERT fails; something that should not happen
197 class ProgrammingError : public std::runtime_error
200 ProgrammingError (std::string file, int line);
204 class KDMDecryptionError : public std::runtime_error
207 KDMDecryptionError (std::string message, int cipher_length, int modulus_dmax);
211 class KDMFormatError : public std::runtime_error
214 KDMFormatError (std::string message);
218 class CertificateChainError : public std::runtime_error
221 CertificateChainError (std::string message);
225 class MissingSubtitleImageError : public std::runtime_error
228 MissingSubtitleImageError (std::string id);
232 class BadKDMDateError : public std::runtime_error
235 BadKDMDateError (bool starts_too_early);
237 bool starts_too_early () const {
238 return _starts_too_early;
242 bool _starts_too_early;
246 class StartCompressionError : public std::runtime_error
249 explicit StartCompressionError (boost::optional<int> code = boost::optional<int>());
250 ~StartCompressionError () throw () {}
252 boost::optional<int> code () const {
257 boost::optional<int> _code;
261 class CombineError : public std::runtime_error
264 explicit CombineError (std::string message);
268 class LanguageTagError : public std::runtime_error
271 LanguageTagError (std::string message);
275 class BadSettingError : public std::runtime_error
278 BadSettingError (std::string message);
282 class DuplicateIdError : public std::runtime_error
285 DuplicateIdError (std::string message);
289 class MainSoundConfigurationError : public std::runtime_error
292 MainSoundConfigurationError (std::string s);
296 class UnknownChannelIdError : public std::runtime_error
299 UnknownChannelIdError (std::string s);
303 class NoReelsError : public std::runtime_error