]> git.sesse.net Git - ffmpeg/blobdiff - libavcodec/apiexample.c
cosmetics: use a better function name than uncouple_channels()
[ffmpeg] / libavcodec / apiexample.c
index 27ec8241e1e817c9c51ed377b3c3d2017e634088..793cfaa04072804d7d36072e19a6d10e08befbea 100644 (file)
@@ -1,10 +1,30 @@
+/*
+ * copyright (c) 2001 Fabrice Bellard
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
 /**
  * @file apiexample.c
  * avcodec API use example.
  *
  * Note that this library only handles codecs (mpeg, mpeg4, etc...),
- * not file formats (avi, vob, etc...). See library 'libav' for the
- * format handling 
+ * not file formats (avi, vob, etc...). See library 'libavformat' for the
+ * format handling
  */
 
 #include <stdlib.h>
@@ -12,6 +32,8 @@
 #include <string.h>
 #include <math.h>
 
+#define PI 3.14159265358979323846
+
 #ifdef HAVE_AV_CONFIG_H
 #undef HAVE_AV_CONFIG_H
 #endif
@@ -21,7 +43,7 @@
 #define INBUF_SIZE 4096
 
 /*
- * Audio encoding example 
+ * Audio encoding example
  */
 void audio_encode_example(const char *filename)
 {
@@ -43,7 +65,7 @@ void audio_encode_example(const char *filename)
     }
 
     c= avcodec_alloc_context();
-    
+
     /* put sample parameters */
     c->bit_rate = 64000;
     c->sample_rate = 44100;
@@ -54,22 +76,22 @@ void audio_encode_example(const char *filename)
         fprintf(stderr, "could not open codec\n");
         exit(1);
     }
-    
+
     /* the codec gives us the frame size, in samples */
     frame_size = c->frame_size;
     samples = malloc(frame_size * 2 * c->channels);
     outbuf_size = 10000;
     outbuf = malloc(outbuf_size);
 
-    f = fopen(filename, "w");
+    f = fopen(filename, "wb");
     if (!f) {
         fprintf(stderr, "could not open %s\n", filename);
         exit(1);
     }
-        
+
     /* encode a single tone sound */
     t = 0;
