X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.h;h=aa26bfaf80688f28ff2ced1f1c9cce00353866c1;hb=cf4e4272f72346c39964b128f78b2297f04dba55;hp=619c15c5d4b1a627c6e4db866bb4c96f35e3aad5;hpb=e5432f1ef35ec5a68a0a3c2d10f76f7582e8852c;p=libdcp.git diff --git a/src/util.h b/src/util.h index 619c15c5..aa26bfaf 100644 --- a/src/util.h +++ b/src/util.h @@ -1,44 +1,173 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ + /** @file src/util.h - * @brief Utility methods. + * @brief Utility methods and classes */ + +#ifndef LIBDCP_UTIL_H +#define LIBDCP_UTIL_H + + +#include "array_data.h" +#include "types.h" +#include "local_time.h" +#include +#include +#include +#include +#include #include #include -#include -#include -#include "types.h" -namespace libdcp { -class ARGBFrame; - +#define LIBDCP_UNUSED(x) (void)(x) + + +namespace xmlpp { + class Element; + class Node; +} + + +namespace dcp { + + +class CertificateChain; +class GammaLUT; +class OpenJPEGImage; + + extern std::string make_uuid (); -extern std::string make_digest (std::string filename, boost::signals2::signal* progress); -extern std::string content_kind_to_string (ContentKind kind); -extern ContentKind content_kind_from_string (std::string kind); -extern bool starts_with (std::string big, std::string little); -extern bool ends_with (std::string big, std::string little); + +/** Create a digest for a file + * @param filename File name + * @param progress Optional progress reporting function. The function will be called + * with a progress value between 0 and 1 + * @return Digest + */ +extern std::string make_digest (boost::filesystem::path filename, boost::function); + +extern std::string make_digest (ArrayData data); + +/** @param s A string + * @return true if the string contains only space, newline or tab characters, or is empty + */ extern bool empty_or_white_space (std::string s); -extern opj_image_t* decompress_j2k (uint8_t* data, int64_t size, int reduce); -extern boost::shared_ptr xyz_to_rgb (opj_image_t* xyz_frame); + +extern bool ids_equal (std::string a, std::string b); +extern std::string remove_urn_uuid (std::string raw); + +/** Set up various bits that the library needs. Should be called once + * by client applications. + * + * @param tags_directory Path to a copy of the tags directory from the source code; + * if none is specified libdcp will look for a tags directory in the environment + * variable LIBDCP_RESOURCES or based on where the current executable is. + */ +extern void init (boost::optional tags_directory = boost::optional()); + +/** Decode a base64 string. The base64 decode routine in KM_util.cpp + * gives different values to both this and the command-line base64 + * for some inputs. Not sure why. + * + * @param in base64-encoded string + * @param out Output buffer + * @param out_length Length of output buffer + * @return Number of characters written to the output buffer + */ +extern int base64_decode (std::string const & in, unsigned char* out, int out_length); + +extern boost::optional relative_to_root (boost::filesystem::path root, boost::filesystem::path file); + +/** @param p Path to open + * @param t mode flags, as for fopen(3) + * @return FILE pointer or 0 on error + * + * Apparently there is no way to create an ofstream using a UTF-8 + * filename under Windows. We are hence reduced to using fopen + * with this wrapper. + */ +extern FILE * fopen_boost (boost::filesystem::path, std::string); + +extern std::string file_to_string (boost::filesystem::path, uintmax_t max_length = 1048576); + +/** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...) + * @return SHA1 fingerprint of key + */ +extern std::string private_key_fingerprint (std::string key); +extern xmlpp::Node* find_child (xmlpp::Node const * node, std::string name); +extern std::string openjpeg_version(); +extern std::string spaces (int n); +extern void indent (xmlpp::Element* element, int initial); + +/** @return true if the day represented by \ref a is less than or + * equal to the one represented by \ref b, ignoring the time parts + */ +extern bool day_less_than_or_equal (LocalTime a, LocalTime b); + +/** @return true if the day represented by \ref a is greater than or + * equal to the one represented by \ref b, ignoring the time parts + */ +extern bool day_greater_than_or_equal (LocalTime a, LocalTime b); + +/** Try quite hard to find a string which starts with \ref base and is + * not in \ref existing + */ +extern std::string unique_string (std::vector existing, std::string base); + +extern ASDCP::Dictionary const* asdcp_smpte_dict; + +extern boost::filesystem::path directory_containing_executable (); +extern boost::filesystem::path resources_directory (); + + +class ASDCPErrorSuspender +{ +public: + ASDCPErrorSuspender(); + ~ASDCPErrorSuspender(); + +private: + Kumu::LogEntryList _log; + Kumu::ILogSink& _old; + Kumu::EntryListLogSink* _sink; +}; + } + + +#endif