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