Some include tidying.
[dcpomatic.git] / src / lib / util.h
index f625b85729ab37e151ee40b4ac537bb8e5d29d5f..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 "compose.hpp"
+#include "types.h"
+#include "video_content.h"
 #include <dcp/util.h>
-#include <dcp/signer.h>
 extern "C" {
 #include <libavcodec/avcodec.h>
 #include <libavfilter/avfilter.h>
 }
-#include "compose.hpp"
-#include "types.h"
-#include "video_content.h"
-
-#ifdef DCPOMATIC_DEBUG
-#define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
-#else
-#define TIMING(...)
-#endif
+#include <boost/shared_ptr.hpp>
+#include <boost/asio.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+#include <string>
+#include <vector>
 
 #undef check
 
-/** The maximum number of audio channels that we can cope with */
-#define MAX_AUDIO_CHANNELS 8
-
+/** The maximum number of audio channels that we can have in a DCP */
+#define MAX_DCP_AUDIO_CHANNELS 12
 #define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
-
-namespace libdcp {
-       class Signer;
-}
+#define HISTORY_SIZE 10
+#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);
@@ -69,60 +60,20 @@ extern void dcpomatic_setup ();
 extern void dcpomatic_setup_gettext_i18n (std::string);
 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
 extern std::string md5_digest (std::vector<boost::filesystem::path>, boost::shared_ptr<Job>);
-extern std::string md5_digest (void const *, int);
 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 dcp::Signer> make_signer ();
-extern dcp::Size fit_ratio_within (float ratio, dcp::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);
-
-struct FrameRateChange
-{
-       FrameRateChange (float, int);
-
-       /** @return factor by which to multiply a source frame rate
-           to get the effective rate after any skip or repeat has happened.
-       */
-       float factor () const {
-               if (skip) {
-                       return 0.5;
-               }
-
-               return repeat;
-       }
-
-       /** true to skip every other frame */
-       bool skip;
-       /** number of times to use each frame (e.g. 1 is normal, 2 means repeat each frame once, and so on) */
-       int repeat;
-       /** true if this DCP will run its video faster or slower than the source
-        *  without taking into account `repeat' nor `skip'.
-        *  (e.g. change_speed will be true if
-        *          source is 29.97fps, DCP is 30fps
-        *          source is 14.50fps, DCP is 30fps
-        *  but not if
-        *          source is 15.00fps, DCP is 30fps
-        *          source is 12.50fps, DCP is 25fps)
-        */
-       bool change_speed;
-
-       /** Amount by which the video is being sped-up in the DCP; e.g. for a
-        *  24fps source in a 25fps DCP this would be 25/24.
-        */
-       float speed_up;
-
-       std::string description;
-};
-
 extern int dcp_audio_frame_rate (int);
 extern int stride_round_up (int, int const *, int);
-extern DCPTime time_round_up (DCPTime, DCPTime);
+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);
@@ -130,6 +81,9 @@ extern std::string get_required_string (std::multimap<std::string, std::string>
 extern int get_optional_int (std::multimap<std::string, std::string> const & kv, std::string k);
 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
@@ -170,18 +124,30 @@ private:
        int _timeout;
 };
 
-extern int64_t video_frames_to_audio_frames (VideoFrame v, float audio_sample_rate, float frames_per_second);
+extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second);
 
-class LocaleGuard
+/** @class ScopedTemporary
+ *  @brief A temporary file which is deleted when the ScopedTemporary object goes out of scope.
+ */
+class ScopedTemporary
 {
 public:
-       LocaleGuard ();
-       ~LocaleGuard ();
-       
+       ScopedTemporary ();
+       ~ScopedTemporary ();
+
+       /** @return temporary filename */
+       boost::filesystem::path file () const {
+               return _file;
+       }
+
+       char const * c_str () const;
+       FILE* open (char const *);
+       void close ();
+
 private:
-       char* _old;
+       boost::filesystem::path _file;
+       FILE* _open;
 };
 
-
 #endif