intrax8: Pass the output frame to the decoding function
[ffmpeg.git] / libavcodec / intrax8.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef AVCODEC_INTRAX8_H
20 #define AVCODEC_INTRAX8_H
21
22 #include "get_bits.h"
23 #include "mpegvideo.h"
24 #include "idctdsp.h"
25 #include "intrax8dsp.h"
26 #include "mpegpicture.h"
27
28 typedef struct IntraX8Context {
29     VLC *j_ac_vlc[4]; // they point to the static j_mb_vlc
30     VLC *j_orient_vlc;
31     VLC *j_dc_vlc[3];
32
33     int use_quant_matrix;
34
35     // set by ff_intrax8_common_init
36     uint8_t *prediction_table; // 2 * (mb_w * 2)
37     ScanTable scantable[3];
38
39     // set by the caller codec
40     MpegEncContext *s;
41     IntraX8DSPContext dsp;
42     IDCTDSPContext idsp;
43     int quant;
44     int dquant;
45     int qsum;
46     int loopfilter;
47     AVFrame *frame;
48
49     // calculated per frame
50     int quant_dc_chroma;
51     int divide_quant_dc_luma;
52     int divide_quant_dc_chroma;
53     uint8_t *dest[3];
54
55     // changed per block
56     int edges;
57     int flat_dc;
58     int predicted_dc;
59     int raw_orient;
60     int chroma_orient;
61     int orient;
62     int est_run;
63 } IntraX8Context;
64
65 /**
66  * Initialize IntraX8 frame decoder.
67  * Requires valid MpegEncContext with valid s->mb_width before calling.
68  * @param w pointer to IntraX8Context
69  * @param idsp pointer to IDCTDSPContext
70  * @param s pointer to MpegEncContext of the parent codec
71  * @return 0 on success, a negative AVERROR value on error
72  */
73 int ff_intrax8_common_init(IntraX8Context *w, IDCTDSPContext *idsp,
74                            MpegEncContext *const s);
75
76 /**
77  * Destroy IntraX8 frame structure.
78  * @param w pointer to IntraX8Context
79  */
80 void ff_intrax8_common_end(IntraX8Context *w);
81
82 /**
83  * Decode single IntraX8 frame.
84  * The parent codec must fill s->gb (bitstream).
85  * The parent codec must call ff_mpv_frame_start() before calling this function.
86  * The parent codec must call ff_mpv_frame_end() after calling this function.
87  * This function does not use ff_mpv_decode_mb().
88  * @param w pointer to IntraX8Context
89  * @param pict the output Picture containing an AVFrame
90  * @param dquant doubled quantizer, it would be odd in case of VC-1 halfpq==1.
91  * @param quant_offset offset away from zero
92  * @param loopfilter enable filter after decoding a block
93  */
94 int ff_intrax8_decode_picture(IntraX8Context *w, Picture *pict,
95                               int quant, int halfpq, int loopfilter);
96
97 #endif /* AVCODEC_INTRAX8_H */