CrystalHD: Remove EXPERIMENTAL flag for known good formats.
[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 outputing
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 #include <unistd.h>
81
82 #include <libcrystalhd/bc_dts_types.h>
83 #include <libcrystalhd/bc_dts_defs.h>
84 #include <libcrystalhd/libcrystalhd_if.h>
85
86 #include "avcodec.h"
87 #include "h264.h"
88 #include "libavutil/imgutils.h"
89 #include "libavutil/intreadwrite.h"
90 #include "libavutil/opt.h"
91
92 /** Timeout parameter passed to DtsProcOutput() in us */
93 #define OUTPUT_PROC_TIMEOUT 50
94 /** Step between fake timestamps passed to hardware in units of 100ns */
95 #define TIMESTAMP_UNIT 100000
96 /** Initial value in us of the wait in decode() */
97 #define BASE_WAIT 10000
98 /** Increment in us to adjust wait in decode() */
99 #define WAIT_UNIT 1000
100
101
102 /*****************************************************************************
103  * Module private data
104  ****************************************************************************/
105
106 typedef enum {
107     RET_ERROR           = -1,
108     RET_OK              = 0,
109     RET_COPY_AGAIN      = 1,
110     RET_SKIP_NEXT_COPY  = 2,
111     RET_COPY_NEXT_FIELD = 3,
112 } CopyRet;
113
114 typedef struct OpaqueList {
115     struct OpaqueList *next;
116     uint64_t fake_timestamp;
117     uint64_t reordered_opaque;
118     uint8_t pic_type;
119 } OpaqueList;
120
121 typedef struct {
122     AVClass *av_class;
123     AVCodecContext *avctx;
124     AVFrame pic;
125     HANDLE dev;
126
127     uint8_t *orig_extradata;
128     uint32_t orig_extradata_size;
129
130     AVBitStreamFilterContext *bsfc;
131     AVCodecParserContext *parser;
132
133     uint8_t is_70012;
134     uint8_t *sps_pps_buf;
135     uint32_t sps_pps_size;
136     uint8_t is_nal;
137     uint8_t output_ready;
138     uint8_t need_second_field;
139     uint8_t skip_next_output;
140     uint64_t decode_wait;
141
142     uint64_t last_picture;
143
144     OpaqueList *head;
145     OpaqueList *tail;
146
147     /* Options */
148     uint32_t sWidth;
149     uint8_t bframe_bug;
150 } CHDContext;
151
152 static const AVOption options[] = {
153     { "crystalhd_downscale_width",
154       "Turn on downscaling to the specified width",
155       offsetof(CHDContext, sWidth),
156       AV_OPT_TYPE_INT, 0, 0, UINT32_MAX,
157       AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM, },
158     { NULL, },
159 };
160
161
162 /*****************************************************************************
163  * Helper functions
164  ****************************************************************************/
165
166 static inline BC_MEDIA_SUBTYPE id2subtype(CHDContext *priv, enum CodecID id)
167 {
168     switch (id) {
169     case CODEC_ID_MPEG4:
170         return BC_MSUBTYPE_DIVX;
171     case CODEC_ID_MSMPEG4V3:
172         return BC_MSUBTYPE_DIVX311;
173     case CODEC_ID_MPEG2VIDEO:
174         return BC_MSUBTYPE_MPEG2VIDEO;
175     case CODEC_ID_VC1:
176         return BC_MSUBTYPE_VC1;
177     case CODEC_ID_WMV3:
178         return BC_MSUBTYPE_WMV3;
179     case CODEC_ID_H264:
180         return priv->is_nal ? BC_MSUBTYPE_AVC1 : BC_MSUBTYPE_H264;
181     default:
182         return BC_MSUBTYPE_INVALID;
183     }
184 }
185
186 static inline void print_frame_info(CHDContext *priv, BC_DTS_PROC_OUT *output)
187 {
188     av_log(priv->avctx, AV_LOG_VERBOSE, "\tYBuffSz: %u\n", output->YbuffSz);
189     av_log(priv->avctx, AV_LOG_VERBOSE, "\tYBuffDoneSz: %u\n",
190            output->YBuffDoneSz);
191     av_log(priv->avctx, AV_LOG_VERBOSE, "\tUVBuffDoneSz: %u\n",
192            output->UVBuffDoneSz);
193     av_log(priv->avctx, AV_LOG_VERBOSE, "\tTimestamp: %"PRIu64"\n",
194            output->PicInfo.timeStamp);
195     av_log(priv->avctx, AV_LOG_VERBOSE, "\tPicture Number: %u\n",
196            output->PicInfo.picture_number);
197     av_log(priv->avctx, AV_LOG_VERBOSE, "\tWidth: %u\n",
198            output->PicInfo.width);
199     av_log(priv->avctx, AV_LOG_VERBOSE, "\tHeight: %u\n",
200            output->PicInfo.height);
201     av_log(priv->avctx, AV_LOG_VERBOSE, "\tChroma: 0x%03x\n",
202            output->PicInfo.chroma_format);
203     av_log(priv->avctx, AV_LOG_VERBOSE, "\tPulldown: %u\n",
204            output->PicInfo.pulldown);
205     av_log(priv->avctx, AV_LOG_VERBOSE, "\tFlags: 0x%08x\n",
206            output->PicInfo.flags);
207     av_log(priv->avctx, AV_LOG_VERBOSE, "\tFrame Rate/Res: %u\n",
208            output->PicInfo.frame_rate);
209     av_log(priv->avctx, AV_LOG_VERBOSE, "\tAspect Ratio: %u\n",
210            output->PicInfo.aspect_ratio);
211     av_log(priv->avctx, AV_LOG_VERBOSE, "\tColor Primaries: %u\n",
212            output->PicInfo.colour_primaries);
213     av_log(priv->avctx, AV_LOG_VERBOSE, "\tMetaData: %u\n",
214            output->PicInfo.picture_meta_payload);
215     av_log(priv->avctx, AV_LOG_VERBOSE, "\tSession Number: %u\n",
216            output->PicInfo.sess_num);
217     av_log(priv->avctx, AV_LOG_VERBOSE, "\tycom: %u\n",
218            output->PicInfo.ycom);
219     av_log(priv->avctx, AV_LOG_VERBOSE, "\tCustom Aspect: %u\n",
220            output->PicInfo.custom_aspect_ratio_width_height);
221     av_log(priv->avctx, AV_LOG_VERBOSE, "\tFrames to Drop: %u\n",
222            output->PicInfo.n_drop);
223     av_log(priv->avctx, AV_LOG_VERBOSE, "\tH264 Valid Fields: 0x%08x\n",
224            output->PicInfo.other.h264.valid);
225 }
226
227
228 /*****************************************************************************
229  * OpaqueList functions
230  ****************************************************************************/
231
232 static uint64_t opaque_list_push(CHDContext *priv, uint64_t reordered_opaque,
233                                  uint8_t pic_type)
234 {
235     OpaqueList *newNode = av_mallocz(sizeof (OpaqueList));
236     if (!newNode) {
237         av_log(priv->avctx, AV_LOG_ERROR,
238                "Unable to allocate new node in OpaqueList.\n");
239         return 0;
240     }
241     if (!priv->head) {
242         newNode->fake_timestamp = TIMESTAMP_UNIT;
243         priv->head              = newNode;
244     } else {
245         newNode->fake_timestamp = priv->tail->fake_timestamp + TIMESTAMP_UNIT;
246         priv->tail->next        = newNode;
247     }
248     priv->tail = newNode;
249     newNode->reordered_opaque = reordered_opaque;
250     newNode->pic_type = pic_type;
251
252     return newNode->fake_timestamp;
253 }
254
255 /*
256  * The OpaqueList is built in decode order, while elements will be removed
257  * in presentation order. If frames are reordered, this means we must be
258  * able to remove elements that are not the first element.
259  *
260  * Returned node must be freed by caller.
261  */
262 static OpaqueList *opaque_list_pop(CHDContext *priv, uint64_t fake_timestamp)
263 {
264     OpaqueList *node = priv->head;
265
266     if (!priv->head) {
267         av_log(priv->avctx, AV_LOG_ERROR,
268                "CrystalHD: Attempted to query non-existent timestamps.\n");
269         return NULL;
270     }
271
272     /*
273      * The first element is special-cased because we have to manipulate
274      * the head pointer rather than the previous element in the list.
275      */
276     if (priv->head->fake_timestamp == fake_timestamp) {
277         priv->head = node->next;
278
279         if (!priv->head->next)
280             priv->tail = priv->head;
281
282         node->next = NULL;
283         return node;
284     }
285
286     /*
287      * The list is processed at arm's length so that we have the
288      * previous element available to rewrite its next pointer.
289      */
290     while (node->next) {
291         OpaqueList *current = node->next;
292         if (current->fake_timestamp == fake_timestamp) {
293             node->next = current->next;
294
295             if (!node->next)
296                priv->tail = node;
297
298             current->next = NULL;
299             return current;
300         } else {
301             node = current;
302         }
303     }
304
305     av_log(priv->avctx, AV_LOG_VERBOSE,
306            "CrystalHD: Couldn't match fake_timestamp.\n");
307     return NULL;
308 }
309
310
311 /*****************************************************************************
312  * Video decoder API function definitions
313  ****************************************************************************/
314
315 static void flush(AVCodecContext *avctx)
316 {
317     CHDContext *priv = avctx->priv_data;
318
319     avctx->has_b_frames     = 0;
320     priv->last_picture      = -1;
321     priv->output_ready      = 0;
322     priv->need_second_field = 0;
323     priv->skip_next_output  = 0;
324     priv->decode_wait       = BASE_WAIT;
325
326     if (priv->pic.data[0])
327         avctx->release_buffer(avctx, &priv->pic);
328
329     /* Flush mode 4 flushes all software and hardware buffers. */
330     DtsFlushInput(priv->dev, 4);
331 }
332
333
334 static av_cold int uninit(AVCodecContext *avctx)
335 {
336     CHDContext *priv = avctx->priv_data;
337     HANDLE device;
338
339     device = priv->dev;
340     DtsStopDecoder(device);
341     DtsCloseDecoder(device);
342     DtsDeviceClose(device);
343
344     /*
345      * Restore original extradata, so that if the decoder is
346      * reinitialised, the bitstream detection and filtering
347      * will work as expected.
348      */
349     if (priv->orig_extradata) {
350         av_free(avctx->extradata);
351         avctx->extradata = priv->orig_extradata;
352         avctx->extradata_size = priv->orig_extradata_size;
353         priv->orig_extradata = NULL;
354         priv->orig_extradata_size = 0;
355     }
356
357     av_parser_close(priv->parser);
358     if (priv->bsfc) {
359         av_bitstream_filter_close(priv->bsfc);
360     }
361
362     av_free(priv->sps_pps_buf);
363
364     if (priv->pic.data[0])
365         avctx->release_buffer(avctx, &priv->pic);
366
367     if (priv->head) {
368        OpaqueList *node = priv->head;
369        while (node) {
370           OpaqueList *next = node->next;
371           av_free(node);
372           node = next;
373        }
374     }
375
376     return 0;
377 }
378
379
380 static av_cold int init(AVCodecContext *avctx)
381 {
382     CHDContext* priv;
383     BC_STATUS ret;
384     BC_INFO_CRYSTAL version;
385     BC_INPUT_FORMAT format = {
386         .FGTEnable   = FALSE,
387         .Progressive = TRUE,
388         .OptFlags    = 0x80000000 | vdecFrameRate59_94 | 0x40,
389         .width       = avctx->width,
390         .height      = avctx->height,
391     };
392
393     BC_MEDIA_SUBTYPE subtype;
394
395     uint32_t mode = DTS_PLAYBACK_MODE |
396                     DTS_LOAD_FILE_PLAY_FW |
397                     DTS_SKIP_TX_CHK_CPB |
398                     DTS_PLAYBACK_DROP_RPT_MODE |
399                     DTS_SINGLE_THREADED_MODE |
400                     DTS_DFLT_RESOLUTION(vdecRESOLUTION_1080p23_976);
401
402     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD Init for %s\n",
403            avctx->codec->name);
404
405     avctx->pix_fmt = PIX_FMT_YUYV422;
406
407     /* Initialize the library */
408     priv               = avctx->priv_data;
409     priv->avctx        = avctx;
410     priv->is_nal       = avctx->extradata_size > 0 && *(avctx->extradata) == 1;
411     priv->last_picture = -1;
412     priv->decode_wait  = BASE_WAIT;
413
414     subtype = id2subtype(priv, avctx->codec->id);
415     switch (subtype) {
416     case BC_MSUBTYPE_AVC1:
417         {
418             uint8_t *dummy_p;
419             int dummy_int;
420
421             /* Back up the extradata so it can be restored at close time. */
422             priv->orig_extradata = av_malloc(avctx->extradata_size);
423             if (!priv->orig_extradata) {
424                 av_log(avctx, AV_LOG_ERROR,
425                        "Failed to allocate copy of extradata\n");
426                 return AVERROR(ENOMEM);
427             }
428             priv->orig_extradata_size = avctx->extradata_size;
429             memcpy(priv->orig_extradata, avctx->extradata, avctx->extradata_size);
430
431             priv->bsfc = av_bitstream_filter_init("h264_mp4toannexb");
432             if (!priv->bsfc) {
433                 av_log(avctx, AV_LOG_ERROR,
434                        "Cannot open the h264_mp4toannexb BSF!\n");
435                 return AVERROR_BSF_NOT_FOUND;
436             }
437             av_bitstream_filter_filter(priv->bsfc, avctx, NULL, &dummy_p,
438                                        &dummy_int, NULL, 0, 0);
439         }
440         subtype = BC_MSUBTYPE_H264;
441         // Fall-through
442     case BC_MSUBTYPE_H264:
443         format.startCodeSz = 4;
444         // Fall-through
445     case BC_MSUBTYPE_VC1:
446     case BC_MSUBTYPE_WVC1:
447     case BC_MSUBTYPE_WMV3:
448     case BC_MSUBTYPE_WMVA:
449     case BC_MSUBTYPE_MPEG2VIDEO:
450     case BC_MSUBTYPE_DIVX:
451     case BC_MSUBTYPE_DIVX311:
452         format.pMetaData  = avctx->extradata;
453         format.metaDataSz = avctx->extradata_size;
454         break;
455     default:
456         av_log(avctx, AV_LOG_ERROR, "CrystalHD: Unknown codec name\n");
457         return AVERROR(EINVAL);
458     }
459     format.mSubtype = subtype;
460
461     if (priv->sWidth) {
462         format.bEnableScaling = 1;
463         format.ScalingParams.sWidth = priv->sWidth;
464     }
465
466     /* Get a decoder instance */
467     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: starting up\n");
468     // Initialize the Link and Decoder devices
469     ret = DtsDeviceOpen(&priv->dev, mode);
470     if (ret != BC_STS_SUCCESS) {
471         av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: DtsDeviceOpen failed\n");
472         goto fail;
473     }
474
475     ret = DtsCrystalHDVersion(priv->dev, &version);
476     if (ret != BC_STS_SUCCESS) {
477         av_log(avctx, AV_LOG_VERBOSE,
478                "CrystalHD: DtsCrystalHDVersion failed\n");
479         goto fail;
480     }
481     priv->is_70012 = version.device == 0;
482
483     if (priv->is_70012 &&
484         (subtype == BC_MSUBTYPE_DIVX || subtype == BC_MSUBTYPE_DIVX311)) {
485         av_log(avctx, AV_LOG_VERBOSE,
486                "CrystalHD: BCM70012 doesn't support MPEG4-ASP/DivX/Xvid\n");
487         goto fail;
488     }
489
490     ret = DtsSetInputFormat(priv->dev, &format);
491     if (ret != BC_STS_SUCCESS) {
492         av_log(avctx, AV_LOG_ERROR, "CrystalHD: SetInputFormat failed\n");
493         goto fail;
494     }
495
496     ret = DtsOpenDecoder(priv->dev, BC_STREAM_TYPE_ES);
497     if (ret != BC_STS_SUCCESS) {
498         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsOpenDecoder failed\n");
499         goto fail;
500     }
501
502     ret = DtsSetColorSpace(priv->dev, OUTPUT_MODE422_YUY2);
503     if (ret != BC_STS_SUCCESS) {
504         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsSetColorSpace failed\n");
505         goto fail;
506     }
507     ret = DtsStartDecoder(priv->dev);
508     if (ret != BC_STS_SUCCESS) {
509         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsStartDecoder failed\n");
510         goto fail;
511     }
512     ret = DtsStartCapture(priv->dev);
513     if (ret != BC_STS_SUCCESS) {
514         av_log(avctx, AV_LOG_ERROR, "CrystalHD: DtsStartCapture failed\n");
515         goto fail;
516     }
517
518     if (avctx->codec->id == CODEC_ID_H264) {
519         priv->parser = av_parser_init(avctx->codec->id);
520         if (!priv->parser)
521             av_log(avctx, AV_LOG_WARNING,
522                    "Cannot open the h.264 parser! Interlaced h.264 content "
523                    "will not be detected reliably.\n");
524         priv->parser->flags = PARSER_FLAG_COMPLETE_FRAMES;
525     }
526     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Init complete.\n");
527
528     return 0;
529
530  fail:
531     uninit(avctx);
532     return -1;
533 }
534
535
536 static inline CopyRet copy_frame(AVCodecContext *avctx,
537                                  BC_DTS_PROC_OUT *output,
538                                  void *data, int *data_size)
539 {
540     BC_STATUS ret;
541     BC_DTS_STATUS decoder_status = { 0, };
542     uint8_t trust_interlaced;
543     uint8_t interlaced;
544
545     CHDContext *priv = avctx->priv_data;
546     int64_t pkt_pts  = AV_NOPTS_VALUE;
547     uint8_t pic_type = 0;
548
549     uint8_t bottom_field = (output->PicInfo.flags & VDEC_FLAG_BOTTOMFIELD) ==
550                            VDEC_FLAG_BOTTOMFIELD;
551     uint8_t bottom_first = !!(output->PicInfo.flags & VDEC_FLAG_BOTTOM_FIRST);
552
553     int width    = output->PicInfo.width;
554     int height   = output->PicInfo.height;
555     int bwidth;
556     uint8_t *src = output->Ybuff;
557     int sStride;
558     uint8_t *dst;
559     int dStride;
560
561     if (output->PicInfo.timeStamp != 0) {
562         OpaqueList *node = opaque_list_pop(priv, output->PicInfo.timeStamp);
563         if (node) {
564             pkt_pts = node->reordered_opaque;
565             pic_type = node->pic_type;
566             av_free(node);
567         } else {
568             /*
569              * We will encounter a situation where a timestamp cannot be
570              * popped if a second field is being returned. In this case,
571              * each field has the same timestamp and the first one will
572              * cause it to be popped. To keep subsequent calculations
573              * simple, pic_type should be set a FIELD value - doesn't
574              * matter which, but I chose BOTTOM.
575              */
576             pic_type = PICT_BOTTOM_FIELD;
577         }
578         av_log(avctx, AV_LOG_VERBOSE, "output \"pts\": %"PRIu64"\n",
579                output->PicInfo.timeStamp);
580         av_log(avctx, AV_LOG_VERBOSE, "output picture type %d\n",
581                pic_type);
582     }
583
584     ret = DtsGetDriverStatus(priv->dev, &decoder_status);
585     if (ret != BC_STS_SUCCESS) {
586         av_log(avctx, AV_LOG_ERROR,
587                "CrystalHD: GetDriverStatus failed: %u\n", ret);
588        return RET_ERROR;
589     }
590
591     /*
592      * For most content, we can trust the interlaced flag returned
593      * by the hardware, but sometimes we can't. These are the
594      * conditions under which we can trust the flag:
595      *
596      * 1) It's not h.264 content
597      * 2) The UNKNOWN_SRC flag is not set
598      * 3) We know we're expecting a second field
599      * 4) The hardware reports this picture and the next picture
600      *    have the same picture number.
601      *
602      * Note that there can still be interlaced content that will
603      * fail this check, if the hardware hasn't decoded the next
604      * picture or if there is a corruption in the stream. (In either
605      * case a 0 will be returned for the next picture number)
606      */
607     trust_interlaced = avctx->codec->id != CODEC_ID_H264 ||
608                        !(output->PicInfo.flags & VDEC_FLAG_UNKNOWN_SRC) ||
609                        priv->need_second_field ||
610                        (decoder_status.picNumFlags & ~0x40000000) ==
611                        output->PicInfo.picture_number;
612
613     /*
614      * If we got a false negative for trust_interlaced on the first field,
615      * we will realise our mistake here when we see that the picture number is that
616      * of the previous picture. We cannot recover the frame and should discard the
617      * second field to keep the correct number of output frames.
618      */
619     if (output->PicInfo.picture_number == priv->last_picture && !priv->need_second_field) {
620         av_log(avctx, AV_LOG_WARNING,
621                "Incorrectly guessed progressive frame. Discarding second field\n");
622         /* Returning without providing a picture. */
623         return RET_OK;
624     }
625
626     interlaced = (output->PicInfo.flags & VDEC_FLAG_INTERLACED_SRC) &&
627                  trust_interlaced;
628
629     if (!trust_interlaced && (decoder_status.picNumFlags & ~0x40000000) == 0) {
630         av_log(avctx, AV_LOG_VERBOSE,
631                "Next picture number unknown. Assuming progressive frame.\n");
632     }
633
634     av_log(avctx, AV_LOG_VERBOSE, "Interlaced state: %d | trust_interlaced %d\n",
635            interlaced, trust_interlaced);
636
637     if (priv->pic.data[0] && !priv->need_second_field)
638         avctx->release_buffer(avctx, &priv->pic);
639
640     priv->need_second_field = interlaced && !priv->need_second_field;
641
642     priv->pic.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE |
643                              FF_BUFFER_HINTS_REUSABLE;
644     if (!priv->pic.data[0]) {
645         if (avctx->get_buffer(avctx, &priv->pic) < 0) {
646             av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
647             return RET_ERROR;
648         }
649     }
650
651     bwidth = av_image_get_linesize(avctx->pix_fmt, width, 0);
652     if (priv->is_70012) {
653         int pStride;
654
655         if (width <= 720)
656             pStride = 720;
657         else if (width <= 1280)
658             pStride = 1280;
659         else if (width <= 1080)
660             pStride = 1080;
661         sStride = av_image_get_linesize(avctx->pix_fmt, pStride, 0);
662     } else {
663         sStride = bwidth;
664     }
665
666     dStride = priv->pic.linesize[0];
667     dst     = priv->pic.data[0];
668
669     av_log(priv->avctx, AV_LOG_VERBOSE, "CrystalHD: Copying out frame\n");
670
671     if (interlaced) {
672         int dY = 0;
673         int sY = 0;
674
675         height /= 2;
676         if (bottom_field) {
677             av_log(priv->avctx, AV_LOG_VERBOSE, "Interlaced: bottom field\n");
678             dY = 1;
679         } else {
680             av_log(priv->avctx, AV_LOG_VERBOSE, "Interlaced: top field\n");
681             dY = 0;
682         }
683
684         for (sY = 0; sY < height; dY++, sY++) {
685             memcpy(&(dst[dY * dStride]), &(src[sY * sStride]), bwidth);
686             dY++;
687         }
688     } else {
689         av_image_copy_plane(dst, dStride, src, sStride, bwidth, height);
690     }
691
692     priv->pic.interlaced_frame = interlaced;
693     if (interlaced)
694         priv->pic.top_field_first = !bottom_first;
695
696     priv->pic.pkt_pts = pkt_pts;
697
698     if (!priv->need_second_field) {
699         *data_size       = sizeof(AVFrame);
700         *(AVFrame *)data = priv->pic;
701     }
702
703     /*
704      * Two types of PAFF content have been observed. One form causes the
705      * hardware to return a field pair and the other individual fields,
706      * even though the input is always individual fields. We must skip
707      * copying on the next decode() call to maintain pipeline length in
708      * the first case.
709      */
710     if (!interlaced && (output->PicInfo.flags & VDEC_FLAG_UNKNOWN_SRC) &&
711         (pic_type == PICT_TOP_FIELD || pic_type == PICT_BOTTOM_FIELD)) {
712         av_log(priv->avctx, AV_LOG_VERBOSE, "Fieldpair from two packets.\n");
713         return RET_SKIP_NEXT_COPY;
714     }
715
716     /*
717      * Testing has shown that in all cases where we don't want to return the
718      * full frame immediately, VDEC_FLAG_UNKNOWN_SRC is set.
719      */
720     return priv->need_second_field &&
721            !(output->PicInfo.flags & VDEC_FLAG_UNKNOWN_SRC) ?
722            RET_COPY_NEXT_FIELD : RET_OK;
723 }
724
725
726 static inline CopyRet receive_frame(AVCodecContext *avctx,
727                                     void *data, int *data_size)
728 {
729     BC_STATUS ret;
730     BC_DTS_PROC_OUT output = {
731         .PicInfo.width  = avctx->width,
732         .PicInfo.height = avctx->height,
733     };
734     CHDContext *priv = avctx->priv_data;
735     HANDLE dev       = priv->dev;
736
737     *data_size = 0;
738
739     // Request decoded data from the driver
740     ret = DtsProcOutputNoCopy(dev, OUTPUT_PROC_TIMEOUT, &output);
741     if (ret == BC_STS_FMT_CHANGE) {
742         av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Initial format change\n");
743         avctx->width  = output.PicInfo.width;
744         avctx->height = output.PicInfo.height;
745         return RET_COPY_AGAIN;
746     } else if (ret == BC_STS_SUCCESS) {
747         int copy_ret = -1;
748         if (output.PoutFlags & BC_POUT_FLAGS_PIB_VALID) {
749             if (priv->last_picture == -1) {
750                 /*
751                  * Init to one less, so that the incrementing code doesn't
752                  * need to be special-cased.
753                  */
754                 priv->last_picture = output.PicInfo.picture_number - 1;
755             }
756
757             if (avctx->codec->id == CODEC_ID_MPEG4 &&
758                 output.PicInfo.timeStamp == 0 && priv->bframe_bug) {
759                 av_log(avctx, AV_LOG_VERBOSE,
760                        "CrystalHD: Not returning packed frame twice.\n");
761                 priv->last_picture++;
762                 DtsReleaseOutputBuffs(dev, NULL, FALSE);
763                 return RET_COPY_AGAIN;
764             }
765
766             print_frame_info(priv, &output);
767
768             if (priv->last_picture + 1 < output.PicInfo.picture_number) {
769                 av_log(avctx, AV_LOG_WARNING,
770                        "CrystalHD: Picture Number discontinuity\n");
771                 /*
772                  * Have we lost frames? If so, we need to shrink the
773                  * pipeline length appropriately.
774                  *
775                  * XXX: I have no idea what the semantics of this situation
776                  * are so I don't even know if we've lost frames or which
777                  * ones.
778                  *
779                  * In any case, only warn the first time.
780                  */
781                priv->last_picture = output.PicInfo.picture_number - 1;
782             }
783
784             copy_ret = copy_frame(avctx, &output, data, data_size);
785             if (*data_size > 0) {
786                 avctx->has_b_frames--;
787                 priv->last_picture++;
788                 av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Pipeline length: %u\n",
789                        avctx->has_b_frames);
790             }
791         } else {
792             /*
793              * An invalid frame has been consumed.
794              */
795             av_log(avctx, AV_LOG_ERROR, "CrystalHD: ProcOutput succeeded with "
796                                         "invalid PIB\n");
797             avctx->has_b_frames--;
798             copy_ret = RET_OK;
799         }
800         DtsReleaseOutputBuffs(dev, NULL, FALSE);
801
802         return copy_ret;
803     } else if (ret == BC_STS_BUSY) {
804         return RET_COPY_AGAIN;
805     } else {
806         av_log(avctx, AV_LOG_ERROR, "CrystalHD: ProcOutput failed %d\n", ret);
807         return RET_ERROR;
808     }
809 }
810
811
812 static int decode(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
813 {
814     BC_STATUS ret;
815     BC_DTS_STATUS decoder_status = { 0, };
816     CopyRet rec_ret;
817     CHDContext *priv   = avctx->priv_data;
818     HANDLE dev         = priv->dev;
819     uint8_t *in_data   = avpkt->data;
820     int len            = avpkt->size;
821     int free_data      = 0;
822     uint8_t pic_type   = 0;
823
824     av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: decode_frame\n");
825
826     if (avpkt->size == 7 && !priv->bframe_bug) {
827         /*
828          * The use of a drop frame triggers the bug
829          */
830         av_log(avctx, AV_LOG_INFO,
831                "CrystalHD: Enabling work-around for packed b-frame bug\n");
832         priv->bframe_bug = 1;
833     } else if (avpkt->size == 8 && priv->bframe_bug) {
834         /*
835          * Delay frames don't trigger the bug
836          */
837         av_log(avctx, AV_LOG_INFO,
838                "CrystalHD: Disabling work-around for packed b-frame bug\n");
839         priv->bframe_bug = 0;
840     }
841
842     if (len) {
843         int32_t tx_free = (int32_t)DtsTxFreeSize(dev);
844
845         if (priv->parser) {
846             int ret = 0;
847
848             if (priv->bsfc) {
849                 ret = av_bitstream_filter_filter(priv->bsfc, avctx, NULL,
850                                                  &in_data, &len,
851                                                  avpkt->data, len, 0);
852             }
853             free_data = ret > 0;
854
855             if (ret >= 0) {
856                 uint8_t *pout;
857                 int psize;
858                 int index;
859                 H264Context *h = priv->parser->priv_data;
860
861                 index = av_parser_parse2(priv->parser, avctx, &pout, &psize,
862                                          in_data, len, avctx->pkt->pts,
863                                          avctx->pkt->dts, 0);
864                 if (index < 0) {
865                     av_log(avctx, AV_LOG_WARNING,
866                            "CrystalHD: Failed to parse h.264 packet to "
867                            "detect interlacing.\n");
868                 } else if (index != len) {
869                     av_log(avctx, AV_LOG_WARNING,
870                            "CrystalHD: Failed to parse h.264 packet "
871                            "completely. Interlaced frames may be "
872                            "incorrectly detected\n.");
873                 } else {
874                     av_log(avctx, AV_LOG_VERBOSE,
875                            "CrystalHD: parser picture type %d\n",
876                            h->s.picture_structure);
877                     pic_type = h->s.picture_structure;
878                 }
879             } else {
880                 av_log(avctx, AV_LOG_WARNING,
881                        "CrystalHD: mp4toannexb filter failed to filter "
882                        "packet. Interlaced frames may be incorrectly "
883                        "detected.\n");
884             }
885         }
886
887         if (len < tx_free - 1024) {
888             /*
889              * Despite being notionally opaque, either libcrystalhd or
890              * the hardware itself will mangle pts values that are too
891              * small or too large. The docs claim it should be in units
892              * of 100ns. Given that we're nominally dealing with a black
893              * box on both sides, any transform we do has no guarantee of
894              * avoiding mangling so we need to build a mapping to values
895              * we know will not be mangled.
896              */
897             uint64_t pts = opaque_list_push(priv, avctx->pkt->pts, pic_type);
898             if (!pts) {
899                 if (free_data) {
900                     av_freep(&in_data);
901                 }
902                 return AVERROR(ENOMEM);
903             }
904             av_log(priv->avctx, AV_LOG_VERBOSE,
905                    "input \"pts\": %"PRIu64"\n", pts);
906             ret = DtsProcInput(dev, in_data, len, pts, 0);
907             if (free_data) {
908                 av_freep(&in_data);
909             }
910             if (ret == BC_STS_BUSY) {
911                 av_log(avctx, AV_LOG_WARNING,
912                        "CrystalHD: ProcInput returned busy\n");
913                 usleep(BASE_WAIT);
914                 return AVERROR(EBUSY);
915             } else if (ret != BC_STS_SUCCESS) {
916                 av_log(avctx, AV_LOG_ERROR,
917                        "CrystalHD: ProcInput failed: %u\n", ret);
918                 return -1;
919             }
920             avctx->has_b_frames++;
921         } else {
922             av_log(avctx, AV_LOG_WARNING, "CrystalHD: Input buffer full\n");
923             len = 0; // We didn't consume any bytes.
924         }
925     } else {
926         av_log(avctx, AV_LOG_INFO, "CrystalHD: No more input data\n");
927     }
928
929     if (priv->skip_next_output) {
930         av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Skipping next output.\n");
931         priv->skip_next_output = 0;
932         avctx->has_b_frames--;
933         return len;
934     }
935
936     ret = DtsGetDriverStatus(dev, &decoder_status);
937     if (ret != BC_STS_SUCCESS) {
938         av_log(avctx, AV_LOG_ERROR, "CrystalHD: GetDriverStatus failed\n");
939         return -1;
940     }
941
942     /*
943      * No frames ready. Don't try to extract.
944      *
945      * Empirical testing shows that ReadyListCount can be a damn lie,
946      * and ProcOut still fails when count > 0. The same testing showed
947      * that two more iterations were needed before ProcOutput would
948      * succeed.
949      */
950     if (priv->output_ready < 2) {
951         if (decoder_status.ReadyListCount != 0)
952             priv->output_ready++;
953         usleep(BASE_WAIT);
954         av_log(avctx, AV_LOG_INFO, "CrystalHD: Filling pipeline.\n");
955         return len;
956     } else if (decoder_status.ReadyListCount == 0) {
957         /*
958          * After the pipeline is established, if we encounter a lack of frames
959          * that probably means we're not giving the hardware enough time to
960          * decode them, so start increasing the wait time at the end of a
961          * decode call.
962          */
963         usleep(BASE_WAIT);
964         priv->decode_wait += WAIT_UNIT;
965         av_log(avctx, AV_LOG_INFO, "CrystalHD: No frames ready. Returning\n");
966         return len;
967     }
968
969     do {
970         rec_ret = receive_frame(avctx, data, data_size);
971         if (rec_ret == RET_OK && *data_size == 0) {
972             /*
973              * This case is for when the encoded fields are stored
974              * separately and we get a separate avpkt for each one. To keep
975              * the pipeline stable, we should return nothing and wait for
976              * the next time round to grab the second field.
977              * H.264 PAFF is an example of this.
978              */
979             av_log(avctx, AV_LOG_VERBOSE, "Returning after first field.\n");
980             avctx->has_b_frames--;
981         } else if (rec_ret == RET_COPY_NEXT_FIELD) {
982             /*
983              * This case is for when the encoded fields are stored in a
984              * single avpkt but the hardware returns then separately. Unless
985              * we grab the second field before returning, we'll slip another
986              * frame in the pipeline and if that happens a lot, we're sunk.
987              * So we have to get that second field now.
988              * Interlaced mpeg2 and vc1 are examples of this.
989              */
990             av_log(avctx, AV_LOG_VERBOSE, "Trying to get second field.\n");
991             while (1) {
992                 usleep(priv->decode_wait);
993                 ret = DtsGetDriverStatus(dev, &decoder_status);
994                 if (ret == BC_STS_SUCCESS &&
995                     decoder_status.ReadyListCount > 0) {
996                     rec_ret = receive_frame(avctx, data, data_size);
997                     if ((rec_ret == RET_OK && *data_size > 0) ||
998                         rec_ret == RET_ERROR)
999                         break;
1000                 }
1001             }
1002             av_log(avctx, AV_LOG_VERBOSE, "CrystalHD: Got second field.\n");
1003         } else if (rec_ret == RET_SKIP_NEXT_COPY) {
1004             /*
1005              * Two input packets got turned into a field pair. Gawd.
1006              */
1007             av_log(avctx, AV_LOG_VERBOSE,
1008                    "Don't output on next decode call.\n");
1009             priv->skip_next_output = 1;
1010         }
1011         /*
1012          * If rec_ret == RET_COPY_AGAIN, that means that either we just handled
1013          * a FMT_CHANGE event and need to go around again for the actual frame,
1014          * we got a busy status and need to try again, or we're dealing with
1015          * packed b-frames, where the hardware strangely returns the packed
1016          * p-frame twice. We choose to keep the second copy as it carries the
1017          * valid pts.
1018          */
1019     } while (rec_ret == RET_COPY_AGAIN);
1020     usleep(priv->decode_wait);
1021     return len;
1022 }
1023
1024
1025 #if CONFIG_H264_CRYSTALHD_DECODER
1026 static AVClass h264_class = {
1027     "h264_crystalhd",
1028     av_default_item_name,
1029     options,
1030     LIBAVUTIL_VERSION_INT,
1031 };
1032
1033 AVCodec ff_h264_crystalhd_decoder = {
1034     .name           = "h264_crystalhd",
1035     .type           = AVMEDIA_TYPE_VIDEO,
1036     .id             = CODEC_ID_H264,
1037     .priv_data_size = sizeof(CHDContext),
1038     .init           = init,
1039     .close          = uninit,
1040     .decode         = decode,
1041     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_DELAY,
1042     .flush          = flush,
1043     .long_name      = NULL_IF_CONFIG_SMALL("H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 (CrystalHD acceleration)"),
1044     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_YUYV422, PIX_FMT_NONE},
1045     .priv_class     = &h264_class,
1046 };
1047 #endif
1048
1049 #if CONFIG_MPEG2_CRYSTALHD_DECODER
1050 static AVClass mpeg2_class = {
1051     "mpeg2_crystalhd",
1052     av_default_item_name,
1053     options,
1054     LIBAVUTIL_VERSION_INT,
1055 };
1056
1057 AVCodec ff_mpeg2_crystalhd_decoder = {
1058     .name           = "mpeg2_crystalhd",
1059     .type           = AVMEDIA_TYPE_VIDEO,
1060     .id             = CODEC_ID_MPEG2VIDEO,
1061     .priv_data_size = sizeof(CHDContext),
1062     .init           = init,
1063     .close          = uninit,
1064     .decode         = decode,
1065     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_DELAY,
1066     .flush          = flush,
1067     .long_name      = NULL_IF_CONFIG_SMALL("MPEG-2 Video (CrystalHD acceleration)"),
1068     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_YUYV422, PIX_FMT_NONE},
1069     .priv_class     = &mpeg2_class,
1070 };
1071 #endif
1072
1073 #if CONFIG_MPEG4_CRYSTALHD_DECODER
1074 static AVClass mpeg4_class = {
1075     "mpeg4_crystalhd",
1076     av_default_item_name,
1077     options,
1078     LIBAVUTIL_VERSION_INT,
1079 };
1080
1081 AVCodec ff_mpeg4_crystalhd_decoder = {
1082     .name           = "mpeg4_crystalhd",
1083     .type           = AVMEDIA_TYPE_VIDEO,
1084     .id             = CODEC_ID_MPEG4,
1085     .priv_data_size = sizeof(CHDContext),
1086     .init           = init,
1087     .close          = uninit,
1088     .decode         = decode,
1089     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_DELAY,
1090     .flush          = flush,
1091     .long_name      = NULL_IF_CONFIG_SMALL("MPEG-4 Part 2 (CrystalHD acceleration)"),
1092     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_YUYV422, PIX_FMT_NONE},
1093     .priv_class     = &mpeg4_class,
1094 };
1095 #endif
1096
1097 #if CONFIG_MSMPEG4_CRYSTALHD_DECODER
1098 static AVClass msmpeg4_class = {
1099     "msmpeg4_crystalhd",
1100     av_default_item_name,
1101     options,
1102     LIBAVUTIL_VERSION_INT,
1103 };
1104
1105 AVCodec ff_msmpeg4_crystalhd_decoder = {
1106     .name           = "msmpeg4_crystalhd",
1107     .type           = AVMEDIA_TYPE_VIDEO,
1108     .id             = CODEC_ID_MSMPEG4V3,
1109     .priv_data_size = sizeof(CHDContext),
1110     .init           = init,
1111     .close          = uninit,
1112     .decode         = decode,
1113     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_DELAY | CODEC_CAP_EXPERIMENTAL,
1114     .flush          = flush,
1115     .long_name      = NULL_IF_CONFIG_SMALL("MPEG-4 Part 2 Microsoft variant version 3 (CrystalHD acceleration)"),
1116     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_YUYV422, PIX_FMT_NONE},
1117     .priv_class     = &msmpeg4_class,
1118 };
1119 #endif
1120
1121 #if CONFIG_VC1_CRYSTALHD_DECODER
1122 static AVClass vc1_class = {
1123     "vc1_crystalhd",
1124     av_default_item_name,
1125     options,
1126     LIBAVUTIL_VERSION_INT,
1127 };
1128
1129 AVCodec ff_vc1_crystalhd_decoder = {
1130     .name           = "vc1_crystalhd",
1131     .type           = AVMEDIA_TYPE_VIDEO,
1132     .id             = CODEC_ID_VC1,
1133     .priv_data_size = sizeof(CHDContext),
1134     .init           = init,
1135     .close          = uninit,
1136     .decode         = decode,
1137     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_DELAY,
1138     .flush          = flush,
1139     .long_name      = NULL_IF_CONFIG_SMALL("SMPTE VC-1 (CrystalHD acceleration)"),
1140     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_YUYV422, PIX_FMT_NONE},
1141     .priv_class     = &vc1_class,
1142 };
1143 #endif
1144
1145 #if CONFIG_WMV3_CRYSTALHD_DECODER
1146 static AVClass wmv3_class = {
1147     "wmv3_crystalhd",
1148     av_default_item_name,
1149     options,
1150     LIBAVUTIL_VERSION_INT,
1151 };
1152
1153 AVCodec ff_wmv3_crystalhd_decoder = {
1154     .name           = "wmv3_crystalhd",
1155     .type           = AVMEDIA_TYPE_VIDEO,
1156     .id             = CODEC_ID_WMV3,
1157     .priv_data_size = sizeof(CHDContext),
1158     .init           = init,
1159     .close          = uninit,
1160     .decode         = decode,
1161     .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_DELAY,
1162     .flush          = flush,
1163     .long_name      = NULL_IF_CONFIG_SMALL("Windows Media Video 9 (CrystalHD acceleration)"),
1164     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_YUYV422, PIX_FMT_NONE},
1165     .priv_class     = &wmv3_class,
1166 };
1167 #endif