FFmpeg  2.1.1
vf_vidstabdetect.c
Go to the documentation of this file.
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", OFFSET(result), AV_OPT_TYPE_STRING, {.str = DEFAULT_RESULT_NAME}, .flags = FLAGS},
50  {"shakiness", "how shaky is the video and how quick is the camera?"
51  " 1: little (fast) 10: very strong/quick (slow)", OFFSETC(shakiness), AV_OPT_TYPE_INT, {.i64 = 5}, 1, 10, FLAGS},
52  {"accuracy", "(>=shakiness) 1: low 15: high (slow)", OFFSETC(accuracy), AV_OPT_TYPE_INT, {.i64 = 9}, 1, 15, FLAGS},
53  {"stepsize", "region around minimum is scanned with 1 pixel resolution", OFFSETC(stepSize), AV_OPT_TYPE_INT, {.i64 = 6}, 1, 32, FLAGS},
54  {"mincontrast", "below this contrast a field is discarded (0-1)", OFFSETC(contrastThreshold), AV_OPT_TYPE_DOUBLE, {.dbl = 0.25}, 0.0, 1.0, FLAGS},
55  {"show", "0: draw nothing; 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)", 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;
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 
86 {
87  // If you add something here also add it in vidstabutils.c
88  static const enum AVPixelFormat pix_fmts[] = {
94  };
95 
97  return 0;
98 }
99 
100 static int config_input(AVFilterLink *inlink)
101 {
102  AVFilterContext *ctx = inlink->dst;
103  StabData *sd = ctx->priv;
104 
105  VSMotionDetect* md = &(sd->md);
106  VSFrameInfo fi;
107  const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
108 
109  vsFrameInfoInit(&fi, inlink->w, inlink->h, av_2_vs_pixel_format(ctx, inlink->format));
110  if (fi.bytesPerPixel != av_get_bits_per_pixel(desc)/8) {
111  av_log(ctx, AV_LOG_ERROR, "pixel-format error: wrong bits/per/pixel, please report a BUG");
112  return AVERROR(EINVAL);
113  }
114  if (fi.log2ChromaW != desc->log2_chroma_w) {
115  av_log(ctx, AV_LOG_ERROR, "pixel-format error: log2_chroma_w, please report a BUG");
116  return AVERROR(EINVAL);
117  }
118 
119  if (fi.log2ChromaH != desc->log2_chroma_h) {
120  av_log(ctx, AV_LOG_ERROR, "pixel-format error: log2_chroma_h, please report a BUG");
121  return AVERROR(EINVAL);
122  }
123 
124  // set values that are not initialized by the options
125  sd->conf.algo = 1;
126  sd->conf.modName = "vidstabdetect";
127  if (vsMotionDetectInit(md, &sd->conf, &fi) != VS_OK) {
128  av_log(ctx, AV_LOG_ERROR, "initialization of Motion Detection failed, please report a BUG");
129  return AVERROR(EINVAL);
130  }
131 
132  vsMotionDetectGetConfig(&sd->conf, md);
133  av_log(ctx, AV_LOG_INFO, "Video stabilization settings (pass 1/2):\n");
134  av_log(ctx, AV_LOG_INFO, " shakiness = %d\n", sd->conf.shakiness);
135  av_log(ctx, AV_LOG_INFO, " accuracy = %d\n", sd->conf.accuracy);
136  av_log(ctx, AV_LOG_INFO, " stepsize = %d\n", sd->conf.stepSize);
137  av_log(ctx, AV_LOG_INFO, " mincontrast = %f\n", sd->conf.contrastThreshold);
138  av_log(ctx, AV_LOG_INFO, " show = %d\n", sd->conf.show);
139  av_log(ctx, AV_LOG_INFO, " result = %s\n", sd->result);
140 
141  sd->f = fopen(sd->result, "w");
142  if (sd->f == NULL) {
143  av_log(ctx, AV_LOG_ERROR, "cannot open transform file %s\n", sd->result);
144  return AVERROR(EINVAL);
145  } else {
146  if (vsPrepareFile(md, sd->f) != VS_OK) {
147  av_log(ctx, AV_LOG_ERROR, "cannot write to transform file %s\n", sd->result);
148  return AVERROR(EINVAL);
149  }
150  }
151  return 0;
152 }
153 
154 
155 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
156 {
157  AVFilterContext *ctx = inlink->dst;
158  StabData *sd = ctx->priv;
159  VSMotionDetect *md = &(sd->md);
160  LocalMotions localmotions;
161 
162  AVFilterLink *outlink = inlink->dst->outputs[0];
163  VSFrame frame;
164  int plane;
165 
166  if (sd->conf.show > 0 && !av_frame_is_writable(in))
168 
169  for (plane = 0; plane < md->fi.planes; plane++) {
170  frame.data[plane] = in->data[plane];
171  frame.linesize[plane] = in->linesize[plane];
172  }
173  if (vsMotionDetection(md, &localmotions, &frame) != VS_OK) {
174  av_log(ctx, AV_LOG_ERROR, "motion detection failed");
175  return AVERROR(AVERROR_EXTERNAL);
176  } else {
177  if (vsWriteToFile(md, sd->f, &localmotions) != VS_OK) {
178  av_log(ctx, AV_LOG_ERROR, "cannot write to transform file");
179  return AVERROR(errno);
180  }
181  vs_vector_del(&localmotions);
182  }
183 
184  return ff_filter_frame(outlink, in);
185 }
186 
188  {
189  .name = "default",
190  .type = AVMEDIA_TYPE_VIDEO,
191  .filter_frame = filter_frame,
192  .config_props = config_input,
193  },
194  { NULL }
195 };
196 
198  {
199  .name = "default",
200  .type = AVMEDIA_TYPE_VIDEO,
201  },
202  { NULL }
203 };
204 
206  .name = "vidstabdetect",
207  .description = NULL_IF_CONFIG_SMALL("Extract relative transformations, "
208  "pass 1 of 2 for stabilization "
209  "(see vidstabtransform for pass 2)."),
210  .priv_size = sizeof(StabData),
211  .init = init,
212  .uninit = uninit,
214  .inputs = avfilter_vf_vidstabdetect_inputs,
215  .outputs = avfilter_vf_vidstabdetect_outputs,
216  .priv_class = &vidstabdetect_class,
217 };
static av_cold int init(AVFilterContext *ctx)
#define AVERROR_EXTERNAL
This structure describes decoded (raw) audio or video data.
Definition: frame.h:96
AVOption.
Definition: opt.h:253
const char * name
Filter name.
Definition: avfilter.h:468
AVFilter avfilter_vf_vidstabdetect
void * priv
private data for use by the filter
Definition: avfilter.h:648
static const AVFilterPad outputs[]
Definition: af_ashowinfo.c:111
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: avcodec.h:4536
planar YUV 4:2:2, 16bpp, (1 Cr &amp; Cb sample per 2x1 Y samples)
Definition: avcodec.h:4538
void av_log(void *avcl, int level, const char *fmt,...) av_printf_format(3
Send the specified message to the log if the level is less than or equal to the current av_log_level...
Pixel format.
Definition: avcodec.h:4533
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
Definition: frame.c:382
#define av_cold
Definition: avcodec.h:653
static int query_formats(AVFilterContext *ctx)
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:68
Y , 8bpp.
Definition: avcodec.h:4542
AVFilterFormats * ff_make_format_list(const int *fmts)
Create a list of supported formats.
Definition: formats.c:294
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: avcodec.h:4537
const char * name
Pad name.
Definition: internal.h:66
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1118
static const AVOption vidstabdetect_options[]
#define FLAGS
static int config_input(AVFilterLink *inlink)
VSPixelFormat av_2_vs_pixel_format(AVFilterContext *ctx, enum AVPixelFormat pf)
convert AV&#39;s pixelformat to vid.stab pixelformat
Definition: vidstabutils.c:24
#define AV_LOG_VERBOSE
Detailed information.
Definition: avcodec.h:4163
planar YUV 4:2:0, 20bpp, (1 Cr &amp; Cb sample per 2x2 Y &amp; A samples)
Definition: avcodec.h:4571
void ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:531
void vs_set_mem_and_log_functions(void)
sets the memory allocation function and logging constants to av versions
Definition: vidstabutils.c:69
static const AVFilterPad avfilter_vf_vidstabdetect_outputs[]
static AVFrame * frame
Definition: demuxing.c:51
A filter pad used for either input or output.
Definition: internal.h:60
AVS_FilterInfo ** fi
Definition: avisynth_c.h:635
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: avcodec.h:4147
uint8_t pi<< 24) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_U8, uint8_t,(*(constuint8_t *) pi-0x80)*(1.0f/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_U8, uint8_t,(*(constuint8_t *) pi-0x80)*(1.0/(1<< 7))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S16, int16_t,(*(constint16_t *) pi >>8)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S16, int16_t,*(constint16_t *) pi *(1.0f/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S16, int16_t,*(constint16_t *) pi *(1.0/(1<< 15))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_S32, int32_t,(*(constint32_t *) pi >>24)+0x80) CONV_FUNC_GROUP(AV_SAMPLE_FMT_FLT, float, AV_SAMPLE_FMT_S32, int32_t,*(constint32_t *) pi *(1.0f/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_DBL, double, AV_SAMPLE_FMT_S32, int32_t,*(constint32_t *) pi *(1.0/(1U<< 31))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_FLT, float, av_clip_uint8(lrintf(*(constfloat *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_FLT, float, av_clip_int16(lrintf(*(constfloat *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_FLT, float, av_clipl_int32(llrintf(*(constfloat *) pi *(1U<< 31)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_U8, uint8_t, AV_SAMPLE_FMT_DBL, double, av_clip_uint8(lrint(*(constdouble *) pi *(1<< 7))+0x80)) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S16, int16_t, AV_SAMPLE_FMT_DBL, double, av_clip_int16(lrint(*(constdouble *) pi *(1<< 15)))) CONV_FUNC_GROUP(AV_SAMPLE_FMT_S32, int32_t, AV_SAMPLE_FMT_DBL, double, av_clipl_int32(llrint(*(constdouble *) pi *(1U<< 31))))#defineSET_CONV_FUNC_GROUP(ofmt, ifmt) staticvoidset_generic_function(AudioConvert *ac){}voidff_audio_convert_free(AudioConvert **ac){return;ff_dither_free(&(*ac) ->dc);av_freep(ac);}AudioConvert *ff_audio_convert_alloc(AVAudioResampleContext *avr, enumAVSampleFormatout_fmt, enumAVSampleFormatin_fmt, intchannels, intsample_rate, intapply_map){AudioConvert *ac;intin_planar, out_planar;ac=av_mallocz(sizeof(*ac));returnNULL;ac->avr=avr;ac->out_fmt=out_fmt;ac->in_fmt=in_fmt;ac->channels=channels;ac->apply_map=apply_map;if(avr->dither_method!=AV_RESAMPLE_DITHER_NONE &&av_get_packed_sample_fmt(out_fmt)==AV_SAMPLE_FMT_S16 &&av_get_bytes_per_sample(in_fmt)>2){ac->dc=ff_dither_alloc(avr, out_fmt, in_fmt, channels, sample_rate, apply_map);if(!ac->dc){av_free(ac);returnNULL;}returnac;}in_planar=av_sample_fmt_is_planar(in_fmt);out_planar=av_sample_fmt_is_planar(out_fmt);if(in_planar==out_planar){ac->func_type=CONV_FUNC_TYPE_FLAT;ac->planes=in_planar?ac->channels:1;}elseif(in_planar) ac->func_type=CONV_FUNC_TYPE_INTERLEAVE;elseac->func_type=CONV_FUNC_TYPE_DEINTERLEAVE;set_generic_function(ac);ff_audio_convert_init_arm(ac);ff_audio_convert_init_x86(ac);returnac;}intff_audio_convert(AudioConvert *ac, AudioData *out, AudioData *in){intuse_generic=1;intlen=in->nb_samples;intp;if(ac->dc){av_dlog(ac->avr,"%dsamples-audio_convert:%sto%s(dithered)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt));returnff_convert_dither(ac-> in
#define OFFSET(x)
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:77
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:151
planar YUV 4:1:1, 12bpp, (1 Cr &amp; Cb sample per 4x1 Y samples)
Definition: avcodec.h:4541
AVPixelFormat
Pixel format.
Definition: pixfmt.h:66
VSMotionDetect md
int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc)
Return the number of bits per pixel used by the pixel format described by pixdesc.
Definition: pixdesc.c:1891
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
Definition: frame.c:399
const AVClass * class
#define md
Main libavfilter public API header.
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:1938
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:642
planar YUV 4:2:0, 12bpp, (1 Cr &amp; Cb sample per 2x2 Y samples)
Definition: avcodec.h:4534
planar YUV 4:4:0 (1 Cr &amp; Cb sample per 1x2 Y samples)
Definition: avcodec.h:4569
#define AV_LOG_INFO
Standard information.
Definition: avcodec.h:4158
static const AVFilterPad avfilter_vf_vidstabdetect_inputs[]
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:57
#define DEFAULT_RESULT_NAME
Describe the class of an AVClass context structure.
Definition: log.h:50
Filter definition.
Definition: avfilter.h:464
static const AVFilterPad inputs[]
Definition: af_ashowinfo.c:102
planar YUV 4:4:4, 24bpp, (1 Cr &amp; Cb sample per 1x1 Y samples)
Definition: avcodec.h:4539
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:124
VSMotionDetectConfig conf
static int filter_frame(AVFilterLink *inlink, AVFrame *in)
#define OFFSETC(x)
char * result
static av_cold void uninit(AVFilterContext *ctx)
#define AVFILTER_DEFINE_CLASS(fname)
Definition: internal.h:301
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: avcodec.h:4563
#define AVERROR(e)
An instance of a filter.
Definition: avfilter.h:627
internal API functions
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:107
planar YUV 4:1:0, 9bpp, (1 Cr &amp; Cb sample per 4x4 Y samples)
Definition: avcodec.h:4540