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 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 class SocketReader
  63 {
  64 public:
  65         SocketReader (int);
  66
  67         void read_definite_and_consume (uint8_t *, int);
  68         void read_indefinite (uint8_t *, int);
  69         void consume (int);
  70
  71 private:
  72         /** file descriptor we are reading from */
  73         int _fd;
  74         /** a buffer for small reads */
  75         uint8_t _buffer[256];
  76         /** amount of valid data in the buffer */
  77         int _buffer_data;
  78 };
  79
  80 /** @class Size
  81  *  @brief Representation of the size of something */
  82 struct Size
  83 {
  84         /** Construct a zero Size */
  85         Size ()
  86                 : width (0)
  87                 , height (0)
  88         {}
  89
  90         /** @param w Width.
  91          *  @param h Height.
  92          */
  93         Size (int w, int h)
  94                 : width (w)
  95                 , height (h)
  96         {}
  97
  98         /** width */
  99         int width;
 100         /** height */
 101         int height;
 102 };
 103
 104 struct Position
 105 {
 106         Position ()
 107                 : x (0)
 108                 , y (0)
 109         {}
 110
 111         Position (int x_, int y_)
 112                 : x (x_)
 113                 , y (y_)
 114         {}
 115
 116         int x;
 117         int y;
 118 };
 119
 120 extern std::string crop_string (Position, Size);
 121
 122 extern int dcp_audio_sample_rate (int);
 123
 124 #endif