FFmpeg
f_cue.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Marton Balint
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 License
8  * 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
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with FFmpeg; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #include "config_components.h"
22 
23 #include "libavutil/opt.h"
24 #include "libavutil/time.h"
25 #include "avfilter.h"
26 #include "filters.h"
27 #include "internal.h"
28 
29 typedef struct CueContext {
30  const AVClass *class;
31  int64_t first_pts;
32  int64_t cue;
33  int64_t preroll;
34  int64_t buffer;
35  int status;
36 } CueContext;
37 
39 {
40  AVFilterLink *inlink = ctx->inputs[0];
41  AVFilterLink *outlink = ctx->outputs[0];
42  CueContext *s = ctx->priv;
43 
45 
48  int64_t pts = av_rescale_q(frame->pts, inlink->time_base, AV_TIME_BASE_Q);
49 
50  if (!s->status) {
51  s->first_pts = pts;
52  s->status++;
53  }
54  if (s->status == 1) {
55  if (pts - s->first_pts < s->preroll) {
57  if (ret < 0)
58  return ret;
59  return ff_filter_frame(outlink, frame);
60  }
61  s->first_pts = pts;
62  s->status++;
63  }
64  if (s->status == 2) {
66  pts = av_rescale_q(frame->pts, inlink->time_base, AV_TIME_BASE_Q);
67  if (!(pts - s->first_pts < s->buffer && (av_gettime() - s->cue) < 0))
68  s->status++;
69  }
70  if (s->status == 3) {
71  int64_t diff;
72  while ((diff = (av_gettime() - s->cue)) < 0)
73  av_usleep(av_clip(-diff / 2, 100, 1000000));
74  s->status++;
75  }
76  if (s->status == 4) {
78  if (ret < 0)
79  return ret;
80  return ff_filter_frame(outlink, frame);
81  }
82  }
83 
86 
87  return FFERROR_NOT_READY;
88 }
89 
90 #define OFFSET(x) offsetof(CueContext, x)
91 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
92 static const AVOption options[] = {
93  { "cue", "cue unix timestamp in microseconds", OFFSET(cue), AV_OPT_TYPE_INT64, { .i64 = 0 }, 0, INT64_MAX, FLAGS },
94  { "preroll", "preroll duration in seconds", OFFSET(preroll), AV_OPT_TYPE_DURATION, { .i64 = 0 }, 0, INT64_MAX, FLAGS },
95  { "buffer", "buffer duration in seconds", OFFSET(buffer), AV_OPT_TYPE_DURATION, { .i64 = 0 }, 0, INT64_MAX, FLAGS },
96  { NULL }
97 };
98 
99 AVFILTER_DEFINE_CLASS_EXT(cue_acue, "(a)cue", options);
100 
101 #if CONFIG_CUE_FILTER
102 static const AVFilterPad cue_inputs[] = {
103  {
104  .name = "default",
105  .type = AVMEDIA_TYPE_VIDEO,
106  },
107 };
108 
109 static const AVFilterPad cue_outputs[] = {
110  {
111  .name = "default",
112  .type = AVMEDIA_TYPE_VIDEO,
113  },
114 };
115 
116 const AVFilter ff_vf_cue = {
117  .name = "cue",
118  .description = NULL_IF_CONFIG_SMALL("Delay filtering to match a cue."),
119  .priv_class = &cue_acue_class,
120  .priv_size = sizeof(CueContext),
121  FILTER_INPUTS(cue_inputs),
122  FILTER_OUTPUTS(cue_outputs),
123  .activate = activate,
124 };
125 #endif /* CONFIG_CUE_FILTER */
126 
127 #if CONFIG_ACUE_FILTER
128 static const AVFilterPad acue_inputs[] = {
129  {
130  .name = "default",
131  .type = AVMEDIA_TYPE_AUDIO,
132  },
133 };
134 
135 static const AVFilterPad acue_outputs[] = {
136  {
137  .name = "default",
138  .type = AVMEDIA_TYPE_AUDIO,
139  },
140 };
141 
142 const AVFilter ff_af_acue = {
143  .name = "acue",
144  .description = NULL_IF_CONFIG_SMALL("Delay filtering to match a cue."),
145  .priv_class = &cue_acue_class,
146  .priv_size = sizeof(CueContext),
148  FILTER_INPUTS(acue_inputs),
149  FILTER_OUTPUTS(acue_outputs),
150  .activate = activate,
151 };
152 #endif /* CONFIG_ACUE_FILTER */
av_clip
#define av_clip
Definition: common.h:95
opt.h
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1009
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
CueContext::cue
int64_t cue
Definition: f_cue.c:32
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
FLAGS
#define FLAGS
Definition: f_cue.c:91
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVOption
AVOption.
Definition: opt.h:251
AV_OPT_TYPE_DURATION
@ AV_OPT_TYPE_DURATION
Definition: opt.h:239
CueContext::buffer
int64_t buffer
Definition: f_cue.c:34
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:175
FF_FILTER_FORWARD_STATUS_BACK
#define FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink)
Forward the status on an output link to an input link.
Definition: filters.h:199
activate
static int activate(AVFilterContext *ctx)
Definition: f_cue.c:38
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
CueContext::first_pts
int64_t first_pts
Definition: f_cue.c:31
CueContext
Definition: f_cue.c:29
CueContext::preroll
int64_t preroll
Definition: f_cue.c:33
options
static const AVOption options[]
Definition: f_cue.c:92
pts
static int64_t pts
Definition: transcode_aac.c:654
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:49
ff_af_acue
const AVFilter ff_af_acue
s
#define s(width, name)
Definition: cbs_vp9.c:256
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AV_OPT_TYPE_INT64
@ AV_OPT_TYPE_INT64
Definition: opt.h:226
filters.h
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
av_usleep
int av_usleep(unsigned usec)
Sleep for a period of time.
Definition: time.c:84
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:190
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
NULL
#define NULL
Definition: coverity.c:32
AVFILTER_DEFINE_CLASS_EXT
AVFILTER_DEFINE_CLASS_EXT(cue_acue, "(a)cue", options)
time.h
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
CueContext::status
int status
Definition: f_cue.c:35
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
FF_FILTER_FORWARD_WANTED
FF_FILTER_FORWARD_WANTED(outlink, inlink)
internal.h
OFFSET
#define OFFSET(x)
Definition: f_cue.c:90
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:55
AVFilter
Filter definition.
Definition: avfilter.h:171
ret
ret
Definition: filter_design.txt:187
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
buffer
the frame and frame reference mechanism is intended to as much as expensive copies of that data while still allowing the filters to produce correct results The data is stored in buffers represented by AVFrame structures Several references can point to the same frame buffer
Definition: filter_design.txt:49
avfilter.h
AVFILTER_FLAG_METADATA_ONLY
#define AVFILTER_FLAG_METADATA_ONLY
The filter is a "metadata" filter - it does not modify the frame data in any way.
Definition: avfilter.h:143
AVFilterContext
An instance of a filter.
Definition: avfilter.h:408
av_gettime
int64_t av_gettime(void)
Get the current time in microseconds.
Definition: time.c:39
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
diff
static av_always_inline int diff(const uint32_t a, const uint32_t b)
Definition: vf_palettegen.c:139
FF_FILTER_FORWARD_STATUS
FF_FILTER_FORWARD_STATUS(inlink, outlink)
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:191
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
ff_vf_cue
const AVFilter ff_vf_cue