c883429cfc3ba392765bc2152c7edda78bb556bd
[ffmpeg.git] / doc / examples / output.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  * @example output.c
28  * Output a media file in any supported libavformat format. The default
29  * codecs are used.
30  */
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <math.h>
36
37 #include "libavutil/channel_layout.h"
38 #include "libavutil/mathematics.h"
39 #include "libavutil/opt.h"
40 #include "libavformat/avformat.h"
41 #include "libavresample/avresample.h"
42 #include "libswscale/swscale.h"
43
44 /* 5 seconds stream duration */
45 #define STREAM_DURATION   5.0
46 #define STREAM_FRAME_RATE 25 /* 25 images/s */
47 #define STREAM_NB_FRAMES  ((int)(STREAM_DURATION * STREAM_FRAME_RATE))
48 #define STREAM_PIX_FMT    AV_PIX_FMT_YUV420P /* default pix_fmt */
49
50 #define SCALE_FLAGS SWS_BICUBIC
51
52 // a wrapper around a single output AVStream
53 typedef struct OutputStream {
54     AVStream *st;
55
56     /* pts of the next frame that will be generated */
57     int64_t next_pts;
58
59     AVFrame *frame;
60     AVFrame *tmp_frame;
61
62     float t, tincr, tincr2;
63
64     struct SwsContext *sws_ctx;
65     AVAudioResampleContext *avr;
66 } OutputStream;
67
68 /**************************************************************/
69 /* audio output */
70
71 /*
72  * add an audio output stream
73  */
74 static void add_audio_stream(OutputStream *ost, AVFormatContext *oc,
75                              enum AVCodecID codec_id)
76 {
77     AVCodecContext *c;
78     AVCodec *codec;
79     int ret;
80
81     /* find the audio encoder */
82     codec = avcodec_find_encoder(codec_id);
83     if (!codec) {
84         fprintf(stderr, "codec not found\n");
85         exit(1);
86     }
87
88     ost->st = avformat_new_stream(oc, codec);
89     if (!ost->st) {
90         fprintf(stderr, "Could not alloc stream\n");
91         exit(1);
92     }
93
94     c = ost->st->codec;
95
96     /* put sample parameters */
97     c->sample_fmt     = codec->sample_fmts           ? codec->sample_fmts[0]           : AV_SAMPLE_FMT_S16;
98     c->sample_rate    = codec->supported_samplerates ? codec->supported_samplerates[0] : 44100;
99     c->channel_layout = codec->channel_layouts       ? codec->channel_layouts[0]       : AV_CH_LAYOUT_STEREO;
100     c->channels       = av_get_channel_layout_nb_channels(c->channel_layout);
101     c->bit_rate       = 64000;
102
103     ost->st->time_base = (AVRational){ 1, c->sample_rate };
104
105     // some formats want stream headers to be separate
106     if (oc->oformat->flags & AVFMT_GLOBALHEADER)
107         c->flags |= AV_CODEC_FLAG_GLOBAL_HEADER;
108
109     /* initialize sample format conversion;
110      * to simplify the code, we always pass the data through lavr, even
111      * if the encoder supports the generated format directly -- the price is
112      * some extra data copying;
113      */
114     ost->avr = avresample_alloc_context();
115     if (!ost->avr) {
116         fprintf(stderr, "Error allocating the resampling context\n");
117         exit(1);
118     }
119
120     av_opt_set_int(ost->avr, "in_sample_fmt",      AV_SAMPLE_FMT_S16,   0);
121     av_opt_set_int(ost->avr, "in_sample_rate",     44100,               0);
122     av_opt_set_int(ost->avr, "in_channel_layout",  AV_CH_LAYOUT_STEREO, 0);
123     av_opt_set_int(ost->avr, "out_sample_fmt",     c->sample_fmt,       0);
124     av_opt_set_int(ost->avr, "out_sample_rate",    c->sample_rate,      0);
125     av_opt_set_int(ost->avr, "out_channel_layout", c->channel_layout,   0);
126
127     ret = avresample_open(ost->avr);
128     if (ret < 0) {
129         fprintf(stderr, "Error opening the resampling context\n");
130         exit(1);
131     }
132 }
133
134 static AVFrame *alloc_audio_frame(enum AVSampleFormat sample_fmt,
135                                   uint64_t channel_layout,
136                                   int sample_rate, int nb_samples)
137 {
138     AVFrame *frame = av_frame_alloc();
139     int ret;
140
141     if (!frame) {
142         fprintf(stderr, "Error allocating an audio frame\n");
143         exit(1);
144     }
145
146     frame->format = sample_fmt;
147     frame->channel_layout = channel_layout;
148     frame->sample_rate = sample_rate;
149     frame->nb_samples = nb_samples;
150
151     if (nb_samples) {
152         ret = av_frame_get_buffer(frame, 0);
153         if (ret < 0) {
154             fprintf(stderr, "Error allocating an audio buffer\n");
155             exit(1);
156         }
157     }
158
159     return frame;
160 }
161
162 static void open_audio(AVFormatContext *oc, OutputStream *ost)
163 {
164     AVCodecContext *c;
165     int nb_samples;
166
167     c = ost->st->codec;
168
169     /* open it */
170     if (avcodec_open2(c, NULL, NULL) < 0) {
171         fprintf(stderr, "could not open codec\n");
172         exit(1);
173     }
174
175     /* init signal generator */
176     ost->t     = 0;
177     ost->tincr = 2 * M_PI * 110.0 / c->sample_rate;
178     /* increment frequency by 110 Hz per second */
179     ost->tincr2 = 2 * M_PI * 110.0 / c->sample_rate / c->sample_rate;
180
181     if (c->codec->capabilities & AV_CODEC_CAP_VARIABLE_FRAME_SIZE)
182         nb_samples = 10000;
183     else
184         nb_samples = c->frame_size;
185
186     ost->frame     = alloc_audio_frame(c->sample_fmt, c->channel_layout,
187                                        c->sample_rate, nb_samples);
188     ost->tmp_frame = alloc_audio_frame(AV_SAMPLE_FMT_S16, AV_CH_LAYOUT_STEREO,
189                                        44100, nb_samples);
190 }
191
192 /* Prepare a 16 bit dummy audio frame of 'frame_size' samples and
193  * 'nb_channels' channels. */
194 static AVFrame *get_audio_frame(OutputStream *ost)
195 {
196     AVFrame *frame = ost->tmp_frame;
197     int j, i, v;
198     int16_t *q = (int16_t*)frame->data[0];
199
200     /* check if we want to generate more frames */
201     if (av_compare_ts(ost->next_pts, ost->st->codec->time_base,
202                       STREAM_DURATION, (AVRational){ 1, 1 }) >= 0)
203         return NULL;
204
205
206     for (j = 0; j < frame->nb_samples; j++) {
207         v = (int)(sin(ost->t) * 10000);
208         for (i = 0; i < ost->st->codec->channels; i++)
209             *q++ = v;
210         ost->t     += ost->tincr;
211         ost->tincr += ost->tincr2;
212     }
213
214     return frame;
215 }
216
217 /* if a frame is provided, send it to the encoder, otherwise flush the encoder;
218  * return 1 when encoding is finished, 0 otherwise
219  */
220 static int encode_audio_frame(AVFormatContext *oc, OutputStream *ost,
221                               AVFrame *frame)
222 {
223     AVPacket pkt = { 0 }; // data and size must be 0;
224     int got_packet;
225
226     av_init_packet(&pkt);
227     avcodec_encode_audio2(ost->st->codec, &pkt, frame, &got_packet);
228
229     if (got_packet) {
230         pkt.stream_index = ost->st->index;
231
232         av_packet_rescale_ts(&pkt, ost->st->codec->time_base, ost->st->time_base);
233
234         /* Write the compressed frame to the media file. */
235         if (av_interleaved_write_frame(oc, &pkt) != 0) {
236             fprintf(stderr, "Error while writing audio frame\n");
237             exit(1);
238         }
239     }
240
241     return (frame || got_packet) ? 0 : 1;
242 }
243
244 /*
245  * encode one audio frame and send it to the muxer
246  * return 1 when encoding is finished, 0 otherwise
247  */
248 static int process_audio_stream(AVFormatContext *oc, OutputStream *ost)
249 {
250     AVFrame *frame;
251     int got_output = 0;
252     int ret;
253
254     frame = get_audio_frame(ost);
255     got_output |= !!frame;
256
257     /* feed the data to lavr */
258     if (frame) {
259         ret = avresample_convert(ost->avr, NULL, 0, 0,
260                                  frame->extended_data, frame->linesize[0],
261                                  frame->nb_samples);
262         if (ret < 0) {
263             fprintf(stderr, "Error feeding audio data to the resampler\n");
264             exit(1);
265         }
266     }
267
268     while ((frame && avresample_available(ost->avr) >= ost->frame->nb_samples) ||
269            (!frame && avresample_get_out_samples(ost->avr, 0))) {
270         /* when we pass a frame to the encoder, it may keep a reference to it
271          * internally;
272          * make sure we do not overwrite it here
273          */
274         ret = av_frame_make_writable(ost->frame);
275         if (ret < 0)
276             exit(1);
277
278         /* the difference between the two avresample calls here is that the
279          * first one just reads the already converted data that is buffered in
280          * the lavr output buffer, while the second one also flushes the
281          * resampler */
282         if (frame) {
283             ret = avresample_read(ost->avr, ost->frame->extended_data,
284                                   ost->frame->nb_samples);
285         } else {
286             ret = avresample_convert(ost->avr, ost->frame->extended_data,
287                                      ost->frame->linesize[0], ost->frame->nb_samples,
288                                      NULL, 0, 0);
289         }
290
291         if (ret < 0) {
292             fprintf(stderr, "Error while resampling\n");
293             exit(1);
294         } else if (frame && ret != ost->frame->nb_samples) {
295             fprintf(stderr, "Too few samples returned from lavr\n");
296             exit(1);
297         }
298
299         ost->frame->nb_samples = ret;
300
301         ost->frame->pts        = ost->next_pts;
302         ost->next_pts         += ost->frame->nb_samples;
303
304         got_output |= encode_audio_frame(oc, ost, ret ? ost->frame : NULL);
305     }
306
307     return !got_output;
308 }
309
310 /**************************************************************/
311 /* video output */
312
313 /* Add a video output stream. */
314 static void add_video_stream(OutputStream *ost, AVFormatContext *oc,
315                              enum AVCodecID codec_id)
316 {
317     AVCodecContext *c;
318     AVCodec *codec;
319
320     /* find the video encoder */
321     codec = avcodec_find_encoder(codec_id);
322     if (!codec) {
323         fprintf(stderr, "codec not found\n");
324         exit(1);
325     }
326
327     ost->st = avformat_new_stream(oc, codec);
328     if (!ost->st) {
329         fprintf(stderr, "Could not alloc stream\n");
330         exit(1);
331     }
332
333     c = ost->st->codec;
334
335     /* Put sample parameters. */
336     c->bit_rate = 400000;
337     /* Resolution must be a multiple of two. */
338     c->width    = 352;
339     c->height   = 288;
340     /* timebase: This is the fundamental unit of time (in seconds) in terms
341      * of which frame timestamps are represented. For fixed-fps content,
342      * timebase should be 1/framerate and timestamp increments should be
343      * identical to 1. */
344     ost->st->time_base = (AVRational){ 1, STREAM_FRAME_RATE };
345     c->time_base       = ost->st->time_base;
346
347     c->gop_size      = 12; /* emit one intra frame every twelve frames at most */
348     c->pix_fmt       = STREAM_PIX_FMT;
349     if (c->codec_id == AV_CODEC_ID_MPEG2VIDEO) {
350         /* just for testing, we also add B frames */
351         c->max_b_frames = 2;
352     }
353     if (c->codec_id == AV_CODEC_ID_MPEG1VIDEO) {
354         /* Needed to avoid using macroblocks in which some coeffs overflow.
355          * This does not happen with normal video, it just happens here as
356          * the motion of the chroma plane does not match the luma plane. */
357         c->mb_decision = 2;
358     }
359     /* Some formats want stream headers to be separate. */
360     if (oc->oformat->flags & AVFMT_GLOBALHEADER)
361         c->flags |= AV_CODEC_FLAG_GLOBAL_HEADER;
362 }
363
364 static AVFrame *alloc_picture(enum AVPixelFormat pix_fmt, int width, int height)
365 {
366     AVFrame *picture;
367     int ret;
368
369     picture = av_frame_alloc();
370     if (!picture)
371         return NULL;
372
373     picture->format = pix_fmt;
374     picture->width  = width;
375     picture->height = height;
376
377     /* allocate the buffers for the frame data */
378     ret = av_frame_get_buffer(picture, 32);
379     if (ret < 0) {
380         fprintf(stderr, "Could not allocate frame data.\n");
381         exit(1);
382     }
383
384     return picture;
385 }
386
387 static void open_video(AVFormatContext *oc, OutputStream *ost)
388 {
389     AVCodecContext *c;
390
391     c = ost->st->codec;
392
393     /* open the codec */
394     if (avcodec_open2(c, NULL, NULL) < 0) {
395         fprintf(stderr, "could not open codec\n");
396         exit(1);
397     }
398
399     /* Allocate the encoded raw picture. */
400     ost->frame = alloc_picture(c->pix_fmt, c->width, c->height);
401     if (!ost->frame) {
402         fprintf(stderr, "Could not allocate picture\n");
403         exit(1);
404     }
405
406     /* If the output format is not YUV420P, then a temporary YUV420P
407      * picture is needed too. It is then converted to the required
408      * output format. */
409     ost->tmp_frame = NULL;
410     if (c->pix_fmt != AV_PIX_FMT_YUV420P) {
411         ost->tmp_frame = alloc_picture(AV_PIX_FMT_YUV420P, c->width, c->height);
412         if (!ost->tmp_frame) {
413             fprintf(stderr, "Could not allocate temporary picture\n");
414             exit(1);
415         }
416     }
417 }
418
419 /* Prepare a dummy image. */
420 static void fill_yuv_image(AVFrame *pict, int frame_index,
421                            int width, int height)
422 {
423     int x, y, i, ret;
424
425     /* when we pass a frame to the encoder, it may keep a reference to it
426      * internally;
427      * make sure we do not overwrite it here
428      */
429     ret = av_frame_make_writable(pict);
430     if (ret < 0)
431         exit(1);
432
433     i = frame_index;
434
435     /* Y */
436     for (y = 0; y < height; y++)
437         for (x = 0; x < width; x++)
438             pict->data[0][y * pict->linesize[0] + x] = x + y + i * 3;
439
440     /* Cb and Cr */
441     for (y = 0; y < height / 2; y++) {
442         for (x = 0; x < width / 2; x++) {
443             pict->data[1][y * pict->linesize[1] + x] = 128 + y + i * 2;
444             pict->data[2][y * pict->linesize[2] + x] = 64 + x + i * 5;
445         }
446     }
447 }
448
449 static AVFrame *get_video_frame(OutputStream *ost)
450 {
451     AVCodecContext *c = ost->st->codec;
452
453     /* check if we want to generate more frames */
454     if (av_compare_ts(ost->next_pts, ost->st->codec->time_base,
455                       STREAM_DURATION, (AVRational){ 1, 1 }) >= 0)
456         return NULL;
457
458     if (c->pix_fmt != AV_PIX_FMT_YUV420P) {
459         /* as we only generate a YUV420P picture, we must convert it
460          * to the codec pixel format if needed */
461         if (!ost->sws_ctx) {
462             ost->sws_ctx = sws_getContext(c->width, c->height,
463                                           AV_PIX_FMT_YUV420P,
464                                           c->width, c->height,
465                                           c->pix_fmt,
466                                           SCALE_FLAGS, NULL, NULL, NULL);
467             if (!ost->sws_ctx) {
468                 fprintf(stderr,
469                         "Cannot initialize the conversion context\n");
470                 exit(1);
471             }
472         }
473         fill_yuv_image(ost->tmp_frame, ost->next_pts, c->width, c->height);
474         sws_scale(ost->sws_ctx, ost->tmp_frame->data, ost->tmp_frame->linesize,
475                   0, c->height, ost->frame->data, ost->frame->linesize);
476     } else {
477         fill_yuv_image(ost->frame, ost->next_pts, c->width, c->height);
478     }
479
480     ost->frame->pts = ost->next_pts++;
481
482     return ost->frame;
483 }
484
485 /*
486  * encode one video frame and send it to the muxer
487  * return 1 when encoding is finished, 0 otherwise
488  */
489 static int write_video_frame(AVFormatContext *oc, OutputStream *ost)
490 {
491     int ret;
492     AVCodecContext *c;
493     AVFrame *frame;
494     AVPacket pkt   = { 0 };
495     int got_packet = 0;
496
497     c = ost->st->codec;
498
499     frame = get_video_frame(ost);
500
501     av_init_packet(&pkt);
502
503     /* encode the image */
504     ret = avcodec_encode_video2(c, &pkt, frame, &got_packet);
505     if (ret < 0) {
506         fprintf(stderr, "Error encoding a video frame\n");
507         exit(1);
508     }
509
510     if (got_packet) {
511         av_packet_rescale_ts(&pkt, c->time_base, ost->st->time_base);
512         pkt.stream_index = ost->st->index;
513
514         /* Write the compressed frame to the media file. */
515         ret = av_interleaved_write_frame(oc, &pkt);
516     }
517
518     if (ret != 0) {
519         fprintf(stderr, "Error while writing video frame\n");
520         exit(1);
521     }
522
523     return (frame || got_packet) ? 0 : 1;
524 }
525
526 static void close_stream(AVFormatContext *oc, OutputStream *ost)
527 {
528     avcodec_close(ost->st->codec);
529     av_frame_free(&ost->frame);
530     av_frame_free(&ost->tmp_frame);
531     sws_freeContext(ost->sws_ctx);
532     avresample_free(&ost->avr);
533 }
534
535 /**************************************************************/
536 /* media file output */
537
538 int main(int argc, char **argv)
539 {
540     OutputStream video_st = { 0 }, audio_st = { 0 };
541     const char *filename;
542     AVOutputFormat *fmt;
543     AVFormatContext *oc;
544     int have_video = 0, have_audio = 0;
545     int encode_video = 0, encode_audio = 0;
546
547     /* Initialize libavcodec, and register all codecs and formats. */
548     av_register_all();
549
550     if (argc != 2) {
551         printf("usage: %s output_file\n"
552                "API example program to output a media file with libavformat.\n"
553                "The output format is automatically guessed according to the file extension.\n"
554                "Raw images can also be output by using '%%d' in the filename\n"
555                "\n", argv[0]);
556         return 1;
557     }
558
559     filename = argv[1];
560
561     /* Autodetect the output format from the name. default is MPEG. */
562     fmt = av_guess_format(NULL, filename, NULL);
563     if (!fmt) {
564         printf("Could not deduce output format from file extension: using MPEG.\n");
565         fmt = av_guess_format("mpeg", NULL, NULL);
566     }
567     if (!fmt) {
568         fprintf(stderr, "Could not find suitable output format\n");
569         return 1;
570     }
571
572     /* Allocate the output media context. */
573     oc = avformat_alloc_context();
574     if (!oc) {
575         fprintf(stderr, "Memory error\n");
576         return 1;
577     }
578     oc->oformat = fmt;
579     snprintf(oc->filename, sizeof(oc->filename), "%s", filename);
580
581     /* Add the audio and video streams using the default format codecs
582      * and initialize the codecs. */
583     if (fmt->video_codec != AV_CODEC_ID_NONE) {
584         add_video_stream(&video_st, oc, fmt->video_codec);
585         have_video = 1;
586         encode_video = 1;
587     }
588     if (fmt->audio_codec != AV_CODEC_ID_NONE) {
589         add_audio_stream(&audio_st, oc, fmt->audio_codec);
590         have_audio = 1;
591         encode_audio = 1;
592     }
593
594     /* Now that all the parameters are set, we can open the audio and
595      * video codecs and allocate the necessary encode buffers. */
596     if (have_video)
597         open_video(oc, &video_st);
598     if (have_audio)
599         open_audio(oc, &audio_st);
600
601     av_dump_format(oc, 0, filename, 1);
602
603     /* open the output file, if needed */
604     if (!(fmt->flags & AVFMT_NOFILE)) {
605         if (avio_open(&oc->pb, filename, AVIO_FLAG_WRITE) < 0) {
606             fprintf(stderr, "Could not open '%s'\n", filename);
607             return 1;
608         }
609     }
610
611     /* Write the stream header, if any. */
612     avformat_write_header(oc, NULL);
613
614     while (encode_video || encode_audio) {
615         /* select the stream to encode */
616         if (encode_video &&
617             (!encode_audio || av_compare_ts(video_st.next_pts, video_st.st->codec->time_base,
618                                             audio_st.next_pts, audio_st.st->codec->time_base) <= 0)) {
619             encode_video = !write_video_frame(oc, &video_st);
620         } else {
621             encode_audio = !process_audio_stream(oc, &audio_st);
622         }
623     }
624
625     /* Write the trailer, if any. The trailer must be written before you
626      * close the CodecContexts open when you wrote the header; otherwise
627      * av_write_trailer() may try to use memory that was freed on
628      * av_codec_close(). */
629     av_write_trailer(oc);
630
631     /* Close each codec. */
632     if (have_video)
633         close_stream(oc, &video_st);
634     if (have_audio)
635         close_stream(oc, &audio_st);
636
637     if (!(fmt->flags & AVFMT_NOFILE))
638         /* Close the output file. */
639         avio_close(oc->pb);
640
641     /* free the stream */
642     avformat_free_context(oc);
643
644     return 0;
645 }