Merge commit '9b56d5c11488656254e9aed8d964ef2b7c2ff5e6'
[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 static int packet_alloc(AVBufferRef **buf, int size)
52 {
53     int ret;
54     if ((unsigned)size >= (unsigned)size + AV_INPUT_BUFFER_PADDING_SIZE)
55         return AVERROR(EINVAL);
56
57     ret = av_buffer_realloc(buf, size + AV_INPUT_BUFFER_PADDING_SIZE);
58     if (ret < 0)
59         return ret;
60
61     memset((*buf)->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
62
63     return 0;
64 }
65
66 int av_new_packet(AVPacket *pkt, int size)
67 {
68     AVBufferRef *buf = NULL;
69     int ret = packet_alloc(&buf, size);
70     if (ret < 0)
71         return ret;
72
73     av_init_packet(pkt);
74     pkt->buf      = buf;
75     pkt->data     = buf->data;
76     pkt->size     = size;
77
78     return 0;
79 }
80
81 void av_shrink_packet(AVPacket *pkt, int size)
82 {
83     if (pkt->size <= size)
84         return;
85     pkt->size = size;
86     memset(pkt->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
87 }
88
89 int av_grow_packet(AVPacket *pkt, int grow_by)
90 {
91     int new_size;
92     av_assert0((unsigned)pkt->size <= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE);
93     if (!pkt->size)
94         return av_new_packet(pkt, grow_by);
95     if ((unsigned)grow_by >
96         INT_MAX - (pkt->size + AV_INPUT_BUFFER_PADDING_SIZE))
97         return -1;
98
99     new_size = pkt->size + grow_by + AV_INPUT_BUFFER_PADDING_SIZE;
100     if (pkt->buf) {
101         int ret = av_buffer_realloc(&pkt->buf, new_size);
102         if (ret < 0)
103             return ret;
104     } else {
105         pkt->buf = av_buffer_alloc(new_size);
106         if (!pkt->buf)
107             return AVERROR(ENOMEM);
108         memcpy(pkt->buf->data, pkt->data, FFMIN(pkt->size, pkt->size + grow_by));
109     }
110     pkt->data  = pkt->buf->data;
111     pkt->size += grow_by;
112     memset(pkt->data + pkt->size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
113
114     return 0;
115 }
116
117 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
118 {
119     if (size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
120         return AVERROR(EINVAL);
121
122     pkt->buf = av_buffer_create(data, size + AV_INPUT_BUFFER_PADDING_SIZE,
123                                 av_buffer_default_free, NULL, 0);
124     if (!pkt->buf)
125         return AVERROR(ENOMEM);
126
127     pkt->data = data;
128     pkt->size = size;
129
130     return 0;
131 }
132
133 #if FF_API_AVPACKET_OLD_API
134 FF_DISABLE_DEPRECATION_WARNINGS
135 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
136 #define ALLOC_BUF(data, size)                \
137 do {                                         \
138     av_buffer_realloc(&pkt->buf, size);      \
139     data = pkt->buf ? pkt->buf->data : NULL; \
140 } while (0)
141
142 #define DUP_DATA(dst, src, size, padding, ALLOC)                        \
143     do {                                                                \
144         void *data;                                                     \
145         if (padding) {                                                  \
146             if ((unsigned)(size) >                                      \
147                 (unsigned)(size) + AV_INPUT_BUFFER_PADDING_SIZE)        \
148                 goto failed_alloc;                                      \
149             ALLOC(data, size + AV_INPUT_BUFFER_PADDING_SIZE);           \
150         } else {                                                        \
151             ALLOC(data, size);                                          \
152         }                                                               \
153         if (!data)                                                      \
154             goto failed_alloc;                                          \
155         memcpy(data, src, size);                                        \
156         if (padding)                                                    \
157             memset((uint8_t *)data + size, 0,                           \
158                    AV_INPUT_BUFFER_PADDING_SIZE);                       \
159         dst = data;                                                     \
160     } while (0)
161
162 /* Makes duplicates of data, side_data, but does not copy any other fields */
163 static int copy_packet_data(AVPacket *pkt, const AVPacket *src, int dup)
164 {
165     pkt->data      = NULL;
166     pkt->side_data = NULL;
167     if (pkt->buf) {
168         AVBufferRef *ref = av_buffer_ref(src->buf);
169         if (!ref)
170             return AVERROR(ENOMEM);
171         pkt->buf  = ref;
172         pkt->data = ref->data;
173     } else {
174         DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
175     }
176     if (pkt->side_data_elems && dup)
177         pkt->side_data = src->side_data;
178     if (pkt->side_data_elems && !dup) {
179         return av_copy_packet_side_data(pkt, src);
180     }
181     return 0;
182
183 failed_alloc:
184     av_packet_unref(pkt);
185     return AVERROR(ENOMEM);
186 }
187
188 int av_copy_packet_side_data(AVPacket *pkt, const AVPacket *src)
189 {
190     if (src->side_data_elems) {
191         int i;
192         DUP_DATA(pkt->side_data, src->side_data,
193                 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
194         if (src != pkt) {
195             memset(pkt->side_data, 0,
196                    src->side_data_elems * sizeof(*src->side_data));
197         }
198         for (i = 0; i < src->side_data_elems; i++) {
199             DUP_DATA(pkt->side_data[i].data, src->side_data[i].data,
200                     src->side_data[i].size, 1, ALLOC_MALLOC);
201             pkt->side_data[i].size = src->side_data[i].size;
202             pkt->side_data[i].type = src->side_data[i].type;
203         }
204     }
205     pkt->side_data_elems = src->side_data_elems;
206     return 0;
207
208 failed_alloc:
209     av_packet_unref(pkt);
210     return AVERROR(ENOMEM);
211 }
212 FF_ENABLE_DEPRECATION_WARNINGS
213 #endif
214
215 int av_dup_packet(AVPacket *pkt)
216 {
217     AVPacket tmp_pkt;
218
219     if (!pkt->buf && pkt->data) {
220         tmp_pkt = *pkt;
221         return copy_packet_data(pkt, &tmp_pkt, 1);
222     }
223     return 0;
224 }
225
226 int av_copy_packet(AVPacket *dst, const AVPacket *src)
227 {
228     *dst = *src;
229     return copy_packet_data(dst, src, 0);
230 }
231
232 void av_packet_free_side_data(AVPacket *pkt)
233 {
234     int i;
235     for (i = 0; i < pkt->side_data_elems; i++)
236         av_freep(&pkt->side_data[i].data);
237     av_freep(&pkt->side_data);
238     pkt->side_data_elems = 0;
239 }
240
241 #if FF_API_AVPACKET_OLD_API
242 FF_DISABLE_DEPRECATION_WARNINGS
243 void av_free_packet(AVPacket *pkt)
244 {
245     if (pkt) {
246         if (pkt->buf)
247             av_buffer_unref(&pkt->buf);
248         pkt->data            = NULL;
249         pkt->size            = 0;
250
251         av_packet_free_side_data(pkt);
252     }
253 }
254 FF_ENABLE_DEPRECATION_WARNINGS
255 #endif
256
257 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
258                                  int size)
259 {
260     int elems = pkt->side_data_elems;
261
262     if ((unsigned)elems + 1 > INT_MAX / sizeof(*pkt->side_data))
263         return NULL;
264     if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
265         return NULL;
266
267     pkt->side_data = av_realloc(pkt->side_data,
268                                 (elems + 1) * sizeof(*pkt->side_data));
269     if (!pkt->side_data)
270         return NULL;
271
272     pkt->side_data[elems].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
273     if (!pkt->side_data[elems].data)
274         return NULL;
275     pkt->side_data[elems].size = size;
276     pkt->side_data[elems].type = type;
277     pkt->side_data_elems++;
278
279     return pkt->side_data[elems].data;
280 }
281
282 uint8_t *av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
283                                  int *size)
284 {
285     int i;
286
287     for (i = 0; i < pkt->side_data_elems; i++) {
288         if (pkt->side_data[i].type == type) {
289             if (size)
290                 *size = pkt->side_data[i].size;
291             return pkt->side_data[i].data;
292         }
293     }
294     return NULL;
295 }
296
297 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
298 {
299     switch(type) {
300     case AV_PKT_DATA_PALETTE:                   return "Palette";
301     case AV_PKT_DATA_NEW_EXTRADATA:             return "New Extradata";
302     case AV_PKT_DATA_PARAM_CHANGE:              return "Param Change";
303     case AV_PKT_DATA_H263_MB_INFO:              return "H263 MB Info";
304     case AV_PKT_DATA_REPLAYGAIN:                return "Replay Gain";
305     case AV_PKT_DATA_DISPLAYMATRIX:             return "Display Matrix";
306     case AV_PKT_DATA_STEREO3D:                  return "Stereo 3D";
307     case AV_PKT_DATA_AUDIO_SERVICE_TYPE:        return "Audio Service Type";
308     case AV_PKT_DATA_SKIP_SAMPLES:              return "Skip Samples";
309     case AV_PKT_DATA_JP_DUALMONO:               return "JP Dual Mono";
310     case AV_PKT_DATA_STRINGS_METADATA:          return "Strings Metadata";
311     case AV_PKT_DATA_SUBTITLE_POSITION:         return "Subtitle Position";
312     case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL:  return "Matroska BlockAdditional";
313     case AV_PKT_DATA_WEBVTT_IDENTIFIER:         return "WebVTT ID";
314     case AV_PKT_DATA_WEBVTT_SETTINGS:           return "WebVTT Settings";
315     case AV_PKT_DATA_METADATA_UPDATE:           return "Metadata Update";
316     }
317     return NULL;
318 }
319
320 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
321
322 int av_packet_merge_side_data(AVPacket *pkt){
323     if(pkt->side_data_elems){
324         AVBufferRef *buf;
325         int i;
326         uint8_t *p;
327         uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
328         AVPacket old= *pkt;
329         for (i=0; i<old.side_data_elems; i++) {
330             size += old.side_data[i].size + 5LL;
331         }
332         if (size > INT_MAX)
333             return AVERROR(EINVAL);
334         buf = av_buffer_alloc(size);
335         if (!buf)
336             return AVERROR(ENOMEM);
337         pkt->buf = buf;
338         pkt->data = p = buf->data;
339         pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
340         bytestream_put_buffer(&p, old.data, old.size);
341         for (i=old.side_data_elems-1; i>=0; i--) {
342             bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
343             bytestream_put_be32(&p, old.side_data[i].size);
344             *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
345         }
346         bytestream_put_be64(&p, FF_MERGE_MARKER);
347         av_assert0(p-pkt->data == pkt->size);
348         memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
349         av_packet_unref(&old);
350         pkt->side_data_elems = 0;
351         pkt->side_data = NULL;
352         return 1;
353     }
354     return 0;
355 }
356
357 int av_packet_split_side_data(AVPacket *pkt){
358     if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
359         int i;
360         unsigned int size;
361         uint8_t *p;
362
363         p = pkt->data + pkt->size - 8 - 5;
364         for (i=1; ; i++){
365             size = AV_RB32(p);
366             if (size>INT_MAX || p - pkt->data < size)
367                 return 0;
368             if (p[4]&128)
369                 break;
370             p-= size+5;
371         }
372
373         pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
374         if (!pkt->side_data)
375             return AVERROR(ENOMEM);
376
377         p= pkt->data + pkt->size - 8 - 5;
378         for (i=0; ; i++){
379             size= AV_RB32(p);
380             av_assert0(size<=INT_MAX && p - pkt->data >= size);
381             pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
382             pkt->side_data[i].size = size;
383             pkt->side_data[i].type = p[4]&127;
384             if (!pkt->side_data[i].data)
385                 return AVERROR(ENOMEM);
386             memcpy(pkt->side_data[i].data, p-size, size);
387             pkt->size -= size + 5;
388             if(p[4]&128)
389                 break;
390             p-= size+5;
391         }
392         pkt->size -= 8;
393         pkt->side_data_elems = i+1;
394         return 1;
395     }
396     return 0;
397 }
398
399 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
400 {
401     AVDictionaryEntry *t = NULL;
402     uint8_t *data = NULL;
403     *size = 0;
404
405     if (!dict)
406         return NULL;
407
408     while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
409         const size_t keylen   = strlen(t->key);
410         const size_t valuelen = strlen(t->value);
411         const size_t new_size = *size + keylen + 1 + valuelen + 1;
412         uint8_t *const new_data = av_realloc(data, new_size);
413
414         if (!new_data)
415             goto fail;
416         data = new_data;
417         if (new_size > INT_MAX)
418             goto fail;
419
420         memcpy(data + *size, t->key, keylen + 1);
421         memcpy(data + *size + keylen + 1, t->value, valuelen + 1);
422
423         *size = new_size;
424     }
425
426     return data;
427
428 fail:
429     av_freep(&data);
430     *size = 0;
431     return NULL;
432 }
433
434 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
435 {
436     const uint8_t *end = data + size;
437     int ret = 0;
438
439     if (!dict || !data || !size)
440         return ret;
441     if (size && end[-1])
442         return AVERROR_INVALIDDATA;
443     while (data < end) {
444         const uint8_t *key = data;
445         const uint8_t *val = data + strlen(key) + 1;
446
447         if (val >= end)
448             return AVERROR_INVALIDDATA;
449
450         ret = av_dict_set(dict, key, val, 0);
451         if (ret < 0)
452             break;
453         data = val + strlen(val) + 1;
454     }
455
456     return ret;
457 }
458
459 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
460                                int size)
461 {
462     int i;
463
464     for (i = 0; i < pkt->side_data_elems; i++) {
465         if (pkt->side_data[i].type == type) {
466             if (size > pkt->side_data[i].size)
467                 return AVERROR(ENOMEM);
468             pkt->side_data[i].size = size;
469             return 0;
470         }
471     }
472     return AVERROR(ENOENT);
473 }
474
475 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
476 {
477     int i;
478
479     dst->pts                  = src->pts;
480     dst->dts                  = src->dts;
481     dst->pos                  = src->pos;
482     dst->duration             = src->duration;
483 #if FF_API_CONVERGENCE_DURATION
484 FF_DISABLE_DEPRECATION_WARNINGS
485     dst->convergence_duration = src->convergence_duration;
486 FF_ENABLE_DEPRECATION_WARNINGS
487 #endif
488     dst->flags                = src->flags;
489     dst->stream_index         = src->stream_index;
490
491     for (i = 0; i < src->side_data_elems; i++) {
492          enum AVPacketSideDataType type = src->side_data[i].type;
493          int size          = src->side_data[i].size;
494          uint8_t *src_data = src->side_data[i].data;
495          uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
496
497         if (!dst_data) {
498             av_packet_free_side_data(dst);
499             return AVERROR(ENOMEM);
500         }
501         memcpy(dst_data, src_data, size);
502     }
503
504     return 0;
505 }
506
507 void av_packet_unref(AVPacket *pkt)
508 {
509     av_packet_free_side_data(pkt);
510     av_buffer_unref(&pkt->buf);
511     av_init_packet(pkt);
512     pkt->data = NULL;
513     pkt->size = 0;
514 }
515
516 int av_packet_ref(AVPacket *dst, const AVPacket *src)
517 {
518     int ret;
519
520     ret = av_packet_copy_props(dst, src);
521     if (ret < 0)
522         return ret;
523
524     if (!src->buf) {
525         ret = packet_alloc(&dst->buf, src->size);
526         if (ret < 0)
527             goto fail;
528         memcpy(dst->buf->data, src->data, src->size);
529     } else {
530         dst->buf = av_buffer_ref(src->buf);
531         if (!dst->buf) {
532             ret = AVERROR(ENOMEM);
533             goto fail;
534         }
535     }
536
537     dst->size = src->size;
538     dst->data = dst->buf->data;
539     return 0;
540 fail:
541     av_packet_free_side_data(dst);
542     return ret;
543 }
544
545 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
546 {
547     *dst = *src;
548     av_init_packet(src);
549 }
550
551 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
552 {
553     if (pkt->pts != AV_NOPTS_VALUE)
554         pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
555     if (pkt->dts != AV_NOPTS_VALUE)
556         pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
557     if (pkt->duration > 0)
558         pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
559 #if FF_API_CONVERGENCE_DURATION
560 FF_DISABLE_DEPRECATION_WARNINGS
561     if (pkt->convergence_duration > 0)
562         pkt->convergence_duration = av_rescale_q(pkt->convergence_duration, src_tb, dst_tb);
563 FF_ENABLE_DEPRECATION_WARNINGS
564 #endif
565 }
566
567 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
568 {
569     uint8_t *side_data;
570     int side_data_size;
571     int i;
572
573     side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
574     if (!side_data) {
575         side_data_size = 4+4+8*error_count;
576         side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
577                                             side_data_size);
578     }
579
580     if (!side_data || side_data_size < 4+4+8*error_count)
581         return AVERROR(ENOMEM);
582
583     AV_WL32(side_data   , quality  );
584     side_data[4] = pict_type;
585     side_data[5] = error_count;
586     for (i = 0; i<error_count; i++)
587         AV_WL64(side_data+8 + 8*i , error[i]);
588
589     return 0;
590 }