src/lib/util.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Copyright (C) 2000-2007 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file src/util.h
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #ifndef DVDOMATIC_UTIL_H
  26 #define DVDOMATIC_UTIL_H
  27
  28 #include <string>
  29 #include <vector>
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/asio.hpp>
  32 extern "C" {
  33 #include <libavcodec/avcodec.h>
  34 #include <libavfilter/avfilter.h>
  35 }
  36
  37 class Scaler;
  38
  39 extern std::string seconds_to_hms (int);
  40 extern std::string seconds_to_approximate_hms (int);
  41 extern void stacktrace (std::ostream &, int);
  42 extern std::string audio_sample_format_to_string (AVSampleFormat);
  43 extern AVSampleFormat audio_sample_format_from_string (std::string);
  44 extern std::string dependency_version_summary ();
  45 extern double seconds (struct timeval);
  46 extern void dvdomatic_setup ();
  47 extern std::vector<std::string> split_at_spaces_considering_quotes (std::string);
  48 extern std::string md5_digest (std::string);
  49
  50 enum ContentType {
  51         STILL,
  52         VIDEO
  53 };
  54
  55 #ifdef DEBUG_HASH
  56 extern void md5_data (std::string, void const *, int);
  57 #endif
  58
  59 /** @class Size
  60  *  @brief Representation of the size of something */
  61 struct Size
  62 {
  63         /** Construct a zero Size */
  64         Size ()
  65                 : width (0)
  66                 , height (0)
  67         {}
  68
  69         /** @param w Width.
  70          *  @param h Height.
  71          */
  72         Size (int w, int h)
  73                 : width (w)
  74                 , height (h)
  75         {}
  76
  77         /** width */
  78         int width;
  79         /** height */
  80         int height;
  81 };
  82
  83 /** A description of the crop of an image or video. */
  84 struct Crop
  85 {
  86         Crop () : left (0), right (0), top (0), bottom (0) {}
  87
  88         /** Number of pixels to remove from the left-hand side */
  89         int left;
  90         /** Number of pixels to remove from the right-hand side */
  91         int right;
  92         /** Number of pixels to remove from the top */
  93         int top;
  94         /** Number of pixels to remove from the bottom */
  95         int bottom;
  96 };
  97
  98 extern bool operator== (Crop const & a, Crop const & b);
  99 extern bool operator!= (Crop const & a, Crop const & b);
 100
 101 /** A position */
 102 struct Position
 103 {
 104         Position ()
 105                 : x (0)
 106                 , y (0)
 107         {}
 108
 109         Position (int x_, int y_)
 110                 : x (x_)
 111                 , y (y_)
 112         {}
 113
 114         /** x coordinate */
 115         int x;
 116         /** y coordinate */
 117         int y;
 118 };
 119
 120 extern std::string crop_string (Position, Size);
 121 extern int dcp_audio_sample_rate (int);
 122 extern std::string colour_lut_index_to_name (int index);
 123
 124 /** @class Socket
 125  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 126  *  that are useful for DVD-o-matic.
 127  *
 128  *  This class wraps some things that I could not work out how to do with boost;
 129  *  most notably, sync read/write calls with timeouts, and the ability to peak into
 130  *  data being read.
 131  */
 132 class Socket
 133 {
 134 public:
 135         Socket ();
 136
 137         /** @return Our underlying socket */
 138         boost::asio::ip::tcp::socket& socket () {
 139                 return _socket;
 140         }
 141
 142         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
 143         void write (uint8_t const * data, int size, int timeout);
 144
 145         void read_definite_and_consume (uint8_t* data, int size, int timeout);
 146         void read_indefinite (uint8_t* data, int size, int timeout);
 147         void consume (int amount);
 148
 149 private:
 150         void check ();
 151         int read (uint8_t* data, int size, int timeout);
 152
 153         Socket (Socket const &);
 154
 155         boost::asio::io_service _io_service;
 156         boost::asio::deadline_timer _deadline;
 157         boost::asio::ip::tcp::socket _socket;
 158         /** a buffer for small reads */
 159         uint8_t _buffer[256];
 160         /** amount of valid data in the buffer */
 161         int _buffer_data;
 162 };
 163
 164 #endif