Mercurial > libavcodec.hg
comparison bink.c @ 12024:fdafbcef52f5 libavcodec
Fix grammar errors in documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 15:38:06 +0000 |
parents | 2501df1cabc5 |
children | 914f484bb476 |
comparison
equal
deleted
inserted
replaced
12023:c7455450364d | 12024:fdafbcef52f5 |
---|---|
104 PATTERN_BLOCK, ///< block is filled with two colours following custom pattern | 104 PATTERN_BLOCK, ///< block is filled with two colours following custom pattern |
105 RAW_BLOCK, ///< uncoded 8x8 block | 105 RAW_BLOCK, ///< uncoded 8x8 block |
106 }; | 106 }; |
107 | 107 |
108 /** | 108 /** |
109 * Initializes length length in all bundles. | 109 * Initialize length length in all bundles. |
110 * | 110 * |
111 * @param c decoder context | 111 * @param c decoder context |
112 * @param width plane width | 112 * @param width plane width |
113 * @param bw plane width in 8x8 blocks | 113 * @param bw plane width in 8x8 blocks |
114 */ | 114 */ |
129 | 129 |
130 c->bundle[BINK_SRC_RUN].len = av_log2((width >> 3)*48 + 511) + 1; | 130 c->bundle[BINK_SRC_RUN].len = av_log2((width >> 3)*48 + 511) + 1; |
131 } | 131 } |
132 | 132 |
133 /** | 133 /** |
134 * Allocates memory for bundles. | 134 * Allocate memory for bundles. |
135 * | 135 * |
136 * @param c decoder context | 136 * @param c decoder context |
137 */ | 137 */ |
138 static av_cold void init_bundles(BinkContext *c) | 138 static av_cold void init_bundles(BinkContext *c) |
139 { | 139 { |
149 c->bundle[i].data_end = c->bundle[i].data + blocks * 64; | 149 c->bundle[i].data_end = c->bundle[i].data + blocks * 64; |
150 } | 150 } |
151 } | 151 } |
152 | 152 |
153 /** | 153 /** |
154 * Frees memory used by bundles. | 154 * Free memory used by bundles. |
155 * | 155 * |
156 * @param c decoder context | 156 * @param c decoder context |
157 */ | 157 */ |
158 static av_cold void free_bundles(BinkContext *c) | 158 static av_cold void free_bundles(BinkContext *c) |
159 { | 159 { |
161 for (i = 0; i < BINK_NB_SRC; i++) | 161 for (i = 0; i < BINK_NB_SRC; i++) |
162 av_freep(&c->bundle[i].data); | 162 av_freep(&c->bundle[i].data); |
163 } | 163 } |
164 | 164 |
165 /** | 165 /** |
166 * Merges two consequent lists of equal size depending on bits read. | 166 * Merge two consequent lists of equal size depending on bits read. |
167 * | 167 * |
168 * @param gb context for reading bits | 168 * @param gb context for reading bits |
169 * @param dst buffer where merged list will be written to | 169 * @param dst buffer where merged list will be written to |
170 * @param src pointer to the head of the first list (the second lists starts at src+size) | 170 * @param src pointer to the head of the first list (the second lists starts at src+size) |
171 * @param size input lists size | 171 * @param size input lists size |
190 while (size2--) | 190 while (size2--) |
191 *dst++ = *src2++; | 191 *dst++ = *src2++; |
192 } | 192 } |
193 | 193 |
194 /** | 194 /** |
195 * Reads information about Huffman tree used to decode data. | 195 * Read information about Huffman tree used to decode data. |
196 * | 196 * |
197 * @param gb context for reading bits | 197 * @param gb context for reading bits |
198 * @param tree pointer for storing tree data | 198 * @param tree pointer for storing tree data |
199 */ | 199 */ |
200 static void read_tree(GetBitContext *gb, Tree *tree) | 200 static void read_tree(GetBitContext *gb, Tree *tree) |
231 memcpy(tree->syms, in, 16); | 231 memcpy(tree->syms, in, 16); |
232 } | 232 } |
233 } | 233 } |
234 | 234 |
235 /** | 235 /** |
236 * Prepares bundle for decoding data. | 236 * Prepare bundle for decoding data. |
237 * | 237 * |
238 * @param gb context for reading bits | 238 * @param gb context for reading bits |
239 * @param c decoder context | 239 * @param c decoder context |
240 * @param bundle_num number of the bundle to initialize | 240 * @param bundle_num number of the bundle to initialize |
241 */ | 241 */ |
460 b->cur_dec = (uint8_t*)dst; | 460 b->cur_dec = (uint8_t*)dst; |
461 return 0; | 461 return 0; |
462 } | 462 } |
463 | 463 |
464 /** | 464 /** |
465 * Retrieves next value from bundle. | 465 * Retrieve next value from bundle. |
466 * | 466 * |
467 * @param c decoder context | 467 * @param c decoder context |
468 * @param bundle bundle number | 468 * @param bundle bundle number |
469 */ | 469 */ |
470 static inline int get_value(BinkContext *c, int bundle) | 470 static inline int get_value(BinkContext *c, int bundle) |
479 c->bundle[bundle].cur_ptr += 2; | 479 c->bundle[bundle].cur_ptr += 2; |
480 return ret; | 480 return ret; |
481 } | 481 } |
482 | 482 |
483 /** | 483 /** |
484 * Reads 8x8 block of DCT coefficients. | 484 * Read 8x8 block of DCT coefficients. |
485 * | 485 * |
486 * @param gb context for reading bits | 486 * @param gb context for reading bits |
487 * @param block place for storing coefficients | 487 * @param block place for storing coefficients |
488 * @param scan scan order table | 488 * @param scan scan order table |
489 * @param is_intra tells what set of quantizer matrices to use | 489 * @param is_intra tells what set of quantizer matrices to use |
581 | 581 |
582 return 0; | 582 return 0; |
583 } | 583 } |
584 | 584 |
585 /** | 585 /** |
586 * Reads 8x8 block with residue after motion compensation. | 586 * Read 8x8 block with residue after motion compensation. |
587 * | 587 * |
588 * @param gb context for reading bits | 588 * @param gb context for reading bits |
589 * @param block place to store read data | 589 * @param block place to store read data |
590 * @param masks_count number of masks to decode | 590 * @param masks_count number of masks to decode |
591 * @return 0 on success, negative value in other cases | 591 * @return 0 on success, negative value in other cases |