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 extern std::string md5_hash (void const *, int);
  56
  57 /** @class Size
  58  *  @brief Representation of the size of something */
  59 struct Size
  60 {
  61         /** Construct a zero Size */
  62         Size ()
  63                 : width (0)
  64                 , height (0)
  65         {}
  66
  67         /** @param w Width.
  68          *  @param h Height.
  69          */
  70         Size (int w, int h)
  71                 : width (w)
  72                 , height (h)
  73         {}
  74
  75         /** width */
  76         int width;
  77         /** height */
  78         int height;
  79 };
  80
  81 /** A description of the crop of an image or video. */
  82 struct Crop
  83 {
  84         Crop () : left (0), right (0), top (0), bottom (0) {}
  85
  86         /** Number of pixels to remove from the left-hand side */
  87         int left;
  88         /** Number of pixels to remove from the right-hand side */
  89         int right;
  90         /** Number of pixels to remove from the top */
  91         int top;
  92         /** Number of pixels to remove from the bottom */
  93         int bottom;
  94 };
  95
  96 extern bool operator== (Crop const & a, Crop const & b);
  97 extern bool operator!= (Crop const & a, Crop const & b);
  98
  99 /** A position */
 100 struct Position
 101 {
 102         Position ()
 103                 : x (0)
 104                 , y (0)
 105         {}
 106
 107         Position (int x_, int y_)
 108                 : x (x_)
 109                 , y (y_)
 110         {}
 111
 112         /** x coordinate */
 113         int x;
 114         /** y coordinate */
 115         int y;
 116 };
 117
 118 extern std::string crop_string (Position, Size);
 119 extern int dcp_audio_sample_rate (int);
 120 extern std::string colour_lut_index_to_name (int index);
 121
 122 /** @class Socket
 123  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 124  *  that are useful for DVD-o-matic.
 125  *
 126  *  This class wraps some things that I could not work out how to do with boost;
 127  *  most notably, sync read/write calls with timeouts, and the ability to peak into
 128  *  data being read.
 129  */
 130 class Socket
 131 {
 132 public:
 133         Socket ();
 134
 135         /** @return Our underlying socket */
 136         boost::asio::ip::tcp::socket& socket () {
 137                 return _socket;
 138         }
 139
 140         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
 141         void write (uint8_t const * data, int size, int timeout);
 142
 143         void read_definite_and_consume (uint8_t* data, int size, int timeout);
 144         void read_indefinite (uint8_t* data, int size, int timeout);
 145         void consume (int amount);
 146
 147 private:
 148         void check ();
 149         int read (uint8_t* data, int size, int timeout);
 150
 151         Socket (Socket const &);
 152
 153         boost::asio::io_service _io_service;
 154         boost::asio::deadline_timer _deadline;
 155         boost::asio::ip::tcp::socket _socket;
 156         /** a buffer for small reads */
 157         uint8_t _buffer[256];
 158         /** amount of valid data in the buffer */
 159         int _buffer_data;
 160 };
 161
 162 #endif