2 * RockChip MPP Video Decoder
3 * Copyright (c) 2017 Lionel CHAZALLON
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <drm_fourcc.h>
24 #include <rockchip/mpp_buffer.h>
25 #include <rockchip/rk_mpi.h>
33 #include "libavutil/buffer.h"
34 #include "libavutil/common.h"
35 #include "libavutil/frame.h"
36 #include "libavutil/hwcontext.h"
37 #include "libavutil/hwcontext_drm.h"
38 #include "libavutil/imgutils.h"
39 #include "libavutil/log.h"
41 #define RECEIVE_FRAME_TIMEOUT 100
42 #define FRAMEGROUP_MAX_FRAMES 16
47 MppBufferGroup frame_group;
53 AVBufferRef *frames_ref;
54 AVBufferRef *device_ref;
59 AVBufferRef *decoder_ref;
64 AVBufferRef *decoder_ref;
67 static MppCodingType rkmpp_get_codingtype(AVCodecContext *avctx)
69 switch (avctx->codec_id) {
70 case AV_CODEC_ID_H264: return MPP_VIDEO_CodingAVC;
71 case AV_CODEC_ID_HEVC: return MPP_VIDEO_CodingHEVC;
72 case AV_CODEC_ID_VP8: return MPP_VIDEO_CodingVP8;
73 case AV_CODEC_ID_VP9: return MPP_VIDEO_CodingVP9;
74 default: return MPP_VIDEO_CodingUnused;
78 static uint32_t rkmpp_get_frameformat(MppFrameFormat mppformat)
81 case MPP_FMT_YUV420SP: return DRM_FORMAT_NV12;
82 #ifdef DRM_FORMAT_NV12_10
83 case MPP_FMT_YUV420SP_10BIT: return DRM_FORMAT_NV12_10;
89 static int rkmpp_write_data(AVCodecContext *avctx, uint8_t *buffer, int size, int64_t pts)
91 RKMPPDecodeContext *rk_context = avctx->priv_data;
92 RKMPPDecoder *decoder = (RKMPPDecoder *)rk_context->decoder_ref->data;
96 // create the MPP packet
97 ret = mpp_packet_init(&packet, buffer, size);
99 av_log(avctx, AV_LOG_ERROR, "Failed to init MPP packet (code = %d)\n", ret);
100 return AVERROR_UNKNOWN;
103 mpp_packet_set_pts(packet, pts);
106 mpp_packet_set_eos(packet);
108 ret = decoder->mpi->decode_put_packet(decoder->ctx, packet);
110 if (ret == MPP_ERR_BUFFER_FULL) {
111 av_log(avctx, AV_LOG_DEBUG, "Buffer full writing %d bytes to decoder\n", size);
112 ret = AVERROR(EAGAIN);
114 ret = AVERROR_UNKNOWN;
117 av_log(avctx, AV_LOG_DEBUG, "Wrote %d bytes to decoder\n", size);
119 mpp_packet_deinit(&packet);
124 static int rkmpp_close_decoder(AVCodecContext *avctx)
126 RKMPPDecodeContext *rk_context = avctx->priv_data;
127 av_buffer_unref(&rk_context->decoder_ref);
131 static void rkmpp_release_decoder(void *opaque, uint8_t *data)
133 RKMPPDecoder *decoder = (RKMPPDecoder *)data;
136 decoder->mpi->reset(decoder->ctx);
137 mpp_destroy(decoder->ctx);
141 if (decoder->frame_group) {
142 mpp_buffer_group_put(decoder->frame_group);
143 decoder->frame_group = NULL;
146 av_buffer_unref(&decoder->frames_ref);
147 av_buffer_unref(&decoder->device_ref);
152 static int rkmpp_init_decoder(AVCodecContext *avctx)
154 RKMPPDecodeContext *rk_context = avctx->priv_data;
155 RKMPPDecoder *decoder = NULL;
156 MppCodingType codectype = MPP_VIDEO_CodingUnused;
161 avctx->pix_fmt = AV_PIX_FMT_DRM_PRIME;
163 // create a decoder and a ref to it
164 decoder = av_mallocz(sizeof(RKMPPDecoder));
166 ret = AVERROR(ENOMEM);
170 rk_context->decoder_ref = av_buffer_create((uint8_t *)decoder, sizeof(*decoder), rkmpp_release_decoder,
171 NULL, AV_BUFFER_FLAG_READONLY);
172 if (!rk_context->decoder_ref) {
174 ret = AVERROR(ENOMEM);
178 av_log(avctx, AV_LOG_DEBUG, "Initializing RKMPP decoder.\n");
180 codectype = rkmpp_get_codingtype(avctx);
181 if (codectype == MPP_VIDEO_CodingUnused) {
182 av_log(avctx, AV_LOG_ERROR, "Unknown codec type (%d).\n", avctx->codec_id);
183 ret = AVERROR_UNKNOWN;
187 ret = mpp_check_support_format(MPP_CTX_DEC, codectype);
189 av_log(avctx, AV_LOG_ERROR, "Codec type (%d) unsupported by MPP\n", avctx->codec_id);
190 ret = AVERROR_UNKNOWN;
194 // Create the MPP context
195 ret = mpp_create(&decoder->ctx, &decoder->mpi);
197 av_log(avctx, AV_LOG_ERROR, "Failed to create MPP context (code = %d).\n", ret);
198 ret = AVERROR_UNKNOWN;
203 ret = mpp_init(decoder->ctx, MPP_CTX_DEC, codectype);
205 av_log(avctx, AV_LOG_ERROR, "Failed to initialize MPP context (code = %d).\n", ret);
206 ret = AVERROR_UNKNOWN;
210 // make decode calls blocking with a timeout
211 paramS32 = MPP_POLL_BLOCK;
212 ret = decoder->mpi->control(decoder->ctx, MPP_SET_OUTPUT_BLOCK, ¶mS32);
214 av_log(avctx, AV_LOG_ERROR, "Failed to set blocking mode on MPI (code = %d).\n", ret);
215 ret = AVERROR_UNKNOWN;
219 paramS64 = RECEIVE_FRAME_TIMEOUT;
220 ret = decoder->mpi->control(decoder->ctx, MPP_SET_OUTPUT_BLOCK_TIMEOUT, ¶mS64);
222 av_log(avctx, AV_LOG_ERROR, "Failed to set block timeout on MPI (code = %d).\n", ret);
223 ret = AVERROR_UNKNOWN;
227 ret = mpp_buffer_group_get_internal(&decoder->frame_group, MPP_BUFFER_TYPE_ION);
229 av_log(avctx, AV_LOG_ERROR, "Failed to retrieve buffer group (code = %d)\n", ret);
230 ret = AVERROR_UNKNOWN;
234 ret = decoder->mpi->control(decoder->ctx, MPP_DEC_SET_EXT_BUF_GROUP, decoder->frame_group);
236 av_log(avctx, AV_LOG_ERROR, "Failed to assign buffer group (code = %d)\n", ret);
237 ret = AVERROR_UNKNOWN;
241 ret = mpp_buffer_group_limit_config(decoder->frame_group, 0, FRAMEGROUP_MAX_FRAMES);
243 av_log(avctx, AV_LOG_ERROR, "Failed to set buffer group limit (code = %d)\n", ret);
244 ret = AVERROR_UNKNOWN;
248 decoder->first_packet = 1;
250 av_log(avctx, AV_LOG_DEBUG, "RKMPP decoder initialized successfully.\n");
252 decoder->device_ref = av_hwdevice_ctx_alloc(AV_HWDEVICE_TYPE_DRM);
253 if (!decoder->device_ref) {
254 ret = AVERROR(ENOMEM);
257 ret = av_hwdevice_ctx_init(decoder->device_ref);
264 av_log(avctx, AV_LOG_ERROR, "Failed to initialize RKMPP decoder.\n");
265 rkmpp_close_decoder(avctx);
269 static int rkmpp_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
271 RKMPPDecodeContext *rk_context = avctx->priv_data;
272 RKMPPDecoder *decoder = (RKMPPDecoder *)rk_context->decoder_ref->data;
277 av_log(avctx, AV_LOG_DEBUG, "End of stream.\n");
278 decoder->eos_reached = 1;
279 ret = rkmpp_write_data(avctx, NULL, 0, 0);
281 av_log(avctx, AV_LOG_ERROR, "Failed to send EOS to decoder (code = %d)\n", ret);
285 // on first packet, send extradata
286 if (decoder->first_packet) {
287 if (avctx->extradata_size) {
288 ret = rkmpp_write_data(avctx, avctx->extradata,
289 avctx->extradata_size,
292 av_log(avctx, AV_LOG_ERROR, "Failed to write extradata to decoder (code = %d)\n", ret);
296 decoder->first_packet = 0;
300 ret = rkmpp_write_data(avctx, avpkt->data, avpkt->size, avpkt->pts);
301 if (ret && ret!=AVERROR(EAGAIN))
302 av_log(avctx, AV_LOG_ERROR, "Failed to write data to decoder (code = %d)\n", ret);
307 static void rkmpp_release_frame(void *opaque, uint8_t *data)
309 AVDRMFrameDescriptor *desc = (AVDRMFrameDescriptor *)data;
310 AVBufferRef *framecontextref = (AVBufferRef *)opaque;
311 RKMPPFrameContext *framecontext = (RKMPPFrameContext *)framecontextref->data;
313 mpp_frame_deinit(&framecontext->frame);
314 av_buffer_unref(&framecontext->decoder_ref);
315 av_buffer_unref(&framecontextref);
320 static int rkmpp_retrieve_frame(AVCodecContext *avctx, AVFrame *frame)
322 RKMPPDecodeContext *rk_context = avctx->priv_data;
323 RKMPPDecoder *decoder = (RKMPPDecoder *)rk_context->decoder_ref->data;
324 RKMPPFrameContext *framecontext = NULL;
325 AVBufferRef *framecontextref = NULL;
327 MppFrame mppframe = NULL;
328 MppBuffer buffer = NULL;
329 AVDRMFrameDescriptor *desc = NULL;
330 AVDRMLayerDescriptor *layer = NULL;
333 MppFrameFormat mppformat;
336 // on start of decoding, MPP can return -1, which is supposed to be expected
337 // this is due to some internal MPP init which is not completed, that will
338 // only happen in the first few frames queries, but should not be interpreted
339 // as an error, Therefore we need to retry a couple times when we get -1
340 // in order to let it time to complete it's init, then we sleep a bit between retries.
342 ret = decoder->mpi->decode_get_frame(decoder->ctx, &mppframe);
343 if (ret != MPP_OK && ret != MPP_ERR_TIMEOUT && !decoder->first_frame) {
344 if (retrycount < 5) {
345 av_log(avctx, AV_LOG_DEBUG, "Failed to get a frame, retrying (code = %d, retrycount = %d)\n", ret, retrycount);
348 goto retry_get_frame;
350 av_log(avctx, AV_LOG_ERROR, "Failed to get a frame from MPP (code = %d)\n", ret);
356 // Check whether we have a special frame or not
357 if (mpp_frame_get_info_change(mppframe)) {
358 AVHWFramesContext *hwframes;
360 av_log(avctx, AV_LOG_INFO, "Decoder noticed an info change (%dx%d), format=%d\n",
361 (int)mpp_frame_get_width(mppframe), (int)mpp_frame_get_height(mppframe),
362 (int)mpp_frame_get_fmt(mppframe));
364 avctx->width = mpp_frame_get_width(mppframe);
365 avctx->height = mpp_frame_get_height(mppframe);
367 decoder->mpi->control(decoder->ctx, MPP_DEC_SET_INFO_CHANGE_READY, NULL);
368 decoder->first_frame = 1;
370 av_buffer_unref(&decoder->frames_ref);
372 decoder->frames_ref = av_hwframe_ctx_alloc(decoder->device_ref);
373 if (!decoder->frames_ref) {
374 ret = AVERROR(ENOMEM);
378 mppformat = mpp_frame_get_fmt(mppframe);
379 drmformat = rkmpp_get_frameformat(mppformat);
381 hwframes = (AVHWFramesContext*)decoder->frames_ref->data;
382 hwframes->format = AV_PIX_FMT_DRM_PRIME;
383 hwframes->sw_format = drmformat == DRM_FORMAT_NV12 ? AV_PIX_FMT_NV12 : AV_PIX_FMT_NONE;
384 hwframes->width = avctx->width;
385 hwframes->height = avctx->height;
386 ret = av_hwframe_ctx_init(decoder->frames_ref);
390 // here decoder is fully initialized, we need to feed it again with data
391 ret = AVERROR(EAGAIN);
393 } else if (mpp_frame_get_eos(mppframe)) {
394 av_log(avctx, AV_LOG_DEBUG, "Received a EOS frame.\n");
395 decoder->eos_reached = 1;
398 } else if (mpp_frame_get_discard(mppframe)) {
399 av_log(avctx, AV_LOG_DEBUG, "Received a discard frame.\n");
400 ret = AVERROR(EAGAIN);
402 } else if (mpp_frame_get_errinfo(mppframe)) {
403 av_log(avctx, AV_LOG_ERROR, "Received a errinfo frame.\n");
404 ret = AVERROR_UNKNOWN;
408 // here we should have a valid frame
409 av_log(avctx, AV_LOG_DEBUG, "Received a frame.\n");
411 // setup general frame fields
412 frame->format = AV_PIX_FMT_DRM_PRIME;
413 frame->width = mpp_frame_get_width(mppframe);
414 frame->height = mpp_frame_get_height(mppframe);
415 frame->pts = mpp_frame_get_pts(mppframe);
416 frame->color_range = mpp_frame_get_color_range(mppframe);
417 frame->color_primaries = mpp_frame_get_color_primaries(mppframe);
418 frame->color_trc = mpp_frame_get_color_trc(mppframe);
419 frame->colorspace = mpp_frame_get_colorspace(mppframe);
421 mode = mpp_frame_get_mode(mppframe);
422 frame->interlaced_frame = ((mode & MPP_FRAME_FLAG_FIELD_ORDER_MASK) == MPP_FRAME_FLAG_DEINTERLACED);
423 frame->top_field_first = ((mode & MPP_FRAME_FLAG_FIELD_ORDER_MASK) == MPP_FRAME_FLAG_TOP_FIRST);
425 mppformat = mpp_frame_get_fmt(mppframe);
426 drmformat = rkmpp_get_frameformat(mppformat);
428 // now setup the frame buffer info
429 buffer = mpp_frame_get_buffer(mppframe);
431 desc = av_mallocz(sizeof(AVDRMFrameDescriptor));
433 ret = AVERROR(ENOMEM);
437 desc->nb_objects = 1;
438 desc->objects[0].fd = mpp_buffer_get_fd(buffer);
439 desc->objects[0].size = mpp_buffer_get_size(buffer);
442 layer = &desc->layers[0];
443 layer->format = drmformat;
444 layer->nb_planes = 2;
446 layer->planes[0].object_index = 0;
447 layer->planes[0].offset = 0;
448 layer->planes[0].pitch = mpp_frame_get_hor_stride(mppframe);
450 layer->planes[1].object_index = 0;
451 layer->planes[1].offset = layer->planes[0].pitch * mpp_frame_get_ver_stride(mppframe);
452 layer->planes[1].pitch = layer->planes[0].pitch;
454 // we also allocate a struct in buf[0] that will allow to hold additionnal information
455 // for releasing properly MPP frames and decoder
456 framecontextref = av_buffer_allocz(sizeof(*framecontext));
457 if (!framecontextref) {
458 ret = AVERROR(ENOMEM);
462 // MPP decoder needs to be closed only when all frames have been released.
463 framecontext = (RKMPPFrameContext *)framecontextref->data;
464 framecontext->decoder_ref = av_buffer_ref(rk_context->decoder_ref);
465 framecontext->frame = mppframe;
467 frame->data[0] = (uint8_t *)desc;
468 frame->buf[0] = av_buffer_create((uint8_t *)desc, sizeof(*desc), rkmpp_release_frame,
469 framecontextref, AV_BUFFER_FLAG_READONLY);
471 if (!frame->buf[0]) {
472 ret = AVERROR(ENOMEM);
476 frame->hw_frames_ctx = av_buffer_ref(decoder->frames_ref);
477 if (!frame->hw_frames_ctx) {
478 ret = AVERROR(ENOMEM);
482 decoder->first_frame = 0;
485 av_log(avctx, AV_LOG_ERROR, "Failed to retrieve the frame buffer, frame is dropped (code = %d)\n", ret);
486 mpp_frame_deinit(&mppframe);
488 } else if (decoder->eos_reached) {
490 } else if (ret == MPP_ERR_TIMEOUT) {
491 av_log(avctx, AV_LOG_DEBUG, "Timeout when trying to get a frame from MPP\n");
494 return AVERROR(EAGAIN);
498 mpp_frame_deinit(&mppframe);
501 av_buffer_unref(&framecontext->decoder_ref);
504 av_buffer_unref(&framecontextref);
512 static int rkmpp_receive_frame(AVCodecContext *avctx, AVFrame *frame)
514 RKMPPDecodeContext *rk_context = avctx->priv_data;
515 RKMPPDecoder *decoder = (RKMPPDecoder *)rk_context->decoder_ref->data;
520 if (!decoder->eos_reached) {
521 // we get the available slots in decoder
522 ret = decoder->mpi->control(decoder->ctx, MPP_DEC_GET_FREE_PACKET_SLOT_COUNT, &freeslots);
524 av_log(avctx, AV_LOG_ERROR, "Failed to get decoder free slots (code = %d).\n", ret);
529 ret = ff_decode_get_packet(avctx, &pkt);
530 if (ret < 0 && ret != AVERROR_EOF) {
534 ret = rkmpp_send_packet(avctx, &pkt);
535 av_packet_unref(&pkt);
538 av_log(avctx, AV_LOG_ERROR, "Failed to send packet to decoder (code = %d)\n", ret);
543 // make sure we keep decoder full
544 if (freeslots > 1 && decoder->first_frame)
545 return AVERROR(EAGAIN);
548 return rkmpp_retrieve_frame(avctx, frame);
551 static void rkmpp_flush(AVCodecContext *avctx)
553 RKMPPDecodeContext *rk_context = avctx->priv_data;
554 RKMPPDecoder *decoder = (RKMPPDecoder *)rk_context->decoder_ref->data;
557 av_log(avctx, AV_LOG_DEBUG, "Flush.\n");
559 ret = decoder->mpi->reset(decoder->ctx);
561 decoder->first_frame = 1;
562 decoder->first_packet = 1;
564 av_log(avctx, AV_LOG_ERROR, "Failed to reset MPI (code = %d)\n", ret);
567 static const AVCodecHWConfigInternal *rkmpp_hw_configs[] = {
568 HW_CONFIG_INTERNAL(DRM_PRIME),
572 #define RKMPP_DEC_CLASS(NAME) \
573 static const AVClass rkmpp_##NAME##_dec_class = { \
574 .class_name = "rkmpp_" #NAME "_dec", \
575 .version = LIBAVUTIL_VERSION_INT, \
578 #define RKMPP_DEC(NAME, ID, BSFS) \
579 RKMPP_DEC_CLASS(NAME) \
580 AVCodec ff_##NAME##_rkmpp_decoder = { \
581 .name = #NAME "_rkmpp", \
582 .long_name = NULL_IF_CONFIG_SMALL(#NAME " (rkmpp)"), \
583 .type = AVMEDIA_TYPE_VIDEO, \
585 .priv_data_size = sizeof(RKMPPDecodeContext), \
586 .init = rkmpp_init_decoder, \
587 .close = rkmpp_close_decoder, \
588 .receive_frame = rkmpp_receive_frame, \
589 .flush = rkmpp_flush, \
590 .priv_class = &rkmpp_##NAME##_dec_class, \
591 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AVOID_PROBING | AV_CODEC_CAP_HARDWARE, \
592 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_DRM_PRIME, \
594 .hw_configs = rkmpp_hw_configs, \
596 .wrapper_name = "rkmpp", \
599 RKMPP_DEC(h264, AV_CODEC_ID_H264, "h264_mp4toannexb")
600 RKMPP_DEC(hevc, AV_CODEC_ID_HEVC, "hevc_mp4toannexb")
601 RKMPP_DEC(vp8, AV_CODEC_ID_VP8, NULL)
602 RKMPP_DEC(vp9, AV_CODEC_ID_VP9, NULL)