examples/muxing: check on frame
[ffmpeg.git] / doc / examples / muxing.c
1 /*
2  * Copyright (c) 2003 Fabrice Bellard
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  * libavformat API example.
26  *
27  * Output a media file in any supported libavformat format.
28  * The default codecs are used.
29  */
30
31 #include <stdlib.h>
32 #include <stdio.h>
33 #include <string.h>
34 #include <math.h>
35
36 #include <libavutil/mathematics.h>
37 #include <libavformat/avformat.h>
38 #include <libswscale/swscale.h>
39
40 /* 5 seconds stream duration */
41 #define STREAM_DURATION   200.0
42 #define STREAM_FRAME_RATE 25 /* 25 images/s */
43 #define STREAM_NB_FRAMES  ((int)(STREAM_DURATION * STREAM_FRAME_RATE))
44 #define STREAM_PIX_FMT    AV_PIX_FMT_YUV420P /* default pix_fmt */
45
46 static int sws_flags = SWS_BICUBIC;
47
48 /**************************************************************/
49 /* audio output */
50
51 static float t, tincr, tincr2;
52 static int16_t *samples;
53 static int audio_input_frame_size;
54
55 /*
56  * add an audio output stream
57  */
58 static AVStream *add_audio_stream(AVFormatContext *oc, AVCodec **codec,
59                                   enum AVCodecID codec_id)
60 {
61     AVCodecContext *c;
62     AVStream *st;
63
64     /* find the audio encoder */
65     *codec = avcodec_find_encoder(codec_id);
66     if (!(*codec)) {
67         fprintf(stderr, "Could not find codec\n");
68         exit(1);
69     }
70
71     st = avformat_new_stream(oc, *codec);
72     if (!st) {
73         fprintf(stderr, "Could not allocate stream\n");
74         exit(1);
75     }
76     st->id = oc->nb_streams-1;
77     c = st->codec;
78
79     /* put sample parameters */
80     c->sample_fmt  = AV_SAMPLE_FMT_S16;
81     c->bit_rate    = 64000;
82     c->sample_rate = 44100;
83     c->channels    = 2;
84
85     // some formats want stream headers to be separate
86     if (oc->oformat->flags & AVFMT_GLOBALHEADER)
87         c->flags |= CODEC_FLAG_GLOBAL_HEADER;
88
89     return st;
90 }
91
92 static void open_audio(AVFormatContext *oc, AVCodec *codec, AVStream *st)
93 {
94     AVCodecContext *c;
95
96     c = st->codec;
97
98     /* open it */
99     if (avcodec_open2(c, codec, NULL) < 0) {
100         fprintf(stderr, "Could not open audio codec\n");
101         exit(1);
102     }
103
104     /* init signal generator */
105     t     = 0;
106     tincr = 2 * M_PI * 110.0 / c->sample_rate;
107     /* increment frequency by 110 Hz per second */
108     tincr2 = 2 * M_PI * 110.0 / c->sample_rate / c->sample_rate;
109
110     if (c->codec->capabilities & CODEC_CAP_VARIABLE_FRAME_SIZE)
111         audio_input_frame_size = 10000;
112     else
113         audio_input_frame_size = c->frame_size;
114     samples = av_malloc(audio_input_frame_size *
115                         av_get_bytes_per_sample(c->sample_fmt) *
116                         c->channels);
117     if (!samples) {
118         fprintf(stderr, "Could not allocate audio samples buffer\n");
119         exit(1);
120     }
121 }
122
123 /* Prepare a 16 bit dummy audio frame of 'frame_size' samples and
124  * 'nb_channels' channels. */
125 static void get_audio_frame(int16_t *samples, int frame_size, int nb_channels)
126 {
127     int j, i, v;
128     int16_t *q;
129
130     q = samples;
131     for (j = 0; j < frame_size; j++) {
132         v = (int)(sin(t) * 10000);
133         for (i = 0; i < nb_channels; i++)
134             *q++ = v;
135         t     += tincr;
136         tincr += tincr2;
137     }
138 }
139
140 static void write_audio_frame(AVFormatContext *oc, AVStream *st)
141 {
142     AVCodecContext *c;
143     AVPacket pkt = { 0 }; // data and size must be 0;
144     AVFrame *frame = avcodec_alloc_frame();
145     int got_packet, ret;
146
147     av_init_packet(&pkt);
148     c = st->codec;
149
150     get_audio_frame(samples, audio_input_frame_size, c->channels);
151     frame->nb_samples = audio_input_frame_size;
152     avcodec_fill_audio_frame(frame, c->channels, c->sample_fmt,
153                              (uint8_t *)samples,
154                              audio_input_frame_size *
155                              av_get_bytes_per_sample(c->sample_fmt) *
156                              c->channels, 1);
157
158     ret = avcodec_encode_audio2(c, &pkt, frame, &got_packet);
159     if (ret < 0) {
160         fprintf(stderr, "Error encoding audio frame\n");
161         exit(1);
162     }
163
164     if (!got_packet)
165         return;
166
167     pkt.stream_index = st->index;
168
169     /* Write the compressed frame to the media file. */
170     if (av_interleaved_write_frame(oc, &pkt) != 0) {
171         fprintf(stderr, "Error while writing audio frame\n");
172         exit(1);
173     }
174     avcodec_free_frame(&frame);
175 }
176
177 static void close_audio(AVFormatContext *oc, AVStream *st)
178 {
179     avcodec_close(st->codec);
180
181     av_free(samples);
182 }
183
184 /**************************************************************/
185 /* video output */
186
187 static AVFrame *frame;
188 static AVPicture src_picture, dst_picture;
189 static int frame_count;
190
191 /* Add a video output stream. */
192 static AVStream *add_video_stream(AVFormatContext *oc, AVCodec **codec,
193                                   enum AVCodecID codec_id)
194 {
195     AVCodecContext *c;
196     AVStream *st;
197
198     /* find the video encoder */
199     *codec = avcodec_find_encoder(codec_id);
200     if (!(*codec)) {
201         fprintf(stderr, "codec not found\n");
202         exit(1);
203     }
204
205     st = avformat_new_stream(oc, *codec);
206     if (!st) {
207         fprintf(stderr, "Could not alloc stream\n");
208         exit(1);
209     }
210     st->id = oc->nb_streams-1;
211     c = st->codec;
212
213     avcodec_get_context_defaults3(c, *codec);
214
215     c->codec_id = codec_id;
216
217     /* Put sample parameters. */
218     c->bit_rate = 400000;
219     /* Resolution must be a multiple of two. */
220     c->width    = 352;
221     c->height   = 288;
222     /* timebase: This is the fundamental unit of time (in seconds) in terms
223      * of which frame timestamps are represented. For fixed-fps content,
224      * timebase should be 1/framerate and timestamp increments should be
225      * identical to 1. */
226     c->time_base.den = STREAM_FRAME_RATE;
227     c->time_base.num = 1;
228     c->gop_size      = 12; /* emit one intra frame every twelve frames at most */
229     c->pix_fmt       = STREAM_PIX_FMT;
230     if (c->codec_id == AV_CODEC_ID_MPEG2VIDEO) {
231         /* just for testing, we also add B frames */
232         c->max_b_frames = 2;
233     }
234     if (c->codec_id == AV_CODEC_ID_MPEG1VIDEO) {
235         /* Needed to avoid using macroblocks in which some coeffs overflow.
236          * This does not happen with normal video, it just happens here as
237          * the motion of the chroma plane does not match the luma plane. */
238         c->mb_decision = 2;
239     }
240     /* Some formats want stream headers to be separate. */
241     if (oc->oformat->flags & AVFMT_GLOBALHEADER)
242         c->flags |= CODEC_FLAG_GLOBAL_HEADER;
243
244     return st;
245 }
246
247 static void open_video(AVFormatContext *oc, AVCodec *codec, AVStream *st)
248 {
249     int ret;
250     AVCodecContext *c = st->codec;
251
252     /* open the codec */
253     if (avcodec_open2(c, codec, NULL) < 0) {
254         fprintf(stderr, "Could not open video codec\n");
255         exit(1);
256     }
257
258     /* allocate and init a re-usable frame */
259     frame = avcodec_alloc_frame();
260     if (!frame) {
261         fprintf(stderr, "Could not allocate video frame\n");
262         exit(1);
263     }
264
265     /* Allocate the encoded raw picture. */
266     ret = avpicture_alloc(&dst_picture, c->pix_fmt, c->width, c->height);
267     if (ret < 0) {
268         fprintf(stderr, "Could not allocate picture\n");
269         exit(1);
270     }
271
272     /* If the output format is not YUV420P, then a temporary YUV420P
273      * picture is needed too. It is then converted to the required
274      * output format. */
275     if (c->pix_fmt != AV_PIX_FMT_YUV420P) {
276         ret = avpicture_alloc(&src_picture, AV_PIX_FMT_YUV420P, c->width, c->height);
277         if (ret < 0) {
278             fprintf(stderr, "Could not allocate temporary picture\n");
279             exit(1);
280         }
281     }
282
283     /* copy data and linesize picture pointers to frame */
284     *((AVPicture *)frame) = dst_picture;
285 }
286
287 /* Prepare a dummy image. */
288 static void fill_yuv_image(AVPicture *pict, int frame_index,
289                            int width, int height)
290 {
291     int x, y, i;
292
293     i = frame_index;
294
295     /* Y */
296     for (y = 0; y < height; y++)
297         for (x = 0; x < width; x++)
298             pict->data[0][y * pict->linesize[0] + x] = x + y + i * 3;
299
300     /* Cb and Cr */
301     for (y = 0; y < height / 2; y++) {
302         for (x = 0; x < width / 2; x++) {
303             pict->data[1][y * pict->linesize[1] + x] = 128 + y + i * 2;
304             pict->data[2][y * pict->linesize[2] + x] = 64 + x + i * 5;
305         }
306     }
307 }
308
309 static void write_video_frame(AVFormatContext *oc, AVStream *st)
310 {
311     int ret;
312     static struct SwsContext *sws_ctx;
313     AVCodecContext *c = st->codec;
314
315     if (frame_count >= STREAM_NB_FRAMES) {
316         /* No more frames to compress. The codec has a latency of a few
317          * frames if using B-frames, so we get the last frames by
318          * passing the same picture again. */
319     } else {
320         if (c->pix_fmt != AV_PIX_FMT_YUV420P) {
321             /* as we only generate a YUV420P picture, we must convert it
322              * to the codec pixel format if needed */
323             if (!sws_ctx) {
324                 sws_ctx = sws_getContext(c->width, c->height, AV_PIX_FMT_YUV420P,
325                                          c->width, c->height, c->pix_fmt,
326                                          sws_flags, NULL, NULL, NULL);
327                 if (!sws_ctx) {
328                     fprintf(stderr,
329                             "Could not initialize the conversion context\n");
330                     exit(1);
331                 }
332             }
333             fill_yuv_image(&src_picture, frame_count, c->width, c->height);
334             sws_scale(sws_ctx,
335                       (const uint8_t * const *)src_picture.data, src_picture.linesize,
336                       0, c->height, dst_picture.data, dst_picture.linesize);
337         } else {
338             fill_yuv_image(&dst_picture, frame_count, c->width, c->height);
339         }
340     }
341
342     if (oc->oformat->flags & AVFMT_RAWPICTURE) {
343         /* Raw video case - directly store the picture in the packet */
344         AVPacket pkt;
345         av_init_packet(&pkt);
346
347         pkt.flags        |= AV_PKT_FLAG_KEY;
348         pkt.stream_index  = st->index;
349         pkt.data          = dst_picture.data[0];
350         pkt.size          = sizeof(AVPicture);
351
352         ret = av_interleaved_write_frame(oc, &pkt);
353     } else {
354         /* encode the image */
355         AVPacket pkt;
356         int got_output;
357
358         av_init_packet(&pkt);
359         pkt.data = NULL;    // packet data will be allocated by the encoder
360         pkt.size = 0;
361
362         ret = avcodec_encode_video2(c, &pkt, frame, &got_output);
363         if (ret < 0) {
364             fprintf(stderr, "Error encoding video frame\n");
365             exit(1);
366         }
367
368         /* If size is zero, it means the image was buffered. */
369         if (got_output) {
370             if (c->coded_frame->key_frame)
371                 pkt.flags |= AV_PKT_FLAG_KEY;
372
373             pkt.stream_index = st->index;
374
375             /* Write the compressed frame to the media file. */
376             ret = av_interleaved_write_frame(oc, &pkt);
377         } else {
378             ret = 0;
379         }
380     }
381     if (ret != 0) {
382         fprintf(stderr, "Error while writing video frame\n");
383         exit(1);
384     }
385     frame_count++;
386 }
387
388 static void close_video(AVFormatContext *oc, AVStream *st)
389 {
390     avcodec_close(st->codec);
391     av_free(src_picture.data[0]);
392     av_free(dst_picture.data[0]);
393     av_free(frame);
394 }
395
396 /**************************************************************/
397 /* media file output */
398
399 int main(int argc, char **argv)
400 {
401     const char *filename;
402     AVOutputFormat *fmt;
403     AVFormatContext *oc;
404     AVStream *audio_st, *video_st;
405     AVCodec *audio_codec, *video_codec;
406     double audio_pts, video_pts;
407     int i;
408
409     /* Initialize libavcodec, and register all codecs and formats. */
410     av_register_all();
411
412     if (argc != 2) {
413         printf("usage: %s output_file\n"
414                "API example program to output a media file with libavformat.\n"
415                "This program generates a synthetic audio and video stream, encodes and\n"
416                "muxes them into a file named output_file.\n"
417                "The output format is automatically guessed according to the file extension.\n"
418                "Raw images can also be output by using '%%d' in the filename.\n"
419                "\n", argv[0]);
420         return 1;
421     }
422
423     filename = argv[1];
424
425     /* allocate the output media context */
426     avformat_alloc_output_context2(&oc, NULL, NULL, filename);
427     if (!oc) {
428         printf("Could not deduce output format from file extension: using MPEG.\n");
429         avformat_alloc_output_context2(&oc, NULL, "mpeg", filename);
430     }
431     if (!oc) {
432         return 1;
433     }
434     fmt = oc->oformat;
435
436     /* Add the audio and video streams using the default format codecs
437      * and initialize the codecs. */
438     video_st = NULL;
439     audio_st = NULL;
440     if (fmt->video_codec != AV_CODEC_ID_NONE) {
441         video_st = add_video_stream(oc, &video_codec, fmt->video_codec);
442     }
443     if (fmt->audio_codec != AV_CODEC_ID_NONE) {
444         audio_st = add_audio_stream(oc, &audio_codec, fmt->audio_codec);
445     }
446
447     /* Now that all the parameters are set, we can open the audio and
448      * video codecs and allocate the necessary encode buffers. */
449     if (video_st)
450         open_video(oc, video_codec, video_st);
451     if (audio_st)
452         open_audio(oc, audio_codec, audio_st);
453
454     av_dump_format(oc, 0, filename, 1);
455
456     /* open the output file, if needed */
457     if (!(fmt->flags & AVFMT_NOFILE)) {
458         if (avio_open(&oc->pb, filename, AVIO_FLAG_WRITE) < 0) {
459             fprintf(stderr, "Could not open '%s'\n", filename);
460             return 1;
461         }
462     }
463
464     /* Write the stream header, if any. */
465     if (avformat_write_header(oc, NULL) < 0) {
466         fprintf(stderr, "Error occurred when opening output file\n");
467         return 1;
468     }
469
470     if (frame)
471         frame->pts = 0;
472     for (;;) {
473         /* Compute current audio and video time. */
474         if (audio_st)
475             audio_pts = (double)audio_st->pts.val * audio_st->time_base.num / audio_st->time_base.den;
476         else
477             audio_pts = 0.0;
478
479         if (video_st)
480             video_pts = (double)video_st->pts.val * video_st->time_base.num /
481                         video_st->time_base.den;
482         else
483             video_pts = 0.0;
484
485         if ((!audio_st || audio_pts >= STREAM_DURATION) &&
486             (!video_st || video_pts >= STREAM_DURATION))
487             break;
488
489         /* write interleaved audio and video frames */
490         if (!video_st || (video_st && audio_st && audio_pts < video_pts)) {
491             write_audio_frame(oc, audio_st);
492         } else {
493             write_video_frame(oc, video_st);
494             frame->pts += av_rescale_q(1, video_st->codec->time_base, video_st->time_base);
495         }
496     }
497
498     /* Write the trailer, if any. The trailer must be written before you
499      * close the CodecContexts open when you wrote the header; otherwise
500      * av_write_trailer() may try to use memory that was freed on
501      * av_codec_close(). */
502     av_write_trailer(oc);
503
504     /* Close each codec. */
505     if (video_st)
506         close_video(oc, video_st);
507     if (audio_st)
508         close_audio(oc, audio_st);
509
510     /* Free the streams. */
511     for (i = 0; i < oc->nb_streams; i++) {
512         av_freep(&oc->streams[i]->codec);
513         av_freep(&oc->streams[i]);
514     }
515
516     if (!(fmt->flags & AVFMT_NOFILE))
517         /* Close the output file. */
518         avio_close(oc->pb);
519
520     /* free the stream */
521     av_free(oc);
522
523     return 0;
524 }