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 struct Crop
  84 {
  85         Crop () : left (0), right (0), top (0), bottom (0) {}
  86
  87         int left;
  88         int right;
  89         int top;
  90         int bottom;
  91 };
  92
  93 extern bool operator== (Crop const & a, Crop const & b);
  94 extern bool operator!= (Crop const & a, Crop const & b);
  95
  96 struct Position
  97 {
  98         Position ()
  99                 : x (0)
 100                 , y (0)
 101         {}
 102
 103         Position (int x_, int y_)
 104                 : x (x_)
 105                 , y (y_)
 106         {}
 107
 108         int x;
 109         int y;
 110 };
 111
 112 extern std::string crop_string (Position, Size);
 113 extern int dcp_audio_sample_rate (int);
 114 extern std::string colour_lut_index_to_name (int index);
 115
 116 class DeadlineWrapper
 117 {
 118 public:
 119         DeadlineWrapper (boost::asio::io_service& io_service);
 120
 121         void set_socket (boost::shared_ptr<boost::asio::ip::tcp::socket> socket);
 122
 123         void connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint, int timeout);
 124         void write (uint8_t const * data, int size, int timeout);
 125         int read (uint8_t* data, int size, int timeout);
 126
 127         void read_definite_and_consume (uint8_t* data, int size, int timeout);
 128         void read_indefinite (uint8_t* data, int size, int timeout);
 129         void consume (int amount);
 130
 131 private:
 132         void check ();
 133
 134         boost::asio::io_service& _io_service;
 135         boost::asio::deadline_timer _deadline;
 136         boost::shared_ptr<boost::asio::ip::tcp::socket> _socket;
 137         /** a buffer for small reads */
 138         uint8_t _buffer[256];
 139         /** amount of valid data in the buffer */
 140         int _buffer_data;
 141 };
 142
 143 #endif