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"
33 #include "packet_internal.h"
35 #if FF_API_INIT_PACKET
36 void av_init_packet(AVPacket *pkt)
38 pkt->pts = AV_NOPTS_VALUE;
39 pkt->dts = AV_NOPTS_VALUE;
43 pkt->stream_index = 0;
45 pkt->side_data = NULL;
46 pkt->side_data_elems = 0;
50 static void get_packet_defaults(AVPacket *pkt)
52 memset(pkt, 0, sizeof(*pkt));
54 pkt->pts = AV_NOPTS_VALUE;
55 pkt->dts = AV_NOPTS_VALUE;
59 AVPacket *av_packet_alloc(void)
61 AVPacket *pkt = av_mallocz(sizeof(AVPacket));
65 get_packet_defaults(pkt);
70 void av_packet_free(AVPacket **pkt)
75 av_packet_unref(*pkt);
79 static int packet_alloc(AVBufferRef **buf, int size)
82 if (size < 0 || size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
83 return AVERROR(EINVAL);
85 ret = av_buffer_realloc(buf, size + AV_INPUT_BUFFER_PADDING_SIZE);
89 memset((*buf)->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
94 int av_new_packet(AVPacket *pkt, int size)
96 AVBufferRef *buf = NULL;
97 int ret = packet_alloc(&buf, size);
101 get_packet_defaults(pkt);
103 pkt->data = buf->data;
109 void av_shrink_packet(AVPacket *pkt, int size)
111 if (pkt->size <= size)
114 memset(pkt->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
117 int av_grow_packet(AVPacket *pkt, int grow_by)
120 av_assert0((unsigned)pkt->size <= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE);
121 if ((unsigned)grow_by >
122 INT_MAX - (pkt->size + AV_INPUT_BUFFER_PADDING_SIZE))
123 return AVERROR(ENOMEM);
125 new_size = pkt->size + grow_by + AV_INPUT_BUFFER_PADDING_SIZE;
128 uint8_t *old_data = pkt->data;
129 if (pkt->data == NULL) {
131 pkt->data = pkt->buf->data;
133 data_offset = pkt->data - pkt->buf->data;
134 if (data_offset > INT_MAX - new_size)
135 return AVERROR(ENOMEM);
138 if (new_size + data_offset > pkt->buf->size ||
139 !av_buffer_is_writable(pkt->buf)) {
140 int ret = av_buffer_realloc(&pkt->buf, new_size + data_offset);
142 pkt->data = old_data;
145 pkt->data = pkt->buf->data + data_offset;
148 pkt->buf = av_buffer_alloc(new_size);
150 return AVERROR(ENOMEM);
152 memcpy(pkt->buf->data, pkt->data, pkt->size);
153 pkt->data = pkt->buf->data;
155 pkt->size += grow_by;
156 memset(pkt->data + pkt->size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
161 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
163 if (size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
164 return AVERROR(EINVAL);
166 pkt->buf = av_buffer_create(data, size + AV_INPUT_BUFFER_PADDING_SIZE,
167 av_buffer_default_free, NULL, 0);
169 return AVERROR(ENOMEM);
177 #if FF_API_AVPACKET_OLD_API
178 FF_DISABLE_DEPRECATION_WARNINGS
179 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
180 #define ALLOC_BUF(data, size) \
182 av_buffer_realloc(&pkt->buf, size); \
183 data = pkt->buf ? pkt->buf->data : NULL; \
186 #define DUP_DATA(dst, src, size, padding, ALLOC) \
190 if ((unsigned)(size) > \
191 (unsigned)(size) + AV_INPUT_BUFFER_PADDING_SIZE) \
193 ALLOC(data, size + AV_INPUT_BUFFER_PADDING_SIZE); \
199 memcpy(data, src, size); \
201 memset((uint8_t *)data + size, 0, \
202 AV_INPUT_BUFFER_PADDING_SIZE); \
206 /* Makes duplicates of data, side_data, but does not copy any other fields */
207 static int copy_packet_data(AVPacket *pkt, const AVPacket *src, int dup)
210 pkt->side_data = NULL;
211 pkt->side_data_elems = 0;
213 AVBufferRef *ref = av_buffer_ref(src->buf);
215 return AVERROR(ENOMEM);
217 pkt->data = ref->data;
219 DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
221 if (src->side_data_elems && dup) {
222 pkt->side_data = src->side_data;
223 pkt->side_data_elems = src->side_data_elems;
225 if (src->side_data_elems && !dup) {
226 return av_copy_packet_side_data(pkt, src);
231 av_packet_unref(pkt);
232 return AVERROR(ENOMEM);
235 int av_copy_packet_side_data(AVPacket *pkt, const AVPacket *src)
237 if (src->side_data_elems) {
239 DUP_DATA(pkt->side_data, src->side_data,
240 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
242 memset(pkt->side_data, 0,
243 src->side_data_elems * sizeof(*src->side_data));
245 for (i = 0; i < src->side_data_elems; i++) {
246 DUP_DATA(pkt->side_data[i].data, src->side_data[i].data,
247 src->side_data[i].size, 1, ALLOC_MALLOC);
248 pkt->side_data[i].size = src->side_data[i].size;
249 pkt->side_data[i].type = src->side_data[i].type;
252 pkt->side_data_elems = src->side_data_elems;
256 av_packet_unref(pkt);
257 return AVERROR(ENOMEM);
260 int av_dup_packet(AVPacket *pkt)
264 if (!pkt->buf && pkt->data) {
266 return copy_packet_data(pkt, &tmp_pkt, 1);
271 int av_copy_packet(AVPacket *dst, const AVPacket *src)
274 return copy_packet_data(dst, src, 0);
276 FF_ENABLE_DEPRECATION_WARNINGS
279 void av_packet_free_side_data(AVPacket *pkt)
282 for (i = 0; i < pkt->side_data_elems; i++)
283 av_freep(&pkt->side_data[i].data);
284 av_freep(&pkt->side_data);
285 pkt->side_data_elems = 0;
288 #if FF_API_AVPACKET_OLD_API
289 FF_DISABLE_DEPRECATION_WARNINGS
290 void av_free_packet(AVPacket *pkt)
294 av_buffer_unref(&pkt->buf);
298 av_packet_free_side_data(pkt);
301 FF_ENABLE_DEPRECATION_WARNINGS
304 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
305 uint8_t *data, size_t size)
307 AVPacketSideData *tmp;
308 int i, elems = pkt->side_data_elems;
310 for (i = 0; i < elems; i++) {
311 AVPacketSideData *sd = &pkt->side_data[i];
313 if (sd->type == type) {
321 if ((unsigned)elems + 1 > AV_PKT_DATA_NB)
322 return AVERROR(ERANGE);
324 tmp = av_realloc(pkt->side_data, (elems + 1) * sizeof(*tmp));
326 return AVERROR(ENOMEM);
328 pkt->side_data = tmp;
329 pkt->side_data[elems].data = data;
330 pkt->side_data[elems].size = size;
331 pkt->side_data[elems].type = type;
332 pkt->side_data_elems++;
338 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
344 #if FF_API_BUFFER_SIZE_T
345 if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
347 if (size > SIZE_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
350 data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
354 ret = av_packet_add_side_data(pkt, type, data, size);
363 uint8_t *av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
368 for (i = 0; i < pkt->side_data_elems; i++) {
369 if (pkt->side_data[i].type == type) {
371 *size = pkt->side_data[i].size;
372 return pkt->side_data[i].data;
380 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
383 case AV_PKT_DATA_PALETTE: return "Palette";
384 case AV_PKT_DATA_NEW_EXTRADATA: return "New Extradata";
385 case AV_PKT_DATA_PARAM_CHANGE: return "Param Change";
386 case AV_PKT_DATA_H263_MB_INFO: return "H263 MB Info";
387 case AV_PKT_DATA_REPLAYGAIN: return "Replay Gain";
388 case AV_PKT_DATA_DISPLAYMATRIX: return "Display Matrix";
389 case AV_PKT_DATA_STEREO3D: return "Stereo 3D";
390 case AV_PKT_DATA_AUDIO_SERVICE_TYPE: return "Audio Service Type";
391 case AV_PKT_DATA_QUALITY_STATS: return "Quality stats";
392 case AV_PKT_DATA_FALLBACK_TRACK: return "Fallback track";
393 case AV_PKT_DATA_CPB_PROPERTIES: return "CPB properties";
394 case AV_PKT_DATA_SKIP_SAMPLES: return "Skip Samples";
395 case AV_PKT_DATA_JP_DUALMONO: return "JP Dual Mono";
396 case AV_PKT_DATA_STRINGS_METADATA: return "Strings Metadata";
397 case AV_PKT_DATA_SUBTITLE_POSITION: return "Subtitle Position";
398 case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL: return "Matroska BlockAdditional";
399 case AV_PKT_DATA_WEBVTT_IDENTIFIER: return "WebVTT ID";
400 case AV_PKT_DATA_WEBVTT_SETTINGS: return "WebVTT Settings";
401 case AV_PKT_DATA_METADATA_UPDATE: return "Metadata Update";
402 case AV_PKT_DATA_MPEGTS_STREAM_ID: return "MPEGTS Stream ID";
403 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
404 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL: return "Content light level metadata";
405 case AV_PKT_DATA_SPHERICAL: return "Spherical Mapping";
406 case AV_PKT_DATA_A53_CC: return "A53 Closed Captions";
407 case AV_PKT_DATA_ENCRYPTION_INIT_INFO: return "Encryption initialization data";
408 case AV_PKT_DATA_ENCRYPTION_INFO: return "Encryption info";
409 case AV_PKT_DATA_AFD: return "Active Format Description data";
410 case AV_PKT_DATA_PRFT: return "Producer Reference Time";
411 case AV_PKT_DATA_ICC_PROFILE: return "ICC Profile";
412 case AV_PKT_DATA_DOVI_CONF: return "DOVI configuration record";
413 case AV_PKT_DATA_S12M_TIMECODE: return "SMPTE ST 12-1:2014 timecode";
418 #if FF_API_MERGE_SD_API
420 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
422 int av_packet_merge_side_data(AVPacket *pkt){
423 if(pkt->side_data_elems){
427 uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
429 for (i=0; i<old.side_data_elems; i++) {
430 size += old.side_data[i].size + 5LL;
433 return AVERROR(EINVAL);
434 buf = av_buffer_alloc(size);
436 return AVERROR(ENOMEM);
438 pkt->data = p = buf->data;
439 pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
440 bytestream_put_buffer(&p, old.data, old.size);
441 for (i=old.side_data_elems-1; i>=0; i--) {
442 bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
443 bytestream_put_be32(&p, old.side_data[i].size);
444 *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
446 bytestream_put_be64(&p, FF_MERGE_MARKER);
447 av_assert0(p-pkt->data == pkt->size);
448 memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
449 av_packet_unref(&old);
450 pkt->side_data_elems = 0;
451 pkt->side_data = NULL;
457 int av_packet_split_side_data(AVPacket *pkt){
458 if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
463 p = pkt->data + pkt->size - 8 - 5;
466 if (size>INT_MAX - 5 || p - pkt->data < size)
470 if (p - pkt->data < size + 5)
475 if (i > AV_PKT_DATA_NB)
476 return AVERROR(ERANGE);
478 pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
480 return AVERROR(ENOMEM);
482 p= pkt->data + pkt->size - 8 - 5;
485 av_assert0(size<=INT_MAX - 5 && p - pkt->data >= size);
486 pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
487 pkt->side_data[i].size = size;
488 pkt->side_data[i].type = p[4]&127;
489 if (!pkt->side_data[i].data)
490 return AVERROR(ENOMEM);
491 memcpy(pkt->side_data[i].data, p-size, size);
492 pkt->size -= size + 5;
498 pkt->side_data_elems = i+1;
505 #if FF_API_BUFFER_SIZE_T
506 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
508 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, size_t *size)
511 uint8_t *data = NULL;
517 for (int pass = 0; pass < 2; pass++) {
518 const AVDictionaryEntry *t = NULL;
519 size_t total_length = 0;
521 while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
522 for (int i = 0; i < 2; i++) {
523 const char *str = i ? t->value : t->key;
524 const size_t len = strlen(str) + 1;
527 memcpy(data + total_length, str, len);
528 #if FF_API_BUFFER_SIZE_T
529 else if (len > INT_MAX - total_length)
531 else if (len > SIZE_MAX - total_length)
539 data = av_malloc(total_length);
542 *size = total_length;
548 #if FF_API_BUFFER_SIZE_T
549 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
551 int av_packet_unpack_dictionary(const uint8_t *data, size_t size,
558 if (!dict || !data || !size)
562 return AVERROR_INVALIDDATA;
564 const uint8_t *key = data;
565 const uint8_t *val = data + strlen(key) + 1;
567 if (val >= end || !*key)
568 return AVERROR_INVALIDDATA;
570 ret = av_dict_set(dict, key, val, 0);
573 data = val + strlen(val) + 1;
579 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
584 for (i = 0; i < pkt->side_data_elems; i++) {
585 if (pkt->side_data[i].type == type) {
586 if (size > pkt->side_data[i].size)
587 return AVERROR(ENOMEM);
588 pkt->side_data[i].size = size;
592 return AVERROR(ENOENT);
595 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
602 dst->duration = src->duration;
603 dst->flags = src->flags;
604 dst->stream_index = src->stream_index;
606 dst->side_data = NULL;
607 dst->side_data_elems = 0;
608 for (i = 0; i < src->side_data_elems; i++) {
609 enum AVPacketSideDataType type = src->side_data[i].type;
610 buffer_size_t size = src->side_data[i].size;
611 uint8_t *src_data = src->side_data[i].data;
612 uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
615 av_packet_free_side_data(dst);
616 return AVERROR(ENOMEM);
618 memcpy(dst_data, src_data, size);
624 void av_packet_unref(AVPacket *pkt)
626 av_packet_free_side_data(pkt);
627 av_buffer_unref(&pkt->buf);
628 get_packet_defaults(pkt);
631 int av_packet_ref(AVPacket *dst, const AVPacket *src)
637 ret = av_packet_copy_props(dst, src);
642 ret = packet_alloc(&dst->buf, src->size);
645 av_assert1(!src->size || src->data);
647 memcpy(dst->buf->data, src->data, src->size);
649 dst->data = dst->buf->data;
651 dst->buf = av_buffer_ref(src->buf);
653 ret = AVERROR(ENOMEM);
656 dst->data = src->data;
659 dst->size = src->size;
663 av_packet_unref(dst);
667 AVPacket *av_packet_clone(const AVPacket *src)
669 AVPacket *ret = av_packet_alloc();
674 if (av_packet_ref(ret, src))
675 av_packet_free(&ret);
680 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
683 get_packet_defaults(src);
686 int av_packet_make_refcounted(AVPacket *pkt)
693 ret = packet_alloc(&pkt->buf, pkt->size);
696 av_assert1(!pkt->size || pkt->data);
698 memcpy(pkt->buf->data, pkt->data, pkt->size);
700 pkt->data = pkt->buf->data;
705 int av_packet_make_writable(AVPacket *pkt)
707 AVBufferRef *buf = NULL;
710 if (pkt->buf && av_buffer_is_writable(pkt->buf))
713 ret = packet_alloc(&buf, pkt->size);
716 av_assert1(!pkt->size || pkt->data);
718 memcpy(buf->data, pkt->data, pkt->size);
720 av_buffer_unref(&pkt->buf);
722 pkt->data = buf->data;
727 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
729 if (pkt->pts != AV_NOPTS_VALUE)
730 pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
731 if (pkt->dts != AV_NOPTS_VALUE)
732 pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
733 if (pkt->duration > 0)
734 pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
737 int avpriv_packet_list_put(PacketList **packet_buffer,
738 PacketList **plast_pktl,
740 int (*copy)(AVPacket *dst, const AVPacket *src),
743 PacketList *pktl = av_mallocz(sizeof(PacketList));
747 return AVERROR(ENOMEM);
750 ret = copy(&pktl->pkt, pkt);
756 ret = av_packet_make_refcounted(pkt);
761 av_packet_move_ref(&pktl->pkt, pkt);
765 (*plast_pktl)->next = pktl;
767 *packet_buffer = pktl;
769 /* Add the packet in the buffered packet list. */
774 int avpriv_packet_list_get(PacketList **pkt_buffer,
775 PacketList **pkt_buffer_end,
780 return AVERROR(EAGAIN);
783 *pkt_buffer = pktl->next;
785 *pkt_buffer_end = NULL;
790 void avpriv_packet_list_free(PacketList **pkt_buf, PacketList **pkt_buf_end)
792 PacketList *tmp = *pkt_buf;
795 PacketList *pktl = tmp;
797 av_packet_unref(&pktl->pkt);
804 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
807 buffer_size_t side_data_size;
810 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
812 side_data_size = 4+4+8*error_count;
813 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
817 if (!side_data || side_data_size < 4+4+8*error_count)
818 return AVERROR(ENOMEM);
820 AV_WL32(side_data , quality );
821 side_data[4] = pict_type;
822 side_data[5] = error_count;
823 for (i = 0; i<error_count; i++)
824 AV_WL64(side_data+8 + 8*i , error[i]);
829 int ff_side_data_set_prft(AVPacket *pkt, int64_t timestamp)
831 AVProducerReferenceTime *prft;
833 buffer_size_t side_data_size;
835 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_PRFT, &side_data_size);
837 side_data_size = sizeof(AVProducerReferenceTime);
838 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_PRFT, side_data_size);
841 if (!side_data || side_data_size < sizeof(AVProducerReferenceTime))
842 return AVERROR(ENOMEM);
844 prft = (AVProducerReferenceTime *)side_data;
845 prft->wallclock = timestamp;