lavfi: add video stabilization plugins using vid.stab library
[ffmpeg.git] / libavfilter / vf_vidstabdetect.c
1 /*
2  * Copyright (c) 2013 Georg Martius <georg dot martius at web dot de>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #define DEFAULT_RESULT_NAME     "transforms.trf"
22
23 #include <vid.stab/libvidstab.h>
24
25 #include "libavutil/common.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/imgutils.h"
28 #include "avfilter.h"
29 #include "internal.h"
30
31 #include "vidstabutils.h"
32
33 typedef struct {
34     const AVClass* class;
35
36     VSMotionDetect md;
37     VSMotionDetectConfig conf;
38
39     char* result;
40     FILE* f;
41 } StabData;
42
43
44 #define OFFSET(x) offsetof(StabData, x)
45 #define OFFSETC(x) (offsetof(StabData, conf)+offsetof(VSMotionDetectConfig, x))
46 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
47
48 static const AVOption vidstabdetect_options[]= {
49     {"result",      "path to the file used to write the transforms (def:transforms.trf)", OFFSET(result),              AV_OPT_TYPE_STRING, {.str = DEFAULT_RESULT_NAME}},
50     {"shakiness",   "how shaky is the video and how quick is the camera?"
51                     " 1: little (fast) 10: very strong/quick (slow) (def: 5)",            OFFSETC(shakiness),         AV_OPT_TYPE_INT,    {.i64 = 5},  1, 10,       FLAGS},
52     {"accuracy",    "(>=shakiness) 1: low 15: high (slow) (def: 9)",                      OFFSETC(accuracy),          AV_OPT_TYPE_INT,    {.i64 = 9 }, 1, 15,       FLAGS},
53     {"stepsize",    "region around minimum is scanned with 1 pixel resolution (def: 6)",  OFFSETC(stepSize),          AV_OPT_TYPE_INT,    {.i64 = 6},  1, 32,       FLAGS},
54     {"mincontrast", "below this contrast a field is discarded (0-1) (def: 0.3)",          OFFSETC(contrastThreshold), AV_OPT_TYPE_DOUBLE, {.dbl =  0.25}, 0.0, 1.0, FLAGS},
55     {"show",        "0: draw nothing (def); 1,2: show fields and transforms",             OFFSETC(show),              AV_OPT_TYPE_INT,    {.i64 =  0}, 0, 2,        FLAGS},
56     {"tripod",      "virtual tripod mode (if >0): motion is compared to a reference"
57                     " reference frame (frame # is the value) (def: 0)",                   OFFSETC(virtualTripod),     AV_OPT_TYPE_INT,    {.i64 = 0},  0, INT_MAX,  FLAGS},
58     {NULL},
59 };
60
61 AVFILTER_DEFINE_CLASS(vidstabdetect);
62
63 static av_cold int init(AVFilterContext *ctx)
64 {
65     StabData* sd = ctx->priv;
66     vs_set_mem_and_log_functions();
67     sd->class = &vidstabdetect_class;
68     av_log(ctx, AV_LOG_VERBOSE, "vidstabdetect filter: init %s\n", LIBVIDSTAB_VERSION);
69     return 0;
70 }
71
72 static av_cold void uninit(AVFilterContext *ctx)
73 {
74     StabData *sd = ctx->priv;
75     VSMotionDetect* md = &(sd->md);
76
77     if (sd->f) {
78         fclose(sd->f);
79         sd->f = NULL;
80     }
81
82     vsMotionDetectionCleanup(md);
83
84 }
85
86 static int query_formats(AVFilterContext *ctx)
87 {
88     // If you add something here also add it in vidstabutils.c
89     static const enum AVPixelFormat pix_fmts[] = {
90         AV_PIX_FMT_YUV444P,  AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV420P,
91         AV_PIX_FMT_YUV411P,  AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUVA420P,
92         AV_PIX_FMT_YUV440P,  AV_PIX_FMT_GRAY8,
93         AV_PIX_FMT_RGB24, AV_PIX_FMT_BGR24, AV_PIX_FMT_RGBA,
94         AV_PIX_FMT_NONE
95     };
96
97     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
98     return 0;
99 }
100
101
102 static int config_input(AVFilterLink *inlink)
103 {
104     AVFilterContext *ctx = inlink->dst;
105     StabData *sd = ctx->priv;
106
107     VSMotionDetect* md = &(sd->md);
108     VSFrameInfo fi;
109     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
110
111     vsFrameInfoInit(&fi,inlink->w, inlink->h, av_2_vs_pixel_format(ctx, inlink->format));
112     if(fi.bytesPerPixel != av_get_bits_per_pixel(desc)/8){
113         av_log(ctx, AV_LOG_ERROR, "pixel-format error: wrong bits/per/pixel, please report a BUG");
114         return AVERROR(EINVAL);
115     }
116     if(fi.log2ChromaW != desc->log2_chroma_w){
117         av_log(ctx, AV_LOG_ERROR, "pixel-format error: log2_chroma_w, please report a BUG");
118         return AVERROR(EINVAL);
119     }
120
121     if(fi.log2ChromaH != desc->log2_chroma_h){
122         av_log(ctx, AV_LOG_ERROR, "pixel-format error: log2_chroma_h, please report a BUG");
123         return AVERROR(EINVAL);
124     }
125
126     // set values that are not initializes by the options
127     sd->conf.algo     = 1;
128     sd->conf.modName  = "vidstabdetect";
129     if(vsMotionDetectInit(md, &sd->conf, &fi) != VS_OK){
130         av_log(ctx, AV_LOG_ERROR, "initialization of Motion Detection failed, please report a BUG");
131         return AVERROR(EINVAL);
132     }
133
134     vsMotionDetectGetConfig(&sd->conf, md);
135     av_log(ctx, AV_LOG_INFO, "Video stabilization settings (pass 1/2):\n");
136     av_log(ctx, AV_LOG_INFO, "     shakiness = %d\n", sd->conf.shakiness);
137     av_log(ctx, AV_LOG_INFO, "      accuracy = %d\n", sd->conf.accuracy);
138     av_log(ctx, AV_LOG_INFO, "      stepsize = %d\n", sd->conf.stepSize);
139     av_log(ctx, AV_LOG_INFO, "   mincontrast = %f\n", sd->conf.contrastThreshold);
140     av_log(ctx, AV_LOG_INFO, "          show = %d\n", sd->conf.show);
141     av_log(ctx, AV_LOG_INFO, "        result = %s\n", sd->result);
142
143     sd->f = fopen(sd->result, "w");
144     if (sd->f == NULL) {
145         av_log(ctx, AV_LOG_ERROR, "cannot open transform file %s\n", sd->result);
146         return AVERROR(EINVAL);
147     }else{
148         if(vsPrepareFile(md, sd->f) != VS_OK){
149             av_log(ctx, AV_LOG_ERROR, "cannot write to transform file %s\n", sd->result);
150             return AVERROR(EINVAL);
151         }
152     }
153     return 0;
154 }
155
156
157 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
158 {
159     AVFilterContext *ctx = inlink->dst;
160     StabData *sd = ctx->priv;
161     VSMotionDetect* md = &(sd->md);
162     LocalMotions localmotions;
163
164     AVFilterLink *outlink = inlink->dst->outputs[0];
165     int direct = 0;
166     AVFrame *out;
167     VSFrame frame;
168     int plane;
169
170     if (av_frame_is_writable(in)) {
171         direct = 1;
172         out = in;
173     } else {
174         out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
175         if (!out) {
176             av_frame_free(&in);
177             return AVERROR(ENOMEM);
178         }
179         av_frame_copy_props(out, in);
180     }
181
182     for(plane=0; plane < md->fi.planes; plane++){
183         frame.data[plane] = in->data[plane];
184         frame.linesize[plane] = in->linesize[plane];
185     }
186     if(vsMotionDetection(md, &localmotions, &frame) !=  VS_OK){
187         av_log(ctx, AV_LOG_ERROR, "motion detection failed");
188         return AVERROR(AVERROR_EXTERNAL);
189     } else {
190         if(vsWriteToFile(md, sd->f, &localmotions) != VS_OK){
191             av_log(ctx, AV_LOG_ERROR, "cannot write to transform file");
192             return AVERROR(errno);
193         }
194         vs_vector_del(&localmotions);
195     }
196     if(sd->conf.show>0 && !direct){
197         av_image_copy(out->data, out->linesize,
198                       (void*)in->data, in->linesize,
199                       in->format, in->width, in->height);
200     }
201
202     if (!direct)
203         av_frame_free(&in);
204
205     return ff_filter_frame(outlink, out);
206 }
207
208 static const AVFilterPad avfilter_vf_vidstabdetect_inputs[] = {
209     {
210         .name             = "default",
211         .type             = AVMEDIA_TYPE_VIDEO,
212         .filter_frame     = filter_frame,
213         .config_props     = config_input,
214     },
215     { NULL }
216 };
217
218 static const AVFilterPad avfilter_vf_vidstabdetect_outputs[] = {
219     {
220         .name             = "default",
221         .type             = AVMEDIA_TYPE_VIDEO,
222     },
223     { NULL }
224 };
225
226 AVFilter avfilter_vf_vidstabdetect = {
227     .name          = "vidstabdetect",
228     .description   = NULL_IF_CONFIG_SMALL("pass 1 of 2 for stabilization"
229                                           "extracts relative transformations"
230                                           "(pass 2 see vidstabtransform)"),
231     .priv_size     = sizeof(StabData),
232     .init          = init,
233     .uninit        = uninit,
234     .query_formats = query_formats,
235
236     .inputs        = avfilter_vf_vidstabdetect_inputs,
237     .outputs       = avfilter_vf_vidstabdetect_outputs,
238     .priv_class    = &vidstabdetect_class,
239 };