bd10ff72645065d2758ccaa77c8eb5e71012132b
[ffmpeg.git] / libavcodec / mediacodecdec.c
1 /*
2  * Android MediaCodec decoder
3  *
4  * Copyright (c) 2015-2016 Matthieu Bouron <matthieu.bouron stupeflix.com>
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #include <string.h>
24 #include <sys/types.h>
25
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"
32
33 #include "avcodec.h"
34 #include "internal.h"
35
36 #include "mediacodec_sw_buffer.h"
37 #include "mediacodec_wrapper.h"
38 #include "mediacodecdec.h"
39
40 /**
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
43  * project.
44  *
45  * Gstreamer references:
46  * https://cgit.freedesktop.org/gstreamer/gst-plugins-bad/tree/sys/androidmedia/
47  *
48  * Gstreamer copyright notice:
49  *
50  * Copyright (C) 2012, Collabora Ltd.
51  *   Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
52  *
53  * Copyright (C) 2012, Rafaël Carré <funman@videolanorg>
54  *
55  * Copyright (C) 2015, Sebastian Dröge <sebastian@centricular.com>
56  *
57  * Copyright (C) 2014-2015, Collabora Ltd.
58  *   Author: Matthieu Bouron <matthieu.bouron@gcollabora.com>
59  *
60  * Copyright (C) 2015, Edward Hervey
61  *   Author: Edward Hervey <bilboed@gmail.com>
62  *
63  * Copyright (C) 2015, Matthew Waters <matthew@centricular.com>
64  *
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.
69  *
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.
74  *
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
78  *
79  */
80
81 #define INPUT_DEQUEUE_TIMEOUT_US 8000
82 #define OUTPUT_DEQUEUE_TIMEOUT_US 8000
83 #define OUTPUT_DEQUEUE_BLOCK_TIMEOUT_US 1000000
84
85 enum {
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,
95 };
96
97 static const struct {
98
99     int color_format;
100     enum AVPixelFormat pix_fmt;
101
102 } color_formats[] = {
103
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    },
111     { 0 }
112 };
113
114 static enum AVPixelFormat mcdec_map_color_format(AVCodecContext *avctx,
115                                                  MediaCodecDecContext *s,
116                                                  int color_format)
117 {
118     int i;
119     enum AVPixelFormat ret = AV_PIX_FMT_NONE;
120
121     if (!strcmp(s->codec_name, "OMX.k3.video.decoder.avc") && color_format == COLOR_FormatYCbYCr) {
122         s->color_format = color_format = COLOR_TI_FormatYUV420PackedSemiPlanar;
123     }
124
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;
128         }
129     }
130
131     av_log(avctx, AV_LOG_ERROR, "Output color format 0x%x (value=%d) is not supported\n",
132         color_format, color_format);
133
134     return ret;
135 }
136
137 static int mediacodec_wrap_buffer(AVCodecContext *avctx,
138                                   MediaCodecDecContext *s,
139                                   uint8_t *data,
140                                   size_t size,
141                                   ssize_t index,
142                                   FFAMediaCodecBufferInfo *info,
143                                   AVFrame *frame)
144 {
145     int ret = 0;
146     int status = 0;
147
148     frame->width = avctx->width;
149     frame->height = avctx->height;
150     frame->format = avctx->pix_fmt;
151
152     /* MediaCodec buffers needs to be copied to our own refcounted buffers
153      * because the flush command invalidates all input and output buffers.
154      */
155     if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
156         av_log(avctx, AV_LOG_ERROR, "Could not allocate buffer\n");
157         goto done;
158     }
159
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;
165
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]);
173
174     switch (s->color_format) {
175     case COLOR_FormatYUV420Planar:
176         ff_mediacodec_sw_buffer_copy_yuv420_planar(avctx, s, data, size, info, frame);
177         break;
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);
182         break;
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);
186         break;
187     case COLOR_QCOM_FormatYUV420PackedSemiPlanar64x32Tile2m8ka:
188         ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(avctx, s, data, size, info, frame);
189         break;
190     default:
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);
194         goto done;
195     }
196
197     ret = 0;
198 done:
199     status = ff_AMediaCodec_releaseOutputBuffer(s->codec, index, 0);
200     if (status < 0) {
201         av_log(NULL, AV_LOG_ERROR, "Failed to release output buffer\n");
202         ret = AVERROR_EXTERNAL;
203     }
204
205     return ret;
206 }
207
208 static int mediacodec_dec_parse_format(AVCodecContext *avctx, MediaCodecDecContext *s)
209 {
210     int width = 0;
211     int height = 0;
212     int32_t value = 0;
213     char *format = NULL;
214
215     if (!s->format) {
216         av_log(avctx, AV_LOG_ERROR, "Output MediaFormat is not set\n");
217         return AVERROR(EINVAL);
218     }
219
220     format = ff_AMediaFormat_toString(s->format);
221     if (!format) {
222         return AVERROR_EXTERNAL;
223     }
224     av_log(avctx, AV_LOG_DEBUG, "Parsing MediaFormat %s\n", format);
225     av_freep(&format);
226
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);
231         av_freep(&format);
232         return AVERROR_EXTERNAL;
233     }
234     s->width = value;
235
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);
239         av_freep(&format);
240         return AVERROR_EXTERNAL;
241     }
242     s->height = value;
243
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);
247         av_freep(&format);
248         return AVERROR_EXTERNAL;
249     }
250     s->stride = value >= 0 ? value : s->width;
251
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);
255         av_freep(&format);
256         return AVERROR_EXTERNAL;
257     }
258     if (value > 0) {
259         s->slice_height = value;
260     } else {
261         s->slice_height = s->height;
262     }
263
264     if (strstr(s->codec_name, "OMX.Nvidia.")) {
265         s->slice_height = FFALIGN(s->height, 16);
266     } else if (strstr(s->codec_name, "OMX.SEC.avc.dec")) {
267         s->slice_height = avctx->height;
268         s->stride = avctx->width;
269     }
270
271     if (!ff_AMediaFormat_getInt32(s->format, "color-format", &value)) {
272         format = ff_AMediaFormat_toString(s->format);
273         av_log(avctx, AV_LOG_ERROR, "Could not get %s from format %s\n", "color-format", format);
274         av_freep(&format);
275         return AVERROR_EXTERNAL;
276     }
277     s->color_format = value;
278
279     s->pix_fmt = avctx->pix_fmt = mcdec_map_color_format(avctx, s, value);
280     if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
281         av_log(avctx, AV_LOG_ERROR, "Output color format is not supported\n");
282         return AVERROR(EINVAL);
283     }
284
285     /* Optional fields */
286     if (ff_AMediaFormat_getInt32(s->format, "crop-top", &value))
287         s->crop_top = value;
288
289     if (ff_AMediaFormat_getInt32(s->format, "crop-bottom", &value))
290         s->crop_bottom = value;
291
292     if (ff_AMediaFormat_getInt32(s->format, "crop-left", &value))
293         s->crop_left = value;
294
295     if (ff_AMediaFormat_getInt32(s->format, "crop-right", &value))
296         s->crop_right = value;
297
298     width = s->crop_right + 1 - s->crop_left;
299     height = s->crop_bottom + 1 - s->crop_top;
300
301     av_log(avctx, AV_LOG_INFO,
302         "Output crop parameters top=%d bottom=%d left=%d right=%d, "
303         "resulting dimensions width=%d height=%d\n",
304         s->crop_top, s->crop_bottom, s->crop_left, s->crop_right,
305         width, height);
306
307     return ff_set_dimensions(avctx, width, height);
308 }
309
310 int ff_mediacodec_dec_init(AVCodecContext *avctx, MediaCodecDecContext *s,
311                            const char *mime, FFAMediaFormat *format)
312 {
313     int ret = 0;
314     int status;
315
316     s->first_buffer_at = av_gettime();
317
318     s->codec_name = ff_AMediaCodecList_getCodecNameByType(mime, avctx->width, avctx->height, avctx);
319     if (!s->codec_name) {
320         ret = AVERROR_EXTERNAL;
321         goto fail;
322     }
323
324     av_log(avctx, AV_LOG_DEBUG, "Found decoder %s\n", s->codec_name);
325     s->codec = ff_AMediaCodec_createCodecByName(s->codec_name);
326     if (!s->codec) {
327         av_log(avctx, AV_LOG_ERROR, "Failed to create media decoder for type %s and name %s\n", mime, s->codec_name);
328         ret = AVERROR_EXTERNAL;
329         goto fail;
330     }
331
332     status = ff_AMediaCodec_configure(s->codec, format, NULL, NULL, 0);
333     if (status < 0) {
334         char *desc = ff_AMediaFormat_toString(format);
335         av_log(avctx, AV_LOG_ERROR,
336             "Failed to configure codec (status = %d) with format %s\n",
337             status, desc);
338         av_freep(&desc);
339
340         ret = AVERROR_EXTERNAL;
341         goto fail;
342     }
343
344     status = ff_AMediaCodec_start(s->codec);
345     if (status < 0) {
346         char *desc = ff_AMediaFormat_toString(format);
347         av_log(avctx, AV_LOG_ERROR,
348             "Failed to start codec (status = %d) with format %s\n",
349             status, desc);
350         av_freep(&desc);
351         ret = AVERROR_EXTERNAL;
352         goto fail;
353     }
354
355     s->format = ff_AMediaCodec_getOutputFormat(s->codec);
356     if (s->format) {
357         if ((ret = mediacodec_dec_parse_format(avctx, s)) < 0) {
358             av_log(avctx, AV_LOG_ERROR,
359                 "Failed to configure context\n");
360             goto fail;
361         }
362     }
363
364     av_log(avctx, AV_LOG_DEBUG, "MediaCodec %p started successfully\n", s->codec);
365
366     return 0;
367
368 fail:
369     av_log(avctx, AV_LOG_ERROR, "MediaCodec %p failed to start\n", s->codec);
370     ff_mediacodec_dec_close(avctx, s);
371     return ret;
372 }
373
374 int ff_mediacodec_dec_decode(AVCodecContext *avctx, MediaCodecDecContext *s,
375                              AVFrame *frame, int *got_frame,
376                              AVPacket *pkt)
377 {
378     int ret;
379     int offset = 0;
380     int need_flushing = 0;
381     uint8_t *data;
382     ssize_t index;
383     size_t size;
384     FFAMediaCodec *codec = s->codec;
385     FFAMediaCodecBufferInfo info = { 0 };
386
387     int status;
388
389     int64_t input_dequeue_timeout_us = INPUT_DEQUEUE_TIMEOUT_US;
390     int64_t output_dequeue_timeout_us = OUTPUT_DEQUEUE_TIMEOUT_US;
391
392
393     if (pkt->size == 0) {
394         need_flushing = 1;
395     }
396
397     if (s->flushing && need_flushing && s->queued_buffer_nb <= 0) {
398         return 0;
399     }
400
401     while (offset < pkt->size || (need_flushing && !s->flushing)) {
402         int size;
403
404         index = ff_AMediaCodec_dequeueInputBuffer(codec, input_dequeue_timeout_us);
405         if (ff_AMediaCodec_infoTryAgainLater(codec, index)) {
406             break;
407         }
408
409         if (index < 0) {
410             av_log(avctx, AV_LOG_ERROR, "Failed to dequeue input buffer (status=%zd)\n", index);
411             return AVERROR_EXTERNAL;
412         }
413
414         data = ff_AMediaCodec_getInputBuffer(codec, index, &size);
415         if (!data) {
416             av_log(avctx, AV_LOG_ERROR, "Failed to get input buffer\n");
417             return AVERROR_EXTERNAL;
418         }
419
420         if (need_flushing) {
421             uint32_t flags = ff_AMediaCodec_getBufferFlagEndOfStream(codec);
422
423             av_log(avctx, AV_LOG_DEBUG, "Sending End Of Stream signal\n");
424
425             status = ff_AMediaCodec_queueInputBuffer(codec, index, 0, 0, pkt->pts, flags);
426             if (status < 0) {
427                 av_log(avctx, AV_LOG_ERROR, "Failed to queue input empty buffer (status = %d)\n", status);
428                 return AVERROR_EXTERNAL;
429             }
430
431             s->flushing = 1;
432             break;
433         } else {
434             size = FFMIN(pkt->size - offset, size);
435
436             memcpy(data, pkt->data + offset, size);
437             offset += size;
438
439             status = ff_AMediaCodec_queueInputBuffer(codec, index, 0, size, pkt->pts, 0);
440             if (status < 0) {
441                 av_log(avctx, AV_LOG_ERROR, "Failed to queue input buffer (status = %d)\n", status);
442                 return AVERROR_EXTERNAL;
443             }
444
445             s->queued_buffer_nb++;
446             if (s->queued_buffer_nb > s->queued_buffer_max)
447                 s->queued_buffer_max = s->queued_buffer_nb;
448         }
449     }
450
451     if (s->flushing) {
452         /* If the codec is flushing, block for a fair amount of time to
453         * ensure we got a frame */
454         output_dequeue_timeout_us = OUTPUT_DEQUEUE_BLOCK_TIMEOUT_US;
455     } else if (s->dequeued_buffer_nb == 0) {
456         /* If the codec hasn't produced any frames, do not block so we
457          * can push data to it as fast as possible, and get the first
458          * frame */
459         output_dequeue_timeout_us = 0;
460     }
461
462     index = ff_AMediaCodec_dequeueOutputBuffer(codec, &info, output_dequeue_timeout_us);
463     if (index >= 0) {
464         int ret;
465
466         if (!s->first_buffer++) {
467             av_log(avctx, AV_LOG_DEBUG, "Got first buffer after %fms\n", (av_gettime() - s->first_buffer_at) / 1000);
468         }
469
470         av_log(avctx, AV_LOG_DEBUG, "Got output buffer %zd"
471                 " offset=%" PRIi32 " size=%" PRIi32 " ts=%" PRIi64
472                 " flags=%" PRIu32 "\n", index, info.offset, info.size,
473                 info.presentationTimeUs, info.flags);
474
475         data = ff_AMediaCodec_getOutputBuffer(codec, index, &size);
476         if (!data) {
477             av_log(avctx, AV_LOG_ERROR, "Failed to get output buffer\n");
478             return AVERROR_EXTERNAL;
479         }
480
481         if ((ret = mediacodec_wrap_buffer(avctx, s, data, size, index, &info, frame)) < 0) {
482             av_log(avctx, AV_LOG_ERROR, "Failed to wrap MediaCodec buffer\n");
483             return ret;
484         }
485
486         *got_frame = 1;
487         s->queued_buffer_nb--;
488         s->dequeued_buffer_nb++;
489
490     } else if (ff_AMediaCodec_infoOutputFormatChanged(codec, index)) {
491         char *format = NULL;
492
493         if (s->format) {
494             status = ff_AMediaFormat_delete(s->format);
495             if (status < 0) {
496                 av_log(avctx, AV_LOG_ERROR, "Failed to delete MediaFormat %p\n", s->format);
497             }
498         }
499
500         s->format = ff_AMediaCodec_getOutputFormat(codec);
501         if (!s->format) {
502             av_log(avctx, AV_LOG_ERROR, "Failed to get output format\n");
503             return AVERROR_EXTERNAL;
504         }
505
506         format = ff_AMediaFormat_toString(s->format);
507         if (!format) {
508             return AVERROR_EXTERNAL;
509         }
510         av_log(avctx, AV_LOG_INFO, "Output MediaFormat changed to %s\n", format);
511         av_freep(&format);
512
513         if ((ret = mediacodec_dec_parse_format(avctx, s)) < 0) {
514             return ret;
515         }
516
517     } else if (ff_AMediaCodec_infoOutputBuffersChanged(codec, index)) {
518         ff_AMediaCodec_cleanOutputBuffers(codec);
519     } else if (ff_AMediaCodec_infoTryAgainLater(codec, index)) {
520         if (s->flushing) {
521             av_log(avctx, AV_LOG_ERROR, "Failed to dequeue output buffer within %" PRIi64 "ms "
522                                         "while flushing remaining frames, output will probably lack last %d frames\n",
523                                         output_dequeue_timeout_us / 1000, s->queued_buffer_nb);
524         } else {
525             av_log(avctx, AV_LOG_DEBUG, "No output buffer available, try again later\n");
526         }
527     } else {
528         av_log(avctx, AV_LOG_ERROR, "Failed to dequeue output buffer (status=%zd)\n", index);
529         return AVERROR_EXTERNAL;
530     }
531
532     return offset;
533 }
534
535 int ff_mediacodec_dec_flush(AVCodecContext *avctx, MediaCodecDecContext *s)
536 {
537     FFAMediaCodec *codec = s->codec;
538     int status;
539
540     s->queued_buffer_nb = 0;
541     s->dequeued_buffer_nb = 0;
542
543     s->flushing = 0;
544
545     status = ff_AMediaCodec_flush(codec);
546     if (status < 0) {
547         av_log(NULL, AV_LOG_ERROR, "Failed to flush MediaCodec %p", codec);
548         return AVERROR_EXTERNAL;
549     }
550
551     s->first_buffer = 0;
552     s->first_buffer_at = av_gettime();
553
554     return 0;
555 }
556
557 int ff_mediacodec_dec_close(AVCodecContext *avctx, MediaCodecDecContext *s)
558 {
559     if (s->codec) {
560         ff_AMediaCodec_delete(s->codec);
561         s->codec = NULL;
562     }
563
564     if (s->format) {
565         ff_AMediaFormat_delete(s->format);
566         s->format = NULL;
567     }
568
569     return 0;
570 }