Revision 49bd8e4b libavcodec/put_bits.h

View differences:

libavcodec/put_bits.h
52 52
} PutBitContext;
53 53

  
54 54
/**
55
 * Initializes the PutBitContext s.
55
 * Initialize the PutBitContext s.
56 56
 *
57 57
 * @param buffer the buffer where to put bits
58 58
 * @param buffer_size the size in bytes of buffer
......
79 79
}
80 80

  
81 81
/**
82
 * Returns the total number of bits written to the bitstream.
82
 * @return the total number of bits written to the bitstream.
83 83
 */
84 84
static inline int put_bits_count(PutBitContext *s)
85 85
{
......
91 91
}
92 92

  
93 93
/**
94
 * Pads the end of the output stream with zeros.
94
 * Pad the end of the output stream with zeros.
95 95
 */
96 96
static inline void flush_put_bits(PutBitContext *s)
97 97
{
......
123 123
#define ff_copy_bits ff_copy_bits_unsupported_here
124 124
#else
125 125
/**
126
 * Pads the bitstream with zeros up to the next byte boundary.
126
 * Pad the bitstream with zeros up to the next byte boundary.
127 127
 */
128 128
void align_put_bits(PutBitContext *s);
129 129

  
130 130
/**
131
 * Puts the string string in the bitstream.
131
 * Put the string string in the bitstream.
132 132
 *
133 133
 * @param terminate_string 0-terminates the written string if value is 1
134 134
 */
135 135
void ff_put_string(PutBitContext *pb, const char *string, int terminate_string);
136 136

  
137 137
/**
138
 * Copies the content of src to the bitstream.
138
 * Copy the content of src to the bitstream.
139 139
 *
140 140
 * @param length the number of bits of src to copy
141 141
 */
......
143 143
#endif
144 144

  
145 145
/**
146
 * Writes up to 31 bits into a bitstream.
146
 * Write up to 31 bits into a bitstream.
147 147
 * Use put_bits32 to write 32 bits.
148 148
 */
149 149
static inline void put_bits(PutBitContext *s, int n, unsigned int value)
......
270 270
}
271 271

  
272 272
/**
273
 * Writes exactly 32 bits into a bitstream.
273
 * Write exactly 32 bits into a bitstream.
274 274
 */
275 275
static void av_unused put_bits32(PutBitContext *s, uint32_t value)
276 276
{
......
286 286
}
287 287

  
288 288
/**
289
 * Returns the pointer to the byte where the bitstream writer will put
289
 * Return the pointer to the byte where the bitstream writer will put
290 290
 * the next bit.
291 291
 */
292 292
static inline uint8_t* put_bits_ptr(PutBitContext *s)
......
299 299
}
300 300

  
301 301
/**
302
 * Skips the given number of bytes.
302
 * Skip the given number of bytes.
303 303
 * PutBitContext must be flushed & aligned to a byte boundary before calling this.
304 304
 */
305 305
static inline void skip_put_bytes(PutBitContext *s, int n)
......
315 315
}
316 316

  
317 317
/**
318
 * Skips the given number of bits.
318
 * Skip the given number of bits.
319 319
 * Must only be used if the actual values in the bitstream do not matter.
320 320
 * If n is 0 the behavior is undefined.
321 321
 */
......
331 331
}
332 332

  
333 333
/**
334
 * Changes the end of the buffer.
334
 * Change the end of the buffer.
335 335
 *
336 336
 * @param size the new size in bytes of the buffer where to put bits
337 337
 */

Also available in: Unified diff