crystalhd: Revert back to letting hardware handle packed b-frames
[ffmpeg.git] / libavcodec / crystalhd.c
1 /*
2  * - CrystalHD decoder module -
3  *
4  * Copyright(C) 2010,2011 Philip Langdale <ffmpeg.philipl@overt.org>
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 /*
24  * - Principles of Operation -
25  *
26  * The CrystalHD decoder operates at the bitstream level - which is an even
27  * higher level than the decoding hardware you typically see in modern GPUs.
28  * This means it has a very simple interface, in principle. You feed demuxed
29  * packets in one end and get decoded picture (fields/frames) out the other.
30  *
31  * Of course, nothing is ever that simple. Due, at the very least, to b-frame
32  * dependencies in the supported formats, the hardware has a delay between
33  * when a packet goes in, and when a picture comes out. Furthermore, this delay
34  * is not just a function of time, but also one of the dependency on additional
35  * frames being fed into the decoder to satisfy the b-frame dependencies.
36  *
37  * As such, a pipeline will build up that is roughly equivalent to the required
38  * DPB for the file being played. If that was all it took, things would still
39  * be simple - so, of course, it isn't.
40  *
41  * The hardware has a way of indicating that a picture is ready to be copied out,
42  * but this is unreliable - and sometimes the attempt will still fail so, based
43  * on testing, the code will wait until 3 pictures are ready before starting
44  * to copy out - and this has the effect of extending the pipeline.
45  *
46  * Finally, while it is tempting to say that once the decoder starts outputting
47  * frames, the software should never fail to return a frame from a decode(),
48  * this is a hard assertion to make, because the stream may switch between
49  * differently encoded content (number of b-frames, interlacing, etc) which
50  * might require a longer pipeline than before. If that happened, you could
51  * deadlock trying to retrieve a frame that can't be decoded without feeding
52  * in additional packets.
53  *
54  * As such, the code will return in the event that a picture cannot be copied
55  * out, leading to an increase in the length of the pipeline. This in turn,
56  * means we have to be sensitive to the time it takes to decode a picture;
57  * We do not want to give up just because the hardware needed a little more
58  * time to prepare the picture! For this reason, there are delays included
59  * in the decode() path that ensure that, under normal conditions, the hardware
60  * will only fail to return a frame if it really needs additional packets to
61  * complete the decoding.
62  *
63  * Finally, to be explicit, we do not want the pipeline to grow without bound
64  * for two reasons: 1) The hardware can only buffer a finite number of packets,
65  * and 2) The client application may not be able to cope with arbitrarily long
66  * delays in the video path relative to the audio path. For example. MPlayer
67  * can only handle a 20 picture delay (although this is arbitrary, and needs
68  * to be extended to fully support the CrystalHD where the delay could be up
69  * to 32 pictures - consider PAFF H.264 content with 16 b-frames).
70  */
71
72 /*****************************************************************************
73  * Includes
74  ****************************************************************************/
75
76 #define _XOPEN_SOURCE 600
77 #include <inttypes.h>
78 #include <stdio.h>
79 #include <stdlib.h>
80
81 #include <libcrystalhd/bc_dts_types.h>
82 #include <libcrystalhd/bc_dts_defs.h>
83 #include <libcrystalhd/libcrystalhd_if.h>
84
85 #include "avcodec.h"
86 #include "h264dec.h"
87 #include "internal.h"
88 #include "libavutil/imgutils.h"
89 #include "libavutil/intreadwrite.h"
90 #include "libavutil/opt.h"
91
92 #if HAVE_UNISTD_H
93 #include <unistd.h>
94 #endif
95
96 /** Timeout parameter passed to DtsProcOutput() in us */
97 #define OUTPUT_PROC_TIMEOUT 50
98 /** Step between fake timestamps passed to hardware in units of 100ns */
99 #define TIMESTAMP_UNIT 100000
100
101
102 /*****************************************************************************
103  * Module private data
104  ****************************************************************************/
105
106 typedef enum {
107     RET_ERROR           = -1,
108     RET_OK              = 0,
109 } CopyRet;
110
111 typedef struct OpaqueList {
112     struct OpaqueList *next;
113     uint64_t fake_timestamp;
114     uint64_t reordered_opaque;
115     uint8_t pic_type;
116 } OpaqueList;
117
118 typedef struct {
119     AVClass *av_class;
120     AVCodecContext *avctx;
121     AVFrame *pic;
122     HANDLE dev;
123
124     uint8_t *orig_extradata;
125     uint32_t orig_extradata_size;
126
127     AVBSFContext *bsfc;
128     AVCodecParserContext *parser;
129
130     uint8_t is_70012;
131     uint8_t *sps_pps_buf;
132     uint32_t sps_pps_size;
133     uint8_t is_nal;
134     uint8_t need_second_field;
135
136     uint64_t last_picture;
137
138     OpaqueList *head;
139     OpaqueList *tail;
140
141     /* Options */
142     uint32_t sWidth;
143     uint8_t bframe_bug;
144 } CHDContext;
145
146 static const AVOption options[] = {
147     { "crystalhd_downscale_width",
148       "Turn on downscaling to the specified width",
149       offsetof(CHDContext, sWidth),
150       AV_OPT_TYPE_INT, {.i64 = 0}, 0, UINT32_MAX,
151       AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM, },
152     { NULL, },
153 };
154
155
156 /*****************************************************************************
157  * Helper functions
158  ****************************************************************************/
159
160 static inline BC_MEDIA_SUBTYPE id2subtype(CHDContext *priv, enum AVCodecID id)
161 {
162     switch (id) {
163     case AV_CODEC_ID_MPEG4:
164         return BC_MSUBTYPE_DIVX;
165     case AV_CODEC_ID_MSMPEG4V3:
166         return BC_MSUBTYPE_DIVX311;
167     case AV_CODEC_ID_MPEG2VIDEO:
168         return BC_MSUBTYPE_MPEG2VIDEO;
169     case AV_CODEC_ID_VC1:
170         return BC_MSUBTYPE_VC1;
171     case AV_CODEC_ID_WMV3:
172         return BC_MSUBTYPE_WMV3;
173     case AV_CODEC_ID_H264:
174         return priv->is_nal ? BC_MSUBTYPE_AVC1 : BC_MSUBTYPE_H264;
175     default:
176         return BC_MSUBTYPE_INVALID;
177     }
178 }
179
180 static inline void print_frame_info(CHDContext *priv, BC_DTS_PROC_OUT *output)
181 {
182     av_log(priv->avctx, AV_LOG_TRACE, "\tYBuffSz: %u\n", output->YbuffSz);
183     av_log(priv->avctx, AV_LOG_TRACE, "\tYBuffDoneSz: %u\n",
184            output->YBuffDoneSz);
185     av_log(priv->avctx, AV_LOG_TRACE, "\tUVBuffDoneSz: %u\n",
186            output->UVBuffDoneSz);
187     av_log(priv->avctx, AV_LOG_TRACE, "\tTimestamp: %"PRIu64"\n",
188            output->PicInfo.timeStamp);
189     av_log(priv->avctx, AV_LOG_TRACE, "\tPicture Number: %u\n",
190            output->PicInfo.picture_number);
191     av_log(priv->avctx, AV_LOG_TRACE, "\tWidth: %u\n",
192            output->PicInfo.width);
193     av_log(priv->avctx, AV_LOG_TRACE, "\tHeight: %u\n",
194            output->PicInfo.height);
195     av_log(priv->avctx, AV_LOG_TRACE, "\tChroma: 0x%03x\n",
196            output->PicInfo.chroma_format);
197     av_log(priv->avctx, AV_LOG_TRACE, "\tPulldown: %u\n",
198            output->PicInfo.pulldown);
199     av_log(priv->avctx, AV_LOG_TRACE, "\tFlags: 0x%08x\n",
200            output->PicInfo.flags);
201     av_log(priv->avctx, AV_LOG_TRACE, "\tFrame Rate/Res: %u\n",
202            output->PicInfo.frame_rate);
203     av_log(priv->avctx, AV_LOG_TRACE, "\tAspect Ratio: %u\n",
204            output->PicInfo.aspect_ratio);
205     av_log(priv->avctx, AV_LOG_TRACE, "\tColor Primaries: %u\n",
206            output->PicInfo.colour_primaries);
207     av_log(priv->avctx, AV_LOG_TRACE, "\tMetaData: %u\n",
208            output->PicInfo.picture_meta_payload);
209     av_log(priv->avctx, AV_LOG_TRACE, "\tSession Number: %u\n",
210            output->PicInfo.sess_num);
211     av_log(priv->avctx, AV_LOG_TRACE, "\tycom: %u\n",
212            output->PicInfo.ycom);
213     av_log(priv->avctx, AV_LOG_TRACE, "\tCustom Aspect: %u\n",
214            output->PicInfo.custom_aspect_ratio_width_height);
215     av_log(priv->avctx, AV_LOG_TRACE, "\tFrames to Drop: %u\n",
216            output->PicInfo.n_drop);
217     av_log(priv->avctx, AV_LOG_TRACE, "\tH264 Valid Fields: 0x%08x\n",
218            output->PicInfo.other.h264.valid);
219 }
220
221
222 /*****************************************************************************
223  * OpaqueList functions
224  ****************************************************************************/
225
226 static uint64_t opaque_list_push(CHDContext *priv, uint64_t reordered_opaque,
227                                  uint8_t pic_type)
228 {
229     OpaqueList *newNode = av_mallocz(sizeof (OpaqueList));
230     if (!newNode) {
231         av_log(priv->avctx, AV_LOG_ERROR,
232                "Unable to allocate new node in OpaqueList.\n");
233         return 0;
234     }
235     if (!priv->head) {
236         newNode->fake_timestamp = TIMESTAMP_UNIT;
237         priv->head              = newNode;
238     } else {
239         newNode->fake_timestamp = priv->tail->fake_timestamp + TIMESTAMP_UNIT;
240         priv->tail->next        = newNode;
241     }
242     priv->tail = newNode;
243     newNode->reordered_opaque = reordered_opaque;
244     newNode->pic_type = pic_type;
245
246     return newNode->fake_timestamp;
247 }
248
249 /*
250  * The OpaqueList is built in decode order, while elements will be removed
251  * in presentation order. If frames are reordered, this means we must be
252  * able to remove elements that are not the first element.
253  *
254  * Returned node must be freed by caller.
255  */
256 static OpaqueList *opaque_list_pop(CHDContext *priv, uint64_t fake_timestamp)
257 {
258     OpaqueList *node = priv->head;
259
260     if (!priv->head) {
261         av_log(priv->avctx, AV_LOG_ERROR,
262                "CrystalHD: Attempted to query non-existent timestamps.\n");
263         return NULL;
264     }
265
266     /*
267      * The first element is special-cased because we have to manipulate
268      * the head pointer rather than the previous element in the list.
269      */
270     if (priv->head->fake_timestamp == fake_timestamp) {
271         priv->head = node->next;
272
273         if (!priv->head->next)
274             priv->tail = priv->head;
275
276         node->next = NULL;
277         return node;
278     }
279
280     /*
281      * The list is processed at arm's length so that we have the
282      * previous element available to rewrite its next pointer.
283      */
284     while (node->next) {
285         OpaqueList *current = node->next;
286         if (current->fake_timestamp == fake_timestamp) {
287             node->next = current->next;
288
289             if (!node->next)
290                priv->tail = node;
291
292             current->next = NULL;
293             return current;
294         } else {
295             node = current;
296         }
297     }
298
299     av_log(priv->avctx, AV_LOG_VERBOSE,
300            "CrystalHD: Couldn't match fake_timestamp.\n");
301     return NULL;
302 }
303
304
305 /*****************************************************************************
306  * Video decoder API function definitions
307  ****************************************************************************/
308
309 static void flush(AVCodecContext *avctx)
310 {
311     CHDContext *priv = avctx->priv_data;
312
313     priv->last_picture      = -1;
314     priv->need_second_field = 0;
315
316     av_frame_unref (priv->pic);
317
318     /* Flush mode 4 flushes all software and hardware buffers. */
319     DtsFlushInput(priv->dev, 4);
320 }
321
322
323 static av_cold int uninit(AVCodecContext *avctx)
324 {
325     CHDContext *priv = avctx->priv_data;
326     HANDLE device;
327
328     device = priv->dev;
329     DtsStopDecoder(device);
330     DtsCloseDecoder(device);
331     DtsDeviceClose(device);
332
333     /*
334      * Restore original extradata, so that if the decoder is
335      * reinitialised, the bitstream detection and filtering
336      * will work as expected.
337      */
338     if (priv->orig_extradata) {
339         av_free(avctx->extradata);
340         avctx->extradata = priv->orig_extradata;
341         avctx->extradata_size = priv->orig_extradata_size;
342         priv->orig_extradata = NULL;
343         priv->orig_extradata_size = 0;
344     }
345
346     av_parser_close(priv->parser);
347     if (priv->bsfc) {
348         av_bsf_free(&priv->bsfc);
349     }
350
351     av_freep(&priv->sps_pps_buf);
352
353     av_frame_free (&priv->pic);
354
355     if (priv->head) {
356        OpaqueList *node = priv->head;
357        while (node) {
358           OpaqueList *next = node->next;
359           av_free(node);
360           node = next;
361        }
362     }
363
364     return 0;
365 }
366
367
368 static av_cold int init_bsf(AVCodecContext *avctx, const char *bsf_name)
369 {
370     CHDContext *priv = avctx->priv_data;
371     const AVBitStreamFilter *bsf;
372     int avret;
373     void *extradata = NULL;
374     size_t size = 0;
375
376     bsf = av_bsf_get_by_name(bsf_name);
377     if (!bsf) {
378         av_log(avctx, AV_LOG_ERROR,
379                "Cannot open the %s BSF!\n", bsf_name);
380         return AVERROR_BSF_NOT_FOUND;
381     }
382
383     avret = av_bsf_alloc(bsf, &priv->bsfc);
384     if (avret != 0) {
385         return avret;
386     }
387
388     avret = avcodec_parameters_from_context(priv->bsfc->par_in, avctx);
389     if (avret != 0) {
390         return avret;
391     }
392
393     avret = av_bsf_init(priv->bsfc);
394     if (avret != 0) {
395         return avret;
396     }
397
398     /* Back up the extradata so it can be restored at close time. */
399     priv->orig_extradata = avctx->extradata;
400     priv->orig_extradata_size = avctx->extradata_size;
401
402     size = priv->bsfc->par_out->extradata_size;
403     extradata = av_malloc(size + AV_INPUT_BUFFER_PADDING_SIZE);
404     if (!extradata) {
405         av_log(avctx, AV_LOG_ERROR,
406                "Failed to allocate copy of extradata\n");
407         return AVERROR(ENOMEM);
408     }
409     memcpy(extradata, priv->bsfc->par_out->extradata, size);
410
411     avctx->extradata = extradata;
412     avctx->extradata_size = size;
413
414     return 0;
415 }
416
417 static av_cold int init(AVCodecContext *avctx)
418 {
419     CHDContext* priv;
420     int avret;
421     BC_STATUS ret;
422     BC_INFO_CRYSTAL version;
423     BC_INPUT_FORMAT format = {
424         .FGTEnable   = FALSE,
425         .Progressive = TRUE,
426         .OptFlags    = 0x80000000 | vdecFrameRate59_94 | 0x40,
427         .width       = avctx->width,
428         .height      = avctx->height,
429     };
430
431     BC_MEDIA_SUBTYPE subtype;
432
433     uint32_t mode = DTS_PLAYBACK_MODE |
434                     DTS_LOAD_FILE_PLAY_FW |
435                     DTS_SKIP_TX_CHK_CPB |
436                     DTS_PLAYBACK_DROP_RPT_MODE |
437                     DTS_SINGLE_THREADED_MODE |
438                     DTS_DFLT_RESOLUTION(vdecRESOLUTION_1080p23_976);
439
440     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD Init for %s\n",
441            avctx->codec->name);
442
443     avctx->pix_fmt = AV_PIX_FMT_YUYV422;
444
445     /* Initialize the library */
446     priv               = avctx->priv_data;
447     priv->avctx        = avctx;
448     priv->is_nal       = avctx->extradata_size > 0 && *(avctx->extradata) == 1;
449     priv->last_picture = -1;
450     priv->pic          = av_frame_alloc();
451
452     subtype = id2subtype(priv, avctx->codec->id);
453     switch (subtype) {
454     case BC_MSUBTYPE_AVC1:
455         avret = init_bsf(avctx, "h264_mp4toannexb");
456         if (avret != 0) {
457             return avret;
458         }
459         subtype = BC_MSUBTYPE_H264;
460         format.startCodeSz = 4;
461         format.pMetaData  = avctx->extradata;
462         format.metaDataSz = avctx->extradata_size;
463         break;
464     case BC_MSUBTYPE_H264:
465         format.startCodeSz = 4;
466         // Fall-through
467     case BC_MSUBTYPE_VC1:
468     case BC_MSUBTYPE_WVC1:
469     case BC_MSUBTYPE_WMV3:
470     case BC_MSUBTYPE_WMVA:
471     case BC_MSUBTYPE_MPEG2VIDEO:
472     case BC_MSUBTYPE_DIVX:
473     case BC_MSUBTYPE_DIVX311:
474         format.pMetaData  = avctx->extradata;
475         format.metaDataSz = avctx->extradata_size;
476         break;
477     default:
478         av_log(avctx, AV_LOG_ERROR, "CrystalHD: Unknown codec name\n");
479         return AVERROR(EINVAL);
480     }
481     format.mSubtype = subtype;
482
483     if (priv->sWidth) {
484         format.bEnableScaling = 1;
485         format.ScalingParams.sWidth = priv->sWidth;
486     }
487
488     /* Get a decoder instance */
489     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: starting up\n");
490     // Initialize the Link and Decoder devices
491     ret = DtsDeviceOpen(&priv->dev, mode);
492     if (ret != BC_STS_SUCCESS) {
493         av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: DtsDeviceOpen failed\n");
494         goto fail;
495     }
496
497     ret = DtsCrystalHDVersion(priv->dev, &version);
498     if (ret != BC_STS_SUCCESS) {
499         av_log(avctx, AV_LOG_VERBOSE,
500                "CrystalHD: DtsCrystalHDVersion failed\n");
501         goto fail;
502     }
503     priv->is_70012 = version.device == 0;
504
505     if (priv->is_70012 &&
506         (subtype == BC_MSUBTYPE_DIVX || subtype == BC_MSUBTYPE_DIVX311)) {
507         av_log(avctx, AV_LOG_VERBOSE,
508                "CrystalHD: BCM70012 doesn't support MPEG4-ASP/DivX/Xvid\n");
509         goto fail;
510     }
511
512     ret = DtsSetInputFormat(priv->dev, &format);
513     if (ret != BC_STS_SUCCESS) {
514         av_log(avctx, AV_LOG_ERROR, "CrystalHD: SetInputFormat failed\n");
515         goto fail;
516     }
517
518     ret = DtsOpenDecoder(priv->dev, BC_STREAM_TYPE_ES);
519     if (ret != BC_STS_SUCCESS) {
520         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsOpenDecoder failed\n");
521         goto fail;
522     }
523
524     ret = DtsSetColorSpace(priv->dev, OUTPUT_MODE422_YUY2);
525     if (ret != BC_STS_SUCCESS) {
526         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsSetColorSpace failed\n");
527         goto fail;
528     }
529     ret = DtsStartDecoder(priv->dev);
530     if (ret != BC_STS_SUCCESS) {
531         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsStartDecoder failed\n");
532         goto fail;
533     }
534     ret = DtsStartCapture(priv->dev);
535     if (ret != BC_STS_SUCCESS) {
536         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsStartCapture failed\n");
537         goto fail;
538     }
539
540     if (avctx->codec->id == AV_CODEC_ID_H264) {
541         priv->parser = av_parser_init(avctx->codec->id);
542         if (!priv->parser)
543             av_log(avctx, AV_LOG_WARNING,
544                    "Cannot open the h.264 parser! Interlaced h.264 content "
545                    "will not be detected reliably.\n");
546         priv->parser->flags = PARSER_FLAG_COMPLETE_FRAMES;
547     }
548     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Init complete.\n");
549
550     return 0;
551
552  fail:
553     uninit(avctx);
554     return -1;
555 }
556
557
558 static inline CopyRet copy_frame(AVCodecContext *avctx,
559                                  BC_DTS_PROC_OUT *output,
560                                  void *data, int *got_frame)
561 {
562     BC_STATUS ret;
563     BC_DTS_STATUS decoder_status = { 0, };
564     uint8_t trust_interlaced;
565     uint8_t interlaced;
566
567     CHDContext *priv = avctx->priv_data;
568     int64_t pkt_pts  = AV_NOPTS_VALUE;
569     uint8_t pic_type = 0;
570
571     uint8_t bottom_field = (output->PicInfo.flags & VDEC_FLAG_BOTTOMFIELD) ==
572                            VDEC_FLAG_BOTTOMFIELD;
573     uint8_t bottom_first = !!(output->PicInfo.flags & VDEC_FLAG_BOTTOM_FIRST);
574
575     int width    = output->PicInfo.width;
576     int height   = output->PicInfo.height;
577     int bwidth;
578     uint8_t *src = output->Ybuff;
579     int sStride;
580     uint8_t *dst;
581     int dStride;
582
583     if (output->PicInfo.timeStamp != 0) {
584         OpaqueList *node = opaque_list_pop(priv, output->PicInfo.timeStamp);
585         if (node) {
586             pkt_pts = node->reordered_opaque;
587             pic_type = node->pic_type;
588             av_free(node);
589         } else {
590             /*
591              * We will encounter a situation where a timestamp cannot be
592              * popped if a second field is being returned. In this case,
593              * each field has the same timestamp and the first one will
594              * cause it to be popped. To keep subsequent calculations
595              * simple, pic_type should be set a FIELD value - doesn't
596              * matter which, but I chose BOTTOM.
597              */
598             pic_type = PICT_BOTTOM_FIELD;
599         }
600         av_log(avctx, AV_LOG_VERBOSE, "output \"pts\": %"PRIu64"\n",
601                output->PicInfo.timeStamp);
602         av_log(avctx, AV_LOG_VERBOSE, "output picture type %d\n",
603                pic_type);
604     }
605
606     ret = DtsGetDriverStatus(priv->dev, &decoder_status);
607     if (ret != BC_STS_SUCCESS) {
608         av_log(avctx, AV_LOG_ERROR,
609                "CrystalHD: GetDriverStatus failed: %u\n", ret);
610        return RET_ERROR;
611     }
612
613     /*
614      * For most content, we can trust the interlaced flag returned
615      * by the hardware, but sometimes we can't. These are the
616      * conditions under which we can trust the flag:
617      *
618      * 1) It's not h.264 content
619      * 2) The UNKNOWN_SRC flag is not set
620      * 3) We know we're expecting a second field
621      * 4) The hardware reports this picture and the next picture
622      *    have the same picture number.
623      *
624      * Note that there can still be interlaced content that will
625      * fail this check, if the hardware hasn't decoded the next
626      * picture or if there is a corruption in the stream. (In either
627      * case a 0 will be returned for the next picture number)
628      */
629     trust_interlaced = avctx->codec->id != AV_CODEC_ID_H264 ||
630                        !(output->PicInfo.flags & VDEC_FLAG_UNKNOWN_SRC) ||
631                        priv->need_second_field ||
632                        (decoder_status.picNumFlags & ~0x40000000) ==
633                        output->PicInfo.picture_number;
634
635     /*
636      * If we got a false negative for trust_interlaced on the first field,
637      * we will realise our mistake here when we see that the picture number is that
638      * of the previous picture. We cannot recover the frame and should discard the
639      * second field to keep the correct number of output frames.
640      */
641     if (output->PicInfo.picture_number == priv->last_picture && !priv->need_second_field) {
642         av_log(avctx, AV_LOG_WARNING,
643                "Incorrectly guessed progressive frame. Discarding second field\n");
644         /* Returning without providing a picture. */
645         return RET_OK;
646     }
647
648     interlaced = (output->PicInfo.flags & VDEC_FLAG_INTERLACED_SRC) &&
649                  trust_interlaced;
650
651     if (!trust_interlaced && (decoder_status.picNumFlags & ~0x40000000) == 0) {
652         av_log(avctx, AV_LOG_VERBOSE,
653                "Next picture number unknown. Assuming progressive frame.\n");
654     }
655
656     av_log(avctx, AV_LOG_VERBOSE, "Interlaced state: %d | trust_interlaced %d\n",
657            interlaced, trust_interlaced);
658
659     if (priv->pic->data[0] && !priv->need_second_field)
660         av_frame_unref(priv->pic);
661
662     priv->need_second_field = interlaced && !priv->need_second_field;
663
664     if (!priv->pic->data[0]) {
665         if (ff_get_buffer(avctx, priv->pic, AV_GET_BUFFER_FLAG_REF) < 0)
666             return RET_ERROR;
667     }
668
669     bwidth = av_image_get_linesize(avctx->pix_fmt, width, 0);
670     if (priv->is_70012) {
671         int pStride;
672
673         if (width <= 720)
674             pStride = 720;
675         else if (width <= 1280)
676             pStride = 1280;
677         else pStride = 1920;
678         sStride = av_image_get_linesize(avctx->pix_fmt, pStride, 0);
679     } else {
680         sStride = bwidth;
681     }
682
683     dStride = priv->pic->linesize[0];
684     dst     = priv->pic->data[0];
685
686     av_log(priv->avctx, AV_LOG_VERBOSE, "CrystalHD: Copying out frame\n");
687
688     /*
689      * The hardware doesn't return the first sample of a picture.
690      * Ignoring why it behaves this way, it's better to copy the sample from
691      * the second line, rather than the next sample across because the chroma
692      * values should be correct (assuming the decoded video was 4:2:0, which
693      * it was).
694      */
695     *((uint32_t *)src) = *((uint32_t *)(src + sStride));
696
697     if (interlaced) {
698         int dY = 0;
699         int sY = 0;
700
701         height /= 2;
702         if (bottom_field) {
703             av_log(priv->avctx, AV_LOG_VERBOSE, "Interlaced: bottom field\n");
704             dY = 1;
705         } else {
706             av_log(priv->avctx, AV_LOG_VERBOSE, "Interlaced: top field\n");
707             dY = 0;
708         }
709
710         for (sY = 0; sY < height; dY++, sY++) {
711             memcpy(&(dst[dY * dStride]), &(src[sY * sStride]), bwidth);
712             dY++;
713         }
714     } else {
715         av_image_copy_plane(dst, dStride, src, sStride, bwidth, height);
716     }
717
718     priv->pic->interlaced_frame = interlaced;
719     if (interlaced)
720         priv->pic->top_field_first = !bottom_first;
721
722     if (pkt_pts != AV_NOPTS_VALUE) {
723         priv->pic->pts = pkt_pts;
724 #if FF_API_PKT_PTS
725 FF_DISABLE_DEPRECATION_WARNINGS
726         priv->pic->pkt_pts = pkt_pts;
727 FF_ENABLE_DEPRECATION_WARNINGS
728 #endif
729     }
730     av_frame_set_pkt_pos(priv->pic, -1);
731     av_frame_set_pkt_duration(priv->pic, 0);
732     av_frame_set_pkt_size(priv->pic, -1);
733
734     if (!priv->need_second_field) {
735         *got_frame       = 1;
736         if ((ret = av_frame_ref(data, priv->pic)) < 0) {
737             return ret;
738         }
739     }
740
741     return RET_OK;
742 }
743
744
745 static inline CopyRet receive_frame(AVCodecContext *avctx,
746                                     void *data, int *got_frame)
747 {
748     BC_STATUS ret;
749     BC_DTS_PROC_OUT output = {
750         .PicInfo.width  = avctx->width,
751         .PicInfo.height = avctx->height,
752     };
753     CHDContext *priv = avctx->priv_data;
754     HANDLE dev       = priv->dev;
755
756     *got_frame = 0;
757
758     // Request decoded data from the driver
759     ret = DtsProcOutputNoCopy(dev, OUTPUT_PROC_TIMEOUT, &output);
760     if (ret == BC_STS_FMT_CHANGE) {
761         av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Initial format change\n");
762         avctx->width  = output.PicInfo.width;
763         avctx->height = output.PicInfo.height;
764         switch ( output.PicInfo.aspect_ratio ) {
765         case vdecAspectRatioSquare:
766             avctx->sample_aspect_ratio = (AVRational) {  1,  1};
767             break;
768         case vdecAspectRatio12_11:
769             avctx->sample_aspect_ratio = (AVRational) { 12, 11};
770             break;
771         case vdecAspectRatio10_11:
772             avctx->sample_aspect_ratio = (AVRational) { 10, 11};
773             break;
774         case vdecAspectRatio16_11:
775             avctx->sample_aspect_ratio = (AVRational) { 16, 11};
776             break;
777         case vdecAspectRatio40_33:
778             avctx->sample_aspect_ratio = (AVRational) { 40, 33};
779             break;
780         case vdecAspectRatio24_11:
781             avctx->sample_aspect_ratio = (AVRational) { 24, 11};
782             break;
783         case vdecAspectRatio20_11:
784             avctx->sample_aspect_ratio = (AVRational) { 20, 11};
785             break;
786         case vdecAspectRatio32_11:
787             avctx->sample_aspect_ratio = (AVRational) { 32, 11};
788             break;
789         case vdecAspectRatio80_33:
790             avctx->sample_aspect_ratio = (AVRational) { 80, 33};
791             break;
792         case vdecAspectRatio18_11:
793             avctx->sample_aspect_ratio = (AVRational) { 18, 11};
794             break;
795         case vdecAspectRatio15_11:
796             avctx->sample_aspect_ratio = (AVRational) { 15, 11};
797             break;
798         case vdecAspectRatio64_33:
799             avctx->sample_aspect_ratio = (AVRational) { 64, 33};
800             break;
801         case vdecAspectRatio160_99:
802             avctx->sample_aspect_ratio = (AVRational) {160, 99};
803             break;
804         case vdecAspectRatio4_3:
805             avctx->sample_aspect_ratio = (AVRational) {  4,  3};
806             break;
807         case vdecAspectRatio16_9:
808             avctx->sample_aspect_ratio = (AVRational) { 16,  9};
809             break;
810         case vdecAspectRatio221_1:
811             avctx->sample_aspect_ratio = (AVRational) {221,  1};
812             break;
813         }
814         return RET_OK;
815     } else if (ret == BC_STS_SUCCESS) {
816         int copy_ret = -1;
817         if (output.PoutFlags & BC_POUT_FLAGS_PIB_VALID) {
818             if (priv->last_picture == -1) {
819                 /*
820                  * Init to one less, so that the incrementing code doesn't
821                  * need to be special-cased.
822                  */
823                 priv->last_picture = output.PicInfo.picture_number - 1;
824             }
825
826             if (avctx->codec->id == AV_CODEC_ID_MPEG4 &&
827                 output.PicInfo.timeStamp == 0 && priv->bframe_bug) {
828                 if (!priv->bframe_bug) {
829                     av_log(avctx, AV_LOG_VERBOSE,
830                            "CrystalHD: Not returning packed frame twice.\n");
831                 }
832                 priv->last_picture++;
833                 DtsReleaseOutputBuffs(dev, NULL, FALSE);
834                 return RET_COPY_AGAIN;
835             }
836
837             print_frame_info(priv, &output);
838
839             if (priv->last_picture + 1 < output.PicInfo.picture_number) {
840                 av_log(avctx, AV_LOG_WARNING,
841                        "CrystalHD: Picture Number discontinuity\n");
842                 /*
843                  * XXX: I have no idea what the semantics of this situation
844                  * are so I don't even know if we've lost frames or which
845                  * ones.
846                  */
847                priv->last_picture = output.PicInfo.picture_number - 1;
848             }
849
850             copy_ret = copy_frame(avctx, &output, data, got_frame);
851             if (*got_frame > 0) {
852                 priv->last_picture++;
853             }
854         } else {
855             /*
856              * An invalid frame has been consumed.
857              */
858             av_log(avctx, AV_LOG_ERROR, "CrystalHD: ProcOutput succeeded with "
859                                         "invalid PIB\n");
860             copy_ret = RET_OK;
861         }
862         DtsReleaseOutputBuffs(dev, NULL, FALSE);
863
864         return copy_ret;
865     } else if (ret == BC_STS_BUSY) {
866         return RET_OK;
867     } else {
868         av_log(avctx, AV_LOG_ERROR, "CrystalHD: ProcOutput failed %d\n", ret);
869         return RET_ERROR;
870     }
871 }
872
873 static int crystalhd_decode_packet(AVCodecContext *avctx, const AVPacket *avpkt)
874 {
875     BC_STATUS bc_ret;
876     CHDContext *priv   = avctx->priv_data;
877     HANDLE dev         = priv->dev;
878     uint8_t pic_type   = 0;
879     AVPacket filtered_packet = { 0 };
880     int ret = 0;
881
882     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: decode_packet\n");
883
884     if (avpkt && avpkt->size) {
885         int32_t tx_free = (int32_t)DtsTxFreeSize(dev);
886
887         if (!priv->bframe_bug && (avpkt->size == 6 || avpkt->size == 7)) {
888             /*
889              * Drop frames trigger the bug
890              */
891             av_log(avctx, AV_LOG_WARNING,
892                    "CrystalHD: Enabling work-around for packed b-frame bug\n");
893             priv->bframe_bug = 1;
894         } else if (priv->bframe_bug && avpkt->size == 8) {
895             /*
896              * Delay frames don't trigger the bug
897              */
898             av_log(avctx, AV_LOG_WARNING,
899                    "CrystalHD: Disabling work-around for packed b-frame bug\n");
900             priv->bframe_bug = 0;
901         }
902
903         if (priv->bsfc) {
904             AVPacket filter_packet = { 0 };
905
906             ret = av_packet_ref(&filter_packet, avpkt);
907             if (ret < 0) {
908                 av_log(avctx, AV_LOG_ERROR, "CrystalHD: mpv4toannexb filter "
909                        "failed to ref input packet\n");
910                 goto exit;
911             }
912
913             ret = av_bsf_send_packet(priv->bsfc, &filter_packet);
914             if (ret < 0) {
915                 av_log(avctx, AV_LOG_ERROR, "CrystalHD: mpv4toannexb filter "
916                        "failed to send input packet\n");
917                 goto exit;
918             }
919
920             ret = av_bsf_receive_packet(priv->bsfc, &filtered_packet);
921             if (ret < 0) {
922                 av_log(avctx, AV_LOG_ERROR, "CrystalHD: mpv4toannexb filter "
923                        "failed to receive output packet\n");
924                 goto exit;
925             }
926
927             avpkt = &filtered_packet;
928             av_packet_unref(&filter_packet);
929         }
930
931         if (priv->parser) {
932             uint8_t *pout;
933             int psize;
934             int index;
935             H264Context *h = priv->parser->priv_data;
936
937             index = av_parser_parse2(priv->parser, avctx, &pout, &psize,
938                                      avpkt->data, avpkt->size, avpkt->pts,
939                                      avpkt->dts, 0);
940             if (index < 0) {
941                 av_log(avctx, AV_LOG_WARNING,
942                        "CrystalHD: Failed to parse h.264 packet to "
943                        "detect interlacing.\n");
944             } else if (index != avpkt->size) {
945                 av_log(avctx, AV_LOG_WARNING,
946                        "CrystalHD: Failed to parse h.264 packet "
947                        "completely. Interlaced frames may be "
948                        "incorrectly detected.\n");
949             } else {
950                 av_log(avctx, AV_LOG_VERBOSE,
951                        "CrystalHD: parser picture type %d\n",
952                        h->picture_structure);
953                 pic_type = h->picture_structure;
954             }
955         }
956
957         if (avpkt->size < tx_free) {
958             /*
959              * Despite being notionally opaque, either libcrystalhd or
960              * the hardware itself will mangle pts values that are too
961              * small or too large. The docs claim it should be in units
962              * of 100ns. Given that we're nominally dealing with a black
963              * box on both sides, any transform we do has no guarantee of
964              * avoiding mangling so we need to build a mapping to values
965              * we know will not be mangled.
966              */
967             int64_t safe_pts = avpkt->pts == AV_NOPTS_VALUE ? 0 : avpkt->pts;
968             uint64_t pts = opaque_list_push(priv, safe_pts, pic_type);
969             if (!pts) {
970                 ret = AVERROR(ENOMEM);
971                 goto exit;
972             }
973             av_log(priv->avctx, AV_LOG_VERBOSE,
974                    "input \"pts\": %"PRIu64"\n", pts);
975             bc_ret = DtsProcInput(dev, avpkt->data, avpkt->size, pts, 0);
976             if (bc_ret == BC_STS_BUSY) {
977                 av_log(avctx, AV_LOG_WARNING,
978                        "CrystalHD: ProcInput returned busy\n");
979                 ret = AVERROR(EAGAIN);
980                 goto exit;
981             } else if (bc_ret != BC_STS_SUCCESS) {
982                 av_log(avctx, AV_LOG_ERROR,
983                        "CrystalHD: ProcInput failed: %u\n", ret);
984                 ret = -1;
985                 goto exit;
986             }
987         } else {
988             av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Input buffer full\n");
989             ret = AVERROR(EAGAIN);
990             goto exit;
991         }
992     } else {
993         av_log(avctx, AV_LOG_INFO, "CrystalHD: No more input data\n");
994         ret = AVERROR_EOF;
995         goto exit;
996     }
997  exit:
998     av_packet_unref(&filtered_packet);
999     return ret;
1000 }
1001
1002 static int crystalhd_receive_frame(AVCodecContext *avctx, AVFrame *frame)
1003 {
1004     BC_STATUS bc_ret;
1005     BC_DTS_STATUS decoder_status = { 0, };
1006     CopyRet rec_ret;
1007     CHDContext *priv   = avctx->priv_data;
1008     HANDLE dev         = priv->dev;
1009     int got_frame = 0;
1010
1011     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: receive_frame\n");
1012
1013     bc_ret = DtsGetDriverStatus(dev, &decoder_status);
1014     if (bc_ret != BC_STS_SUCCESS) {
1015         av_log(avctx, AV_LOG_ERROR, "CrystalHD: GetDriverStatus failed\n");
1016         return -1;
1017     }
1018
1019     if (decoder_status.ReadyListCount == 0) {
1020         av_log(avctx, AV_LOG_INFO, "CrystalHD: Insufficient frames ready. Returning\n");
1021         return AVERROR(EAGAIN);
1022     }
1023
1024     rec_ret = receive_frame(avctx, frame, &got_frame);
1025     if (rec_ret == RET_ERROR) {
1026         return -1;
1027     } else if (got_frame == 0) {
1028         return AVERROR(EAGAIN);
1029     } else {
1030         return 0;
1031     }
1032 }
1033
1034 #define DEFINE_CRYSTALHD_DECODER(x, X) \
1035     static const AVClass x##_crystalhd_class = { \
1036         .class_name = #x "_crystalhd", \
1037         .item_name = av_default_item_name, \
1038         .option = options, \
1039         .version = LIBAVUTIL_VERSION_INT, \
1040     }; \
1041     AVCodec ff_##x##_crystalhd_decoder = { \
1042         .name           = #x "_crystalhd", \
1043         .long_name      = NULL_IF_CONFIG_SMALL("CrystalHD " #X " decoder"), \
1044         .type           = AVMEDIA_TYPE_VIDEO, \
1045         .id             = AV_CODEC_ID_##X, \
1046         .priv_data_size = sizeof(CHDContext), \
1047         .priv_class     = &x##_crystalhd_class, \
1048         .init           = init, \
1049         .close          = uninit, \
1050         .send_packet    = crystalhd_decode_packet, \
1051         .receive_frame  = crystalhd_receive_frame, \
1052         .flush          = flush, \
1053         .capabilities   = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AVOID_PROBING, \
1054         .pix_fmts       = (const enum AVPixelFormat[]){AV_PIX_FMT_YUYV422, AV_PIX_FMT_NONE}, \
1055     };
1056
1057 #if CONFIG_H264_CRYSTALHD_DECODER
1058 DEFINE_CRYSTALHD_DECODER(h264, H264)
1059 #endif
1060
1061 #if CONFIG_MPEG2_CRYSTALHD_DECODER
1062 DEFINE_CRYSTALHD_DECODER(mpeg2, MPEG2VIDEO)
1063 #endif
1064
1065 #if CONFIG_MPEG4_CRYSTALHD_DECODER
1066 DEFINE_CRYSTALHD_DECODER(mpeg4, MPEG4)
1067 #endif
1068
1069 #if CONFIG_MSMPEG4_CRYSTALHD_DECODER
1070 DEFINE_CRYSTALHD_DECODER(msmpeg4, MSMPEG4V3)
1071 #endif
1072
1073 #if CONFIG_VC1_CRYSTALHD_DECODER
1074 DEFINE_CRYSTALHD_DECODER(vc1, VC1)
1075 #endif
1076
1077 #if CONFIG_WMV3_CRYSTALHD_DECODER
1078 DEFINE_CRYSTALHD_DECODER(wmv3, WMV3)
1079 #endif