src/lib/crop.h

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #ifndef DCPOMATIC_CROP_H
  23 #define DCPOMATIC_CROP_H
  24
  25
  26 #include <dcp/types.h>
  27 #include <memory>
  28
  29
  30 namespace cxml {
  31         class Node;
  32 }
  33
  34
  35 /** @struct Crop
  36  *  @brief A description of the crop of an image or video.
  37  */
  38 struct Crop
  39 {
  40         Crop() {}
  41         Crop(int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
  42         explicit Crop(std::shared_ptr<cxml::Node>);
  43
  44         /** Number of pixels to remove from the left-hand side */
  45         int left = 0;
  46         /** Number of pixels to remove from the right-hand side */
  47         int right = 0;
  48         /** Number of pixels to remove from the top */
  49         int top = 0;
  50         /** Number of pixels to remove from the bottom */
  51         int bottom = 0;
  52
  53         dcp::Size apply(dcp::Size s, int minimum = 4) const {
  54                 s.width -= left + right;
  55                 s.height -= top + bottom;
  56
  57                 if (s.width < minimum) {
  58                         s.width = minimum;
  59                 }
  60
  61                 if (s.height < minimum) {
  62                         s.height = minimum;
  63                 }
  64
  65                 return s;
  66         }
  67
  68         void as_xml (xmlpp::Node *) const;
  69 };
  70
  71
  72 extern bool operator==(Crop const & a, Crop const & b);
  73 extern bool operator!=(Crop const & a, Crop const & b);
  74
  75
  76 #endif