Some work on DCI naming. Clean up compacted / aligned image handling somewhat.

[dcpomatic.git] / src / lib / util.h

diff --git a/src/lib/util.h b/src/lib/util.h
index 8d6e2f5415f5a202b6b30c2baa0065bfe964827c..bd7675a8af28ae05676aba327794ef37b2b6105f 100644 (file)
--- a/src/lib/util.h
+++ b/src/lib/util.h
@@ -33,6 +33,13 @@ extern "C" {
 #include <libavcodec/avcodec.h>
 #include <libavfilter/avfilter.h>
 }
+#include "compose.hpp"
+
+#ifdef DVDOMATIC_DEBUG
+#define TIMING(...) _log->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING);
+#else
+#define TIMING(...)
+#endif
 
 class Scaler;
 
@@ -46,16 +53,13 @@ extern double seconds (struct timeval);
 extern void dvdomatic_setup ();
 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
 extern std::string md5_digest (std::string);
+extern std::string md5_digest (void const *, int);
 
 enum ContentType {
        STILL,
        VIDEO
 };
 
-#ifdef DEBUG_HASH
-extern void md5_data (std::string, void const *, int);
-#endif
-
 /** @class Size
  *  @brief Representation of the size of something */
 struct Size
@@ -80,19 +84,25 @@ struct Size
        int height;
 };
 
+/** A description of the crop of an image or video. */
 struct Crop
 {
        Crop () : left (0), right (0), top (0), bottom (0) {}
-       
+
+       /** 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;
 };
 
 extern bool operator== (Crop const & a, Crop const & b);
 extern bool operator!= (Crop const & a, Crop const & b);
 
+/** A position */
 struct Position
 {
        Position ()
@@ -105,26 +115,62 @@ struct Position
                , y (y_)
        {}
 
+       /** x coordinate */
        int x;
+       /** y coordinate */
        int y;
 };
 
+/** A rectangle */
+struct Rectangle
+{
+       Rectangle ()
+               : x (0)
+               , y (0)
+               , w (0)
+               , h (0)
+       {}
+
+       Rectangle (int x_, int y_, int w_, int h_)
+               : x (x_)
+               , y (y_)
+               , w (w_)
+               , h (h_)
+       {}
+
+       int x;
+       int y;
+       int w;
+       int h;
+
+       Rectangle intersection (Rectangle const & other) const;
+};
+
 extern std::string crop_string (Position, Size);
 extern int dcp_audio_sample_rate (int);
 extern std::string colour_lut_index_to_name (int index);
-
-class DeadlineWrapper
+extern int round_up (int, int);
+
+/** @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, and the ability to peak into
+ *  data being read.
+ */
+class Socket
 {
 public:
-       DeadlineWrapper ();
+       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);
-       int read (uint8_t* data, int size, int timeout);
        
        void read_definite_and_consume (uint8_t* data, int size, int timeout);
        void read_indefinite (uint8_t* data, int size, int timeout);
@@ -132,8 +178,9 @@ public:
        
 private:
        void check ();
+       int read (uint8_t* data, int size, int timeout);
 
-       DeadlineWrapper (DeadlineWrapper const &);
+       Socket (Socket const &);
 
        boost::asio::io_service _io_service;
        boost::asio::deadline_timer _deadline;
@@ -145,3 +192,4 @@ private:
 };
 
 #endif
+