summaryrefslogtreecommitdiff
path: root/src/lib/crop.h
blob: 00734d5e9c63e4d732b341b2e4983487ee3a3455 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    DCP-o-matic is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef DCPOMATIC_CROP_H
#define DCPOMATIC_CROP_H


#include <dcp/types.h>
#include <memory>


namespace cxml {
	class Node;
}


/** @struct Crop
 *  @brief A description of the crop of an image or video.
 */
struct Crop
{
	Crop() {}
	Crop(int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
	explicit Crop(std::shared_ptr<cxml::Node>);

	/** Number of pixels to remove from the left-hand side */
	int left = 0;
	/** Number of pixels to remove from the right-hand side */
	int right = 0;
	/** Number of pixels to remove from the top */
	int top = 0;
	/** Number of pixels to remove from the bottom */
	int bottom = 0;

	dcp::Size apply(dcp::Size s, int minimum = 4) const {
		s.width -= left + right;
		s.height -= top + bottom;

		if (s.width < minimum) {
			s.width = minimum;
		}

		if (s.height < minimum) {
			s.height = minimum;
		}

		return s;
	}

	void as_xml (xmlpp::Node *) const;
};


extern bool operator==(Crop const & a, Crop const & b);
extern bool operator!=(Crop const & a, Crop const & b);


#endif