src/lib/types.h

   1 /*
   2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_TYPES_H
  21 #define DCPOMATIC_TYPES_H
  22
  23 #include <vector>
  24 #include <stdint.h>
  25 #include <boost/shared_ptr.hpp>
  26 #include <libdcp/util.h>
  27
  28 class Content;
  29
  30 typedef int64_t ContentAudioFrame;
  31 typedef int     ContentVideoFrame;
  32 typedef int64_t Time;
  33 #define TIME_MAX INT64_MAX
  34 #define TIME_HZ  ((Time) 96000)
  35 typedef int64_t OutputAudioFrame;
  36 typedef int     OutputVideoFrame;
  37
  38 /** @struct Crop
  39  *  @brief A description of the crop of an image or video.
  40  */
  41 struct Crop
  42 {
  43         Crop () : left (0), right (0), top (0), bottom (0) {}
  44
  45         /** Number of pixels to remove from the left-hand side */
  46         int left;
  47         /** Number of pixels to remove from the right-hand side */
  48         int right;
  49         /** Number of pixels to remove from the top */
  50         int top;
  51         /** Number of pixels to remove from the bottom */
  52         int bottom;
  53 };
  54
  55 extern bool operator== (Crop const & a, Crop const & b);
  56 extern bool operator!= (Crop const & a, Crop const & b);
  57
  58 /** @struct Position
  59  *  @brief A position.
  60  */
  61 struct Position
  62 {
  63         Position ()
  64                 : x (0)
  65                 , y (0)
  66         {}
  67
  68         Position (int x_, int y_)
  69                 : x (x_)
  70                 , y (y_)
  71         {}
  72
  73         /** x coordinate */
  74         int x;
  75         /** y coordinate */
  76         int y;
  77 };
  78
  79 /** @struct Rect
  80  *  @brief A rectangle.
  81  */
  82 struct Rect
  83 {
  84         Rect ()
  85                 : x (0)
  86                 , y (0)
  87                 , width (0)
  88                 , height (0)
  89         {}
  90
  91         Rect (int x_, int y_, int w_, int h_)
  92                 : x (x_)
  93                 , y (y_)
  94                 , width (w_)
  95                 , height (h_)
  96         {}
  97
  98         int x;
  99         int y;
 100         int width;
 101         int height;
 102
 103         Position position () const {
 104                 return Position (x, y);
 105         }
 106
 107         libdcp::Size size () const {
 108                 return libdcp::Size (width, height);
 109         }
 110
 111         Rect intersection (Rect const & other) const;
 112
 113         bool contains (Position) const;
 114 };
 115
 116 #endif