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