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     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
  23     including the two.
  24
  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.
  32 */
  33
  34 #ifndef LIBDCP_UTIL_H
  35 #define LIBDCP_UTIL_H
  36
  37 /** @file  src/util.h
  38  *  @brief Utility methods.
  39  */
  40
  41 #include "types.h"
  42 #include "data.h"
  43 #include <boost/shared_ptr.hpp>
  44 #include <boost/function.hpp>
  45 #include <boost/filesystem.hpp>
  46 #include <boost/optional.hpp>
  47 #include <string>
  48 #include <stdint.h>
  49
  50 namespace xmlpp {
  51         class Element;
  52         class Node;
  53 }
  54
  55 namespace dcp {
  56
  57 class CertificateChain;
  58 class GammaLUT;
  59 class OpenJPEGImage;
  60
  61 extern std::string make_uuid ();
  62 extern std::string make_digest (boost::filesystem::path filename, boost::function<void (float)>);
  63 extern std::string make_digest (Data data);
  64 extern bool empty_or_white_space (std::string s);
  65 extern bool ids_equal (std::string a, std::string b);
  66 extern std::string remove_urn_uuid (std::string raw);
  67 extern void init ();
  68
  69 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
  70 extern boost::optional<boost::filesystem::path> relative_to_root (boost::filesystem::path root, boost::filesystem::path file);
  71 extern FILE * fopen_boost (boost::filesystem::path, std::string);
  72 extern std::string file_to_string (boost::filesystem::path, uintmax_t max_length = 1048576);
  73 extern std::string private_key_fingerprint (std::string key);
  74 extern xmlpp::Node* find_child (xmlpp::Node const * node, std::string name);
  75 extern std::string openjpeg_version();
  76 extern std::string spaces (int n);
  77 extern void indent (xmlpp::Element* element, int initial);
  78
  79 }
  80
  81 #endif