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 extern "C" {
  32 #include <libavcodec/avcodec.h>
  33 #include <libavfilter/avfilter.h>
  34 }
  35
  36 class Scaler;
  37
  38 extern std::string seconds_to_hms (int);
  39 extern std::string seconds_to_approximate_hms (int);
  40 extern void stacktrace (std::ostream &, int);
  41 extern std::string audio_sample_format_to_string (AVSampleFormat);
  42 extern AVSampleFormat audio_sample_format_from_string (std::string);
  43 extern std::string dependency_version_summary ();
  44 extern void socket_write (int, uint8_t const *, int);
  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
  49 enum ContentType {
  50         STILL,
  51         VIDEO
  52 };
  53
  54 #ifdef DEBUG_HASH
  55 extern void md5_data (std::string, void const *, int);
  56 #endif
  57
  58 /** @class SocketReader
  59  *  @brief A helper class from reading from sockets.
  60  */
  61 class SocketReader
  62 {
  63 public:
  64         SocketReader (int);
  65
  66         void read_definite_and_consume (uint8_t *, int);
  67         void read_indefinite (uint8_t *, int);
  68         void consume (int);
  69
  70 private:
  71         /** file descriptor we are reading from */
  72         int _fd;
  73         /** a buffer for small reads */
  74         uint8_t _buffer[256];
  75         /** amount of valid data in the buffer */
  76         int _buffer_data;
  77 };
  78
  79 /** @class Size
  80  *  @brief Representation of the size of something */
  81 struct Size
  82 {
  83         /** Construct a zero Size */
  84         Size ()
  85                 : width (0)
  86                 , height (0)
  87         {}
  88
  89         /** @param w Width.
  90          *  @param h Height.
  91          */
  92         Size (int w, int h)
  93                 : width (w)
  94                 , height (h)
  95         {}
  96
  97         /** width */
  98         int width;
  99         /** height */
 100         int height;
 101 };
 102
 103 struct Position
 104 {
 105         Position ()
 106                 : x (0)
 107                 , y (0)
 108         {}
 109
 110         Position (int x_, int y_)
 111                 : x (x_)
 112                 , y (y_)
 113         {}
 114
 115         int x;
 116         int y;
 117 };
 118
 119 extern std::string crop_string (Position, Size);
 120
 121 #endif