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 "libavutil/avassert.h"
27 #include "libavutil/avstring.h"
28 #include "libavutil/opt.h"
29 
30 #include "avfilter.h"
31 #include "formats.h"
32 #include "filters.h"
33 #include "internal.h"
34 #include "audio.h"
35 #include "video.h"
36 
37 typedef struct InterleaveContext {
38  const AVClass *class;
39  int nb_inputs;
41  int64_t pts;
43 
44 #define DURATION_LONGEST 0
45 #define DURATION_SHORTEST 1
46 #define DURATION_FIRST 2
47 
48 #define OFFSET(x) offsetof(InterleaveContext, x)
49 
50 #define DEFINE_OPTIONS(filt_name, flags_) \
51 static const AVOption filt_name##_options[] = { \
52  { "nb_inputs", "set number of inputs", OFFSET(nb_inputs), AV_OPT_TYPE_INT, {.i64 = 2}, 1, INT_MAX, .flags = flags_ }, \
53  { "n", "set number of inputs", OFFSET(nb_inputs), AV_OPT_TYPE_INT, {.i64 = 2}, 1, INT_MAX, .flags = flags_ }, \
54  { "duration", "how to determine the end-of-stream", \
55  OFFSET(duration_mode), AV_OPT_TYPE_INT, { .i64 = DURATION_LONGEST }, 0, 2, flags_, "duration" }, \
56  { "longest", "Duration of longest input", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_LONGEST }, 0, 0, flags_, "duration" }, \
57  { "shortest", "Duration of shortest input", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_SHORTEST }, 0, 0, flags_, "duration" }, \
58  { "first", "Duration of first input", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_FIRST }, 0, 0, flags_, "duration" }, \
59  { NULL } \
60 }
61 
63 {
64  AVFilterLink *outlink = ctx->outputs[0];
65  InterleaveContext *s = ctx->priv;
66  int64_t q_pts, pts = INT64_MAX;
67  int i, nb_eofs = 0, input_idx = -1;
68  int first_eof = 0;
69  int64_t rpts;
70  int status;
71  int nb_inputs_with_frames = 0;
72 
74 
75  for (i = 0; i < ctx->nb_inputs; i++) {
76  int is_eof = !!ff_inlink_acknowledge_status(ctx->inputs[i], &status, &rpts);
77 
78  nb_eofs += is_eof;
79  if (i == 0)
80  first_eof = is_eof;
81  }
82 
83  if ((nb_eofs > 0 && s->duration_mode == DURATION_SHORTEST) ||
84  (nb_eofs == ctx->nb_inputs && s->duration_mode == DURATION_LONGEST) ||
85  (first_eof && s->duration_mode == DURATION_FIRST)) {
86  ff_outlink_set_status(outlink, AVERROR_EOF, s->pts);
87  return 0;
88  }
89 
90  for (i = 0; i < ctx->nb_inputs; i++) {
91  if (!ff_inlink_queued_frames(ctx->inputs[i]))
92  continue;
93  nb_inputs_with_frames++;
94  }
95 
96  if (nb_inputs_with_frames >= ctx->nb_inputs - nb_eofs) {
97  for (i = 0; i < ctx->nb_inputs; i++) {
98  AVFrame *frame;
99 
100  if (ff_inlink_queued_frames(ctx->inputs[i]) == 0)
101  continue;
102 
103  frame = ff_inlink_peek_frame(ctx->inputs[i], 0);
104  if (frame->pts == AV_NOPTS_VALUE) {
105  int ret;
106 
108  "NOPTS value for input frame cannot be accepted, frame discarded\n");
109  ret = ff_inlink_consume_frame(ctx->inputs[i], &frame);
110  if (ret < 0)
111  return ret;
113  return AVERROR_INVALIDDATA;
114  }
115 
116  q_pts = av_rescale_q(frame->pts, ctx->inputs[i]->time_base, AV_TIME_BASE_Q);
117  if (q_pts < pts) {
118  pts = q_pts;
119  input_idx = i;
120  }
121  }
122 
123  if (input_idx >= 0) {
124  AVFrame *frame;
125  int ret;
126 
127  ret = ff_inlink_consume_frame(ctx->inputs[input_idx], &frame);
128  if (ret < 0)
129  return ret;
130 
131  frame->pts = s->pts = pts;
132  return ff_filter_frame(outlink, frame);
133  }
134  }
135 
136  for (i = 0; i < ctx->nb_inputs; i++) {
137  if (ff_inlink_queued_frames(ctx->inputs[i]))
138  continue;
139  if (ff_outlink_frame_wanted(outlink) &&
140  !ff_outlink_get_status(ctx->inputs[i])) {
141  ff_inlink_request_frame(ctx->inputs[i]);
142  return 0;
143  }
144  }
145 
146  if (i == ctx->nb_inputs - nb_eofs && ff_outlink_frame_wanted(outlink)) {
147  ff_filter_set_ready(ctx, 100);
148  return 0;
149  }
150 
151  return FFERROR_NOT_READY;
152 }
153 
155 {
156  InterleaveContext *s = ctx->priv;
157  const AVFilterPad *outpad = &ctx->filter->outputs[0];
158  int i, ret;
159 
160  for (i = 0; i < s->nb_inputs; i++) {
161  AVFilterPad inpad = { 0 };
162 
163  inpad.name = av_asprintf("input%d", i);
164  if (!inpad.name)
165  return AVERROR(ENOMEM);
166  inpad.type = outpad->type;
167 
168  switch (outpad->type) {
169  case AVMEDIA_TYPE_VIDEO:
171  case AVMEDIA_TYPE_AUDIO:
173  default:
174  av_assert0(0);
175  }
176  if ((ret = ff_append_inpad_free_name(ctx, &inpad)) < 0)
177  return ret;
178  }
179 
180  return 0;
181 }
182 
183 static int config_output(AVFilterLink *outlink)
184 {
185  AVFilterContext *ctx = outlink->src;
186  AVFilterLink *inlink0 = ctx->inputs[0];
187  int i;
188 
189  if (outlink->type == AVMEDIA_TYPE_VIDEO) {
190  outlink->time_base = AV_TIME_BASE_Q;
191  outlink->w = inlink0->w;
192  outlink->h = inlink0->h;
193  outlink->sample_aspect_ratio = inlink0->sample_aspect_ratio;
194  outlink->format = inlink0->format;
195  outlink->frame_rate = (AVRational) {1, 0};
196  for (i = 1; i < ctx->nb_inputs; i++) {
197  AVFilterLink *inlink = ctx->inputs[i];
198 
199  if (outlink->w != inlink->w ||
200  outlink->h != inlink->h ||
201  outlink->sample_aspect_ratio.num != inlink->sample_aspect_ratio.num ||
202  outlink->sample_aspect_ratio.den != inlink->sample_aspect_ratio.den) {
203  av_log(ctx, AV_LOG_ERROR, "Parameters for input link %s "
204  "(size %dx%d, SAR %d:%d) do not match the corresponding "
205  "output link parameters (%dx%d, SAR %d:%d)\n",
206  ctx->input_pads[i].name, inlink->w, inlink->h,
207  inlink->sample_aspect_ratio.num,
208  inlink->sample_aspect_ratio.den,
209  outlink->w, outlink->h,
210  outlink->sample_aspect_ratio.num,
211  outlink->sample_aspect_ratio.den);
212  return AVERROR(EINVAL);
213  }
214  }
215  }
216  return 0;
217 }
218 
219 #if CONFIG_INTERLEAVE_FILTER
220 
223 
224 static const AVFilterPad interleave_outputs[] = {
225  {
226  .name = "default",
227  .type = AVMEDIA_TYPE_VIDEO,
228  .config_props = config_output,
229  },
230 };
231 
232 const AVFilter ff_vf_interleave = {
233  .name = "interleave",
234  .description = NULL_IF_CONFIG_SMALL("Temporally interleave video inputs."),
235  .priv_size = sizeof(InterleaveContext),
236  .init = init,
237  .activate = activate,
238  FILTER_OUTPUTS(interleave_outputs),
239  .priv_class = &interleave_class,
241 };
242 
243 #endif
244 
245 #if CONFIG_AINTERLEAVE_FILTER
246 
248 AVFILTER_DEFINE_CLASS(ainterleave);
249 
250 static const AVFilterPad ainterleave_outputs[] = {
251  {
252  .name = "default",
253  .type = AVMEDIA_TYPE_AUDIO,
254  .config_props = config_output,
255  },
256 };
257 
258 const AVFilter ff_af_ainterleave = {
259  .name = "ainterleave",
260  .description = NULL_IF_CONFIG_SMALL("Temporally interleave audio inputs."),
261  .priv_size = sizeof(InterleaveContext),
262  .init = init,
263  .activate = activate,
264  FILTER_OUTPUTS(ainterleave_outputs),
265  .priv_class = &ainterleave_class,
267 };
268 
269 #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:280
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
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:113
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:109
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:310
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:169
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:293
config_output
static int config_output(AVFilterLink *outlink)
Definition: f_interleave.c:183
formats.h
activate
static int activate(AVFilterContext *ctx)
Definition: f_interleave.c:62
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:1417
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:653
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:110
AVRational::num
int num
Numerator.
Definition: rational.h:59
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
ff_vf_interleave
const AVFilter ff_vf_interleave
DEFINE_OPTIONS
#define DEFINE_OPTIONS(filt_name, flags_)
Definition: f_interleave.c:50
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:1534
s
#define s(width, name)
Definition: cbs_vp9.c:257
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:34
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:141
init
static av_cold int init(AVFilterContext *ctx)
Definition: f_interleave.c:154
AV_OPT_FLAG_AUDIO_PARAM
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:279
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:1456
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:144
AVFilterPad::get_buffer
union AVFilterPad::@209 get_buffer
Callback functions to get a video/audio buffers.
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:1371
ff_inlink_queued_frames
size_t ff_inlink_queued_frames(AVFilterLink *link)
Get the number of frames available on the link.
Definition: avfilter.c:1386
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:117
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
DURATION_SHORTEST
#define DURATION_SHORTEST
Definition: f_interleave.c:45
InterleaveContext::nb_inputs
int nb_inputs
Definition: f_interleave.c:39
InterleaveContext
Definition: f_interleave.c:37
ff_null_get_video_buffer
AVFrame * ff_null_get_video_buffer(AVFilterLink *link, int w, int h)
Definition: video.c:38
internal.h
AVFILTER_DEFINE_CLASS
#define AVFILTER_DEFINE_CLASS(fname)
Definition: internal.h:326
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
InterleaveContext::duration_mode
int duration_mode
Definition: f_interleave.c:40
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
InterleaveContext::pts
int64_t pts
Definition: f_interleave.c:41
AVFilter
Filter definition.
Definition: avfilter.h:165
ret
ret
Definition: filter_design.txt:187
AVFilterPad::type
enum AVMediaType type
AVFilterPad type.
Definition: internal.h:61
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:91
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:1557
AVFilterContext
An instance of a filter.
Definition: avfilter.h:402
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
audio.h
AVFilterPad::audio
AVFrame *(* audio)(AVFilterLink *link, int nb_samples)
Definition: internal.h:92
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
DURATION_FIRST
#define DURATION_FIRST
Definition: f_interleave.c:46
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:44
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:211