2 * generic encoding-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
21 #include "libavutil/attributes.h"
22 #include "libavutil/avassert.h"
23 #include "libavutil/frame.h"
24 #include "libavutil/imgutils.h"
25 #include "libavutil/internal.h"
26 #include "libavutil/samplefmt.h"
30 #include "frame_thread_encoder.h"
33 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
35 if (size < 0 || size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE) {
36 av_log(avctx, AV_LOG_ERROR, "Invalid minimum required packet size %"PRId64" (max allowed is %d)\n",
37 size, INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE);
38 return AVERROR(EINVAL);
41 av_assert0(!avpkt->data);
43 if (avctx && 2*min_size < size) { // FIXME The factor needs to be finetuned
44 av_fast_padded_malloc(&avctx->internal->byte_buffer, &avctx->internal->byte_buffer_size, size);
45 avpkt->data = avctx->internal->byte_buffer;
50 int ret = av_new_packet(avpkt, size);
52 av_log(avctx, AV_LOG_ERROR, "Failed to allocate packet of size %"PRId64"\n", size);
60 * Pad last frame with silence.
62 static int pad_last_frame(AVCodecContext *s, AVFrame *frame, const AVFrame *src)
66 frame->format = src->format;
67 frame->channel_layout = src->channel_layout;
68 frame->channels = src->channels;
69 frame->nb_samples = s->frame_size;
70 ret = av_frame_get_buffer(frame, 0);
74 ret = av_frame_copy_props(frame, src);
78 if ((ret = av_samples_copy(frame->extended_data, src->extended_data, 0, 0,
79 src->nb_samples, s->channels, s->sample_fmt)) < 0)
81 if ((ret = av_samples_set_silence(frame->extended_data, src->nb_samples,
82 frame->nb_samples - src->nb_samples,
83 s->channels, s->sample_fmt)) < 0)
89 av_frame_unref(frame);
93 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
94 const AVSubtitle *sub)
97 if (sub->start_display_time) {
98 av_log(avctx, AV_LOG_ERROR, "start_display_time must be 0.\n");
102 ret = avctx->codec->encode_sub(avctx, buf, buf_size, sub);
103 avctx->frame_number++;
107 int ff_encode_get_frame(AVCodecContext *avctx, AVFrame *frame)
109 AVCodecInternal *avci = avctx->internal;
114 if (!avci->buffer_frame->buf[0])
115 return AVERROR(EAGAIN);
117 av_frame_move_ref(frame, avci->buffer_frame);
122 static int encode_simple_internal(AVCodecContext *avctx, AVPacket *avpkt)
124 AVCodecInternal *avci = avctx->internal;
125 EncodeSimpleContext *es = &avci->es;
126 AVFrame *frame = es->in_frame;
130 if (avci->draining_done)
133 if (!frame->buf[0] && !avci->draining) {
134 av_frame_unref(frame);
135 ret = ff_encode_get_frame(avctx, frame);
136 if (ret < 0 && ret != AVERROR_EOF)
140 if (!frame->buf[0]) {
141 if (!(avctx->codec->capabilities & AV_CODEC_CAP_DELAY ||
142 (avci->frame_thread_encoder && avctx->active_thread_type & FF_THREAD_FRAME)))
145 // Flushing is signaled with a NULL frame
151 av_assert0(avctx->codec->encode2);
153 if (CONFIG_FRAME_THREAD_ENCODER &&
154 avci->frame_thread_encoder && (avctx->active_thread_type & FF_THREAD_FRAME))
155 ret = ff_thread_video_encode_frame(avctx, avpkt, frame, &got_packet);
157 ret = avctx->codec->encode2(avctx, avpkt, frame, &got_packet);
158 if (avctx->codec->type == AVMEDIA_TYPE_VIDEO && !ret && got_packet &&
159 !(avctx->codec->capabilities & AV_CODEC_CAP_DELAY))
160 avpkt->pts = avpkt->dts = frame->pts;
163 av_assert0(ret <= 0);
167 if (!ret && got_packet) {
169 ret = av_packet_make_refcounted(avpkt);
174 if (frame && !(avctx->codec->capabilities & AV_CODEC_CAP_DELAY)) {
175 if (avctx->codec->type == AVMEDIA_TYPE_AUDIO) {
176 if (avpkt->pts == AV_NOPTS_VALUE)
177 avpkt->pts = frame->pts;
178 if (!avpkt->duration)
179 avpkt->duration = ff_samples_to_time_base(avctx,
183 if (avctx->codec->type == AVMEDIA_TYPE_AUDIO) {
184 /* NOTE: if we add any audio encoders which output non-keyframe packets,
185 * this needs to be moved to the encoders, but for now we can do it
186 * here to simplify things */
187 avpkt->flags |= AV_PKT_FLAG_KEY;
188 avpkt->dts = avpkt->pts;
192 if (avci->draining && !got_packet)
193 avci->draining_done = 1;
196 if (ret < 0 || !got_packet)
197 av_packet_unref(avpkt);
201 avctx->frame_number++;
202 av_frame_unref(frame);
206 // Encoders must always return ref-counted buffers.
207 // Side-data only packets have no data and can be not ref-counted.
208 av_assert0(!avpkt->data || avpkt->buf);
213 static int encode_simple_receive_packet(AVCodecContext *avctx, AVPacket *avpkt)
217 while (!avpkt->data && !avpkt->side_data) {
218 ret = encode_simple_internal(avctx, avpkt);
226 static int encode_receive_packet_internal(AVCodecContext *avctx, AVPacket *avpkt)
228 AVCodecInternal *avci = avctx->internal;
231 if (avci->draining_done)
234 av_assert0(!avpkt->data && !avpkt->side_data);
236 if (avctx->codec->type == AVMEDIA_TYPE_VIDEO) {
237 if ((avctx->flags & AV_CODEC_FLAG_PASS1) && avctx->stats_out)
238 avctx->stats_out[0] = '\0';
239 if (av_image_check_size2(avctx->width, avctx->height, avctx->max_pixels, AV_PIX_FMT_NONE, 0, avctx))
240 return AVERROR(EINVAL);
243 if (avctx->codec->receive_packet) {
244 ret = avctx->codec->receive_packet(avctx, avpkt);
246 // Encoders must always return ref-counted buffers.
247 // Side-data only packets have no data and can be not ref-counted.
248 av_assert0(!avpkt->data || avpkt->buf);
250 ret = encode_simple_receive_packet(avctx, avpkt);
252 if (ret == AVERROR_EOF)
253 avci->draining_done = 1;
258 static int encode_send_frame_internal(AVCodecContext *avctx, const AVFrame *src)
260 AVCodecInternal *avci = avctx->internal;
261 AVFrame *dst = avci->buffer_frame;
264 if (avctx->codec->type == AVMEDIA_TYPE_AUDIO) {
265 /* extract audio service type metadata */
266 AVFrameSideData *sd = av_frame_get_side_data(src, AV_FRAME_DATA_AUDIO_SERVICE_TYPE);
267 if (sd && sd->size >= sizeof(enum AVAudioServiceType))
268 avctx->audio_service_type = *(enum AVAudioServiceType*)sd->data;
270 /* check for valid frame size */
271 if (avctx->codec->capabilities & AV_CODEC_CAP_SMALL_LAST_FRAME) {
272 if (src->nb_samples > avctx->frame_size) {
273 av_log(avctx, AV_LOG_ERROR, "more samples than frame size\n");
274 return AVERROR(EINVAL);
276 } else if (!(avctx->codec->capabilities & AV_CODEC_CAP_VARIABLE_FRAME_SIZE)) {
277 /* if we already got an undersized frame, that must have been the last */
278 if (avctx->internal->last_audio_frame) {
279 av_log(avctx, AV_LOG_ERROR, "frame_size (%d) was not respected for a non-last frame\n", avctx->frame_size);
280 return AVERROR(EINVAL);
283 if (src->nb_samples < avctx->frame_size) {
284 ret = pad_last_frame(avctx, dst, src);
288 avctx->internal->last_audio_frame = 1;
289 } else if (src->nb_samples > avctx->frame_size) {
290 av_log(avctx, AV_LOG_ERROR, "nb_samples (%d) != frame_size (%d)\n", src->nb_samples, avctx->frame_size);
291 return AVERROR(EINVAL);
297 ret = av_frame_ref(dst, src);
305 int attribute_align_arg avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame)
307 AVCodecInternal *avci = avctx->internal;
310 if (!avcodec_is_open(avctx) || !av_codec_is_encoder(avctx->codec))
311 return AVERROR(EINVAL);
316 if (avci->buffer_frame->data[0])
317 return AVERROR(EAGAIN);
322 ret = encode_send_frame_internal(avctx, frame);
327 if (!avci->buffer_pkt->data && !avci->buffer_pkt->side_data) {
328 ret = encode_receive_packet_internal(avctx, avci->buffer_pkt);
329 if (ret < 0 && ret != AVERROR(EAGAIN) && ret != AVERROR_EOF)
336 int attribute_align_arg avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt)
338 AVCodecInternal *avci = avctx->internal;
341 av_packet_unref(avpkt);
343 if (!avcodec_is_open(avctx) || !av_codec_is_encoder(avctx->codec))
344 return AVERROR(EINVAL);
346 if (avci->buffer_pkt->data || avci->buffer_pkt->side_data) {
347 av_packet_move_ref(avpkt, avci->buffer_pkt);
349 ret = encode_receive_packet_internal(avctx, avpkt);
357 static int compat_encode(AVCodecContext *avctx, AVPacket *avpkt,
358 int *got_packet, const AVFrame *frame)
360 AVCodecInternal *avci = avctx->internal;
366 if (frame && avctx->codec->type == AVMEDIA_TYPE_VIDEO) {
367 if (frame->format == AV_PIX_FMT_NONE)
368 av_log(avctx, AV_LOG_WARNING, "AVFrame.format is not set\n");
369 if (frame->width == 0 || frame->height == 0)
370 av_log(avctx, AV_LOG_WARNING, "AVFrame.width or height is not set\n");
373 ret = avcodec_send_frame(avctx, frame);
374 if (ret == AVERROR_EOF)
376 else if (ret == AVERROR(EAGAIN)) {
377 /* we fully drain all the output in each encode call, so this should not
383 av_packet_move_ref(&user_pkt, avpkt);
385 ret = avcodec_receive_packet(avctx, avpkt);
387 if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF)
392 if (avpkt != avci->compat_encode_packet) {
393 if (avpkt->data && user_pkt.data) {
394 if (user_pkt.size >= avpkt->size) {
395 memcpy(user_pkt.data, avpkt->data, avpkt->size);
396 av_buffer_unref(&avpkt->buf);
397 avpkt->buf = user_pkt.buf;
398 avpkt->data = user_pkt.data;
399 av_init_packet(&user_pkt);
401 av_log(avctx, AV_LOG_ERROR, "Provided packet is too small, needs to be %d\n", avpkt->size);
402 av_packet_unref(avpkt);
403 ret = AVERROR(EINVAL);
409 avpkt = avci->compat_encode_packet;
411 if (!avci->compat_decode_warned) {
412 av_log(avctx, AV_LOG_WARNING, "The deprecated avcodec_encode_* "
413 "API cannot return all the packets for this encoder. "
414 "Some packets will be dropped. Update your code to the "
415 "new encoding API to fix this.\n");
416 avci->compat_decode_warned = 1;
417 av_packet_unref(avpkt);
427 av_packet_unref(&user_pkt);
432 int attribute_align_arg avcodec_encode_audio2(AVCodecContext *avctx,
434 const AVFrame *frame,
437 int ret = compat_encode(avctx, avpkt, got_packet_ptr, frame);
440 av_packet_unref(avpkt);
445 int attribute_align_arg avcodec_encode_video2(AVCodecContext *avctx,
447 const AVFrame *frame,
450 int ret = compat_encode(avctx, avpkt, got_packet_ptr, frame);
453 av_packet_unref(avpkt);