src/util.h

   1 /*
   2     Copyright (C) 2012-2021 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
  35 /** @file  src/util.h
  36  *  @brief Utility methods and classes
  37  */
  38
  39
  40 #ifndef LIBDCP_UTIL_H
  41 #define LIBDCP_UTIL_H
  42
  43
  44 #include "array_data.h"
  45 #include "local_time.h"
  46 #include "warnings.h"
  47 LIBDCP_DISABLE_WARNINGS
  48 #include <asdcp/KM_log.h>
  49 LIBDCP_ENABLE_WARNINGS
  50 #include <boost/filesystem.hpp>
  51 #include <boost/function.hpp>
  52 #include <boost/optional.hpp>
  53 #include <memory>
  54 #include <string>
  55 #include <stdint.h>
  56
  57
  58 #define LIBDCP_UNUSED(x) (void)(x)
  59
  60
  61 namespace ASDCP {
  62         class Dictionary;
  63 }
  64
  65
  66 namespace xmlpp {
  67         class Element;
  68         class Node;
  69 }
  70
  71
  72 namespace dcp {
  73
  74
  75 class CertificateChain;
  76 class GammaLUT;
  77 class OpenJPEGImage;
  78
  79
  80 extern std::string make_uuid ();
  81
  82 /** Create a digest for a file
  83  *  @param filename File name
  84  *  @param progress Optional progress reporting function.  The function will be called
  85  *  with a progress value between 0 and 1
  86  *  @return Digest
  87  */
  88 extern std::string make_digest (boost::filesystem::path filename, boost::function<void (float)>);
  89
  90 extern std::string make_digest (ArrayData data);
  91
  92 extern bool ids_equal (std::string a, std::string b);
  93 extern std::string remove_urn_uuid (std::string raw);
  94
  95 /** Set up various bits that the library needs.  Should be called once
  96  *  by client applications.
  97  *
  98  *  @param resources_directory Path to a directory containing the tags and xsd
  99  *  directories from the source code; if none is specified libdcp will look
 100  *  in the directory given by LIBDCP_RESOURCES or based on where the current
 101  *  executable is.
 102  */
 103 extern void init (boost::optional<boost::filesystem::path> resources_directory = boost::optional<boost::filesystem::path>());
 104
 105 /** Decode a base64 string.  The base64 decode routine in KM_util.cpp
 106  *  gives different values to both this and the command-line base64
 107  *  for some inputs.  Not sure why.
 108  *
 109  *  @param in base64-encoded string
 110  *  @param out Output buffer
 111  *  @param out_length Length of output buffer
 112  *  @return Number of characters written to the output buffer
 113  */
 114 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
 115
 116 extern boost::optional<boost::filesystem::path> relative_to_root (boost::filesystem::path root, boost::filesystem::path file);
 117
 118 extern std::string file_to_string (boost::filesystem::path, uintmax_t max_length = 1048576);
 119
 120 /** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...)
 121  *  @return SHA1 fingerprint of key
 122  */
 123 extern std::string private_key_fingerprint (std::string key);
 124 extern xmlpp::Node* find_child (xmlpp::Node const * node, std::string name);
 125 extern std::string openjpeg_version();
 126 extern std::string spaces (int n);
 127 extern void indent (xmlpp::Element* element, int initial);
 128
 129 /** @return true if the day represented by \ref a is less than or
 130  *  equal to the one represented by \ref b, ignoring the time parts
 131  */
 132 extern bool day_less_than_or_equal (LocalTime a, LocalTime b);
 133
 134 /** @return true if the day represented by \ref a is greater than or
 135  *  equal to the one represented by \ref b, ignoring the time parts
 136  */
 137 extern bool day_greater_than_or_equal (LocalTime a, LocalTime b);
 138
 139 /** Try quite hard to find a string which starts with \ref base and is
 140  *  not in \ref existing
 141  */
 142 extern std::string unique_string (std::vector<std::string> existing, std::string base);
 143
 144 extern ASDCP::Dictionary const* asdcp_smpte_dict;
 145
 146 extern boost::filesystem::path directory_containing_executable ();
 147 extern boost::filesystem::path resources_directory ();
 148
 149
 150 class ASDCPErrorSuspender
 151 {
 152 public:
 153         ASDCPErrorSuspender();
 154         ~ASDCPErrorSuspender();
 155
 156 private:
 157         Kumu::LogEntryList _log;
 158         Kumu::ILogSink& _old;
 159         Kumu::EntryListLogSink* _sink;
 160 };
 161
 162
 163 template <class From, class To>
 164 void
 165 add_to_container(To& container, From source)
 166 {
 167         std::copy(source.begin(), source.end(), std::back_inserter(container));
 168 }
 169
 170
 171 }
 172
 173
 174 #endif