FFmpeg
decode_filter_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 decode_filter_video.c
28  */
29 
30 #include <stdio.h>
31 #include <stdlib.h>
32 
33 #include <libavcodec/avcodec.h>
34 #include <libavformat/avformat.h>
35 #include <libavfilter/buffersink.h>
36 #include <libavfilter/buffersrc.h>
37 #include <libavutil/mem.h>
38 #include <libavutil/opt.h>
39 #include <libavutil/time.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;
53 
54 static int open_input_file(const char *filename)
55 {
56  const AVCodec *dec;
57  int ret;
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 */
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 */
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");
101 
103  if (!outputs || !inputs || !filter_graph) {
104  ret = AVERROR(ENOMEM);
105  goto end;
106  }
107 
108  /* buffer video source: the decoded frames from the decoder will be inserted here. */
109  snprintf(args, sizeof(args),
110  "video_size=%dx%d:pix_fmt=%d:time_base=%d/%d:pixel_aspect=%d/%d",
112  time_base.num, time_base.den,
114 
115  ret = avfilter_graph_create_filter(&buffersrc_ctx, buffersrc, "in",
116  args, NULL, filter_graph);
117  if (ret < 0) {
118  av_log(NULL, AV_LOG_ERROR, "Cannot create buffer source\n");
119  goto end;
120  }
121 
122  /* buffer video sink: to terminate the filter chain. */
124  if (!buffersink_ctx) {
125  av_log(NULL, AV_LOG_ERROR, "Cannot create buffer sink\n");
126  ret = AVERROR(ENOMEM);
127  goto end;
128  }
129 
130  ret = av_opt_set(buffersink_ctx, "pixel_formats", "gray8",
132  if (ret < 0) {
133  av_log(NULL, AV_LOG_ERROR, "Cannot set output pixel format\n");
134  goto end;
135  }
136 
138  if (ret < 0) {
139  av_log(NULL, AV_LOG_ERROR, "Cannot initialize buffer sink\n");
140  goto end;
141  }
142 
143  /*
144  * Set the endpoints for the filter graph. The filter_graph will
145  * be linked to the graph described by filters_descr.
146  */
147 
148  /*
149  * The buffer source output must be connected to the input pad of
150  * the first filter described by filters_descr; since the first
151  * filter input label is not specified, it is set to "in" by
152  * default.
153  */
154  outputs->name = av_strdup("in");
155  outputs->filter_ctx = buffersrc_ctx;
156  outputs->pad_idx = 0;
157  outputs->next = NULL;
158 
159  /*
160  * The buffer sink input must be connected to the output pad of
161  * the last filter described by filters_descr; since the last
162  * filter output label is not specified, it is set to "out" by
163  * default.
164  */
165  inputs->name = av_strdup("out");
166  inputs->filter_ctx = buffersink_ctx;
167  inputs->pad_idx = 0;
168  inputs->next = NULL;
169 
170  if ((ret = avfilter_graph_parse_ptr(filter_graph, filters_descr,
171  &inputs, &outputs, NULL)) < 0)
172  goto end;
173 
175  goto end;
176 
177 end:
180 
181  return ret;
182 }
183 
184 static void display_frame(const AVFrame *frame, AVRational time_base)
185 {
186  int x, y;
187  uint8_t *p0, *p;
188  int64_t delay;
189 
190  if (frame->pts != AV_NOPTS_VALUE) {
191  if (last_pts != AV_NOPTS_VALUE) {
192  /* sleep roughly the right amount of time;
193  * usleep is in microseconds, just like AV_TIME_BASE. */
194  delay = av_rescale_q(frame->pts - last_pts,
195  time_base, AV_TIME_BASE_Q);
196  if (delay > 0 && delay < 1000000)
197  av_usleep(delay);
198  }
199  last_pts = frame->pts;
200  }
201 
202  /* Trivial ASCII grayscale display. */
203  p0 = frame->data[0];
204  puts("\033c");
205  for (y = 0; y < frame->height; y++) {
206  p = p0;
207  for (x = 0; x < frame->width; x++)
208  putchar(" .-+#"[*(p++) / 52]);
209  putchar('\n');
210  p0 += frame->linesize[0];
211  }
212  fflush(stdout);
213 }
214 
215 int main(int argc, char **argv)
216 {
217  int ret;
218  AVPacket *packet;
219  AVFrame *frame;
220  AVFrame *filt_frame;
221 
222  if (argc != 2) {
223  fprintf(stderr, "Usage: %s file\n", argv[0]);
224  exit(1);
225  }
226 
227  frame = av_frame_alloc();
228  filt_frame = av_frame_alloc();
229  packet = av_packet_alloc();
230  if (!frame || !filt_frame || !packet) {
231  fprintf(stderr, "Could not allocate frame or packet\n");
232  exit(1);
233  }
234 
235  if ((ret = open_input_file(argv[1])) < 0)
236  goto end;
237  if ((ret = init_filters(filter_descr)) < 0)
238  goto end;
239 
240  /* read all packets */
241  while (1) {
242  if ((ret = av_read_frame(fmt_ctx, packet)) < 0)
243  break;
244 
245  if (packet->stream_index == video_stream_index) {
246  ret = avcodec_send_packet(dec_ctx, packet);
247  if (ret < 0) {
248  av_log(NULL, AV_LOG_ERROR, "Error while sending a packet to the decoder\n");
249  break;
250  }
251 
252  while (ret >= 0) {
254  if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF) {
255  break;
256  } else if (ret < 0) {
257  av_log(NULL, AV_LOG_ERROR, "Error while receiving a frame from the decoder\n");
258  goto end;
259  }
260 
261  frame->pts = frame->best_effort_timestamp;
262 
263  /* push the decoded frame into the filtergraph */
265  av_log(NULL, AV_LOG_ERROR, "Error while feeding the filtergraph\n");
266  break;
267  }
268 
269  /* pull filtered frames from the filtergraph */
270  while (1) {
272  if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
273  break;
274  if (ret < 0)
275  goto end;
276  display_frame(filt_frame, buffersink_ctx->inputs[0]->time_base);
277  av_frame_unref(filt_frame);
278  }
280  }
281  }
282  av_packet_unref(packet);
283  }
284  if (ret == AVERROR_EOF) {
285  /* signal EOF to the filtergraph */
287  av_log(NULL, AV_LOG_ERROR, "Error while closing the filtergraph\n");
288  goto end;
289  }
290 
291  /* pull remaining frames from the filtergraph */
292  while (1) {
294  if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
295  break;
296  if (ret < 0)
297  goto end;
298  display_frame(filt_frame, buffersink_ctx->inputs[0]->time_base);
299  av_frame_unref(filt_frame);
300  }
301  }
302 
303 end:
308  av_frame_free(&filt_frame);
309  av_packet_free(&packet);
310 
311  if (ret < 0 && ret != AVERROR_EOF) {
312  fprintf(stderr, "Error occurred: %s\n", av_err2str(ret));
313  exit(1);
314  }
315 
316  exit(0);
317 }
AV_OPT_SEARCH_CHILDREN
#define AV_OPT_SEARCH_CHILDREN
Search in possible children of the given object first.
Definition: opt.h:605
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: packet.c:433
AVCodec
AVCodec.
Definition: codec.h:172
fmt_ctx
static AVFormatContext * fmt_ctx
Definition: decode_filter_video.c:46
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_find_best_stream
int av_find_best_stream(AVFormatContext *ic, enum AVMediaType type, int wanted_stream_nb, int related_stream, const AVCodec **decoder_ret, int flags)
Definition: avformat.c:376
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
filter_descr
const char * filter_descr
Definition: decode_filter_video.c:41
AV_TIME_BASE_Q
#define AV_TIME_BASE_Q
Internal time base represented as fractional value.
Definition: avutil.h:263
int64_t
long long int64_t
Definition: coverity.c:34
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:63
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:427
AVFormatContext::streams
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1332
av_read_frame
int av_read_frame(AVFormatContext *s, AVPacket *pkt)
Return the next frame of a stream.
Definition: demux.c:1534
av_packet_free
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
Definition: packet.c:75
avfilter_graph_free
void avfilter_graph_free(AVFilterGraph **graph)
Free a graph, destroy its links, and set *graph to NULL.
Definition: avfiltergraph.c:119
avformat_close_input
void avformat_close_input(AVFormatContext **s)
Close an opened input AVFormatContext.
Definition: demux.c:367
avfilter_graph_create_filter
int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt, const char *name, const char *args, void *opaque, AVFilterGraph *graph_ctx)
A convenience wrapper that allocates and initializes a filter in a single step.
Definition: avfiltergraph.c:140
avfilter_graph_alloc_filter
AVFilterContext * avfilter_graph_alloc_filter(AVFilterGraph *graph, const AVFilter *filter, const char *name)
Create a new filter instance in a filter graph.
Definition: avfiltergraph.c:167
avfilter_graph_alloc
AVFilterGraph * avfilter_graph_alloc(void)
Allocate a filter graph.
Definition: avfiltergraph.c:85
filter_graph
AVFilterGraph * filter_graph
Definition: decode_filter_video.c:50
av_opt_set
int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
Definition: opt.c:835
main
int main(int argc, char **argv)
Definition: decode_filter_video.c:215
AVRational::num
int num
Numerator.
Definition: rational.h:59
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:51
avfilter_inout_free
void avfilter_inout_free(AVFilterInOut **inout)
Free the supplied list of AVFilterInOut and set *inout to NULL.
Definition: graphparser.c:76
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:210
avformat_open_input
int avformat_open_input(AVFormatContext **ps, const char *url, const AVInputFormat *fmt, AVDictionary **options)
Open an input stream and read the header.
Definition: demux.c:217
avcodec_alloc_context3
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:149
open_input_file
static int open_input_file(const char *filename)
Definition: decode_filter_video.c:54
av_buffersink_get_frame
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:89
avcodec_receive_frame
int attribute_align_arg avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder or encoder (when the AV_CODEC_FLAG_RECON_FRAME flag is used...
Definition: avcodec.c:708
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
video_stream_index
static int video_stream_index
Definition: decode_filter_video.c:51
AVFormatContext
Format I/O context.
Definition: avformat.h:1264
avfilter_get_by_name
const AVFilter * avfilter_get_by_name(const char *name)
Get a filter definition matching the given name.
Definition: allfilters.c:645
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:767
avcodec_parameters_to_context
int avcodec_parameters_to_context(AVCodecContext *codec, const struct AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
avfilter_graph_config
int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx)
Check validity and configure all the links and formats in the graph.
Definition: avfiltergraph.c:1359
AVStream::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avformat.h:783
NULL
#define NULL
Definition: coverity.c:32
avcodec_free_context
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:164
dec_ctx
static AVCodecContext * dec_ctx
Definition: decode_filter_video.c:47
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVFilterContext::inputs
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:277
avfilter_inout_alloc
AVFilterInOut * avfilter_inout_alloc(void)
Allocate a single AVFilterInOut entry.
Definition: graphparser.c:71
display_frame
static void display_frame(const AVFrame *frame, AVRational time_base)
Definition: decode_filter_video.c:184
avcodec_open2
int attribute_align_arg avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: avcodec.c:145
time.h
AVFilterGraph
Definition: avfilter.h:582
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:244
avformat_find_stream_info
int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options)
Read packets of a media file to get stream information.
Definition: demux.c:2512
init_filters
static int init_filters(const char *filters_descr)
Definition: decode_filter_video.c:92
av_err2str
#define av_err2str(errnum)
Convenience macro, the return value should be used only directly in function arguments but never stan...
Definition: error.h:122
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:247
AV_BUFFERSRC_FLAG_KEEP_REF
@ AV_BUFFERSRC_FLAG_KEEP_REF
Keep a reference to the frame.
Definition: buffersrc.h:53
av_packet_alloc
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: packet.c:64
buffersink.h
avcodec_send_packet
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
Definition: decode.c:702
avfilter_graph_parse_ptr
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:920
av_buffersrc_add_frame_flags
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:204
av_frame_unref
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:494
AVFilterPad::name
const char * name
Pad name.
Definition: filters.h:45
last_pts
static int64_t last_pts
Definition: decode_filter_video.c:52
AVCodecContext::height
int height
Definition: avcodec.h:592
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:631
outputs
static const AVFilterPad outputs[]
Definition: af_aap.c:310
avcodec.h
AVFilter
Filter definition.
Definition: avfilter.h:211
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:265
avformat.h
buffersrc_ctx
AVFilterContext * buffersrc_ctx
Definition: decode_filter_video.c:49
AVCodecContext
main external API structure.
Definition: avcodec.h:431
avfilter_init_dict
int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options)
Initialize a filter with the supplied dictionary of options.
Definition: avfilter.c:913
AVRational::den
int den
Denominator.
Definition: rational.h:60
AVPacket::stream_index
int stream_index
Definition: packet.h:560
AVFilterContext
An instance of a filter.
Definition: avfilter.h:269
av_strdup
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:272
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:200
mem.h
AVPacket
This structure stores compressed data.
Definition: packet.h:535
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:592
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
buffersink_ctx
AVFilterContext * buffersink_ctx
Definition: decode_filter_video.c:48
AVFilterInOut
A linked-list of the inputs/outputs of the filter chain.
Definition: avfilter.h:739
snprintf
#define snprintf
Definition: snprintf.h:34
buffersrc.h
AVCodecContext::sample_aspect_ratio
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:616