2 * generic decoding-related code
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30 #include "libavutil/avassert.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/bprint.h"
33 #include "libavutil/common.h"
34 #include "libavutil/frame.h"
35 #include "libavutil/hwcontext.h"
36 #include "libavutil/imgutils.h"
37 #include "libavutil/internal.h"
38 #include "libavutil/intmath.h"
39 #include "libavutil/opt.h"
42 #include "bytestream.h"
46 #include "packet_internal.h"
49 typedef struct FramePool {
51 * Pools for each data plane. For audio all the planes have the same size,
52 * so only pools[0] is used.
54 AVBufferPool *pools[4];
61 int stride_align[AV_NUM_DATA_POINTERS];
68 static int apply_param_change(AVCodecContext *avctx, const AVPacket *avpkt)
75 data = av_packet_get_side_data(avpkt, AV_PKT_DATA_PARAM_CHANGE, &size);
79 if (!(avctx->codec->capabilities & AV_CODEC_CAP_PARAM_CHANGE)) {
80 av_log(avctx, AV_LOG_ERROR, "This decoder does not support parameter "
81 "changes, but PARAM_CHANGE side data was sent to it.\n");
82 ret = AVERROR(EINVAL);
89 flags = bytestream_get_le32(&data);
92 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) {
95 val = bytestream_get_le32(&data);
96 if (val <= 0 || val > INT_MAX) {
97 av_log(avctx, AV_LOG_ERROR, "Invalid channel count");
98 ret = AVERROR_INVALIDDATA;
101 avctx->channels = val;
104 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) {
107 avctx->channel_layout = bytestream_get_le64(&data);
110 if (flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) {
113 val = bytestream_get_le32(&data);
114 if (val <= 0 || val > INT_MAX) {
115 av_log(avctx, AV_LOG_ERROR, "Invalid sample rate");
116 ret = AVERROR_INVALIDDATA;
119 avctx->sample_rate = val;
122 if (flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) {
125 avctx->width = bytestream_get_le32(&data);
126 avctx->height = bytestream_get_le32(&data);
128 ret = ff_set_dimensions(avctx, avctx->width, avctx->height);
135 av_log(avctx, AV_LOG_ERROR, "PARAM_CHANGE side data too small.\n");
136 ret = AVERROR_INVALIDDATA;
139 av_log(avctx, AV_LOG_ERROR, "Error applying parameter changes.\n");
140 if (avctx->err_recognition & AV_EF_EXPLODE)
146 #define IS_EMPTY(pkt) (!(pkt)->data)
148 static int extract_packet_props(AVCodecInternal *avci, AVPacket *pkt)
152 ret = avpriv_packet_list_put(&avci->pkt_props, &avci->pkt_props_tail, pkt,
153 av_packet_copy_props, 0);
156 avci->pkt_props_tail->pkt.size = pkt->size; // HACK: Needed for ff_decode_frame_props().
157 avci->pkt_props_tail->pkt.data = (void*)1; // HACK: Needed for IS_EMPTY().
159 if (IS_EMPTY(avci->last_pkt_props)) {
160 ret = avpriv_packet_list_get(&avci->pkt_props,
161 &avci->pkt_props_tail,
162 avci->last_pkt_props);
163 av_assert0(ret != AVERROR(EAGAIN));
168 int ff_decode_bsfs_init(AVCodecContext *avctx)
170 AVCodecInternal *avci = avctx->internal;
176 ret = av_bsf_list_parse_str(avctx->codec->bsfs, &avci->bsf);
178 av_log(avctx, AV_LOG_ERROR, "Error parsing decoder bitstream filters '%s': %s\n", avctx->codec->bsfs, av_err2str(ret));
179 if (ret != AVERROR(ENOMEM))
184 /* We do not currently have an API for passing the input timebase into decoders,
185 * but no filters used here should actually need it.
186 * So we make up some plausible-looking number (the MPEG 90kHz timebase) */
187 avci->bsf->time_base_in = (AVRational){ 1, 90000 };
188 ret = avcodec_parameters_from_context(avci->bsf->par_in, avctx);
192 ret = av_bsf_init(avci->bsf);
198 av_bsf_free(&avci->bsf);
202 int ff_decode_get_packet(AVCodecContext *avctx, AVPacket *pkt)
204 AVCodecInternal *avci = avctx->internal;
210 ret = av_bsf_receive_packet(avci->bsf, pkt);
211 if (ret == AVERROR_EOF)
216 ret = extract_packet_props(avctx->internal, pkt);
220 ret = apply_param_change(avctx, pkt);
224 #if FF_API_OLD_ENCDEC
225 if (avctx->codec->receive_frame)
226 avci->compat_decode_consumed += pkt->size;
231 av_packet_unref(pkt);
236 * Attempt to guess proper monotonic timestamps for decoded video frames
237 * which might have incorrect times. Input timestamps may wrap around, in
238 * which case the output will as well.
240 * @param pts the pts field of the decoded AVPacket, as passed through
242 * @param dts the dts field of the decoded AVPacket
243 * @return one of the input values, may be AV_NOPTS_VALUE
245 static int64_t guess_correct_pts(AVCodecContext *ctx,
246 int64_t reordered_pts, int64_t dts)
248 int64_t pts = AV_NOPTS_VALUE;
250 if (dts != AV_NOPTS_VALUE) {
251 ctx->pts_correction_num_faulty_dts += dts <= ctx->pts_correction_last_dts;
252 ctx->pts_correction_last_dts = dts;
253 } else if (reordered_pts != AV_NOPTS_VALUE)
254 ctx->pts_correction_last_dts = reordered_pts;
256 if (reordered_pts != AV_NOPTS_VALUE) {
257 ctx->pts_correction_num_faulty_pts += reordered_pts <= ctx->pts_correction_last_pts;
258 ctx->pts_correction_last_pts = reordered_pts;
259 } else if(dts != AV_NOPTS_VALUE)
260 ctx->pts_correction_last_pts = dts;
262 if ((ctx->pts_correction_num_faulty_pts<=ctx->pts_correction_num_faulty_dts || dts == AV_NOPTS_VALUE)
263 && reordered_pts != AV_NOPTS_VALUE)
272 * The core of the receive_frame_wrapper for the decoders implementing
273 * the simple API. Certain decoders might consume partial packets without
274 * returning any output, so this function needs to be called in a loop until it
277 static inline int decode_simple_internal(AVCodecContext *avctx, AVFrame *frame, int64_t *discarded_samples)
279 AVCodecInternal *avci = avctx->internal;
280 DecodeSimpleContext *ds = &avci->ds;
281 AVPacket *pkt = ds->in_pkt;
282 // copy to ensure we do not change pkt
283 int got_frame, actual_got_frame;
286 if (!pkt->data && !avci->draining) {
287 av_packet_unref(pkt);
288 ret = ff_decode_get_packet(avctx, pkt);
289 if (ret < 0 && ret != AVERROR_EOF)
293 // Some codecs (at least wma lossless) will crash when feeding drain packets
294 // after EOF was signaled.
295 if (avci->draining_done)
299 !(avctx->codec->capabilities & AV_CODEC_CAP_DELAY ||
300 avctx->active_thread_type & FF_THREAD_FRAME))
305 if (HAVE_THREADS && avctx->active_thread_type & FF_THREAD_FRAME) {
306 ret = ff_thread_decode_frame(avctx, frame, &got_frame, pkt);
308 ret = avctx->codec->decode(avctx, frame, &got_frame, pkt);
310 if (!(avctx->codec->caps_internal & FF_CODEC_CAP_SETS_PKT_DTS))
311 frame->pkt_dts = pkt->dts;
312 if (avctx->codec->type == AVMEDIA_TYPE_VIDEO) {
313 if(!avctx->has_b_frames)
314 frame->pkt_pos = pkt->pos;
315 //FIXME these should be under if(!avctx->has_b_frames)
316 /* get_buffer is supposed to set frame parameters */
317 if (!(avctx->codec->capabilities & AV_CODEC_CAP_DR1)) {
318 if (!frame->sample_aspect_ratio.num) frame->sample_aspect_ratio = avctx->sample_aspect_ratio;
319 if (!frame->width) frame->width = avctx->width;
320 if (!frame->height) frame->height = avctx->height;
321 if (frame->format == AV_PIX_FMT_NONE) frame->format = avctx->pix_fmt;
326 actual_got_frame = got_frame;
328 if (avctx->codec->type == AVMEDIA_TYPE_VIDEO) {
329 if (frame->flags & AV_FRAME_FLAG_DISCARD)
331 } else if (avctx->codec->type == AVMEDIA_TYPE_AUDIO) {
334 uint32_t discard_padding = 0;
335 uint8_t skip_reason = 0;
336 uint8_t discard_reason = 0;
338 if (ret >= 0 && got_frame) {
339 if (frame->format == AV_SAMPLE_FMT_NONE)
340 frame->format = avctx->sample_fmt;
341 if (!frame->channel_layout)
342 frame->channel_layout = avctx->channel_layout;
343 if (!frame->channels)
344 frame->channels = avctx->channels;
345 if (!frame->sample_rate)
346 frame->sample_rate = avctx->sample_rate;
349 side= av_packet_get_side_data(avci->last_pkt_props, AV_PKT_DATA_SKIP_SAMPLES, &side_size);
350 if(side && side_size>=10) {
351 avci->skip_samples = AV_RL32(side) * avci->skip_samples_multiplier;
352 discard_padding = AV_RL32(side + 4);
353 av_log(avctx, AV_LOG_DEBUG, "skip %d / discard %d samples due to side data\n",
354 avci->skip_samples, (int)discard_padding);
355 skip_reason = AV_RL8(side + 8);
356 discard_reason = AV_RL8(side + 9);
359 if ((frame->flags & AV_FRAME_FLAG_DISCARD) && got_frame &&
360 !(avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL)) {
361 avci->skip_samples = FFMAX(0, avci->skip_samples - frame->nb_samples);
363 *discarded_samples += frame->nb_samples;
366 if (avci->skip_samples > 0 && got_frame &&
367 !(avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL)) {
368 if(frame->nb_samples <= avci->skip_samples){
370 *discarded_samples += frame->nb_samples;
371 avci->skip_samples -= frame->nb_samples;
372 av_log(avctx, AV_LOG_DEBUG, "skip whole frame, skip left: %d\n",
375 av_samples_copy(frame->extended_data, frame->extended_data, 0, avci->skip_samples,
376 frame->nb_samples - avci->skip_samples, avctx->channels, frame->format);
377 if(avctx->pkt_timebase.num && avctx->sample_rate) {
378 int64_t diff_ts = av_rescale_q(avci->skip_samples,
379 (AVRational){1, avctx->sample_rate},
380 avctx->pkt_timebase);
381 if(frame->pts!=AV_NOPTS_VALUE)
382 frame->pts += diff_ts;
384 FF_DISABLE_DEPRECATION_WARNINGS
385 if(frame->pkt_pts!=AV_NOPTS_VALUE)
386 frame->pkt_pts += diff_ts;
387 FF_ENABLE_DEPRECATION_WARNINGS
389 if(frame->pkt_dts!=AV_NOPTS_VALUE)
390 frame->pkt_dts += diff_ts;
391 if (frame->pkt_duration >= diff_ts)
392 frame->pkt_duration -= diff_ts;
394 av_log(avctx, AV_LOG_WARNING, "Could not update timestamps for skipped samples.\n");
396 av_log(avctx, AV_LOG_DEBUG, "skip %d/%d samples\n",
397 avci->skip_samples, frame->nb_samples);
398 *discarded_samples += avci->skip_samples;
399 frame->nb_samples -= avci->skip_samples;
400 avci->skip_samples = 0;
404 if (discard_padding > 0 && discard_padding <= frame->nb_samples && got_frame &&
405 !(avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL)) {
406 if (discard_padding == frame->nb_samples) {
407 *discarded_samples += frame->nb_samples;
410 if(avctx->pkt_timebase.num && avctx->sample_rate) {
411 int64_t diff_ts = av_rescale_q(frame->nb_samples - discard_padding,
412 (AVRational){1, avctx->sample_rate},
413 avctx->pkt_timebase);
414 frame->pkt_duration = diff_ts;
416 av_log(avctx, AV_LOG_WARNING, "Could not update timestamps for discarded samples.\n");
418 av_log(avctx, AV_LOG_DEBUG, "discard %d/%d samples\n",
419 (int)discard_padding, frame->nb_samples);
420 frame->nb_samples -= discard_padding;
424 if ((avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL) && got_frame) {
425 AVFrameSideData *fside = av_frame_new_side_data(frame, AV_FRAME_DATA_SKIP_SAMPLES, 10);
427 AV_WL32(fside->data, avci->skip_samples);
428 AV_WL32(fside->data + 4, discard_padding);
429 AV_WL8(fside->data + 8, skip_reason);
430 AV_WL8(fside->data + 9, discard_reason);
431 avci->skip_samples = 0;
436 if (avctx->codec->type == AVMEDIA_TYPE_AUDIO &&
437 !avci->showed_multi_packet_warning &&
438 ret >= 0 && ret != pkt->size && !(avctx->codec->capabilities & AV_CODEC_CAP_SUBFRAMES)) {
439 av_log(avctx, AV_LOG_WARNING, "Multiple frames in a packet.\n");
440 avci->showed_multi_packet_warning = 1;
444 av_frame_unref(frame);
446 if (ret >= 0 && avctx->codec->type == AVMEDIA_TYPE_VIDEO && !(avctx->flags & AV_CODEC_FLAG_TRUNCATED))
449 #if FF_API_AVCTX_TIMEBASE
450 if (avctx->framerate.num > 0 && avctx->framerate.den > 0)
451 avctx->time_base = av_inv_q(av_mul_q(avctx->framerate, (AVRational){avctx->ticks_per_frame, 1}));
454 /* do not stop draining when actual_got_frame != 0 or ret < 0 */
455 /* got_frame == 0 but actual_got_frame != 0 when frame is discarded */
456 if (avci->draining && !actual_got_frame) {
458 /* prevent infinite loop if a decoder wrongly always return error on draining */
459 /* reasonable nb_errors_max = maximum b frames + thread count */
460 int nb_errors_max = 20 + (HAVE_THREADS && avctx->active_thread_type & FF_THREAD_FRAME ?
461 avctx->thread_count : 1);
463 if (avci->nb_draining_errors++ >= nb_errors_max) {
464 av_log(avctx, AV_LOG_ERROR, "Too many errors when draining, this is a bug. "
465 "Stop draining and force EOF.\n");
466 avci->draining_done = 1;
470 avci->draining_done = 1;
474 #if FF_API_OLD_ENCDEC
475 avci->compat_decode_consumed += ret;
478 if (ret >= pkt->size || ret < 0) {
479 av_packet_unref(pkt);
480 av_packet_unref(avci->last_pkt_props);
484 pkt->data += consumed;
485 pkt->size -= consumed;
486 avci->last_pkt_props->size -= consumed; // See extract_packet_props() comment.
487 pkt->pts = AV_NOPTS_VALUE;
488 pkt->dts = AV_NOPTS_VALUE;
489 avci->last_pkt_props->pts = AV_NOPTS_VALUE;
490 avci->last_pkt_props->dts = AV_NOPTS_VALUE;
494 av_assert0(frame->buf[0]);
496 return ret < 0 ? ret : 0;
499 static int decode_simple_receive_frame(AVCodecContext *avctx, AVFrame *frame)
502 int64_t discarded_samples = 0;
504 while (!frame->buf[0]) {
505 if (discarded_samples > avctx->max_samples)
506 return AVERROR(EAGAIN);
507 ret = decode_simple_internal(avctx, frame, &discarded_samples);
515 static int decode_receive_frame_internal(AVCodecContext *avctx, AVFrame *frame)
517 AVCodecInternal *avci = avctx->internal;
520 av_assert0(!frame->buf[0]);
522 if (avctx->codec->receive_frame) {
523 ret = avctx->codec->receive_frame(avctx, frame);
524 if (ret != AVERROR(EAGAIN))
525 av_packet_unref(avci->last_pkt_props);
527 ret = decode_simple_receive_frame(avctx, frame);
529 if (ret == AVERROR_EOF)
530 avci->draining_done = 1;
533 frame->best_effort_timestamp = guess_correct_pts(avctx,
537 /* the only case where decode data is not set should be decoders
538 * that do not call ff_get_buffer() */
539 av_assert0((frame->private_ref && frame->private_ref->size == sizeof(FrameDecodeData)) ||
540 !(avctx->codec->capabilities & AV_CODEC_CAP_DR1));
542 if (frame->private_ref) {
543 FrameDecodeData *fdd = (FrameDecodeData*)frame->private_ref->data;
545 if (fdd->post_process) {
546 ret = fdd->post_process(avctx, frame);
548 av_frame_unref(frame);
555 /* free the per-frame decode data */
556 av_buffer_unref(&frame->private_ref);
561 int attribute_align_arg avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
563 AVCodecInternal *avci = avctx->internal;
566 if (!avcodec_is_open(avctx) || !av_codec_is_decoder(avctx->codec))
567 return AVERROR(EINVAL);
569 if (avctx->internal->draining)
572 if (avpkt && !avpkt->size && avpkt->data)
573 return AVERROR(EINVAL);
575 av_packet_unref(avci->buffer_pkt);
576 if (avpkt && (avpkt->data || avpkt->side_data_elems)) {
577 ret = av_packet_ref(avci->buffer_pkt, avpkt);
582 ret = av_bsf_send_packet(avci->bsf, avci->buffer_pkt);
584 av_packet_unref(avci->buffer_pkt);
588 if (!avci->buffer_frame->buf[0]) {
589 ret = decode_receive_frame_internal(avctx, avci->buffer_frame);
590 if (ret < 0 && ret != AVERROR(EAGAIN) && ret != AVERROR_EOF)
597 static int apply_cropping(AVCodecContext *avctx, AVFrame *frame)
599 /* make sure we are noisy about decoders returning invalid cropping data */
600 if (frame->crop_left >= INT_MAX - frame->crop_right ||
601 frame->crop_top >= INT_MAX - frame->crop_bottom ||
602 (frame->crop_left + frame->crop_right) >= frame->width ||
603 (frame->crop_top + frame->crop_bottom) >= frame->height) {
604 av_log(avctx, AV_LOG_WARNING,
605 "Invalid cropping information set by a decoder: "
606 "%"SIZE_SPECIFIER"/%"SIZE_SPECIFIER"/%"SIZE_SPECIFIER"/%"SIZE_SPECIFIER" "
607 "(frame size %dx%d). This is a bug, please report it\n",
608 frame->crop_left, frame->crop_right, frame->crop_top, frame->crop_bottom,
609 frame->width, frame->height);
610 frame->crop_left = 0;
611 frame->crop_right = 0;
613 frame->crop_bottom = 0;
617 if (!avctx->apply_cropping)
620 return av_frame_apply_cropping(frame, avctx->flags & AV_CODEC_FLAG_UNALIGNED ?
621 AV_FRAME_CROP_UNALIGNED : 0);
624 int attribute_align_arg avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
626 AVCodecInternal *avci = avctx->internal;
629 av_frame_unref(frame);
631 if (!avcodec_is_open(avctx) || !av_codec_is_decoder(avctx->codec))
632 return AVERROR(EINVAL);
634 if (avci->buffer_frame->buf[0]) {
635 av_frame_move_ref(frame, avci->buffer_frame);
637 ret = decode_receive_frame_internal(avctx, frame);
642 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO) {
643 ret = apply_cropping(avctx, frame);
645 av_frame_unref(frame);
650 avctx->frame_number++;
652 if (avctx->flags & AV_CODEC_FLAG_DROPCHANGED) {
654 if (avctx->frame_number == 1) {
655 avci->initial_format = frame->format;
656 switch(avctx->codec_type) {
657 case AVMEDIA_TYPE_VIDEO:
658 avci->initial_width = frame->width;
659 avci->initial_height = frame->height;
661 case AVMEDIA_TYPE_AUDIO:
662 avci->initial_sample_rate = frame->sample_rate ? frame->sample_rate :
664 avci->initial_channels = frame->channels;
665 avci->initial_channel_layout = frame->channel_layout;
670 if (avctx->frame_number > 1) {
671 changed = avci->initial_format != frame->format;
673 switch(avctx->codec_type) {
674 case AVMEDIA_TYPE_VIDEO:
675 changed |= avci->initial_width != frame->width ||
676 avci->initial_height != frame->height;
678 case AVMEDIA_TYPE_AUDIO:
679 changed |= avci->initial_sample_rate != frame->sample_rate ||
680 avci->initial_sample_rate != avctx->sample_rate ||
681 avci->initial_channels != frame->channels ||
682 avci->initial_channel_layout != frame->channel_layout;
687 avci->changed_frames_dropped++;
688 av_log(avctx, AV_LOG_INFO, "dropped changed frame #%d pts %"PRId64
689 " drop count: %d \n",
690 avctx->frame_number, frame->pts,
691 avci->changed_frames_dropped);
692 av_frame_unref(frame);
693 return AVERROR_INPUT_CHANGED;
700 #if FF_API_OLD_ENCDEC
701 FF_DISABLE_DEPRECATION_WARNINGS
702 static int unrefcount_frame(AVCodecInternal *avci, AVFrame *frame)
706 /* move the original frame to our backup */
707 av_frame_unref(avci->to_free);
708 av_frame_move_ref(avci->to_free, frame);
710 /* now copy everything except the AVBufferRefs back
711 * note that we make a COPY of the side data, so calling av_frame_free() on
712 * the caller's frame will work properly */
713 ret = av_frame_copy_props(frame, avci->to_free);
717 memcpy(frame->data, avci->to_free->data, sizeof(frame->data));
718 memcpy(frame->linesize, avci->to_free->linesize, sizeof(frame->linesize));
719 if (avci->to_free->extended_data != avci->to_free->data) {
720 int planes = avci->to_free->channels;
721 int size = planes * sizeof(*frame->extended_data);
724 av_frame_unref(frame);
728 frame->extended_data = av_malloc(size);
729 if (!frame->extended_data) {
730 av_frame_unref(frame);
731 return AVERROR(ENOMEM);
733 memcpy(frame->extended_data, avci->to_free->extended_data,
736 frame->extended_data = frame->data;
738 frame->format = avci->to_free->format;
739 frame->width = avci->to_free->width;
740 frame->height = avci->to_free->height;
741 frame->channel_layout = avci->to_free->channel_layout;
742 frame->nb_samples = avci->to_free->nb_samples;
743 frame->channels = avci->to_free->channels;
748 static int compat_decode(AVCodecContext *avctx, AVFrame *frame,
749 int *got_frame, const AVPacket *pkt)
751 AVCodecInternal *avci = avctx->internal;
754 av_assert0(avci->compat_decode_consumed == 0);
756 if (avci->draining_done && pkt && pkt->size != 0) {
757 av_log(avctx, AV_LOG_WARNING, "Got unexpected packet after EOF\n");
758 avcodec_flush_buffers(avctx);
763 if (avci->compat_decode_partial_size > 0 &&
764 avci->compat_decode_partial_size != pkt->size) {
765 av_log(avctx, AV_LOG_ERROR,
766 "Got unexpected packet size after a partial decode\n");
767 ret = AVERROR(EINVAL);
771 if (!avci->compat_decode_partial_size) {
772 ret = avcodec_send_packet(avctx, pkt);
773 if (ret == AVERROR_EOF)
775 else if (ret == AVERROR(EAGAIN)) {
776 /* we fully drain all the output in each decode call, so this should not
785 ret = avcodec_receive_frame(avctx, frame);
787 if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
792 if (frame != avci->compat_decode_frame) {
793 if (!avctx->refcounted_frames) {
794 ret = unrefcount_frame(avci, frame);
800 frame = avci->compat_decode_frame;
802 if (!avci->compat_decode_warned) {
803 av_log(avctx, AV_LOG_WARNING, "The deprecated avcodec_decode_* "
804 "API cannot return all the frames for this decoder. "
805 "Some frames will be dropped. Update your code to the "
806 "new decoding API to fix this.\n");
807 avci->compat_decode_warned = 1;
811 if (avci->draining || (!avctx->codec->bsfs && avci->compat_decode_consumed < pkt->size))
817 /* if there are any bsfs then assume full packet is always consumed */
818 if (avctx->codec->bsfs)
821 ret = FFMIN(avci->compat_decode_consumed, pkt->size);
823 avci->compat_decode_consumed = 0;
824 avci->compat_decode_partial_size = (ret >= 0) ? pkt->size - ret : 0;
829 int attribute_align_arg avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
830 int *got_picture_ptr,
831 const AVPacket *avpkt)
833 return compat_decode(avctx, picture, got_picture_ptr, avpkt);
836 int attribute_align_arg avcodec_decode_audio4(AVCodecContext *avctx,
839 const AVPacket *avpkt)
841 return compat_decode(avctx, frame, got_frame_ptr, avpkt);
843 FF_ENABLE_DEPRECATION_WARNINGS
846 static void get_subtitle_defaults(AVSubtitle *sub)
848 memset(sub, 0, sizeof(*sub));
849 sub->pts = AV_NOPTS_VALUE;
852 #define UTF8_MAX_BYTES 4 /* 5 and 6 bytes sequences should not be used */
853 static int recode_subtitle(AVCodecContext *avctx,
854 AVPacket *outpkt, const AVPacket *inpkt)
857 iconv_t cd = (iconv_t)-1;
864 if (avctx->sub_charenc_mode != FF_SUB_CHARENC_MODE_PRE_DECODER || inpkt->size == 0)
868 cd = iconv_open("UTF-8", avctx->sub_charenc);
869 av_assert0(cd != (iconv_t)-1);
874 if (inl >= INT_MAX / UTF8_MAX_BYTES - AV_INPUT_BUFFER_PADDING_SIZE) {
875 av_log(avctx, AV_LOG_ERROR, "Subtitles packet is too big for recoding\n");
876 ret = AVERROR(ENOMEM);
880 ret = av_new_packet(&tmp, inl * UTF8_MAX_BYTES);
883 outpkt->buf = tmp.buf;
884 outpkt->data = tmp.data;
885 outpkt->size = tmp.size;
889 if (iconv(cd, &inb, &inl, &outb, &outl) == (size_t)-1 ||
890 iconv(cd, NULL, NULL, &outb, &outl) == (size_t)-1 ||
891 outl >= outpkt->size || inl != 0) {
892 ret = FFMIN(AVERROR(errno), -1);
893 av_log(avctx, AV_LOG_ERROR, "Unable to recode subtitle event \"%s\" "
894 "from %s to UTF-8\n", inpkt->data, avctx->sub_charenc);
895 av_packet_unref(&tmp);
898 outpkt->size -= outl;
899 memset(outpkt->data + outpkt->size, 0, outl);
902 if (cd != (iconv_t)-1)
906 av_log(avctx, AV_LOG_ERROR, "requesting subtitles recoding without iconv");
907 return AVERROR(EINVAL);
911 static int utf8_check(const uint8_t *str)
914 uint32_t codepoint, min;
918 GET_UTF8(codepoint, *(byte++), return 0;);
919 min = byte - str == 1 ? 0 : byte - str == 2 ? 0x80 :
920 1 << (5 * (byte - str) - 4);
921 if (codepoint < min || codepoint >= 0x110000 ||
922 codepoint == 0xFFFE /* BOM */ ||
923 codepoint >= 0xD800 && codepoint <= 0xDFFF /* surrogates */)
930 #if FF_API_ASS_TIMING
931 static void insert_ts(AVBPrint *buf, int ts)
934 av_bprintf(buf, "9:59:59.99,");
938 h = ts/360000; ts -= 360000*h;
939 m = ts/ 6000; ts -= 6000*m;
940 s = ts/ 100; ts -= 100*s;
941 av_bprintf(buf, "%d:%02d:%02d.%02d,", h, m, s, ts);
945 static int convert_sub_to_old_ass_form(AVSubtitle *sub, const AVPacket *pkt, AVRational tb)
950 av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
952 for (i = 0; i < sub->num_rects; i++) {
955 AVSubtitleRect *rect = sub->rects[i];
956 int ts_start, ts_duration = -1;
959 if (rect->type != SUBTITLE_ASS || !strncmp(rect->ass, "Dialogue: ", 10))
962 av_bprint_clear(&buf);
965 dialog = strchr(rect->ass, ',');
970 /* extract Layer or Marked */
971 layer = strtol(dialog, (char**)&dialog, 10);
976 /* rescale timing to ASS time base (ms) */
977 ts_start = av_rescale_q(pkt->pts, tb, av_make_q(1, 100));
978 if (pkt->duration != -1)
979 ts_duration = av_rescale_q(pkt->duration, tb, av_make_q(1, 100));
980 sub->end_display_time = FFMAX(sub->end_display_time, 10 * ts_duration);
982 /* construct ASS (standalone file form with timestamps) string */
983 av_bprintf(&buf, "Dialogue: %ld,", layer);
984 insert_ts(&buf, ts_start);
985 insert_ts(&buf, ts_duration == -1 ? -1 : ts_start + ts_duration);
986 av_bprintf(&buf, "%s\r\n", dialog);
988 final_dialog = av_strdup(buf.str);
989 if (!av_bprint_is_complete(&buf) || !final_dialog) {
990 av_freep(&final_dialog);
991 av_bprint_finalize(&buf, NULL);
992 return AVERROR(ENOMEM);
994 av_freep(&rect->ass);
995 rect->ass = final_dialog;
998 av_bprint_finalize(&buf, NULL);
1003 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
1009 if (!avpkt->data && avpkt->size) {
1010 av_log(avctx, AV_LOG_ERROR, "invalid packet: NULL data, size != 0\n");
1011 return AVERROR(EINVAL);
1014 return AVERROR(EINVAL);
1015 if (avctx->codec->type != AVMEDIA_TYPE_SUBTITLE) {
1016 av_log(avctx, AV_LOG_ERROR, "Invalid media type for subtitles\n");
1017 return AVERROR(EINVAL);
1021 get_subtitle_defaults(sub);
1023 if ((avctx->codec->capabilities & AV_CODEC_CAP_DELAY) || avpkt->size) {
1024 AVPacket pkt_recoded = *avpkt;
1026 ret = recode_subtitle(avctx, &pkt_recoded, avpkt);
1030 ret = extract_packet_props(avctx->internal, &pkt_recoded);
1034 if (avctx->pkt_timebase.num && avpkt->pts != AV_NOPTS_VALUE)
1035 sub->pts = av_rescale_q(avpkt->pts,
1036 avctx->pkt_timebase, AV_TIME_BASE_Q);
1037 ret = avctx->codec->decode(avctx, sub, got_sub_ptr, &pkt_recoded);
1038 av_assert1((ret >= 0) >= !!*got_sub_ptr &&
1039 !!*got_sub_ptr >= !!sub->num_rects);
1041 #if FF_API_ASS_TIMING
1042 if (avctx->sub_text_format == FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS
1043 && *got_sub_ptr && sub->num_rects) {
1044 const AVRational tb = avctx->pkt_timebase.num ? avctx->pkt_timebase
1046 int err = convert_sub_to_old_ass_form(sub, avpkt, tb);
1052 if (sub->num_rects && !sub->end_display_time && avpkt->duration &&
1053 avctx->pkt_timebase.num) {
1054 AVRational ms = { 1, 1000 };
1055 sub->end_display_time = av_rescale_q(avpkt->duration,
1056 avctx->pkt_timebase, ms);
1059 if (avctx->codec_descriptor->props & AV_CODEC_PROP_BITMAP_SUB)
1061 else if (avctx->codec_descriptor->props & AV_CODEC_PROP_TEXT_SUB)
1064 for (i = 0; i < sub->num_rects; i++) {
1065 if (avctx->sub_charenc_mode != FF_SUB_CHARENC_MODE_IGNORE &&
1066 sub->rects[i]->ass && !utf8_check(sub->rects[i]->ass)) {
1067 av_log(avctx, AV_LOG_ERROR,
1068 "Invalid UTF-8 in decoded subtitles text; "
1069 "maybe missing -sub_charenc option\n");
1070 avsubtitle_free(sub);
1071 ret = AVERROR_INVALIDDATA;
1076 if (avpkt->data != pkt_recoded.data) { // did we recode?
1077 /* prevent from destroying side data from original packet */
1078 pkt_recoded.side_data = NULL;
1079 pkt_recoded.side_data_elems = 0;
1081 av_packet_unref(&pkt_recoded);
1086 avctx->frame_number++;
1092 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *avctx,
1093 const enum AVPixelFormat *fmt)
1095 const AVPixFmtDescriptor *desc;
1096 const AVCodecHWConfig *config;
1099 // If a device was supplied when the codec was opened, assume that the
1100 // user wants to use it.
1101 if (avctx->hw_device_ctx && avctx->codec->hw_configs) {
1102 AVHWDeviceContext *device_ctx =
1103 (AVHWDeviceContext*)avctx->hw_device_ctx->data;
1105 config = &avctx->codec->hw_configs[i]->public;
1108 if (!(config->methods &
1109 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX))
1111 if (device_ctx->type != config->device_type)
1113 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++) {
1114 if (config->pix_fmt == fmt[n])
1119 // No device or other setup, so we have to choose from things which
1120 // don't any other external information.
1122 // If the last element of the list is a software format, choose it
1123 // (this should be best software format if any exist).
1124 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++);
1125 desc = av_pix_fmt_desc_get(fmt[n - 1]);
1126 if (!(desc->flags & AV_PIX_FMT_FLAG_HWACCEL))
1129 // Finally, traverse the list in order and choose the first entry
1130 // with no external dependencies (if there is no hardware configuration
1131 // information available then this just picks the first entry).
1132 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++) {
1134 config = avcodec_get_hw_config(avctx->codec, i);
1137 if (config->pix_fmt == fmt[n])
1141 // No specific config available, so the decoder must be able
1142 // to handle this format without any additional setup.
1145 if (config->methods & AV_CODEC_HW_CONFIG_METHOD_INTERNAL) {
1146 // Usable with only internal setup.
1151 // Nothing is usable, give up.
1152 return AV_PIX_FMT_NONE;
1155 int ff_decode_get_hw_frames_ctx(AVCodecContext *avctx,
1156 enum AVHWDeviceType dev_type)
1158 AVHWDeviceContext *device_ctx;
1159 AVHWFramesContext *frames_ctx;
1162 if (!avctx->hwaccel)
1163 return AVERROR(ENOSYS);
1165 if (avctx->hw_frames_ctx)
1167 if (!avctx->hw_device_ctx) {
1168 av_log(avctx, AV_LOG_ERROR, "A hardware frames or device context is "
1169 "required for hardware accelerated decoding.\n");
1170 return AVERROR(EINVAL);
1173 device_ctx = (AVHWDeviceContext *)avctx->hw_device_ctx->data;
1174 if (device_ctx->type != dev_type) {
1175 av_log(avctx, AV_LOG_ERROR, "Device type %s expected for hardware "
1176 "decoding, but got %s.\n", av_hwdevice_get_type_name(dev_type),
1177 av_hwdevice_get_type_name(device_ctx->type));
1178 return AVERROR(EINVAL);
1181 ret = avcodec_get_hw_frames_parameters(avctx,
1182 avctx->hw_device_ctx,
1183 avctx->hwaccel->pix_fmt,
1184 &avctx->hw_frames_ctx);
1188 frames_ctx = (AVHWFramesContext*)avctx->hw_frames_ctx->data;
1191 if (frames_ctx->initial_pool_size) {
1192 // We guarantee 4 base work surfaces. The function above guarantees 1
1193 // (the absolute minimum), so add the missing count.
1194 frames_ctx->initial_pool_size += 3;
1197 ret = av_hwframe_ctx_init(avctx->hw_frames_ctx);
1199 av_buffer_unref(&avctx->hw_frames_ctx);
1206 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
1207 AVBufferRef *device_ref,
1208 enum AVPixelFormat hw_pix_fmt,
1209 AVBufferRef **out_frames_ref)
1211 AVBufferRef *frames_ref = NULL;
1212 const AVCodecHWConfigInternal *hw_config;
1213 const AVHWAccel *hwa;
1217 hw_config = avctx->codec->hw_configs[i];
1219 return AVERROR(ENOENT);
1220 if (hw_config->public.pix_fmt == hw_pix_fmt)
1224 hwa = hw_config->hwaccel;
1225 if (!hwa || !hwa->frame_params)
1226 return AVERROR(ENOENT);
1228 frames_ref = av_hwframe_ctx_alloc(device_ref);
1230 return AVERROR(ENOMEM);
1232 ret = hwa->frame_params(avctx, frames_ref);
1234 AVHWFramesContext *frames_ctx = (AVHWFramesContext*)frames_ref->data;
1236 if (frames_ctx->initial_pool_size) {
1237 // If the user has requested that extra output surfaces be
1238 // available then add them here.
1239 if (avctx->extra_hw_frames > 0)
1240 frames_ctx->initial_pool_size += avctx->extra_hw_frames;
1242 // If frame threading is enabled then an extra surface per thread
1243 // is also required.
1244 if (avctx->active_thread_type & FF_THREAD_FRAME)
1245 frames_ctx->initial_pool_size += avctx->thread_count;
1248 *out_frames_ref = frames_ref;
1250 av_buffer_unref(&frames_ref);
1255 static int hwaccel_init(AVCodecContext *avctx,
1256 const AVCodecHWConfigInternal *hw_config)
1258 const AVHWAccel *hwaccel;
1261 hwaccel = hw_config->hwaccel;
1262 if (hwaccel->capabilities & AV_HWACCEL_CODEC_CAP_EXPERIMENTAL &&
1263 avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL) {
1264 av_log(avctx, AV_LOG_WARNING, "Ignoring experimental hwaccel: %s\n",
1266 return AVERROR_PATCHWELCOME;
1269 if (hwaccel->priv_data_size) {
1270 avctx->internal->hwaccel_priv_data =
1271 av_mallocz(hwaccel->priv_data_size);
1272 if (!avctx->internal->hwaccel_priv_data)
1273 return AVERROR(ENOMEM);
1276 avctx->hwaccel = hwaccel;
1277 if (hwaccel->init) {
1278 err = hwaccel->init(avctx);
1280 av_log(avctx, AV_LOG_ERROR, "Failed setup for format %s: "
1281 "hwaccel initialisation returned error.\n",
1282 av_get_pix_fmt_name(hw_config->public.pix_fmt));
1283 av_freep(&avctx->internal->hwaccel_priv_data);
1284 avctx->hwaccel = NULL;
1292 static void hwaccel_uninit(AVCodecContext *avctx)
1294 if (avctx->hwaccel && avctx->hwaccel->uninit)
1295 avctx->hwaccel->uninit(avctx);
1297 av_freep(&avctx->internal->hwaccel_priv_data);
1299 avctx->hwaccel = NULL;
1301 av_buffer_unref(&avctx->hw_frames_ctx);
1304 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
1306 const AVPixFmtDescriptor *desc;
1307 enum AVPixelFormat *choices;
1308 enum AVPixelFormat ret, user_choice;
1309 const AVCodecHWConfigInternal *hw_config;
1310 const AVCodecHWConfig *config;
1313 // Find end of list.
1314 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++);
1315 // Must contain at least one entry.
1317 // If a software format is available, it must be the last entry.
1318 desc = av_pix_fmt_desc_get(fmt[n - 1]);
1319 if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
1320 // No software format is available.
1322 avctx->sw_pix_fmt = fmt[n - 1];
1325 choices = av_malloc_array(n + 1, sizeof(*choices));
1327 return AV_PIX_FMT_NONE;
1329 memcpy(choices, fmt, (n + 1) * sizeof(*choices));
1332 // Remove the previous hwaccel, if there was one.
1333 hwaccel_uninit(avctx);
1335 user_choice = avctx->get_format(avctx, choices);
1336 if (user_choice == AV_PIX_FMT_NONE) {
1337 // Explicitly chose nothing, give up.
1338 ret = AV_PIX_FMT_NONE;
1342 desc = av_pix_fmt_desc_get(user_choice);
1344 av_log(avctx, AV_LOG_ERROR, "Invalid format returned by "
1345 "get_format() callback.\n");
1346 ret = AV_PIX_FMT_NONE;
1349 av_log(avctx, AV_LOG_DEBUG, "Format %s chosen by get_format().\n",
1352 for (i = 0; i < n; i++) {
1353 if (choices[i] == user_choice)
1357 av_log(avctx, AV_LOG_ERROR, "Invalid return from get_format(): "
1358 "%s not in possible list.\n", desc->name);
1359 ret = AV_PIX_FMT_NONE;
1363 if (avctx->codec->hw_configs) {
1365 hw_config = avctx->codec->hw_configs[i];
1368 if (hw_config->public.pix_fmt == user_choice)
1376 // No config available, so no extra setup required.
1380 config = &hw_config->public;
1382 if (config->methods &
1383 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX &&
1384 avctx->hw_frames_ctx) {
1385 const AVHWFramesContext *frames_ctx =
1386 (AVHWFramesContext*)avctx->hw_frames_ctx->data;
1387 if (frames_ctx->format != user_choice) {
1388 av_log(avctx, AV_LOG_ERROR, "Invalid setup for format %s: "
1389 "does not match the format of the provided frames "
1390 "context.\n", desc->name);
1393 } else if (config->methods &
1394 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX &&
1395 avctx->hw_device_ctx) {
1396 const AVHWDeviceContext *device_ctx =
1397 (AVHWDeviceContext*)avctx->hw_device_ctx->data;
1398 if (device_ctx->type != config->device_type) {
1399 av_log(avctx, AV_LOG_ERROR, "Invalid setup for format %s: "
1400 "does not match the type of the provided device "
1401 "context.\n", desc->name);
1404 } else if (config->methods &
1405 AV_CODEC_HW_CONFIG_METHOD_INTERNAL) {
1406 // Internal-only setup, no additional configuration.
1407 } else if (config->methods &
1408 AV_CODEC_HW_CONFIG_METHOD_AD_HOC) {
1409 // Some ad-hoc configuration we can't see and can't check.
1411 av_log(avctx, AV_LOG_ERROR, "Invalid setup for format %s: "
1412 "missing configuration.\n", desc->name);
1415 if (hw_config->hwaccel) {
1416 av_log(avctx, AV_LOG_DEBUG, "Format %s requires hwaccel "
1417 "initialisation.\n", desc->name);
1418 err = hwaccel_init(avctx, hw_config);
1426 av_log(avctx, AV_LOG_DEBUG, "Format %s not usable, retrying "
1427 "get_format() without it.\n", desc->name);
1428 for (i = 0; i < n; i++) {
1429 if (choices[i] == user_choice)
1432 for (; i + 1 < n; i++)
1433 choices[i] = choices[i + 1];
1441 static void frame_pool_free(void *opaque, uint8_t *data)
1443 FramePool *pool = (FramePool*)data;
1446 for (i = 0; i < FF_ARRAY_ELEMS(pool->pools); i++)
1447 av_buffer_pool_uninit(&pool->pools[i]);
1452 static AVBufferRef *frame_pool_alloc(void)
1454 FramePool *pool = av_mallocz(sizeof(*pool));
1460 buf = av_buffer_create((uint8_t*)pool, sizeof(*pool),
1461 frame_pool_free, NULL, 0);
1470 static int update_frame_pool(AVCodecContext *avctx, AVFrame *frame)
1472 FramePool *pool = avctx->internal->pool ?
1473 (FramePool*)avctx->internal->pool->data : NULL;
1474 AVBufferRef *pool_buf;
1475 int i, ret, ch, planes;
1477 if (avctx->codec_type == AVMEDIA_TYPE_AUDIO) {
1478 int planar = av_sample_fmt_is_planar(frame->format);
1479 ch = frame->channels;
1480 planes = planar ? ch : 1;
1483 if (pool && pool->format == frame->format) {
1484 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO &&
1485 pool->width == frame->width && pool->height == frame->height)
1487 if (avctx->codec_type == AVMEDIA_TYPE_AUDIO && pool->planes == planes &&
1488 pool->channels == ch && frame->nb_samples == pool->samples)
1492 pool_buf = frame_pool_alloc();
1494 return AVERROR(ENOMEM);
1495 pool = (FramePool*)pool_buf->data;
1497 switch (avctx->codec_type) {
1498 case AVMEDIA_TYPE_VIDEO: {
1500 int w = frame->width;
1501 int h = frame->height;
1503 ptrdiff_t linesize1[4];
1506 avcodec_align_dimensions2(avctx, &w, &h, pool->stride_align);
1509 // NOTE: do not align linesizes individually, this breaks e.g. assumptions
1510 // that linesize[0] == 2*linesize[1] in the MPEG-encoder for 4:2:2
1511 ret = av_image_fill_linesizes(linesize, avctx->pix_fmt, w);
1514 // increase alignment of w for next try (rhs gives the lowest bit set in w)
1518 for (i = 0; i < 4; i++)
1519 unaligned |= linesize[i] % pool->stride_align[i];
1520 } while (unaligned);
1522 for (i = 0; i < 4; i++)
1523 linesize1[i] = linesize[i];
1524 ret = av_image_fill_plane_sizes(size, avctx->pix_fmt, h, linesize1);
1528 for (i = 0; i < 4; i++) {
1529 pool->linesize[i] = linesize[i];
1531 if (size[i] > INT_MAX - (16 + STRIDE_ALIGN - 1)) {
1532 ret = AVERROR(EINVAL);
1535 pool->pools[i] = av_buffer_pool_init(size[i] + 16 + STRIDE_ALIGN - 1,
1536 CONFIG_MEMORY_POISONING ?
1539 if (!pool->pools[i]) {
1540 ret = AVERROR(ENOMEM);
1545 pool->format = frame->format;
1546 pool->width = frame->width;
1547 pool->height = frame->height;
1551 case AVMEDIA_TYPE_AUDIO: {
1552 ret = av_samples_get_buffer_size(&pool->linesize[0], ch,
1553 frame->nb_samples, frame->format, 0);
1557 pool->pools[0] = av_buffer_pool_init(pool->linesize[0], NULL);
1558 if (!pool->pools[0]) {
1559 ret = AVERROR(ENOMEM);
1563 pool->format = frame->format;
1564 pool->planes = planes;
1565 pool->channels = ch;
1566 pool->samples = frame->nb_samples;
1569 default: av_assert0(0);
1572 av_buffer_unref(&avctx->internal->pool);
1573 avctx->internal->pool = pool_buf;
1577 av_buffer_unref(&pool_buf);
1581 static int audio_get_buffer(AVCodecContext *avctx, AVFrame *frame)
1583 FramePool *pool = (FramePool*)avctx->internal->pool->data;
1584 int planes = pool->planes;
1587 frame->linesize[0] = pool->linesize[0];
1589 if (planes > AV_NUM_DATA_POINTERS) {
1590 frame->extended_data = av_mallocz_array(planes, sizeof(*frame->extended_data));
1591 frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
1592 frame->extended_buf = av_mallocz_array(frame->nb_extended_buf,
1593 sizeof(*frame->extended_buf));
1594 if (!frame->extended_data || !frame->extended_buf) {
1595 av_freep(&frame->extended_data);
1596 av_freep(&frame->extended_buf);
1597 return AVERROR(ENOMEM);
1600 frame->extended_data = frame->data;
1601 av_assert0(frame->nb_extended_buf == 0);
1604 for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
1605 frame->buf[i] = av_buffer_pool_get(pool->pools[0]);
1608 frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
1610 for (i = 0; i < frame->nb_extended_buf; i++) {
1611 frame->extended_buf[i] = av_buffer_pool_get(pool->pools[0]);
1612 if (!frame->extended_buf[i])
1614 frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
1617 if (avctx->debug & FF_DEBUG_BUFFERS)
1618 av_log(avctx, AV_LOG_DEBUG, "default_get_buffer called on frame %p", frame);
1622 av_frame_unref(frame);
1623 return AVERROR(ENOMEM);
1626 static int video_get_buffer(AVCodecContext *s, AVFrame *pic)
1628 FramePool *pool = (FramePool*)s->internal->pool->data;
1629 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pic->format);
1632 if (pic->data[0] || pic->data[1] || pic->data[2] || pic->data[3]) {
1633 av_log(s, AV_LOG_ERROR, "pic->data[*]!=NULL in avcodec_default_get_buffer\n");
1638 av_log(s, AV_LOG_ERROR,
1639 "Unable to get pixel format descriptor for format %s\n",
1640 av_get_pix_fmt_name(pic->format));
1641 return AVERROR(EINVAL);
1644 memset(pic->data, 0, sizeof(pic->data));
1645 pic->extended_data = pic->data;
1647 for (i = 0; i < 4 && pool->pools[i]; i++) {
1648 pic->linesize[i] = pool->linesize[i];
1650 pic->buf[i] = av_buffer_pool_get(pool->pools[i]);
1654 pic->data[i] = pic->buf[i]->data;
1656 for (; i < AV_NUM_DATA_POINTERS; i++) {
1657 pic->data[i] = NULL;
1658 pic->linesize[i] = 0;
1660 if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
1661 ((desc->flags & FF_PSEUDOPAL) && pic->data[1]))
1662 avpriv_set_systematic_pal2((uint32_t *)pic->data[1], pic->format);
1664 if (s->debug & FF_DEBUG_BUFFERS)
1665 av_log(s, AV_LOG_DEBUG, "default_get_buffer called on pic %p\n", pic);
1669 av_frame_unref(pic);
1670 return AVERROR(ENOMEM);
1673 int avcodec_default_get_buffer2(AVCodecContext *avctx, AVFrame *frame, int flags)
1677 if (avctx->hw_frames_ctx) {
1678 ret = av_hwframe_get_buffer(avctx->hw_frames_ctx, frame, 0);
1679 frame->width = avctx->coded_width;
1680 frame->height = avctx->coded_height;
1684 if ((ret = update_frame_pool(avctx, frame)) < 0)
1687 switch (avctx->codec_type) {
1688 case AVMEDIA_TYPE_VIDEO:
1689 return video_get_buffer(avctx, frame);
1690 case AVMEDIA_TYPE_AUDIO:
1691 return audio_get_buffer(avctx, frame);
1697 static int add_metadata_from_side_data(const AVPacket *avpkt, AVFrame *frame)
1700 const uint8_t *side_metadata;
1702 AVDictionary **frame_md = &frame->metadata;
1704 side_metadata = av_packet_get_side_data(avpkt,
1705 AV_PKT_DATA_STRINGS_METADATA, &size);
1706 return av_packet_unpack_dictionary(side_metadata, size, frame_md);
1709 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame)
1711 AVPacket *pkt = avctx->internal->last_pkt_props;
1713 static const struct {
1714 enum AVPacketSideDataType packet;
1715 enum AVFrameSideDataType frame;
1717 { AV_PKT_DATA_REPLAYGAIN , AV_FRAME_DATA_REPLAYGAIN },
1718 { AV_PKT_DATA_DISPLAYMATRIX, AV_FRAME_DATA_DISPLAYMATRIX },
1719 { AV_PKT_DATA_SPHERICAL, AV_FRAME_DATA_SPHERICAL },
1720 { AV_PKT_DATA_STEREO3D, AV_FRAME_DATA_STEREO3D },
1721 { AV_PKT_DATA_AUDIO_SERVICE_TYPE, AV_FRAME_DATA_AUDIO_SERVICE_TYPE },
1722 { AV_PKT_DATA_MASTERING_DISPLAY_METADATA, AV_FRAME_DATA_MASTERING_DISPLAY_METADATA },
1723 { AV_PKT_DATA_CONTENT_LIGHT_LEVEL, AV_FRAME_DATA_CONTENT_LIGHT_LEVEL },
1724 { AV_PKT_DATA_A53_CC, AV_FRAME_DATA_A53_CC },
1725 { AV_PKT_DATA_ICC_PROFILE, AV_FRAME_DATA_ICC_PROFILE },
1726 { AV_PKT_DATA_S12M_TIMECODE, AV_FRAME_DATA_S12M_TIMECODE },
1730 avpriv_packet_list_get(&avctx->internal->pkt_props,
1731 &avctx->internal->pkt_props_tail,
1735 frame->pts = pkt->pts;
1737 FF_DISABLE_DEPRECATION_WARNINGS
1738 frame->pkt_pts = pkt->pts;
1739 FF_ENABLE_DEPRECATION_WARNINGS
1741 frame->pkt_pos = pkt->pos;
1742 frame->pkt_duration = pkt->duration;
1743 frame->pkt_size = pkt->size;
1745 for (i = 0; i < FF_ARRAY_ELEMS(sd); i++) {
1747 uint8_t *packet_sd = av_packet_get_side_data(pkt, sd[i].packet, &size);
1749 AVFrameSideData *frame_sd = av_frame_new_side_data(frame,
1753 return AVERROR(ENOMEM);
1755 memcpy(frame_sd->data, packet_sd, size);
1758 add_metadata_from_side_data(pkt, frame);
1760 if (pkt->flags & AV_PKT_FLAG_DISCARD) {
1761 frame->flags |= AV_FRAME_FLAG_DISCARD;
1763 frame->flags = (frame->flags & ~AV_FRAME_FLAG_DISCARD);
1766 frame->reordered_opaque = avctx->reordered_opaque;
1768 if (frame->color_primaries == AVCOL_PRI_UNSPECIFIED)
1769 frame->color_primaries = avctx->color_primaries;
1770 if (frame->color_trc == AVCOL_TRC_UNSPECIFIED)
1771 frame->color_trc = avctx->color_trc;
1772 if (frame->colorspace == AVCOL_SPC_UNSPECIFIED)
1773 frame->colorspace = avctx->colorspace;
1774 if (frame->color_range == AVCOL_RANGE_UNSPECIFIED)
1775 frame->color_range = avctx->color_range;
1776 if (frame->chroma_location == AVCHROMA_LOC_UNSPECIFIED)
1777 frame->chroma_location = avctx->chroma_sample_location;
1779 switch (avctx->codec->type) {
1780 case AVMEDIA_TYPE_VIDEO:
1781 frame->format = avctx->pix_fmt;
1782 if (!frame->sample_aspect_ratio.num)
1783 frame->sample_aspect_ratio = avctx->sample_aspect_ratio;
1785 if (frame->width && frame->height &&
1786 av_image_check_sar(frame->width, frame->height,
1787 frame->sample_aspect_ratio) < 0) {
1788 av_log(avctx, AV_LOG_WARNING, "ignoring invalid SAR: %u/%u\n",
1789 frame->sample_aspect_ratio.num,
1790 frame->sample_aspect_ratio.den);
1791 frame->sample_aspect_ratio = (AVRational){ 0, 1 };
1795 case AVMEDIA_TYPE_AUDIO:
1796 if (!frame->sample_rate)
1797 frame->sample_rate = avctx->sample_rate;
1798 if (frame->format < 0)
1799 frame->format = avctx->sample_fmt;
1800 if (!frame->channel_layout) {
1801 if (avctx->channel_layout) {
1802 if (av_get_channel_layout_nb_channels(avctx->channel_layout) !=
1804 av_log(avctx, AV_LOG_ERROR, "Inconsistent channel "
1805 "configuration.\n");
1806 return AVERROR(EINVAL);
1809 frame->channel_layout = avctx->channel_layout;
1811 if (avctx->channels > FF_SANE_NB_CHANNELS) {
1812 av_log(avctx, AV_LOG_ERROR, "Too many channels: %d.\n",
1814 return AVERROR(ENOSYS);
1818 frame->channels = avctx->channels;
1824 static void validate_avframe_allocation(AVCodecContext *avctx, AVFrame *frame)
1826 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO) {
1828 int num_planes = av_pix_fmt_count_planes(frame->format);
1829 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
1830 int flags = desc ? desc->flags : 0;
1831 if (num_planes == 1 && (flags & AV_PIX_FMT_FLAG_PAL))
1833 if ((flags & FF_PSEUDOPAL) && frame->data[1])
1835 for (i = 0; i < num_planes; i++) {
1836 av_assert0(frame->data[i]);
1838 // For formats without data like hwaccel allow unused pointers to be non-NULL.
1839 for (i = num_planes; num_planes > 0 && i < FF_ARRAY_ELEMS(frame->data); i++) {
1841 av_log(avctx, AV_LOG_ERROR, "Buffer returned by get_buffer2() did not zero unused plane pointers\n");
1842 frame->data[i] = NULL;
1847 static void decode_data_free(void *opaque, uint8_t *data)
1849 FrameDecodeData *fdd = (FrameDecodeData*)data;
1851 if (fdd->post_process_opaque_free)
1852 fdd->post_process_opaque_free(fdd->post_process_opaque);
1854 if (fdd->hwaccel_priv_free)
1855 fdd->hwaccel_priv_free(fdd->hwaccel_priv);
1860 int ff_attach_decode_data(AVFrame *frame)
1862 AVBufferRef *fdd_buf;
1863 FrameDecodeData *fdd;
1865 av_assert1(!frame->private_ref);
1866 av_buffer_unref(&frame->private_ref);
1868 fdd = av_mallocz(sizeof(*fdd));
1870 return AVERROR(ENOMEM);
1872 fdd_buf = av_buffer_create((uint8_t*)fdd, sizeof(*fdd), decode_data_free,
1873 NULL, AV_BUFFER_FLAG_READONLY);
1876 return AVERROR(ENOMEM);
1879 frame->private_ref = fdd_buf;
1884 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
1886 const AVHWAccel *hwaccel = avctx->hwaccel;
1887 int override_dimensions = 1;
1890 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO) {
1891 if ((unsigned)avctx->width > INT_MAX - STRIDE_ALIGN ||
1892 (ret = av_image_check_size2(FFALIGN(avctx->width, STRIDE_ALIGN), avctx->height, avctx->max_pixels, AV_PIX_FMT_NONE, 0, avctx)) < 0 || avctx->pix_fmt<0) {
1893 av_log(avctx, AV_LOG_ERROR, "video_get_buffer: image parameters invalid\n");
1894 ret = AVERROR(EINVAL);
1898 if (frame->width <= 0 || frame->height <= 0) {
1899 frame->width = FFMAX(avctx->width, AV_CEIL_RSHIFT(avctx->coded_width, avctx->lowres));
1900 frame->height = FFMAX(avctx->height, AV_CEIL_RSHIFT(avctx->coded_height, avctx->lowres));
1901 override_dimensions = 0;
1904 if (frame->data[0] || frame->data[1] || frame->data[2] || frame->data[3]) {
1905 av_log(avctx, AV_LOG_ERROR, "pic->data[*]!=NULL in get_buffer_internal\n");
1906 ret = AVERROR(EINVAL);
1909 } else if (avctx->codec_type == AVMEDIA_TYPE_AUDIO) {
1910 if (frame->nb_samples * (int64_t)avctx->channels > avctx->max_samples) {
1911 av_log(avctx, AV_LOG_ERROR, "samples per frame %d, exceeds max_samples %"PRId64"\n", frame->nb_samples, avctx->max_samples);
1912 ret = AVERROR(EINVAL);
1916 ret = ff_decode_frame_props(avctx, frame);
1921 if (hwaccel->alloc_frame) {
1922 ret = hwaccel->alloc_frame(avctx, frame);
1926 avctx->sw_pix_fmt = avctx->pix_fmt;
1928 ret = avctx->get_buffer2(avctx, frame, flags);
1932 validate_avframe_allocation(avctx, frame);
1934 ret = ff_attach_decode_data(frame);
1939 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO && !override_dimensions &&
1940 !(avctx->codec->caps_internal & FF_CODEC_CAP_EXPORTS_CROPPING)) {
1941 frame->width = avctx->width;
1942 frame->height = avctx->height;
1947 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1948 av_frame_unref(frame);
1954 static int reget_buffer_internal(AVCodecContext *avctx, AVFrame *frame, int flags)
1959 av_assert0(avctx->codec_type == AVMEDIA_TYPE_VIDEO);
1961 if (frame->data[0] && (frame->width != avctx->width || frame->height != avctx->height || frame->format != avctx->pix_fmt)) {
1962 av_log(avctx, AV_LOG_WARNING, "Picture changed from size:%dx%d fmt:%s to size:%dx%d fmt:%s in reget buffer()\n",
1963 frame->width, frame->height, av_get_pix_fmt_name(frame->format), avctx->width, avctx->height, av_get_pix_fmt_name(avctx->pix_fmt));
1964 av_frame_unref(frame);
1967 if (!frame->data[0])
1968 return ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF);
1970 if ((flags & FF_REGET_BUFFER_FLAG_READONLY) || av_frame_is_writable(frame))
1971 return ff_decode_frame_props(avctx, frame);
1973 tmp = av_frame_alloc();
1975 return AVERROR(ENOMEM);
1977 av_frame_move_ref(tmp, frame);
1979 ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF);
1981 av_frame_free(&tmp);
1985 av_frame_copy(frame, tmp);
1986 av_frame_free(&tmp);
1991 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
1993 int ret = reget_buffer_internal(avctx, frame, flags);
1995 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");