1/*
2 * DV decoder
3 * Copyright (c) 2002 Fabrice Bellard
4 * Copyright (c) 2004 Roman Shaposhnik
5 *
6 * 50 Mbps (DVCPRO50) support
7 * Copyright (c) 2006 Daniel Maas <dmaas@maasdigital.com>
8 *
9 * 100 Mbps (DVCPRO HD) support
10 * Initial code by Daniel Maas <dmaas@maasdigital.com> (funded by BBC R&D)
11 * Final code by Roman Shaposhnik
12 *
13 * Many thanks to Dan Dennedy <dan@dennedy.org> for providing wealth
14 * of DV technical info.
15 *
16 * This file is part of FFmpeg.
17 *
18 * FFmpeg is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU Lesser General Public
20 * License as published by the Free Software Foundation; either
21 * version 2.1 of the License, or (at your option) any later version.
22 *
23 * FFmpeg is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
26 * Lesser General Public License for more details.
27 *
28 * You should have received a copy of the GNU Lesser General Public
29 * License along with FFmpeg; if not, write to the Free Software
30 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31 */
32
33/**
34 * @file
35 * DV decoder
36 */
37
38#include "libavutil/avassert.h"
39#include "libavutil/internal.h"
40#include "libavutil/imgutils.h"
41#include "libavutil/pixdesc.h"
42#include "avcodec.h"
43#include "idctdsp.h"
44#include "internal.h"
45#include "get_bits.h"
46#include "put_bits.h"
47#include "simple_idct.h"
48#include "dvdata.h"
49#include "dv.h"
50
51typedef struct BlockInfo {
52    const uint32_t *factor_table;
53    const uint8_t *scan_table;
54    uint8_t pos; /* position in block */
55    void (*idct_put)(uint8_t *dest, int line_size, int16_t *block);
56    uint8_t partial_bit_count;
57    uint32_t partial_bit_buffer;
58    int shift_offset;
59} BlockInfo;
60
61static const int dv_iweight_bits = 14;
62
63static av_cold int dvvideo_decode_init(AVCodecContext *avctx)
64{
65    DVVideoContext *s = avctx->priv_data;
66    IDCTDSPContext idsp;
67    int i;
68
69    memset(&idsp,0, sizeof(idsp));
70    ff_idctdsp_init(&idsp, avctx);
71
72    for (i = 0; i < 64; i++)
73       s->dv_zigzag[0][i] = idsp.idct_permutation[ff_zigzag_direct[i]];
74
75    if (avctx->lowres){
76        for (i = 0; i < 64; i++){
77            int j = ff_dv_zigzag248_direct[i];
78            s->dv_zigzag[1][i] = idsp.idct_permutation[(j & 7) + (j & 8) * 4 + (j & 48) / 2];
79        }
80    }else
81        memcpy(s->dv_zigzag[1], ff_dv_zigzag248_direct, sizeof(s->dv_zigzag[1]));
82
83    s->idct_put[0] = idsp.idct_put;
84    s->idct_put[1] = ff_simple_idct248_put;
85
86    return ff_dvvideo_init(avctx);
87}
88
89/* decode AC coefficients */
90static void dv_decode_ac(GetBitContext *gb, BlockInfo *mb, int16_t *block)
91{
92    int last_index = gb->size_in_bits;
93    const uint8_t  *scan_table   = mb->scan_table;
94    const uint32_t *factor_table = mb->factor_table;
95    int pos               = mb->pos;
96    int partial_bit_count = mb->partial_bit_count;
97    int level, run, vlc_len, index;
98
99    OPEN_READER(re, gb);
100    UPDATE_CACHE(re, gb);
101
102    /* if we must parse a partial VLC, we do it here */
103    if (partial_bit_count > 0) {
104        re_cache = re_cache >> partial_bit_count | mb->partial_bit_buffer;
105        re_index -= partial_bit_count;
106        mb->partial_bit_count = 0;
107    }
108
109    /* get the AC coefficients until last_index is reached */
110    for (;;) {
111        av_dlog(NULL, "%2d: bits=%04x index=%d\n", pos, SHOW_UBITS(re, gb, 16),
112                re_index);
113        /* our own optimized GET_RL_VLC */
114        index   = NEG_USR32(re_cache, TEX_VLC_BITS);
115        vlc_len = ff_dv_rl_vlc[index].len;
116        if (vlc_len < 0) {
117            index = NEG_USR32((unsigned)re_cache << TEX_VLC_BITS, -vlc_len) +
118                    ff_dv_rl_vlc[index].level;
119            vlc_len = TEX_VLC_BITS - vlc_len;
120        }
121        level = ff_dv_rl_vlc[index].level;
122        run   = ff_dv_rl_vlc[index].run;
123
124        /* gotta check if we're still within gb boundaries */
125        if (re_index + vlc_len > last_index) {
126            /* should be < 16 bits otherwise a codeword could have been parsed */
127            mb->partial_bit_count = last_index - re_index;
128            mb->partial_bit_buffer = re_cache & ~(-1u >> mb->partial_bit_count);
129            re_index = last_index;
130            break;
131        }
132        re_index += vlc_len;
133
134        av_dlog(NULL, "run=%d level=%d\n", run, level);
135        pos += run;
136        if (pos >= 64)
137            break;
138
139        level = (level * factor_table[pos] + (1 << (dv_iweight_bits - 1))) >> dv_iweight_bits;
140        block[scan_table[pos]] = level;
141
142        UPDATE_CACHE(re, gb);
143    }
144    CLOSE_READER(re, gb);
145    mb->pos = pos;
146}
147
148static inline void bit_copy(PutBitContext *pb, GetBitContext *gb)
149{
150    int bits_left = get_bits_left(gb);
151    while (bits_left >= MIN_CACHE_BITS) {
152        put_bits(pb, MIN_CACHE_BITS, get_bits(gb, MIN_CACHE_BITS));
153        bits_left -= MIN_CACHE_BITS;
154    }
155    if (bits_left > 0) {
156        put_bits(pb, bits_left, get_bits(gb, bits_left));
157    }
158}
159
160/* mb_x and mb_y are in units of 8 pixels */
161static int dv_decode_video_segment(AVCodecContext *avctx, void *arg)
162{
163    DVVideoContext *s = avctx->priv_data;
164    DVwork_chunk *work_chunk = arg;
165    int quant, dc, dct_mode, class1, j;
166    int mb_index, mb_x, mb_y, last_index;
167    int y_stride, linesize;
168    int16_t *block, *block1;
169    int c_offset;
170    uint8_t *y_ptr;
171    const uint8_t *buf_ptr;
172    PutBitContext pb, vs_pb;
173    GetBitContext gb;
174    BlockInfo mb_data[5 * DV_MAX_BPM], *mb, *mb1;
175    LOCAL_ALIGNED_16(int16_t, sblock, [5*DV_MAX_BPM], [64]);
176    LOCAL_ALIGNED_16(uint8_t, mb_bit_buffer, [  80 + FF_INPUT_BUFFER_PADDING_SIZE]); /* allow some slack */
177    LOCAL_ALIGNED_16(uint8_t, vs_bit_buffer, [5*80 + FF_INPUT_BUFFER_PADDING_SIZE]); /* allow some slack */
178    const int log2_blocksize = 3-s->avctx->lowres;
179    int is_field_mode[5];
180
181    av_assert1((((int)mb_bit_buffer) & 7) == 0);
182    av_assert1((((int)vs_bit_buffer) & 7) == 0);
183
184    memset(sblock, 0, 5*DV_MAX_BPM*sizeof(*sblock));
185
186    /* pass 1: read DC and AC coefficients in blocks */
187    buf_ptr = &s->buf[work_chunk->buf_offset*80];
188    block1  = &sblock[0][0];
189    mb1     = mb_data;
190    init_put_bits(&vs_pb, vs_bit_buffer, 5 * 80);
191    for (mb_index = 0; mb_index < 5; mb_index++, mb1 += s->sys->bpm, block1 += s->sys->bpm * 64) {
192        /* skip header */
193        quant = buf_ptr[3] & 0x0f;
194        buf_ptr += 4;
195        init_put_bits(&pb, mb_bit_buffer, 80);
196        mb    = mb1;
197        block = block1;
198        is_field_mode[mb_index] = 0;
199        for (j = 0; j < s->sys->bpm; j++) {
200            last_index = s->sys->block_sizes[j];
201            init_get_bits(&gb, buf_ptr, last_index);
202
203            /* get the DC */
204            dc       = get_sbits(&gb, 9);
205            dct_mode = get_bits1(&gb);
206            class1   = get_bits(&gb, 2);
207            if (DV_PROFILE_IS_HD(s->sys)) {
208                mb->idct_put     = s->idct_put[0];
209                mb->scan_table   = s->dv_zigzag[0];
210                mb->factor_table = &s->idct_factor[(j >= 4)*4*16*64 + class1*16*64 + quant*64];
211                is_field_mode[mb_index] |= !j && dct_mode;
212            } else {
213                mb->idct_put     = s->idct_put[dct_mode && log2_blocksize == 3];
214                mb->scan_table   = s->dv_zigzag[dct_mode];
215                mb->factor_table = &s->idct_factor[(class1 == 3)*2*22*64 + dct_mode*22*64 +
216                                                        (quant + ff_dv_quant_offset[class1])*64];
217            }
218            dc = dc << 2;
219            /* convert to unsigned because 128 is not added in the
220               standard IDCT */
221            dc += 1024;
222            block[0] = dc;
223            buf_ptr += last_index >> 3;
224            mb->pos               = 0;
225            mb->partial_bit_count = 0;
226
227            av_dlog(avctx, "MB block: %d, %d ", mb_index, j);
228            dv_decode_ac(&gb, mb, block);
229
230            /* write the remaining bits in a new buffer only if the
231               block is finished */
232            if (mb->pos >= 64)
233                bit_copy(&pb, &gb);
234
235            block += 64;
236            mb++;
237        }
238
239        /* pass 2: we can do it just after */
240        av_dlog(avctx, "***pass 2 size=%d MB#=%d\n", put_bits_count(&pb), mb_index);
241        block = block1;
242        mb    = mb1;
243        init_get_bits(&gb, mb_bit_buffer, put_bits_count(&pb));
244        put_bits32(&pb, 0); // padding must be zeroed
245        flush_put_bits(&pb);
246        for (j = 0; j < s->sys->bpm; j++, block += 64, mb++) {
247            if (mb->pos < 64 && get_bits_left(&gb) > 0) {
248                dv_decode_ac(&gb, mb, block);
249                /* if still not finished, no need to parse other blocks */
250                if (mb->pos < 64)
251                    break;
252            }
253        }
254        /* all blocks are finished, so the extra bytes can be used at
255           the video segment level */
256        if (j >= s->sys->bpm)
257            bit_copy(&vs_pb, &gb);
258    }
259
260    /* we need a pass over the whole video segment */
261    av_dlog(avctx, "***pass 3 size=%d\n", put_bits_count(&vs_pb));
262    block = &sblock[0][0];
263    mb    = mb_data;
264    init_get_bits(&gb, vs_bit_buffer, put_bits_count(&vs_pb));
265    put_bits32(&vs_pb, 0); // padding must be zeroed
266    flush_put_bits(&vs_pb);
267    for (mb_index = 0; mb_index < 5; mb_index++) {
268        for (j = 0; j < s->sys->bpm; j++) {
269            if (mb->pos < 64 && get_bits_left(&gb) > 0) {
270                av_dlog(avctx, "start %d:%d\n", mb_index, j);
271                dv_decode_ac(&gb, mb, block);
272            }
273            if (mb->pos >= 64 && mb->pos < 127)
274                av_log(avctx, AV_LOG_ERROR, "AC EOB marker is absent pos=%d\n", mb->pos);
275            block += 64;
276            mb++;
277        }
278    }
279
280    /* compute idct and place blocks */
281    block = &sblock[0][0];
282    mb    = mb_data;
283    for (mb_index = 0; mb_index < 5; mb_index++) {
284        dv_calculate_mb_xy(s, work_chunk, mb_index, &mb_x, &mb_y);
285
286        /* idct_put'ting luminance */
287        if ((s->sys->pix_fmt == AV_PIX_FMT_YUV420P) ||
288            (s->sys->pix_fmt == AV_PIX_FMT_YUV411P && mb_x >= (704 / 8)) ||
289            (s->sys->height >= 720 && mb_y != 134)) {
290            y_stride = (s->frame->linesize[0] << ((!is_field_mode[mb_index]) * log2_blocksize));
291        } else {
292            y_stride = (2 << log2_blocksize);
293        }
294        y_ptr = s->frame->data[0] + ((mb_y * s->frame->linesize[0] + mb_x) << log2_blocksize);
295        linesize = s->frame->linesize[0] << is_field_mode[mb_index];
296        mb[0]    .idct_put(y_ptr                                   , linesize, block + 0*64);
297        if (s->sys->video_stype == 4) { /* SD 422 */
298            mb[2].idct_put(y_ptr + (1 << log2_blocksize)           , linesize, block + 2*64);
299        } else {
300            mb[1].idct_put(y_ptr + (1 << log2_blocksize)           , linesize, block + 1*64);
301            mb[2].idct_put(y_ptr                         + y_stride, linesize, block + 2*64);
302            mb[3].idct_put(y_ptr + (1 << log2_blocksize) + y_stride, linesize, block + 3*64);
303        }
304        mb += 4;
305        block += 4*64;
306
307        /* idct_put'ting chrominance */
308        c_offset = (((mb_y >>  (s->sys->pix_fmt == AV_PIX_FMT_YUV420P)) * s->frame->linesize[1] +
309                     (mb_x >> ((s->sys->pix_fmt == AV_PIX_FMT_YUV411P) ? 2 : 1))) << log2_blocksize);
310        for (j = 2; j; j--) {
311            uint8_t *c_ptr = s->frame->data[j] + c_offset;
312            if (s->sys->pix_fmt == AV_PIX_FMT_YUV411P && mb_x >= (704 / 8)) {
313                  uint64_t aligned_pixels[64/8];
314                  uint8_t *pixels = (uint8_t*)aligned_pixels;
315                  uint8_t *c_ptr1, *ptr1;
316                  int x, y;
317                  mb->idct_put(pixels, 8, block);
318                  for (y = 0; y < (1 << log2_blocksize); y++, c_ptr += s->frame->linesize[j], pixels += 8) {
319                      ptr1   = pixels + ((1 << (log2_blocksize))>>1);
320                      c_ptr1 = c_ptr + (s->frame->linesize[j] << log2_blocksize);
321                      for (x = 0; x < (1 << FFMAX(log2_blocksize - 1, 0)); x++) {
322                          c_ptr[x]  = pixels[x];
323                          c_ptr1[x] = ptr1[x];
324                      }
325                  }
326                  block += 64; mb++;
327            } else {
328                  y_stride = (mb_y == 134) ? (1 << log2_blocksize) :
329                                             s->frame->linesize[j] << ((!is_field_mode[mb_index]) * log2_blocksize);
330                  linesize = s->frame->linesize[j] << is_field_mode[mb_index];
331                  (mb++)->    idct_put(c_ptr           , linesize, block); block += 64;
332                  if (s->sys->bpm == 8) {
333                      (mb++)->idct_put(c_ptr + y_stride, linesize, block); block += 64;
334                  }
335            }
336        }
337    }
338    return 0;
339}
340
341/* NOTE: exactly one frame must be given (120000 bytes for NTSC,
342   144000 bytes for PAL - or twice those for 50Mbps) */
343static int dvvideo_decode_frame(AVCodecContext *avctx,
344                                 void *data, int *got_frame,
345                                 AVPacket *avpkt)
346{
347    uint8_t *buf = avpkt->data;
348    int buf_size = avpkt->size;
349    DVVideoContext *s = avctx->priv_data;
350    const uint8_t* vsc_pack;
351    int apt, is16_9, ret;
352    const AVDVProfile *sys;
353
354    sys = avpriv_dv_frame_profile2(avctx, s->sys, buf, buf_size);
355    if (!sys || buf_size < sys->frame_size) {
356        av_log(avctx, AV_LOG_ERROR, "could not find dv frame profile\n");
357        return -1; /* NOTE: we only accept several full frames */
358    }
359
360    if (sys != s->sys) {
361        ret = ff_dv_init_dynamic_tables(s, sys);
362        if (ret < 0) {
363            av_log(avctx, AV_LOG_ERROR, "Error initializing the work tables.\n");
364            return ret;
365        }
366        s->sys = sys;
367    }
368
369    s->frame            = data;
370    s->frame->key_frame = 1;
371    s->frame->pict_type = AV_PICTURE_TYPE_I;
372    avctx->pix_fmt   = s->sys->pix_fmt;
373    avctx->time_base = s->sys->time_base;
374
375    ret = ff_set_dimensions(avctx, s->sys->width, s->sys->height);
376    if (ret < 0)
377        return ret;
378
379    /* Determine the codec's sample_aspect ratio from the packet */
380    vsc_pack = buf + 80*5 + 48 + 5;
381    if ( *vsc_pack == dv_video_control ) {
382        apt = buf[4] & 0x07;
383        is16_9 = (vsc_pack[2] & 0x07) == 0x02 || (!apt && (vsc_pack[2] & 0x07) == 0x07);
384        ff_set_sar(avctx, s->sys->sar[is16_9]);
385    }
386
387    if ((ret = ff_get_buffer(avctx, s->frame, 0)) < 0)
388        return ret;
389    s->frame->interlaced_frame = 1;
390    s->frame->top_field_first  = 0;
391
392    /* Determine the codec's field order from the packet */
393    if ( *vsc_pack == dv_video_control ) {
394        s->frame->top_field_first = !(vsc_pack[3] & 0x40);
395    }
396
397    s->buf = buf;
398    avctx->execute(avctx, dv_decode_video_segment, s->work_chunks, NULL,
399                   dv_work_pool_size(s->sys), sizeof(DVwork_chunk));
400
401    emms_c();
402
403    /* return image */
404    *got_frame = 1;
405
406    return s->sys->frame_size;
407}
408
409AVCodec ff_dvvideo_decoder = {
410    .name           = "dvvideo",
411    .long_name      = NULL_IF_CONFIG_SMALL("DV (Digital Video)"),
412    .type           = AVMEDIA_TYPE_VIDEO,
413    .id             = AV_CODEC_ID_DVVIDEO,
414    .priv_data_size = sizeof(DVVideoContext),
415    .init           = dvvideo_decode_init,
416    .decode         = dvvideo_decode_frame,
417    .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_SLICE_THREADS,
418    .max_lowres     = 3,
419};
420