Doxygen example
[libav.git] / output_example.c
1 /*
2 * Libavformat API example: Output a media file in any supported
3 * libavformat format. The default codecs are used.
4 *
5 * Copyright (c) 2003 Fabrice Bellard
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25 #include <stdlib.h>
26 #include <stdio.h>
27 #include <string.h>
28 #include <math.h>
29
30 #ifndef M_PI
31 #define M_PI 3.1415926535897931
32 #endif
33
34 #include "avformat.h"
35
36 /* 5 seconds stream duration */
37 #define STREAM_DURATION 5.0
38 #define STREAM_FRAME_RATE 25 /* 25 images/s */
39 #define STREAM_NB_FRAMES ((int)(STREAM_DURATION * STREAM_FRAME_RATE))
40
41 /**************************************************************/
42 /* audio output */
43
44 float t, tincr, tincr2;
45 int16_t *samples;
46 uint8_t *audio_outbuf;
47 int audio_outbuf_size;
48 int audio_input_frame_size;
49
50 /*
51 * add an audio output stream
52 */
53 AVStream *add_audio_stream(AVFormatContext *oc, int codec_id)
54 {
55 AVCodecContext *c;
56 AVStream *st;
57
58 st = av_new_stream(oc, 1);
59 if (!st) {
60 fprintf(stderr, "Could not alloc stream\n");
61 exit(1);
62 }
63
64 c = &st->codec;
65 c->codec_id = codec_id;
66 c->codec_type = CODEC_TYPE_AUDIO;
67
68 /* put sample parameters */
69 c->bit_rate = 64000;
70 c->sample_rate = 44100;
71 c->channels = 2;
72 return st;
73 }
74
75 void open_audio(AVFormatContext *oc, AVStream *st)
76 {
77 AVCodecContext *c;
78 AVCodec *codec;
79
80 c = &st->codec;
81
82 /* find the audio encoder */
83 codec = avcodec_find_encoder(c->codec_id);
84 if (!codec) {
85 fprintf(stderr, "codec not found\n");
86 exit(1);
87 }
88
89 /* open it */
90 if (avcodec_open(c, codec) < 0) {
91 fprintf(stderr, "could not open codec\n");
92 exit(1);
93 }
94
95 /* init signal generator */
96 t = 0;
97 tincr = 2 * M_PI * 110.0 / c->sample_rate;
98 /* increment frequency by 110 Hz per second */
99 tincr2 = 2 * M_PI * 110.0 / c->sample_rate / c->sample_rate;
100
101 audio_outbuf_size = 10000;
102 audio_outbuf = malloc(audio_outbuf_size);
103
104 /* ugly hack for PCM codecs (will be removed ASAP with new PCM
105 support to compute the input frame size in samples */
106 if (c->frame_size <= 1) {
107 audio_input_frame_size = audio_outbuf_size / c->channels;
108 switch(st->codec.codec_id) {
109 case CODEC_ID_PCM_S16LE:
110 case CODEC_ID_PCM_S16BE:
111 case CODEC_ID_PCM_U16LE:
112 case CODEC_ID_PCM_U16BE:
113 audio_input_frame_size >>= 1;
114 break;
115 default:
116 break;
117 }
118 } else {
119 audio_input_frame_size = c->frame_size;
120 }
121 samples = malloc(audio_input_frame_size * 2 * c->channels);
122 }
123
124 /* prepare a 16 bit dummy audio frame of 'frame_size' samples and
125 'nb_channels' channels */
126 void get_audio_frame(int16_t *samples, int frame_size, int nb_channels)
127 {
128 int j, i, v;
129 int16_t *q;
130
131 q = samples;
132 for(j=0;j<frame_size;j++) {
133 v = (int)(sin(t) * 10000);
134 for(i = 0; i < nb_channels; i++)
135 *q++ = v;
136 t += tincr;
137 tincr += tincr2;
138 }
139 }
140
141 void write_audio_frame(AVFormatContext *oc, AVStream *st)
142 {
143 int out_size;
144 AVCodecContext *c;
145 AVPacket pkt;
146 av_init_packet(&pkt);
147
148 c = &st->codec;
149
150 get_audio_frame(samples, audio_input_frame_size, c->channels);
151
152 pkt.size= avcodec_encode_audio(c, audio_outbuf, audio_outbuf_size, samples);
153
154 pkt.pts= c->coded_frame->pts;
155 pkt.flags |= PKT_FLAG_KEY;
156 pkt.stream_index= st->index;
157 pkt.data= audio_outbuf;
158
159 /* write the compressed frame in the media file */
160 if (av_write_frame(oc, &pkt) != 0) {
161 fprintf(stderr, "Error while writing audio frame\n");
162 exit(1);
163 }
164 }
165
166 void close_audio(AVFormatContext *oc, AVStream *st)
167 {
168 avcodec_close(&st->codec);
169
170 av_free(samples);
171 av_free(audio_outbuf);
172 }
173
174 /**************************************************************/
175 /* video output */
176
177 AVFrame *picture, *tmp_picture;
178 uint8_t *video_outbuf;
179 int frame_count, video_outbuf_size;
180
181 /* add a video output stream */
182 AVStream *add_video_stream(AVFormatContext *oc, int codec_id)
183 {
184 AVCodecContext *c;
185 AVStream *st;
186
187 st = av_new_stream(oc, 0);
188 if (!st) {
189 fprintf(stderr, "Could not alloc stream\n");
190 exit(1);
191 }
192
193 c = &st->codec;
194 c->codec_id = codec_id;
195 c->codec_type = CODEC_TYPE_VIDEO;
196
197 /* put sample parameters */
198 c->bit_rate = 400000;
199 /* resolution must be a multiple of two */
200 c->width = 352;
201 c->height = 288;
202 /* frames per second */
203 c->frame_rate = STREAM_FRAME_RATE;
204 c->frame_rate_base = 1;
205 c->gop_size = 12; /* emit one intra frame every twelve frames at most */
206 if (c->codec_id == CODEC_ID_MPEG2VIDEO) {
207 /* just for testing, we also add B frames */
208 c->max_b_frames = 2;
209 }
210 if (c->codec_id == CODEC_ID_MPEG1VIDEO){
211 /* needed to avoid using macroblocks in which some coeffs overflow
212 this doesnt happen with normal video, it just happens here as the
213 motion of the chroma plane doesnt match the luma plane */
214 c->mb_decision=2;
215 }
216 // some formats want stream headers to be seperate
217 if(!strcmp(oc->oformat->name, "mp4") || !strcmp(oc->oformat->name, "mov") || !strcmp(oc->oformat->name, "3gp"))
218 c->flags |= CODEC_FLAG_GLOBAL_HEADER;
219
220 return st;
221 }
222
223 AVFrame *alloc_picture(int pix_fmt, int width, int height)
224 {
225 AVFrame *picture;
226 uint8_t *picture_buf;
227 int size;
228
229 picture = avcodec_alloc_frame();
230 if (!picture)
231 return NULL;
232 size = avpicture_get_size(pix_fmt, width, height);
233 picture_buf = malloc(size);
234 if (!picture_buf) {
235 av_free(picture);
236 return NULL;
237 }
238 avpicture_fill((AVPicture *)picture, picture_buf,
239 pix_fmt, width, height);
240 return picture;
241 }
242
243 void open_video(AVFormatContext *oc, AVStream *st)
244 {
245 AVCodec *codec;
246 AVCodecContext *c;
247
248 c = &st->codec;
249
250 /* find the video encoder */
251 codec = avcodec_find_encoder(c->codec_id);
252 if (!codec) {
253 fprintf(stderr, "codec not found\n");
254 exit(1);
255 }
256
257 /* open the codec */
258 if (avcodec_open(c, codec) < 0) {
259 fprintf(stderr, "could not open codec\n");
260 exit(1);
261 }
262
263 video_outbuf = NULL;
264 if (!(oc->oformat->flags & AVFMT_RAWPICTURE)) {
265 /* allocate output buffer */
266 /* XXX: API change will be done */
267 video_outbuf_size = 200000;
268 video_outbuf = malloc(video_outbuf_size);
269 }
270
271 /* allocate the encoded raw picture */
272 picture = alloc_picture(c->pix_fmt, c->width, c->height);
273 if (!picture) {
274 fprintf(stderr, "Could not allocate picture\n");
275 exit(1);
276 }
277
278 /* if the output format is not YUV420P, then a temporary YUV420P
279 picture is needed too. It is then converted to the required
280 output format */
281 tmp_picture = NULL;
282 if (c->pix_fmt != PIX_FMT_YUV420P) {
283 tmp_picture = alloc_picture(PIX_FMT_YUV420P, c->width, c->height);
284 if (!tmp_picture) {
285 fprintf(stderr, "Could not allocate temporary picture\n");
286 exit(1);
287 }
288 }
289 }
290
291 /* prepare a dummy image */
292 void fill_yuv_image(AVFrame *pict, int frame_index, int width, int height)
293 {
294 int x, y, i;
295
296 i = frame_index;
297
298 /* Y */
299 for(y=0;y<height;y++) {
300 for(x=0;x<width;x++) {
301 pict->data[0][y * pict->linesize[0] + x] = x + y + i * 3;
302 }
303 }
304
305 /* Cb and Cr */
306 for(y=0;y<height/2;y++) {
307 for(x=0;x<width/2;x++) {
308 pict->data[1][y * pict->linesize[1] + x] = 128 + y + i * 2;
309 pict->data[2][y * pict->linesize[2] + x] = 64 + x + i * 5;
310 }
311 }
312 }
313
314 void write_video_frame(AVFormatContext *oc, AVStream *st)
315 {
316 int out_size, ret;
317 AVCodecContext *c;
318 AVFrame *picture_ptr;
319
320 c = &st->codec;
321
322 if (frame_count >= STREAM_NB_FRAMES) {
323 /* no more frame to compress. The codec has a latency of a few
324 frames if using B frames, so we get the last frames by
325 passing a NULL picture */
326 picture_ptr = NULL;
327 } else {
328 if (c->pix_fmt != PIX_FMT_YUV420P) {
329 /* as we only generate a YUV420P picture, we must convert it
330 to the codec pixel format if needed */
331 fill_yuv_image(tmp_picture, frame_count, c->width, c->height);
332 img_convert((AVPicture *)picture, c->pix_fmt,
333 (AVPicture *)tmp_picture, PIX_FMT_YUV420P,
334 c->width, c->height);
335 } else {
336 fill_yuv_image(picture, frame_count, c->width, c->height);
337 }
338 picture_ptr = picture;
339 }
340
341
342 if (oc->oformat->flags & AVFMT_RAWPICTURE) {
343 /* raw video case. The API will change slightly in the near
344 futur for that */
345 AVPacket pkt;
346 av_init_packet(&pkt);
347
348 pkt.flags |= PKT_FLAG_KEY;
349 pkt.stream_index= st->index;
350 pkt.data= (uint8_t *)picture_ptr;
351 pkt.size= sizeof(AVPicture);
352
353 ret = av_write_frame(oc, &pkt);
354 } else {
355 /* encode the image */
356 out_size = avcodec_encode_video(c, video_outbuf, video_outbuf_size, picture_ptr);
357 /* if zero size, it means the image was buffered */
358 if (out_size != 0) {
359 AVPacket pkt;
360 av_init_packet(&pkt);
361
362 pkt.pts= c->coded_frame->pts;
363 if(c->coded_frame->key_frame)
364 pkt.flags |= PKT_FLAG_KEY;
365 pkt.stream_index= st->index;
366 pkt.data= video_outbuf;
367 pkt.size= out_size;
368
369 /* write the compressed frame in the media file */
370 ret = av_write_frame(oc, &pkt);
371 } else {
372 ret = 0;
373 }
374 }
375 if (ret != 0) {
376 fprintf(stderr, "Error while writing video frame\n");
377 exit(1);
378 }
379 frame_count++;
380 }
381
382 void close_video(AVFormatContext *oc, AVStream *st)
383 {
384 avcodec_close(&st->codec);
385 av_free(picture->data[0]);
386 av_free(picture);
387 if (tmp_picture) {
388 av_free(tmp_picture->data[0]);
389 av_free(tmp_picture);
390 }
391 av_free(video_outbuf);
392 }
393
394 /**************************************************************/
395 /* media file output */
396
397 int main(int argc, char **argv)
398 {
399 const char *filename;
400 AVOutputFormat *fmt;
401 AVFormatContext *oc;
402 AVStream *audio_st, *video_st;
403 double audio_pts, video_pts;
404 int i;
405
406 /* initialize libavcodec, and register all codecs and formats */
407 av_register_all();
408
409 if (argc != 2) {
410 printf("usage: %s output_file\n"
411 "API example program to output a media file with libavformat.\n"
412 "The output format is automatically guessed according to the file extension.\n"
413 "Raw images can also be output by using '%%d' in the filename\n"
414 "\n", argv[0]);
415 exit(1);
416 }
417
418 filename = argv[1];
419
420 /* auto detect the output format from the name. default is
421 mpeg. */
422 fmt = guess_format(NULL, filename, NULL);
423 if (!fmt) {
424 printf("Could not deduce output format from file extension: using MPEG.\n");
425 fmt = guess_format("mpeg", NULL, NULL);
426 }
427 if (!fmt) {
428 fprintf(stderr, "Could not find suitable output format\n");
429 exit(1);
430 }
431
432 /* allocate the output media context */
433 oc = av_alloc_format_context();
434 if (!oc) {
435 fprintf(stderr, "Memory error\n");
436 exit(1);
437 }
438 oc->oformat = fmt;
439 snprintf(oc->filename, sizeof(oc->filename), "%s", filename);
440
441 /* add the audio and video streams using the default format codecs
442 and initialize the codecs */
443 video_st = NULL;
444 audio_st = NULL;
445 if (fmt->video_codec != CODEC_ID_NONE) {
446 video_st = add_video_stream(oc, fmt->video_codec);
447 }
448 if (fmt->audio_codec != CODEC_ID_NONE) {
449 audio_st = add_audio_stream(oc, fmt->audio_codec);
450 }
451
452 /* set the output parameters (must be done even if no
453 parameters). */
454 if (av_set_parameters(oc, NULL) < 0) {
455 fprintf(stderr, "Invalid output format parameters\n");
456 exit(1);
457 }
458
459 dump_format(oc, 0, filename, 1);
460
461 /* now that all the parameters are set, we can open the audio and
462 video codecs and allocate the necessary encode buffers */
463 if (video_st)
464 open_video(oc, video_st);
465 if (audio_st)
466 open_audio(oc, audio_st);
467
468 /* open the output file, if needed */
469 if (!(fmt->flags & AVFMT_NOFILE)) {
470 if (url_fopen(&oc->pb, filename, URL_WRONLY) < 0) {
471 fprintf(stderr, "Could not open '%s'\n", filename);
472 exit(1);
473 }
474 }
475
476 /* write the stream header, if any */
477 av_write_header(oc);
478
479 for(;;) {
480 /* compute current audio and video time */
481 if (audio_st)
482 audio_pts = (double)audio_st->pts.val * audio_st->time_base.num / audio_st->time_base.den;
483 else
484 audio_pts = 0.0;
485
486 if (video_st)
487 video_pts = (double)video_st->pts.val * video_st->time_base.num / video_st->time_base.den;
488 else
489 video_pts = 0.0;
490
491 if ((!audio_st || audio_pts >= STREAM_DURATION) &&
492 (!video_st || video_pts >= STREAM_DURATION))
493 break;
494
495 /* write interleaved audio and video frames */
496 if (!video_st || (video_st && audio_st && audio_pts < video_pts)) {
497 write_audio_frame(oc, audio_st);
498 } else {
499 write_video_frame(oc, video_st);
500 }
501 }
502
503 /* close each codec */
504 if (video_st)
505 close_video(oc, video_st);
506 if (audio_st)
507 close_audio(oc, audio_st);
508
509 /* write the trailer, if any */
510 av_write_trailer(oc);
511
512 /* free the streams */
513 for(i = 0; i < oc->nb_streams; i++) {
514 av_freep(&oc->streams[i]);
515 }
516
517 if (!(fmt->flags & AVFMT_NOFILE)) {
518 /* close the output file */
519 url_fclose(&oc->pb);
520 }
521
522 /* free the stream */
523 av_free(oc);
524
525 return 0;
526 }