Use an enum class for Marker.
[libdcp.git] / src / util.h
index 8db838ebc7c2adbfc6269f47be87bd193ad18bc4..232b91ccb44a80b13883fc0a29bd12754716a0f7 100644 (file)
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
+
+    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.
 */
 
 #ifndef LIBDCP_UTIL_H
  *  @brief Utility methods.
  */
 
+
+#include "array_data.h"
 #include "types.h"
-#include <boost/shared_ptr.hpp>
+#include "local_time.h"
+#include <asdcp/KM_log.h>
+#include <memory>
 #include <boost/function.hpp>
-#include <boost/date_time/posix_time/posix_time.hpp>
 #include <boost/filesystem.hpp>
 #include <boost/optional.hpp>
-#include <openjpeg.h>
 #include <string>
 #include <stdint.h>
 
+#define LIBDCP_UNUSED(x) (void)(x)
+
 namespace xmlpp {
        class Element;
+       class Node;
 }
 
 namespace dcp {
 
-class ARGBFrame;
 class CertificateChain;
 class GammaLUT;
-class XYZFrame;
-
-struct Size
-{
-       Size ()
-               : width (0)
-               , height (0)
-       {}
-
-       Size (int w, int h)
-               : width (w)
-               , height (h)
-       {}
-
-       float ratio () const {
-               return float (width) / height;
-       }
-       
-       int width;
-       int height;
-};
-       
-extern bool operator== (Size const & a, Size const & b);
-extern bool operator!= (Size const & a, Size const & b);
+class OpenJPEGImage;
 
 extern std::string make_uuid ();
-extern std::string make_digest (boost::filesystem::path filename, boost::function<void (float)> *);
-extern std::string content_kind_to_string (ContentKind kind);
-extern ContentKind content_kind_from_string (std::string kind);
+extern std::string make_digest (boost::filesystem::path filename, boost::function<void (float)>);
+extern std::string make_digest (ArrayData data);
 extern bool empty_or_white_space (std::string s);
-extern boost::shared_ptr<XYZFrame> decompress_j2k (uint8_t* data, int64_t size, int reduce);
-
-extern void init ();
-
-extern void sign (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, Standard standard);
-extern void add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, boost::filesystem::path signer_key, std::string const & ns);
-extern void add_signer (xmlpp::Element* parent, CertificateChain const & certificates, std::string const & ns);
+extern bool ids_equal (std::string a, std::string b);
+extern std::string remove_urn_uuid (std::string raw);
+extern void init (boost::optional<boost::filesystem::path> tags_directory = boost::optional<boost::filesystem::path>());
 
 extern int base64_decode (std::string const & in, unsigned char* out, int out_length);
 extern boost::optional<boost::filesystem::path> relative_to_root (boost::filesystem::path root, boost::filesystem::path file);
-extern std::string tm_to_string (struct tm *);
-extern std::string utc_offset_to_string (int);
-extern std::string ptime_to_string (boost::posix_time::ptime);
 extern FILE * fopen_boost (boost::filesystem::path, std::string);
-
-template <class F, class T>
-std::list<boost::shared_ptr<T> >
-list_of_type (std::list<boost::shared_ptr<F> > const & from)
+extern std::string file_to_string (boost::filesystem::path, uintmax_t max_length = 1048576);
+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);
+extern bool day_less_than_or_equal (LocalTime a, LocalTime b);
+extern bool day_greater_than_or_equal (LocalTime a, LocalTime b);
+extern std::string unique_string (std::vector<std::string> existing, std::string base);
+extern ASDCP::Dictionary const* asdcp_smpte_dict;
+
+
+class ASDCPErrorSuspender
 {
-       std::list<boost::shared_ptr<T> > out;
-       for (typename std::list<boost::shared_ptr<F> >::const_iterator i = from.begin(); i != from.end(); ++i) {
-               boost::shared_ptr<T> check = boost::dynamic_pointer_cast<T> (*i);
-               if (check) {
-                       out.push_back (check);
-               }
-       }
-
-       return out;
-}
-       
+public:
+       ASDCPErrorSuspender();
+       ~ASDCPErrorSuspender();
+
+private:
+       Kumu::LogEntryList _log;
+       Kumu::ILogSink& _old;
+       Kumu::EntryListLogSink* _sink;
+};
+
+
 }
 
 #endif