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 !av_buffer_is_writable(pkt->buf)) {
133 int ret = av_buffer_realloc(&pkt->buf, new_size + data_offset);
135 pkt->data = old_data;
138 pkt->data = pkt->buf->data + data_offset;
141 pkt->buf = av_buffer_alloc(new_size);
143 return AVERROR(ENOMEM);
145 memcpy(pkt->buf->data, pkt->data, pkt->size);
146 pkt->data = pkt->buf->data;
148 pkt->size += grow_by;
149 memset(pkt->data + pkt->size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
154 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
156 if (size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
157 return AVERROR(EINVAL);
159 pkt->buf = av_buffer_create(data, size + AV_INPUT_BUFFER_PADDING_SIZE,
160 av_buffer_default_free, NULL, 0);
162 return AVERROR(ENOMEM);
170 #if FF_API_AVPACKET_OLD_API
171 FF_DISABLE_DEPRECATION_WARNINGS
172 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
173 #define ALLOC_BUF(data, size) \
175 av_buffer_realloc(&pkt->buf, size); \
176 data = pkt->buf ? pkt->buf->data : NULL; \
179 #define DUP_DATA(dst, src, size, padding, ALLOC) \
183 if ((unsigned)(size) > \
184 (unsigned)(size) + AV_INPUT_BUFFER_PADDING_SIZE) \
186 ALLOC(data, size + AV_INPUT_BUFFER_PADDING_SIZE); \
192 memcpy(data, src, size); \
194 memset((uint8_t *)data + size, 0, \
195 AV_INPUT_BUFFER_PADDING_SIZE); \
199 /* Makes duplicates of data, side_data, but does not copy any other fields */
200 static int copy_packet_data(AVPacket *pkt, const AVPacket *src, int dup)
203 pkt->side_data = NULL;
204 pkt->side_data_elems = 0;
206 AVBufferRef *ref = av_buffer_ref(src->buf);
208 return AVERROR(ENOMEM);
210 pkt->data = ref->data;
212 DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
214 if (src->side_data_elems && dup) {
215 pkt->side_data = src->side_data;
216 pkt->side_data_elems = src->side_data_elems;
218 if (src->side_data_elems && !dup) {
219 return av_copy_packet_side_data(pkt, src);
224 av_packet_unref(pkt);
225 return AVERROR(ENOMEM);
228 int av_copy_packet_side_data(AVPacket *pkt, const AVPacket *src)
230 if (src->side_data_elems) {
232 DUP_DATA(pkt->side_data, src->side_data,
233 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
235 memset(pkt->side_data, 0,
236 src->side_data_elems * sizeof(*src->side_data));
238 for (i = 0; i < src->side_data_elems; i++) {
239 DUP_DATA(pkt->side_data[i].data, src->side_data[i].data,
240 src->side_data[i].size, 1, ALLOC_MALLOC);
241 pkt->side_data[i].size = src->side_data[i].size;
242 pkt->side_data[i].type = src->side_data[i].type;
245 pkt->side_data_elems = src->side_data_elems;
249 av_packet_unref(pkt);
250 return AVERROR(ENOMEM);
253 int av_dup_packet(AVPacket *pkt)
257 if (!pkt->buf && pkt->data) {
259 return copy_packet_data(pkt, &tmp_pkt, 1);
264 int av_copy_packet(AVPacket *dst, const AVPacket *src)
267 return copy_packet_data(dst, src, 0);
269 FF_ENABLE_DEPRECATION_WARNINGS
272 void av_packet_free_side_data(AVPacket *pkt)
275 for (i = 0; i < pkt->side_data_elems; i++)
276 av_freep(&pkt->side_data[i].data);
277 av_freep(&pkt->side_data);
278 pkt->side_data_elems = 0;
281 #if FF_API_AVPACKET_OLD_API
282 FF_DISABLE_DEPRECATION_WARNINGS
283 void av_free_packet(AVPacket *pkt)
287 av_buffer_unref(&pkt->buf);
291 av_packet_free_side_data(pkt);
294 FF_ENABLE_DEPRECATION_WARNINGS
297 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
298 uint8_t *data, size_t size)
300 AVPacketSideData *tmp;
301 int i, elems = pkt->side_data_elems;
303 for (i = 0; i < elems; i++) {
304 AVPacketSideData *sd = &pkt->side_data[i];
306 if (sd->type == type) {
314 if ((unsigned)elems + 1 > AV_PKT_DATA_NB)
315 return AVERROR(ERANGE);
317 tmp = av_realloc(pkt->side_data, (elems + 1) * sizeof(*tmp));
319 return AVERROR(ENOMEM);
321 pkt->side_data = tmp;
322 pkt->side_data[elems].data = data;
323 pkt->side_data[elems].size = size;
324 pkt->side_data[elems].type = type;
325 pkt->side_data_elems++;
331 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
337 if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
339 data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
343 ret = av_packet_add_side_data(pkt, type, data, size);
352 uint8_t *av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
357 for (i = 0; i < pkt->side_data_elems; i++) {
358 if (pkt->side_data[i].type == type) {
360 *size = pkt->side_data[i].size;
361 return pkt->side_data[i].data;
369 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
372 case AV_PKT_DATA_PALETTE: return "Palette";
373 case AV_PKT_DATA_NEW_EXTRADATA: return "New Extradata";
374 case AV_PKT_DATA_PARAM_CHANGE: return "Param Change";
375 case AV_PKT_DATA_H263_MB_INFO: return "H263 MB Info";
376 case AV_PKT_DATA_REPLAYGAIN: return "Replay Gain";
377 case AV_PKT_DATA_DISPLAYMATRIX: return "Display Matrix";
378 case AV_PKT_DATA_STEREO3D: return "Stereo 3D";
379 case AV_PKT_DATA_AUDIO_SERVICE_TYPE: return "Audio Service Type";
380 case AV_PKT_DATA_QUALITY_STATS: return "Quality stats";
381 case AV_PKT_DATA_FALLBACK_TRACK: return "Fallback track";
382 case AV_PKT_DATA_CPB_PROPERTIES: return "CPB properties";
383 case AV_PKT_DATA_SKIP_SAMPLES: return "Skip Samples";
384 case AV_PKT_DATA_JP_DUALMONO: return "JP Dual Mono";
385 case AV_PKT_DATA_STRINGS_METADATA: return "Strings Metadata";
386 case AV_PKT_DATA_SUBTITLE_POSITION: return "Subtitle Position";
387 case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL: return "Matroska BlockAdditional";
388 case AV_PKT_DATA_WEBVTT_IDENTIFIER: return "WebVTT ID";
389 case AV_PKT_DATA_WEBVTT_SETTINGS: return "WebVTT Settings";
390 case AV_PKT_DATA_METADATA_UPDATE: return "Metadata Update";
391 case AV_PKT_DATA_MPEGTS_STREAM_ID: return "MPEGTS Stream ID";
392 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
393 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL: return "Content light level metadata";
394 case AV_PKT_DATA_SPHERICAL: return "Spherical Mapping";
395 case AV_PKT_DATA_A53_CC: return "A53 Closed Captions";
396 case AV_PKT_DATA_ENCRYPTION_INIT_INFO: return "Encryption initialization data";
397 case AV_PKT_DATA_ENCRYPTION_INFO: return "Encryption info";
398 case AV_PKT_DATA_AFD: return "Active Format Description data";
399 case AV_PKT_DATA_PRFT: return "Producer Reference Time";
400 case AV_PKT_DATA_ICC_PROFILE: return "ICC Profile";
401 case AV_PKT_DATA_DOVI_CONF: return "DOVI configuration record";
406 #if FF_API_MERGE_SD_API
408 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
410 int av_packet_merge_side_data(AVPacket *pkt){
411 if(pkt->side_data_elems){
415 uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
417 for (i=0; i<old.side_data_elems; i++) {
418 size += old.side_data[i].size + 5LL;
421 return AVERROR(EINVAL);
422 buf = av_buffer_alloc(size);
424 return AVERROR(ENOMEM);
426 pkt->data = p = buf->data;
427 pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
428 bytestream_put_buffer(&p, old.data, old.size);
429 for (i=old.side_data_elems-1; i>=0; i--) {
430 bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
431 bytestream_put_be32(&p, old.side_data[i].size);
432 *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
434 bytestream_put_be64(&p, FF_MERGE_MARKER);
435 av_assert0(p-pkt->data == pkt->size);
436 memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
437 av_packet_unref(&old);
438 pkt->side_data_elems = 0;
439 pkt->side_data = NULL;
445 int av_packet_split_side_data(AVPacket *pkt){
446 if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
451 p = pkt->data + pkt->size - 8 - 5;
454 if (size>INT_MAX - 5 || p - pkt->data < size)
458 if (p - pkt->data < size + 5)
463 if (i > AV_PKT_DATA_NB)
464 return AVERROR(ERANGE);
466 pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
468 return AVERROR(ENOMEM);
470 p= pkt->data + pkt->size - 8 - 5;
473 av_assert0(size<=INT_MAX - 5 && p - pkt->data >= size);
474 pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
475 pkt->side_data[i].size = size;
476 pkt->side_data[i].type = p[4]&127;
477 if (!pkt->side_data[i].data)
478 return AVERROR(ENOMEM);
479 memcpy(pkt->side_data[i].data, p-size, size);
480 pkt->size -= size + 5;
486 pkt->side_data_elems = i+1;
493 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
495 AVDictionaryEntry *t = NULL;
496 uint8_t *data = NULL;
502 while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
503 const size_t keylen = strlen(t->key);
504 const size_t valuelen = strlen(t->value);
505 const size_t new_size = *size + keylen + 1 + valuelen + 1;
506 uint8_t *const new_data = av_realloc(data, new_size);
511 if (new_size > INT_MAX)
514 memcpy(data + *size, t->key, keylen + 1);
515 memcpy(data + *size + keylen + 1, t->value, valuelen + 1);
528 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
533 if (!dict || !data || !size)
537 return AVERROR_INVALIDDATA;
539 const uint8_t *key = data;
540 const uint8_t *val = data + strlen(key) + 1;
542 if (val >= end || !*key)
543 return AVERROR_INVALIDDATA;
545 ret = av_dict_set(dict, key, val, 0);
548 data = val + strlen(val) + 1;
554 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
559 for (i = 0; i < pkt->side_data_elems; i++) {
560 if (pkt->side_data[i].type == type) {
561 if (size > pkt->side_data[i].size)
562 return AVERROR(ENOMEM);
563 pkt->side_data[i].size = size;
567 return AVERROR(ENOENT);
570 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
577 dst->duration = src->duration;
578 #if FF_API_CONVERGENCE_DURATION
579 FF_DISABLE_DEPRECATION_WARNINGS
580 dst->convergence_duration = src->convergence_duration;
581 FF_ENABLE_DEPRECATION_WARNINGS
583 dst->flags = src->flags;
584 dst->stream_index = src->stream_index;
586 dst->side_data = NULL;
587 dst->side_data_elems = 0;
588 for (i = 0; i < src->side_data_elems; i++) {
589 enum AVPacketSideDataType type = src->side_data[i].type;
590 int size = src->side_data[i].size;
591 uint8_t *src_data = src->side_data[i].data;
592 uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
595 av_packet_free_side_data(dst);
596 return AVERROR(ENOMEM);
598 memcpy(dst_data, src_data, size);
604 void av_packet_unref(AVPacket *pkt)
606 av_packet_free_side_data(pkt);
607 av_buffer_unref(&pkt->buf);
613 int av_packet_ref(AVPacket *dst, const AVPacket *src)
619 ret = av_packet_copy_props(dst, src);
624 ret = packet_alloc(&dst->buf, src->size);
627 av_assert1(!src->size || src->data);
629 memcpy(dst->buf->data, src->data, src->size);
631 dst->data = dst->buf->data;
633 dst->buf = av_buffer_ref(src->buf);
635 ret = AVERROR(ENOMEM);
638 dst->data = src->data;
641 dst->size = src->size;
645 av_packet_unref(dst);
649 AVPacket *av_packet_clone(const AVPacket *src)
651 AVPacket *ret = av_packet_alloc();
656 if (av_packet_ref(ret, src))
657 av_packet_free(&ret);
662 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
670 int av_packet_make_refcounted(AVPacket *pkt)
677 ret = packet_alloc(&pkt->buf, pkt->size);
680 av_assert1(!pkt->size || pkt->data);
682 memcpy(pkt->buf->data, pkt->data, pkt->size);
684 pkt->data = pkt->buf->data;
689 int av_packet_make_writable(AVPacket *pkt)
691 AVBufferRef *buf = NULL;
694 if (pkt->buf && av_buffer_is_writable(pkt->buf))
697 ret = packet_alloc(&buf, pkt->size);
700 av_assert1(!pkt->size || pkt->data);
702 memcpy(buf->data, pkt->data, pkt->size);
704 av_buffer_unref(&pkt->buf);
706 pkt->data = buf->data;
711 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
713 if (pkt->pts != AV_NOPTS_VALUE)
714 pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
715 if (pkt->dts != AV_NOPTS_VALUE)
716 pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
717 if (pkt->duration > 0)
718 pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
719 #if FF_API_CONVERGENCE_DURATION
720 FF_DISABLE_DEPRECATION_WARNINGS
721 if (pkt->convergence_duration > 0)
722 pkt->convergence_duration = av_rescale_q(pkt->convergence_duration, src_tb, dst_tb);
723 FF_ENABLE_DEPRECATION_WARNINGS
727 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
733 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
735 side_data_size = 4+4+8*error_count;
736 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
740 if (!side_data || side_data_size < 4+4+8*error_count)
741 return AVERROR(ENOMEM);
743 AV_WL32(side_data , quality );
744 side_data[4] = pict_type;
745 side_data[5] = error_count;
746 for (i = 0; i<error_count; i++)
747 AV_WL64(side_data+8 + 8*i , error[i]);
752 int ff_side_data_set_prft(AVPacket *pkt, int64_t timestamp)
754 AVProducerReferenceTime *prft;
758 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_PRFT, &side_data_size);
760 side_data_size = sizeof(AVProducerReferenceTime);
761 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_PRFT, side_data_size);
764 if (!side_data || side_data_size < sizeof(AVProducerReferenceTime))
765 return AVERROR(ENOMEM);
767 prft = (AVProducerReferenceTime *)side_data;
768 prft->wallclock = timestamp;