vf_deshake: Fix cast discards qualifiers from pointer target type warning.
[ffmpeg.git] / libavfilter / vf_deshake.c
1 /*
2  * Copyright (C) 2010 Georg Martius <georg.martius@web.de>
3  * Copyright (C) 2010 Daniel G. Taylor <dan@programmer-art.org>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * fast deshake / depan video filter
25  *
26  * SAD block-matching motion compensation to fix small changes in
27  * horizontal and/or vertical shift. This filter helps remove camera shake
28  * from hand-holding a camera, bumping a tripod, moving on a vehicle, etc.
29  *
30  * Algorithm:
31  *   - For each frame with one previous reference frame
32  *       - For each block in the frame
33  *           - If contrast > threshold then find likely motion vector
34  *       - For all found motion vectors
35  *           - Find most common, store as global motion vector
36  *       - Find most likely rotation angle
37  *       - Transform image along global motion
38  *
39  * TODO:
40  *   - Fill frame edges based on previous/next reference frames
41  *   - Fill frame edges by stretching image near the edges?
42  *       - Can this be done quickly and look decent?
43  *
44  * Dark Shikari links to http://wiki.videolan.org/SoC_x264_2010#GPU_Motion_Estimation_2
45  * for an algorithm similar to what could be used here to get the gmv
46  * It requires only a couple diamond searches + fast downscaling
47  *
48  * Special thanks to Jason Kotenko for his help with the algorithm and my
49  * inability to see simple errors in C code.
50  */
51
52 #include "avfilter.h"
53 #include "libavutil/common.h"
54 #include "libavutil/mem.h"
55 #include "libavutil/pixdesc.h"
56 #include "libavcodec/dsputil.h"
57
58 #include "transform.h"
59
60 #define CHROMA_WIDTH(link)  -((-link->w) >> av_pix_fmt_descriptors[link->format].log2_chroma_w)
61 #define CHROMA_HEIGHT(link) -((-link->h) >> av_pix_fmt_descriptors[link->format].log2_chroma_h)
62
63 enum SearchMethod {
64     EXHAUSTIVE,        ///< Search all possible positions
65     SMART_EXHAUSTIVE,  ///< Search most possible positions (faster)
66     SEARCH_COUNT
67 };
68
69 typedef struct {
70     double x;             ///< Horizontal shift
71     double y;             ///< Vertical shift
72 } MotionVector;
73
74 typedef struct {
75     MotionVector vector;  ///< Motion vector
76     double angle;         ///< Angle of rotation
77     double zoom;          ///< Zoom percentage
78 } Transform;
79
80 typedef struct {
81     AVClass av_class;
82     AVFilterBufferRef *ref;    ///< Previous frame
83     int rx;                    ///< Maximum horizontal shift
84     int ry;                    ///< Maximum vertical shift
85     enum FillMethod edge;      ///< Edge fill method
86     int blocksize;             ///< Size of blocks to compare
87     int contrast;              ///< Contrast threshold
88     enum SearchMethod search;  ///< Motion search method
89     AVCodecContext *avctx;
90     DSPContext c;              ///< Context providing optimized SAD methods
91     Transform last;            ///< Transform from last frame
92     int refcount;              ///< Number of reference frames (defines averaging window)
93     FILE *fp;
94     Transform avg;
95 } DeshakeContext;
96
97 static int cmp(const double *a, const double *b)
98 {
99     return *a < *b ? -1 : ( *a > *b ? 1 : 0 );
100 }
101
102 /**
103  * Cleaned mean (cuts off 20% of values to remove outliers and then averages)
104  */
105 static double clean_mean(double *values, int count)
106 {
107     double mean = 0;
108     int cut = count / 5;
109     int x;
110
111     qsort(values, count, sizeof(double), (void*)cmp);
112
113     for (x = cut; x < count - cut; x++) {
114         mean += values[x];
115     }
116
117     return mean / (count - cut * 2);
118 }
119
120 /**
121  * Find the most likely shift in motion between two frames for a given
122  * macroblock. Test each block against several shifts given by the rx
123  * and ry attributes. Searches using a simple matrix of those shifts and
124  * chooses the most likely shift by the smallest difference in blocks.
125  */
126 static void find_block_motion(DeshakeContext *deshake, uint8_t *src1,
127                               uint8_t *src2, int cx, int cy, int stride,
128                               MotionVector *mv)
129 {
130     int x, y;
131     int diff;
132     int smallest = INT_MAX;
133     int tmp, tmp2;
134
135     #define CMP(i, j) deshake->c.sad[0](deshake, src1 + cy * stride + cx, \
136                                         src2 + (j) * stride + (i), stride, \
137                                         deshake->blocksize)
138
139     if (deshake->search == EXHAUSTIVE) {
140         // Compare every possible position - this is sloooow!
141         for (y = -deshake->ry; y <= deshake->ry; y++) {
142             for (x = -deshake->rx; x <= deshake->rx; x++) {
143                 diff = CMP(cx - x, cy - y);
144                 if (diff < smallest) {
145                     smallest = diff;
146                     mv->x = x;
147                     mv->y = y;
148                 }
149             }
150         }
151     } else if (deshake->search == SMART_EXHAUSTIVE) {
152         // Compare every other possible position and find the best match
153         for (y = -deshake->ry + 1; y < deshake->ry - 2; y += 2) {
154             for (x = -deshake->rx + 1; x < deshake->rx - 2; x += 2) {
155                 diff = CMP(cx - x, cy - y);
156                 if (diff < smallest) {
157                     smallest = diff;
158                     mv->x = x;
159                     mv->y = y;
160                 }
161             }
162         }
163
164         // Hone in on the specific best match around the match we found above
165         tmp = mv->x;
166         tmp2 = mv->y;
167
168         for (y = tmp2 - 1; y <= tmp2 + 1; y++) {
169             for (x = tmp - 1; x <= tmp + 1; x++) {
170                 if (x == tmp && y == tmp2)
171                     continue;
172
173                 diff = CMP(cx - x, cy - y);
174                 if (diff < smallest) {
175                     smallest = diff;
176                     mv->x = x;
177                     mv->y = y;
178                 }
179             }
180         }
181     }
182
183     if (smallest > 512) {
184         mv->x = -1;
185         mv->y = -1;
186     }
187     emms_c();
188     //av_log(NULL, AV_LOG_ERROR, "%d\n", smallest);
189     //av_log(NULL, AV_LOG_ERROR, "Final: (%d, %d) = %d x %d\n", cx, cy, mv->x, mv->y);
190 }
191
192 /**
193  * Find the contrast of a given block. When searching for global motion we
194  * really only care about the high contrast blocks, so using this method we
195  * can actually skip blocks we don't care much about.
196  */
197 static int block_contrast(uint8_t *src, int x, int y, int stride, int blocksize)
198 {
199     int highest = 0;
200     int lowest = 0;
201     int i, j, pos;
202
203     for (i = 0; i <= blocksize * 2; i++) {
204         // We use a width of 16 here to match the libavcodec sad functions
205         for (j = 0; i <= 15; i++) {
206             pos = (y - i) * stride + (x - j);
207             if (src[pos] < lowest)
208                 lowest = src[pos];
209             else if (src[pos] > highest) {
210                 highest = src[pos];
211             }
212         }
213     }
214
215     return highest - lowest;
216 }
217
218 /**
219  * Find the rotation for a given block.
220  */
221 static double block_angle(int x, int y, int cx, int cy, MotionVector *shift)
222 {
223     double a1, a2, diff;
224
225     a1 = atan2(y - cy, x - cx);
226     a2 = atan2(y - cy + shift->y, x - cx + shift->x);
227
228     diff = a2 - a1;
229
230     return (diff > M_PI)  ? diff - 2 * M_PI :
231            (diff < -M_PI) ? diff + 2 * M_PI :
232            diff;
233 }
234
235 /**
236  * Find the estimated global motion for a scene given the most likely shift
237  * for each block in the frame. The global motion is estimated to be the
238  * same as the motion from most blocks in the frame, so if most blocks
239  * move one pixel to the right and two pixels down, this would yield a
240  * motion vector (1, -2).
241  */
242 static void find_motion(DeshakeContext *deshake, uint8_t *src1, uint8_t *src2,
243                         int width, int height, int stride, Transform *t)
244 {
245     int x, y;
246     MotionVector mv = {0, 0};
247     int counts[128][128];
248     int count_max_value = 0;
249     int contrast;
250
251     int pos;
252     double *angles = av_malloc(sizeof(*angles) * width * height / (16 * deshake->blocksize));
253     double totalangles = 0;
254
255     int center_x = 0, center_y = 0;
256     double p_x, p_y;
257
258     // Reset counts to zero
259     for (x = 0; x < deshake->rx * 2 + 1; x++) {
260         for (y = 0; y < deshake->ry * 2 + 1; y++) {
261             counts[x][y] = 0;
262         }
263     }
264
265     pos = 0;
266     // Find motion for every block and store the motion vector in the counts
267     for (y = deshake->ry; y < height - deshake->ry - (deshake->blocksize * 2); y += deshake->blocksize * 2) {
268         // We use a width of 16 here to match the libavcodec sad functions
269         for (x = deshake->rx; x < width - deshake->rx - 16; x += 16) {
270             // If the contrast is too low, just skip this block as it probably
271             // won't be very useful to us.
272             contrast = block_contrast(src2, x, y, stride, deshake->blocksize);
273             if (contrast > deshake->contrast) {
274                 //av_log(NULL, AV_LOG_ERROR, "%d\n", contrast);
275                 find_block_motion(deshake, src1, src2, x, y, stride, &mv);
276                 if (mv.x != -1 && mv.y != -1) {
277                     counts[(int)(mv.x + deshake->rx)][(int)(mv.y + deshake->ry)] += 1;
278                     if (x > deshake->rx && y > deshake->ry)
279                         angles[pos++] = block_angle(x, y, 0, 0, &mv);
280
281                     center_x += mv.x;
282                     center_y += mv.y;
283                 }
284             }
285         }
286     }
287
288     pos = FFMAX(1, pos);
289
290     center_x /= pos;
291     center_y /= pos;
292
293     for (x = 0; x < pos; x++) {
294         totalangles += angles[x];
295     }
296
297     //av_log(NULL, AV_LOG_ERROR, "Angle: %lf\n", totalangles / (pos - 1));
298     t->angle = totalangles / (pos - 1);
299
300     t->angle = clean_mean(angles, pos);
301     if (t->angle < 0.001)
302         t->angle = 0;
303
304     // Find the most common motion vector in the frame and use it as the gmv
305     for (y = deshake->ry * 2; y >= 0; y--) {
306         for (x = 0; x < deshake->rx * 2 + 1; x++) {
307             //av_log(NULL, AV_LOG_ERROR, "%5d ", counts[x][y]);
308             if (counts[x][y] > count_max_value) {
309                 t->vector.x = x - deshake->rx;
310                 t->vector.y = y - deshake->ry;
311                 count_max_value = counts[x][y];
312             }
313         }
314         //av_log(NULL, AV_LOG_ERROR, "\n");
315     }
316
317     p_x = (center_x - width / 2);
318     p_y = (center_y - height / 2);
319     t->vector.x += (cos(t->angle)-1)*p_x  - sin(t->angle)*p_y;
320     t->vector.y += sin(t->angle)*p_x  + (cos(t->angle)-1)*p_y;
321
322     // Clamp max shift & rotation?
323     t->vector.x = av_clipf(t->vector.x, -deshake->rx * 2, deshake->rx * 2);
324     t->vector.y = av_clipf(t->vector.y, -deshake->ry * 2, deshake->ry * 2);
325     t->angle = av_clipf(t->angle, -0.1, 0.1);
326
327     //av_log(NULL, AV_LOG_ERROR, "%d x %d\n", avg->x, avg->y);
328     av_free(angles);
329 }
330
331 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
332 {
333     DeshakeContext *deshake = ctx->priv;
334     char filename[256] = {0};
335
336     deshake->rx = 16;
337     deshake->ry = 16;
338     deshake->edge = FILL_MIRROR;
339     deshake->blocksize = 8;
340     deshake->contrast = 125;
341     deshake->search = EXHAUSTIVE;
342     deshake->refcount = 20;
343
344     if (args) {
345         sscanf(args, "%d:%d:%d:%d:%d:%d:%255s", &deshake->rx, &deshake->ry, (int *)&deshake->edge,
346                &deshake->blocksize, &deshake->contrast, (int *)&deshake->search, filename);
347
348         deshake->blocksize /= 2;
349
350         deshake->rx = av_clip(deshake->rx, 0, 64);
351         deshake->ry = av_clip(deshake->ry, 0, 64);
352         deshake->edge = av_clip(deshake->edge, FILL_BLANK, FILL_COUNT - 1);
353         deshake->blocksize = av_clip(deshake->blocksize, 4, 128);
354         deshake->contrast = av_clip(deshake->contrast, 1, 255);
355         deshake->search = av_clip(deshake->search, EXHAUSTIVE, SEARCH_COUNT - 1);
356     }
357     if (*filename)
358         deshake->fp = fopen(filename, "w");
359     if (deshake->fp)
360         fwrite("Ori x, Avg x, Fin x, Ori y, Avg y, Fin y, Ori angle, Avg angle, Fin angle, Ori zoom, Avg zoom, Fin zoom\n", sizeof(char), 104, deshake->fp);
361
362     av_log(ctx, AV_LOG_INFO, "rx: %d, ry: %d, edge: %d blocksize: %d contrast: %d search: %d\n",
363            deshake->rx, deshake->ry, deshake->edge, deshake->blocksize * 2, deshake->contrast, deshake->search);
364
365     return 0;
366 }
367
368 static int query_formats(AVFilterContext *ctx)
369 {
370     enum PixelFormat pix_fmts[] = {
371         PIX_FMT_YUV420P,  PIX_FMT_YUV422P,  PIX_FMT_YUV444P,  PIX_FMT_YUV410P,
372         PIX_FMT_YUV411P,  PIX_FMT_YUV440P,  PIX_FMT_YUVJ420P, PIX_FMT_YUVJ422P,
373         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ440P, PIX_FMT_NONE
374     };
375
376     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
377
378     return 0;
379 }
380
381 static int config_props(AVFilterLink *link)
382 {
383     DeshakeContext *deshake = link->dst->priv;
384
385     deshake->ref = NULL;
386     deshake->last.vector.x = 0;
387     deshake->last.vector.y = 0;
388     deshake->last.angle = 0;
389     deshake->last.zoom = 0;
390
391     deshake->avctx = avcodec_alloc_context3(NULL);
392     dsputil_init(&deshake->c, deshake->avctx);
393
394     return 0;
395 }
396
397 static av_cold void uninit(AVFilterContext *ctx)
398 {
399     DeshakeContext *deshake = ctx->priv;
400
401     avfilter_unref_buffer(deshake->ref);
402     if (deshake->fp)
403         fclose(deshake->fp);
404 }
405
406 static void end_frame(AVFilterLink *link)
407 {
408     DeshakeContext *deshake = link->dst->priv;
409     AVFilterBufferRef *in  = link->cur_buf;
410     AVFilterBufferRef *out = link->dst->outputs[0]->out_buf;
411     Transform t;
412     float matrix[9];
413     float alpha = 2.0 / deshake->refcount;
414     char tmp[256];
415     Transform orig;
416
417     // Find the most likely global motion for the current frame
418     find_motion(deshake, (deshake->ref == NULL) ? in->data[0] : deshake->ref->data[0], in->data[0], link->w, link->h, in->linesize[0], &t);
419
420     // Copy transform so we can output it later to compare to the smoothed value
421     orig.vector.x = t.vector.x;
422     orig.vector.y = t.vector.y;
423     orig.angle = t.angle;
424     orig.zoom = t.zoom;
425
426     // Generate a one-sided moving exponential average
427     deshake->avg.vector.x = alpha * t.vector.x + (1.0 - alpha) * deshake->avg.vector.x;
428     deshake->avg.vector.y = alpha * t.vector.y + (1.0 - alpha) * deshake->avg.vector.y;
429     deshake->avg.angle = alpha * t.angle + (1.0 - alpha) * deshake->avg.angle;
430     deshake->avg.zoom = alpha * t.zoom + (1.0 - alpha) * deshake->avg.zoom;
431
432     // Remove the average from the current motion to detect the motion that
433     // is not on purpose, just as jitter from bumping the camera
434     t.vector.x -= deshake->avg.vector.x;
435     t.vector.y -= deshake->avg.vector.y;
436     t.angle -= deshake->avg.angle;
437     t.zoom -= deshake->avg.zoom;
438
439     // Invert the motion to undo it
440     t.vector.x *= -1;
441     t.vector.y *= -1;
442     t.angle *= -1;
443
444     // Write statistics to file
445     if (deshake->fp) {
446         snprintf(tmp, 256, "%f, %f, %f, %f, %f, %f, %f, %f, %f, %f, %f, %f\n", orig.vector.x, deshake->avg.vector.x, t.vector.x, orig.vector.y, deshake->avg.vector.y, t.vector.y, orig.angle, deshake->avg.angle, t.angle, orig.zoom, deshake->avg.zoom, t.zoom);
447         fwrite(tmp, sizeof(char), strlen(tmp), deshake->fp);
448     }
449
450     // Turn relative current frame motion into absolute by adding it to the
451     // last absolute motion
452     t.vector.x += deshake->last.vector.x;
453     t.vector.y += deshake->last.vector.y;
454     t.angle += deshake->last.angle;
455     t.zoom += deshake->last.zoom;
456
457     // Shrink motion by 10% to keep things centered in the camera frame
458     t.vector.x *= 0.9;
459     t.vector.y *= 0.9;
460     t.angle *= 0.9;
461
462     // Store the last absolute motion information
463     deshake->last.vector.x = t.vector.x;
464     deshake->last.vector.y = t.vector.y;
465     deshake->last.angle = t.angle;
466     deshake->last.zoom = t.zoom;
467
468     // Generate a luma transformation matrix
469     avfilter_get_matrix(t.vector.x, t.vector.y, t.angle, 1.0 + t.zoom / 100.0, matrix);
470
471     // Transform the luma plane
472     avfilter_transform(in->data[0], out->data[0], in->linesize[0], out->linesize[0], link->w, link->h, matrix, INTERPOLATE_BILINEAR, deshake->edge);
473
474     // Generate a chroma transformation matrix
475     avfilter_get_matrix(t.vector.x / (link->w / CHROMA_WIDTH(link)), t.vector.y / (link->h / CHROMA_HEIGHT(link)), t.angle, 1.0 + t.zoom / 100.0, matrix);
476
477     // Transform the chroma planes
478     avfilter_transform(in->data[1], out->data[1], in->linesize[1], out->linesize[1], CHROMA_WIDTH(link), CHROMA_HEIGHT(link), matrix, INTERPOLATE_BILINEAR, deshake->edge);
479     avfilter_transform(in->data[2], out->data[2], in->linesize[2], out->linesize[2], CHROMA_WIDTH(link), CHROMA_HEIGHT(link), matrix, INTERPOLATE_BILINEAR, deshake->edge);
480
481     // Store the current frame as the reference frame for calculating the
482     // motion of the next frame
483     if (deshake->ref != NULL)
484         avfilter_unref_buffer(deshake->ref);
485
486     // Cleanup the old reference frame
487     deshake->ref = in;
488
489     // Draw the transformed frame information
490     avfilter_draw_slice(link->dst->outputs[0], 0, link->h, 1);
491     avfilter_end_frame(link->dst->outputs[0]);
492     avfilter_unref_buffer(out);
493 }
494
495 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
496 {
497 }
498
499 AVFilter avfilter_vf_deshake = {
500     .name      = "deshake",
501     .description = NULL_IF_CONFIG_SMALL("Stabilize shaky video."),
502
503     .priv_size = sizeof(DeshakeContext),
504
505     .init = init,
506     .uninit = uninit,
507     .query_formats = query_formats,
508
509     .inputs    = (AVFilterPad[]) {{ .name             = "default",
510                                     .type             = AVMEDIA_TYPE_VIDEO,
511                                     .draw_slice       = draw_slice,
512                                     .end_frame        = end_frame,
513                                     .config_props     = config_props,
514                                     .min_perms        = AV_PERM_READ, },
515                                   { .name = NULL}},
516
517     .outputs   = (AVFilterPad[]) {{ .name             = "default",
518                                     .type             = AVMEDIA_TYPE_VIDEO, },
519                                   { .name = NULL}},
520 };