2 * Android MediaCodec decoder
4 * Copyright (c) 2015-2016 Matthieu Bouron <matthieu.bouron stupeflix.com>
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <sys/types.h>
26 #include "libavutil/common.h"
27 #include "libavutil/mem.h"
28 #include "libavutil/log.h"
29 #include "libavutil/pixfmt.h"
30 #include "libavutil/time.h"
31 #include "libavutil/timestamp.h"
36 #include "mediacodec_sw_buffer.h"
37 #include "mediacodec_wrapper.h"
38 #include "mediacodecdec.h"
41 * OMX.k3.video.decoder.avc, OMX.NVIDIA.* OMX.SEC.avc.dec and OMX.google
42 * codec workarounds used in various place are taken from the Gstreamer
45 * Gstreamer references:
46 * https://cgit.freedesktop.org/gstreamer/gst-plugins-bad/tree/sys/androidmedia/
48 * Gstreamer copyright notice:
50 * Copyright (C) 2012, Collabora Ltd.
51 * Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
53 * Copyright (C) 2012, Rafaël Carré <funman@videolanorg>
55 * Copyright (C) 2015, Sebastian Dröge <sebastian@centricular.com>
57 * Copyright (C) 2014-2015, Collabora Ltd.
58 * Author: Matthieu Bouron <matthieu.bouron@gcollabora.com>
60 * Copyright (C) 2015, Edward Hervey
61 * Author: Edward Hervey <bilboed@gmail.com>
63 * Copyright (C) 2015, Matthew Waters <matthew@centricular.com>
65 * This library is free software; you can redistribute it and/or
66 * modify it under the terms of the GNU Lesser General Public
67 * License as published by the Free Software Foundation
68 * version 2.1 of the License.
70 * This library is distributed in the hope that it will be useful,
71 * but WITHOUT ANY WARRANTY; without even the implied warranty of
72 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
73 * Lesser General Public License for more details.
75 * You should have received a copy of the GNU Lesser General Public
76 * License along with this library; if not, write to the Free Software
77 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
81 #define INPUT_DEQUEUE_TIMEOUT_US 8000
82 #define OUTPUT_DEQUEUE_TIMEOUT_US 8000
83 #define OUTPUT_DEQUEUE_BLOCK_TIMEOUT_US 1000000
86 COLOR_FormatYUV420Planar = 0x13,
87 COLOR_FormatYUV420SemiPlanar = 0x15,
88 COLOR_FormatYCbYCr = 0x19,
89 COLOR_FormatAndroidOpaque = 0x7F000789,
90 COLOR_QCOM_FormatYUV420SemiPlanar = 0x7fa30c00,
91 COLOR_QCOM_FormatYUV420SemiPlanar32m = 0x7fa30c04,
92 COLOR_QCOM_FormatYUV420PackedSemiPlanar64x32Tile2m8ka = 0x7fa30c03,
93 COLOR_TI_FormatYUV420PackedSemiPlanar = 0x7f000100,
94 COLOR_TI_FormatYUV420PackedSemiPlanarInterlaced = 0x7f000001,
100 enum AVPixelFormat pix_fmt;
102 } color_formats[] = {
104 { COLOR_FormatYUV420Planar, AV_PIX_FMT_YUV420P },
105 { COLOR_FormatYUV420SemiPlanar, AV_PIX_FMT_NV12 },
106 { COLOR_QCOM_FormatYUV420SemiPlanar, AV_PIX_FMT_NV12 },
107 { COLOR_QCOM_FormatYUV420SemiPlanar32m, AV_PIX_FMT_NV12 },
108 { COLOR_QCOM_FormatYUV420PackedSemiPlanar64x32Tile2m8ka, AV_PIX_FMT_NV12 },
109 { COLOR_TI_FormatYUV420PackedSemiPlanar, AV_PIX_FMT_NV12 },
110 { COLOR_TI_FormatYUV420PackedSemiPlanarInterlaced, AV_PIX_FMT_NV12 },
114 static enum AVPixelFormat mcdec_map_color_format(AVCodecContext *avctx,
115 MediaCodecDecContext *s,
119 enum AVPixelFormat ret = AV_PIX_FMT_NONE;
121 if (!strcmp(s->codec_name, "OMX.k3.video.decoder.avc") && color_format == COLOR_FormatYCbYCr) {
122 s->color_format = color_format = COLOR_TI_FormatYUV420PackedSemiPlanar;
125 for (i = 0; i < FF_ARRAY_ELEMS(color_formats); i++) {
126 if (color_formats[i].color_format == color_format) {
127 return color_formats[i].pix_fmt;
131 av_log(avctx, AV_LOG_ERROR, "Output color format 0x%x (value=%d) is not supported\n",
132 color_format, color_format);
137 static int mediacodec_wrap_buffer(AVCodecContext *avctx,
138 MediaCodecDecContext *s,
142 FFAMediaCodecBufferInfo *info,
148 frame->width = avctx->width;
149 frame->height = avctx->height;
150 frame->format = avctx->pix_fmt;
152 /* MediaCodec buffers needs to be copied to our own refcounted buffers
153 * because the flush command invalidates all input and output buffers.
155 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
156 av_log(avctx, AV_LOG_ERROR, "Could not allocate buffer\n");
160 /* Override frame->pkt_pts as ff_get_buffer will override its value based
161 * on the last avpacket received which is not in sync with the frame:
162 * * N avpackets can be pushed before 1 frame is actually returned
163 * * 0-sized avpackets are pushed to flush remaining frames at EOS */
164 frame->pkt_pts = info->presentationTimeUs;
166 av_log(avctx, AV_LOG_DEBUG,
167 "Frame: width=%d stride=%d height=%d slice-height=%d "
168 "crop-top=%d crop-bottom=%d crop-left=%d crop-right=%d encoder=%s\n"
169 "destination linesizes=%d,%d,%d\n" ,
170 avctx->width, s->stride, avctx->height, s->slice_height,
171 s->crop_top, s->crop_bottom, s->crop_left, s->crop_right, s->codec_name,
172 frame->linesize[0], frame->linesize[1], frame->linesize[2]);
174 switch (s->color_format) {
175 case COLOR_FormatYUV420Planar:
176 ff_mediacodec_sw_buffer_copy_yuv420_planar(avctx, s, data, size, info, frame);
178 case COLOR_FormatYUV420SemiPlanar:
179 case COLOR_QCOM_FormatYUV420SemiPlanar:
180 case COLOR_QCOM_FormatYUV420SemiPlanar32m:
181 ff_mediacodec_sw_buffer_copy_yuv420_semi_planar(avctx, s, data, size, info, frame);
183 case COLOR_TI_FormatYUV420PackedSemiPlanar:
184 case COLOR_TI_FormatYUV420PackedSemiPlanarInterlaced:
185 ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar(avctx, s, data, size, info, frame);
187 case COLOR_QCOM_FormatYUV420PackedSemiPlanar64x32Tile2m8ka:
188 ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(avctx, s, data, size, info, frame);
191 av_log(avctx, AV_LOG_ERROR, "Unsupported color format 0x%x (value=%d)\n",
192 s->color_format, s->color_format);
193 ret = AVERROR(EINVAL);
199 status = ff_AMediaCodec_releaseOutputBuffer(s->codec, index, 0);
201 av_log(NULL, AV_LOG_ERROR, "Failed to release output buffer\n");
202 ret = AVERROR_EXTERNAL;
208 static int mediacodec_dec_parse_format(AVCodecContext *avctx, MediaCodecDecContext *s)
216 av_log(avctx, AV_LOG_ERROR, "Output MediaFormat is not set\n");
217 return AVERROR(EINVAL);
220 format = ff_AMediaFormat_toString(s->format);
222 return AVERROR_EXTERNAL;
224 av_log(avctx, AV_LOG_DEBUG, "Parsing MediaFormat %s\n", format);
227 /* Mandatory fields */
228 if (!ff_AMediaFormat_getInt32(s->format, "width", &value)) {
229 format = ff_AMediaFormat_toString(s->format);
230 av_log(avctx, AV_LOG_ERROR, "Could not get %s from format %s\n", "width", format);
232 return AVERROR_EXTERNAL;
236 if (!ff_AMediaFormat_getInt32(s->format, "height", &value)) {
237 format = ff_AMediaFormat_toString(s->format);
238 av_log(avctx, AV_LOG_ERROR, "Could not get %s from format %s\n", "height", format);
240 return AVERROR_EXTERNAL;
244 if (!ff_AMediaFormat_getInt32(s->format, "stride", &value)) {
245 format = ff_AMediaFormat_toString(s->format);
246 av_log(avctx, AV_LOG_ERROR, "Could not get %s from format %s\n", "stride", format);
248 return AVERROR_EXTERNAL;
250 s->stride = value > 0 ? value : s->width;
252 if (!ff_AMediaFormat_getInt32(s->format, "slice-height", &value)) {
253 format = ff_AMediaFormat_toString(s->format);
254 av_log(avctx, AV_LOG_ERROR, "Could not get %s from format %s\n", "slice-height", format);
256 return AVERROR_EXTERNAL;
258 s->slice_height = value > 0 ? value : s->height;
260 if (strstr(s->codec_name, "OMX.Nvidia.")) {
261 s->slice_height = FFALIGN(s->height, 16);
262 } else if (strstr(s->codec_name, "OMX.SEC.avc.dec")) {
263 s->slice_height = avctx->height;
264 s->stride = avctx->width;
267 if (!ff_AMediaFormat_getInt32(s->format, "color-format", &value)) {
268 format = ff_AMediaFormat_toString(s->format);
269 av_log(avctx, AV_LOG_ERROR, "Could not get %s from format %s\n", "color-format", format);
271 return AVERROR_EXTERNAL;
273 s->color_format = value;
275 s->pix_fmt = avctx->pix_fmt = mcdec_map_color_format(avctx, s, value);
276 if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
277 av_log(avctx, AV_LOG_ERROR, "Output color format is not supported\n");
278 return AVERROR(EINVAL);
281 /* Optional fields */
282 if (ff_AMediaFormat_getInt32(s->format, "crop-top", &value))
285 if (ff_AMediaFormat_getInt32(s->format, "crop-bottom", &value))
286 s->crop_bottom = value;
288 if (ff_AMediaFormat_getInt32(s->format, "crop-left", &value))
289 s->crop_left = value;
291 if (ff_AMediaFormat_getInt32(s->format, "crop-right", &value))
292 s->crop_right = value;
294 width = s->crop_right + 1 - s->crop_left;
295 height = s->crop_bottom + 1 - s->crop_top;
297 av_log(avctx, AV_LOG_INFO,
298 "Output crop parameters top=%d bottom=%d left=%d right=%d, "
299 "resulting dimensions width=%d height=%d\n",
300 s->crop_top, s->crop_bottom, s->crop_left, s->crop_right,
303 return ff_set_dimensions(avctx, width, height);
306 int ff_mediacodec_dec_init(AVCodecContext *avctx, MediaCodecDecContext *s,
307 const char *mime, FFAMediaFormat *format)
312 s->first_buffer_at = av_gettime();
314 s->codec_name = ff_AMediaCodecList_getCodecNameByType(mime, avctx->width, avctx->height, avctx);
315 if (!s->codec_name) {
316 ret = AVERROR_EXTERNAL;
320 av_log(avctx, AV_LOG_DEBUG, "Found decoder %s\n", s->codec_name);
321 s->codec = ff_AMediaCodec_createCodecByName(s->codec_name);
323 av_log(avctx, AV_LOG_ERROR, "Failed to create media decoder for type %s and name %s\n", mime, s->codec_name);
324 ret = AVERROR_EXTERNAL;
328 status = ff_AMediaCodec_configure(s->codec, format, NULL, NULL, 0);
330 char *desc = ff_AMediaFormat_toString(format);
331 av_log(avctx, AV_LOG_ERROR,
332 "Failed to configure codec (status = %d) with format %s\n",
336 ret = AVERROR_EXTERNAL;
340 status = ff_AMediaCodec_start(s->codec);
342 char *desc = ff_AMediaFormat_toString(format);
343 av_log(avctx, AV_LOG_ERROR,
344 "Failed to start codec (status = %d) with format %s\n",
347 ret = AVERROR_EXTERNAL;
351 s->format = ff_AMediaCodec_getOutputFormat(s->codec);
353 if ((ret = mediacodec_dec_parse_format(avctx, s)) < 0) {
354 av_log(avctx, AV_LOG_ERROR,
355 "Failed to configure context\n");
360 av_log(avctx, AV_LOG_DEBUG, "MediaCodec %p started successfully\n", s->codec);
365 av_log(avctx, AV_LOG_ERROR, "MediaCodec %p failed to start\n", s->codec);
366 ff_mediacodec_dec_close(avctx, s);
370 int ff_mediacodec_dec_decode(AVCodecContext *avctx, MediaCodecDecContext *s,
371 AVFrame *frame, int *got_frame,
376 int need_flushing = 0;
380 FFAMediaCodec *codec = s->codec;
381 FFAMediaCodecBufferInfo info = { 0 };
385 int64_t input_dequeue_timeout_us = INPUT_DEQUEUE_TIMEOUT_US;
386 int64_t output_dequeue_timeout_us = OUTPUT_DEQUEUE_TIMEOUT_US;
388 if (pkt->size == 0) {
392 if (s->flushing && need_flushing && s->queued_buffer_nb <= 0) {
396 while (offset < pkt->size || (need_flushing && !s->flushing)) {
399 index = ff_AMediaCodec_dequeueInputBuffer(codec, input_dequeue_timeout_us);
400 if (ff_AMediaCodec_infoTryAgainLater(codec, index)) {
405 av_log(avctx, AV_LOG_ERROR, "Failed to dequeue input buffer (status=%zd)\n", index);
406 return AVERROR_EXTERNAL;
409 data = ff_AMediaCodec_getInputBuffer(codec, index, &size);
411 av_log(avctx, AV_LOG_ERROR, "Failed to get input buffer\n");
412 return AVERROR_EXTERNAL;
416 uint32_t flags = ff_AMediaCodec_getBufferFlagEndOfStream(codec);
418 av_log(avctx, AV_LOG_DEBUG, "Sending End Of Stream signal\n");
420 status = ff_AMediaCodec_queueInputBuffer(codec, index, 0, 0, pkt->pts, flags);
422 av_log(avctx, AV_LOG_ERROR, "Failed to queue input empty buffer (status = %d)\n", status);
423 return AVERROR_EXTERNAL;
429 size = FFMIN(pkt->size - offset, size);
431 memcpy(data, pkt->data + offset, size);
434 status = ff_AMediaCodec_queueInputBuffer(codec, index, 0, size, pkt->pts, 0);
436 av_log(avctx, AV_LOG_ERROR, "Failed to queue input buffer (status = %d)\n", status);
437 return AVERROR_EXTERNAL;
440 s->queued_buffer_nb++;
441 if (s->queued_buffer_nb > s->queued_buffer_max)
442 s->queued_buffer_max = s->queued_buffer_nb;
447 /* If the codec is flushing, block for a fair amount of time to
448 * ensure we got a frame */
449 output_dequeue_timeout_us = OUTPUT_DEQUEUE_BLOCK_TIMEOUT_US;
450 } else if (s->dequeued_buffer_nb == 0) {
451 /* If the codec hasn't produced any frames, do not block so we
452 * can push data to it as fast as possible, and get the first
454 output_dequeue_timeout_us = 0;
457 index = ff_AMediaCodec_dequeueOutputBuffer(codec, &info, output_dequeue_timeout_us);
461 if (!s->first_buffer++) {
462 av_log(avctx, AV_LOG_DEBUG, "Got first buffer after %fms\n", (av_gettime() - s->first_buffer_at) / 1000);
465 av_log(avctx, AV_LOG_DEBUG, "Got output buffer %zd"
466 " offset=%" PRIi32 " size=%" PRIi32 " ts=%" PRIi64
467 " flags=%" PRIu32 "\n", index, info.offset, info.size,
468 info.presentationTimeUs, info.flags);
470 data = ff_AMediaCodec_getOutputBuffer(codec, index, &size);
472 av_log(avctx, AV_LOG_ERROR, "Failed to get output buffer\n");
473 return AVERROR_EXTERNAL;
476 if ((ret = mediacodec_wrap_buffer(avctx, s, data, size, index, &info, frame)) < 0) {
477 av_log(avctx, AV_LOG_ERROR, "Failed to wrap MediaCodec buffer\n");
482 s->queued_buffer_nb--;
483 s->dequeued_buffer_nb++;
485 } else if (ff_AMediaCodec_infoOutputFormatChanged(codec, index)) {
489 status = ff_AMediaFormat_delete(s->format);
491 av_log(avctx, AV_LOG_ERROR, "Failed to delete MediaFormat %p\n", s->format);
495 s->format = ff_AMediaCodec_getOutputFormat(codec);
497 av_log(avctx, AV_LOG_ERROR, "Failed to get output format\n");
498 return AVERROR_EXTERNAL;
501 format = ff_AMediaFormat_toString(s->format);
503 return AVERROR_EXTERNAL;
505 av_log(avctx, AV_LOG_INFO, "Output MediaFormat changed to %s\n", format);
508 if ((ret = mediacodec_dec_parse_format(avctx, s)) < 0) {
512 } else if (ff_AMediaCodec_infoOutputBuffersChanged(codec, index)) {
513 ff_AMediaCodec_cleanOutputBuffers(codec);
514 } else if (ff_AMediaCodec_infoTryAgainLater(codec, index)) {
516 av_log(avctx, AV_LOG_ERROR, "Failed to dequeue output buffer within %" PRIi64 "ms "
517 "while flushing remaining frames, output will probably lack last %d frames\n",
518 output_dequeue_timeout_us / 1000, s->queued_buffer_nb);
520 av_log(avctx, AV_LOG_DEBUG, "No output buffer available, try again later\n");
523 av_log(avctx, AV_LOG_ERROR, "Failed to dequeue output buffer (status=%zd)\n", index);
524 return AVERROR_EXTERNAL;
530 int ff_mediacodec_dec_flush(AVCodecContext *avctx, MediaCodecDecContext *s)
532 FFAMediaCodec *codec = s->codec;
535 s->queued_buffer_nb = 0;
536 s->dequeued_buffer_nb = 0;
540 status = ff_AMediaCodec_flush(codec);
542 av_log(NULL, AV_LOG_ERROR, "Failed to flush MediaCodec %p", codec);
543 return AVERROR_EXTERNAL;
547 s->first_buffer_at = av_gettime();
552 int ff_mediacodec_dec_close(AVCodecContext *avctx, MediaCodecDecContext *s)
555 ff_AMediaCodec_delete(s->codec);
560 ff_AMediaFormat_delete(s->format);
564 av_freep(&s->codec_name);