e6624076cfe91f7fa0f403d3999e088e4a46d007
[ffmpeg.git] / doc / examples / demuxing_decoding.c
1 /*
2  * Copyright (c) 2012 Stefano Sabatini
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22
23 /**
24  * @file
25  * Demuxing and decoding example.
26  *
27  * Show how to use the libavformat and libavcodec API to demux and
28  * decode audio and video data.
29  * @example demuxing_decoding.c
30  */
31
32 #include <libavutil/imgutils.h>
33 #include <libavutil/samplefmt.h>
34 #include <libavutil/timestamp.h>
35 #include <libavformat/avformat.h>
36
37 static AVFormatContext *fmt_ctx = NULL;
38 static AVCodecContext *video_dec_ctx = NULL, *audio_dec_ctx;
39 static int width, height;
40 static enum AVPixelFormat pix_fmt;
41 static AVStream *video_stream = NULL, *audio_stream = NULL;
42 static const char *src_filename = NULL;
43 static const char *video_dst_filename = NULL;
44 static const char *audio_dst_filename = NULL;
45 static FILE *video_dst_file = NULL;
46 static FILE *audio_dst_file = NULL;
47
48 static uint8_t *video_dst_data[4] = {NULL};
49 static int      video_dst_linesize[4];
50 static int video_dst_bufsize;
51
52 static int video_stream_idx = -1, audio_stream_idx = -1;
53 static AVFrame *frame = NULL;
54 static AVPacket pkt;
55 static int video_frame_count = 0;
56 static int audio_frame_count = 0;
57
58 /* Enable or disable frame reference counting. You are not supposed to support
59  * both paths in your application but pick the one most appropriate to your
60  * needs. Look for the use of refcount in this example to see what are the
61  * differences of API usage between them. */
62 static int refcount = 0;
63
64 static int decode_packet(int *got_frame, int cached)
65 {
66     int ret = 0;
67     int decoded = pkt.size;
68
69     *got_frame = 0;
70
71     if (pkt.stream_index == video_stream_idx) {
72         /* decode video frame */
73         ret = avcodec_decode_video2(video_dec_ctx, frame, got_frame, &pkt);
74         if (ret < 0) {
75             fprintf(stderr, "Error decoding video frame (%s)\n", av_err2str(ret));
76             return ret;
77         }
78
79         if (*got_frame) {
80
81             if (frame->width != width || frame->height != height ||
82                 frame->format != pix_fmt) {
83                 /* To handle this change, one could call av_image_alloc again and
84                  * decode the following frames into another rawvideo file. */
85                 fprintf(stderr, "Error: Width, height and pixel format have to be "
86                         "constant in a rawvideo file, but the width, height or "
87                         "pixel format of the input video changed:\n"
88                         "old: width = %d, height = %d, format = %s\n"
89                         "new: width = %d, height = %d, format = %s\n",
90                         width, height, av_get_pix_fmt_name(pix_fmt),
91                         frame->width, frame->height,
92                         av_get_pix_fmt_name(frame->format));
93                 return -1;
94             }
95
96             printf("video_frame%s n:%d coded_n:%d pts:%s\n",
97                    cached ? "(cached)" : "",
98                    video_frame_count++, frame->coded_picture_number,
99                    av_ts2timestr(frame->pts, &video_dec_ctx->time_base));
100
101             /* copy decoded frame to destination buffer:
102              * this is required since rawvideo expects non aligned data */
103             av_image_copy(video_dst_data, video_dst_linesize,
104                           (const uint8_t **)(frame->data), frame->linesize,
105                           pix_fmt, width, height);
106
107             /* write to rawvideo file */
108             fwrite(video_dst_data[0], 1, video_dst_bufsize, video_dst_file);
109         }
110     } else if (pkt.stream_index == audio_stream_idx) {
111         /* decode audio frame */
112         ret = avcodec_decode_audio4(audio_dec_ctx, frame, got_frame, &pkt);
113         if (ret < 0) {
114             fprintf(stderr, "Error decoding audio frame (%s)\n", av_err2str(ret));
115             return ret;
116         }
117         /* Some audio decoders decode only part of the packet, and have to be
118          * called again with the remainder of the packet data.
119          * Sample: fate-suite/lossless-audio/luckynight-partial.shn
120          * Also, some decoders might over-read the packet. */
121         decoded = FFMIN(ret, pkt.size);
122
123         if (*got_frame) {
124             size_t unpadded_linesize = frame->nb_samples * av_get_bytes_per_sample(frame->format);
125             printf("audio_frame%s n:%d nb_samples:%d pts:%s\n",
126                    cached ? "(cached)" : "",
127                    audio_frame_count++, frame->nb_samples,
128                    av_ts2timestr(frame->pts, &audio_dec_ctx->time_base));
129
130             /* Write the raw audio data samples of the first plane. This works
131              * fine for packed formats (e.g. AV_SAMPLE_FMT_S16). However,
132              * most audio decoders output planar audio, which uses a separate
133              * plane of audio samples for each channel (e.g. AV_SAMPLE_FMT_S16P).
134              * In other words, this code will write only the first audio channel
135              * in these cases.
136              * You should use libswresample or libavfilter to convert the frame
137              * to packed data. */
138             fwrite(frame->extended_data[0], 1, unpadded_linesize, audio_dst_file);
139         }
140     }
141
142     /* If we use frame reference counting, we own the data and need
143      * to de-reference it when we don't use it anymore */
144     if (*got_frame && refcount)
145         av_frame_unref(frame);
146
147     return decoded;
148 }
149
150 static int open_codec_context(int *stream_idx,
151                               AVFormatContext *fmt_ctx, enum AVMediaType type)
152 {
153     int ret, stream_index;
154     AVStream *st;
155     AVCodecContext *dec_ctx = NULL;
156     AVCodec *dec = NULL;
157     AVDictionary *opts = NULL;
158
159     ret = av_find_best_stream(fmt_ctx, type, -1, -1, NULL, 0);
160     if (ret < 0) {
161         fprintf(stderr, "Could not find %s stream in input file '%s'\n",
162                 av_get_media_type_string(type), src_filename);
163         return ret;
164     } else {
165         stream_index = ret;
166         st = fmt_ctx->streams[stream_index];
167
168         /* find decoder for the stream */
169         dec_ctx = st->codec;
170         dec = avcodec_find_decoder(dec_ctx->codec_id);
171         if (!dec) {
172             fprintf(stderr, "Failed to find %s codec\n",
173                     av_get_media_type_string(type));
174             return AVERROR(EINVAL);
175         }
176
177         /* Init the decoders, with or without reference counting */
178         av_dict_set(&opts, "refcounted_frames", refcount ? "1" : "0", 0);
179         if ((ret = avcodec_open2(dec_ctx, dec, &opts)) < 0) {
180             fprintf(stderr, "Failed to open %s codec\n",
181                     av_get_media_type_string(type));
182             return ret;
183         }
184         *stream_idx = stream_index;
185     }
186
187     return 0;
188 }
189
190 static int get_format_from_sample_fmt(const char **fmt,
191                                       enum AVSampleFormat sample_fmt)
192 {
193     int i;
194     struct sample_fmt_entry {
195         enum AVSampleFormat sample_fmt; const char *fmt_be, *fmt_le;
196     } sample_fmt_entries[] = {
197         { AV_SAMPLE_FMT_U8,  "u8",    "u8"    },
198         { AV_SAMPLE_FMT_S16, "s16be", "s16le" },
199         { AV_SAMPLE_FMT_S32, "s32be", "s32le" },
200         { AV_SAMPLE_FMT_FLT, "f32be", "f32le" },
201         { AV_SAMPLE_FMT_DBL, "f64be", "f64le" },
202     };
203     *fmt = NULL;
204
205     for (i = 0; i < FF_ARRAY_ELEMS(sample_fmt_entries); i++) {
206         struct sample_fmt_entry *entry = &sample_fmt_entries[i];
207         if (sample_fmt == entry->sample_fmt) {
208             *fmt = AV_NE(entry->fmt_be, entry->fmt_le);
209             return 0;
210         }
211     }
212
213     fprintf(stderr,
214             "sample format %s is not supported as output format\n",
215             av_get_sample_fmt_name(sample_fmt));
216     return -1;
217 }
218
219 int main (int argc, char **argv)
220 {
221     int ret = 0, got_frame;
222
223     if (argc != 4 && argc != 5) {
224         fprintf(stderr, "usage: %s [-refcount] input_file video_output_file audio_output_file\n"
225                 "API example program to show how to read frames from an input file.\n"
226                 "This program reads frames from a file, decodes them, and writes decoded\n"
227                 "video frames to a rawvideo file named video_output_file, and decoded\n"
228                 "audio frames to a rawaudio file named audio_output_file.\n\n"
229                 "If the -refcount option is specified, the program use the\n"
230                 "reference counting frame system which allows keeping a copy of\n"
231                 "the data for longer than one decode call.\n"
232                 "\n", argv[0]);
233         exit(1);
234     }
235     if (argc == 5 && !strcmp(argv[1], "-refcount")) {
236         refcount = 1;
237         argv++;
238     }
239     src_filename = argv[1];
240     video_dst_filename = argv[2];
241     audio_dst_filename = argv[3];
242
243     /* register all formats and codecs */
244     av_register_all();
245
246     /* open input file, and allocate format context */
247     if (avformat_open_input(&fmt_ctx, src_filename, NULL, NULL) < 0) {
248         fprintf(stderr, "Could not open source file %s\n", src_filename);
249         exit(1);
250     }
251
252     /* retrieve stream information */
253     if (avformat_find_stream_info(fmt_ctx, NULL) < 0) {
254         fprintf(stderr, "Could not find stream information\n");
255         exit(1);
256     }
257
258     if (open_codec_context(&video_stream_idx, fmt_ctx, AVMEDIA_TYPE_VIDEO) >= 0) {
259         video_stream = fmt_ctx->streams[video_stream_idx];
260         video_dec_ctx = video_stream->codec;
261
262         video_dst_file = fopen(video_dst_filename, "wb");
263         if (!video_dst_file) {
264             fprintf(stderr, "Could not open destination file %s\n", video_dst_filename);
265             ret = 1;
266             goto end;
267         }
268
269         /* allocate image where the decoded image will be put */
270         width = video_dec_ctx->width;
271         height = video_dec_ctx->height;
272         pix_fmt = video_dec_ctx->pix_fmt;
273         ret = av_image_alloc(video_dst_data, video_dst_linesize,
274                              width, height, pix_fmt, 1);
275         if (ret < 0) {
276             fprintf(stderr, "Could not allocate raw video buffer\n");
277             goto end;
278         }
279         video_dst_bufsize = ret;
280     }
281
282     if (open_codec_context(&audio_stream_idx, fmt_ctx, AVMEDIA_TYPE_AUDIO) >= 0) {
283         audio_stream = fmt_ctx->streams[audio_stream_idx];
284         audio_dec_ctx = audio_stream->codec;
285         audio_dst_file = fopen(audio_dst_filename, "wb");
286         if (!audio_dst_file) {
287             fprintf(stderr, "Could not open destination file %s\n", audio_dst_filename);
288             ret = 1;
289             goto end;
290         }
291     }
292
293     /* dump input information to stderr */
294     av_dump_format(fmt_ctx, 0, src_filename, 0);
295
296     if (!audio_stream && !video_stream) {
297         fprintf(stderr, "Could not find audio or video stream in the input, aborting\n");
298         ret = 1;
299         goto end;
300     }
301
302     frame = av_frame_alloc();
303     if (!frame) {
304         fprintf(stderr, "Could not allocate frame\n");
305         ret = AVERROR(ENOMEM);
306         goto end;
307     }
308
309     /* initialize packet, set data to NULL, let the demuxer fill it */
310     av_init_packet(&pkt);
311     pkt.data = NULL;
312     pkt.size = 0;
313
314     if (video_stream)
315         printf("Demuxing video from file '%s' into '%s'\n", src_filename, video_dst_filename);
316     if (audio_stream)
317         printf("Demuxing audio from file '%s' into '%s'\n", src_filename, audio_dst_filename);
318
319     /* read frames from the file */
320     while (av_read_frame(fmt_ctx, &pkt) >= 0) {
321         AVPacket orig_pkt = pkt;
322         do {
323             ret = decode_packet(&got_frame, 0);
324             if (ret < 0)
325                 break;
326             pkt.data += ret;
327             pkt.size -= ret;
328         } while (pkt.size > 0);
329         av_free_packet(&orig_pkt);
330     }
331
332     /* flush cached frames */
333     pkt.data = NULL;
334     pkt.size = 0;
335     do {
336         decode_packet(&got_frame, 1);
337     } while (got_frame);
338
339     printf("Demuxing succeeded.\n");
340
341     if (video_stream) {
342         printf("Play the output video file with the command:\n"
343                "ffplay -f rawvideo -pix_fmt %s -video_size %dx%d %s\n",
344                av_get_pix_fmt_name(pix_fmt), width, height,
345                video_dst_filename);
346     }
347
348     if (audio_stream) {
349         enum AVSampleFormat sfmt = audio_dec_ctx->sample_fmt;
350         int n_channels = audio_dec_ctx->channels;
351         const char *fmt;
352
353         if (av_sample_fmt_is_planar(sfmt)) {
354             const char *packed = av_get_sample_fmt_name(sfmt);
355             printf("Warning: the sample format the decoder produced is planar "
356                    "(%s). This example will output the first channel only.\n",
357                    packed ? packed : "?");
358             sfmt = av_get_packed_sample_fmt(sfmt);
359             n_channels = 1;
360         }
361
362         if ((ret = get_format_from_sample_fmt(&fmt, sfmt)) < 0)
363             goto end;
364
365         printf("Play the output audio file with the command:\n"
366                "ffplay -f %s -ac %d -ar %d %s\n",
367                fmt, n_channels, audio_dec_ctx->sample_rate,
368                audio_dst_filename);
369     }
370
371 end:
372     avcodec_close(video_dec_ctx);
373     avcodec_close(audio_dec_ctx);
374     avformat_close_input(&fmt_ctx);
375     if (video_dst_file)
376         fclose(video_dst_file);
377     if (audio_dst_file)
378         fclose(audio_dst_file);
379     av_frame_free(&frame);
380     av_free(video_dst_data[0]);
381
382     return ret < 0;
383 }