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 ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
340 data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
344 ret = av_packet_add_side_data(pkt, type, data, size);
353 uint8_t *av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
358 for (i = 0; i < pkt->side_data_elems; i++) {
359 if (pkt->side_data[i].type == type) {
361 *size = pkt->side_data[i].size;
362 return pkt->side_data[i].data;
370 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
373 case AV_PKT_DATA_PALETTE: return "Palette";
374 case AV_PKT_DATA_NEW_EXTRADATA: return "New Extradata";
375 case AV_PKT_DATA_PARAM_CHANGE: return "Param Change";
376 case AV_PKT_DATA_H263_MB_INFO: return "H263 MB Info";
377 case AV_PKT_DATA_REPLAYGAIN: return "Replay Gain";
378 case AV_PKT_DATA_DISPLAYMATRIX: return "Display Matrix";
379 case AV_PKT_DATA_STEREO3D: return "Stereo 3D";
380 case AV_PKT_DATA_AUDIO_SERVICE_TYPE: return "Audio Service Type";
381 case AV_PKT_DATA_QUALITY_STATS: return "Quality stats";
382 case AV_PKT_DATA_FALLBACK_TRACK: return "Fallback track";
383 case AV_PKT_DATA_CPB_PROPERTIES: return "CPB properties";
384 case AV_PKT_DATA_SKIP_SAMPLES: return "Skip Samples";
385 case AV_PKT_DATA_JP_DUALMONO: return "JP Dual Mono";
386 case AV_PKT_DATA_STRINGS_METADATA: return "Strings Metadata";
387 case AV_PKT_DATA_SUBTITLE_POSITION: return "Subtitle Position";
388 case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL: return "Matroska BlockAdditional";
389 case AV_PKT_DATA_WEBVTT_IDENTIFIER: return "WebVTT ID";
390 case AV_PKT_DATA_WEBVTT_SETTINGS: return "WebVTT Settings";
391 case AV_PKT_DATA_METADATA_UPDATE: return "Metadata Update";
392 case AV_PKT_DATA_MPEGTS_STREAM_ID: return "MPEGTS Stream ID";
393 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
394 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL: return "Content light level metadata";
395 case AV_PKT_DATA_SPHERICAL: return "Spherical Mapping";
396 case AV_PKT_DATA_A53_CC: return "A53 Closed Captions";
397 case AV_PKT_DATA_ENCRYPTION_INIT_INFO: return "Encryption initialization data";
398 case AV_PKT_DATA_ENCRYPTION_INFO: return "Encryption info";
399 case AV_PKT_DATA_AFD: return "Active Format Description data";
400 case AV_PKT_DATA_PRFT: return "Producer Reference Time";
401 case AV_PKT_DATA_ICC_PROFILE: return "ICC Profile";
402 case AV_PKT_DATA_DOVI_CONF: return "DOVI configuration record";
407 #if FF_API_MERGE_SD_API
409 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
411 int av_packet_merge_side_data(AVPacket *pkt){
412 if(pkt->side_data_elems){
416 uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
418 for (i=0; i<old.side_data_elems; i++) {
419 size += old.side_data[i].size + 5LL;
422 return AVERROR(EINVAL);
423 buf = av_buffer_alloc(size);
425 return AVERROR(ENOMEM);
427 pkt->data = p = buf->data;
428 pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
429 bytestream_put_buffer(&p, old.data, old.size);
430 for (i=old.side_data_elems-1; i>=0; i--) {
431 bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
432 bytestream_put_be32(&p, old.side_data[i].size);
433 *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
435 bytestream_put_be64(&p, FF_MERGE_MARKER);
436 av_assert0(p-pkt->data == pkt->size);
437 memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
438 av_packet_unref(&old);
439 pkt->side_data_elems = 0;
440 pkt->side_data = NULL;
446 int av_packet_split_side_data(AVPacket *pkt){
447 if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
452 p = pkt->data + pkt->size - 8 - 5;
455 if (size>INT_MAX - 5 || p - pkt->data < size)
459 if (p - pkt->data < size + 5)
464 if (i > AV_PKT_DATA_NB)
465 return AVERROR(ERANGE);
467 pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
469 return AVERROR(ENOMEM);
471 p= pkt->data + pkt->size - 8 - 5;
474 av_assert0(size<=INT_MAX - 5 && p - pkt->data >= size);
475 pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
476 pkt->side_data[i].size = size;
477 pkt->side_data[i].type = p[4]&127;
478 if (!pkt->side_data[i].data)
479 return AVERROR(ENOMEM);
480 memcpy(pkt->side_data[i].data, p-size, size);
481 pkt->size -= size + 5;
487 pkt->side_data_elems = i+1;
494 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
496 AVDictionaryEntry *t = NULL;
497 uint8_t *data = NULL;
503 while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
504 const size_t keylen = strlen(t->key);
505 const size_t valuelen = strlen(t->value);
506 const size_t new_size = *size + keylen + 1 + valuelen + 1;
507 uint8_t *const new_data = av_realloc(data, new_size);
512 if (new_size > INT_MAX)
515 memcpy(data + *size, t->key, keylen + 1);
516 memcpy(data + *size + keylen + 1, t->value, valuelen + 1);
529 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
534 if (!dict || !data || !size)
538 return AVERROR_INVALIDDATA;
540 const uint8_t *key = data;
541 const uint8_t *val = data + strlen(key) + 1;
543 if (val >= end || !*key)
544 return AVERROR_INVALIDDATA;
546 ret = av_dict_set(dict, key, val, 0);
549 data = val + strlen(val) + 1;
555 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
560 for (i = 0; i < pkt->side_data_elems; i++) {
561 if (pkt->side_data[i].type == type) {
562 if (size > pkt->side_data[i].size)
563 return AVERROR(ENOMEM);
564 pkt->side_data[i].size = size;
568 return AVERROR(ENOENT);
571 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
578 dst->duration = src->duration;
579 #if FF_API_CONVERGENCE_DURATION
580 FF_DISABLE_DEPRECATION_WARNINGS
581 dst->convergence_duration = src->convergence_duration;
582 FF_ENABLE_DEPRECATION_WARNINGS
584 dst->flags = src->flags;
585 dst->stream_index = src->stream_index;
587 dst->side_data = NULL;
588 dst->side_data_elems = 0;
589 for (i = 0; i < src->side_data_elems; i++) {
590 enum AVPacketSideDataType type = src->side_data[i].type;
591 int size = src->side_data[i].size;
592 uint8_t *src_data = src->side_data[i].data;
593 uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
596 av_packet_free_side_data(dst);
597 return AVERROR(ENOMEM);
599 memcpy(dst_data, src_data, size);
605 void av_packet_unref(AVPacket *pkt)
607 av_packet_free_side_data(pkt);
608 av_buffer_unref(&pkt->buf);
614 int av_packet_ref(AVPacket *dst, const AVPacket *src)
620 ret = av_packet_copy_props(dst, src);
625 ret = packet_alloc(&dst->buf, src->size);
628 av_assert1(!src->size || src->data);
630 memcpy(dst->buf->data, src->data, src->size);
632 dst->data = dst->buf->data;
634 dst->buf = av_buffer_ref(src->buf);
636 ret = AVERROR(ENOMEM);
639 dst->data = src->data;
642 dst->size = src->size;
646 av_packet_unref(dst);
650 AVPacket *av_packet_clone(const AVPacket *src)
652 AVPacket *ret = av_packet_alloc();
657 if (av_packet_ref(ret, src))
658 av_packet_free(&ret);
663 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
671 int av_packet_make_refcounted(AVPacket *pkt)
678 ret = packet_alloc(&pkt->buf, pkt->size);
681 av_assert1(!pkt->size || pkt->data);
683 memcpy(pkt->buf->data, pkt->data, pkt->size);
685 pkt->data = pkt->buf->data;
690 int av_packet_make_writable(AVPacket *pkt)
692 AVBufferRef *buf = NULL;
695 if (pkt->buf && av_buffer_is_writable(pkt->buf))
698 ret = packet_alloc(&buf, pkt->size);
701 av_assert1(!pkt->size || pkt->data);
703 memcpy(buf->data, pkt->data, pkt->size);
705 av_buffer_unref(&pkt->buf);
707 pkt->data = buf->data;
712 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
714 if (pkt->pts != AV_NOPTS_VALUE)
715 pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
716 if (pkt->dts != AV_NOPTS_VALUE)
717 pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
718 if (pkt->duration > 0)
719 pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
720 #if FF_API_CONVERGENCE_DURATION
721 FF_DISABLE_DEPRECATION_WARNINGS
722 if (pkt->convergence_duration > 0)
723 pkt->convergence_duration = av_rescale_q(pkt->convergence_duration, src_tb, dst_tb);
724 FF_ENABLE_DEPRECATION_WARNINGS
728 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
734 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
736 side_data_size = 4+4+8*error_count;
737 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
741 if (!side_data || side_data_size < 4+4+8*error_count)
742 return AVERROR(ENOMEM);
744 AV_WL32(side_data , quality );
745 side_data[4] = pict_type;
746 side_data[5] = error_count;
747 for (i = 0; i<error_count; i++)
748 AV_WL64(side_data+8 + 8*i , error[i]);
753 int ff_side_data_set_prft(AVPacket *pkt, int64_t timestamp)
755 AVProducerReferenceTime *prft;
759 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_PRFT, &side_data_size);
761 side_data_size = sizeof(AVProducerReferenceTime);
762 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_PRFT, side_data_size);
765 if (!side_data || side_data_size < sizeof(AVProducerReferenceTime))
766 return AVERROR(ENOMEM);
768 prft = (AVProducerReferenceTime *)side_data;
769 prft->wallclock = timestamp;