Runs.
[dcpomatic.git] / src / lib / util.h
index 3901e7ec697e2fc058e4b3f0f045631dc51d8bac..87274cfff1d3b18c5e7e4729eb3f738dca5b7b81 100644 (file)
 #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"
+
+#ifdef DVDOMATIC_DEBUG
+#define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
+#else
+#define TIMING(...)
+#endif
+
+/** The maximum number of audio channels that we can cope with */
+#define MAX_AUDIO_CHANNELS 6
 
 class Scaler;
 
 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 void socket_write (int, uint8_t const *, int);
 extern double seconds (struct timeval);
 extern void dvdomatic_setup ();
+extern void dvdomatic_setup_i18n (std::string);
 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
+extern std::string md5_digest (boost::filesystem::path);
+extern std::string md5_digest (void const *, int);
+extern void ensure_ui_thread ();
+extern std::string audio_channel_name (int);
+#ifdef DVDOMATIC_WINDOWS
+extern boost::filesystem::path mo_path ();
+#endif
 
-enum ContentType {
-       STILL,
-       VIDEO
+typedef int SourceFrame;
+typedef int64_t ContentAudioFrame;
+typedef int ContentVideoFrame;
+
+struct FrameRateConversion
+{
+       FrameRateConversion (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;
+               } else if (repeat) {
+                       return 2;
+               }
+
+               return 1;
+       }
+
+       /** true to skip every other frame */
+       bool skip;
+       /** true to repeat every frame once */
+       bool 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;
+
+       std::string description;
 };
 
-#ifdef DEBUG_HASH
-extern void md5_data (std::string, void const *, int);
-#endif
+int best_dcp_frame_rate (float);
+
+enum ContentType {
+       STILL, ///< content is still images
+       VIDEO  ///< content is a video
+};
 
-/** @class SocketReader
- *  @brief A helper class from reading from sockets.
+/** @struct Crop
+ *  @brief A description of the crop of an image or video.
  */
-class SocketReader
+struct Crop
 {
-public:
-       SocketReader (int);
-
-       void read_definite_and_consume (uint8_t *, int);
-       void read_indefinite (uint8_t *, int);
-       void consume (int);
+       Crop () : left (0), right (0), top (0), bottom (0) {}
 
-private:
-       /** file descriptor we are reading from */
-       int _fd;
-       /** a buffer for small reads */
-       uint8_t _buffer[256];
-       /** amount of valid data in the buffer */
-       int _buffer_data;
+       /** Number of pixels to remove from the left-hand side */
+       int left;
+       /** Number of pixels to remove from the right-hand side */
+       int right;
+       /** Number of pixels to remove from the top */
+       int top;
+       /** Number of pixels to remove from the bottom */
+       int bottom;
 };
 
-/** @class Size
- *  @brief Representation of the size of something */
-struct Size
+extern bool operator== (Crop const & a, Crop const & b);
+extern bool operator!= (Crop const & a, Crop const & b);
+
+/** @struct Position
+ *  @brief A position.
+ */
+struct Position
 {
-       /** Construct a zero Size */
-       Size ()
-               : width (0)
-               , height (0)
+       Position ()
+               : x (0)
+               , y (0)
        {}
 
-       /** @param w Width.
-        *  @param h Height.
-        */
-       Size (int w, int h)
-               : width (w)
-               , height (h)
+       Position (int x_, int y_)
+               : x (x_)
+               , y (y_)
        {}
 
-       /** width */
-       int width;
-       /** height */
-       int height;
+       /** x coordinate */
+       int x;
+       /** y coordinate */
+       int y;
 };
 
-struct Position
+/** @struct Rect
+ *  @brief A rectangle.
+ */
+struct Rect
 {
-       Position ()
+       Rect ()
                : x (0)
                , y (0)
+               , width (0)
+               , height (0)
        {}
 
-       Position (int x_, int y_)
+       Rect (int x_, int y_, int w_, int h_)
                : x (x_)
                , y (y_)
+               , width (w_)
+               , height (h_)
        {}
 
        int x;
        int y;
+       int width;
+       int height;
+
+       Position position () const {
+               return Position (x, y);
+       }
+
+       libdcp::Size size () const {
+               return libdcp::Size (width, height);
+       }
+
+       Rect intersection (Rect const & other) const;
+};
+
+extern std::string crop_string (Position, libdcp::Size);
+extern int dcp_audio_sample_rate (int);
+extern std::string colour_lut_index_to_name (int index);
+extern int stride_round_up (int, int const *, int);
+extern int stride_lookup (int c, int const * stride);
+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);
+
+/** @class Socket
+ *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
+ *  that are useful for DVD-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 (int timeout = 30);
+
+       /** @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);
+
+       void write (uint32_t n);
+       void write (uint8_t const * data, int size);
+       
+       void read (uint8_t* data, int size);
+       uint32_t read_uint32 ();
+       
+private:
+       void check ();
+
+       Socket (Socket const &);
+
+       boost::asio::io_service _io_service;
+       boost::asio::deadline_timer _deadline;
+       boost::asio::ip::tcp::socket _socket;
+       int _timeout;
+};
+
+/** @class AudioBuffers
+ *  @brief A class to hold multi-channel audio data in float format.
+ */
+class AudioBuffers
+{
+public:
+       AudioBuffers (int channels, int frames);
+       AudioBuffers (AudioBuffers const &);
+       ~AudioBuffers ();
+
+       float** data () const {
+               return _data;
+       }
+       
+       float* data (int) const;
+
+       int channels () const {
+               return _channels;
+       }
+
+       int frames () const {
+               return _frames;
+       }
+
+       void set_frames (int f);
+
+       void make_silent ();
+       void make_silent (int c);
+
+       void copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset);
+       void move (int from, int to, int frames);
+
+private:
+       /** Number of channels */
+       int _channels;
+       /** Number of frames (where a frame is one sample across all channels) */
+       int _frames;
+       /** Number of frames that _data can hold */
+       int _allocated_frames;
+       /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
+       float** _data;
 };
 
-extern std::string crop_string (Position, Size);
+class AudioMapping
+{
+public:
+       AudioMapping (int);
+
+       boost::optional<libdcp::Channel> source_to_dcp (int c) const;
+       boost::optional<int> dcp_to_source (libdcp::Channel c) const;
+       int dcp_channels () const;
+
+private:
+       int _source_channels;
+};
+
+extern int64_t video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second);
+extern bool still_image_file (std::string);
+extern std::pair<std::string, int> cpu_info ();
 
 #endif
+