96397d0f7a2d80b429379f5fb401186b9544ad4c
[vlc.git] / modules / video_filter / transform.c
1 /*****************************************************************************
2  * transform.c : transform image module for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2006 VLC authors and VideoLAN
5  * Copyright (C) 2010 Laurent Aimar
6  * Copyright (C) 2012 RĂ©mi Denis-Courmont
7  *
8  * Authors: Samuel Hocevar <sam@zoy.org>
9  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29
30 #ifdef HAVE_CONFIG_H
31 #   include "config.h"
32 #endif
33 #include <limits.h>
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_filter.h>
38 #include <vlc_mouse.h>
39 #include <vlc_picture.h>
40
41 /*****************************************************************************
42  * Module descriptor
43  *****************************************************************************/
44 static int  Open (filter_t *);
45
46 #define CFG_PREFIX "transform-"
47
48 #define TYPE_TEXT N_("Transform type")
49 static const char * const type_list[] = { "90", "180", "270",
50     "hflip", "vflip", "transpose", "antitranspose" };
51 static const char * const type_list_text[] = { N_("Rotate by 90 degrees"),
52     N_("Rotate by 180 degrees"), N_("Rotate by 270 degrees"),
53     N_("Flip horizontally"), N_("Flip vertically"),
54     N_("Transpose"), N_("Anti-transpose") };
55
56 vlc_module_begin()
57     set_description(N_("Video transformation filter"))
58     set_shortname(N_("Transformation"))
59     set_help(N_("Rotate or flip the video"))
60     set_category(CAT_VIDEO)
61     set_subcategory(SUBCAT_VIDEO_VFILTER)
62
63     add_string(CFG_PREFIX "type", "90", TYPE_TEXT, TYPE_TEXT, false)
64         change_string_list(type_list, type_list_text)
65         change_safe()
66
67     add_shortcut("transform")
68     set_callback_video_filter(Open)
69 vlc_module_end()
70
71 /*****************************************************************************
72  * Local prototypes
73  *****************************************************************************/
74 static void HFlip(int *sx, int *sy, int w, int h, int dx, int dy)
75 {
76     VLC_UNUSED( h );
77     *sx = w - 1 - dx;
78     *sy = dy;
79 }
80 static void VFlip(int *sx, int *sy, int w, int h, int dx, int dy)
81 {
82     VLC_UNUSED( w );
83     *sx = dx;
84     *sy = h - 1 - dy;
85 }
86 static void Transpose(int *sx, int *sy, int w, int h, int dx, int dy)
87 {
88     VLC_UNUSED( h ); VLC_UNUSED( w );
89     *sx = dy;
90     *sy = dx;
91 }
92 static void AntiTranspose(int *sx, int *sy, int w, int h, int dx, int dy)
93 {
94     *sx = h - 1 - dy;
95     *sy = w - 1 - dx;
96 }
97 static void R90(int *sx, int *sy, int w, int h, int dx, int dy)
98 {
99     VLC_UNUSED( h );
100     *sx = dy;
101     *sy = w - 1 - dx;
102 }
103 static void R180(int *sx, int *sy, int w, int h, int dx, int dy)
104 {
105     *sx = w - 1 - dx;
106     *sy = h - 1 - dy;
107 }
108 static void R270(int *sx, int *sy, int w, int h, int dx, int dy)
109 {
110     VLC_UNUSED( w );
111     *sx = h - 1 - dy;
112     *sy = dx;
113 }
114 typedef void (*convert_t)(int *, int *, int, int, int, int);
115
116 #define PLANE(f,bits) \
117 static void Plane##bits##_##f(plane_t *restrict dst, const plane_t *restrict src) \
118 { \
119     const uint##bits##_t *src_pixels = (const void *)src->p_pixels; \
120     uint##bits##_t *restrict dst_pixels = (void *)dst->p_pixels; \
121     const unsigned src_width = src->i_pitch / sizeof (*src_pixels); \
122     const unsigned dst_width = dst->i_pitch / sizeof (*dst_pixels); \
123     const unsigned dst_visible_width = dst->i_visible_pitch / sizeof (*dst_pixels); \
124  \
125     for (int y = 0; y < dst->i_visible_lines; y++) { \
126         for (unsigned x = 0; x < dst_visible_width; x++) { \
127             int sx, sy; \
128             (f)(&sx, &sy, dst_visible_width, dst->i_visible_lines, x, y); \
129             dst_pixels[y * dst_width + x] = \
130                 src_pixels[sy * src_width + sx]; \
131         } \
132     } \
133 }
134
135 static void Plane_VFlip(plane_t *restrict dst, const plane_t *restrict src)
136 {
137     const uint8_t *src_pixels = src->p_pixels;
138     uint8_t *restrict dst_pixels = dst->p_pixels;
139
140     dst_pixels += dst->i_pitch * dst->i_visible_lines;
141     for (int y = 0; y < dst->i_visible_lines; y++) {
142         dst_pixels -= dst->i_pitch;
143         memcpy(dst_pixels, src_pixels, dst->i_visible_pitch);
144         src_pixels += src->i_pitch;
145     }
146 }
147
148 #define I422(f) \
149 static void Plane422_##f(plane_t *restrict dst, const plane_t *restrict src) \
150 { \
151     for (int y = 0; y < dst->i_visible_lines; y += 2) { \
152         for (int x = 0; x < dst->i_visible_pitch; x++) { \
153             int sx, sy, uv; \
154             (f)(&sx, &sy, dst->i_visible_pitch, dst->i_visible_lines / 2, \
155                 x, y / 2); \
156             uv = (1 + src->p_pixels[2 * sy * src->i_pitch + sx] + \
157                 src->p_pixels[(2 * sy + 1) * src->i_pitch + sx]) / 2; \
158             dst->p_pixels[y * dst->i_pitch + x] = uv; \
159             dst->p_pixels[(y + 1) * dst->i_pitch + x] = uv; \
160         } \
161     } \
162 }
163
164 #define YUY2(f) \
165 static void PlaneYUY2_##f(plane_t *restrict dst, const plane_t *restrict src) \
166 { \
167     unsigned dst_visible_width = dst->i_visible_pitch / 2; \
168  \
169     for (int y = 0; y < dst->i_visible_lines; y += 2) { \
170         for (unsigned x = 0; x < dst_visible_width; x+= 2) { \
171             int sx0, sy0, sx1, sy1; \
172             (f)(&sx0, &sy0, dst_visible_width, dst->i_visible_lines, x, y); \
173             (f)(&sx1, &sy1, dst_visible_width, dst->i_visible_lines, \
174                 x + 1, y + 1); \
175             dst->p_pixels[(y + 0) * dst->i_pitch + 2 * (x + 0)] = \
176                 src->p_pixels[sy0 * src->i_pitch + 2 * sx0]; \
177             dst->p_pixels[(y + 0) * dst->i_pitch + 2 * (x + 1)] = \
178                 src->p_pixels[sy1 * src->i_pitch + 2 * sx0]; \
179             dst->p_pixels[(y + 1) * dst->i_pitch + 2 * (x + 0)] = \
180                 src->p_pixels[sy0 * src->i_pitch + 2 * sx1]; \
181             dst->p_pixels[(y + 1) * dst->i_pitch + 2 * (x + 1)] = \
182                 src->p_pixels[sy1 * src->i_pitch + 2 * sx1]; \
183  \
184             int sx, sy, u, v; \
185             (f)(&sx, &sy, dst_visible_width / 2, dst->i_visible_lines / 2, \
186                 x / 2, y / 2); \
187             u = (1 + src->p_pixels[2 * sy * src->i_pitch + 4 * sx + 1] + \
188                 src->p_pixels[(2 * sy + 1) * src->i_pitch + 4 * sx + 1]) / 2; \
189             v = (1 + src->p_pixels[2 * sy * src->i_pitch + 4 * sx + 3] + \
190                 src->p_pixels[(2 * sy + 1) * src->i_pitch + 4 * sx + 3]) / 2; \
191             dst->p_pixels[(y + 0) * dst->i_pitch + 2 * x + 1] = u; \
192             dst->p_pixels[(y + 0) * dst->i_pitch + 2 * x + 3] = v; \
193             dst->p_pixels[(y + 1) * dst->i_pitch + 2 * x + 1] = u; \
194             dst->p_pixels[(y + 1) * dst->i_pitch + 2 * x + 3] = v; \
195         } \
196     } \
197 }
198
199 #undef PLANES // already exists on Windows
200 #define PLANES(f) \
201 PLANE(f,8) PLANE(f,16) PLANE(f,32)
202
203 PLANES(HFlip)
204 #define Plane8_VFlip Plane_VFlip
205 #define Plane16_VFlip Plane_VFlip
206 #define Plane32_VFlip Plane_VFlip
207 PLANES(Transpose)
208 PLANES(AntiTranspose)
209 PLANES(R90)
210 PLANES(R180)
211 PLANES(R270)
212
213 #define Plane422_HFlip Plane16_HFlip
214 #define Plane422_VFlip Plane_VFlip
215 #define Plane422_R180  Plane16_R180
216 I422(Transpose)
217 I422(AntiTranspose)
218 I422(R90)
219 I422(R270)
220
221 #define PlaneYUY2_HFlip Plane32_HFlip
222 #define PlaneYUY2_VFlip Plane_VFlip
223 #define PlaneYUY2_R180  Plane32_R180
224 YUY2(Transpose)
225 YUY2(AntiTranspose)
226 YUY2(R90)
227 YUY2(R270)
228
229 typedef struct {
230     char      name[16];
231     convert_t convert;
232     convert_t iconvert;
233     video_transform_t operation;
234     void      (*plane8) (plane_t *dst, const plane_t *src);
235     void      (*plane16)(plane_t *dst, const plane_t *src);
236     void      (*plane32)(plane_t *dst, const plane_t *src);
237     void      (*i422)(plane_t *dst, const plane_t *src);
238     void      (*yuyv)(plane_t *dst, const plane_t *src);
239 } transform_description_t;
240
241 #define DESC(str, f, invf, op) \
242     { str, f, invf, op, Plane8_##f, Plane16_##f, Plane32_##f, \
243       Plane422_##f, PlaneYUY2_##f }
244
245 static const transform_description_t descriptions[] = {
246     DESC("90",            R90,           R270,          TRANSFORM_R90),
247     DESC("180",           R180,          R180,          TRANSFORM_R180),
248     DESC("270",           R270,          R90,           TRANSFORM_R270),
249     DESC("hflip",         HFlip,         HFlip,         TRANSFORM_HFLIP),
250     DESC("vflip",         VFlip,         VFlip,         TRANSFORM_VFLIP),
251     DESC("transpose",     Transpose,     Transpose,     TRANSFORM_TRANSPOSE),
252     DESC("antitranspose", AntiTranspose, AntiTranspose, TRANSFORM_ANTI_TRANSPOSE),
253 };
254
255 static bool dsc_is_rotated(const transform_description_t *dsc)
256 {
257     return dsc->plane32 != dsc->yuyv;
258 }
259
260 typedef struct
261 {
262     const vlc_chroma_description_t *chroma;
263     void (*plane[PICTURE_PLANE_MAX])(plane_t *, const plane_t *);
264     convert_t convert;
265 } filter_sys_t;
266
267 static picture_t *Filter(filter_t *filter, picture_t *src)
268 {
269     filter_sys_t *sys = filter->p_sys;
270
271     picture_t *dst = filter_NewPicture(filter);
272     if (!dst) {
273         picture_Release(src);
274         return NULL;
275     }
276
277     const vlc_chroma_description_t *chroma = sys->chroma;
278     for (unsigned i = 0; i < chroma->plane_count; i++)
279          (sys->plane[i])(&dst->p[i], &src->p[i]);
280
281     picture_CopyProperties(dst, src);
282     picture_Release(src);
283     return dst;
284 }
285
286 static int Mouse(filter_t *filter, vlc_mouse_t *mouse,
287                  const vlc_mouse_t *mold)
288 {
289     VLC_UNUSED( mold );
290
291     const video_format_t *fmt = &filter->fmt_out.video;
292     const filter_sys_t   *sys = filter->p_sys;
293
294     sys->convert(&mouse->i_x, &mouse->i_y,
295                  fmt->i_visible_width, fmt->i_visible_height,
296                  mouse->i_x, mouse->i_y);
297     return VLC_SUCCESS;
298 }
299
300 static int Open(filter_t *filter)
301 {
302     const video_format_t *src = &filter->fmt_in.video;
303     video_format_t       *dst = &filter->fmt_out.video;
304
305     const vlc_chroma_description_t *chroma =
306         vlc_fourcc_GetChromaDescription(src->i_chroma);
307     if (chroma == NULL)
308         return VLC_EGENERIC;
309
310     filter_sys_t *sys = vlc_obj_malloc(VLC_OBJECT(filter), sizeof(*sys));
311     if (unlikely(!sys))
312         return VLC_ENOMEM;
313
314     sys->chroma = chroma;
315
316     static const char *const ppsz_filter_options[] = {
317         "type", NULL
318     };
319
320     config_ChainParse(filter, CFG_PREFIX, ppsz_filter_options,
321                       filter->p_cfg);
322     char *type_name = var_InheritString(filter, CFG_PREFIX"type");
323     const transform_description_t *dsc = NULL;
324
325     for (size_t i = 0; i < ARRAY_SIZE(descriptions); i++)
326         if (type_name && !strcmp(descriptions[i].name, type_name)) {
327             dsc = &descriptions[i];
328             break;
329         }
330     if (dsc == NULL) {
331         dsc = &descriptions[0];
332         msg_Warn(filter, "No valid transform mode provided, using '%s'",
333                  dsc->name);
334     }
335
336     free(type_name);
337
338     switch (chroma->pixel_size) {
339         case 1:
340             sys->plane[0] = dsc->plane8;
341             break;
342         case 2:
343             sys->plane[0] = dsc->plane16;
344             break;
345         case 4:
346             sys->plane[0] = dsc->plane32;
347             break;
348         default:
349             msg_Err(filter, "Unsupported pixel size %u (chroma %4.4s)",
350                     chroma->pixel_size, (char *)&src->i_chroma);
351             return VLC_EGENERIC;
352     }
353
354     for (unsigned i = 1; i < PICTURE_PLANE_MAX; i++)
355         sys->plane[i] = sys->plane[0];
356     sys->convert = dsc->convert;
357
358     if (dsc_is_rotated(dsc)) {
359         switch (src->i_chroma) {
360             case VLC_CODEC_I422:
361             case VLC_CODEC_J422:
362                 sys->plane[2] = sys->plane[1] = dsc->i422;
363                 break;
364             default:
365                 for (unsigned i = 0; i < chroma->plane_count; i++) {
366                     if (chroma->p[i].w.num * chroma->p[i].h.den
367                      != chroma->p[i].h.num * chroma->p[i].w.den) {
368                         msg_Err(filter, "Format rotation not possible "
369                                 "(chroma %4.4s)", (char *)&src->i_chroma);
370                         return VLC_EGENERIC;
371                     }
372             }
373         }
374     }
375
376     /*
377      * Note: we neither compare nor set dst->orientation,
378      * the caller needs to do it manually (user might want
379      * to transform video without changing the orientation).
380      */
381
382     video_format_t src_trans = *src;
383     video_format_TransformBy(&src_trans, dsc->operation);
384
385     if (!filter->b_allow_fmt_out_change &&
386         (dst->i_width          != src_trans.i_width ||
387          dst->i_visible_width  != src_trans.i_visible_width ||
388          dst->i_height         != src_trans.i_height ||
389          dst->i_visible_height != src_trans.i_visible_height ||
390          dst->i_sar_num        != src_trans.i_sar_num ||
391          dst->i_sar_den        != src_trans.i_sar_den ||
392          dst->i_x_offset       != src_trans.i_x_offset ||
393          dst->i_y_offset       != src_trans.i_y_offset)) {
394
395             msg_Err(filter, "Format change is not allowed");
396             return VLC_EGENERIC;
397     }
398     else if(filter->b_allow_fmt_out_change) {
399
400         dst->i_width          = src_trans.i_width;
401         dst->i_visible_width  = src_trans.i_visible_width;
402         dst->i_height         = src_trans.i_height;
403         dst->i_visible_height = src_trans.i_visible_height;
404         dst->i_sar_num        = src_trans.i_sar_num;
405         dst->i_sar_den        = src_trans.i_sar_den;
406         dst->i_x_offset       = src_trans.i_x_offset;
407         dst->i_y_offset       = src_trans.i_y_offset;
408     }
409
410     /* Deal with weird packed formats */
411     switch (src->i_chroma) {
412         case VLC_CODEC_UYVY:
413         case VLC_CODEC_VYUY:
414             if (dsc_is_rotated(dsc)) {
415                 msg_Err(filter, "Format rotation not possible (chroma %4.4s)",
416                         (char *)&src->i_chroma);
417                 return VLC_EGENERIC;
418             }
419             /* fallthrough */
420         case VLC_CODEC_YUYV:
421         case VLC_CODEC_YVYU:
422             sys->plane[0] = dsc->yuyv; /* 32-bits, not 16-bits! */
423             break;
424         case VLC_CODEC_NV12:
425         case VLC_CODEC_NV21:
426             return VLC_EGENERIC;
427     }
428
429     static const struct vlc_filter_operations filter_ops =
430     {
431         .filter_video = Filter,
432         .video_mouse = Mouse,
433     };
434     filter->ops = &filter_ops;
435     filter->p_sys           = sys;
436     return VLC_SUCCESS;
437 }