FFmpeg
filtering_video.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010 Nicolas George
3  * Copyright (c) 2011 Stefano Sabatini
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to deal
7  * in the Software without restriction, including without limitation the rights
8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9  * copies of the Software, and to permit persons to whom the Software is
10  * furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21  * THE SOFTWARE.
22  */
23 
24 /**
25  * @file
26  * API example for decoding and filtering
27  * @example filtering_video.c
28  */
29 
30 #define _XOPEN_SOURCE 600 /* for usleep */
31 #include <unistd.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 
35 #include <libavcodec/avcodec.h>
36 #include <libavformat/avformat.h>
37 #include <libavfilter/buffersink.h>
38 #include <libavfilter/buffersrc.h>
39 #include <libavutil/opt.h>
40 
41 const char *filter_descr = "scale=78:24,transpose=cclock";
42 /* other way:
43  scale=78:24 [scl]; [scl] transpose=cclock // assumes "[in]" and "[out]" to be input output pads respectively
44  */
45 
51 static int video_stream_index = -1;
52 static int64_t last_pts = AV_NOPTS_VALUE;
53 
54 static int open_input_file(const char *filename)
55 {
56  int ret;
57  AVCodec *dec;
58 
59  if ((ret = avformat_open_input(&fmt_ctx, filename, NULL, NULL)) < 0) {
60  av_log(NULL, AV_LOG_ERROR, "Cannot open input file\n");
61  return ret;
62  }
63 
64  if ((ret = avformat_find_stream_info(fmt_ctx, NULL)) < 0) {
65  av_log(NULL, AV_LOG_ERROR, "Cannot find stream information\n");
66  return ret;
67  }
68 
69  /* select the video stream */
70  ret = av_find_best_stream(fmt_ctx, AVMEDIA_TYPE_VIDEO, -1, -1, &dec, 0);
71  if (ret < 0) {
72  av_log(NULL, AV_LOG_ERROR, "Cannot find a video stream in the input file\n");
73  return ret;
74  }
76 
77  /* create decoding context */
78  dec_ctx = avcodec_alloc_context3(dec);
79  if (!dec_ctx)
80  return AVERROR(ENOMEM);
82 
83  /* init the video decoder */
84  if ((ret = avcodec_open2(dec_ctx, dec, NULL)) < 0) {
85  av_log(NULL, AV_LOG_ERROR, "Cannot open video decoder\n");
86  return ret;
87  }
88 
89  return 0;
90 }
91 
92 static int init_filters(const char *filters_descr)
93 {
94  char args[512];
95  int ret = 0;
96  const AVFilter *buffersrc = avfilter_get_by_name("buffer");
97  const AVFilter *buffersink = avfilter_get_by_name("buffersink");
100  AVRational time_base = fmt_ctx->streams[video_stream_index]->time_base;
102 
103  filter_graph = avfilter_graph_alloc();
104  if (!outputs || !inputs || !filter_graph) {
105  ret = AVERROR(ENOMEM);
106  goto end;
107  }
108 
109  /* buffer video source: the decoded frames from the decoder will be inserted here. */
110  snprintf(args, sizeof(args),
111  "video_size=%dx%d:pix_fmt=%d:time_base=%d/%d:pixel_aspect=%d/%d",
112  dec_ctx->width, dec_ctx->height, dec_ctx->pix_fmt,
113  time_base.num, time_base.den,
114  dec_ctx->sample_aspect_ratio.num, dec_ctx->sample_aspect_ratio.den);
115 
116  ret = avfilter_graph_create_filter(&buffersrc_ctx, buffersrc, "in",
117  args, NULL, filter_graph);
118  if (ret < 0) {
119  av_log(NULL, AV_LOG_ERROR, "Cannot create buffer source\n");
120  goto end;
121  }
122 
123  /* buffer video sink: to terminate the filter chain. */
124  ret = avfilter_graph_create_filter(&buffersink_ctx, buffersink, "out",
125  NULL, NULL, filter_graph);
126  if (ret < 0) {
127  av_log(NULL, AV_LOG_ERROR, "Cannot create buffer sink\n");
128  goto end;
129  }
130 
131  ret = av_opt_set_int_list(buffersink_ctx, "pix_fmts", pix_fmts,
132  AV_PIX_FMT_NONE, AV_OPT_SEARCH_CHILDREN);
133  if (ret < 0) {
134  av_log(NULL, AV_LOG_ERROR, "Cannot set output pixel format\n");
135  goto end;
136  }
137 
138  /*
139  * Set the endpoints for the filter graph. The filter_graph will
140  * be linked to the graph described by filters_descr.
141  */
142 
143  /*
144  * The buffer source output must be connected to the input pad of
145  * the first filter described by filters_descr; since the first
146  * filter input label is not specified, it is set to "in" by
147  * default.
148  */
149  outputs->name = av_strdup("in");
150  outputs->filter_ctx = buffersrc_ctx;
151  outputs->pad_idx = 0;
152  outputs->next = NULL;
153 
154  /*
155  * The buffer sink input must be connected to the output pad of
156  * the last filter described by filters_descr; since the last
157  * filter output label is not specified, it is set to "out" by
158  * default.
159  */
160  inputs->name = av_strdup("out");
161  inputs->filter_ctx = buffersink_ctx;
162  inputs->pad_idx = 0;
163  inputs->next = NULL;
164 
165  if ((ret = avfilter_graph_parse_ptr(filter_graph, filters_descr,
166  &inputs, &outputs, NULL)) < 0)
167  goto end;
168 
169  if ((ret = avfilter_graph_config(filter_graph, NULL)) < 0)
170  goto end;
171 
172 end:
173  avfilter_inout_free(&inputs);
174  avfilter_inout_free(&outputs);
175 
176  return ret;
177 }
178 
179 static void display_frame(const AVFrame *frame, AVRational time_base)
180 {
181  int x, y;
182  uint8_t *p0, *p;
183  int64_t delay;
184 
185  if (frame->pts != AV_NOPTS_VALUE) {
186  if (last_pts != AV_NOPTS_VALUE) {
187  /* sleep roughly the right amount of time;
188  * usleep is in microseconds, just like AV_TIME_BASE. */
189  delay = av_rescale_q(frame->pts - last_pts,
190  time_base, AV_TIME_BASE_Q);
191  if (delay > 0 && delay < 1000000)
192  usleep(delay);
193  }
194  last_pts = frame->pts;
195  }
196 
197  /* Trivial ASCII grayscale display. */
198  p0 = frame->data[0];
199  puts("\033c");
200  for (y = 0; y < frame->height; y++) {
201  p = p0;
202  for (x = 0; x < frame->width; x++)
203  putchar(" .-+#"[*(p++) / 52]);
204  putchar('\n');
205  p0 += frame->linesize[0];
206  }
207  fflush(stdout);
208 }
209 
210 int main(int argc, char **argv)
211 {
212  int ret;
213  AVPacket packet;
214  AVFrame *frame;
215  AVFrame *filt_frame;
216 
217  if (argc != 2) {
218  fprintf(stderr, "Usage: %s file\n", argv[0]);
219  exit(1);
220  }
221 
222  frame = av_frame_alloc();
223  filt_frame = av_frame_alloc();
224  if (!frame || !filt_frame) {
225  perror("Could not allocate frame");
226  exit(1);
227  }
228 
229  if ((ret = open_input_file(argv[1])) < 0)
230  goto end;
231  if ((ret = init_filters(filter_descr)) < 0)
232  goto end;
233 
234  /* read all packets */
235  while (1) {
236  if ((ret = av_read_frame(fmt_ctx, &packet)) < 0)
237  break;
238 
239  if (packet.stream_index == video_stream_index) {
240  ret = avcodec_send_packet(dec_ctx, &packet);
241  if (ret < 0) {
242  av_log(NULL, AV_LOG_ERROR, "Error while sending a packet to the decoder\n");
243  break;
244  }
245 
246  while (ret >= 0) {
247  ret = avcodec_receive_frame(dec_ctx, frame);
248  if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF) {
249  break;
250  } else if (ret < 0) {
251  av_log(NULL, AV_LOG_ERROR, "Error while receiving a frame from the decoder\n");
252  goto end;
253  }
254 
255  frame->pts = frame->best_effort_timestamp;
256 
257  /* push the decoded frame into the filtergraph */
258  if (av_buffersrc_add_frame_flags(buffersrc_ctx, frame, AV_BUFFERSRC_FLAG_KEEP_REF) < 0) {
259  av_log(NULL, AV_LOG_ERROR, "Error while feeding the filtergraph\n");
260  break;
261  }
262 
263  /* pull filtered frames from the filtergraph */
264  while (1) {
265  ret = av_buffersink_get_frame(buffersink_ctx, filt_frame);
266  if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
267  break;
268  if (ret < 0)
269  goto end;
270  display_frame(filt_frame, buffersink_ctx->inputs[0]->time_base);
271  av_frame_unref(filt_frame);
272  }
273  av_frame_unref(frame);
274  }
275  }
276  av_packet_unref(&packet);
277  }
278 end:
279  avfilter_graph_free(&filter_graph);
280  avcodec_free_context(&dec_ctx);
281  avformat_close_input(&fmt_ctx);
282  av_frame_free(&frame);
283  av_frame_free(&filt_frame);
284 
285  if (ret < 0 && ret != AVERROR_EOF) {
286  fprintf(stderr, "Error occurred: %s\n", av_err2str(ret));
287  exit(1);
288  }
289 
290  exit(0);
291 }
#define NULL
Definition: coverity.c:32
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
AVFilterGraph * avfilter_graph_alloc(void)
Allocate a filter graph.
Definition: avfiltergraph.c:83
Memory buffer source API.
int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx)
Check validity and configure all the links and formats in the graph.
void avfilter_inout_free(AVFilterInOut **inout)
Free the supplied list of AVFilterInOut and set *inout to NULL.
Definition: graphparser.c:203
struct AVFilterInOut * next
next input/input in the list, NULL if this is the last
Definition: avfilter.h:1014
#define av_opt_set_int_list(obj, name, val, term, flags)
Set a binary option to an integer list.
Definition: opt.h:708
const char * filter_descr
int num
Numerator.
Definition: rational.h:59
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel...
Definition: avcodec.h:1944
void avfilter_graph_free(AVFilterGraph **graph)
Free a graph, destroy its links, and set *graph to NULL.
Keep a reference to the frame.
Definition: buffersrc.h:53
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1775
int avformat_open_input(AVFormatContext **ps, const char *url, ff_const59 AVInputFormat *fmt, AVDictionary **options)
Open an input stream and read the header.
Definition: utils.c:537
AVCodec.
Definition: avcodec.h:3481
Format I/O context.
Definition: avformat.h:1358
memory buffer sink API for audio and video
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:346
uint8_t
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:189
AVOptions.
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
static int64_t last_pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:388
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1426
int avcodec_parameters_to_context(AVCodecContext *codec, const AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
Definition: utils.c:2096
int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt, const char *name, const char *args, void *opaque, AVFilterGraph *graph_ctx)
Create and add a filter instance into an existing graph.
#define AVERROR_EOF
End of file.
Definition: error.h:55
int main(int argc, char **argv)
#define av_log(a,...)
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
int av_find_best_stream(AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, AVCodec **decoder_ret, int flags)
Find the "best" stream in the file.
Definition: utils.c:4192
int width
Definition: frame.h:353
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVFilterContext * buffersrc_ctx
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder.
Definition: decode.c:740
static int video_stream_index
const AVFilter * avfilter_get_by_name(const char *name)
Get a filter definition matching the given name.
Definition: allfilters.c:486
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:156
#define AV_OPT_SEARCH_CHILDREN
Search in possible children of the given object first.
Definition: opt.h:556
int width
picture width / height.
Definition: avcodec.h:1738
#define av_err2str(errnum)
Convenience macro, the return value should be used only directly in function arguments but never stan...
Definition: error.h:119
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
AVFilterContext * filter_ctx
filter context associated to this input/output
Definition: avfilter.h:1008
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
A linked-list of the inputs/outputs of the filter chain.
Definition: avfilter.h:1003
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
Definition: decode.c:677
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:251
Libavcodec external API header.
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer...
Definition: options.c:171
#define AV_TIME_BASE_Q
Internal time base represented as fractional value.
Definition: avutil.h:260
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:326
AVFilterGraph * filter_graph
main external API structure.
Definition: avcodec.h:1565
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:599
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
Filter definition.
Definition: avfilter.h:144
static int open_input_file(const char *filename)
int pad_idx
index of the filt_ctx pad to use for linking
Definition: avfilter.h:1011
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: utils.c:542
#define snprintf
Definition: snprintf.h:34
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
Definition: frame.h:559
int av_read_frame(AVFormatContext *s, AVPacket *pkt)
Return the next frame of a stream.
Definition: utils.c:1768
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:275
AVFilterContext * buffersink_ctx
char * name
unique name for this input/output in the list
Definition: avfilter.h:1005
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:553
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:309
static int init_filters(const char *filters_descr)
Main libavformat public API header.
Y , 8bpp.
Definition: pixfmt.h:74
AVFilterInOut * avfilter_inout_alloc(void)
Allocate a single AVFilterInOut entry.
Definition: graphparser.c:198
int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options)
Read packets of a media file to get stream information.
Definition: utils.c:3573
int den
Denominator.
Definition: rational.h:60
int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
Add a frame to the buffer source.
Definition: buffersrc.c:158
void avformat_close_input(AVFormatContext **s)
Close an opened input AVFormatContext.
Definition: utils.c:4437
int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters, AVFilterInOut **inputs, AVFilterInOut **outputs, void *log_ctx)
Add a graph described by a string to a graph.
Definition: graphparser.c:538
An instance of a filter.
Definition: avfilter.h:338
static void display_frame(const AVFrame *frame, AVRational time_base)
int height
Definition: frame.h:353
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1028
static AVFormatContext * fmt_ctx
int stream_index
Definition: avcodec.h:1479
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:910
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
static AVCodecContext * dec_ctx
int attribute_align_arg av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame)
Get a frame with filtered data from sink and put it in frame.
Definition: buffersink.c:67
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
This structure stores compressed data.
Definition: avcodec.h:1454
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248