deshake: simplify filename check.
[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(void const *ca, void const *cb)
98 {
99     double *a = (double *) ca;
100     double *b = (double *) cb;
101     return *a < *b ? -1 : ( *a > *b ? 1 : 0 );
102 }
103
104 /**
105  * Cleaned mean (cuts off 20% of values to remove outliers and then averages)
106  */
107 static double clean_mean(double *values, int count)
108 {
109     double mean = 0;
110     int cut = count / 5;
111     int x;
112
113     qsort(values, count, sizeof(double), cmp);
114
115     for (x = cut; x < count - cut; x++) {
116         mean += values[x];
117     }
118
119     return mean / (count - cut * 2);
120 }
121
122 /**
123  * Find the most likely shift in motion between two frames for a given
124  * macroblock. Test each block against several shifts given by the rx
125  * and ry attributes. Searches using a simple matrix of those shifts and
126  * chooses the most likely shift by the smallest difference in blocks.
127  */
128 static void find_block_motion(DeshakeContext *deshake, uint8_t *src1,
129                               uint8_t *src2, int cx, int cy, int stride,
130                               MotionVector *mv)
131 {
132     int x, y;
133     int diff;
134     int smallest = INT_MAX;
135     int tmp, tmp2;
136
137     #define CMP(i, j) deshake->c.sad[0](deshake, src1 + cy * stride + cx, \
138                                         src2 + (j) * stride + (i), stride, \
139                                         deshake->blocksize)
140
141     if (deshake->search == EXHAUSTIVE) {
142         // Compare every possible position - this is sloooow!
143         for (y = -deshake->ry; y <= deshake->ry; y++) {
144             for (x = -deshake->rx; x <= deshake->rx; x++) {
145                 diff = CMP(cx - x, cy - y);
146                 if (diff < smallest) {
147                     smallest = diff;
148                     mv->x = x;
149                     mv->y = y;
150                 }
151             }
152         }
153     } else if (deshake->search == SMART_EXHAUSTIVE) {
154         // Compare every other possible position and find the best match
155         for (y = -deshake->ry + 1; y < deshake->ry - 2; y += 2) {
156             for (x = -deshake->rx + 1; x < deshake->rx - 2; x += 2) {
157                 diff = CMP(cx - x, cy - y);
158                 if (diff < smallest) {
159                     smallest = diff;
160                     mv->x = x;
161                     mv->y = y;
162                 }
163             }
164         }
165
166         // Hone in on the specific best match around the match we found above
167         tmp = mv->x;
168         tmp2 = mv->y;
169
170         for (y = tmp2 - 1; y <= tmp2 + 1; y++) {
171             for (x = tmp - 1; x <= tmp + 1; x++) {
172                 if (x == tmp && y == tmp2)
173                     continue;
174
175                 diff = CMP(cx - x, cy - y);
176                 if (diff < smallest) {
177                     smallest = diff;
178                     mv->x = x;
179                     mv->y = y;
180                 }
181             }
182         }
183     }
184
185     if (smallest > 512) {
186         mv->x = -1;
187         mv->y = -1;
188     }
189     emms_c();
190     //av_log(NULL, AV_LOG_ERROR, "%d\n", smallest);
191     //av_log(NULL, AV_LOG_ERROR, "Final: (%d, %d) = %d x %d\n", cx, cy, mv->x, mv->y);
192 }
193
194 /**
195  * Find the contrast of a given block. When searching for global motion we
196  * really only care about the high contrast blocks, so using this method we
197  * can actually skip blocks we don't care much about.
198  */
199 static int block_contrast(uint8_t *src, int x, int y, int stride, int blocksize)
200 {
201     int highest = 0;
202     int lowest = 0;
203     int i, j, pos;
204
205     for (i = 0; i <= blocksize * 2; i++) {
206         // We use a width of 16 here to match the libavcodec sad functions
207         for (j = 0; i <= 15; i++) {
208             pos = (y - i) * stride + (x - j);
209             if (src[pos] < lowest)
210                 lowest = src[pos];
211             else if (src[pos] > highest) {
212                 highest = src[pos];
213             }
214         }
215     }
216
217     return highest - lowest;
218 }
219
220 /**
221  * Find the rotation for a given block.
222  */
223 static double block_angle(int x, int y, int cx, int cy, MotionVector *shift)
224 {
225     double a1, a2, diff;
226
227     a1 = atan2(y - cy, x - cx);
228     a2 = atan2(y - cy + shift->y, x - cx + shift->x);
229
230     diff = a2 - a1;
231
232     return (diff > M_PI)  ? diff - 2 * M_PI :
233            (diff < -M_PI) ? diff + 2 * M_PI :
234            diff;
235 }
236
237 /**
238  * Find the estimated global motion for a scene given the most likely shift
239  * for each block in the frame. The global motion is estimated to be the
240  * same as the motion from most blocks in the frame, so if most blocks
241  * move one pixel to the right and two pixels down, this would yield a
242  * motion vector (1, -2).
243  */
244 static void find_motion(DeshakeContext *deshake, uint8_t *src1, uint8_t *src2,
245                         int width, int height, int stride, Transform *t)
246 {
247     int x, y;
248     MotionVector mv = {0, 0};
249     int counts[128][128];
250     int count_max_value = 0;
251     int contrast;
252
253     int pos;
254     double *angles = av_malloc(sizeof(*angles) * width * height / (16 * deshake->blocksize));
255     double totalangles = 0;
256
257     int center_x = 0, center_y = 0;
258     double p_x, p_y;
259
260     // Reset counts to zero
261     for (x = 0; x < deshake->rx * 2 + 1; x++) {
262         for (y = 0; y < deshake->ry * 2 + 1; y++) {
263             counts[x][y] = 0;
264         }
265     }
266
267     pos = 0;
268     // Find motion for every block and store the motion vector in the counts
269     for (y = deshake->ry; y < height - deshake->ry - (deshake->blocksize * 2); y += deshake->blocksize * 2) {
270         // We use a width of 16 here to match the libavcodec sad functions
271         for (x = deshake->rx; x < width - deshake->rx - 16; x += 16) {
272             // If the contrast is too low, just skip this block as it probably
273             // won't be very useful to us.
274             contrast = block_contrast(src2, x, y, stride, deshake->blocksize);
275             if (contrast > deshake->contrast) {
276                 //av_log(NULL, AV_LOG_ERROR, "%d\n", contrast);
277                 find_block_motion(deshake, src1, src2, x, y, stride, &mv);
278                 if (mv.x != -1 && mv.y != -1) {
279                     counts[(int)(mv.x + deshake->rx)][(int)(mv.y + deshake->ry)] += 1;
280                     if (x > deshake->rx && y > deshake->ry)
281                         angles[pos++] = block_angle(x, y, 0, 0, &mv);
282
283                     center_x += mv.x;
284                     center_y += mv.y;
285                 }
286             }
287         }
288     }
289
290     pos = FFMAX(1, pos);
291
292     center_x /= pos;
293     center_y /= pos;
294
295     for (x = 0; x < pos; x++) {
296         totalangles += angles[x];
297     }
298
299     //av_log(NULL, AV_LOG_ERROR, "Angle: %lf\n", totalangles / (pos - 1));
300     t->angle = totalangles / (pos - 1);
301
302     t->angle = clean_mean(angles, pos);
303     if (t->angle < 0.001)
304         t->angle = 0;
305
306     // Find the most common motion vector in the frame and use it as the gmv
307     for (y = deshake->ry * 2; y >= 0; y--) {
308         for (x = 0; x < deshake->rx * 2 + 1; x++) {
309             //av_log(NULL, AV_LOG_ERROR, "%5d ", counts[x][y]);
310             if (counts[x][y] > count_max_value) {
311                 t->vector.x = x - deshake->rx;
312                 t->vector.y = y - deshake->ry;
313                 count_max_value = counts[x][y];
314             }
315         }
316         //av_log(NULL, AV_LOG_ERROR, "\n");
317     }
318
319     p_x = (center_x - width / 2);
320     p_y = (center_y - height / 2);
321     t->vector.x += (cos(t->angle)-1)*p_x  - sin(t->angle)*p_y;
322     t->vector.y += sin(t->angle)*p_x  + (cos(t->angle)-1)*p_y;
323
324     // Clamp max shift & rotation?
325     t->vector.x = av_clipf(t->vector.x, -deshake->rx * 2, deshake->rx * 2);
326     t->vector.y = av_clipf(t->vector.y, -deshake->ry * 2, deshake->ry * 2);
327     t->angle = av_clipf(t->angle, -0.1, 0.1);
328
329     //av_log(NULL, AV_LOG_ERROR, "%d x %d\n", avg->x, avg->y);
330     av_free(angles);
331 }
332
333 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)
334 {
335     DeshakeContext *deshake = ctx->priv;
336     char filename[256] = {0};
337
338     deshake->rx = 16;
339     deshake->ry = 16;
340     deshake->edge = FILL_MIRROR;
341     deshake->blocksize = 8;
342     deshake->contrast = 125;
343     deshake->search = EXHAUSTIVE;
344     deshake->refcount = 20;
345
346     if (args) {
347         sscanf(args, "%d:%d:%d:%d:%d:%d:%255s", &deshake->rx, &deshake->ry, (int *)&deshake->edge,
348                &deshake->blocksize, &deshake->contrast, (int *)&deshake->search, filename);
349
350         deshake->blocksize /= 2;
351
352         deshake->rx = av_clip(deshake->rx, 0, 64);
353         deshake->ry = av_clip(deshake->ry, 0, 64);
354         deshake->edge = av_clip(deshake->edge, FILL_BLANK, FILL_COUNT - 1);
355         deshake->blocksize = av_clip(deshake->blocksize, 4, 128);
356         deshake->contrast = av_clip(deshake->contrast, 1, 255);
357         deshake->search = av_clip(deshake->search, EXHAUSTIVE, SEARCH_COUNT - 1);
358     }
359     if (*filename)
360         deshake->fp = fopen(filename, "w");
361     if (deshake->fp)
362         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);
363
364     av_log(ctx, AV_LOG_INFO, "rx: %d, ry: %d, edge: %d blocksize: %d contrast: %d search: %d\n",
365            deshake->rx, deshake->ry, deshake->edge, deshake->blocksize * 2, deshake->contrast, deshake->search);
366
367     return 0;
368 }
369
370 static int query_formats(AVFilterContext *ctx)
371 {
372     enum PixelFormat pix_fmts[] = {
373         PIX_FMT_YUV420P,  PIX_FMT_YUV422P,  PIX_FMT_YUV444P,  PIX_FMT_YUV410P,
374         PIX_FMT_YUV411P,  PIX_FMT_YUV440P,  PIX_FMT_YUVJ420P, PIX_FMT_YUVJ422P,
375         PIX_FMT_YUVJ444P, PIX_FMT_YUVJ440P, PIX_FMT_NONE
376     };
377
378     avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
379
380     return 0;
381 }
382
383 static int config_props(AVFilterLink *link)
384 {
385     DeshakeContext *deshake = link->dst->priv;
386
387     deshake->ref = NULL;
388     deshake->last.vector.x = 0;
389     deshake->last.vector.y = 0;
390     deshake->last.angle = 0;
391     deshake->last.zoom = 0;
392
393     deshake->avctx = avcodec_alloc_context3(NULL);
394     dsputil_init(&deshake->c, deshake->avctx);
395
396     return 0;
397 }
398
399 static av_cold void uninit(AVFilterContext *ctx)
400 {
401     DeshakeContext *deshake = ctx->priv;
402
403     avfilter_unref_buffer(deshake->ref);
404     if (deshake->fp)
405         fclose(deshake->fp);
406 }
407
408 static void end_frame(AVFilterLink *link)
409 {
410     DeshakeContext *deshake = link->dst->priv;
411     AVFilterBufferRef *in  = link->cur_buf;
412     AVFilterBufferRef *out = link->dst->outputs[0]->out_buf;
413     Transform t;
414     float matrix[9];
415     float alpha = 2.0 / deshake->refcount;
416     char tmp[256];
417     Transform orig;
418
419     // Find the most likely global motion for the current frame
420     find_motion(deshake, (deshake->ref == NULL) ? in->data[0] : deshake->ref->data[0], in->data[0], link->w, link->h, in->linesize[0], &t);
421
422     // Copy transform so we can output it later to compare to the smoothed value
423     orig.vector.x = t.vector.x;
424     orig.vector.y = t.vector.y;
425     orig.angle = t.angle;
426     orig.zoom = t.zoom;
427
428     // Generate a one-sided moving exponential average
429     deshake->avg.vector.x = alpha * t.vector.x + (1.0 - alpha) * deshake->avg.vector.x;
430     deshake->avg.vector.y = alpha * t.vector.y + (1.0 - alpha) * deshake->avg.vector.y;
431     deshake->avg.angle = alpha * t.angle + (1.0 - alpha) * deshake->avg.angle;
432     deshake->avg.zoom = alpha * t.zoom + (1.0 - alpha) * deshake->avg.zoom;
433
434     // Remove the average from the current motion to detect the motion that
435     // is not on purpose, just as jitter from bumping the camera
436     t.vector.x -= deshake->avg.vector.x;
437     t.vector.y -= deshake->avg.vector.y;
438     t.angle -= deshake->avg.angle;
439     t.zoom -= deshake->avg.zoom;
440
441     // Invert the motion to undo it
442     t.vector.x *= -1;
443     t.vector.y *= -1;
444     t.angle *= -1;
445
446     // Write statistics to file
447     if (deshake->fp) {
448         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);
449         fwrite(tmp, sizeof(char), strlen(tmp), deshake->fp);
450     }
451
452     // Turn relative current frame motion into absolute by adding it to the
453     // last absolute motion
454     t.vector.x += deshake->last.vector.x;
455     t.vector.y += deshake->last.vector.y;
456     t.angle += deshake->last.angle;
457     t.zoom += deshake->last.zoom;
458
459     // Shrink motion by 10% to keep things centered in the camera frame
460     t.vector.x *= 0.9;
461     t.vector.y *= 0.9;
462     t.angle *= 0.9;
463
464     // Store the last absolute motion information
465     deshake->last.vector.x = t.vector.x;
466     deshake->last.vector.y = t.vector.y;
467     deshake->last.angle = t.angle;
468     deshake->last.zoom = t.zoom;
469
470     // Generate a luma transformation matrix
471     avfilter_get_matrix(t.vector.x, t.vector.y, t.angle, 1.0 + t.zoom / 100.0, matrix);
472
473     // Transform the luma plane
474     avfilter_transform(in->data[0], out->data[0], in->linesize[0], out->linesize[0], link->w, link->h, matrix, INTERPOLATE_BILINEAR, deshake->edge);
475
476     // Generate a chroma transformation matrix
477     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);
478
479     // Transform the chroma planes
480     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);
481     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);
482
483     // Store the current frame as the reference frame for calculating the
484     // motion of the next frame
485     if (deshake->ref != NULL)
486         avfilter_unref_buffer(deshake->ref);
487
488     // Cleanup the old reference frame
489     deshake->ref = in;
490
491     // Draw the transformed frame information
492     avfilter_draw_slice(link->dst->outputs[0], 0, link->h, 1);
493     avfilter_end_frame(link->dst->outputs[0]);
494     avfilter_unref_buffer(out);
495 }
496
497 static void draw_slice(AVFilterLink *link, int y, int h, int slice_dir)
498 {
499 }
500
501 AVFilter avfilter_vf_deshake = {
502     .name      = "deshake",
503     .description = NULL_IF_CONFIG_SMALL("Stabilize shaky video."),
504
505     .priv_size = sizeof(DeshakeContext),
506
507     .init = init,
508     .uninit = uninit,
509     .query_formats = query_formats,
510
511     .inputs    = (AVFilterPad[]) {{ .name             = "default",
512                                     .type             = AVMEDIA_TYPE_VIDEO,
513                                     .draw_slice       = draw_slice,
514                                     .end_frame        = end_frame,
515                                     .config_props     = config_props,
516                                     .min_perms        = AV_PERM_READ, },
517                                   { .name = NULL}},
518
519     .outputs   = (AVFilterPad[]) {{ .name             = "default",
520                                     .type             = AVMEDIA_TYPE_VIDEO, },
521                                   { .name = NULL}},
522 };