1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * v4l2-rect.h - v4l2_rect helper functions
4 *
5 * Copyright 2014 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
6 */
7
8 #ifndef _V4L2_RECT_H_
9 #define _V4L2_RECT_H_
10
11 #include <linux/videodev2.h>
12
13 /**
14 * v4l2_rect_set_size_to() - copy the width/height values.
15 * @r: rect whose width and height fields will be set
16 * @size: rect containing the width and height fields you need.
17 */
v4l2_rect_set_size_to(struct v4l2_rect * r,const struct v4l2_rect * size)18 static inline void v4l2_rect_set_size_to(struct v4l2_rect *r,
19 const struct v4l2_rect *size)
20 {
21 r->width = size->width;
22 r->height = size->height;
23 }
24
25 /**
26 * v4l2_rect_set_min_size() - width and height of r should be >= min_size.
27 * @r: rect whose width and height will be modified
28 * @min_size: rect containing the minimal width and height
29 */
v4l2_rect_set_min_size(struct v4l2_rect * r,const struct v4l2_rect * min_size)30 static inline void v4l2_rect_set_min_size(struct v4l2_rect *r,
31 const struct v4l2_rect *min_size)
32 {
33 if (r->width < min_size->width)
34 r->width = min_size->width;
35 if (r->height < min_size->height)
36 r->height = min_size->height;
37 }
38
39 /**
40 * v4l2_rect_set_max_size() - width and height of r should be <= max_size
41 * @r: rect whose width and height will be modified
42 * @max_size: rect containing the maximum width and height
43 */
v4l2_rect_set_max_size(struct v4l2_rect * r,const struct v4l2_rect * max_size)44 static inline void v4l2_rect_set_max_size(struct v4l2_rect *r,
45 const struct v4l2_rect *max_size)
46 {
47 if (r->width > max_size->width)
48 r->width = max_size->width;
49 if (r->height > max_size->height)
50 r->height = max_size->height;
51 }
52
53 /**
54 * v4l2_rect_map_inside()- r should be inside boundary.
55 * @r: rect that will be modified
56 * @boundary: rect containing the boundary for @r
57 */
v4l2_rect_map_inside(struct v4l2_rect * r,const struct v4l2_rect * boundary)58 static inline void v4l2_rect_map_inside(struct v4l2_rect *r,
59 const struct v4l2_rect *boundary)
60 {
61 v4l2_rect_set_max_size(r, boundary);
62 if (r->left < boundary->left)
63 r->left = boundary->left;
64 if (r->top < boundary->top)
65 r->top = boundary->top;
66 if (r->left + r->width > boundary->left + boundary->width)
67 r->left = boundary->left + boundary->width - r->width;
68 if (r->top + r->height > boundary->top + boundary->height)
69 r->top = boundary->top + boundary->height - r->height;
70 }
71
72 /**
73 * v4l2_rect_same_size() - return true if r1 has the same size as r2
74 * @r1: rectangle.
75 * @r2: rectangle.
76 *
77 * Return true if both rectangles have the same size.
78 */
v4l2_rect_same_size(const struct v4l2_rect * r1,const struct v4l2_rect * r2)79 static inline bool v4l2_rect_same_size(const struct v4l2_rect *r1,
80 const struct v4l2_rect *r2)
81 {
82 return r1->width == r2->width && r1->height == r2->height;
83 }
84
85 /**
86 * v4l2_rect_same_position() - return true if r1 has the same position as r2
87 * @r1: rectangle.
88 * @r2: rectangle.
89 *
90 * Return true if both rectangles have the same position
91 */
v4l2_rect_same_position(const struct v4l2_rect * r1,const struct v4l2_rect * r2)92 static inline bool v4l2_rect_same_position(const struct v4l2_rect *r1,
93 const struct v4l2_rect *r2)
94 {
95 return r1->top == r2->top && r1->left == r2->left;
96 }
97
98 /**
99 * v4l2_rect_equal() - return true if r1 equals r2
100 * @r1: rectangle.
101 * @r2: rectangle.
102 *
103 * Return true if both rectangles have the same size and position.
104 */
v4l2_rect_equal(const struct v4l2_rect * r1,const struct v4l2_rect * r2)105 static inline bool v4l2_rect_equal(const struct v4l2_rect *r1,
106 const struct v4l2_rect *r2)
107 {
108 return v4l2_rect_same_size(r1, r2) && v4l2_rect_same_position(r1, r2);
109 }
110
111 /**
112 * v4l2_rect_intersect() - calculate the intersection of two rects.
113 * @r: intersection of @r1 and @r2.
114 * @r1: rectangle.
115 * @r2: rectangle.
116 */
v4l2_rect_intersect(struct v4l2_rect * r,const struct v4l2_rect * r1,const struct v4l2_rect * r2)117 static inline void v4l2_rect_intersect(struct v4l2_rect *r,
118 const struct v4l2_rect *r1,
119 const struct v4l2_rect *r2)
120 {
121 int right, bottom;
122
123 r->top = max(r1->top, r2->top);
124 r->left = max(r1->left, r2->left);
125 bottom = min(r1->top + r1->height, r2->top + r2->height);
126 right = min(r1->left + r1->width, r2->left + r2->width);
127 r->height = max(0, bottom - r->top);
128 r->width = max(0, right - r->left);
129 }
130
131 /**
132 * v4l2_rect_scale() - scale rect r by to/from
133 * @r: rect to be scaled.
134 * @from: from rectangle.
135 * @to: to rectangle.
136 *
137 * This scales rectangle @r horizontally by @to->width / @from->width and
138 * vertically by @to->height / @from->height.
139 *
140 * Typically @r is a rectangle inside @from and you want the rectangle as
141 * it would appear after scaling @from to @to. So the resulting @r will
142 * be the scaled rectangle inside @to.
143 */
v4l2_rect_scale(struct v4l2_rect * r,const struct v4l2_rect * from,const struct v4l2_rect * to)144 static inline void v4l2_rect_scale(struct v4l2_rect *r,
145 const struct v4l2_rect *from,
146 const struct v4l2_rect *to)
147 {
148 if (from->width == 0 || from->height == 0) {
149 r->left = r->top = r->width = r->height = 0;
150 return;
151 }
152 r->left = (((r->left - from->left) * to->width) / from->width) & ~1;
153 r->width = ((r->width * to->width) / from->width) & ~1;
154 r->top = ((r->top - from->top) * to->height) / from->height;
155 r->height = (r->height * to->height) / from->height;
156 }
157
158 /**
159 * v4l2_rect_overlap() - do r1 and r2 overlap?
160 * @r1: rectangle.
161 * @r2: rectangle.
162 *
163 * Returns true if @r1 and @r2 overlap.
164 */
v4l2_rect_overlap(const struct v4l2_rect * r1,const struct v4l2_rect * r2)165 static inline bool v4l2_rect_overlap(const struct v4l2_rect *r1,
166 const struct v4l2_rect *r2)
167 {
168 /*
169 * IF the left side of r1 is to the right of the right side of r2 OR
170 * the left side of r2 is to the right of the right side of r1 THEN
171 * they do not overlap.
172 */
173 if (r1->left >= r2->left + r2->width ||
174 r2->left >= r1->left + r1->width)
175 return false;
176 /*
177 * IF the top side of r1 is below the bottom of r2 OR
178 * the top side of r2 is below the bottom of r1 THEN
179 * they do not overlap.
180 */
181 if (r1->top >= r2->top + r2->height ||
182 r2->top >= r1->top + r1->height)
183 return false;
184 return true;
185 }
186
187 /**
188 * v4l2_rect_enclosed() - is r1 enclosed in r2?
189 * @r1: rectangle.
190 * @r2: rectangle.
191 *
192 * Returns true if @r1 is enclosed in @r2.
193 */
v4l2_rect_enclosed(struct v4l2_rect * r1,struct v4l2_rect * r2)194 static inline bool v4l2_rect_enclosed(struct v4l2_rect *r1,
195 struct v4l2_rect *r2)
196 {
197 if (r1->left < r2->left || r1->top < r2->top)
198 return false;
199 if (r1->left + r1->width > r2->left + r2->width)
200 return false;
201 if (r1->top + r1->height > r2->top + r2->height)
202 return false;
203
204 return true;
205 }
206
207 #endif
208