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 SocketReader
  60  *  @brief A helper class from reading from sockets.
  61  *
  62  *  You can probably do this stuff directly in boost, but I'm not sure how.
  63  */
  64 class SocketReader
  65 {
  66 public:
  67         SocketReader (boost::shared_ptr<boost::asio::ip::tcp::socket>);
  68
  69         void read_definite_and_consume (uint8_t *, int);
  70         void read_indefinite (uint8_t *, int);
  71         void consume (int);
  72
  73 private:
  74         /** socket we are reading from */
  75         boost::shared_ptr<boost::asio::ip::tcp::socket> _socket;
  76         /** a buffer for small reads */
  77         uint8_t _buffer[256];
  78         /** amount of valid data in the buffer */
  79         int _buffer_data;
  80 };
  81
  82 /** @class Size
  83  *  @brief Representation of the size of something */
  84 struct Size
  85 {
  86         /** Construct a zero Size */
  87         Size ()
  88                 : width (0)
  89                 , height (0)
  90         {}
  91
  92         /** @param w Width.
  93          *  @param h Height.
  94          */
  95         Size (int w, int h)
  96                 : width (w)
  97                 , height (h)
  98         {}
  99
 100         /** width */
 101         int width;
 102         /** height */
 103         int height;
 104 };
 105
 106 struct Crop
 107 {
 108         Crop () : left (0), right (0), top (0), bottom (0) {}
 109
 110         int left;
 111         int right;
 112         int top;
 113         int bottom;
 114 };
 115
 116 extern bool operator== (Crop const & a, Crop const & b);
 117 extern bool operator!= (Crop const & a, Crop const & b);
 118
 119 struct Position
 120 {
 121         Position ()
 122                 : x (0)
 123                 , y (0)
 124         {}
 125
 126         Position (int x_, int y_)
 127                 : x (x_)
 128                 , y (y_)
 129         {}
 130
 131         int x;
 132         int y;
 133 };
 134
 135 extern std::string crop_string (Position, Size);
 136 extern int dcp_audio_sample_rate (int);
 137 extern std::string colour_lut_index_to_name (int index);
 138
 139 #endif