c2705889ba517a2928c6284e642f6ba3a8fc043f
[ffmpeg.git] / libavcodec / utils.c
1 /*
2  * utils for libavcodec
3  * Copyright (c) 2001 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19  
20 /**
21  * @file utils.c
22  * utils.
23  */
24  
25 #include "avcodec.h"
26 #include "dsputil.h"
27 #include "mpegvideo.h"
28
29 void *av_mallocz(unsigned int size)
30 {
31     void *ptr;
32     
33     ptr = av_malloc(size);
34     if (!ptr)
35         return NULL;
36     memset(ptr, 0, size);
37     return ptr;
38 }
39
40 char *av_strdup(const char *s)
41 {
42     char *ptr;
43     int len;
44     len = strlen(s) + 1;
45     ptr = av_malloc(len);
46     if (!ptr)
47         return NULL;
48     memcpy(ptr, s, len);
49     return ptr;
50 }
51
52 /**
53  * realloc which does nothing if the block is large enough
54  */
55 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size)
56 {
57     if(min_size < *size) 
58         return ptr;
59     
60     *size= min_size + 10*1024;
61
62     return av_realloc(ptr, *size);
63 }
64
65
66 /* allocation of static arrays - do not use for normal allocation */
67 static unsigned int last_static = 0;
68 static char*** array_static = NULL;
69 static const unsigned int grow_static = 64; // ^2
70 void *__av_mallocz_static(void** location, unsigned int size)
71 {
72     unsigned int l = (last_static + grow_static) & ~(grow_static - 1);
73     void *ptr = av_mallocz(size);
74     if (!ptr)
75         return NULL;
76
77     if (location)
78     {
79         if (l > last_static)
80             array_static = av_realloc(array_static, l);
81         array_static[last_static++] = (char**) location;
82         *location = ptr;
83     }
84     return ptr;
85 }
86 /* free all static arrays and reset pointers to 0 */
87 void av_free_static(void)
88 {
89     if (array_static)
90     {
91         unsigned i;
92         for (i = 0; i < last_static; i++)
93         {
94             av_free(*array_static[i]);
95             *array_static[i] = NULL;
96         }
97         av_free(array_static);
98         array_static = 0;
99     }
100     last_static = 0;
101 }
102
103 /* cannot call it directly because of 'void **' casting is not automatic */
104 void __av_freep(void **ptr)
105 {
106     av_free(*ptr);
107     *ptr = NULL;
108 }
109
110 /* encoder management */
111 AVCodec *first_avcodec;
112
113 void register_avcodec(AVCodec *format)
114 {
115     AVCodec **p;
116     p = &first_avcodec;
117     while (*p != NULL) p = &(*p)->next;
118     *p = format;
119     format->next = NULL;
120 }
121
122 typedef struct InternalBuffer{
123     int last_pic_num;
124     uint8_t *base[4];
125     uint8_t *data[4];
126 }InternalBuffer;
127
128 #define INTERNAL_BUFFER_SIZE 32
129
130 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic){
131     int i;
132     const int width = s->width;
133     const int height= s->height;
134     InternalBuffer *buf;
135     
136     assert(pic->data[0]==NULL);
137     assert(INTERNAL_BUFFER_SIZE > s->internal_buffer_count);
138
139     if(s->internal_buffer==NULL){
140         s->internal_buffer= av_mallocz(INTERNAL_BUFFER_SIZE*sizeof(InternalBuffer));
141     }
142 #if 0
143     s->internal_buffer= av_fast_realloc(
144         s->internal_buffer, 
145         &s->internal_buffer_size, 
146         sizeof(InternalBuffer)*FFMAX(99,  s->internal_buffer_count+1)/*FIXME*/
147         );
148 #endif
149      
150     buf= &((InternalBuffer*)s->internal_buffer)[s->internal_buffer_count];
151
152     if(buf->base[0]){
153         pic->age= pic->coded_picture_number - buf->last_pic_num;
154         buf->last_pic_num= pic->coded_picture_number;
155     }else{
156         int align, h_chroma_shift, v_chroma_shift;
157         int w, h, pixel_size;
158         
159         avcodec_get_chroma_sub_sample(s->pix_fmt, &h_chroma_shift, &v_chroma_shift);
160         switch(s->pix_fmt){
161         case PIX_FMT_RGB555:
162         case PIX_FMT_RGB565:
163         case PIX_FMT_YUV422:
164             pixel_size=2;
165             break;
166         case PIX_FMT_RGB24:
167         case PIX_FMT_BGR24:
168             pixel_size=3;
169             break;
170         case PIX_FMT_RGBA32:
171             pixel_size=4;
172             break;
173         default:
174             pixel_size=1;
175         }
176         
177         if(s->codec_id==CODEC_ID_SVQ1) align=63;
178         else                           align=15;
179     
180         w= (width +align)&~align;
181         h= (height+align)&~align;
182     
183         if(!(s->flags&CODEC_FLAG_EMU_EDGE)){
184             w+= EDGE_WIDTH*2;
185             h+= EDGE_WIDTH*2;
186         }
187         
188         buf->last_pic_num= -256*256*256*64;
189
190         for(i=0; i<3; i++){
191             const int h_shift= i==0 ? 0 : h_chroma_shift;
192             const int v_shift= i==0 ? 0 : v_chroma_shift;
193
194             pic->linesize[i]= pixel_size*w>>h_shift;
195
196             buf->base[i]= av_mallocz((pic->linesize[i]*h>>v_shift)+16); //FIXME 16
197             if(buf->base[i]==NULL) return -1;
198             memset(buf->base[i], 128, pic->linesize[i]*h>>v_shift);
199         
200             if(s->flags&CODEC_FLAG_EMU_EDGE)
201                 buf->data[i] = buf->base[i];
202             else
203                 buf->data[i] = buf->base[i] + (pic->linesize[i]*EDGE_WIDTH>>v_shift) + (EDGE_WIDTH>>h_shift);
204         }
205         pic->age= 256*256*256*64;
206         pic->type= FF_BUFFER_TYPE_INTERNAL;
207     }
208
209     for(i=0; i<4; i++){
210         pic->base[i]= buf->base[i];
211         pic->data[i]= buf->data[i];
212     }
213     s->internal_buffer_count++;
214
215     return 0;
216 }
217
218 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic){
219     int i;
220     InternalBuffer *buf, *last, temp;
221
222     assert(pic->type==FF_BUFFER_TYPE_INTERNAL);
223     assert(s->internal_buffer_count);
224
225     for(i=0; i<s->internal_buffer_count; i++){ //just 3-5 checks so is not worth to optimize
226         buf= &((InternalBuffer*)s->internal_buffer)[i];
227         if(buf->data[0] == pic->data[0])
228             break;
229     }
230     assert(i < s->internal_buffer_count);
231     s->internal_buffer_count--;
232     last = &((InternalBuffer*)s->internal_buffer)[s->internal_buffer_count];
233
234     temp= *buf;
235     *buf= *last;
236     *last= temp;
237
238     for(i=0; i<3; i++){
239         pic->data[i]=NULL;
240 //        pic->base[i]=NULL;
241     }
242 //printf("R%X\n", pic->opaque);
243 }
244
245 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, enum PixelFormat * fmt){
246     return fmt[0];
247 }
248
249 void avcodec_get_context_defaults(AVCodecContext *s){
250     s->bit_rate= 800*1000;
251     s->bit_rate_tolerance= s->bit_rate*10;
252     s->qmin= 2;
253     s->qmax= 31;
254     s->mb_qmin= 2;
255     s->mb_qmax= 31;
256     s->rc_eq= "tex^qComp";
257     s->qcompress= 0.5;
258     s->max_qdiff= 3;
259     s->b_quant_factor=1.25;
260     s->b_quant_offset=1.25;
261     s->i_quant_factor=-0.8;
262     s->i_quant_offset=0.0;
263     s->error_concealment= 3;
264     s->error_resilience= 1;
265     s->workaround_bugs= FF_BUG_AUTODETECT;
266     s->frame_rate_base= 1;
267     s->frame_rate = 25;
268     s->gop_size= 50;
269     s->me_method= ME_EPZS;
270     s->get_buffer= avcodec_default_get_buffer;
271     s->release_buffer= avcodec_default_release_buffer;
272     s->get_format= avcodec_default_get_format;
273     s->me_subpel_quality=8;
274     
275     s->intra_quant_bias= FF_DEFAULT_QUANT_BIAS;
276     s->inter_quant_bias= FF_DEFAULT_QUANT_BIAS;
277 }
278
279 /**
280  * allocates a AVCodecContext and set it to defaults.
281  * this can be deallocated by simply calling free() 
282  */
283 AVCodecContext *avcodec_alloc_context(void){
284     AVCodecContext *avctx= av_mallocz(sizeof(AVCodecContext));
285     
286     if(avctx==NULL) return NULL;
287     
288     avcodec_get_context_defaults(avctx);
289     
290     return avctx;
291 }
292
293 /**
294  * allocates a AVPFrame and set it to defaults.
295  * this can be deallocated by simply calling free() 
296  */
297 AVFrame *avcodec_alloc_frame(void){
298     AVFrame *pic= av_mallocz(sizeof(AVFrame));
299     
300     return pic;
301 }
302
303 int avcodec_open(AVCodecContext *avctx, AVCodec *codec)
304 {
305     int ret;
306
307     avctx->codec = codec;
308     avctx->codec_id = codec->id;
309     avctx->frame_number = 0;
310     if (codec->priv_data_size > 0) {
311         avctx->priv_data = av_mallocz(codec->priv_data_size);
312         if (!avctx->priv_data) 
313             return -ENOMEM;
314     } else {
315         avctx->priv_data = NULL;
316     }
317     ret = avctx->codec->init(avctx);
318     if (ret < 0) {
319         av_freep(&avctx->priv_data);
320         return ret;
321     }
322     return 0;
323 }
324
325 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
326                          const short *samples)
327 {
328     int ret;
329
330     ret = avctx->codec->encode(avctx, buf, buf_size, (void *)samples);
331     avctx->frame_number++;
332     return ret;
333 }
334
335 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
336                          const AVFrame *pict)
337 {
338     int ret;
339
340     ret = avctx->codec->encode(avctx, buf, buf_size, (void *)pict);
341     
342     emms_c(); //needed to avoid a emms_c() call before every return;
343
344     avctx->frame_number++;
345     return ret;
346 }
347
348 /** 
349  * decode a frame. 
350  * @param buf bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE larger then the actual read bytes
351  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
352  * @param buf_size the size of the buffer in bytes
353  * @param got_picture_ptr zero if no frame could be decompressed, Otherwise, it is non zero
354  * @return -1 if error, otherwise return the number of
355  * bytes used. 
356  */
357 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
358                          int *got_picture_ptr,
359                          uint8_t *buf, int buf_size)
360 {
361     int ret;
362     
363     ret = avctx->codec->decode(avctx, picture, got_picture_ptr, 
364                                buf, buf_size);
365
366     emms_c(); //needed to avoid a emms_c() call before every return;
367     
368     if (*got_picture_ptr)                           
369         avctx->frame_number++;
370     return ret;
371 }
372
373 /* decode an audio frame. return -1 if error, otherwise return the
374    *number of bytes used. If no frame could be decompressed,
375    *frame_size_ptr is zero. Otherwise, it is the decompressed frame
376    *size in BYTES. */
377 int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
378                          int *frame_size_ptr,
379                          uint8_t *buf, int buf_size)
380 {
381     int ret;
382
383     ret = avctx->codec->decode(avctx, samples, frame_size_ptr, 
384                                buf, buf_size);
385     avctx->frame_number++;
386     return ret;
387 }
388
389 int avcodec_close(AVCodecContext *avctx)
390 {
391     if (avctx->codec->close)
392         avctx->codec->close(avctx);
393     av_freep(&avctx->priv_data);
394     avctx->codec = NULL;
395     return 0;
396 }
397
398 AVCodec *avcodec_find_encoder(enum CodecID id)
399 {
400     AVCodec *p;
401     p = first_avcodec;
402     while (p) {
403         if (p->encode != NULL && p->id == id)
404             return p;
405         p = p->next;
406     }
407     return NULL;
408 }
409
410 AVCodec *avcodec_find_encoder_by_name(const char *name)
411 {
412     AVCodec *p;
413     p = first_avcodec;
414     while (p) {
415         if (p->encode != NULL && strcmp(name,p->name) == 0)
416             return p;
417         p = p->next;
418     }
419     return NULL;
420 }
421
422 AVCodec *avcodec_find_decoder(enum CodecID id)
423 {
424     AVCodec *p;
425     p = first_avcodec;
426     while (p) {
427         if (p->decode != NULL && p->id == id)
428             return p;
429         p = p->next;
430     }
431     return NULL;
432 }
433
434 AVCodec *avcodec_find_decoder_by_name(const char *name)
435 {
436     AVCodec *p;
437     p = first_avcodec;
438     while (p) {
439         if (p->decode != NULL && strcmp(name,p->name) == 0)
440             return p;
441         p = p->next;
442     }
443     return NULL;
444 }
445
446 AVCodec *avcodec_find(enum CodecID id)
447 {
448     AVCodec *p;
449     p = first_avcodec;
450     while (p) {
451         if (p->id == id)
452             return p;
453         p = p->next;
454     }
455     return NULL;
456 }
457
458 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode)
459 {
460     const char *codec_name;
461     AVCodec *p;
462     char buf1[32];
463     char channels_str[100];
464     int bitrate;
465
466     if (encode)
467         p = avcodec_find_encoder(enc->codec_id);
468     else
469         p = avcodec_find_decoder(enc->codec_id);
470
471     if (p) {
472         codec_name = p->name;
473         if (!encode && enc->codec_id == CODEC_ID_MP3) {
474             if (enc->sub_id == 2)
475                 codec_name = "mp2";
476             else if (enc->sub_id == 1)
477                 codec_name = "mp1";
478         }
479     } else if (enc->codec_name[0] != '\0') {
480         codec_name = enc->codec_name;
481     } else {
482         /* output avi tags */
483         if (enc->codec_type == CODEC_TYPE_VIDEO) {
484             snprintf(buf1, sizeof(buf1), "%c%c%c%c", 
485                      enc->codec_tag & 0xff,
486                      (enc->codec_tag >> 8) & 0xff,
487                      (enc->codec_tag >> 16) & 0xff,
488                      (enc->codec_tag >> 24) & 0xff);
489         } else {
490             snprintf(buf1, sizeof(buf1), "0x%04x", enc->codec_tag);
491         }
492         codec_name = buf1;
493     }
494
495     switch(enc->codec_type) {
496     case CODEC_TYPE_VIDEO:
497         snprintf(buf, buf_size,
498                  "Video: %s%s",
499                  codec_name, enc->mb_decision ? " (hq)" : "");
500         if (enc->codec_id == CODEC_ID_RAWVIDEO) {
501             snprintf(buf + strlen(buf), buf_size - strlen(buf),
502                      ", %s",
503                      avcodec_get_pix_fmt_name(enc->pix_fmt));
504         }
505         if (enc->width) {
506             snprintf(buf + strlen(buf), buf_size - strlen(buf),
507                      ", %dx%d, %0.2f fps",
508                      enc->width, enc->height, 
509                      (float)enc->frame_rate / enc->frame_rate_base);
510         }
511         if (encode) {
512             snprintf(buf + strlen(buf), buf_size - strlen(buf),
513                      ", q=%d-%d", enc->qmin, enc->qmax);
514         }
515         bitrate = enc->bit_rate;
516         break;
517     case CODEC_TYPE_AUDIO:
518         snprintf(buf, buf_size,
519                  "Audio: %s",
520                  codec_name);
521         switch (enc->channels) {
522             case 1:
523                 strcpy(channels_str, "mono");
524                 break;
525             case 2:
526                 strcpy(channels_str, "stereo");
527                 break;
528             case 6:
529                 strcpy(channels_str, "5:1");
530                 break;
531             default:
532                 sprintf(channels_str, "%d channels", enc->channels);
533                 break;
534         }
535         if (enc->sample_rate) {
536             snprintf(buf + strlen(buf), buf_size - strlen(buf),
537                      ", %d Hz, %s",
538                      enc->sample_rate,
539                      channels_str);
540         }
541         
542         /* for PCM codecs, compute bitrate directly */
543         switch(enc->codec_id) {
544         case CODEC_ID_PCM_S16LE:
545         case CODEC_ID_PCM_S16BE:
546         case CODEC_ID_PCM_U16LE:
547         case CODEC_ID_PCM_U16BE:
548             bitrate = enc->sample_rate * enc->channels * 16;
549             break;
550         case CODEC_ID_PCM_S8:
551         case CODEC_ID_PCM_U8:
552         case CODEC_ID_PCM_ALAW:
553         case CODEC_ID_PCM_MULAW:
554             bitrate = enc->sample_rate * enc->channels * 8;
555             break;
556         default:
557             bitrate = enc->bit_rate;
558             break;
559         }
560         break;
561     default:
562         av_abort();
563     }
564     if (encode) {
565         if (enc->flags & CODEC_FLAG_PASS1)
566             snprintf(buf + strlen(buf), buf_size - strlen(buf),
567                      ", pass 1");
568         if (enc->flags & CODEC_FLAG_PASS2)
569             snprintf(buf + strlen(buf), buf_size - strlen(buf),
570                      ", pass 2");
571     }
572     if (bitrate != 0) {
573         snprintf(buf + strlen(buf), buf_size - strlen(buf), 
574                  ", %d kb/s", bitrate / 1000);
575     }
576 }
577
578 unsigned avcodec_version( void )
579 {
580   return LIBAVCODEC_VERSION_INT;
581 }
582
583 unsigned avcodec_build( void )
584 {
585   return LIBAVCODEC_BUILD;
586 }
587
588 /* must be called before any other functions */
589 void avcodec_init(void)
590 {
591     static int inited = 0;
592
593     if (inited != 0)
594         return;
595     inited = 1;
596
597     dsputil_static_init();
598 }
599
600 /**
601  * Flush buffers, should be called when seeking or when swicthing to a different stream.
602  */
603 void avcodec_flush_buffers(AVCodecContext *avctx)
604 {
605     if(avctx->codec->flush)
606         avctx->codec->flush(avctx);
607 }
608
609 void avcodec_default_free_buffers(AVCodecContext *s){
610     int i, j;
611
612     if(s->internal_buffer==NULL) return;
613     
614     for(i=0; i<INTERNAL_BUFFER_SIZE; i++){
615         InternalBuffer *buf= &((InternalBuffer*)s->internal_buffer)[i];
616         for(j=0; j<4; j++){
617             av_freep(&buf->base[j]);
618             buf->data[j]= NULL;
619         }
620     }
621     av_freep(&s->internal_buffer);
622     
623     s->internal_buffer_count=0;
624 }
625
626 char av_get_pict_type_char(int pict_type){
627     switch(pict_type){
628     case I_TYPE: return 'I'; 
629     case P_TYPE: return 'P'; 
630     case B_TYPE: return 'B'; 
631     case S_TYPE: return 'S'; 
632     case SI_TYPE:return 'i'; 
633     case SP_TYPE:return 'p'; 
634     default:     return '?';
635     }
636 }
637
638 int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max){
639     int exact=1, sign=0;
640     int64_t gcd, larger;
641
642     assert(den != 0);
643
644     if(den < 0){
645         den= -den;
646         nom= -nom;
647     }
648     
649     if(nom < 0){
650         nom= -nom;
651         sign= 1;
652     }
653     
654     for(;;){ //note is executed 1 or 2 times 
655         gcd = ff_gcd(nom, den);
656         nom /= gcd;
657         den /= gcd;
658     
659         larger= FFMAX(nom, den);
660     
661         if(larger > max){
662             int64_t div= (larger + max - 1) / max;
663             nom =  (nom + div/2)/div;
664             den =  (den + div/2)/div;
665             exact=0;
666         }else 
667             break;
668     }
669     
670     if(sign) nom= -nom;
671     
672     *dst_nom = nom;
673     *dst_den = den;
674     
675     return exact;
676 }
677
678 int64_t av_rescale(int64_t a, int b, int c){
679     uint64_t h, l;
680     assert(c > 0);
681     assert(b >=0);
682     
683     if(a<0) return -av_rescale(-a, b, c);
684     
685     h= a>>32;
686     if(h==0) return a*b/c;
687     
688     l= a&0xFFFFFFFF;
689     l *= b;
690     h *= b;
691
692     l += (h%c)<<32;
693
694     return ((h/c)<<32) + l/c;
695 }