-    tincr = 2 * M_PI * 440.0 / c->sample_rate;
+    tincr = 2 * PI * 440.0 / c->sample_rate;
     for(i=0;i<200;i++) {
         for(j=0;j<frame_size;j++) {
             samples[2*j] = (int)(sin(t) * 10000);
@@ -85,11 +107,11 @@ void audio_encode_example(const char *filename)
     free(samples);
 
     avcodec_close(c);
-    free(c);
+    av_free(c);
 }
 
 /*
- * Audio decoding. 
+ * Audio decoding.
  */
 void audio_decode_example(const char *outfilename, const char *filename)
 {
@@ -98,7 +120,7 @@ void audio_decode_example(const char *outfilename, const char *filename)
     int out_size, size, len;
     FILE *f, *outfile;
     uint8_t *outbuf;
-    uint8_t inbuf[INBUF_SIZE], *inbuf_ptr;
+    uint8_t inbuf[INBUF_SIZE + FF_INPUT_BUFFER_PADDING_SIZE], *inbuf_ptr;
 
     printf("Audio decoding\n");
 
@@ -116,20 +138,20 @@ void audio_decode_example(const char *outfilename, const char *filename)
         fprintf(stderr, "could not open codec\n");
         exit(1);
     }
-    
+
     outbuf = malloc(AVCODEC_MAX_AUDIO_FRAME_SIZE);
 
-    f = fopen(filename, "r");
+    f = fopen(filename, "rb");
     if (!f) {
         fprintf(stderr, "could not open %s\n", filename);
         exit(1);
     }
-    outfile = fopen(outfilename, "w");
+    outfile = fopen(outfilename, "wb");
     if (!outfile) {
-        free(c);
+        av_free(c);
         exit(1);
     }
-        
+
     /* decode until eof */
     inbuf_ptr = inbuf;
     for(;;) {
@@ -139,7 +161,7 @@ void audio_decode_example(const char *outfilename, const char *filename)
 
         inbuf_ptr = inbuf;
         while (size > 0) {
-            len = avcodec_decode_audio(c, (short *)outbuf, &out_size, 
+            len = avcodec_decode_audio(c, (short *)outbuf, &out_size,
                                        inbuf_ptr, size);
             if (len < 0) {
                 fprintf(stderr, "Error while decoding\n");
@@ -159,11 +181,11 @@ void audio_decode_example(const char *outfilename, const char *filename)
     free(outbuf);
 
     avcodec_close(c);
-    free(c);
+    av_free(c);
 }
 
 /*
- * Video encoding example 
+ * Video encoding example
  */
 void video_encode_example(const char *filename)
 {
@@ -185,37 +207,36 @@ void video_encode_example(const char *filename)
 
     c= avcodec_alloc_context();
     picture= avcodec_alloc_frame();
-    
+
     /* put sample parameters */
     c->bit_rate = 400000;
     /* resolution must be a multiple of two */
-    c->width = 352;  
+    c->width = 352;
     c->height = 288;
     /* frames per second */
-    c->frame_rate = 25;  
-    c->frame_rate_base= 1;
+    c->time_base= (AVRational){1,25};
     c->gop_size = 10; /* emit one intra frame every ten frames */
+    c->max_b_frames=1;
+    c->pix_fmt = PIX_FMT_YUV420P;
 
     /* open it */
     if (avcodec_open(c, codec) < 0) {
         fprintf(stderr, "could not open codec\n");
         exit(1);
     }
-    
-    /* the codec gives us the frame size, in samples */
 
-    f = fopen(filename, "w");
+    f = fopen(filename, "wb");
     if (!f) {
         fprintf(stderr, "could not open %s\n", filename);
         exit(1);
     }
-    
+
     /* alloc image and output buffer */
     outbuf_size = 100000;
     outbuf = malloc(outbuf_size);
     size = c->width * c->height;
     picture_buf = malloc((size * 3) / 2); /* size for YUV 420 */
-    
+
     picture->data[0] = picture_buf;
     picture->data[1] = picture->data[0] + size;
     picture->data[2] = picture->data[1] + size / 4;
@@ -225,7 +246,6 @@ void video_encode_example(const char *filename)
 
     /* encode 1 second of video */
     for(i=0;i<25;i++) {
-        printf("encoding frame %3d\r", i);
         fflush(stdout);
         /* prepare a dummy image */
         /* Y */
@@ -245,6 +265,16 @@ void video_encode_example(const char *filename)
 
         /* encode the image */
         out_size = avcodec_encode_video(c, outbuf, outbuf_size, picture);
+        printf("encoding frame %3d (size=%5d)\n", i, out_size);
+        fwrite(outbuf, 1, out_size, f);
+    }
+
+    /* get the delayed frames */
+    for(; out_size; i++) {
+        fflush(stdout);
+
+        out_size = avcodec_encode_video(c, outbuf, outbuf_size, NULL);
+        printf("write frame %3d (size=%5d)\n", i, out_size);
         fwrite(outbuf, 1, out_size, f);
     }
 
@@ -259,16 +289,16 @@ void video_encode_example(const char *filename)
     free(outbuf);
 
     avcodec_close(c);
-    free(c);
-    free(picture);
+    av_free(c);
+    av_free(picture);
     printf("\n");
 }
 
 /*
- * Video decoding example 
+ * Video decoding example
  */
 
-void pgm_save(unsigned char *buf,int wrap, int xsize,int ysize,char *filename) 
+void pgm_save(unsigned char *buf,int wrap, int xsize,int ysize,char *filename)
 {
     FILE *f;
     int i;
@@ -287,9 +317,12 @@ void video_decode_example(const char *outfilename, const char *filename)
     int frame, size, got_picture, len;
     FILE *f;
     AVFrame *picture;
-    uint8_t inbuf[INBUF_SIZE], *inbuf_ptr;
+    uint8_t inbuf[INBUF_SIZE + FF_INPUT_BUFFER_PADDING_SIZE], *inbuf_ptr;
     char buf[1024];
 
+    /* set end of buffer to 0 (this ensures that no overreading happens for damaged mpeg streams) */
+    memset(inbuf + INBUF_SIZE, 0, FF_INPUT_BUFFER_PADDING_SIZE);
+
     printf("Video decoding\n");
 
     /* find the mpeg1 video decoder */
@@ -303,26 +336,26 @@ void video_decode_example(const char *outfilename, const char *filename)
     picture= avcodec_alloc_frame();
 
     if(codec->capabilities&CODEC_CAP_TRUNCATED)
-        c->flags|= CODEC_FLAG_TRUNCATED; /* we dont send complete frames */
+        c->flags|= CODEC_FLAG_TRUNCATED; /* we do not send complete frames */
 
-    /* for some codecs, such as msmpeg4 and mpeg4, width and height
-       MUST be initialized there because these info are not available
-       in the bitstream */
+    /* For some codecs, such as msmpeg4 and mpeg4, width and height
+       MUST be initialized there because this information is not
+       available in the bitstream. */
 
     /* open it */
     if (avcodec_open(c, codec) < 0) {
         fprintf(stderr, "could not open codec\n");
         exit(1);
     }
-    
+
     /* the codec gives us the frame size, in samples */
 
-    f = fopen(filename, "r");
+    f = fopen(filename, "rb");
     if (!f) {
         fprintf(stderr, "could not open %s\n", filename);
         exit(1);
     }
-    
+
     frame = 0;
     for(;;) {
         size = fread(inbuf, 1, INBUF_SIZE, f);
@@ -331,7 +364,7 @@ void video_decode_example(const char *outfilename, const char *filename)
 
         /* NOTE1: some codecs are stream based (mpegvideo, mpegaudio)
            and this is the only method to use them because you cannot
-           know the compressed data size before analysing it. 
+           know the compressed data size before analysing it.
 
            BUT some other codecs (msmpeg4, mpeg4) are inherently frame
            based, so you must call them with all the data for one
@@ -346,20 +379,20 @@ void video_decode_example(const char *outfilename, const char *filename)
            feed decoder and see if it could decode a frame */
         inbuf_ptr = inbuf;
         while (size > 0) {
-            len = avcodec_decode_video(c, picture, &got_picture, 
+            len = avcodec_decode_video(c, picture, &got_picture,
                                        inbuf_ptr, size);
             if (len < 0) {
                 fprintf(stderr, "Error while decoding frame %d\n", frame);
                 exit(1);
             }
             if (got_picture) {
-                printf("saving frame %3d\r", frame);
+                printf("saving frame %3d\n", frame);
                 fflush(stdout);
 
                 /* the picture is allocated by the decoder. no need to
                    free it */
                 snprintf(buf, sizeof(buf), outfilename, frame);
-                pgm_save(picture->data[0], picture->linesize[0], 
+                pgm_save(picture->data[0], picture->linesize[0],
                          c->width, c->height, buf);
                 frame++;
             }
@@ -371,103 +404,28 @@ void video_decode_example(const char *outfilename, const char *filename)
     /* some codecs, such as MPEG, transmit the I and P frame with a
        latency of one frame. You must do the following to have a
        chance to get the last frame of the video */
-    len = avcodec_decode_video(c, picture, &got_picture, 
+    len = avcodec_decode_video(c, picture, &got_picture,
                                NULL, 0);
     if (got_picture) {
-        printf("saving frame %3d\r", frame);
+        printf("saving last frame %3d\n", frame);
         fflush(stdout);
-        
+
         /* the picture is allocated by the decoder. no need to
            free it */
         snprintf(buf, sizeof(buf), outfilename, frame);
-        pgm_save(picture->data[0], picture->linesize[0], 
+        pgm_save(picture->data[0], picture->linesize[0],
                  c->width, c->height, buf);
         frame++;
     }
-        
+
     fclose(f);
 
     avcodec_close(c);
-    free(c);
-    free(picture);
+    av_free(c);
+    av_free(picture);
     printf("\n");
 }
 
-// simple example how the options could be used
-int options_example(int argc, char* argv[])
-{
-    AVCodec* codec = avcodec_find_encoder_by_name((argc > 1) ? argv[2] : "mpeg4");
-    const AVOption* c;
-    AVCodecContext* avctx;
-    char* def = av_malloc(5000);
-    const char* col = "";
-    int i = 0;
-
-    if (!codec)
-       return -1;
-    c = codec->options;
-    avctx = avcodec_alloc_context();
-    *def = 0;
-
-    if (c) {
-       const AVOption *stack[FF_OPT_MAX_DEPTH];
-       int depth = 0;
-       for (;;) {
-           if (!c->name) {
-               if (c->help) {
-                   stack[depth++] = c;
-                   c = (const AVOption*)c->help;
-               } else {
-                   if (depth == 0)
-                       break; // finished
-                   c = stack[--depth];
-                    c++;
-               }
-           } else {
-               int t = c->type & FF_OPT_TYPE_MASK;
-               printf("Config   %s  %s\n",
-                      t == FF_OPT_TYPE_BOOL ? "bool   " :
-                      t == FF_OPT_TYPE_DOUBLE ? "double  " :
-                      t == FF_OPT_TYPE_INT ? "integer" :
-                      t == FF_OPT_TYPE_STRING ? "string " :
-                      "unknown??", c->name);
-               switch (t) {
-               case FF_OPT_TYPE_BOOL:
-                   i += sprintf(def + i, "%s%s=%s",
-                                col, c->name,
-                                c->defval != 0. ? "on" : "off");
-                   break;
-               case FF_OPT_TYPE_DOUBLE:
-                   i += sprintf(def + i, "%s%s=%f",
-                                col, c->name, c->defval);
-                   break;
-               case FF_OPT_TYPE_INT:
-                   i += sprintf(def + i, "%s%s=%d",
-                                col, c->name, (int) c->defval);
-                   break;
-               case FF_OPT_TYPE_STRING:
-                   if (c->defstr) {
-                       char* d = av_strdup(c->defstr);
-                       char* f = strchr(d, ',');
-                       if (f)
-                            *f = 0;
-                       i += sprintf(def + i, "%s%s=%s",
-                                    col, c->name, d);
-                        av_free(d);
-                   }
-                   break;
-               }
-               col = ":";
-               c++;
-           }
-       }
-    }
-    printf("Default Options: %s\n", def);
-    av_free(def);
-    return 0;
-}
-
-
 int main(int argc, char **argv)
 {
     const char *filename;
@@ -475,13 +433,9 @@ int main(int argc, char **argv)
     /* must be called before using avcodec lib */
     avcodec_init();
 
-    /* register all the codecs (you can also register only the codec
-       you wish to have smaller code */
+    /* register all the codecs */
     avcodec_register_all();
 
-#ifdef OPT_TEST
-    options_example(argc, argv);
-#else
     if (argc <= 1) {
         audio_encode_example("/tmp/test.mp2");
         audio_decode_example("/tmp/test.sw", "/tmp/test.mp2");
@@ -494,7 +448,6 @@ int main(int argc, char **argv)
 
     //    audio_decode_example("/tmp/test.sw", filename);
     video_decode_example("/tmp/test%d.pgm", filename);
-#endif
 
     return 0;
 }