Add ratio() method.
[libdcp.git] / src / util.h
1 /*
2     Copyright (C) 2012 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 <string>
28 #include <stdint.h>
29 #include <boost/shared_ptr.hpp>
30 #include <boost/function.hpp>
31 #include <boost/date_time/posix_time/posix_time.hpp>
32 #include <boost/filesystem.hpp>
33 #include <openjpeg.h>
34 #include "types.h"
35
36 namespace xmlpp {
37         class Element;
38 }
39
40 namespace libdcp {
41
42 class ARGBFrame;
43 class CertificateChain;
44 class GammaLUT;
45 class XYZFrame;
46
47 struct Size {
48         Size ()
49                 : width (0)
50                 , height (0)
51         {}
52
53         Size (int w, int h)
54                 : width (w)
55                 , height (h)
56         {}
57
58         float ratio () const {
59                 return float (width) / height;
60         }
61         
62         int width;
63         int height;
64 };
65         
66 extern bool operator== (Size const & a, Size const & b);
67 extern bool operator!= (Size const & a, Size const & b);
68
69 extern std::string make_uuid ();
70 extern std::string make_digest (std::string filename, boost::function<void (float)> *);
71 extern std::string content_kind_to_string (ContentKind kind);
72 extern ContentKind content_kind_from_string (std::string kind);
73 extern bool empty_or_white_space (std::string s);
74 extern boost::shared_ptr<XYZFrame> decompress_j2k (uint8_t* data, int64_t size, int reduce);
75
76 extern void init ();
77
78 extern void sign (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, bool interop);
79 extern void add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, std::string const & ns);
80 extern void add_signer (xmlpp::Element* parent, CertificateChain const & certificates, std::string const & ns);
81
82 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
83
84 extern std::string tm_to_string (struct tm *);
85 extern std::string utc_offset_to_string (int);
86 extern std::string ptime_to_string (boost::posix_time::ptime);
87         
88 }
89
90 #endif