2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic 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 DCP-o-matic 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 DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/lib/exceptions.h
22 * @brief Our exceptions.
25 #ifndef DCPOMATIC_EXCEPTIONS_H
26 #define DCPOMATIC_EXCEPTIONS_H
29 #include <libavutil/pixfmt.h>
31 #include <boost/filesystem.hpp>
35 /** @class DecodeError
36 * @brief A low-level problem with the decoder (possibly due to the nature
39 class DecodeError : public std::runtime_error
42 explicit DecodeError (std::string s)
43 : std::runtime_error (s)
47 class CryptoError : public std::runtime_error
50 explicit CryptoError (std::string s)
51 : std::runtime_error (s)
55 /** @class EncodeError
56 * @brief A low-level problem with an encoder.
58 class EncodeError : public std::runtime_error
61 explicit EncodeError (std::string s)
62 : std::runtime_error (s)
67 * @brief Parent class for file-related errors.
69 class FileError : public std::runtime_error
72 /** @param m Error message.
73 * @param f Name of the file that this exception concerns.
75 FileError (std::string m, boost::filesystem::path f)
76 : std::runtime_error (m)
80 virtual ~FileError () throw () {}
82 /** @return name of the file that this exception concerns */
83 boost::filesystem::path file () const {
88 /** name of the file that this exception concerns */
89 boost::filesystem::path _file;
92 class JoinError : public std::runtime_error
95 explicit JoinError (std::string s)
96 : std::runtime_error (s)
100 /** @class OpenFileError.
101 * @brief Indicates that some error occurred when trying to open a file.
103 class OpenFileError : public FileError
112 /** @param f File that we were trying to open.
113 * @param error Code of error that occurred.
114 * @param mode Mode that we tried to open the file in.
116 OpenFileError (boost::filesystem::path f, int error, Mode mode);
119 /** @class ReadFileError.
120 * @brief Indicates that some error occurred when trying to read from a file
122 class ReadFileError : public FileError
125 /** @param f File that we were trying to read from.
126 * @param e errno value, or 0.
128 ReadFileError (boost::filesystem::path f, int e = 0);
131 /** @class WriteFileError.
132 * @brief Indicates that some error occurred when trying to write to a file
134 class WriteFileError : public FileError
137 /** @param f File that we were trying to write to.
138 * @param e errno value, or 0.
140 WriteFileError (boost::filesystem::path f, int e);
143 /** @class SettingError.
144 * @brief Indicates that something is wrong with a setting.
146 class SettingError : public std::runtime_error
149 /** @param s Name of setting that was required.
152 SettingError (std::string s, std::string m)
153 : std::runtime_error (m)
157 virtual ~SettingError () throw () {}
159 /** @return name of setting in question */
160 std::string setting () const {
165 std::string _setting;
168 /** @class MissingSettingError.
169 * @brief Indicates that a Film is missing a setting that is required for some operation.
171 class MissingSettingError : public SettingError
174 /** @param s Name of setting that was required */
175 explicit MissingSettingError (std::string s);
178 /** @class BadSettingError
179 * @brief Indicates that a setting is bad in some way.
181 class BadSettingError : public SettingError
184 /** @param s Name of setting that is bad.
185 * @param m Error message.
187 BadSettingError (std::string s, std::string m)
188 : SettingError (s, m)
192 /** @class NetworkError
193 * @brief Indicates some problem with communication on the network.
195 class NetworkError : public std::runtime_error
198 explicit NetworkError (std::string s)
199 : std::runtime_error (s)
204 * @brief A problem with a KDM.
206 class KDMError : public std::runtime_error
209 KDMError (std::string s, std::string d);
210 ~KDMError () throw() {}
212 std::string summary () const {
216 std::string detail () const {
221 std::string _summary;
225 /** @class PixelFormatError
226 * @brief A problem with an unsupported pixel format.
228 class PixelFormatError : public std::runtime_error
231 PixelFormatError (std::string o, AVPixelFormat f);
234 /** @class TextSubtitleError
235 * @brief An error that occurs while parsing a TextSubtitleError file.
237 class TextSubtitleError : public FileError
240 TextSubtitleError (std::string, std::string, boost::filesystem::path);
243 class DCPError : public std::runtime_error
246 explicit DCPError (std::string s)
247 : std::runtime_error (s)
251 class InvalidSignerError : public std::runtime_error
254 InvalidSignerError ();
255 explicit InvalidSignerError (std::string reason);
258 class ProgrammingError : public std::runtime_error
261 ProgrammingError (std::string file, int line, std::string message = "");
264 class TextEncodingError : public std::runtime_error
267 explicit TextEncodingError (std::string s)
268 : std::runtime_error (s)
272 class MetadataError : public std::runtime_error
275 explicit MetadataError (std::string s)
276 : std::runtime_error (s)
280 class OldFormatError : public std::runtime_error
283 explicit OldFormatError (std::string s)
284 : std::runtime_error (s)
288 class KDMAsContentError : public std::runtime_error
291 KDMAsContentError ();