2 * AVPacket functions for libavcodec
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
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"
30 #include "bytestream.h"
34 void av_init_packet(AVPacket *pkt)
36 pkt->pts = AV_NOPTS_VALUE;
37 pkt->dts = AV_NOPTS_VALUE;
40 #if FF_API_CONVERGENCE_DURATION
41 FF_DISABLE_DEPRECATION_WARNINGS
42 pkt->convergence_duration = 0;
43 FF_ENABLE_DEPRECATION_WARNINGS
46 pkt->stream_index = 0;
48 pkt->side_data = NULL;
49 pkt->side_data_elems = 0;
52 AVPacket *av_packet_alloc(void)
54 AVPacket *pkt = av_mallocz(sizeof(AVPacket));
63 void av_packet_free(AVPacket **pkt)
68 av_packet_unref(*pkt);
72 static int packet_alloc(AVBufferRef **buf, int size)
75 if (size < 0 || size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
76 return AVERROR(EINVAL);
78 ret = av_buffer_realloc(buf, size + AV_INPUT_BUFFER_PADDING_SIZE);
82 memset((*buf)->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
87 int av_new_packet(AVPacket *pkt, int size)
89 AVBufferRef *buf = NULL;
90 int ret = packet_alloc(&buf, size);
96 pkt->data = buf->data;
102 void av_shrink_packet(AVPacket *pkt, int size)
104 if (pkt->size <= size)
107 memset(pkt->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
110 int av_grow_packet(AVPacket *pkt, int grow_by)
113 av_assert0((unsigned)pkt->size <= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE);
114 if ((unsigned)grow_by >
115 INT_MAX - (pkt->size + AV_INPUT_BUFFER_PADDING_SIZE))
116 return AVERROR(ENOMEM);
118 new_size = pkt->size + grow_by + AV_INPUT_BUFFER_PADDING_SIZE;
121 uint8_t *old_data = pkt->data;
122 if (pkt->data == NULL) {
124 pkt->data = pkt->buf->data;
126 data_offset = pkt->data - pkt->buf->data;
127 if (data_offset > INT_MAX - new_size)
128 return AVERROR(ENOMEM);
131 if (new_size + data_offset > pkt->buf->size) {
132 int ret = av_buffer_realloc(&pkt->buf, new_size + data_offset);
134 pkt->data = old_data;
137 pkt->data = pkt->buf->data + data_offset;
140 pkt->buf = av_buffer_alloc(new_size);
142 return AVERROR(ENOMEM);
144 memcpy(pkt->buf->data, pkt->data, pkt->size);
145 pkt->data = pkt->buf->data;
147 pkt->size += grow_by;
148 memset(pkt->data + pkt->size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
153 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
155 if (size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
156 return AVERROR(EINVAL);
158 pkt->buf = av_buffer_create(data, size + AV_INPUT_BUFFER_PADDING_SIZE,
159 av_buffer_default_free, NULL, 0);
161 return AVERROR(ENOMEM);
169 #if FF_API_AVPACKET_OLD_API
170 FF_DISABLE_DEPRECATION_WARNINGS
171 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
172 #define ALLOC_BUF(data, size) \
174 av_buffer_realloc(&pkt->buf, size); \
175 data = pkt->buf ? pkt->buf->data : NULL; \
178 #define DUP_DATA(dst, src, size, padding, ALLOC) \
182 if ((unsigned)(size) > \
183 (unsigned)(size) + AV_INPUT_BUFFER_PADDING_SIZE) \
185 ALLOC(data, size + AV_INPUT_BUFFER_PADDING_SIZE); \
191 memcpy(data, src, size); \
193 memset((uint8_t *)data + size, 0, \
194 AV_INPUT_BUFFER_PADDING_SIZE); \
198 /* Makes duplicates of data, side_data, but does not copy any other fields */
199 static int copy_packet_data(AVPacket *pkt, const AVPacket *src, int dup)
202 pkt->side_data = NULL;
203 pkt->side_data_elems = 0;
205 AVBufferRef *ref = av_buffer_ref(src->buf);
207 return AVERROR(ENOMEM);
209 pkt->data = ref->data;
211 DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
213 if (src->side_data_elems && dup) {
214 pkt->side_data = src->side_data;
215 pkt->side_data_elems = src->side_data_elems;
217 if (src->side_data_elems && !dup) {
218 return av_copy_packet_side_data(pkt, src);
223 av_packet_unref(pkt);
224 return AVERROR(ENOMEM);
227 int av_copy_packet_side_data(AVPacket *pkt, const AVPacket *src)
229 if (src->side_data_elems) {
231 DUP_DATA(pkt->side_data, src->side_data,
232 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
234 memset(pkt->side_data, 0,
235 src->side_data_elems * sizeof(*src->side_data));
237 for (i = 0; i < src->side_data_elems; i++) {
238 DUP_DATA(pkt->side_data[i].data, src->side_data[i].data,
239 src->side_data[i].size, 1, ALLOC_MALLOC);
240 pkt->side_data[i].size = src->side_data[i].size;
241 pkt->side_data[i].type = src->side_data[i].type;
244 pkt->side_data_elems = src->side_data_elems;
248 av_packet_unref(pkt);
249 return AVERROR(ENOMEM);
252 int av_dup_packet(AVPacket *pkt)
256 if (!pkt->buf && pkt->data) {
258 return copy_packet_data(pkt, &tmp_pkt, 1);
263 int av_copy_packet(AVPacket *dst, const AVPacket *src)
266 return copy_packet_data(dst, src, 0);
268 FF_ENABLE_DEPRECATION_WARNINGS
271 void av_packet_free_side_data(AVPacket *pkt)
274 for (i = 0; i < pkt->side_data_elems; i++)
275 av_freep(&pkt->side_data[i].data);
276 av_freep(&pkt->side_data);
277 pkt->side_data_elems = 0;
280 #if FF_API_AVPACKET_OLD_API
281 FF_DISABLE_DEPRECATION_WARNINGS
282 void av_free_packet(AVPacket *pkt)
286 av_buffer_unref(&pkt->buf);
290 av_packet_free_side_data(pkt);
293 FF_ENABLE_DEPRECATION_WARNINGS
296 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
297 uint8_t *data, size_t size)
299 AVPacketSideData *tmp;
300 int i, elems = pkt->side_data_elems;
302 for (i = 0; i < elems; i++) {
303 AVPacketSideData *sd = &pkt->side_data[i];
305 if (sd->type == type) {
313 if ((unsigned)elems + 1 > AV_PKT_DATA_NB)
314 return AVERROR(ERANGE);
316 tmp = av_realloc(pkt->side_data, (elems + 1) * sizeof(*tmp));
318 return AVERROR(ENOMEM);
320 pkt->side_data = tmp;
321 pkt->side_data[elems].data = data;
322 pkt->side_data[elems].size = size;
323 pkt->side_data[elems].type = type;
324 pkt->side_data_elems++;
330 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
336 if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
338 data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
342 ret = av_packet_add_side_data(pkt, type, data, size);
351 uint8_t *av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
356 for (i = 0; i < pkt->side_data_elems; i++) {
357 if (pkt->side_data[i].type == type) {
359 *size = pkt->side_data[i].size;
360 return pkt->side_data[i].data;
368 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
371 case AV_PKT_DATA_PALETTE: return "Palette";
372 case AV_PKT_DATA_NEW_EXTRADATA: return "New Extradata";
373 case AV_PKT_DATA_PARAM_CHANGE: return "Param Change";
374 case AV_PKT_DATA_H263_MB_INFO: return "H263 MB Info";
375 case AV_PKT_DATA_REPLAYGAIN: return "Replay Gain";
376 case AV_PKT_DATA_DISPLAYMATRIX: return "Display Matrix";
377 case AV_PKT_DATA_STEREO3D: return "Stereo 3D";
378 case AV_PKT_DATA_AUDIO_SERVICE_TYPE: return "Audio Service Type";
379 case AV_PKT_DATA_QUALITY_STATS: return "Quality stats";
380 case AV_PKT_DATA_FALLBACK_TRACK: return "Fallback track";
381 case AV_PKT_DATA_CPB_PROPERTIES: return "CPB properties";
382 case AV_PKT_DATA_SKIP_SAMPLES: return "Skip Samples";
383 case AV_PKT_DATA_JP_DUALMONO: return "JP Dual Mono";
384 case AV_PKT_DATA_STRINGS_METADATA: return "Strings Metadata";
385 case AV_PKT_DATA_SUBTITLE_POSITION: return "Subtitle Position";
386 case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL: return "Matroska BlockAdditional";
387 case AV_PKT_DATA_WEBVTT_IDENTIFIER: return "WebVTT ID";
388 case AV_PKT_DATA_WEBVTT_SETTINGS: return "WebVTT Settings";
389 case AV_PKT_DATA_METADATA_UPDATE: return "Metadata Update";
390 case AV_PKT_DATA_MPEGTS_STREAM_ID: return "MPEGTS Stream ID";
391 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
392 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL: return "Content light level metadata";
393 case AV_PKT_DATA_SPHERICAL: return "Spherical Mapping";
394 case AV_PKT_DATA_A53_CC: return "A53 Closed Captions";
395 case AV_PKT_DATA_ENCRYPTION_INIT_INFO: return "Encryption initialization data";
396 case AV_PKT_DATA_ENCRYPTION_INFO: return "Encryption info";
397 case AV_PKT_DATA_AFD: return "Active Format Description data";
398 case AV_PKT_DATA_ICC_PROFILE: return "ICC Profile";
399 case AV_PKT_DATA_DOVI_CONF: return "DOVI configuration record";
404 #if FF_API_MERGE_SD_API
406 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
408 int av_packet_merge_side_data(AVPacket *pkt){
409 if(pkt->side_data_elems){
413 uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
415 for (i=0; i<old.side_data_elems; i++) {
416 size += old.side_data[i].size + 5LL;
419 return AVERROR(EINVAL);
420 buf = av_buffer_alloc(size);
422 return AVERROR(ENOMEM);
424 pkt->data = p = buf->data;
425 pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
426 bytestream_put_buffer(&p, old.data, old.size);
427 for (i=old.side_data_elems-1; i>=0; i--) {
428 bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
429 bytestream_put_be32(&p, old.side_data[i].size);
430 *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
432 bytestream_put_be64(&p, FF_MERGE_MARKER);
433 av_assert0(p-pkt->data == pkt->size);
434 memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
435 av_packet_unref(&old);
436 pkt->side_data_elems = 0;
437 pkt->side_data = NULL;
443 int av_packet_split_side_data(AVPacket *pkt){
444 if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
449 p = pkt->data + pkt->size - 8 - 5;
452 if (size>INT_MAX - 5 || p - pkt->data < size)
456 if (p - pkt->data < size + 5)
461 if (i > AV_PKT_DATA_NB)
462 return AVERROR(ERANGE);
464 pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
466 return AVERROR(ENOMEM);
468 p= pkt->data + pkt->size - 8 - 5;
471 av_assert0(size<=INT_MAX - 5 && p - pkt->data >= size);
472 pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
473 pkt->side_data[i].size = size;
474 pkt->side_data[i].type = p[4]&127;
475 if (!pkt->side_data[i].data)
476 return AVERROR(ENOMEM);
477 memcpy(pkt->side_data[i].data, p-size, size);
478 pkt->size -= size + 5;
484 pkt->side_data_elems = i+1;
491 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
493 AVDictionaryEntry *t = NULL;
494 uint8_t *data = NULL;
500 while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
501 const size_t keylen = strlen(t->key);
502 const size_t valuelen = strlen(t->value);
503 const size_t new_size = *size + keylen + 1 + valuelen + 1;
504 uint8_t *const new_data = av_realloc(data, new_size);
509 if (new_size > INT_MAX)
512 memcpy(data + *size, t->key, keylen + 1);
513 memcpy(data + *size + keylen + 1, t->value, valuelen + 1);
526 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
531 if (!dict || !data || !size)
535 return AVERROR_INVALIDDATA;
537 const uint8_t *key = data;
538 const uint8_t *val = data + strlen(key) + 1;
540 if (val >= end || !*key)
541 return AVERROR_INVALIDDATA;
543 ret = av_dict_set(dict, key, val, 0);
546 data = val + strlen(val) + 1;
552 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
557 for (i = 0; i < pkt->side_data_elems; i++) {
558 if (pkt->side_data[i].type == type) {
559 if (size > pkt->side_data[i].size)
560 return AVERROR(ENOMEM);
561 pkt->side_data[i].size = size;
565 return AVERROR(ENOENT);
568 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
575 dst->duration = src->duration;
576 #if FF_API_CONVERGENCE_DURATION
577 FF_DISABLE_DEPRECATION_WARNINGS
578 dst->convergence_duration = src->convergence_duration;
579 FF_ENABLE_DEPRECATION_WARNINGS
581 dst->flags = src->flags;
582 dst->stream_index = src->stream_index;
584 dst->side_data = NULL;
585 dst->side_data_elems = 0;
586 for (i = 0; i < src->side_data_elems; i++) {
587 enum AVPacketSideDataType type = src->side_data[i].type;
588 int size = src->side_data[i].size;
589 uint8_t *src_data = src->side_data[i].data;
590 uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
593 av_packet_free_side_data(dst);
594 return AVERROR(ENOMEM);
596 memcpy(dst_data, src_data, size);
602 void av_packet_unref(AVPacket *pkt)
604 av_packet_free_side_data(pkt);
605 av_buffer_unref(&pkt->buf);
611 int av_packet_ref(AVPacket *dst, const AVPacket *src)
617 ret = av_packet_copy_props(dst, src);
622 ret = packet_alloc(&dst->buf, src->size);
625 av_assert1(!src->size || src->data);
627 memcpy(dst->buf->data, src->data, src->size);
629 dst->data = dst->buf->data;
631 dst->buf = av_buffer_ref(src->buf);
633 ret = AVERROR(ENOMEM);
636 dst->data = src->data;
639 dst->size = src->size;
643 av_packet_unref(dst);
647 AVPacket *av_packet_clone(const AVPacket *src)
649 AVPacket *ret = av_packet_alloc();
654 if (av_packet_ref(ret, src))
655 av_packet_free(&ret);
660 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
668 int av_packet_make_refcounted(AVPacket *pkt)
675 ret = packet_alloc(&pkt->buf, pkt->size);
678 av_assert1(!pkt->size || pkt->data);
680 memcpy(pkt->buf->data, pkt->data, pkt->size);
682 pkt->data = pkt->buf->data;
687 int av_packet_make_writable(AVPacket *pkt)
689 AVBufferRef *buf = NULL;
692 if (pkt->buf && av_buffer_is_writable(pkt->buf))
695 ret = packet_alloc(&buf, pkt->size);
698 av_assert1(!pkt->size || pkt->data);
700 memcpy(buf->data, pkt->data, pkt->size);
702 av_buffer_unref(&pkt->buf);
704 pkt->data = buf->data;
709 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
711 if (pkt->pts != AV_NOPTS_VALUE)
712 pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
713 if (pkt->dts != AV_NOPTS_VALUE)
714 pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
715 if (pkt->duration > 0)
716 pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
717 #if FF_API_CONVERGENCE_DURATION
718 FF_DISABLE_DEPRECATION_WARNINGS
719 if (pkt->convergence_duration > 0)
720 pkt->convergence_duration = av_rescale_q(pkt->convergence_duration, src_tb, dst_tb);
721 FF_ENABLE_DEPRECATION_WARNINGS
725 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
731 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
733 side_data_size = 4+4+8*error_count;
734 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
738 if (!side_data || side_data_size < 4+4+8*error_count)
739 return AVERROR(ENOMEM);
741 AV_WL32(side_data , quality );
742 side_data[4] = pict_type;
743 side_data[5] = error_count;
744 for (i = 0; i<error_count; i++)
745 AV_WL64(side_data+8 + 8*i , error[i]);
750 int ff_side_data_set_prft(AVPacket *pkt, int64_t timestamp)
752 AVProducerReferenceTime *prft;
756 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_PRFT, &side_data_size);
758 side_data_size = sizeof(AVProducerReferenceTime);
759 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_PRFT, side_data_size);
762 if (!side_data || side_data_size < sizeof(AVProducerReferenceTime))
763 return AVERROR(ENOMEM);
765 prft = (AVProducerReferenceTime *)side_data;
766 prft->wallclock = timestamp;