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"
48 typedef struct FramePool {
50 * Pools for each data plane. For audio all the planes have the same size,
51 * so only pools[0] is used.
53 AVBufferPool *pools[4];
60 int stride_align[AV_NUM_DATA_POINTERS];
67 static int apply_param_change(AVCodecContext *avctx, const AVPacket *avpkt)
74 data = av_packet_get_side_data(avpkt, AV_PKT_DATA_PARAM_CHANGE, &size);
78 if (!(avctx->codec->capabilities & AV_CODEC_CAP_PARAM_CHANGE)) {
79 av_log(avctx, AV_LOG_ERROR, "This decoder does not support parameter "
80 "changes, but PARAM_CHANGE side data was sent to it.\n");
81 ret = AVERROR(EINVAL);
88 flags = bytestream_get_le32(&data);
91 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) {
94 val = bytestream_get_le32(&data);
95 if (val <= 0 || val > INT_MAX) {
96 av_log(avctx, AV_LOG_ERROR, "Invalid channel count");
97 ret = AVERROR_INVALIDDATA;
100 avctx->channels = val;
103 if (flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) {
106 avctx->channel_layout = bytestream_get_le64(&data);
109 if (flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) {
112 val = bytestream_get_le32(&data);
113 if (val <= 0 || val > INT_MAX) {
114 av_log(avctx, AV_LOG_ERROR, "Invalid sample rate");
115 ret = AVERROR_INVALIDDATA;
118 avctx->sample_rate = val;
121 if (flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) {
124 avctx->width = bytestream_get_le32(&data);
125 avctx->height = bytestream_get_le32(&data);
127 ret = ff_set_dimensions(avctx, avctx->width, avctx->height);
134 av_log(avctx, AV_LOG_ERROR, "PARAM_CHANGE side data too small.\n");
135 ret = AVERROR_INVALIDDATA;
138 av_log(avctx, AV_LOG_ERROR, "Error applying parameter changes.\n");
139 if (avctx->err_recognition & AV_EF_EXPLODE)
145 #define IS_EMPTY(pkt) (!(pkt)->data)
147 static int copy_packet_props(AVPacket *dst, const AVPacket *src)
149 int ret = av_packet_copy_props(dst, src);
153 dst->size = src->size; // HACK: Needed for ff_decode_frame_props().
154 dst->data = (void*)1; // HACK: Needed for IS_EMPTY().
159 static int extract_packet_props(AVCodecInternal *avci, const AVPacket *pkt)
161 AVPacket tmp = { 0 };
164 if (IS_EMPTY(avci->last_pkt_props)) {
165 if (av_fifo_size(avci->pkt_props) >= sizeof(*pkt)) {
166 av_fifo_generic_read(avci->pkt_props, avci->last_pkt_props,
167 sizeof(*avci->last_pkt_props), NULL);
169 return copy_packet_props(avci->last_pkt_props, pkt);
172 if (av_fifo_space(avci->pkt_props) < sizeof(*pkt)) {
173 ret = av_fifo_grow(avci->pkt_props, sizeof(*pkt));
178 ret = copy_packet_props(&tmp, pkt);
182 av_fifo_generic_write(avci->pkt_props, &tmp, sizeof(tmp), NULL);
187 int ff_decode_bsfs_init(AVCodecContext *avctx)
189 AVCodecInternal *avci = avctx->internal;
195 ret = av_bsf_list_parse_str(avctx->codec->bsfs, &avci->bsf);
197 av_log(avctx, AV_LOG_ERROR, "Error parsing decoder bitstream filters '%s': %s\n", avctx->codec->bsfs, av_err2str(ret));
198 if (ret != AVERROR(ENOMEM))
203 /* We do not currently have an API for passing the input timebase into decoders,
204 * but no filters used here should actually need it.
205 * So we make up some plausible-looking number (the MPEG 90kHz timebase) */
206 avci->bsf->time_base_in = (AVRational){ 1, 90000 };
207 ret = avcodec_parameters_from_context(avci->bsf->par_in, avctx);
211 ret = av_bsf_init(avci->bsf);
217 av_bsf_free(&avci->bsf);
221 int ff_decode_get_packet(AVCodecContext *avctx, AVPacket *pkt)
223 AVCodecInternal *avci = avctx->internal;
229 ret = av_bsf_receive_packet(avci->bsf, pkt);
230 if (ret == AVERROR_EOF)
235 ret = extract_packet_props(avctx->internal, pkt);
239 ret = apply_param_change(avctx, pkt);
243 #if FF_API_OLD_ENCDEC
244 if (avctx->codec->receive_frame)
245 avci->compat_decode_consumed += pkt->size;
250 av_packet_unref(pkt);
255 * Attempt to guess proper monotonic timestamps for decoded video frames
256 * which might have incorrect times. Input timestamps may wrap around, in
257 * which case the output will as well.
259 * @param pts the pts field of the decoded AVPacket, as passed through
261 * @param dts the dts field of the decoded AVPacket
262 * @return one of the input values, may be AV_NOPTS_VALUE
264 static int64_t guess_correct_pts(AVCodecContext *ctx,
265 int64_t reordered_pts, int64_t dts)
267 int64_t pts = AV_NOPTS_VALUE;
269 if (dts != AV_NOPTS_VALUE) {
270 ctx->pts_correction_num_faulty_dts += dts <= ctx->pts_correction_last_dts;
271 ctx->pts_correction_last_dts = dts;
272 } else if (reordered_pts != AV_NOPTS_VALUE)
273 ctx->pts_correction_last_dts = reordered_pts;
275 if (reordered_pts != AV_NOPTS_VALUE) {
276 ctx->pts_correction_num_faulty_pts += reordered_pts <= ctx->pts_correction_last_pts;
277 ctx->pts_correction_last_pts = reordered_pts;
278 } else if(dts != AV_NOPTS_VALUE)
279 ctx->pts_correction_last_pts = dts;
281 if ((ctx->pts_correction_num_faulty_pts<=ctx->pts_correction_num_faulty_dts || dts == AV_NOPTS_VALUE)
282 && reordered_pts != AV_NOPTS_VALUE)
291 * The core of the receive_frame_wrapper for the decoders implementing
292 * the simple API. Certain decoders might consume partial packets without
293 * returning any output, so this function needs to be called in a loop until it
296 static inline int decode_simple_internal(AVCodecContext *avctx, AVFrame *frame, int64_t *discarded_samples)
298 AVCodecInternal *avci = avctx->internal;
299 DecodeSimpleContext *ds = &avci->ds;
300 AVPacket *pkt = ds->in_pkt;
301 // copy to ensure we do not change pkt
302 int got_frame, actual_got_frame;
305 if (!pkt->data && !avci->draining) {
306 av_packet_unref(pkt);
307 ret = ff_decode_get_packet(avctx, pkt);
308 if (ret < 0 && ret != AVERROR_EOF)
312 // Some codecs (at least wma lossless) will crash when feeding drain packets
313 // after EOF was signaled.
314 if (avci->draining_done)
318 !(avctx->codec->capabilities & AV_CODEC_CAP_DELAY ||
319 avctx->active_thread_type & FF_THREAD_FRAME))
324 if (HAVE_THREADS && avctx->active_thread_type & FF_THREAD_FRAME) {
325 ret = ff_thread_decode_frame(avctx, frame, &got_frame, pkt);
327 ret = avctx->codec->decode(avctx, frame, &got_frame, pkt);
329 if (!(avctx->codec->caps_internal & FF_CODEC_CAP_SETS_PKT_DTS))
330 frame->pkt_dts = pkt->dts;
331 if (avctx->codec->type == AVMEDIA_TYPE_VIDEO) {
332 if(!avctx->has_b_frames)
333 frame->pkt_pos = pkt->pos;
334 //FIXME these should be under if(!avctx->has_b_frames)
335 /* get_buffer is supposed to set frame parameters */
336 if (!(avctx->codec->capabilities & AV_CODEC_CAP_DR1)) {
337 if (!frame->sample_aspect_ratio.num) frame->sample_aspect_ratio = avctx->sample_aspect_ratio;
338 if (!frame->width) frame->width = avctx->width;
339 if (!frame->height) frame->height = avctx->height;
340 if (frame->format == AV_PIX_FMT_NONE) frame->format = avctx->pix_fmt;
345 actual_got_frame = got_frame;
347 if (avctx->codec->type == AVMEDIA_TYPE_VIDEO) {
348 if (frame->flags & AV_FRAME_FLAG_DISCARD)
350 } else if (avctx->codec->type == AVMEDIA_TYPE_AUDIO) {
353 uint32_t discard_padding = 0;
354 uint8_t skip_reason = 0;
355 uint8_t discard_reason = 0;
357 if (ret >= 0 && got_frame) {
358 if (frame->format == AV_SAMPLE_FMT_NONE)
359 frame->format = avctx->sample_fmt;
360 if (!frame->channel_layout)
361 frame->channel_layout = avctx->channel_layout;
362 if (!frame->channels)
363 frame->channels = avctx->channels;
364 if (!frame->sample_rate)
365 frame->sample_rate = avctx->sample_rate;
368 side= av_packet_get_side_data(avci->last_pkt_props, AV_PKT_DATA_SKIP_SAMPLES, &side_size);
369 if(side && side_size>=10) {
370 avci->skip_samples = AV_RL32(side) * avci->skip_samples_multiplier;
371 discard_padding = AV_RL32(side + 4);
372 av_log(avctx, AV_LOG_DEBUG, "skip %d / discard %d samples due to side data\n",
373 avci->skip_samples, (int)discard_padding);
374 skip_reason = AV_RL8(side + 8);
375 discard_reason = AV_RL8(side + 9);
378 if ((frame->flags & AV_FRAME_FLAG_DISCARD) && got_frame &&
379 !(avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL)) {
380 avci->skip_samples = FFMAX(0, avci->skip_samples - frame->nb_samples);
382 *discarded_samples += frame->nb_samples;
385 if (avci->skip_samples > 0 && got_frame &&
386 !(avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL)) {
387 if(frame->nb_samples <= avci->skip_samples){
389 *discarded_samples += frame->nb_samples;
390 avci->skip_samples -= frame->nb_samples;
391 av_log(avctx, AV_LOG_DEBUG, "skip whole frame, skip left: %d\n",
394 av_samples_copy(frame->extended_data, frame->extended_data, 0, avci->skip_samples,
395 frame->nb_samples - avci->skip_samples, avctx->channels, frame->format);
396 if(avctx->pkt_timebase.num && avctx->sample_rate) {
397 int64_t diff_ts = av_rescale_q(avci->skip_samples,
398 (AVRational){1, avctx->sample_rate},
399 avctx->pkt_timebase);
400 if(frame->pts!=AV_NOPTS_VALUE)
401 frame->pts += diff_ts;
403 FF_DISABLE_DEPRECATION_WARNINGS
404 if(frame->pkt_pts!=AV_NOPTS_VALUE)
405 frame->pkt_pts += diff_ts;
406 FF_ENABLE_DEPRECATION_WARNINGS
408 if(frame->pkt_dts!=AV_NOPTS_VALUE)
409 frame->pkt_dts += diff_ts;
410 if (frame->pkt_duration >= diff_ts)
411 frame->pkt_duration -= diff_ts;
413 av_log(avctx, AV_LOG_WARNING, "Could not update timestamps for skipped samples.\n");
415 av_log(avctx, AV_LOG_DEBUG, "skip %d/%d samples\n",
416 avci->skip_samples, frame->nb_samples);
417 *discarded_samples += avci->skip_samples;
418 frame->nb_samples -= avci->skip_samples;
419 avci->skip_samples = 0;
423 if (discard_padding > 0 && discard_padding <= frame->nb_samples && got_frame &&
424 !(avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL)) {
425 if (discard_padding == frame->nb_samples) {
426 *discarded_samples += frame->nb_samples;
429 if(avctx->pkt_timebase.num && avctx->sample_rate) {
430 int64_t diff_ts = av_rescale_q(frame->nb_samples - discard_padding,
431 (AVRational){1, avctx->sample_rate},
432 avctx->pkt_timebase);
433 frame->pkt_duration = diff_ts;
435 av_log(avctx, AV_LOG_WARNING, "Could not update timestamps for discarded samples.\n");
437 av_log(avctx, AV_LOG_DEBUG, "discard %d/%d samples\n",
438 (int)discard_padding, frame->nb_samples);
439 frame->nb_samples -= discard_padding;
443 if ((avctx->flags2 & AV_CODEC_FLAG2_SKIP_MANUAL) && got_frame) {
444 AVFrameSideData *fside = av_frame_new_side_data(frame, AV_FRAME_DATA_SKIP_SAMPLES, 10);
446 AV_WL32(fside->data, avci->skip_samples);
447 AV_WL32(fside->data + 4, discard_padding);
448 AV_WL8(fside->data + 8, skip_reason);
449 AV_WL8(fside->data + 9, discard_reason);
450 avci->skip_samples = 0;
455 if (avctx->codec->type == AVMEDIA_TYPE_AUDIO &&
456 !avci->showed_multi_packet_warning &&
457 ret >= 0 && ret != pkt->size && !(avctx->codec->capabilities & AV_CODEC_CAP_SUBFRAMES)) {
458 av_log(avctx, AV_LOG_WARNING, "Multiple frames in a packet.\n");
459 avci->showed_multi_packet_warning = 1;
463 av_frame_unref(frame);
465 if (ret >= 0 && avctx->codec->type == AVMEDIA_TYPE_VIDEO && !(avctx->flags & AV_CODEC_FLAG_TRUNCATED))
468 #if FF_API_AVCTX_TIMEBASE
469 if (avctx->framerate.num > 0 && avctx->framerate.den > 0)
470 avctx->time_base = av_inv_q(av_mul_q(avctx->framerate, (AVRational){avctx->ticks_per_frame, 1}));
473 /* do not stop draining when actual_got_frame != 0 or ret < 0 */
474 /* got_frame == 0 but actual_got_frame != 0 when frame is discarded */
475 if (avci->draining && !actual_got_frame) {
477 /* prevent infinite loop if a decoder wrongly always return error on draining */
478 /* reasonable nb_errors_max = maximum b frames + thread count */
479 int nb_errors_max = 20 + (HAVE_THREADS && avctx->active_thread_type & FF_THREAD_FRAME ?
480 avctx->thread_count : 1);
482 if (avci->nb_draining_errors++ >= nb_errors_max) {
483 av_log(avctx, AV_LOG_ERROR, "Too many errors when draining, this is a bug. "
484 "Stop draining and force EOF.\n");
485 avci->draining_done = 1;
489 avci->draining_done = 1;
493 #if FF_API_OLD_ENCDEC
494 avci->compat_decode_consumed += ret;
497 if (ret >= pkt->size || ret < 0) {
498 av_packet_unref(pkt);
499 av_packet_unref(avci->last_pkt_props);
503 pkt->data += consumed;
504 pkt->size -= consumed;
505 avci->last_pkt_props->size -= consumed; // See extract_packet_props() comment.
506 pkt->pts = AV_NOPTS_VALUE;
507 pkt->dts = AV_NOPTS_VALUE;
508 avci->last_pkt_props->pts = AV_NOPTS_VALUE;
509 avci->last_pkt_props->dts = AV_NOPTS_VALUE;
513 av_assert0(frame->buf[0]);
515 return ret < 0 ? ret : 0;
518 static int decode_simple_receive_frame(AVCodecContext *avctx, AVFrame *frame)
521 int64_t discarded_samples = 0;
523 while (!frame->buf[0]) {
524 if (discarded_samples > avctx->max_samples)
525 return AVERROR(EAGAIN);
526 ret = decode_simple_internal(avctx, frame, &discarded_samples);
534 static int decode_receive_frame_internal(AVCodecContext *avctx, AVFrame *frame)
536 AVCodecInternal *avci = avctx->internal;
539 av_assert0(!frame->buf[0]);
541 if (avctx->codec->receive_frame) {
542 ret = avctx->codec->receive_frame(avctx, frame);
543 if (ret != AVERROR(EAGAIN))
544 av_packet_unref(avci->last_pkt_props);
546 ret = decode_simple_receive_frame(avctx, frame);
548 if (ret == AVERROR_EOF)
549 avci->draining_done = 1;
552 frame->best_effort_timestamp = guess_correct_pts(avctx,
556 /* the only case where decode data is not set should be decoders
557 * that do not call ff_get_buffer() */
558 av_assert0((frame->private_ref && frame->private_ref->size == sizeof(FrameDecodeData)) ||
559 !(avctx->codec->capabilities & AV_CODEC_CAP_DR1));
561 if (frame->private_ref) {
562 FrameDecodeData *fdd = (FrameDecodeData*)frame->private_ref->data;
564 if (fdd->post_process) {
565 ret = fdd->post_process(avctx, frame);
567 av_frame_unref(frame);
574 /* free the per-frame decode data */
575 av_buffer_unref(&frame->private_ref);
580 int attribute_align_arg avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
582 AVCodecInternal *avci = avctx->internal;
585 if (!avcodec_is_open(avctx) || !av_codec_is_decoder(avctx->codec))
586 return AVERROR(EINVAL);
588 if (avctx->internal->draining)
591 if (avpkt && !avpkt->size && avpkt->data)
592 return AVERROR(EINVAL);
594 av_packet_unref(avci->buffer_pkt);
595 if (avpkt && (avpkt->data || avpkt->side_data_elems)) {
596 ret = av_packet_ref(avci->buffer_pkt, avpkt);
601 ret = av_bsf_send_packet(avci->bsf, avci->buffer_pkt);
603 av_packet_unref(avci->buffer_pkt);
607 if (!avci->buffer_frame->buf[0]) {
608 ret = decode_receive_frame_internal(avctx, avci->buffer_frame);
609 if (ret < 0 && ret != AVERROR(EAGAIN) && ret != AVERROR_EOF)
616 static int apply_cropping(AVCodecContext *avctx, AVFrame *frame)
618 /* make sure we are noisy about decoders returning invalid cropping data */
619 if (frame->crop_left >= INT_MAX - frame->crop_right ||
620 frame->crop_top >= INT_MAX - frame->crop_bottom ||
621 (frame->crop_left + frame->crop_right) >= frame->width ||
622 (frame->crop_top + frame->crop_bottom) >= frame->height) {
623 av_log(avctx, AV_LOG_WARNING,
624 "Invalid cropping information set by a decoder: "
625 "%"SIZE_SPECIFIER"/%"SIZE_SPECIFIER"/%"SIZE_SPECIFIER"/%"SIZE_SPECIFIER" "
626 "(frame size %dx%d). This is a bug, please report it\n",
627 frame->crop_left, frame->crop_right, frame->crop_top, frame->crop_bottom,
628 frame->width, frame->height);
629 frame->crop_left = 0;
630 frame->crop_right = 0;
632 frame->crop_bottom = 0;
636 if (!avctx->apply_cropping)
639 return av_frame_apply_cropping(frame, avctx->flags & AV_CODEC_FLAG_UNALIGNED ?
640 AV_FRAME_CROP_UNALIGNED : 0);
643 int attribute_align_arg avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
645 AVCodecInternal *avci = avctx->internal;
648 av_frame_unref(frame);
650 if (!avcodec_is_open(avctx) || !av_codec_is_decoder(avctx->codec))
651 return AVERROR(EINVAL);
653 if (avci->buffer_frame->buf[0]) {
654 av_frame_move_ref(frame, avci->buffer_frame);
656 ret = decode_receive_frame_internal(avctx, frame);
661 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO) {
662 ret = apply_cropping(avctx, frame);
664 av_frame_unref(frame);
669 avctx->frame_number++;
671 if (avctx->flags & AV_CODEC_FLAG_DROPCHANGED) {
673 if (avctx->frame_number == 1) {
674 avci->initial_format = frame->format;
675 switch(avctx->codec_type) {
676 case AVMEDIA_TYPE_VIDEO:
677 avci->initial_width = frame->width;
678 avci->initial_height = frame->height;
680 case AVMEDIA_TYPE_AUDIO:
681 avci->initial_sample_rate = frame->sample_rate ? frame->sample_rate :
683 avci->initial_channels = frame->channels;
684 avci->initial_channel_layout = frame->channel_layout;
689 if (avctx->frame_number > 1) {
690 changed = avci->initial_format != frame->format;
692 switch(avctx->codec_type) {
693 case AVMEDIA_TYPE_VIDEO:
694 changed |= avci->initial_width != frame->width ||
695 avci->initial_height != frame->height;
697 case AVMEDIA_TYPE_AUDIO:
698 changed |= avci->initial_sample_rate != frame->sample_rate ||
699 avci->initial_sample_rate != avctx->sample_rate ||
700 avci->initial_channels != frame->channels ||
701 avci->initial_channel_layout != frame->channel_layout;
706 avci->changed_frames_dropped++;
707 av_log(avctx, AV_LOG_INFO, "dropped changed frame #%d pts %"PRId64
708 " drop count: %d \n",
709 avctx->frame_number, frame->pts,
710 avci->changed_frames_dropped);
711 av_frame_unref(frame);
712 return AVERROR_INPUT_CHANGED;
719 #if FF_API_OLD_ENCDEC
720 FF_DISABLE_DEPRECATION_WARNINGS
721 static int unrefcount_frame(AVCodecInternal *avci, AVFrame *frame)
725 /* move the original frame to our backup */
726 av_frame_unref(avci->to_free);
727 av_frame_move_ref(avci->to_free, frame);
729 /* now copy everything except the AVBufferRefs back
730 * note that we make a COPY of the side data, so calling av_frame_free() on
731 * the caller's frame will work properly */
732 ret = av_frame_copy_props(frame, avci->to_free);
736 memcpy(frame->data, avci->to_free->data, sizeof(frame->data));
737 memcpy(frame->linesize, avci->to_free->linesize, sizeof(frame->linesize));
738 if (avci->to_free->extended_data != avci->to_free->data) {
739 int planes = avci->to_free->channels;
740 int size = planes * sizeof(*frame->extended_data);
743 av_frame_unref(frame);
747 frame->extended_data = av_malloc(size);
748 if (!frame->extended_data) {
749 av_frame_unref(frame);
750 return AVERROR(ENOMEM);
752 memcpy(frame->extended_data, avci->to_free->extended_data,
755 frame->extended_data = frame->data;
757 frame->format = avci->to_free->format;
758 frame->width = avci->to_free->width;
759 frame->height = avci->to_free->height;
760 frame->channel_layout = avci->to_free->channel_layout;
761 frame->nb_samples = avci->to_free->nb_samples;
762 frame->channels = avci->to_free->channels;
767 static int compat_decode(AVCodecContext *avctx, AVFrame *frame,
768 int *got_frame, const AVPacket *pkt)
770 AVCodecInternal *avci = avctx->internal;
773 av_assert0(avci->compat_decode_consumed == 0);
775 if (avci->draining_done && pkt && pkt->size != 0) {
776 av_log(avctx, AV_LOG_WARNING, "Got unexpected packet after EOF\n");
777 avcodec_flush_buffers(avctx);
782 if (avci->compat_decode_partial_size > 0 &&
783 avci->compat_decode_partial_size != pkt->size) {
784 av_log(avctx, AV_LOG_ERROR,
785 "Got unexpected packet size after a partial decode\n");
786 ret = AVERROR(EINVAL);
790 if (!avci->compat_decode_partial_size) {
791 ret = avcodec_send_packet(avctx, pkt);
792 if (ret == AVERROR_EOF)
794 else if (ret == AVERROR(EAGAIN)) {
795 /* we fully drain all the output in each decode call, so this should not
804 ret = avcodec_receive_frame(avctx, frame);
806 if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
811 if (frame != avci->compat_decode_frame) {
812 if (!avctx->refcounted_frames) {
813 ret = unrefcount_frame(avci, frame);
819 frame = avci->compat_decode_frame;
821 if (!avci->compat_decode_warned) {
822 av_log(avctx, AV_LOG_WARNING, "The deprecated avcodec_decode_* "
823 "API cannot return all the frames for this decoder. "
824 "Some frames will be dropped. Update your code to the "
825 "new decoding API to fix this.\n");
826 avci->compat_decode_warned = 1;
830 if (avci->draining || (!avctx->codec->bsfs && avci->compat_decode_consumed < pkt->size))
836 /* if there are any bsfs then assume full packet is always consumed */
837 if (avctx->codec->bsfs)
840 ret = FFMIN(avci->compat_decode_consumed, pkt->size);
842 avci->compat_decode_consumed = 0;
843 avci->compat_decode_partial_size = (ret >= 0) ? pkt->size - ret : 0;
848 int attribute_align_arg avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
849 int *got_picture_ptr,
850 const AVPacket *avpkt)
852 return compat_decode(avctx, picture, got_picture_ptr, avpkt);
855 int attribute_align_arg avcodec_decode_audio4(AVCodecContext *avctx,
858 const AVPacket *avpkt)
860 return compat_decode(avctx, frame, got_frame_ptr, avpkt);
862 FF_ENABLE_DEPRECATION_WARNINGS
865 static void get_subtitle_defaults(AVSubtitle *sub)
867 memset(sub, 0, sizeof(*sub));
868 sub->pts = AV_NOPTS_VALUE;
871 #define UTF8_MAX_BYTES 4 /* 5 and 6 bytes sequences should not be used */
872 static int recode_subtitle(AVCodecContext *avctx,
873 AVPacket *outpkt, const AVPacket *inpkt)
876 iconv_t cd = (iconv_t)-1;
883 if (avctx->sub_charenc_mode != FF_SUB_CHARENC_MODE_PRE_DECODER || inpkt->size == 0)
890 if (inl >= INT_MAX / UTF8_MAX_BYTES - AV_INPUT_BUFFER_PADDING_SIZE) {
891 av_log(avctx, AV_LOG_ERROR, "Subtitles packet is too big for recoding\n");
892 return AVERROR(ERANGE);
895 cd = iconv_open("UTF-8", avctx->sub_charenc);
896 av_assert0(cd != (iconv_t)-1);
898 ret = av_new_packet(&tmp, inl * UTF8_MAX_BYTES);
901 outpkt->buf = tmp.buf;
902 outpkt->data = tmp.data;
903 outpkt->size = tmp.size;
907 if (iconv(cd, &inb, &inl, &outb, &outl) == (size_t)-1 ||
908 iconv(cd, NULL, NULL, &outb, &outl) == (size_t)-1 ||
909 outl >= outpkt->size || inl != 0) {
910 ret = FFMIN(AVERROR(errno), -1);
911 av_log(avctx, AV_LOG_ERROR, "Unable to recode subtitle event \"%s\" "
912 "from %s to UTF-8\n", inpkt->data, avctx->sub_charenc);
913 av_packet_unref(&tmp);
916 outpkt->size -= outl;
917 memset(outpkt->data + outpkt->size, 0, outl);
920 if (cd != (iconv_t)-1)
924 av_log(avctx, AV_LOG_ERROR, "requesting subtitles recoding without iconv");
925 return AVERROR(EINVAL);
929 static int utf8_check(const uint8_t *str)
932 uint32_t codepoint, min;
936 GET_UTF8(codepoint, *(byte++), return 0;);
937 min = byte - str == 1 ? 0 : byte - str == 2 ? 0x80 :
938 1 << (5 * (byte - str) - 4);
939 if (codepoint < min || codepoint >= 0x110000 ||
940 codepoint == 0xFFFE /* BOM */ ||
941 codepoint >= 0xD800 && codepoint <= 0xDFFF /* surrogates */)
948 #if FF_API_ASS_TIMING
949 static void insert_ts(AVBPrint *buf, int ts)
952 av_bprintf(buf, "9:59:59.99,");
956 h = ts/360000; ts -= 360000*h;
957 m = ts/ 6000; ts -= 6000*m;
958 s = ts/ 100; ts -= 100*s;
959 av_bprintf(buf, "%d:%02d:%02d.%02d,", h, m, s, ts);
963 static int convert_sub_to_old_ass_form(AVSubtitle *sub, const AVPacket *pkt, AVRational tb)
968 av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
970 for (i = 0; i < sub->num_rects; i++) {
973 AVSubtitleRect *rect = sub->rects[i];
974 int ts_start, ts_duration = -1;
977 if (rect->type != SUBTITLE_ASS || !strncmp(rect->ass, "Dialogue: ", 10))
980 av_bprint_clear(&buf);
983 dialog = strchr(rect->ass, ',');
988 /* extract Layer or Marked */
989 layer = strtol(dialog, (char**)&dialog, 10);
994 /* rescale timing to ASS time base (ms) */
995 ts_start = av_rescale_q(pkt->pts, tb, av_make_q(1, 100));
996 if (pkt->duration != -1)
997 ts_duration = av_rescale_q(pkt->duration, tb, av_make_q(1, 100));
998 sub->end_display_time = FFMAX(sub->end_display_time, 10 * ts_duration);
1000 /* construct ASS (standalone file form with timestamps) string */
1001 av_bprintf(&buf, "Dialogue: %ld,", layer);
1002 insert_ts(&buf, ts_start);
1003 insert_ts(&buf, ts_duration == -1 ? -1 : ts_start + ts_duration);
1004 av_bprintf(&buf, "%s\r\n", dialog);
1006 final_dialog = av_strdup(buf.str);
1007 if (!av_bprint_is_complete(&buf) || !final_dialog) {
1008 av_freep(&final_dialog);
1009 av_bprint_finalize(&buf, NULL);
1010 return AVERROR(ENOMEM);
1012 av_freep(&rect->ass);
1013 rect->ass = final_dialog;
1016 av_bprint_finalize(&buf, NULL);
1021 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
1027 if (!avpkt->data && avpkt->size) {
1028 av_log(avctx, AV_LOG_ERROR, "invalid packet: NULL data, size != 0\n");
1029 return AVERROR(EINVAL);
1032 return AVERROR(EINVAL);
1033 if (avctx->codec->type != AVMEDIA_TYPE_SUBTITLE) {
1034 av_log(avctx, AV_LOG_ERROR, "Invalid media type for subtitles\n");
1035 return AVERROR(EINVAL);
1039 get_subtitle_defaults(sub);
1041 if ((avctx->codec->capabilities & AV_CODEC_CAP_DELAY) || avpkt->size) {
1042 AVPacket pkt_recoded = *avpkt;
1044 ret = recode_subtitle(avctx, &pkt_recoded, avpkt);
1048 ret = extract_packet_props(avctx->internal, &pkt_recoded);
1052 if (avctx->pkt_timebase.num && avpkt->pts != AV_NOPTS_VALUE)
1053 sub->pts = av_rescale_q(avpkt->pts,
1054 avctx->pkt_timebase, AV_TIME_BASE_Q);
1055 ret = avctx->codec->decode(avctx, sub, got_sub_ptr, &pkt_recoded);
1056 av_assert1((ret >= 0) >= !!*got_sub_ptr &&
1057 !!*got_sub_ptr >= !!sub->num_rects);
1059 #if FF_API_ASS_TIMING
1060 if (avctx->sub_text_format == FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS
1061 && *got_sub_ptr && sub->num_rects) {
1062 const AVRational tb = avctx->pkt_timebase.num ? avctx->pkt_timebase
1064 int err = convert_sub_to_old_ass_form(sub, avpkt, tb);
1070 if (sub->num_rects && !sub->end_display_time && avpkt->duration &&
1071 avctx->pkt_timebase.num) {
1072 AVRational ms = { 1, 1000 };
1073 sub->end_display_time = av_rescale_q(avpkt->duration,
1074 avctx->pkt_timebase, ms);
1077 if (avctx->codec_descriptor->props & AV_CODEC_PROP_BITMAP_SUB)
1079 else if (avctx->codec_descriptor->props & AV_CODEC_PROP_TEXT_SUB)
1082 for (i = 0; i < sub->num_rects; i++) {
1083 if (avctx->sub_charenc_mode != FF_SUB_CHARENC_MODE_IGNORE &&
1084 sub->rects[i]->ass && !utf8_check(sub->rects[i]->ass)) {
1085 av_log(avctx, AV_LOG_ERROR,
1086 "Invalid UTF-8 in decoded subtitles text; "
1087 "maybe missing -sub_charenc option\n");
1088 avsubtitle_free(sub);
1089 ret = AVERROR_INVALIDDATA;
1094 if (avpkt->data != pkt_recoded.data) { // did we recode?
1095 /* prevent from destroying side data from original packet */
1096 pkt_recoded.side_data = NULL;
1097 pkt_recoded.side_data_elems = 0;
1099 av_packet_unref(&pkt_recoded);
1103 avctx->frame_number++;
1109 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *avctx,
1110 const enum AVPixelFormat *fmt)
1112 const AVPixFmtDescriptor *desc;
1113 const AVCodecHWConfig *config;
1116 // If a device was supplied when the codec was opened, assume that the
1117 // user wants to use it.
1118 if (avctx->hw_device_ctx && avctx->codec->hw_configs) {
1119 AVHWDeviceContext *device_ctx =
1120 (AVHWDeviceContext*)avctx->hw_device_ctx->data;
1122 config = &avctx->codec->hw_configs[i]->public;
1125 if (!(config->methods &
1126 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX))
1128 if (device_ctx->type != config->device_type)
1130 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++) {
1131 if (config->pix_fmt == fmt[n])
1136 // No device or other setup, so we have to choose from things which
1137 // don't any other external information.
1139 // If the last element of the list is a software format, choose it
1140 // (this should be best software format if any exist).
1141 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++);
1142 desc = av_pix_fmt_desc_get(fmt[n - 1]);
1143 if (!(desc->flags & AV_PIX_FMT_FLAG_HWACCEL))
1146 // Finally, traverse the list in order and choose the first entry
1147 // with no external dependencies (if there is no hardware configuration
1148 // information available then this just picks the first entry).
1149 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++) {
1151 config = avcodec_get_hw_config(avctx->codec, i);
1154 if (config->pix_fmt == fmt[n])
1158 // No specific config available, so the decoder must be able
1159 // to handle this format without any additional setup.
1162 if (config->methods & AV_CODEC_HW_CONFIG_METHOD_INTERNAL) {
1163 // Usable with only internal setup.
1168 // Nothing is usable, give up.
1169 return AV_PIX_FMT_NONE;
1172 int ff_decode_get_hw_frames_ctx(AVCodecContext *avctx,
1173 enum AVHWDeviceType dev_type)
1175 AVHWDeviceContext *device_ctx;
1176 AVHWFramesContext *frames_ctx;
1179 if (!avctx->hwaccel)
1180 return AVERROR(ENOSYS);
1182 if (avctx->hw_frames_ctx)
1184 if (!avctx->hw_device_ctx) {
1185 av_log(avctx, AV_LOG_ERROR, "A hardware frames or device context is "
1186 "required for hardware accelerated decoding.\n");
1187 return AVERROR(EINVAL);
1190 device_ctx = (AVHWDeviceContext *)avctx->hw_device_ctx->data;
1191 if (device_ctx->type != dev_type) {
1192 av_log(avctx, AV_LOG_ERROR, "Device type %s expected for hardware "
1193 "decoding, but got %s.\n", av_hwdevice_get_type_name(dev_type),
1194 av_hwdevice_get_type_name(device_ctx->type));
1195 return AVERROR(EINVAL);
1198 ret = avcodec_get_hw_frames_parameters(avctx,
1199 avctx->hw_device_ctx,
1200 avctx->hwaccel->pix_fmt,
1201 &avctx->hw_frames_ctx);
1205 frames_ctx = (AVHWFramesContext*)avctx->hw_frames_ctx->data;
1208 if (frames_ctx->initial_pool_size) {
1209 // We guarantee 4 base work surfaces. The function above guarantees 1
1210 // (the absolute minimum), so add the missing count.
1211 frames_ctx->initial_pool_size += 3;
1214 ret = av_hwframe_ctx_init(avctx->hw_frames_ctx);
1216 av_buffer_unref(&avctx->hw_frames_ctx);
1223 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
1224 AVBufferRef *device_ref,
1225 enum AVPixelFormat hw_pix_fmt,
1226 AVBufferRef **out_frames_ref)
1228 AVBufferRef *frames_ref = NULL;
1229 const AVCodecHWConfigInternal *hw_config;
1230 const AVHWAccel *hwa;
1234 hw_config = avctx->codec->hw_configs[i];
1236 return AVERROR(ENOENT);
1237 if (hw_config->public.pix_fmt == hw_pix_fmt)
1241 hwa = hw_config->hwaccel;
1242 if (!hwa || !hwa->frame_params)
1243 return AVERROR(ENOENT);
1245 frames_ref = av_hwframe_ctx_alloc(device_ref);
1247 return AVERROR(ENOMEM);
1249 ret = hwa->frame_params(avctx, frames_ref);
1251 AVHWFramesContext *frames_ctx = (AVHWFramesContext*)frames_ref->data;
1253 if (frames_ctx->initial_pool_size) {
1254 // If the user has requested that extra output surfaces be
1255 // available then add them here.
1256 if (avctx->extra_hw_frames > 0)
1257 frames_ctx->initial_pool_size += avctx->extra_hw_frames;
1259 // If frame threading is enabled then an extra surface per thread
1260 // is also required.
1261 if (avctx->active_thread_type & FF_THREAD_FRAME)
1262 frames_ctx->initial_pool_size += avctx->thread_count;
1265 *out_frames_ref = frames_ref;
1267 av_buffer_unref(&frames_ref);
1272 static int hwaccel_init(AVCodecContext *avctx,
1273 const AVCodecHWConfigInternal *hw_config)
1275 const AVHWAccel *hwaccel;
1278 hwaccel = hw_config->hwaccel;
1279 if (hwaccel->capabilities & AV_HWACCEL_CODEC_CAP_EXPERIMENTAL &&
1280 avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL) {
1281 av_log(avctx, AV_LOG_WARNING, "Ignoring experimental hwaccel: %s\n",
1283 return AVERROR_PATCHWELCOME;
1286 if (hwaccel->priv_data_size) {
1287 avctx->internal->hwaccel_priv_data =
1288 av_mallocz(hwaccel->priv_data_size);
1289 if (!avctx->internal->hwaccel_priv_data)
1290 return AVERROR(ENOMEM);
1293 avctx->hwaccel = hwaccel;
1294 if (hwaccel->init) {
1295 err = hwaccel->init(avctx);
1297 av_log(avctx, AV_LOG_ERROR, "Failed setup for format %s: "
1298 "hwaccel initialisation returned error.\n",
1299 av_get_pix_fmt_name(hw_config->public.pix_fmt));
1300 av_freep(&avctx->internal->hwaccel_priv_data);
1301 avctx->hwaccel = NULL;
1309 static void hwaccel_uninit(AVCodecContext *avctx)
1311 if (avctx->hwaccel && avctx->hwaccel->uninit)
1312 avctx->hwaccel->uninit(avctx);
1314 av_freep(&avctx->internal->hwaccel_priv_data);
1316 avctx->hwaccel = NULL;
1318 av_buffer_unref(&avctx->hw_frames_ctx);
1321 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
1323 const AVPixFmtDescriptor *desc;
1324 enum AVPixelFormat *choices;
1325 enum AVPixelFormat ret, user_choice;
1326 const AVCodecHWConfigInternal *hw_config;
1327 const AVCodecHWConfig *config;
1330 // Find end of list.
1331 for (n = 0; fmt[n] != AV_PIX_FMT_NONE; n++);
1332 // Must contain at least one entry.
1334 // If a software format is available, it must be the last entry.
1335 desc = av_pix_fmt_desc_get(fmt[n - 1]);
1336 if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL) {
1337 // No software format is available.
1339 avctx->sw_pix_fmt = fmt[n - 1];
1342 choices = av_malloc_array(n + 1, sizeof(*choices));
1344 return AV_PIX_FMT_NONE;
1346 memcpy(choices, fmt, (n + 1) * sizeof(*choices));
1349 // Remove the previous hwaccel, if there was one.
1350 hwaccel_uninit(avctx);
1352 user_choice = avctx->get_format(avctx, choices);
1353 if (user_choice == AV_PIX_FMT_NONE) {
1354 // Explicitly chose nothing, give up.
1355 ret = AV_PIX_FMT_NONE;
1359 desc = av_pix_fmt_desc_get(user_choice);
1361 av_log(avctx, AV_LOG_ERROR, "Invalid format returned by "
1362 "get_format() callback.\n");
1363 ret = AV_PIX_FMT_NONE;
1366 av_log(avctx, AV_LOG_DEBUG, "Format %s chosen by get_format().\n",
1369 for (i = 0; i < n; i++) {
1370 if (choices[i] == user_choice)
1374 av_log(avctx, AV_LOG_ERROR, "Invalid return from get_format(): "
1375 "%s not in possible list.\n", desc->name);
1376 ret = AV_PIX_FMT_NONE;
1380 if (avctx->codec->hw_configs) {
1382 hw_config = avctx->codec->hw_configs[i];
1385 if (hw_config->public.pix_fmt == user_choice)
1393 // No config available, so no extra setup required.
1397 config = &hw_config->public;
1399 if (config->methods &
1400 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX &&
1401 avctx->hw_frames_ctx) {
1402 const AVHWFramesContext *frames_ctx =
1403 (AVHWFramesContext*)avctx->hw_frames_ctx->data;
1404 if (frames_ctx->format != user_choice) {
1405 av_log(avctx, AV_LOG_ERROR, "Invalid setup for format %s: "
1406 "does not match the format of the provided frames "
1407 "context.\n", desc->name);
1410 } else if (config->methods &
1411 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX &&
1412 avctx->hw_device_ctx) {
1413 const AVHWDeviceContext *device_ctx =
1414 (AVHWDeviceContext*)avctx->hw_device_ctx->data;
1415 if (device_ctx->type != config->device_type) {
1416 av_log(avctx, AV_LOG_ERROR, "Invalid setup for format %s: "
1417 "does not match the type of the provided device "
1418 "context.\n", desc->name);
1421 } else if (config->methods &
1422 AV_CODEC_HW_CONFIG_METHOD_INTERNAL) {
1423 // Internal-only setup, no additional configuration.
1424 } else if (config->methods &
1425 AV_CODEC_HW_CONFIG_METHOD_AD_HOC) {
1426 // Some ad-hoc configuration we can't see and can't check.
1428 av_log(avctx, AV_LOG_ERROR, "Invalid setup for format %s: "
1429 "missing configuration.\n", desc->name);
1432 if (hw_config->hwaccel) {
1433 av_log(avctx, AV_LOG_DEBUG, "Format %s requires hwaccel "
1434 "initialisation.\n", desc->name);
1435 err = hwaccel_init(avctx, hw_config);
1443 av_log(avctx, AV_LOG_DEBUG, "Format %s not usable, retrying "
1444 "get_format() without it.\n", desc->name);
1445 for (i = 0; i < n; i++) {
1446 if (choices[i] == user_choice)
1449 for (; i + 1 < n; i++)
1450 choices[i] = choices[i + 1];
1458 static void frame_pool_free(void *opaque, uint8_t *data)
1460 FramePool *pool = (FramePool*)data;
1463 for (i = 0; i < FF_ARRAY_ELEMS(pool->pools); i++)
1464 av_buffer_pool_uninit(&pool->pools[i]);
1469 static AVBufferRef *frame_pool_alloc(void)
1471 FramePool *pool = av_mallocz(sizeof(*pool));
1477 buf = av_buffer_create((uint8_t*)pool, sizeof(*pool),
1478 frame_pool_free, NULL, 0);
1487 static int update_frame_pool(AVCodecContext *avctx, AVFrame *frame)
1489 FramePool *pool = avctx->internal->pool ?
1490 (FramePool*)avctx->internal->pool->data : NULL;
1491 AVBufferRef *pool_buf;
1492 int i, ret, ch, planes;
1494 if (avctx->codec_type == AVMEDIA_TYPE_AUDIO) {
1495 int planar = av_sample_fmt_is_planar(frame->format);
1496 ch = frame->channels;
1497 planes = planar ? ch : 1;
1500 if (pool && pool->format == frame->format) {
1501 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO &&
1502 pool->width == frame->width && pool->height == frame->height)
1504 if (avctx->codec_type == AVMEDIA_TYPE_AUDIO && pool->planes == planes &&
1505 pool->channels == ch && frame->nb_samples == pool->samples)
1509 pool_buf = frame_pool_alloc();
1511 return AVERROR(ENOMEM);
1512 pool = (FramePool*)pool_buf->data;
1514 switch (avctx->codec_type) {
1515 case AVMEDIA_TYPE_VIDEO: {
1517 int w = frame->width;
1518 int h = frame->height;
1520 ptrdiff_t linesize1[4];
1523 avcodec_align_dimensions2(avctx, &w, &h, pool->stride_align);
1526 // NOTE: do not align linesizes individually, this breaks e.g. assumptions
1527 // that linesize[0] == 2*linesize[1] in the MPEG-encoder for 4:2:2
1528 ret = av_image_fill_linesizes(linesize, avctx->pix_fmt, w);
1531 // increase alignment of w for next try (rhs gives the lowest bit set in w)
1535 for (i = 0; i < 4; i++)
1536 unaligned |= linesize[i] % pool->stride_align[i];
1537 } while (unaligned);
1539 for (i = 0; i < 4; i++)
1540 linesize1[i] = linesize[i];
1541 ret = av_image_fill_plane_sizes(size, avctx->pix_fmt, h, linesize1);
1545 for (i = 0; i < 4; i++) {
1546 pool->linesize[i] = linesize[i];
1548 if (size[i] > INT_MAX - (16 + STRIDE_ALIGN - 1)) {
1549 ret = AVERROR(EINVAL);
1552 pool->pools[i] = av_buffer_pool_init(size[i] + 16 + STRIDE_ALIGN - 1,
1553 CONFIG_MEMORY_POISONING ?
1556 if (!pool->pools[i]) {
1557 ret = AVERROR(ENOMEM);
1562 pool->format = frame->format;
1563 pool->width = frame->width;
1564 pool->height = frame->height;
1568 case AVMEDIA_TYPE_AUDIO: {
1569 ret = av_samples_get_buffer_size(&pool->linesize[0], ch,
1570 frame->nb_samples, frame->format, 0);
1574 pool->pools[0] = av_buffer_pool_init(pool->linesize[0], NULL);
1575 if (!pool->pools[0]) {
1576 ret = AVERROR(ENOMEM);
1580 pool->format = frame->format;
1581 pool->planes = planes;
1582 pool->channels = ch;
1583 pool->samples = frame->nb_samples;
1586 default: av_assert0(0);
1589 av_buffer_unref(&avctx->internal->pool);
1590 avctx->internal->pool = pool_buf;
1594 av_buffer_unref(&pool_buf);
1598 static int audio_get_buffer(AVCodecContext *avctx, AVFrame *frame)
1600 FramePool *pool = (FramePool*)avctx->internal->pool->data;
1601 int planes = pool->planes;
1604 frame->linesize[0] = pool->linesize[0];
1606 if (planes > AV_NUM_DATA_POINTERS) {
1607 frame->extended_data = av_mallocz_array(planes, sizeof(*frame->extended_data));
1608 frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
1609 frame->extended_buf = av_mallocz_array(frame->nb_extended_buf,
1610 sizeof(*frame->extended_buf));
1611 if (!frame->extended_data || !frame->extended_buf) {
1612 av_freep(&frame->extended_data);
1613 av_freep(&frame->extended_buf);
1614 return AVERROR(ENOMEM);
1617 frame->extended_data = frame->data;
1618 av_assert0(frame->nb_extended_buf == 0);
1621 for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
1622 frame->buf[i] = av_buffer_pool_get(pool->pools[0]);
1625 frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
1627 for (i = 0; i < frame->nb_extended_buf; i++) {
1628 frame->extended_buf[i] = av_buffer_pool_get(pool->pools[0]);
1629 if (!frame->extended_buf[i])
1631 frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
1634 if (avctx->debug & FF_DEBUG_BUFFERS)
1635 av_log(avctx, AV_LOG_DEBUG, "default_get_buffer called on frame %p", frame);
1639 av_frame_unref(frame);
1640 return AVERROR(ENOMEM);
1643 static int video_get_buffer(AVCodecContext *s, AVFrame *pic)
1645 FramePool *pool = (FramePool*)s->internal->pool->data;
1646 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pic->format);
1649 if (pic->data[0] || pic->data[1] || pic->data[2] || pic->data[3]) {
1650 av_log(s, AV_LOG_ERROR, "pic->data[*]!=NULL in avcodec_default_get_buffer\n");
1655 av_log(s, AV_LOG_ERROR,
1656 "Unable to get pixel format descriptor for format %s\n",
1657 av_get_pix_fmt_name(pic->format));
1658 return AVERROR(EINVAL);
1661 memset(pic->data, 0, sizeof(pic->data));
1662 pic->extended_data = pic->data;
1664 for (i = 0; i < 4 && pool->pools[i]; i++) {
1665 pic->linesize[i] = pool->linesize[i];
1667 pic->buf[i] = av_buffer_pool_get(pool->pools[i]);
1671 pic->data[i] = pic->buf[i]->data;
1673 for (; i < AV_NUM_DATA_POINTERS; i++) {
1674 pic->data[i] = NULL;
1675 pic->linesize[i] = 0;
1677 if (desc->flags & AV_PIX_FMT_FLAG_PAL ||
1678 ((desc->flags & FF_PSEUDOPAL) && pic->data[1]))
1679 avpriv_set_systematic_pal2((uint32_t *)pic->data[1], pic->format);
1681 if (s->debug & FF_DEBUG_BUFFERS)
1682 av_log(s, AV_LOG_DEBUG, "default_get_buffer called on pic %p\n", pic);
1686 av_frame_unref(pic);
1687 return AVERROR(ENOMEM);
1690 int avcodec_default_get_buffer2(AVCodecContext *avctx, AVFrame *frame, int flags)
1694 if (avctx->hw_frames_ctx) {
1695 ret = av_hwframe_get_buffer(avctx->hw_frames_ctx, frame, 0);
1696 frame->width = avctx->coded_width;
1697 frame->height = avctx->coded_height;
1701 if ((ret = update_frame_pool(avctx, frame)) < 0)
1704 switch (avctx->codec_type) {
1705 case AVMEDIA_TYPE_VIDEO:
1706 return video_get_buffer(avctx, frame);
1707 case AVMEDIA_TYPE_AUDIO:
1708 return audio_get_buffer(avctx, frame);
1714 static int add_metadata_from_side_data(const AVPacket *avpkt, AVFrame *frame)
1717 const uint8_t *side_metadata;
1719 AVDictionary **frame_md = &frame->metadata;
1721 side_metadata = av_packet_get_side_data(avpkt,
1722 AV_PKT_DATA_STRINGS_METADATA, &size);
1723 return av_packet_unpack_dictionary(side_metadata, size, frame_md);
1726 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame)
1728 AVPacket *pkt = avctx->internal->last_pkt_props;
1730 static const struct {
1731 enum AVPacketSideDataType packet;
1732 enum AVFrameSideDataType frame;
1734 { AV_PKT_DATA_REPLAYGAIN , AV_FRAME_DATA_REPLAYGAIN },
1735 { AV_PKT_DATA_DISPLAYMATRIX, AV_FRAME_DATA_DISPLAYMATRIX },
1736 { AV_PKT_DATA_SPHERICAL, AV_FRAME_DATA_SPHERICAL },
1737 { AV_PKT_DATA_STEREO3D, AV_FRAME_DATA_STEREO3D },
1738 { AV_PKT_DATA_AUDIO_SERVICE_TYPE, AV_FRAME_DATA_AUDIO_SERVICE_TYPE },
1739 { AV_PKT_DATA_MASTERING_DISPLAY_METADATA, AV_FRAME_DATA_MASTERING_DISPLAY_METADATA },
1740 { AV_PKT_DATA_CONTENT_LIGHT_LEVEL, AV_FRAME_DATA_CONTENT_LIGHT_LEVEL },
1741 { AV_PKT_DATA_A53_CC, AV_FRAME_DATA_A53_CC },
1742 { AV_PKT_DATA_ICC_PROFILE, AV_FRAME_DATA_ICC_PROFILE },
1743 { AV_PKT_DATA_S12M_TIMECODE, AV_FRAME_DATA_S12M_TIMECODE },
1746 if (IS_EMPTY(pkt) && av_fifo_size(avctx->internal->pkt_props) >= sizeof(*pkt))
1747 av_fifo_generic_read(avctx->internal->pkt_props,
1748 pkt, sizeof(*pkt), NULL);
1751 frame->pts = pkt->pts;
1753 FF_DISABLE_DEPRECATION_WARNINGS
1754 frame->pkt_pts = pkt->pts;
1755 FF_ENABLE_DEPRECATION_WARNINGS
1757 frame->pkt_pos = pkt->pos;
1758 frame->pkt_duration = pkt->duration;
1759 frame->pkt_size = pkt->size;
1761 for (i = 0; i < FF_ARRAY_ELEMS(sd); i++) {
1763 uint8_t *packet_sd = av_packet_get_side_data(pkt, sd[i].packet, &size);
1765 AVFrameSideData *frame_sd = av_frame_new_side_data(frame,
1769 return AVERROR(ENOMEM);
1771 memcpy(frame_sd->data, packet_sd, size);
1774 add_metadata_from_side_data(pkt, frame);
1776 if (pkt->flags & AV_PKT_FLAG_DISCARD) {
1777 frame->flags |= AV_FRAME_FLAG_DISCARD;
1779 frame->flags = (frame->flags & ~AV_FRAME_FLAG_DISCARD);
1782 frame->reordered_opaque = avctx->reordered_opaque;
1784 if (frame->color_primaries == AVCOL_PRI_UNSPECIFIED)
1785 frame->color_primaries = avctx->color_primaries;
1786 if (frame->color_trc == AVCOL_TRC_UNSPECIFIED)
1787 frame->color_trc = avctx->color_trc;
1788 if (frame->colorspace == AVCOL_SPC_UNSPECIFIED)
1789 frame->colorspace = avctx->colorspace;
1790 if (frame->color_range == AVCOL_RANGE_UNSPECIFIED)
1791 frame->color_range = avctx->color_range;
1792 if (frame->chroma_location == AVCHROMA_LOC_UNSPECIFIED)
1793 frame->chroma_location = avctx->chroma_sample_location;
1795 switch (avctx->codec->type) {
1796 case AVMEDIA_TYPE_VIDEO:
1797 frame->format = avctx->pix_fmt;
1798 if (!frame->sample_aspect_ratio.num)
1799 frame->sample_aspect_ratio = avctx->sample_aspect_ratio;
1801 if (frame->width && frame->height &&
1802 av_image_check_sar(frame->width, frame->height,
1803 frame->sample_aspect_ratio) < 0) {
1804 av_log(avctx, AV_LOG_WARNING, "ignoring invalid SAR: %u/%u\n",
1805 frame->sample_aspect_ratio.num,
1806 frame->sample_aspect_ratio.den);
1807 frame->sample_aspect_ratio = (AVRational){ 0, 1 };
1811 case AVMEDIA_TYPE_AUDIO:
1812 if (!frame->sample_rate)
1813 frame->sample_rate = avctx->sample_rate;
1814 if (frame->format < 0)
1815 frame->format = avctx->sample_fmt;
1816 if (!frame->channel_layout) {
1817 if (avctx->channel_layout) {
1818 if (av_get_channel_layout_nb_channels(avctx->channel_layout) !=
1820 av_log(avctx, AV_LOG_ERROR, "Inconsistent channel "
1821 "configuration.\n");
1822 return AVERROR(EINVAL);
1825 frame->channel_layout = avctx->channel_layout;
1827 if (avctx->channels > FF_SANE_NB_CHANNELS) {
1828 av_log(avctx, AV_LOG_ERROR, "Too many channels: %d.\n",
1830 return AVERROR(ENOSYS);
1834 frame->channels = avctx->channels;
1840 static void validate_avframe_allocation(AVCodecContext *avctx, AVFrame *frame)
1842 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO) {
1844 int num_planes = av_pix_fmt_count_planes(frame->format);
1845 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
1846 int flags = desc ? desc->flags : 0;
1847 if (num_planes == 1 && (flags & AV_PIX_FMT_FLAG_PAL))
1849 if ((flags & FF_PSEUDOPAL) && frame->data[1])
1851 for (i = 0; i < num_planes; i++) {
1852 av_assert0(frame->data[i]);
1854 // For formats without data like hwaccel allow unused pointers to be non-NULL.
1855 for (i = num_planes; num_planes > 0 && i < FF_ARRAY_ELEMS(frame->data); i++) {
1857 av_log(avctx, AV_LOG_ERROR, "Buffer returned by get_buffer2() did not zero unused plane pointers\n");
1858 frame->data[i] = NULL;
1863 static void decode_data_free(void *opaque, uint8_t *data)
1865 FrameDecodeData *fdd = (FrameDecodeData*)data;
1867 if (fdd->post_process_opaque_free)
1868 fdd->post_process_opaque_free(fdd->post_process_opaque);
1870 if (fdd->hwaccel_priv_free)
1871 fdd->hwaccel_priv_free(fdd->hwaccel_priv);
1876 int ff_attach_decode_data(AVFrame *frame)
1878 AVBufferRef *fdd_buf;
1879 FrameDecodeData *fdd;
1881 av_assert1(!frame->private_ref);
1882 av_buffer_unref(&frame->private_ref);
1884 fdd = av_mallocz(sizeof(*fdd));
1886 return AVERROR(ENOMEM);
1888 fdd_buf = av_buffer_create((uint8_t*)fdd, sizeof(*fdd), decode_data_free,
1889 NULL, AV_BUFFER_FLAG_READONLY);
1892 return AVERROR(ENOMEM);
1895 frame->private_ref = fdd_buf;
1900 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
1902 const AVHWAccel *hwaccel = avctx->hwaccel;
1903 int override_dimensions = 1;
1906 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO) {
1907 if ((unsigned)avctx->width > INT_MAX - STRIDE_ALIGN ||
1908 (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) {
1909 av_log(avctx, AV_LOG_ERROR, "video_get_buffer: image parameters invalid\n");
1910 ret = AVERROR(EINVAL);
1914 if (frame->width <= 0 || frame->height <= 0) {
1915 frame->width = FFMAX(avctx->width, AV_CEIL_RSHIFT(avctx->coded_width, avctx->lowres));
1916 frame->height = FFMAX(avctx->height, AV_CEIL_RSHIFT(avctx->coded_height, avctx->lowres));
1917 override_dimensions = 0;
1920 if (frame->data[0] || frame->data[1] || frame->data[2] || frame->data[3]) {
1921 av_log(avctx, AV_LOG_ERROR, "pic->data[*]!=NULL in get_buffer_internal\n");
1922 ret = AVERROR(EINVAL);
1925 } else if (avctx->codec_type == AVMEDIA_TYPE_AUDIO) {
1926 if (frame->nb_samples * (int64_t)avctx->channels > avctx->max_samples) {
1927 av_log(avctx, AV_LOG_ERROR, "samples per frame %d, exceeds max_samples %"PRId64"\n", frame->nb_samples, avctx->max_samples);
1928 ret = AVERROR(EINVAL);
1932 ret = ff_decode_frame_props(avctx, frame);
1937 if (hwaccel->alloc_frame) {
1938 ret = hwaccel->alloc_frame(avctx, frame);
1942 avctx->sw_pix_fmt = avctx->pix_fmt;
1944 ret = avctx->get_buffer2(avctx, frame, flags);
1948 validate_avframe_allocation(avctx, frame);
1950 ret = ff_attach_decode_data(frame);
1955 if (avctx->codec_type == AVMEDIA_TYPE_VIDEO && !override_dimensions &&
1956 !(avctx->codec->caps_internal & FF_CODEC_CAP_EXPORTS_CROPPING)) {
1957 frame->width = avctx->width;
1958 frame->height = avctx->height;
1963 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1964 av_frame_unref(frame);
1970 static int reget_buffer_internal(AVCodecContext *avctx, AVFrame *frame, int flags)
1975 av_assert0(avctx->codec_type == AVMEDIA_TYPE_VIDEO);
1977 if (frame->data[0] && (frame->width != avctx->width || frame->height != avctx->height || frame->format != avctx->pix_fmt)) {
1978 av_log(avctx, AV_LOG_WARNING, "Picture changed from size:%dx%d fmt:%s to size:%dx%d fmt:%s in reget buffer()\n",
1979 frame->width, frame->height, av_get_pix_fmt_name(frame->format), avctx->width, avctx->height, av_get_pix_fmt_name(avctx->pix_fmt));
1980 av_frame_unref(frame);
1983 if (!frame->data[0])
1984 return ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF);
1986 if ((flags & FF_REGET_BUFFER_FLAG_READONLY) || av_frame_is_writable(frame))
1987 return ff_decode_frame_props(avctx, frame);
1989 tmp = av_frame_alloc();
1991 return AVERROR(ENOMEM);
1993 av_frame_move_ref(tmp, frame);
1995 ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF);
1997 av_frame_free(&tmp);
2001 av_frame_copy(frame, tmp);
2002 av_frame_free(&tmp);
2007 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
2009 int ret = reget_buffer_internal(avctx, frame, flags);
2011 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");