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 void av_init_packet(AVPacket *pkt)
37 pkt->pts = AV_NOPTS_VALUE;
38 pkt->dts = AV_NOPTS_VALUE;
41 #if FF_API_CONVERGENCE_DURATION
42 FF_DISABLE_DEPRECATION_WARNINGS
43 pkt->convergence_duration = 0;
44 FF_ENABLE_DEPRECATION_WARNINGS
47 pkt->stream_index = 0;
49 pkt->side_data = NULL;
50 pkt->side_data_elems = 0;
53 AVPacket *av_packet_alloc(void)
55 AVPacket *pkt = av_mallocz(sizeof(AVPacket));
64 void av_packet_free(AVPacket **pkt)
69 av_packet_unref(*pkt);
73 static int packet_alloc(AVBufferRef **buf, int size)
76 if (size < 0 || size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
77 return AVERROR(EINVAL);
79 ret = av_buffer_realloc(buf, size + AV_INPUT_BUFFER_PADDING_SIZE);
83 memset((*buf)->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
88 int av_new_packet(AVPacket *pkt, int size)
90 AVBufferRef *buf = NULL;
91 int ret = packet_alloc(&buf, size);
97 pkt->data = buf->data;
103 void av_shrink_packet(AVPacket *pkt, int size)
105 if (pkt->size <= size)
108 memset(pkt->data + size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
111 int av_grow_packet(AVPacket *pkt, int grow_by)
114 av_assert0((unsigned)pkt->size <= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE);
115 if ((unsigned)grow_by >
116 INT_MAX - (pkt->size + AV_INPUT_BUFFER_PADDING_SIZE))
117 return AVERROR(ENOMEM);
119 new_size = pkt->size + grow_by + AV_INPUT_BUFFER_PADDING_SIZE;
122 uint8_t *old_data = pkt->data;
123 if (pkt->data == NULL) {
125 pkt->data = pkt->buf->data;
127 data_offset = pkt->data - pkt->buf->data;
128 if (data_offset > INT_MAX - new_size)
129 return AVERROR(ENOMEM);
132 if (new_size + data_offset > pkt->buf->size ||
133 !av_buffer_is_writable(pkt->buf)) {
134 int ret = av_buffer_realloc(&pkt->buf, new_size + data_offset);
136 pkt->data = old_data;
139 pkt->data = pkt->buf->data + data_offset;
142 pkt->buf = av_buffer_alloc(new_size);
144 return AVERROR(ENOMEM);
146 memcpy(pkt->buf->data, pkt->data, pkt->size);
147 pkt->data = pkt->buf->data;
149 pkt->size += grow_by;
150 memset(pkt->data + pkt->size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
155 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
157 if (size >= INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
158 return AVERROR(EINVAL);
160 pkt->buf = av_buffer_create(data, size + AV_INPUT_BUFFER_PADDING_SIZE,
161 av_buffer_default_free, NULL, 0);
163 return AVERROR(ENOMEM);
171 #if FF_API_AVPACKET_OLD_API
172 FF_DISABLE_DEPRECATION_WARNINGS
173 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
174 #define ALLOC_BUF(data, size) \
176 av_buffer_realloc(&pkt->buf, size); \
177 data = pkt->buf ? pkt->buf->data : NULL; \
180 #define DUP_DATA(dst, src, size, padding, ALLOC) \
184 if ((unsigned)(size) > \
185 (unsigned)(size) + AV_INPUT_BUFFER_PADDING_SIZE) \
187 ALLOC(data, size + AV_INPUT_BUFFER_PADDING_SIZE); \
193 memcpy(data, src, size); \
195 memset((uint8_t *)data + size, 0, \
196 AV_INPUT_BUFFER_PADDING_SIZE); \
200 /* Makes duplicates of data, side_data, but does not copy any other fields */
201 static int copy_packet_data(AVPacket *pkt, const AVPacket *src, int dup)
204 pkt->side_data = NULL;
205 pkt->side_data_elems = 0;
207 AVBufferRef *ref = av_buffer_ref(src->buf);
209 return AVERROR(ENOMEM);
211 pkt->data = ref->data;
213 DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
215 if (src->side_data_elems && dup) {
216 pkt->side_data = src->side_data;
217 pkt->side_data_elems = src->side_data_elems;
219 if (src->side_data_elems && !dup) {
220 return av_copy_packet_side_data(pkt, src);
225 av_packet_unref(pkt);
226 return AVERROR(ENOMEM);
229 int av_copy_packet_side_data(AVPacket *pkt, const AVPacket *src)
231 if (src->side_data_elems) {
233 DUP_DATA(pkt->side_data, src->side_data,
234 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
236 memset(pkt->side_data, 0,
237 src->side_data_elems * sizeof(*src->side_data));
239 for (i = 0; i < src->side_data_elems; i++) {
240 DUP_DATA(pkt->side_data[i].data, src->side_data[i].data,
241 src->side_data[i].size, 1, ALLOC_MALLOC);
242 pkt->side_data[i].size = src->side_data[i].size;
243 pkt->side_data[i].type = src->side_data[i].type;
246 pkt->side_data_elems = src->side_data_elems;
250 av_packet_unref(pkt);
251 return AVERROR(ENOMEM);
254 int av_dup_packet(AVPacket *pkt)
258 if (!pkt->buf && pkt->data) {
260 return copy_packet_data(pkt, &tmp_pkt, 1);
265 int av_copy_packet(AVPacket *dst, const AVPacket *src)
268 return copy_packet_data(dst, src, 0);
270 FF_ENABLE_DEPRECATION_WARNINGS
273 void av_packet_free_side_data(AVPacket *pkt)
276 for (i = 0; i < pkt->side_data_elems; i++)
277 av_freep(&pkt->side_data[i].data);
278 av_freep(&pkt->side_data);
279 pkt->side_data_elems = 0;
282 #if FF_API_AVPACKET_OLD_API
283 FF_DISABLE_DEPRECATION_WARNINGS
284 void av_free_packet(AVPacket *pkt)
288 av_buffer_unref(&pkt->buf);
292 av_packet_free_side_data(pkt);
295 FF_ENABLE_DEPRECATION_WARNINGS
298 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
299 uint8_t *data, size_t size)
301 AVPacketSideData *tmp;
302 int i, elems = pkt->side_data_elems;
304 for (i = 0; i < elems; i++) {
305 AVPacketSideData *sd = &pkt->side_data[i];
307 if (sd->type == type) {
315 if ((unsigned)elems + 1 > AV_PKT_DATA_NB)
316 return AVERROR(ERANGE);
318 tmp = av_realloc(pkt->side_data, (elems + 1) * sizeof(*tmp));
320 return AVERROR(ENOMEM);
322 pkt->side_data = tmp;
323 pkt->side_data[elems].data = data;
324 pkt->side_data[elems].size = size;
325 pkt->side_data[elems].type = type;
326 pkt->side_data_elems++;
332 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
338 #if FF_API_BUFFER_SIZE_T
339 if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
341 if (size > SIZE_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
344 data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
348 ret = av_packet_add_side_data(pkt, type, data, size);
357 uint8_t *av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
362 for (i = 0; i < pkt->side_data_elems; i++) {
363 if (pkt->side_data[i].type == type) {
365 *size = pkt->side_data[i].size;
366 return pkt->side_data[i].data;
374 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
377 case AV_PKT_DATA_PALETTE: return "Palette";
378 case AV_PKT_DATA_NEW_EXTRADATA: return "New Extradata";
379 case AV_PKT_DATA_PARAM_CHANGE: return "Param Change";
380 case AV_PKT_DATA_H263_MB_INFO: return "H263 MB Info";
381 case AV_PKT_DATA_REPLAYGAIN: return "Replay Gain";
382 case AV_PKT_DATA_DISPLAYMATRIX: return "Display Matrix";
383 case AV_PKT_DATA_STEREO3D: return "Stereo 3D";
384 case AV_PKT_DATA_AUDIO_SERVICE_TYPE: return "Audio Service Type";
385 case AV_PKT_DATA_QUALITY_STATS: return "Quality stats";
386 case AV_PKT_DATA_FALLBACK_TRACK: return "Fallback track";
387 case AV_PKT_DATA_CPB_PROPERTIES: return "CPB properties";
388 case AV_PKT_DATA_SKIP_SAMPLES: return "Skip Samples";
389 case AV_PKT_DATA_JP_DUALMONO: return "JP Dual Mono";
390 case AV_PKT_DATA_STRINGS_METADATA: return "Strings Metadata";
391 case AV_PKT_DATA_SUBTITLE_POSITION: return "Subtitle Position";
392 case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL: return "Matroska BlockAdditional";
393 case AV_PKT_DATA_WEBVTT_IDENTIFIER: return "WebVTT ID";
394 case AV_PKT_DATA_WEBVTT_SETTINGS: return "WebVTT Settings";
395 case AV_PKT_DATA_METADATA_UPDATE: return "Metadata Update";
396 case AV_PKT_DATA_MPEGTS_STREAM_ID: return "MPEGTS Stream ID";
397 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
398 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL: return "Content light level metadata";
399 case AV_PKT_DATA_SPHERICAL: return "Spherical Mapping";
400 case AV_PKT_DATA_A53_CC: return "A53 Closed Captions";
401 case AV_PKT_DATA_ENCRYPTION_INIT_INFO: return "Encryption initialization data";
402 case AV_PKT_DATA_ENCRYPTION_INFO: return "Encryption info";
403 case AV_PKT_DATA_AFD: return "Active Format Description data";
404 case AV_PKT_DATA_PRFT: return "Producer Reference Time";
405 case AV_PKT_DATA_ICC_PROFILE: return "ICC Profile";
406 case AV_PKT_DATA_DOVI_CONF: return "DOVI configuration record";
407 case AV_PKT_DATA_S12M_TIMECODE: return "SMPTE ST 12-1:2014 timecode";
412 #if FF_API_MERGE_SD_API
414 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
416 int av_packet_merge_side_data(AVPacket *pkt){
417 if(pkt->side_data_elems){
421 uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
423 for (i=0; i<old.side_data_elems; i++) {
424 size += old.side_data[i].size + 5LL;
427 return AVERROR(EINVAL);
428 buf = av_buffer_alloc(size);
430 return AVERROR(ENOMEM);
432 pkt->data = p = buf->data;
433 pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
434 bytestream_put_buffer(&p, old.data, old.size);
435 for (i=old.side_data_elems-1; i>=0; i--) {
436 bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
437 bytestream_put_be32(&p, old.side_data[i].size);
438 *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
440 bytestream_put_be64(&p, FF_MERGE_MARKER);
441 av_assert0(p-pkt->data == pkt->size);
442 memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
443 av_packet_unref(&old);
444 pkt->side_data_elems = 0;
445 pkt->side_data = NULL;
451 int av_packet_split_side_data(AVPacket *pkt){
452 if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
457 p = pkt->data + pkt->size - 8 - 5;
460 if (size>INT_MAX - 5 || p - pkt->data < size)
464 if (p - pkt->data < size + 5)
469 if (i > AV_PKT_DATA_NB)
470 return AVERROR(ERANGE);
472 pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
474 return AVERROR(ENOMEM);
476 p= pkt->data + pkt->size - 8 - 5;
479 av_assert0(size<=INT_MAX - 5 && p - pkt->data >= size);
480 pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
481 pkt->side_data[i].size = size;
482 pkt->side_data[i].type = p[4]&127;
483 if (!pkt->side_data[i].data)
484 return AVERROR(ENOMEM);
485 memcpy(pkt->side_data[i].data, p-size, size);
486 pkt->size -= size + 5;
492 pkt->side_data_elems = i+1;
499 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
501 AVDictionaryEntry *t = NULL;
502 uint8_t *data = NULL;
508 while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
509 const size_t keylen = strlen(t->key);
510 const size_t valuelen = strlen(t->value);
511 const size_t new_size = *size + keylen + 1 + valuelen + 1;
512 uint8_t *const new_data = av_realloc(data, new_size);
517 if (new_size > INT_MAX)
520 memcpy(data + *size, t->key, keylen + 1);
521 memcpy(data + *size + keylen + 1, t->value, valuelen + 1);
534 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
539 if (!dict || !data || !size)
543 return AVERROR_INVALIDDATA;
545 const uint8_t *key = data;
546 const uint8_t *val = data + strlen(key) + 1;
548 if (val >= end || !*key)
549 return AVERROR_INVALIDDATA;
551 ret = av_dict_set(dict, key, val, 0);
554 data = val + strlen(val) + 1;
560 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
565 for (i = 0; i < pkt->side_data_elems; i++) {
566 if (pkt->side_data[i].type == type) {
567 if (size > pkt->side_data[i].size)
568 return AVERROR(ENOMEM);
569 pkt->side_data[i].size = size;
573 return AVERROR(ENOENT);
576 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
583 dst->duration = src->duration;
584 #if FF_API_CONVERGENCE_DURATION
585 FF_DISABLE_DEPRECATION_WARNINGS
586 dst->convergence_duration = src->convergence_duration;
587 FF_ENABLE_DEPRECATION_WARNINGS
589 dst->flags = src->flags;
590 dst->stream_index = src->stream_index;
592 dst->side_data = NULL;
593 dst->side_data_elems = 0;
594 for (i = 0; i < src->side_data_elems; i++) {
595 enum AVPacketSideDataType type = src->side_data[i].type;
596 buffer_size_t size = src->side_data[i].size;
597 uint8_t *src_data = src->side_data[i].data;
598 uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
601 av_packet_free_side_data(dst);
602 return AVERROR(ENOMEM);
604 memcpy(dst_data, src_data, size);
610 void av_packet_unref(AVPacket *pkt)
612 av_packet_free_side_data(pkt);
613 av_buffer_unref(&pkt->buf);
619 int av_packet_ref(AVPacket *dst, const AVPacket *src)
625 ret = av_packet_copy_props(dst, src);
630 ret = packet_alloc(&dst->buf, src->size);
633 av_assert1(!src->size || src->data);
635 memcpy(dst->buf->data, src->data, src->size);
637 dst->data = dst->buf->data;
639 dst->buf = av_buffer_ref(src->buf);
641 ret = AVERROR(ENOMEM);
644 dst->data = src->data;
647 dst->size = src->size;
651 av_packet_unref(dst);
655 AVPacket *av_packet_clone(const AVPacket *src)
657 AVPacket *ret = av_packet_alloc();
662 if (av_packet_ref(ret, src))
663 av_packet_free(&ret);
668 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
676 int av_packet_make_refcounted(AVPacket *pkt)
683 ret = packet_alloc(&pkt->buf, pkt->size);
686 av_assert1(!pkt->size || pkt->data);
688 memcpy(pkt->buf->data, pkt->data, pkt->size);
690 pkt->data = pkt->buf->data;
695 int av_packet_make_writable(AVPacket *pkt)
697 AVBufferRef *buf = NULL;
700 if (pkt->buf && av_buffer_is_writable(pkt->buf))
703 ret = packet_alloc(&buf, pkt->size);
706 av_assert1(!pkt->size || pkt->data);
708 memcpy(buf->data, pkt->data, pkt->size);
710 av_buffer_unref(&pkt->buf);
712 pkt->data = buf->data;
717 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
719 if (pkt->pts != AV_NOPTS_VALUE)
720 pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
721 if (pkt->dts != AV_NOPTS_VALUE)
722 pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
723 if (pkt->duration > 0)
724 pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
725 #if FF_API_CONVERGENCE_DURATION
726 FF_DISABLE_DEPRECATION_WARNINGS
727 if (pkt->convergence_duration > 0)
728 pkt->convergence_duration = av_rescale_q(pkt->convergence_duration, src_tb, dst_tb);
729 FF_ENABLE_DEPRECATION_WARNINGS
733 int avpriv_packet_list_put(AVPacketList **packet_buffer,
734 AVPacketList **plast_pktl,
736 int (*copy)(AVPacket *dst, const AVPacket *src),
739 AVPacketList *pktl = av_mallocz(sizeof(AVPacketList));
743 return AVERROR(ENOMEM);
746 ret = copy(&pktl->pkt, pkt);
752 ret = av_packet_make_refcounted(pkt);
757 av_packet_move_ref(&pktl->pkt, pkt);
761 (*plast_pktl)->next = pktl;
763 *packet_buffer = pktl;
765 /* Add the packet in the buffered packet list. */
770 int avpriv_packet_list_get(AVPacketList **pkt_buffer,
771 AVPacketList **pkt_buffer_end,
776 return AVERROR(EAGAIN);
779 *pkt_buffer = pktl->next;
781 *pkt_buffer_end = NULL;
786 void avpriv_packet_list_free(AVPacketList **pkt_buf, AVPacketList **pkt_buf_end)
788 AVPacketList *tmp = *pkt_buf;
791 AVPacketList *pktl = tmp;
793 av_packet_unref(&pktl->pkt);
800 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
803 buffer_size_t side_data_size;
806 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
808 side_data_size = 4+4+8*error_count;
809 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
813 if (!side_data || side_data_size < 4+4+8*error_count)
814 return AVERROR(ENOMEM);
816 AV_WL32(side_data , quality );
817 side_data[4] = pict_type;
818 side_data[5] = error_count;
819 for (i = 0; i<error_count; i++)
820 AV_WL64(side_data+8 + 8*i , error[i]);
825 int ff_side_data_set_prft(AVPacket *pkt, int64_t timestamp)
827 AVProducerReferenceTime *prft;
829 buffer_size_t side_data_size;
831 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_PRFT, &side_data_size);
833 side_data_size = sizeof(AVProducerReferenceTime);
834 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_PRFT, side_data_size);
837 if (!side_data || side_data_size < sizeof(AVProducerReferenceTime))
838 return AVERROR(ENOMEM);
840 prft = (AVProducerReferenceTime *)side_data;
841 prft->wallclock = timestamp;