FFmpeg
f_interleave.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 Stefano Sabatini
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 /**
22  * @file
23  * audio and video interleaver
24  */
25 
26 #include "config_components.h"
27 
28 #include "libavutil/avassert.h"
29 #include "libavutil/avstring.h"
30 #include "libavutil/opt.h"
31 
32 #include "avfilter.h"
33 #include "formats.h"
34 #include "filters.h"
35 #include "internal.h"
36 #include "audio.h"
37 #include "video.h"
38 
39 typedef struct InterleaveContext {
40  const AVClass *class;
41  int nb_inputs;
43  int64_t pts;
45 
46 #define DURATION_LONGEST 0
47 #define DURATION_SHORTEST 1
48 #define DURATION_FIRST 2
49 
50 #define OFFSET(x) offsetof(InterleaveContext, x)
51 
52 #define DEFINE_OPTIONS(filt_name, flags_) \
53 static const AVOption filt_name##_options[] = { \
54  { "nb_inputs", "set number of inputs", OFFSET(nb_inputs), AV_OPT_TYPE_INT, {.i64 = 2}, 1, INT_MAX, .flags = flags_ }, \
55  { "n", "set number of inputs", OFFSET(nb_inputs), AV_OPT_TYPE_INT, {.i64 = 2}, 1, INT_MAX, .flags = flags_ }, \
56  { "duration", "how to determine the end-of-stream", \
57  OFFSET(duration_mode), AV_OPT_TYPE_INT, { .i64 = DURATION_LONGEST }, 0, 2, flags_, "duration" }, \
58  { "longest", "Duration of longest input", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_LONGEST }, 0, 0, flags_, "duration" }, \
59  { "shortest", "Duration of shortest input", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_SHORTEST }, 0, 0, flags_, "duration" }, \
60  { "first", "Duration of first input", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_FIRST }, 0, 0, flags_, "duration" }, \
61  { NULL } \
62 }
63 
65 {
66  AVFilterLink *outlink = ctx->outputs[0];
67  InterleaveContext *s = ctx->priv;
68  int64_t q_pts, pts = INT64_MAX;
69  int i, nb_eofs = 0, input_idx = -1;
70  int first_eof = 0;
71  int64_t rpts;
72  int status;
73  int nb_inputs_with_frames = 0;
74 
76 
77  for (i = 0; i < ctx->nb_inputs; i++) {
78  int is_eof = !!ff_inlink_acknowledge_status(ctx->inputs[i], &status, &rpts);
79 
80  nb_eofs += is_eof;
81  if (i == 0)
82  first_eof = is_eof;
83  }
84 
85  if ((nb_eofs > 0 && s->duration_mode == DURATION_SHORTEST) ||
86  (nb_eofs == ctx->nb_inputs && s->duration_mode == DURATION_LONGEST) ||
87  (first_eof && s->duration_mode == DURATION_FIRST)) {
88  ff_outlink_set_status(outlink, AVERROR_EOF, s->pts);
89  return 0;
90  }
91 
92  for (i = 0; i < ctx->nb_inputs; i++) {
93  if (!ff_inlink_queued_frames(ctx->inputs[i]))
94  continue;
95  nb_inputs_with_frames++;
96  }
97 
98  if (nb_inputs_with_frames >= ctx->nb_inputs - nb_eofs) {
99  for (i = 0; i < ctx->nb_inputs; i++) {
100  AVFrame *frame;
101 
102  if (ff_inlink_queued_frames(ctx->inputs[i]) == 0)
103  continue;
104 
105  frame = ff_inlink_peek_frame(ctx->inputs[i], 0);
106  if (frame->pts == AV_NOPTS_VALUE) {
107  int ret;
108 
110  "NOPTS value for input frame cannot be accepted, frame discarded\n");
111  ret = ff_inlink_consume_frame(ctx->inputs[i], &frame);
112  if (ret < 0)
113  return ret;
115  return AVERROR_INVALIDDATA;
116  }
117 
118  q_pts = av_rescale_q(frame->pts, ctx->inputs[i]->time_base, AV_TIME_BASE_Q);
119  if (q_pts < pts) {
120  pts = q_pts;
121  input_idx = i;
122  }
123  }
124 
125  if (input_idx >= 0) {
126  AVFrame *frame;
127  int ret;
128 
129  ret = ff_inlink_consume_frame(ctx->inputs[input_idx], &frame);
130  if (ret < 0)
131  return ret;
132 
133  frame->pts = s->pts = pts;
134  return ff_filter_frame(outlink, frame);
135  }
136  }
137 
138  for (i = 0; i < ctx->nb_inputs; i++) {
139  if (ff_inlink_queued_frames(ctx->inputs[i]))
140  continue;
141  if (ff_outlink_frame_wanted(outlink) &&
142  !ff_outlink_get_status(ctx->inputs[i])) {
143  ff_inlink_request_frame(ctx->inputs[i]);
144  return 0;
145  }
146  }
147 
148  if (i == ctx->nb_inputs - nb_eofs && ff_outlink_frame_wanted(outlink)) {
149  ff_filter_set_ready(ctx, 100);
150  return 0;
151  }
152 
153  return FFERROR_NOT_READY;
154 }
155 
157 {
158  InterleaveContext *s = ctx->priv;
159  const AVFilterPad *outpad = &ctx->filter->outputs[0];
160  int i, ret;
161 
162  for (i = 0; i < s->nb_inputs; i++) {
163  AVFilterPad inpad = { 0 };
164 
165  inpad.name = av_asprintf("input%d", i);
166  if (!inpad.name)
167  return AVERROR(ENOMEM);
168  inpad.type = outpad->type;
169 
170  switch (outpad->type) {
171  case AVMEDIA_TYPE_VIDEO:
173  case AVMEDIA_TYPE_AUDIO:
175  default:
176  av_assert0(0);
177  }
178  if ((ret = ff_append_inpad_free_name(ctx, &inpad)) < 0)
179  return ret;
180  }
181 
182  return 0;
183 }
184 
185 static int config_output(AVFilterLink *outlink)
186 {
187  AVFilterContext *ctx = outlink->src;
188  AVFilterLink *inlink0 = ctx->inputs[0];
189  int i;
190 
191  if (outlink->type == AVMEDIA_TYPE_VIDEO) {
192  outlink->time_base = AV_TIME_BASE_Q;
193  outlink->w = inlink0->w;
194  outlink->h = inlink0->h;
195  outlink->sample_aspect_ratio = inlink0->sample_aspect_ratio;
196  outlink->format = inlink0->format;
197  outlink->frame_rate = (AVRational) {1, 0};
198  for (i = 1; i < ctx->nb_inputs; i++) {
199  AVFilterLink *inlink = ctx->inputs[i];
200 
201  if (outlink->w != inlink->w ||
202  outlink->h != inlink->h ||
203  outlink->sample_aspect_ratio.num != inlink->sample_aspect_ratio.num ||
204  outlink->sample_aspect_ratio.den != inlink->sample_aspect_ratio.den) {
205  av_log(ctx, AV_LOG_ERROR, "Parameters for input link %s "
206  "(size %dx%d, SAR %d:%d) do not match the corresponding "
207  "output link parameters (%dx%d, SAR %d:%d)\n",
208  ctx->input_pads[i].name, inlink->w, inlink->h,
209  inlink->sample_aspect_ratio.num,
210  inlink->sample_aspect_ratio.den,
211  outlink->w, outlink->h,
212  outlink->sample_aspect_ratio.num,
213  outlink->sample_aspect_ratio.den);
214  return AVERROR(EINVAL);
215  }
216  }
217  }
218  return 0;
219 }
220 
221 #if CONFIG_INTERLEAVE_FILTER
222 
225 
226 static const AVFilterPad interleave_outputs[] = {
227  {
228  .name = "default",
229  .type = AVMEDIA_TYPE_VIDEO,
230  .config_props = config_output,
231  },
232 };
233 
234 const AVFilter ff_vf_interleave = {
235  .name = "interleave",
236  .description = NULL_IF_CONFIG_SMALL("Temporally interleave video inputs."),
237  .priv_size = sizeof(InterleaveContext),
238  .init = init,
239  .activate = activate,
240  FILTER_OUTPUTS(interleave_outputs),
241  .priv_class = &interleave_class,
243 };
244 
245 #endif
246 
247 #if CONFIG_AINTERLEAVE_FILTER
248 
250 AVFILTER_DEFINE_CLASS(ainterleave);
251 
252 static const AVFilterPad ainterleave_outputs[] = {
253  {
254  .name = "default",
255  .type = AVMEDIA_TYPE_AUDIO,
256  .config_props = config_output,
257  },
258 };
259 
260 const AVFilter ff_af_ainterleave = {
261  .name = "ainterleave",
262  .description = NULL_IF_CONFIG_SMALL("Temporally interleave audio inputs."),
263  .priv_size = sizeof(InterleaveContext),
264  .init = init,
265  .activate = activate,
266  FILTER_OUTPUTS(ainterleave_outputs),
267  .priv_class = &ainterleave_class,
269 };
270 
271 #endif
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
status
they must not be accessed directly The fifo field contains the frames that are queued in the input for processing by the filter The status_in and status_out fields contains the queued status(EOF or error) of the link
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
AV_OPT_FLAG_VIDEO_PARAM
#define AV_OPT_FLAG_VIDEO_PARAM
Definition: opt.h:284
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1009
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
FFERROR_NOT_READY
return FFERROR_NOT_READY
Definition: filter_design.txt:204
AV_TIME_BASE_Q
#define AV_TIME_BASE_Q
Internal time base represented as fractional value.
Definition: avutil.h:260
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
av_asprintf
char * av_asprintf(const char *fmt,...)
Definition: avstring.c:116
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:116
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVFilterPad::get_buffer
union AVFilterPad::@223 get_buffer
Callback functions to get a video/audio buffers.
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:175
video.h
AV_OPT_FLAG_FILTERING_PARAM
#define AV_OPT_FLAG_FILTERING_PARAM
a generic parameter which can be set by the user for filtering
Definition: opt.h:297
config_output
static int config_output(AVFilterLink *outlink)
Definition: f_interleave.c:185
formats.h
activate
static int activate(AVFilterContext *ctx)
Definition: f_interleave.c:64
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:1404
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
ff_af_ainterleave
const AVFilter ff_af_ainterleave
pts
static int64_t pts
Definition: transcode_aac.c:654
AVFILTER_FLAG_DYNAMIC_INPUTS
#define AVFILTER_FLAG_DYNAMIC_INPUTS
The number of the filter inputs is not determined just by AVFilter.inputs.
Definition: avfilter.h:116
AVRational::num
int num
Numerator.
Definition: rational.h:59
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:49
ff_vf_interleave
const AVFilter ff_vf_interleave
DEFINE_OPTIONS
#define DEFINE_OPTIONS(filt_name, flags_)
Definition: f_interleave.c:52
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
ff_outlink_set_status
static void ff_outlink_set_status(AVFilterLink *link, int status, int64_t pts)
Set the status field of a link from the source filter.
Definition: filters.h:189
ff_inlink_request_frame
void ff_inlink_request_frame(AVFilterLink *link)
Mark that a frame is wanted on the link.
Definition: avfilter.c:1521
s
#define s(width, name)
Definition: cbs_vp9.c:256
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
filters.h
ff_null_get_audio_buffer
AVFrame * ff_null_get_audio_buffer(AVFilterLink *link, int nb_samples)
get_audio_buffer() handler for filters which simply pass audio along
Definition: audio.c:32
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_rescale_q
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:142
init
static av_cold int init(AVFilterContext *ctx)
Definition: f_interleave.c:156
AV_OPT_FLAG_AUDIO_PARAM
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:283
ff_inlink_peek_frame
AVFrame * ff_inlink_peek_frame(AVFilterLink *link, size_t idx)
Access a frame in the link fifo without consuming it.
Definition: avfilter.c:1443
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
ff_append_inpad_free_name
int ff_append_inpad_free_name(AVFilterContext *f, AVFilterPad *p)
Definition: avfilter.c:131
ff_inlink_acknowledge_status
int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts)
Test and acknowledge the change of status on the link.
Definition: avfilter.c:1358
ff_inlink_queued_frames
size_t ff_inlink_queued_frames(AVFilterLink *link)
Get the number of frames available on the link.
Definition: avfilter.c:1373
interleave
static void interleave(uint8_t *dst, uint8_t *src, int w, int h, int dst_linesize, int src_linesize, enum FilterMode mode, int swap)
Definition: vf_il.c:108
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:115
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
DURATION_SHORTEST
#define DURATION_SHORTEST
Definition: f_interleave.c:47
InterleaveContext::nb_inputs
int nb_inputs
Definition: f_interleave.c:41
InterleaveContext
Definition: f_interleave.c:39
ff_null_get_video_buffer
AVFrame * ff_null_get_video_buffer(AVFilterLink *link, int w, int h)
Definition: video.c:36
internal.h
AVFILTER_DEFINE_CLASS
#define AVFILTER_DEFINE_CLASS(fname)
Definition: internal.h:325
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
InterleaveContext::duration_mode
int duration_mode
Definition: f_interleave.c:42
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:55
InterleaveContext::pts
int64_t pts
Definition: f_interleave.c:43
AVFilter
Filter definition.
Definition: avfilter.h:171
ret
ret
Definition: filter_design.txt:187
AVFilterPad::type
enum AVMediaType type
AVFilterPad type.
Definition: internal.h:60
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
AVFilterPad::video
AVFrame *(* video)(AVFilterLink *link, int w, int h)
Definition: internal.h:90
AVRational::den
int den
Denominator.
Definition: rational.h:60
avfilter.h
ff_outlink_get_status
int ff_outlink_get_status(AVFilterLink *link)
Get the status on an output link.
Definition: avfilter.c:1544
AVFilterContext
An instance of a filter.
Definition: avfilter.h:408
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
audio.h
AVFilterPad::audio
AVFrame *(* audio)(AVFilterLink *link, int nb_samples)
Definition: internal.h:91
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:191
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
DURATION_FIRST
#define DURATION_FIRST
Definition: f_interleave.c:48
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
ff_outlink_frame_wanted
the definition of that something depends on the semantic of the filter The callback must examine the status of the filter s links and proceed accordingly The status of output links is stored in the status_in and status_out fields and tested by the ff_outlink_frame_wanted() function. If this function returns true
avstring.h
DURATION_LONGEST
#define DURATION_LONGEST
Definition: f_interleave.c:46
ff_filter_set_ready
void ff_filter_set_ready(AVFilterContext *filter, unsigned priority)
Mark a filter ready and schedule it for activation.
Definition: avfilter.c:199