Merge commit '9d218d573f8088c606d873e80df572582e6773ef'
[ffmpeg.git] / libavcodec / avpacket.c
1 /*
2  * AVPacket functions for libavcodec
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <string.h>
23
24 #include "libavutil/avassert.h"
25 #include "libavutil/common.h"
26 #include "libavutil/internal.h"
27 #include "libavutil/mathematics.h"
28 #include "libavutil/mem.h"
29 #include "avcodec.h"
30 #include "bytestream.h"
31 #include "internal.h"
32
33 void av_init_packet(AVPacket *pkt)
34 {
35     pkt->pts                  = AV_NOPTS_VALUE;
36     pkt->dts                  = AV_NOPTS_VALUE;
37     pkt->pos                  = -1;
38     pkt->duration             = 0;
39 #if FF_API_CONVERGENCE_DURATION
40 FF_DISABLE_DEPRECATION_WARNINGS
41     pkt->convergence_duration = 0;
42 FF_ENABLE_DEPRECATION_WARNINGS
43 #endif
44     pkt->flags                = 0;
45     pkt->stream_index         = 0;
46     pkt->buf                  = NULL;
47     pkt->side_data            = NULL;
48     pkt->side_data_elems      = 0;
49 }
50
51 AVPacket *av_packet_alloc(void)
52 {
53     AVPacket *pkt = av_mallocz(sizeof(AVPacket));
54     if (!pkt)
55         return pkt;
56
57     av_packet_unref(pkt);
58
59     return pkt;
60 }
61
62 void av_packet_free(AVPacket **pkt)
63 {
64     if (!pkt || !*pkt)
65         return;
66
67     av_packet_unref(*pkt);
68     av_freep(pkt);
69 }
70
71 static int packet_alloc(AVBufferRef **buf, int size)
72 {
73     int ret;
74     if ((unsigned)size >= (unsigned)size + AV_INPUT_BUFFER_PADDING_SIZE)
75         return AVERROR(EINVAL);
76
77     ret = av_buffer_realloc(buf, size + AV_INPUT_BUFFER_PADDING_SIZE);
78     if (ret < 0)
79         return ret;
80
81     memset((*buf)->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
82
83     return 0;
84 }
85
86 int av_new_packet(AVPacket *pkt, int size)
87 {
88     AVBufferRef *buf = NULL;
89     int ret = packet_alloc(&buf, size);
90     if (ret < 0)
91         return ret;
92
93     av_init_packet(pkt);
94     pkt->buf      = buf;
95     pkt->data     = buf->data;
96     pkt->size     = size;
97
98     return 0;
99 }
100
101 void av_shrink_packet(AVPacket *pkt, int size)
102 {
103     if (pkt->size <= size)
104         return;
105     pkt->size = size;
106     memset(pkt->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
107 }
108
109 int av_grow_packet(AVPacket *pkt, int grow_by)
110 {
111     int new_size;
112     av_assert0((unsigned)pkt->size <= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE);
113     if (!pkt->size)
114         return av_new_packet(pkt, grow_by);
115     if ((unsigned)grow_by >
116         INT_MAX - (pkt->size + AV_INPUT_BUFFER_PADDING_SIZE))
117         return -1;
118
119     new_size = pkt->size + grow_by + AV_INPUT_BUFFER_PADDING_SIZE;
120     if (pkt->buf) {
121         int ret = av_buffer_realloc(&pkt->buf, new_size);
122         if (ret < 0)
123             return ret;
124     } else {
125         pkt->buf = av_buffer_alloc(new_size);
126         if (!pkt->buf)
127             return AVERROR(ENOMEM);
128         memcpy(pkt->buf->data, pkt->data, FFMIN(pkt->size, pkt->size + grow_by));
129     }
130     pkt->data  = pkt->buf->data;
131     pkt->size += grow_by;
132     memset(pkt->data + pkt->size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
133
134     return 0;
135 }
136
137 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
138 {
139     if (size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
140         return AVERROR(EINVAL);
141
142     pkt->buf = av_buffer_create(data, size + AV_INPUT_BUFFER_PADDING_SIZE,
143                                 av_buffer_default_free, NULL, 0);
144     if (!pkt->buf)
145         return AVERROR(ENOMEM);
146
147     pkt->data = data;
148     pkt->size = size;
149
150     return 0;
151 }
152
153 #if FF_API_AVPACKET_OLD_API
154 FF_DISABLE_DEPRECATION_WARNINGS
155 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
156 #define ALLOC_BUF(data, size)                \
157 do {                                         \
158     av_buffer_realloc(&pkt->buf, size);      \
159     data = pkt->buf ? pkt->buf->data : NULL; \
160 } while (0)
161
162 #define DUP_DATA(dst, src, size, padding, ALLOC)                        \
163     do {                                                                \
164         void *data;                                                     \
165         if (padding) {                                                  \
166             if ((unsigned)(size) >                                      \
167                 (unsigned)(size) + AV_INPUT_BUFFER_PADDING_SIZE)        \
168                 goto failed_alloc;                                      \
169             ALLOC(data, size + AV_INPUT_BUFFER_PADDING_SIZE);           \
170         } else {                                                        \
171             ALLOC(data, size);                                          \
172         }                                                               \
173         if (!data)                                                      \
174             goto failed_alloc;                                          \
175         memcpy(data, src, size);                                        \
176         if (padding)                                                    \
177             memset((uint8_t *)data + size, 0,                           \
178                    AV_INPUT_BUFFER_PADDING_SIZE);                       \
179         dst = data;                                                     \
180     } while (0)
181
182 /* Makes duplicates of data, side_data, but does not copy any other fields */
183 static int copy_packet_data(AVPacket *pkt, const AVPacket *src, int dup)
184 {
185     pkt->data      = NULL;
186     pkt->side_data = NULL;
187     if (pkt->buf) {
188         AVBufferRef *ref = av_buffer_ref(src->buf);
189         if (!ref)
190             return AVERROR(ENOMEM);
191         pkt->buf  = ref;
192         pkt->data = ref->data;
193     } else {
194         DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
195     }
196     if (pkt->side_data_elems && dup)
197         pkt->side_data = src->side_data;
198     if (pkt->side_data_elems && !dup) {
199         return av_copy_packet_side_data(pkt, src);
200     }
201     return 0;
202
203 failed_alloc:
204     av_packet_unref(pkt);
205     return AVERROR(ENOMEM);
206 }
207
208 int av_copy_packet_side_data(AVPacket *pkt, const AVPacket *src)
209 {
210     if (src->side_data_elems) {
211         int i;
212         DUP_DATA(pkt->side_data, src->side_data,
213                 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
214         if (src != pkt) {
215             memset(pkt->side_data, 0,
216                    src->side_data_elems * sizeof(*src->side_data));
217         }
218         for (i = 0; i < src->side_data_elems; i++) {
219             DUP_DATA(pkt->side_data[i].data, src->side_data[i].data,
220                     src->side_data[i].size, 1, ALLOC_MALLOC);
221             pkt->side_data[i].size = src->side_data[i].size;
222             pkt->side_data[i].type = src->side_data[i].type;
223         }
224     }
225     pkt->side_data_elems = src->side_data_elems;
226     return 0;
227
228 failed_alloc:
229     av_packet_unref(pkt);
230     return AVERROR(ENOMEM);
231 }
232 FF_ENABLE_DEPRECATION_WARNINGS
233 #endif
234
235 int av_dup_packet(AVPacket *pkt)
236 {
237     AVPacket tmp_pkt;
238
239     if (!pkt->buf && pkt->data) {
240         tmp_pkt = *pkt;
241         return copy_packet_data(pkt, &tmp_pkt, 1);
242     }
243     return 0;
244 }
245
246 int av_copy_packet(AVPacket *dst, const AVPacket *src)
247 {
248     *dst = *src;
249     return copy_packet_data(dst, src, 0);
250 }
251
252 void av_packet_free_side_data(AVPacket *pkt)
253 {
254     int i;
255     for (i = 0; i < pkt->side_data_elems; i++)
256         av_freep(&pkt->side_data[i].data);
257     av_freep(&pkt->side_data);
258     pkt->side_data_elems = 0;
259 }
260
261 #if FF_API_AVPACKET_OLD_API
262 FF_DISABLE_DEPRECATION_WARNINGS
263 void av_free_packet(AVPacket *pkt)
264 {
265     if (pkt) {
266         if (pkt->buf)
267             av_buffer_unref(&pkt->buf);
268         pkt->data            = NULL;
269         pkt->size            = 0;
270
271         av_packet_free_side_data(pkt);
272     }
273 }
274 FF_ENABLE_DEPRECATION_WARNINGS
275 #endif
276
277 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
278                             uint8_t *data, size_t size)
279 {
280     int elems = pkt->side_data_elems;
281
282     if ((unsigned)elems + 1 > INT_MAX / sizeof(*pkt->side_data))
283         return AVERROR(ERANGE);
284
285     pkt->side_data = av_realloc(pkt->side_data,
286                                 (elems + 1) * sizeof(*pkt->side_data));
287     if (!pkt->side_data)
288         return AVERROR(ENOMEM);
289
290     pkt->side_data[elems].data = data;
291     pkt->side_data[elems].size = size;
292     pkt->side_data[elems].type = type;
293     pkt->side_data_elems++;
294
295     return 0;
296 }
297
298
299 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
300                                  int size)
301 {
302     int ret;
303     uint8_t *data;
304
305     if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
306         return NULL;
307     data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
308     if (!data)
309         return NULL;
310
311     ret = av_packet_add_side_data(pkt, type, data, size);
312     if (ret < 0) {
313         av_freep(&data);
314         return NULL;
315     }
316
317     return data;
318 }
319
320 uint8_t *av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
321                                  int *size)
322 {
323     int i;
324
325     for (i = 0; i < pkt->side_data_elems; i++) {
326         if (pkt->side_data[i].type == type) {
327             if (size)
328                 *size = pkt->side_data[i].size;
329             return pkt->side_data[i].data;
330         }
331     }
332     return NULL;
333 }
334
335 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
336 {
337     switch(type) {
338     case AV_PKT_DATA_PALETTE:                   return "Palette";
339     case AV_PKT_DATA_NEW_EXTRADATA:             return "New Extradata";
340     case AV_PKT_DATA_PARAM_CHANGE:              return "Param Change";
341     case AV_PKT_DATA_H263_MB_INFO:              return "H263 MB Info";
342     case AV_PKT_DATA_REPLAYGAIN:                return "Replay Gain";
343     case AV_PKT_DATA_DISPLAYMATRIX:             return "Display Matrix";
344     case AV_PKT_DATA_STEREO3D:                  return "Stereo 3D";
345     case AV_PKT_DATA_AUDIO_SERVICE_TYPE:        return "Audio Service Type";
346     case AV_PKT_DATA_SKIP_SAMPLES:              return "Skip Samples";
347     case AV_PKT_DATA_JP_DUALMONO:               return "JP Dual Mono";
348     case AV_PKT_DATA_STRINGS_METADATA:          return "Strings Metadata";
349     case AV_PKT_DATA_SUBTITLE_POSITION:         return "Subtitle Position";
350     case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL:  return "Matroska BlockAdditional";
351     case AV_PKT_DATA_WEBVTT_IDENTIFIER:         return "WebVTT ID";
352     case AV_PKT_DATA_WEBVTT_SETTINGS:           return "WebVTT Settings";
353     case AV_PKT_DATA_METADATA_UPDATE:           return "Metadata Update";
354     }
355     return NULL;
356 }
357
358 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
359
360 int av_packet_merge_side_data(AVPacket *pkt){
361     if(pkt->side_data_elems){
362         AVBufferRef *buf;
363         int i;
364         uint8_t *p;
365         uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
366         AVPacket old= *pkt;
367         for (i=0; i<old.side_data_elems; i++) {
368             size += old.side_data[i].size + 5LL;
369         }
370         if (size > INT_MAX)
371             return AVERROR(EINVAL);
372         buf = av_buffer_alloc(size);
373         if (!buf)
374             return AVERROR(ENOMEM);
375         pkt->buf = buf;
376         pkt->data = p = buf->data;
377         pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
378         bytestream_put_buffer(&p, old.data, old.size);
379         for (i=old.side_data_elems-1; i>=0; i--) {
380             bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
381             bytestream_put_be32(&p, old.side_data[i].size);
382             *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
383         }
384         bytestream_put_be64(&p, FF_MERGE_MARKER);
385         av_assert0(p-pkt->data == pkt->size);
386         memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
387         av_packet_unref(&old);
388         pkt->side_data_elems = 0;
389         pkt->side_data = NULL;
390         return 1;
391     }
392     return 0;
393 }
394
395 int av_packet_split_side_data(AVPacket *pkt){
396     if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
397         int i;
398         unsigned int size;
399         uint8_t *p;
400
401         p = pkt->data + pkt->size - 8 - 5;
402         for (i=1; ; i++){
403             size = AV_RB32(p);
404             if (size>INT_MAX || p - pkt->data < size)
405                 return 0;
406             if (p[4]&128)
407                 break;
408             p-= size+5;
409         }
410
411         pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
412         if (!pkt->side_data)
413             return AVERROR(ENOMEM);
414
415         p= pkt->data + pkt->size - 8 - 5;
416         for (i=0; ; i++){
417             size= AV_RB32(p);
418             av_assert0(size<=INT_MAX && p - pkt->data >= size);
419             pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
420             pkt->side_data[i].size = size;
421             pkt->side_data[i].type = p[4]&127;
422             if (!pkt->side_data[i].data)
423                 return AVERROR(ENOMEM);
424             memcpy(pkt->side_data[i].data, p-size, size);
425             pkt->size -= size + 5;
426             if(p[4]&128)
427                 break;
428             p-= size+5;
429         }
430         pkt->size -= 8;
431         pkt->side_data_elems = i+1;
432         return 1;
433     }
434     return 0;
435 }
436
437 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
438 {
439     AVDictionaryEntry *t = NULL;
440     uint8_t *data = NULL;
441     *size = 0;
442
443     if (!dict)
444         return NULL;
445
446     while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
447         const size_t keylen   = strlen(t->key);
448         const size_t valuelen = strlen(t->value);
449         const size_t new_size = *size + keylen + 1 + valuelen + 1;
450         uint8_t *const new_data = av_realloc(data, new_size);
451
452         if (!new_data)
453             goto fail;
454         data = new_data;
455         if (new_size > INT_MAX)
456             goto fail;
457
458         memcpy(data + *size, t->key, keylen + 1);
459         memcpy(data + *size + keylen + 1, t->value, valuelen + 1);
460
461         *size = new_size;
462     }
463
464     return data;
465
466 fail:
467     av_freep(&data);
468     *size = 0;
469     return NULL;
470 }
471
472 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
473 {
474     const uint8_t *end = data + size;
475     int ret = 0;
476
477     if (!dict || !data || !size)
478         return ret;
479     if (size && end[-1])
480         return AVERROR_INVALIDDATA;
481     while (data < end) {
482         const uint8_t *key = data;
483         const uint8_t *val = data + strlen(key) + 1;
484
485         if (val >= end)
486             return AVERROR_INVALIDDATA;
487
488         ret = av_dict_set(dict, key, val, 0);
489         if (ret < 0)
490             break;
491         data = val + strlen(val) + 1;
492     }
493
494     return ret;
495 }
496
497 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
498                                int size)
499 {
500     int i;
501
502     for (i = 0; i < pkt->side_data_elems; i++) {
503         if (pkt->side_data[i].type == type) {
504             if (size > pkt->side_data[i].size)
505                 return AVERROR(ENOMEM);
506             pkt->side_data[i].size = size;
507             return 0;
508         }
509     }
510     return AVERROR(ENOENT);
511 }
512
513 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
514 {
515     int i;
516
517     dst->pts                  = src->pts;
518     dst->dts                  = src->dts;
519     dst->pos                  = src->pos;
520     dst->duration             = src->duration;
521 #if FF_API_CONVERGENCE_DURATION
522 FF_DISABLE_DEPRECATION_WARNINGS
523     dst->convergence_duration = src->convergence_duration;
524 FF_ENABLE_DEPRECATION_WARNINGS
525 #endif
526     dst->flags                = src->flags;
527     dst->stream_index         = src->stream_index;
528
529     for (i = 0; i < src->side_data_elems; i++) {
530          enum AVPacketSideDataType type = src->side_data[i].type;
531          int size          = src->side_data[i].size;
532          uint8_t *src_data = src->side_data[i].data;
533          uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
534
535         if (!dst_data) {
536             av_packet_free_side_data(dst);
537             return AVERROR(ENOMEM);
538         }
539         memcpy(dst_data, src_data, size);
540     }
541
542     return 0;
543 }
544
545 void av_packet_unref(AVPacket *pkt)
546 {
547     av_packet_free_side_data(pkt);
548     av_buffer_unref(&pkt->buf);
549     av_init_packet(pkt);
550     pkt->data = NULL;
551     pkt->size = 0;
552 }
553
554 int av_packet_ref(AVPacket *dst, const AVPacket *src)
555 {
556     int ret;
557
558     ret = av_packet_copy_props(dst, src);
559     if (ret < 0)
560         return ret;
561
562     if (!src->buf) {
563         ret = packet_alloc(&dst->buf, src->size);
564         if (ret < 0)
565             goto fail;
566         memcpy(dst->buf->data, src->data, src->size);
567     } else {
568         dst->buf = av_buffer_ref(src->buf);
569         if (!dst->buf) {
570             ret = AVERROR(ENOMEM);
571             goto fail;
572         }
573     }
574
575     dst->size = src->size;
576     dst->data = dst->buf->data;
577     return 0;
578 fail:
579     av_packet_free_side_data(dst);
580     return ret;
581 }
582
583 AVPacket *av_packet_clone(AVPacket *src)
584 {
585     AVPacket *ret = av_packet_alloc();
586
587     if (!ret)
588         return ret;
589
590     if (av_packet_ref(ret, src))
591         av_packet_free(&ret);
592
593     return ret;
594 }
595
596 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
597 {
598     *dst = *src;
599     av_init_packet(src);
600 }
601
602 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
603 {
604     if (pkt->pts != AV_NOPTS_VALUE)
605         pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
606     if (pkt->dts != AV_NOPTS_VALUE)
607         pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
608     if (pkt->duration > 0)
609         pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
610 #if FF_API_CONVERGENCE_DURATION
611 FF_DISABLE_DEPRECATION_WARNINGS
612     if (pkt->convergence_duration > 0)
613         pkt->convergence_duration = av_rescale_q(pkt->convergence_duration, src_tb, dst_tb);
614 FF_ENABLE_DEPRECATION_WARNINGS
615 #endif
616 }
617
618 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
619 {
620     uint8_t *side_data;
621     int side_data_size;
622     int i;
623
624     side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
625     if (!side_data) {
626         side_data_size = 4+4+8*error_count;
627         side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
628                                             side_data_size);
629     }
630
631     if (!side_data || side_data_size < 4+4+8*error_count)
632         return AVERROR(ENOMEM);
633
634     AV_WL32(side_data   , quality  );
635     side_data[4] = pict_type;
636     side_data[5] = error_count;
637     for (i = 0; i<error_count; i++)
638         AV_WL64(side_data+8 + 8*i , error[i]);
639
640     return 0;
641 }