Comments / tweaks.
[libdcp.git] / src / util.h
1 /*
2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
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 <boost/shared_ptr.hpp>
29 #include <boost/function.hpp>
30 #include <boost/date_time/posix_time/posix_time.hpp>
31 #include <boost/filesystem.hpp>
32 #include <boost/optional.hpp>
33 #include <openjpeg.h>
34 #include <string>
35 #include <stdint.h>
36
37 namespace xmlpp {
38         class Element;
39 }
40
41 namespace dcp {
42
43 class ARGBFrame;
44 class CertificateChain;
45 class GammaLUT;
46 class XYZFrame;
47
48 /** @struct Size
49  *  @brief The integer, two-dimensional size of something.
50  */
51 struct Size
52 {
53         Size ()
54                 : width (0)
55                 , height (0)
56         {}
57
58         Size (int w, int h)
59                 : width (w)
60                 , height (h)
61         {}
62
63         float ratio () const {
64                 return float (width) / height;
65         }
66         
67         int width;
68         int height;
69 };
70         
71 extern bool operator== (Size const & a, Size const & b);
72 extern bool operator!= (Size const & a, Size const & b);
73
74 extern std::string make_uuid ();
75 extern std::string make_digest (boost::filesystem::path filename, boost::function<void (float)> *);
76 extern std::string content_kind_to_string (ContentKind kind);
77 extern ContentKind content_kind_from_string (std::string kind);
78 extern bool empty_or_white_space (std::string s);
79 extern boost::shared_ptr<XYZFrame> decompress_j2k (uint8_t* data, int64_t size, int reduce);
80
81 extern void init ();
82
83 extern void sign (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, Standard standard);
84 extern void add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, std::string const & ns);
85 extern void add_signer (xmlpp::Element* parent, CertificateChain const & certificates, std::string const & ns);
86
87 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
88 extern boost::optional<boost::filesystem::path> relative_to_root (boost::filesystem::path root, boost::filesystem::path file);
89 extern std::string tm_to_string (struct tm *);
90 extern std::string utc_offset_to_string (int);
91 extern std::string ptime_to_string (boost::posix_time::ptime);
92 extern FILE * fopen_boost (boost::filesystem::path, std::string);
93
94 template <class F, class T>
95 std::list<boost::shared_ptr<T> >
96 list_of_type (std::list<boost::shared_ptr<F> > const & from)
97 {
98         std::list<boost::shared_ptr<T> > out;
99         for (typename std::list<boost::shared_ptr<F> >::const_iterator i = from.begin(); i != from.end(); ++i) {
100                 boost::shared_ptr<T> check = boost::dynamic_pointer_cast<T> (*i);
101                 if (check) {
102                         out.push_back (check);
103                 }
104         }
105
106         return out;
107 }
108         
109 }
110
111 #endif