1/*
2 * Copyright (C) 2011-2013 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
24#ifndef DRM_RECT_H
25#define DRM_RECT_H
26
27/**
28 * DOC: rect utils
29 *
30 * Utility functions to help manage rectangular areas for
31 * clipping, scaling, etc. calculations.
32 */
33
34/**
35 * struct drm_rect - two dimensional rectangle
36 * @x1: horizontal starting coordinate (inclusive)
37 * @x2: horizontal ending coordinate (exclusive)
38 * @y1: vertical starting coordinate (inclusive)
39 * @y2: vertical ending coordinate (exclusive)
40 */
41struct drm_rect {
42 int x1, y1, x2, y2;
43};
44
45/**
46 * DRM_RECT_FMT - printf string for &struct drm_rect
47 */
48#define DRM_RECT_FMT "%dx%d%+d%+d"
49/**
50 * DRM_RECT_ARG - printf arguments for &struct drm_rect
51 * @r: rectangle struct
52 */
53#define DRM_RECT_ARG(r) drm_rect_width(r), drm_rect_height(r), (r)->x1, (r)->y1
54
55/**
56 * DRM_RECT_FP_FMT - printf string for &struct drm_rect in 16.16 fixed point
57 */
58#define DRM_RECT_FP_FMT "%d.%06ux%d.%06u%+d.%06u%+d.%06u"
59/**
60 * DRM_RECT_FP_ARG - printf arguments for &struct drm_rect in 16.16 fixed point
61 * @r: rectangle struct
62 *
63 * This is useful for e.g. printing plane source rectangles, which are in 16.16
64 * fixed point.
65 */
66#define DRM_RECT_FP_ARG(r) \
67 drm_rect_width(r) >> 16, ((drm_rect_width(r) & 0xffff) * 15625) >> 10, \
68 drm_rect_height(r) >> 16, ((drm_rect_height(r) & 0xffff) * 15625) >> 10, \
69 (r)->x1 >> 16, (((r)->x1 & 0xffff) * 15625) >> 10, \
70 (r)->y1 >> 16, (((r)->y1 & 0xffff) * 15625) >> 10
71
72/**
73 * drm_rect_adjust_size - adjust the size of the rectangle
74 * @r: rectangle to be adjusted
75 * @dw: horizontal adjustment
76 * @dh: vertical adjustment
77 *
78 * Change the size of rectangle @r by @dw in the horizontal direction,
79 * and by @dh in the vertical direction, while keeping the center
80 * of @r stationary.
81 *
82 * Positive @dw and @dh increase the size, negative values decrease it.
83 */
84static inline void drm_rect_adjust_size(struct drm_rect *r, int dw, int dh)
85{
86 r->x1 -= dw >> 1;
87 r->y1 -= dh >> 1;
88 r->x2 += (dw + 1) >> 1;
89 r->y2 += (dh + 1) >> 1;
90}
91
92/**
93 * drm_rect_translate - translate the rectangle
94 * @r: rectangle to be tranlated
95 * @dx: horizontal translation
96 * @dy: vertical translation
97 *
98 * Move rectangle @r by @dx in the horizontal direction,
99 * and by @dy in the vertical direction.
100 */
101static inline void drm_rect_translate(struct drm_rect *r, int dx, int dy)
102{
103 r->x1 += dx;
104 r->y1 += dy;
105 r->x2 += dx;
106 r->y2 += dy;
107}
108
109/**
110 * drm_rect_downscale - downscale a rectangle
111 * @r: rectangle to be downscaled
112 * @horz: horizontal downscale factor
113 * @vert: vertical downscale factor
114 *
115 * Divide the coordinates of rectangle @r by @horz and @vert.
116 */
117static inline void drm_rect_downscale(struct drm_rect *r, int horz, int vert)
118{
119 r->x1 /= horz;
120 r->y1 /= vert;
121 r->x2 /= horz;
122 r->y2 /= vert;
123}
124
125/**
126 * drm_rect_width - determine the rectangle width
127 * @r: rectangle whose width is returned
128 *
129 * RETURNS:
130 * The width of the rectangle.
131 */
132static inline int drm_rect_width(const struct drm_rect *r)
133{
134 return r->x2 - r->x1;
135}
136
137/**
138 * drm_rect_height - determine the rectangle height
139 * @r: rectangle whose height is returned
140 *
141 * RETURNS:
142 * The height of the rectangle.
143 */
144static inline int drm_rect_height(const struct drm_rect *r)
145{
146 return r->y2 - r->y1;
147}
148
149/**
150 * drm_rect_visible - determine if the the rectangle is visible
151 * @r: rectangle whose visibility is returned
152 *
153 * RETURNS:
154 * %true if the rectangle is visible, %false otherwise.
155 */
156static inline bool drm_rect_visible(const struct drm_rect *r)
157{
158 return drm_rect_width(r) > 0 && drm_rect_height(r) > 0;
159}
160
161/**
162 * drm_rect_equals - determine if two rectangles are equal
163 * @r1: first rectangle
164 * @r2: second rectangle
165 *
166 * RETURNS:
167 * %true if the rectangles are equal, %false otherwise.
168 */
169static inline bool drm_rect_equals(const struct drm_rect *r1,
170 const struct drm_rect *r2)
171{
172 return r1->x1 == r2->x1 && r1->x2 == r2->x2 &&
173 r1->y1 == r2->y1 && r1->y2 == r2->y2;
174}
175
176bool drm_rect_intersect(struct drm_rect *r, const struct drm_rect *clip);
177bool drm_rect_clip_scaled(struct drm_rect *src, struct drm_rect *dst,
178 const struct drm_rect *clip);
179int drm_rect_calc_hscale(const struct drm_rect *src,
180 const struct drm_rect *dst,
181 int min_hscale, int max_hscale);
182int drm_rect_calc_vscale(const struct drm_rect *src,
183 const struct drm_rect *dst,
184 int min_vscale, int max_vscale);
185void drm_rect_debug_print(const char *prefix,
186 const struct drm_rect *r, bool fixed_point);
187void drm_rect_rotate(struct drm_rect *r,
188 int width, int height,
189 unsigned int rotation);
190void drm_rect_rotate_inv(struct drm_rect *r,
191 int width, int height,
192 unsigned int rotation);
193
194#endif
195