More licence fixups.
[libdcp.git] / src / util.h
1 /*
2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
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.
10
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.
15
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/>.
18 */
19
20 #ifndef LIBDCP_UTIL_H
21 #define LIBDCP_UTIL_H
22
23 /** @file  src/util.h
24  *  @brief Utility methods.
25  */
26
27 #include "types.h"
28 #include "data.h"
29 #include <boost/shared_ptr.hpp>
30 #include <boost/function.hpp>
31 #include <boost/filesystem.hpp>
32 #include <boost/optional.hpp>
33 #include <string>
34 #include <stdint.h>
35
36 namespace xmlpp {
37         class Element;
38         class Node;
39 }
40
41 namespace dcp {
42
43 class ARGBImage;
44 class CertificateChain;
45 class GammaLUT;
46 class OpenJPEGImage;
47
48 extern bool operator== (Size const & a, Size const & b);
49 extern bool operator!= (Size const & a, Size const & b);
50 extern std::ostream& operator<< (std::ostream& s, Size const & a);
51
52 extern std::string make_uuid ();
53 extern std::string make_digest (boost::filesystem::path filename, boost::function<void (float)>);
54 extern std::string content_kind_to_string (ContentKind kind);
55 extern ContentKind content_kind_from_string (std::string kind);
56 extern bool empty_or_white_space (std::string s);
57 extern bool ids_equal (std::string a, std::string b);
58 extern std::string remove_urn_uuid (std::string raw);
59 extern void init ();
60
61 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
62 extern boost::optional<boost::filesystem::path> relative_to_root (boost::filesystem::path root, boost::filesystem::path file);
63 extern FILE * fopen_boost (boost::filesystem::path, std::string);
64 extern std::string file_to_string (boost::filesystem::path, uintmax_t max_length = 65536);
65 extern std::string private_key_fingerprint (std::string key);
66 extern xmlpp::Node* find_child (xmlpp::Node const * node, std::string name);
67
68 }
69
70 #endif