comparison ivi_dsp.h @ 12181:0885e7a93ed4 libavcodec

Fix Doxygen @param command attribute syntax. The [in] and [out] attributes have to be appended to the @param command.
author diego
date Sat, 17 Jul 2010 10:43:42 +0000
parents fdafbcef52f5
children
comparison
equal deleted inserted replaced
12180:b24153464669 12181:0885e7a93ed4
33 #include "ivi_common.h" 33 #include "ivi_common.h"
34 34
35 /** 35 /**
36 * 5/3 wavelet recomposition filter for Indeo5 36 * 5/3 wavelet recomposition filter for Indeo5
37 * 37 *
38 * @param plane [in] pointer to the descriptor of the plane being processed 38 * @param[in] plane pointer to the descriptor of the plane being processed
39 * @param dst [out] pointer to the destination buffer 39 * @param[out] dst pointer to the destination buffer
40 * @param dst_pitch [in] pitch of the destination buffer 40 * @param[in] dst_pitch pitch of the destination buffer
41 * @param num_bands [in] number of wavelet bands to be processed 41 * @param[in] num_bands number of wavelet bands to be processed
42 */ 42 */
43 void ff_ivi_recompose53(const IVIPlaneDesc *plane, uint8_t *dst, 43 void ff_ivi_recompose53(const IVIPlaneDesc *plane, uint8_t *dst,
44 const int dst_pitch, const int num_bands); 44 const int dst_pitch, const int num_bands);
45 45
46 /** 46 /**
47 * two-dimensional inverse slant 8x8 transform 47 * two-dimensional inverse slant 8x8 transform
48 * 48 *
49 * @param in [in] pointer to the vector of transform coefficients 49 * @param[in] in pointer to the vector of transform coefficients
50 * @param out [out] pointer to the output buffer (frame) 50 * @param[out] out pointer to the output buffer (frame)
51 * @param pitch [in] pitch to move to the next y line 51 * @param[in] pitch pitch to move to the next y line
52 * @param flags [in] pointer to the array of column flags: 52 * @param[in] flags pointer to the array of column flags:
53 * != 0 - non_empty column, 0 - empty one 53 * != 0 - non_empty column, 0 - empty one
54 * (this array must be filled by caller) 54 * (this array must be filled by caller)
55 */ 55 */
56 void ff_ivi_inverse_slant_8x8(const int32_t *in, int16_t *out, uint32_t pitch, 56 void ff_ivi_inverse_slant_8x8(const int32_t *in, int16_t *out, uint32_t pitch,
57 const uint8_t *flags); 57 const uint8_t *flags);
58 58
59 /** 59 /**
60 * two-dimensional inverse slant 4x4 transform 60 * two-dimensional inverse slant 4x4 transform
61 * 61 *
62 * @param in [in] pointer to the vector of transform coefficients 62 * @param[in] in pointer to the vector of transform coefficients
63 * @param out [out] pointer to the output buffer (frame) 63 * @param[out] out pointer to the output buffer (frame)
64 * @param pitch [in] pitch to move to the next y line 64 * @param[in] pitch pitch to move to the next y line
65 * @param flags [in] pointer to the array of column flags: 65 * @param[in] flags pointer to the array of column flags:
66 * != 0 - non_empty column, 0 - empty one 66 * != 0 - non_empty column, 0 - empty one
67 * (this array must be filled by caller) 67 * (this array must be filled by caller)
68 */ 68 */
69 void ff_ivi_inverse_slant_4x4(const int32_t *in, int16_t *out, uint32_t pitch, 69 void ff_ivi_inverse_slant_4x4(const int32_t *in, int16_t *out, uint32_t pitch,
70 const uint8_t *flags); 70 const uint8_t *flags);
73 * DC-only two-dimensional inverse slant transform. 73 * DC-only two-dimensional inverse slant transform.
74 * Performing the inverse slant transform in this case is equivalent to 74 * Performing the inverse slant transform in this case is equivalent to
75 * spreading (DC_coeff + 1)/2 over the whole block. 75 * spreading (DC_coeff + 1)/2 over the whole block.
76 * It works much faster than performing the slant transform on a vector of zeroes. 76 * It works much faster than performing the slant transform on a vector of zeroes.
77 * 77 *
78 * @param in [in] pointer to the dc coefficient 78 * @param[in] in pointer to the dc coefficient
79 * @param out [out] pointer to the output buffer (frame) 79 * @param[out] out pointer to the output buffer (frame)
80 * @param pitch [in] pitch to move to the next y line 80 * @param[in] pitch pitch to move to the next y line
81 * @param blk_size [in] transform block size 81 * @param[in] blk_size transform block size
82 */ 82 */
83 void ff_ivi_dc_slant_2d(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size); 83 void ff_ivi_dc_slant_2d(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
84 84
85 /** 85 /**
86 * inverse 1D row slant transform 86 * inverse 1D row slant transform
87 * 87 *
88 * @param in [in] pointer to the vector of transform coefficients 88 * @param[in] in pointer to the vector of transform coefficients
89 * @param out [out] pointer to the output buffer (frame) 89 * @param[out] out pointer to the output buffer (frame)
90 * @param pitch [in] pitch to move to the next y line 90 * @param[in] pitch pitch to move to the next y line
91 * @param flags [in] pointer to the array of column flags (unused here) 91 * @param[in] flags pointer to the array of column flags (unused here)
92 */ 92 */
93 void ff_ivi_row_slant8(const int32_t *in, int16_t *out, uint32_t pitch, 93 void ff_ivi_row_slant8(const int32_t *in, int16_t *out, uint32_t pitch,
94 const uint8_t *flags); 94 const uint8_t *flags);
95 95
96 /** 96 /**
97 * inverse 1D column slant transform 97 * inverse 1D column slant transform
98 * 98 *
99 * @param in [in] pointer to the vector of transform coefficients 99 * @param[in] in pointer to the vector of transform coefficients
100 * @param out [out] pointer to the output buffer (frame) 100 * @param[out] out pointer to the output buffer (frame)
101 * @param pitch [in] pitch to move to the next y line 101 * @param[in] pitch pitch to move to the next y line
102 * @param flags [in] pointer to the array of column flags: 102 * @param[in] flags pointer to the array of column flags:
103 * != 0 - non_empty column, 0 - empty one 103 * != 0 - non_empty column, 0 - empty one
104 * (this array must be filled by caller) 104 * (this array must be filled by caller)
105 */ 105 */
106 void ff_ivi_col_slant8(const int32_t *in, int16_t *out, uint32_t pitch, 106 void ff_ivi_col_slant8(const int32_t *in, int16_t *out, uint32_t pitch,
107 const uint8_t *flags); 107 const uint8_t *flags);
128 void ff_ivi_put_dc_pixel_8x8(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size); 128 void ff_ivi_put_dc_pixel_8x8(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
129 129
130 /** 130 /**
131 * 8x8 block motion compensation with adding delta 131 * 8x8 block motion compensation with adding delta
132 * 132 *
133 * @param buf [in,out] pointer to the block in the current frame buffer containing delta 133 * @param[in,out] buf pointer to the block in the current frame buffer containing delta
134 * @param ref_buf [in] pointer to the corresponding block in the reference frame 134 * @param[in] ref_buf pointer to the corresponding block in the reference frame
135 * @param pitch [in] pitch for moving to the next y line 135 * @param[in] pitch pitch for moving to the next y line
136 * @param mc_type [in] interpolation type 136 * @param[in] mc_type interpolation type
137 */ 137 */
138 void ff_ivi_mc_8x8_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); 138 void ff_ivi_mc_8x8_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
139 139
140 /** 140 /**
141 * 4x4 block motion compensation with adding delta 141 * 4x4 block motion compensation with adding delta
142 * 142 *
143 * @param buf [in,out] pointer to the block in the current frame buffer containing delta 143 * @param[in,out] buf pointer to the block in the current frame buffer containing delta
144 * @param ref_buf [in] pointer to the corresponding block in the reference frame 144 * @param[in] ref_buf pointer to the corresponding block in the reference frame
145 * @param pitch [in] pitch for moving to the next y line 145 * @param[in] pitch pitch for moving to the next y line
146 * @param mc_type [in] interpolation type 146 * @param[in] mc_type interpolation type
147 */ 147 */
148 void ff_ivi_mc_4x4_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); 148 void ff_ivi_mc_4x4_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
149 149
150 /** 150 /**
151 * motion compensation without adding delta 151 * motion compensation without adding delta
152 * 152 *
153 * @param buf [in,out] pointer to the block in the current frame receiving the result 153 * @param[in,out] buf pointer to the block in the current frame receiving the result
154 * @param ref_buf [in] pointer to the corresponding block in the reference frame 154 * @param[in] ref_buf pointer to the corresponding block in the reference frame
155 * @param pitch [in] pitch for moving to the next y line 155 * @param[in] pitch pitch for moving to the next y line
156 * @param mc_type [in] interpolation type 156 * @param[in] mc_type interpolation type
157 */ 157 */
158 void ff_ivi_mc_8x8_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); 158 void ff_ivi_mc_8x8_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
159 159
160 /** 160 /**
161 * 4x4 block motion compensation without adding delta 161 * 4x4 block motion compensation without adding delta
162 * 162 *
163 * @param buf [in,out] pointer to the block in the current frame receiving the result 163 * @param[in,out] buf pointer to the block in the current frame receiving the result
164 * @param ref_buf [in] pointer to the corresponding block in the reference frame 164 * @param[in] ref_buf pointer to the corresponding block in the reference frame
165 * @param pitch [in] pitch for moving to the next y line 165 * @param[in] pitch pitch for moving to the next y line
166 * @param mc_type [in] interpolation type 166 * @param[in] mc_type interpolation type
167 */ 167 */
168 void ff_ivi_mc_4x4_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type); 168 void ff_ivi_mc_4x4_no_delta(int16_t *buf, const int16_t *ref_buf, uint32_t pitch, int mc_type);
169 169
170 #endif /* AVCODEC_IVI_DSP_H */ 170 #endif /* AVCODEC_IVI_DSP_H */