eeffde2c9e626fd0059fbd4e738946c7a4a21633
[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
224     for(i=0; i<s->internal_buffer_count; i++){ //just 3-5 checks so is not worth to optimize
225         buf= &((InternalBuffer*)s->internal_buffer)[i];
226         if(buf->data[0] == pic->data[0])
227             break;
228     }
229     assert(i < s->internal_buffer_count);
230     s->internal_buffer_count--;
231     last = &((InternalBuffer*)s->internal_buffer)[s->internal_buffer_count];
232
233     temp= *buf;
234     *buf= *last;
235     *last= temp;
236
237     for(i=0; i<3; i++){
238         pic->data[i]=NULL;
239 //        pic->base[i]=NULL;
240     }
241 //printf("R%X\n", pic->opaque);
242 }
243
244 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, enum PixelFormat * fmt){
245     return fmt[0];
246 }
247
248 void avcodec_get_context_defaults(AVCodecContext *s){
249     s->bit_rate= 800*1000;
250     s->bit_rate_tolerance= s->bit_rate*10;
251     s->qmin= 2;
252     s->qmax= 31;
253     s->mb_qmin= 2;
254     s->mb_qmax= 31;
255     s->rc_eq= "tex^qComp";
256     s->qcompress= 0.5;
257     s->max_qdiff= 3;
258     s->b_quant_factor=1.25;
259     s->b_quant_offset=1.25;
260     s->i_quant_factor=-0.8;
261     s->i_quant_offset=0.0;
262     s->error_concealment= 3;
263     s->error_resilience= 1;
264     s->workaround_bugs= FF_BUG_AUTODETECT;
265     s->frame_rate_base= 1;
266     s->frame_rate = 25;
267     s->gop_size= 50;
268     s->me_method= ME_EPZS;
269     s->get_buffer= avcodec_default_get_buffer;
270     s->release_buffer= avcodec_default_release_buffer;
271     s->get_format= avcodec_default_get_format;
272     s->me_subpel_quality=8;
273     
274     s->intra_quant_bias= FF_DEFAULT_QUANT_BIAS;
275     s->inter_quant_bias= FF_DEFAULT_QUANT_BIAS;
276 }
277
278 /**
279  * allocates a AVCodecContext and set it to defaults.
280  * this can be deallocated by simply calling free() 
281  */
282 AVCodecContext *avcodec_alloc_context(void){
283     AVCodecContext *avctx= av_mallocz(sizeof(AVCodecContext));
284     
285     if(avctx==NULL) return NULL;
286     
287     avcodec_get_context_defaults(avctx);
288     
289     return avctx;
290 }
291
292 /**
293  * allocates a AVPFrame and set it to defaults.
294  * this can be deallocated by simply calling free() 
295  */
296 AVFrame *avcodec_alloc_frame(void){
297     AVFrame *pic= av_mallocz(sizeof(AVFrame));
298     
299     return pic;
300 }
301
302 int avcodec_open(AVCodecContext *avctx, AVCodec *codec)
303 {
304     int ret;
305
306     avctx->codec = codec;
307     avctx->codec_id = codec->id;
308     avctx->frame_number = 0;
309     if (codec->priv_data_size > 0) {
310         avctx->priv_data = av_mallocz(codec->priv_data_size);
311         if (!avctx->priv_data) 
312             return -ENOMEM;
313     } else {
314         avctx->priv_data = NULL;
315     }
316     ret = avctx->codec->init(avctx);
317     if (ret < 0) {
318         av_freep(&avctx->priv_data);
319         return ret;
320     }
321     return 0;
322 }
323
324 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
325                          const short *samples)
326 {
327     int ret;
328
329     ret = avctx->codec->encode(avctx, buf, buf_size, (void *)samples);
330     avctx->frame_number++;
331     return ret;
332 }
333
334 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
335                          const AVFrame *pict)
336 {
337     int ret;
338
339     ret = avctx->codec->encode(avctx, buf, buf_size, (void *)pict);
340     
341     emms_c(); //needed to avoid a emms_c() call before every return;
342
343     avctx->frame_number++;
344     return ret;
345 }
346
347 /** 
348  * decode a frame. 
349  * @param buf bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE larger then the actual read bytes
350  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
351  * @param buf_size the size of the buffer in bytes
352  * @param got_picture_ptr zero if no frame could be decompressed, Otherwise, it is non zero
353  * @return -1 if error, otherwise return the number of
354  * bytes used. 
355  */
356 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
357                          int *got_picture_ptr,
358                          uint8_t *buf, int buf_size)
359 {
360     int ret;
361     
362     ret = avctx->codec->decode(avctx, picture, got_picture_ptr, 
363                                buf, buf_size);
364
365     emms_c(); //needed to avoid a emms_c() call before every return;
366     
367     if (*got_picture_ptr)                           
368         avctx->frame_number++;
369     return ret;
370 }
371
372 /* decode an audio frame. return -1 if error, otherwise return the
373    *number of bytes used. If no frame could be decompressed,
374    *frame_size_ptr is zero. Otherwise, it is the decompressed frame
375    *size in BYTES. */
376 int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
377                          int *frame_size_ptr,
378                          uint8_t *buf, int buf_size)
379 {
380     int ret;
381
382     ret = avctx->codec->decode(avctx, samples, frame_size_ptr, 
383                                buf, buf_size);
384     avctx->frame_number++;
385     return ret;
386 }
387
388 int avcodec_close(AVCodecContext *avctx)
389 {
390     if (avctx->codec->close)
391         avctx->codec->close(avctx);
392     av_freep(&avctx->priv_data);
393     avctx->codec = NULL;
394     return 0;
395 }
396
397 AVCodec *avcodec_find_encoder(enum CodecID id)
398 {
399     AVCodec *p;
400     p = first_avcodec;
401     while (p) {
402         if (p->encode != NULL && p->id == id)
403             return p;
404         p = p->next;
405     }
406     return NULL;
407 }
408
409 AVCodec *avcodec_find_encoder_by_name(const char *name)
410 {
411     AVCodec *p;
412     p = first_avcodec;
413     while (p) {
414         if (p->encode != NULL && strcmp(name,p->name) == 0)
415             return p;
416         p = p->next;
417     }
418     return NULL;
419 }
420
421 AVCodec *avcodec_find_decoder(enum CodecID id)
422 {
423     AVCodec *p;
424     p = first_avcodec;
425     while (p) {
426         if (p->decode != NULL && p->id == id)
427             return p;
428         p = p->next;
429     }
430     return NULL;
431 }
432
433 AVCodec *avcodec_find_decoder_by_name(const char *name)
434 {
435     AVCodec *p;
436     p = first_avcodec;
437     while (p) {
438         if (p->decode != NULL && strcmp(name,p->name) == 0)
439             return p;
440         p = p->next;
441     }
442     return NULL;
443 }
444
445 AVCodec *avcodec_find(enum CodecID id)
446 {
447     AVCodec *p;
448     p = first_avcodec;
449     while (p) {
450         if (p->id == id)
451             return p;
452         p = p->next;
453     }
454     return NULL;
455 }
456
457 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode)
458 {
459     const char *codec_name;
460     AVCodec *p;
461     char buf1[32];
462     char channels_str[100];
463     int bitrate;
464
465     if (encode)
466         p = avcodec_find_encoder(enc->codec_id);
467     else
468         p = avcodec_find_decoder(enc->codec_id);
469
470     if (p) {
471         codec_name = p->name;
472     } else if (enc->codec_name[0] != '\0') {
473         codec_name = enc->codec_name;
474     } else {
475         /* output avi tags */
476         if (enc->codec_type == CODEC_TYPE_VIDEO) {
477             snprintf(buf1, sizeof(buf1), "%c%c%c%c", 
478                      enc->codec_tag & 0xff,
479                      (enc->codec_tag >> 8) & 0xff,
480                      (enc->codec_tag >> 16) & 0xff,
481                      (enc->codec_tag >> 24) & 0xff);
482         } else {
483             snprintf(buf1, sizeof(buf1), "0x%04x", enc->codec_tag);
484         }
485         codec_name = buf1;
486     }
487
488     switch(enc->codec_type) {
489     case CODEC_TYPE_VIDEO:
490         snprintf(buf, buf_size,
491                  "Video: %s%s",
492                  codec_name, enc->flags & CODEC_FLAG_HQ ? " (hq)" : "");
493         if (enc->codec_id == CODEC_ID_RAWVIDEO) {
494             snprintf(buf + strlen(buf), buf_size - strlen(buf),
495                      ", %s",
496                      avcodec_get_pix_fmt_name(enc->pix_fmt));
497         }
498         if (enc->width) {
499             snprintf(buf + strlen(buf), buf_size - strlen(buf),
500                      ", %dx%d, %0.2f fps",
501                      enc->width, enc->height, 
502                      (float)enc->frame_rate / enc->frame_rate_base);
503         }
504         if (encode) {
505             snprintf(buf + strlen(buf), buf_size - strlen(buf),
506                      ", q=%d-%d", enc->qmin, enc->qmax);
507         }
508         bitrate = enc->bit_rate;
509         break;
510     case CODEC_TYPE_AUDIO:
511         snprintf(buf, buf_size,
512                  "Audio: %s",
513                  codec_name);
514         switch (enc->channels) {
515             case 1:
516                 strcpy(channels_str, "mono");
517                 break;
518             case 2:
519                 strcpy(channels_str, "stereo");
520                 break;
521             case 6:
522                 strcpy(channels_str, "5:1");
523                 break;
524             default:
525                 sprintf(channels_str, "%d channels", enc->channels);
526                 break;
527         }
528         if (enc->sample_rate) {
529             snprintf(buf + strlen(buf), buf_size - strlen(buf),
530                      ", %d Hz, %s",
531                      enc->sample_rate,
532                      channels_str);
533         }
534         
535         /* for PCM codecs, compute bitrate directly */
536         switch(enc->codec_id) {
537         case CODEC_ID_PCM_S16LE:
538         case CODEC_ID_PCM_S16BE:
539         case CODEC_ID_PCM_U16LE:
540         case CODEC_ID_PCM_U16BE:
541             bitrate = enc->sample_rate * enc->channels * 16;
542             break;
543         case CODEC_ID_PCM_S8:
544         case CODEC_ID_PCM_U8:
545         case CODEC_ID_PCM_ALAW:
546         case CODEC_ID_PCM_MULAW:
547             bitrate = enc->sample_rate * enc->channels * 8;
548             break;
549         default:
550             bitrate = enc->bit_rate;
551             break;
552         }
553         break;
554     default:
555         av_abort();
556     }
557     if (encode) {
558         if (enc->flags & CODEC_FLAG_PASS1)
559             snprintf(buf + strlen(buf), buf_size - strlen(buf),
560                      ", pass 1");
561         if (enc->flags & CODEC_FLAG_PASS2)
562             snprintf(buf + strlen(buf), buf_size - strlen(buf),
563                      ", pass 2");
564     }
565     if (bitrate != 0) {
566         snprintf(buf + strlen(buf), buf_size - strlen(buf), 
567                  ", %d kb/s", bitrate / 1000);
568     }
569 }
570
571 unsigned avcodec_version( void )
572 {
573   return LIBAVCODEC_VERSION_INT;
574 }
575
576 unsigned avcodec_build( void )
577 {
578   return LIBAVCODEC_BUILD;
579 }
580
581 /* must be called before any other functions */
582 void avcodec_init(void)
583 {
584     static int inited = 0;
585
586     if (inited != 0)
587         return;
588     inited = 1;
589
590     dsputil_static_init();
591 }
592
593 /**
594  * Flush buffers, should be called when seeking or when swicthing to a different stream.
595  */
596 void avcodec_flush_buffers(AVCodecContext *avctx)
597 {
598     if(avctx->codec->flush)
599         avctx->codec->flush(avctx);
600 }
601
602 void avcodec_default_free_buffers(AVCodecContext *s){
603     int i, j;
604
605     if(s->internal_buffer==NULL) return;
606     
607     for(i=0; i<INTERNAL_BUFFER_SIZE; i++){
608         InternalBuffer *buf= &((InternalBuffer*)s->internal_buffer)[i];
609         for(j=0; j<4; j++){
610             av_freep(&buf->base[j]);
611             buf->data[j]= NULL;
612         }
613     }
614     av_freep(&s->internal_buffer);
615     
616     s->internal_buffer_count=0;
617 }
618
619 char av_get_pict_type_char(int pict_type){
620     switch(pict_type){
621     case I_TYPE: return 'I'; 
622     case P_TYPE: return 'P'; 
623     case B_TYPE: return 'B'; 
624     case S_TYPE: return 'S'; 
625     case SI_TYPE:return 'i'; 
626     case SP_TYPE:return 'p'; 
627     default:     return '?';
628     }
629 }
630
631 int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max){
632     int exact=1, sign=0;
633     int64_t gcd, larger;
634
635     assert(den != 0);
636
637     if(den < 0){
638         den= -den;
639         nom= -nom;
640     }
641     
642     if(nom < 0){
643         nom= -nom;
644         sign= 1;
645     }
646     
647     for(;;){ //note is executed 1 or 2 times 
648         gcd = ff_gcd(nom, den);
649         nom /= gcd;
650         den /= gcd;
651     
652         larger= FFMAX(nom, den);
653     
654         if(larger > max){
655             int64_t div= (larger + max - 1) / max;
656             nom =  (nom + div/2)/div;
657             den =  (den + div/2)/div;
658             exact=0;
659         }else 
660             break;
661     }
662     
663     if(sign) nom= -nom;
664     
665     *dst_nom = nom;
666     *dst_den = den;
667     
668     return exact;
669 }
670
671 int64_t av_rescale(int64_t a, int b, int c){
672     uint64_t h, l;
673     assert(c > 0);
674     assert(b >=0);
675     
676     if(a<0) return -av_rescale(-a, b, c);
677     
678     h= a>>32;
679     if(h==0) return a*b/c;
680     
681     l= a&0xFFFFFFFF;
682     l *= b;
683     h *= b;
684
685     l += (h%c)<<32;
686
687     return ((h/c)<<32) + l/c;
688 }