FFmpeg  4.3
vf_freezeframes.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Paul B Mahol
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 #include "libavutil/avassert.h"
22 #include "libavutil/avstring.h"
23 #include "libavutil/common.h"
24 #include "libavutil/internal.h"
25 #include "libavutil/opt.h"
26 
27 #include "avfilter.h"
28 #include "filters.h"
29 #include "internal.h"
30 #include "video.h"
31 
32 typedef struct FreezeFramesContext {
33  const AVClass *class;
34  int64_t first, last, replace;
35 
38 
39 #define OFFSET(x) offsetof(FreezeFramesContext, x)
40 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
41 
42 static const AVOption freezeframes_options[] = {
43  { "first", "set first frame to freeze", OFFSET(first), AV_OPT_TYPE_INT64, {.i64=0}, 0, INT64_MAX, FLAGS },
44  { "last", "set last frame to freeze", OFFSET(last), AV_OPT_TYPE_INT64, {.i64=0}, 0, INT64_MAX, FLAGS },
45  { "replace", "set frame to replace", OFFSET(replace), AV_OPT_TYPE_INT64, {.i64=0}, 0, INT64_MAX, FLAGS },
46  { NULL },
47 };
48 
49 AVFILTER_DEFINE_CLASS(freezeframes);
50 
51 static int config_output(AVFilterLink *outlink)
52 {
53  AVFilterContext *ctx = outlink->src;
54  AVFilterLink *sourcelink = ctx->inputs[0];
55  AVFilterLink *replacelink = ctx->inputs[1];
56 
57  if (sourcelink->w != replacelink->w || sourcelink->h != replacelink->h) {
59  "Input frame sizes do not match (%dx%d vs %dx%d).\n",
60  sourcelink->w, sourcelink->h,
61  replacelink->w, replacelink->h);
62  return AVERROR(EINVAL);
63  }
64 
65  outlink->w = sourcelink->w;
66  outlink->h = sourcelink->h;
67  outlink->time_base = sourcelink->time_base;
68  outlink->sample_aspect_ratio = sourcelink->sample_aspect_ratio;
69  outlink->frame_rate = sourcelink->frame_rate;
70 
71  return 0;
72 }
73 
75 {
76  AVFilterLink *outlink = ctx->outputs[0];
77  FreezeFramesContext *s = ctx->priv;
78  AVFrame *frame = NULL;
79  int drop = ctx->inputs[0]->frame_count_out >= s->first &&
80  ctx->inputs[0]->frame_count_out <= s->last;
81  int replace = ctx->inputs[1]->frame_count_out == s->replace;
82  int ret;
83 
85 
86  if (drop && s->replace_frame) {
87  ret = ff_inlink_consume_frame(ctx->inputs[0], &frame);
88  if (ret < 0)
89  return ret;
90 
91  if (frame) {
92  int64_t dropped_pts = frame->pts;
93 
95  frame = av_frame_clone(s->replace_frame);
96  if (!frame)
97  return AVERROR(ENOMEM);
98  frame->pts = dropped_pts;
99  return ff_filter_frame(outlink, frame);
100  }
101  } else if (!drop) {
102  ret = ff_inlink_consume_frame(ctx->inputs[0], &frame);
103  if (ret < 0)
104  return ret;
105 
106  if (frame)
107  return ff_filter_frame(outlink, frame);
108  }
109 
110  ret = ff_inlink_consume_frame(ctx->inputs[1], &frame);
111  if (ret < 0)
112  return ret;
113  if (replace && frame) {
114  s->replace_frame = frame;
115  } else if (frame) {
117  }
118 
119  FF_FILTER_FORWARD_STATUS(ctx->inputs[0], outlink);
120  FF_FILTER_FORWARD_STATUS(ctx->inputs[1], outlink);
121 
122  if (!drop || (drop && s->replace_frame))
123  FF_FILTER_FORWARD_WANTED(outlink, ctx->inputs[0]);
124  if (!s->replace_frame)
125  FF_FILTER_FORWARD_WANTED(outlink, ctx->inputs[1]);
126 
127  return FFERROR_NOT_READY;
128 }
129 
131 {
132  FreezeFramesContext *s = ctx->priv;
133 
134  av_frame_free(&s->replace_frame);
135 }
136 
138  {
139  .name = "source",
140  .type = AVMEDIA_TYPE_VIDEO,
141  },
142  {
143  .name = "replace",
144  .type = AVMEDIA_TYPE_VIDEO,
145  },
146  { NULL },
147 };
148 
150  {
151  .name = "default",
152  .type = AVMEDIA_TYPE_VIDEO,
153  .config_props = config_output,
154  },
155  { NULL },
156 };
157 
159  .name = "freezeframes",
160  .description = NULL_IF_CONFIG_SMALL("Freeze video frames."),
161  .priv_size = sizeof(FreezeFramesContext),
162  .priv_class = &freezeframes_class,
165  .activate = activate,
166  .uninit = uninit,
167 };
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
config_output
static int config_output(AVFilterLink *outlink)
Definition: vf_freezeframes.c:51
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1075
FFERROR_NOT_READY
return FFERROR_NOT_READY
Definition: filter_design.txt:204
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:300
AVOption
AVOption.
Definition: opt.h:246
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:148
video.h
uninit
static av_cold void uninit(AVFilterContext *ctx)
Definition: vf_freezeframes.c:130
ff_inlink_consume_frame
int ff_inlink_consume_frame(AVFilterLink *link, AVFrame **rframe)
Take a frame from the link's FIFO and update the link's stats.
Definition: avfilter.c:1476
OFFSET
#define OFFSET(x)
Definition: vf_freezeframes.c:39
FF_FILTER_FORWARD_STATUS_BACK_ALL
#define FF_FILTER_FORWARD_STATUS_BACK_ALL(outlink, filter)
Forward the status on an output link to all input links.
Definition: filters.h:212
FLAGS
#define FLAGS
Definition: vf_freezeframes.c:40
FreezeFramesContext
Definition: vf_freezeframes.c:32
freezeframes_inputs
static const AVFilterPad freezeframes_inputs[]
Definition: vf_freezeframes.c:137
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:54
first
trying all byte sequences megabyte in length and selecting the best looking sequence will yield cases to try But first
Definition: rate_distortion.txt:12
avassert.h
replace
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not replace
Definition: fate.txt:142
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
av_cold
#define av_cold
Definition: attributes.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_OPT_TYPE_INT64
@ AV_OPT_TYPE_INT64
Definition: opt.h:224
outputs
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
filters.h
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_frame_clone
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
Definition: frame.c:541
freezeframes_options
static const AVOption freezeframes_options[]
Definition: vf_freezeframes.c:42
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
NULL
#define NULL
Definition: coverity.c:32
ff_vf_freezeframes
AVFilter ff_vf_freezeframes
Definition: vf_freezeframes.c:158
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:243
FreezeFramesContext::replace
int64_t replace
Definition: vf_freezeframes.c:34
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:186
FF_FILTER_FORWARD_WANTED
FF_FILTER_FORWARD_WANTED(outlink, inlink)
internal.h
FreezeFramesContext::first
int64_t first
Definition: vf_freezeframes.c:34
internal.h
common.h
FreezeFramesContext::replace_frame
AVFrame * replace_frame
Definition: vf_freezeframes.c:36
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:60
AVFilter
Filter definition.
Definition: avfilter.h:144
ret
ret
Definition: filter_design.txt:187
activate
static int activate(AVFilterContext *ctx)
Definition: vf_freezeframes.c:74
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:338
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(freezeframes)
FF_FILTER_FORWARD_STATUS
FF_FILTER_FORWARD_STATUS(inlink, outlink)
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
FreezeFramesContext::last
int64_t last
Definition: vf_freezeframes.c:34
avstring.h
freezeframes_outputs
static const AVFilterPad freezeframes_outputs[]
Definition: vf_freezeframes.c:149