Merge master.
[dcpomatic.git] / src / lib / util.h
index d7f2330038cd653f0c8336fb1b11d9e209a67b9e..d3e6a67de9e1fd053783c65afd8effaef22ef001 100644 (file)
  *  @brief Some utility functions and classes.
  */
 
-#ifndef DVDOMATIC_UTIL_H
-#define DVDOMATIC_UTIL_H
+#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>
 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
+
+#undef check
+
+/** The maximum number of audio channels that we can cope with */
+#define MAX_AUDIO_CHANNELS 6
+
+#define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way"
 
-class Scaler;
+namespace libdcp {
+       class Signer;
+}
+
+class Job;
 
 extern std::string seconds_to_hms (int);
 extern std::string seconds_to_approximate_hms (int);
 extern void stacktrace (std::ostream &, int);
-extern std::string audio_sample_format_to_string (AVSampleFormat);
-extern AVSampleFormat audio_sample_format_from_string (std::string);
 extern std::string dependency_version_summary ();
 extern double seconds (struct timeval);
-extern void dvdomatic_setup ();
+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::string);
-
-enum ContentType {
-       STILL,
-       VIDEO
-};
-
-#ifdef DEBUG_HASH
-extern void md5_data (std::string, void const *, int);
+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);
+#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);
 
-/** @class Size
- *  @brief Representation of the size of something */
-struct Size
+struct FrameRateChange
 {
-       /** Construct a zero Size */
-       Size ()
-               : width (0)
-               , height (0)
-       {}
-
-       /** @param w Width.
-        *  @param h Height.
-        */
-       Size (int w, int h)
-               : width (w)
-               , height (h)
-       {}
-
-       /** width */
-       int width;
-       /** height */
-       int height;
-};
+       FrameRateChange (float, int);
 
-struct Crop
-{
-       Crop () : left (0), right (0), top (0), bottom (0) {}
-       
-       int left;
-       int right;
-       int top;
-       int bottom;
-};
+       /** @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;
+               }
 
-extern bool operator== (Crop const & a, Crop const & b);
-extern bool operator!= (Crop const & a, Crop const & b);
+               return repeat;
+       }
 
-struct Position
-{
-       Position ()
-               : x (0)
-               , y (0)
-       {}
-
-       Position (int x_, int y_)
-               : x (x_)
-               , y (y_)
-       {}
-
-       int x;
-       int y;
-};
+       /** 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;
 
-extern std::string crop_string (Position, Size);
-extern int dcp_audio_sample_rate (int);
-extern std::string colour_lut_index_to_name (int index);
+       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 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);
+extern std::string get_required_string (std::multimap<std::string, std::string> const & kv, std::string k);
+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);
+
+/** @class Socket
+ *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
+ *  that are useful for DCP-o-matic.
+ *
+ *  This class wraps some things that I could not work out how to do with boost;
+ *  most notably, sync read/write calls with timeouts.
+ */
 class Socket
 {
 public:
-       Socket ();
+       Socket (int timeout = 30);
+       ~Socket ();
 
+       /** @return Our underlying socket */
        boost::asio::ip::tcp::socket& socket () {
                return _socket;
        }
 
-       void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
-       void write (uint8_t const * data, int size, int timeout);
+       void connect (boost::asio::ip::tcp::endpoint);
+       void accept (int);
+
+       void write (uint32_t n);
+       void write (uint8_t const * data, int size);
        
-       void read_definite_and_consume (uint8_t* data, int size, int timeout);
-       void read_indefinite (uint8_t* data, int size, int timeout);
-       void consume (int amount);
+       void read (uint8_t* data, int size);
+       uint32_t read_uint32 ();
        
 private:
        void check ();
-       int read (uint8_t* data, int size, int timeout);
 
        Socket (Socket const &);
 
        boost::asio::io_service _io_service;
        boost::asio::deadline_timer _deadline;
        boost::asio::ip::tcp::socket _socket;
-       /** a buffer for small reads */
-       uint8_t _buffer[256];
-       /** amount of valid data in the buffer */
-       int _buffer_data;
+       boost::asio::ip::tcp::acceptor* _acceptor;
+       int _timeout;
+};
+
+extern int64_t video_frames_to_audio_frames (VideoFrame v, float audio_sample_rate, float frames_per_second);
+
+class LocaleGuard
+{
+public:
+       LocaleGuard ();
+       ~LocaleGuard ();
+       
+private:
+       char* _old;
 };
 
+
 #endif
+