Some include tidying.
[dcpomatic.git] / src / lib / util.h
index 675c8d03e6304a42a56f4911e88eb4bdeeaa352d..b6817f8837c0d675d07b5f569afd2a3e19710a33 100644 (file)
 #ifndef DCPOMATIC_UTIL_H
 #define DCPOMATIC_UTIL_H
 
-#include <string>
-#include <vector>
-#include <boost/shared_ptr.hpp>
-#include <boost/asio.hpp>
-#include <boost/optional.hpp>
-#include <boost/filesystem.hpp>
-#include <libdcp/util.h>
+#include "compose.hpp"
+#include "types.h"
+#include "video_content.h"
+#include <dcp/util.h>
 extern "C" {
 #include <libavcodec/avcodec.h>
 #include <libavfilter/avfilter.h>
 }
-#include "compose.hpp"
-#include "types.h"
-#include "video_content.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/asio.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <string>
+#include <vector>
 
 #undef check
 
@@ -46,12 +46,10 @@ extern "C" {
 #define MAX_DCP_AUDIO_CHANNELS 12
 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
 #define HISTORY_SIZE 10
-
-namespace libdcp {
-       class Signer;
-}
+#define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com")
 
 class Job;
+struct AVSubtitle;
 
 extern std::string seconds_to_hms (int);
 extern std::string seconds_to_approximate_hms (int);
@@ -65,16 +63,17 @@ extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shar
 extern void ensure_ui_thread ();
 extern std::string audio_channel_name (int);
 extern bool valid_image_file (boost::filesystem::path);
+extern bool valid_j2k_file (boost::filesystem::path);
 #ifdef DCPOMATIC_WINDOWS
 extern boost::filesystem::path mo_path ();
 #endif
 extern std::string tidy_for_filename (std::string);
-extern boost::shared_ptr<const libdcp::Signer> make_signer ();
-extern libdcp::Size fit_ratio_within (float ratio, libdcp::Size);
+extern dcp::Size fit_ratio_within (float ratio, dcp::Size, int);
 extern std::string entities_to_text (std::string e);
 extern std::map<std::string, std::string> split_get_request (std::string url);
 extern int dcp_audio_frame_rate (int);
 extern int stride_round_up (int, int const *, int);
+extern int round_to (float n, int r);
 extern std::multimap<std::string, std::string> read_key_value (std::istream& s);
 extern int get_required_int (std::multimap<std::string, std::string> const & kv, std::string k);
 extern float get_required_float (std::multimap<std::string, std::string> const & kv, std::string k);
@@ -83,6 +82,8 @@ extern int get_optional_int (std::multimap<std::string, std::string> const & kv,
 extern std::string get_optional_string (std::multimap<std::string, std::string> const & kv, std::string k);
 extern void* wrapped_av_malloc (size_t);
 extern int64_t divide_with_round (int64_t a, int64_t b);
+extern ContentTimePeriod subtitle_period (AVSubtitle const &);
+extern void set_backtrace_file (boost::filesystem::path);
 
 /** @class Socket
  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
@@ -125,16 +126,20 @@ private:
 
 extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
 
+/** @class ScopedTemporary
+ *  @brief A temporary file which is deleted when the ScopedTemporary object goes out of scope.
+ */
 class ScopedTemporary
 {
 public:
        ScopedTemporary ();
        ~ScopedTemporary ();
 
+       /** @return temporary filename */
        boost::filesystem::path file () const {
                return _file;
        }
-       
+
        char const * c_str () const;
        FILE* open (char const *);
        void close ();