87d1507bc1eed4a81be97648ace0151ae3e11e2f
[ffmpeg.git] / libavcodec / avpacket.c
1 /*
2  * AVPacket functions for libavcodec
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include <string.h>
23
24 #include "libavutil/avassert.h"
25 #include "libavutil/common.h"
26 #include "libavutil/internal.h"
27 #include "libavutil/mem.h"
28 #include "avcodec.h"
29 #include "bytestream.h"
30 #include "internal.h"
31
32 void ff_packet_free_side_data(AVPacket *pkt)
33 {
34     int i;
35     for (i = 0; i < pkt->side_data_elems; i++)
36         av_free(pkt->side_data[i].data);
37     av_freep(&pkt->side_data);
38     pkt->side_data_elems = 0;
39 }
40
41 #if FF_API_DESTRUCT_PACKET
42
43 void av_destruct_packet(AVPacket *pkt)
44 {
45     av_free(pkt->data);
46     pkt->data = NULL;
47     pkt->size = 0;
48 }
49
50 /* a dummy destruct callback for the callers that assume AVPacket.destruct ==
51  * NULL => static data */
52 static void dummy_destruct_packet(AVPacket *pkt)
53 {
54     av_assert0(0);
55 }
56 #endif
57
58 void av_init_packet(AVPacket *pkt)
59 {
60     pkt->pts                  = AV_NOPTS_VALUE;
61     pkt->dts                  = AV_NOPTS_VALUE;
62     pkt->pos                  = -1;
63     pkt->duration             = 0;
64     pkt->convergence_duration = 0;
65     pkt->flags                = 0;
66     pkt->stream_index         = 0;
67 #if FF_API_DESTRUCT_PACKET
68 FF_DISABLE_DEPRECATION_WARNINGS
69     pkt->destruct             = NULL;
70 FF_ENABLE_DEPRECATION_WARNINGS
71 #endif
72     pkt->buf                  = NULL;
73     pkt->side_data            = NULL;
74     pkt->side_data_elems      = 0;
75 }
76
77 static int packet_alloc(AVBufferRef **buf, int size)
78 {
79     if ((unsigned)size >= (unsigned)size + FF_INPUT_BUFFER_PADDING_SIZE)
80         return AVERROR(EINVAL);
81
82     av_buffer_realloc(buf, size + FF_INPUT_BUFFER_PADDING_SIZE);
83     if (!buf)
84         return AVERROR(ENOMEM);
85
86     memset((*buf)->data + size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
87
88     return 0;
89 }
90
91 int av_new_packet(AVPacket *pkt, int size)
92 {
93     AVBufferRef *buf = NULL;
94     int ret = packet_alloc(&buf, size);
95     if (ret < 0)
96         return ret;
97
98     av_init_packet(pkt);
99     pkt->buf      = buf;
100     pkt->data     = buf->data;
101     pkt->size     = size;
102 #if FF_API_DESTRUCT_PACKET
103 FF_DISABLE_DEPRECATION_WARNINGS
104     pkt->destruct = dummy_destruct_packet;
105 FF_ENABLE_DEPRECATION_WARNINGS
106 #endif
107
108     return 0;
109 }
110
111 void av_shrink_packet(AVPacket *pkt, int size)
112 {
113     if (pkt->size <= size)
114         return;
115     pkt->size = size;
116     memset(pkt->data + size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
117 }
118
119 int av_grow_packet(AVPacket *pkt, int grow_by)
120 {
121     int new_size;
122     av_assert0((unsigned)pkt->size <= INT_MAX - FF_INPUT_BUFFER_PADDING_SIZE);
123     if (!pkt->size)
124         return av_new_packet(pkt, grow_by);
125     if ((unsigned)grow_by >
126         INT_MAX - (pkt->size + FF_INPUT_BUFFER_PADDING_SIZE))
127         return -1;
128
129     new_size = pkt->size + grow_by + FF_INPUT_BUFFER_PADDING_SIZE;
130     if (pkt->buf) {
131         int ret = av_buffer_realloc(&pkt->buf, new_size);
132         if (ret < 0)
133             return ret;
134     } else {
135         pkt->buf = av_buffer_alloc(new_size);
136         if (!pkt->buf)
137             return AVERROR(ENOMEM);
138         memcpy(pkt->buf->data, pkt->data, FFMIN(pkt->size, pkt->size + grow_by));
139 #if FF_API_DESTRUCT_PACKET
140 FF_DISABLE_DEPRECATION_WARNINGS
141         pkt->destruct = dummy_destruct_packet;
142 FF_ENABLE_DEPRECATION_WARNINGS
143 #endif
144     }
145     pkt->data  = pkt->buf->data;
146     pkt->size += grow_by;
147     memset(pkt->data + pkt->size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
148
149     return 0;
150 }
151
152 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size)
153 {
154     if (size >= INT_MAX - FF_INPUT_BUFFER_PADDING_SIZE)
155         return AVERROR(EINVAL);
156
157     pkt->buf = av_buffer_create(data, size + FF_INPUT_BUFFER_PADDING_SIZE,
158                                 av_buffer_default_free, NULL, 0);
159     if (!pkt->buf)
160         return AVERROR(ENOMEM);
161
162     pkt->data = data;
163     pkt->size = size;
164 #if FF_API_DESTRUCT_PACKET
165 FF_DISABLE_DEPRECATION_WARNINGS
166     pkt->destruct = dummy_destruct_packet;
167 FF_ENABLE_DEPRECATION_WARNINGS
168 #endif
169
170     return 0;
171 }
172
173 #define ALLOC_MALLOC(data, size) data = av_malloc(size)
174 #define ALLOC_BUF(data, size)                \
175 do {                                         \
176     av_buffer_realloc(&pkt->buf, size);      \
177     data = pkt->buf ? pkt->buf->data : NULL; \
178 } while (0)
179
180 #define DUP_DATA(dst, src, size, padding, ALLOC)                        \
181     do {                                                                \
182         void *data;                                                     \
183         if (padding) {                                                  \
184             if ((unsigned)(size) >                                      \
185                 (unsigned)(size) + FF_INPUT_BUFFER_PADDING_SIZE)        \
186                 goto failed_alloc;                                      \
187             ALLOC(data, size + FF_INPUT_BUFFER_PADDING_SIZE);           \
188         } else {                                                        \
189             ALLOC(data, size);                                          \
190         }                                                               \
191         if (!data)                                                      \
192             goto failed_alloc;                                          \
193         memcpy(data, src, size);                                        \
194         if (padding)                                                    \
195             memset((uint8_t *)data + size, 0,                           \
196                    FF_INPUT_BUFFER_PADDING_SIZE);                       \
197         dst = data;                                                     \
198     } while (0)
199
200 /* Makes duplicates of data, side_data, but does not copy any other fields */
201 static int copy_packet_data(AVPacket *pkt, AVPacket *src, int dup)
202 {
203     pkt->data      = NULL;
204     pkt->side_data = NULL;
205     if (pkt->buf) {
206         AVBufferRef *ref = av_buffer_ref(src->buf);
207         if (!ref)
208             return AVERROR(ENOMEM);
209         pkt->buf  = ref;
210         pkt->data = ref->data;
211     } else {
212         DUP_DATA(pkt->data, src->data, pkt->size, 1, ALLOC_BUF);
213     }
214 #if FF_API_DESTRUCT_PACKET
215 FF_DISABLE_DEPRECATION_WARNINGS
216     pkt->destruct = dummy_destruct_packet;
217 FF_ENABLE_DEPRECATION_WARNINGS
218 #endif
219     if (pkt->side_data_elems && dup)
220         pkt->side_data = src->side_data;
221     if (pkt->side_data_elems && !dup) {
222         return av_copy_packet_side_data(pkt, src);
223     }
224     return 0;
225
226 failed_alloc:
227     av_destruct_packet(pkt);
228     return AVERROR(ENOMEM);
229 }
230
231 int av_copy_packet_side_data(AVPacket *pkt, AVPacket *src)
232 {
233     if (src->side_data_elems) {
234         int i;
235         DUP_DATA(pkt->side_data, src->side_data,
236                 src->side_data_elems * sizeof(*src->side_data), 0, ALLOC_MALLOC);
237         memset(pkt->side_data, 0,
238                 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;
244         }
245     }
246     return 0;
247
248 failed_alloc:
249     av_destruct_packet(pkt);
250     return AVERROR(ENOMEM);
251 }
252
253 int av_dup_packet(AVPacket *pkt)
254 {
255     AVPacket tmp_pkt;
256
257 FF_DISABLE_DEPRECATION_WARNINGS
258     if (!pkt->buf && pkt->data
259 #if FF_API_DESTRUCT_PACKET
260         && !pkt->destruct
261 #endif
262         ) {
263 FF_ENABLE_DEPRECATION_WARNINGS
264         tmp_pkt = *pkt;
265         return copy_packet_data(pkt, &tmp_pkt, 1);
266     }
267     return 0;
268 }
269
270 int av_copy_packet(AVPacket *dst, AVPacket *src)
271 {
272     *dst = *src;
273     return copy_packet_data(dst, src, 0);
274 }
275
276 void av_packet_free_side_data(AVPacket *pkt)
277 {
278     int i;
279     for (i = 0; i < pkt->side_data_elems; i++)
280         av_free(pkt->side_data[i].data);
281     av_freep(&pkt->side_data);
282     pkt->side_data_elems = 0;
283 }
284
285 void av_free_packet(AVPacket *pkt)
286 {
287     if (pkt) {
288 FF_DISABLE_DEPRECATION_WARNINGS
289         if (pkt->buf)
290             av_buffer_unref(&pkt->buf);
291 #if FF_API_DESTRUCT_PACKET
292         else if (pkt->destruct)
293             pkt->destruct(pkt);
294         pkt->destruct = NULL;
295 #endif
296 FF_ENABLE_DEPRECATION_WARNINGS
297         pkt->data            = NULL;
298         pkt->size            = 0;
299
300         av_packet_free_side_data(pkt);
301     }
302 }
303
304 uint8_t *av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
305                                  int size)
306 {
307     int elems = pkt->side_data_elems;
308
309     if ((unsigned)elems + 1 > INT_MAX / sizeof(*pkt->side_data))
310         return NULL;
311     if ((unsigned)size > INT_MAX - FF_INPUT_BUFFER_PADDING_SIZE)
312         return NULL;
313
314     pkt->side_data = av_realloc(pkt->side_data,
315                                 (elems + 1) * sizeof(*pkt->side_data));
316     if (!pkt->side_data)
317         return NULL;
318
319     pkt->side_data[elems].data = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
320     if (!pkt->side_data[elems].data)
321         return NULL;
322     pkt->side_data[elems].size = size;
323     pkt->side_data[elems].type = type;
324     pkt->side_data_elems++;
325
326     return pkt->side_data[elems].data;
327 }
328
329 uint8_t *av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
330                                  int *size)
331 {
332     int i;
333
334     for (i = 0; i < pkt->side_data_elems; i++) {
335         if (pkt->side_data[i].type == type) {
336             if (size)
337                 *size = pkt->side_data[i].size;
338             return pkt->side_data[i].data;
339         }
340     }
341     return NULL;
342 }
343
344 #define FF_MERGE_MARKER 0x8c4d9d108e25e9feULL
345
346 int av_packet_merge_side_data(AVPacket *pkt){
347     if(pkt->side_data_elems){
348         AVBufferRef *buf;
349         int i;
350         uint8_t *p;
351         uint64_t size= pkt->size + 8LL + FF_INPUT_BUFFER_PADDING_SIZE;
352         AVPacket old= *pkt;
353         for (i=0; i<old.side_data_elems; i++) {
354             size += old.side_data[i].size + 5LL;
355         }
356         if (size > INT_MAX)
357             return AVERROR(EINVAL);
358         buf = av_buffer_alloc(size);
359         if (!buf)
360             return AVERROR(ENOMEM);
361         pkt->buf = buf;
362         pkt->data = p = buf->data;
363 #if FF_API_DESTRUCT_PACKET
364 FF_DISABLE_DEPRECATION_WARNINGS
365         pkt->destruct = dummy_destruct_packet;
366 FF_ENABLE_DEPRECATION_WARNINGS
367 #endif
368         pkt->size = size - FF_INPUT_BUFFER_PADDING_SIZE;
369         bytestream_put_buffer(&p, old.data, old.size);
370         for (i=old.side_data_elems-1; i>=0; i--) {
371             bytestream_put_buffer(&p, old.side_data[i].data, old.side_data[i].size);
372             bytestream_put_be32(&p, old.side_data[i].size);
373             *p++ = old.side_data[i].type | ((i==old.side_data_elems-1)*128);
374         }
375         bytestream_put_be64(&p, FF_MERGE_MARKER);
376         av_assert0(p-pkt->data == pkt->size);
377         memset(p, 0, FF_INPUT_BUFFER_PADDING_SIZE);
378         av_free_packet(&old);
379         pkt->side_data_elems = 0;
380         pkt->side_data = NULL;
381         return 1;
382     }
383     return 0;
384 }
385
386 int av_packet_split_side_data(AVPacket *pkt){
387     if (!pkt->side_data_elems && pkt->size >12 && AV_RB64(pkt->data + pkt->size - 8) == FF_MERGE_MARKER){
388         int i;
389         unsigned int size, orig_pktsize = pkt->size;
390         uint8_t *p;
391
392         p = pkt->data + pkt->size - 8 - 5;
393         for (i=1; ; i++){
394             size = AV_RB32(p);
395             if (size>INT_MAX || p - pkt->data < size)
396                 return 0;
397             if (p[4]&128)
398                 break;
399             p-= size+5;
400         }
401
402         pkt->side_data = av_malloc(i * sizeof(*pkt->side_data));
403         if (!pkt->side_data)
404             return AVERROR(ENOMEM);
405
406         p= pkt->data + pkt->size - 8 - 5;
407         for (i=0; ; i++){
408             size= AV_RB32(p);
409             av_assert0(size<=INT_MAX && p - pkt->data >= size);
410             pkt->side_data[i].data = av_malloc(size + FF_INPUT_BUFFER_PADDING_SIZE);
411             pkt->side_data[i].size = size;
412             pkt->side_data[i].type = p[4]&127;
413             if (!pkt->side_data[i].data)
414                 return AVERROR(ENOMEM);
415             memcpy(pkt->side_data[i].data, p-size, size);
416             pkt->size -= size + 5;
417             if(p[4]&128)
418                 break;
419             p-= size+5;
420         }
421         pkt->size -= 8;
422         /* FFMIN() prevents overflow in case the packet wasn't allocated with
423          * proper padding.
424          * If the side data is smaller than the buffer padding size, the
425          * remaining bytes should have already been filled with zeros by the
426          * original packet allocation anyway. */
427         memset(pkt->data + pkt->size, 0,
428                FFMIN(orig_pktsize - pkt->size, FF_INPUT_BUFFER_PADDING_SIZE));
429         pkt->side_data_elems = i+1;
430         return 1;
431     }
432     return 0;
433 }
434
435 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
436                                int size)
437 {
438     int i;
439
440     for (i = 0; i < pkt->side_data_elems; i++) {
441         if (pkt->side_data[i].type == type) {
442             if (size > pkt->side_data[i].size)
443                 return AVERROR(ENOMEM);
444             pkt->side_data[i].size = size;
445             return 0;
446         }
447     }
448     return AVERROR(ENOENT);
449 }
450
451 int av_packet_copy_props(AVPacket *dst, const AVPacket *src)
452 {
453     int i;
454
455     dst->pts                  = src->pts;
456     dst->dts                  = src->dts;
457     dst->pos                  = src->pos;
458     dst->duration             = src->duration;
459     dst->convergence_duration = src->convergence_duration;
460     dst->flags                = src->flags;
461     dst->stream_index         = src->stream_index;
462     dst->side_data_elems      = src->side_data_elems;
463
464     for (i = 0; i < src->side_data_elems; i++) {
465          enum AVPacketSideDataType type = src->side_data[i].type;
466          int size          = src->side_data[i].size;
467          uint8_t *src_data = src->side_data[i].data;
468          uint8_t *dst_data = av_packet_new_side_data(dst, type, size);
469
470         if (!dst_data) {
471             av_packet_free_side_data(dst);
472             return AVERROR(ENOMEM);
473         }
474         memcpy(dst_data, src_data, size);
475     }
476
477     return 0;
478 }
479
480 void av_packet_unref(AVPacket *pkt)
481 {
482     av_packet_free_side_data(pkt);
483     av_buffer_unref(&pkt->buf);
484     av_init_packet(pkt);
485     pkt->data = NULL;
486     pkt->size = 0;
487 }
488
489 int av_packet_ref(AVPacket *dst, AVPacket *src)
490 {
491     int ret;
492
493     ret = av_packet_copy_props(dst, src);
494     if (ret < 0)
495         return ret;
496
497     if (!src->buf) {
498         ret = packet_alloc(&dst->buf, src->size);
499         if (ret < 0)
500             goto fail;
501         memcpy(dst->buf->data, src->data, src->size);
502     } else
503         dst->buf = av_buffer_ref(src->buf);
504
505     dst->size = src->size;
506     dst->data = dst->buf->data;
507     return 0;
508 fail:
509     av_packet_free_side_data(dst);
510     return ret;
511 }
512
513 void av_packet_move_ref(AVPacket *dst, AVPacket *src)
514 {
515     *dst = *src;
516     av_init_packet(src);
517 }