xref: /aosp_15_r20/external/libdav1d/src/ipred.h (revision c09093415860a1c2373dacd84c4fde00c507cdfd)
1 /*
2  * Copyright © 2018-2021, VideoLAN and dav1d authors
3  * Copyright © 2018, Two Orioles, LLC
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  *    list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  *    this list of conditions and the following disclaimer in the documentation
14  *    and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef DAV1D_SRC_IPRED_H
29 #define DAV1D_SRC_IPRED_H
30 
31 #include <stddef.h>
32 
33 #include "common/bitdepth.h"
34 
35 #include "src/levels.h"
36 
37 /*
38  * Intra prediction.
39  * - a is the angle (in degrees) for directional intra predictors. For other
40  *   modes, it is ignored;
41  * - topleft is the same as the argument given to dav1d_prepare_intra_edges(),
42  *   see ipred_prepare.h for more detailed documentation.
43  */
44 #define decl_angular_ipred_fn(name) \
45 void (name)(pixel *dst, ptrdiff_t stride, const pixel *topleft, \
46             int width, int height, int angle, int max_width, int max_height \
47             HIGHBD_DECL_SUFFIX)
48 typedef decl_angular_ipred_fn(*angular_ipred_fn);
49 
50 /*
51  * Create a subsampled Y plane with the DC subtracted.
52  * - w/h_pad is the edge of the width/height that extends outside the visible
53  *   portion of the frame in 4px units;
54  * - ac has a stride of 16.
55  */
56 #define decl_cfl_ac_fn(name) \
57 void (name)(int16_t *ac, const pixel *y, ptrdiff_t stride, \
58             int w_pad, int h_pad, int cw, int ch)
59 typedef decl_cfl_ac_fn(*cfl_ac_fn);
60 
61 /*
62  * dst[x,y] += alpha * ac[x,y]
63  * - alpha contains a q3 scalar in [-16,16] range;
64  */
65 #define decl_cfl_pred_fn(name) \
66 void (name)(pixel *dst, ptrdiff_t stride, const pixel *topleft, \
67             int width, int height, const int16_t *ac, int alpha \
68             HIGHBD_DECL_SUFFIX)
69 typedef decl_cfl_pred_fn(*cfl_pred_fn);
70 
71 /*
72  * dst[x,y] = pal[idx[x,y]]
73  * - palette indices are [0-7]
74  * - only 16-byte alignment is guaranteed for idx.
75  */
76 #define decl_pal_pred_fn(name) \
77 void (name)(pixel *dst, ptrdiff_t stride, const pixel *pal, \
78             const uint8_t *idx, int w, int h)
79 typedef decl_pal_pred_fn(*pal_pred_fn);
80 
81 typedef struct Dav1dIntraPredDSPContext {
82     angular_ipred_fn intra_pred[N_IMPL_INTRA_PRED_MODES];
83 
84     // chroma-from-luma
85     cfl_ac_fn cfl_ac[3 /* 420, 422, 444 */];
86     cfl_pred_fn cfl_pred[DC_128_PRED + 1];
87 
88     // palette
89     pal_pred_fn pal_pred;
90 } Dav1dIntraPredDSPContext;
91 
92 bitfn_decls(void dav1d_intra_pred_dsp_init, Dav1dIntraPredDSPContext *c);
93 
94 #endif /* DAV1D_SRC_IPRED_H */
95