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 void av_packet_free_side_data(AVPacket *pkt)
180 for (i = 0; i < pkt->side_data_elems; i++)
181 av_freep(&pkt->side_data[i].data);
182 av_freep(&pkt->side_data);
183 pkt->side_data_elems = 0;
186 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
187 uint8_t *data, size_t size)
189 AVPacketSideData *tmp;
190 int i, elems = pkt->side_data_elems;
192 for (i = 0; i < elems; i++) {
193 AVPacketSideData *sd = &pkt->side_data[i];
195 if (sd->type == type) {
203 if ((unsigned)elems + 1 > AV_PKT_DATA_NB)
204 return AVERROR(ERANGE);
206 tmp = av_realloc(pkt->side_data, (elems + 1) * sizeof(*tmp));
208 return AVERROR(ENOMEM);
210 pkt->side_data = tmp;
211 pkt->side_data[elems].data = data;
212 pkt->side_data[elems].size = size;
213 pkt->side_data[elems].type = type;
214 pkt->side_data_elems++;
220 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
226 #if FF_API_BUFFER_SIZE_T
227 if ((unsigned)size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
229 if (size > SIZE_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
232 data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
236 ret = av_packet_add_side_data(pkt, type, data, size);
245 uint8_t *av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
250 for (i = 0; i < pkt->side_data_elems; i++) {
251 if (pkt->side_data[i].type == type) {
253 *size = pkt->side_data[i].size;
254 return pkt->side_data[i].data;
262 const char *av_packet_side_data_name(enum AVPacketSideDataType type)
265 case AV_PKT_DATA_PALETTE: return "Palette";
266 case AV_PKT_DATA_NEW_EXTRADATA: return "New Extradata";
267 case AV_PKT_DATA_PARAM_CHANGE: return "Param Change";
268 case AV_PKT_DATA_H263_MB_INFO: return "H263 MB Info";
269 case AV_PKT_DATA_REPLAYGAIN: return "Replay Gain";
270 case AV_PKT_DATA_DISPLAYMATRIX: return "Display Matrix";
271 case AV_PKT_DATA_STEREO3D: return "Stereo 3D";
272 case AV_PKT_DATA_AUDIO_SERVICE_TYPE: return "Audio Service Type";
273 case AV_PKT_DATA_QUALITY_STATS: return "Quality stats";
274 case AV_PKT_DATA_FALLBACK_TRACK: return "Fallback track";
275 case AV_PKT_DATA_CPB_PROPERTIES: return "CPB properties";
276 case AV_PKT_DATA_SKIP_SAMPLES: return "Skip Samples";
277 case AV_PKT_DATA_JP_DUALMONO: return "JP Dual Mono";
278 case AV_PKT_DATA_STRINGS_METADATA: return "Strings Metadata";
279 case AV_PKT_DATA_SUBTITLE_POSITION: return "Subtitle Position";
280 case AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL: return "Matroska BlockAdditional";
281 case AV_PKT_DATA_WEBVTT_IDENTIFIER: return "WebVTT ID";
282 case AV_PKT_DATA_WEBVTT_SETTINGS: return "WebVTT Settings";
283 case AV_PKT_DATA_METADATA_UPDATE: return "Metadata Update";
284 case AV_PKT_DATA_MPEGTS_STREAM_ID: return "MPEGTS Stream ID";
285 case AV_PKT_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
286 case AV_PKT_DATA_CONTENT_LIGHT_LEVEL: return "Content light level metadata";
287 case AV_PKT_DATA_SPHERICAL: return "Spherical Mapping";
288 case AV_PKT_DATA_A53_CC: return "A53 Closed Captions";
289 case AV_PKT_DATA_ENCRYPTION_INIT_INFO: return "Encryption initialization data";
290 case AV_PKT_DATA_ENCRYPTION_INFO: return "Encryption info";
291 case AV_PKT_DATA_AFD: return "Active Format Description data";
292 case AV_PKT_DATA_PRFT: return "Producer Reference Time";
293 case AV_PKT_DATA_ICC_PROFILE: return "ICC Profile";
294 case AV_PKT_DATA_DOVI_CONF: return "DOVI configuration record";
295 case AV_PKT_DATA_S12M_TIMECODE: return "SMPTE ST 12-1:2014 timecode";
300 #if FF_API_MERGE_SD_API
302 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
304 int av_packet_merge_side_data(AVPacket *pkt){
305 if(pkt->side_data_elems){
309 uint64_t size= pkt->size + 8LL + AV_INPUT_BUFFER_PADDING_SIZE;
311 for (i=0; i<old.side_data_elems; i++) {
312 size += old.side_data[i].size + 5LL;
315 return AVERROR(EINVAL);
316 buf = av_buffer_alloc(size);
318 return AVERROR(ENOMEM);
320 pkt->data = p = buf->data;
321 pkt->size = size - AV_INPUT_BUFFER_PADDING_SIZE;
322 bytestream_put_buffer(&p, old.data, old.size);
323 for (i=old.side_data_elems-1; i>=0; i--) {
324 bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
325 bytestream_put_be32(&p, old.side_data[i].size);
326 *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
328 bytestream_put_be64(&p, FF_MERGE_MARKER);
329 av_assert0(p-pkt->data == pkt->size);
330 memset(p, 0, AV_INPUT_BUFFER_PADDING_SIZE);
331 av_packet_unref(&old);
332 pkt->side_data_elems = 0;
333 pkt->side_data = NULL;
339 int av_packet_split_side_data(AVPacket *pkt){
340 if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
345 p = pkt->data + pkt->size - 8 - 5;
348 if (size>INT_MAX - 5 || p - pkt->data < size)
352 if (p - pkt->data < size + 5)
357 if (i > AV_PKT_DATA_NB)
358 return AVERROR(ERANGE);
360 pkt->side_data = av_malloc_array(i, sizeof(*pkt->side_data));
362 return AVERROR(ENOMEM);
364 p= pkt->data + pkt->size - 8 - 5;
367 av_assert0(size<=INT_MAX - 5 && p - pkt->data >= size);
368 pkt->side_data[i].data = av_mallocz(size + AV_INPUT_BUFFER_PADDING_SIZE);
369 pkt->side_data[i].size = size;
370 pkt->side_data[i].type = p[4]&127;
371 if (!pkt->side_data[i].data)
372 return AVERROR(ENOMEM);
373 memcpy(pkt->side_data[i].data, p-size, size);
374 pkt->size -= size + 5;
380 pkt->side_data_elems = i+1;
387 #if FF_API_BUFFER_SIZE_T
388 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size)
390 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, size_t *size)
393 uint8_t *data = NULL;
399 for (int pass = 0; pass < 2; pass++) {
400 const AVDictionaryEntry *t = NULL;
401 size_t total_length = 0;
403 while ((t = av_dict_get(dict, "", t, AV_DICT_IGNORE_SUFFIX))) {
404 for (int i = 0; i < 2; i++) {
405 const char *str = i ? t->value : t->key;
406 const size_t len = strlen(str) + 1;
409 memcpy(data + total_length, str, len);
410 #if FF_API_BUFFER_SIZE_T
411 else if (len > INT_MAX - total_length)
413 else if (len > SIZE_MAX - total_length)
421 data = av_malloc(total_length);
424 *size = total_length;
430 #if FF_API_BUFFER_SIZE_T
431 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict)
433 int av_packet_unpack_dictionary(const uint8_t *data, size_t size,
440 if (!dict || !data || !size)
444 return AVERROR_INVALIDDATA;
446 const uint8_t *key = data;
447 const uint8_t *val = data + strlen(key) + 1;
449 if (val >= end || !*key)
450 return AVERROR_INVALIDDATA;
452 ret = av_dict_set(dict, key, val, 0);
455 data = val + strlen(val) + 1;
461 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
466 for (i = 0; i < pkt->side_data_elems; i++) {
467 if (pkt->side_data[i].type == type) {
468 if (size > pkt->side_data[i].size)
469 return AVERROR(ENOMEM);
470 pkt->side_data[i].size = size;
474 return AVERROR(ENOENT);
477 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
484 dst->duration = src->duration;
485 dst->flags = src->flags;
486 dst->stream_index = src->stream_index;
488 dst->side_data = NULL;
489 dst->side_data_elems = 0;
490 for (i = 0; i < src->side_data_elems; i++) {
491 enum AVPacketSideDataType type = src->side_data[i].type;
492 buffer_size_t size = src->side_data[i].size;
493 uint8_t *src_data = src->side_data[i].data;
494 uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
497 av_packet_free_side_data(dst);
498 return AVERROR(ENOMEM);
500 memcpy(dst_data, src_data, size);
506 void av_packet_unref(AVPacket *pkt)
508 av_packet_free_side_data(pkt);
509 av_buffer_unref(&pkt->buf);
510 get_packet_defaults(pkt);
513 int av_packet_ref(AVPacket *dst, const AVPacket *src)
519 ret = av_packet_copy_props(dst, src);
524 ret = packet_alloc(&dst->buf, src->size);
527 av_assert1(!src->size || src->data);
529 memcpy(dst->buf->data, src->data, src->size);
531 dst->data = dst->buf->data;
533 dst->buf = av_buffer_ref(src->buf);
535 ret = AVERROR(ENOMEM);
538 dst->data = src->data;
541 dst->size = src->size;
545 av_packet_unref(dst);
549 AVPacket *av_packet_clone(const AVPacket *src)
551 AVPacket *ret = av_packet_alloc();
556 if (av_packet_ref(ret, src))
557 av_packet_free(&ret);
562 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
565 get_packet_defaults(src);
568 int av_packet_make_refcounted(AVPacket *pkt)
575 ret = packet_alloc(&pkt->buf, pkt->size);
578 av_assert1(!pkt->size || pkt->data);
580 memcpy(pkt->buf->data, pkt->data, pkt->size);
582 pkt->data = pkt->buf->data;
587 int av_packet_make_writable(AVPacket *pkt)
589 AVBufferRef *buf = NULL;
592 if (pkt->buf && av_buffer_is_writable(pkt->buf))
595 ret = packet_alloc(&buf, pkt->size);
598 av_assert1(!pkt->size || pkt->data);
600 memcpy(buf->data, pkt->data, pkt->size);
602 av_buffer_unref(&pkt->buf);
604 pkt->data = buf->data;
609 void av_packet_rescale_ts(AVPacket *pkt, AVRational src_tb, AVRational dst_tb)
611 if (pkt->pts != AV_NOPTS_VALUE)
612 pkt->pts = av_rescale_q(pkt->pts, src_tb, dst_tb);
613 if (pkt->dts != AV_NOPTS_VALUE)
614 pkt->dts = av_rescale_q(pkt->dts, src_tb, dst_tb);
615 if (pkt->duration > 0)
616 pkt->duration = av_rescale_q(pkt->duration, src_tb, dst_tb);
619 int avpriv_packet_list_put(PacketList **packet_buffer,
620 PacketList **plast_pktl,
622 int (*copy)(AVPacket *dst, const AVPacket *src),
625 PacketList *pktl = av_mallocz(sizeof(PacketList));
629 return AVERROR(ENOMEM);
632 ret = copy(&pktl->pkt, pkt);
638 ret = av_packet_make_refcounted(pkt);
643 av_packet_move_ref(&pktl->pkt, pkt);
647 (*plast_pktl)->next = pktl;
649 *packet_buffer = pktl;
651 /* Add the packet in the buffered packet list. */
656 int avpriv_packet_list_get(PacketList **pkt_buffer,
657 PacketList **pkt_buffer_end,
662 return AVERROR(EAGAIN);
665 *pkt_buffer = pktl->next;
667 *pkt_buffer_end = NULL;
672 void avpriv_packet_list_free(PacketList **pkt_buf, PacketList **pkt_buf_end)
674 PacketList *tmp = *pkt_buf;
677 PacketList *pktl = tmp;
679 av_packet_unref(&pktl->pkt);
686 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
689 buffer_size_t side_data_size;
692 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_QUALITY_STATS, &side_data_size);
694 side_data_size = 4+4+8*error_count;
695 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_STATS,
699 if (!side_data || side_data_size < 4+4+8*error_count)
700 return AVERROR(ENOMEM);
702 AV_WL32(side_data , quality );
703 side_data[4] = pict_type;
704 side_data[5] = error_count;
705 for (i = 0; i<error_count; i++)
706 AV_WL64(side_data+8 + 8*i , error[i]);
711 int ff_side_data_set_prft(AVPacket *pkt, int64_t timestamp)
713 AVProducerReferenceTime *prft;
715 buffer_size_t side_data_size;
717 side_data = av_packet_get_side_data(pkt, AV_PKT_DATA_PRFT, &side_data_size);
719 side_data_size = sizeof(AVProducerReferenceTime);
720 side_data = av_packet_new_side_data(pkt, AV_PKT_DATA_PRFT, side_data_size);
723 if (!side_data || side_data_size < sizeof(AVProducerReferenceTime))
724 return AVERROR(ENOMEM);
726 prft = (AVProducerReferenceTime *)side_data;
727 prft->wallclock = timestamp;