FFmpeg coverage

GCC Code Coverage Report

Directory:	../../../ffmpeg/		Exec	Total	Coverage
File:	src/libavcodec/put_bits.h	Lines:	103	136	75.7 %
Date:	2020-06-02 07:24:37	Branches:	21	40	52.5 %


/*
 * copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * @file
 * bitstream writer API
 */

#ifndef AVCODEC_PUT_BITS_H
#define AVCODEC_PUT_BITS_H

#include <stdint.h>
#include <stddef.h>

#include "libavutil/intreadwrite.h"
#include "libavutil/avassert.h"

typedef struct PutBitContext {
    uint32_t bit_buf;
    int bit_left;
    uint8_t *buf, *buf_ptr, *buf_end;
    int size_in_bits;
} PutBitContext;

/**
 * Initialize the PutBitContext s.
 *
 * @param buffer the buffer where to put bits
 * @param buffer_size the size in bytes of buffer
 */
static inline void init_put_bits(PutBitContext *s, uint8_t *buffer,
                                 int buffer_size)
{
    if (buffer_size < 0) {
        buffer_size = 0;
        buffer      = NULL;
    }

    s->size_in_bits = 8 * buffer_size;
    s->buf          = buffer;
    s->buf_end      = s->buf + buffer_size;
    s->buf_ptr      = s->buf;
    s->bit_left     = 32;
    s->bit_buf      = 0;
}

/**
 * @return the total number of bits written to the bitstream.
 */
static inline int put_bits_count(PutBitContext *s)
{
    return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
}

/**
 * Rebase the bit writer onto a reallocated buffer.
 *
 * @param buffer the buffer where to put bits
 * @param buffer_size the size in bytes of buffer,
 *                    must be large enough to hold everything written so far
 */
static inline void rebase_put_bits(PutBitContext *s, uint8_t *buffer,
                                   int buffer_size)
{
    av_assert0(8*buffer_size >= put_bits_count(s));

    s->buf_end = buffer + buffer_size;
    s->buf_ptr = buffer + (s->buf_ptr - s->buf);
    s->buf     = buffer;
    s->size_in_bits = 8 * buffer_size;
}

/**
 * @return the number of bits available in the bitstream.
 */
static inline int put_bits_left(PutBitContext* s)
{
    return (s->buf_end - s->buf_ptr) * 8 - 32 + s->bit_left;
}

/**
 * Pad the end of the output stream with zeros.
 */
static inline void flush_put_bits(PutBitContext *s)
{
#ifndef BITSTREAM_WRITER_LE
    if (s->bit_left < 32)
        s->bit_buf <<= s->bit_left;
#endif
    while (s->bit_left < 32) {
        av_assert0(s->buf_ptr < s->buf_end);
#ifdef BITSTREAM_WRITER_LE
        *s->buf_ptr++ = s->bit_buf;
        s->bit_buf  >>= 8;
#else
        *s->buf_ptr++ = s->bit_buf >> 24;
        s->bit_buf  <<= 8;
#endif
        s->bit_left  += 8;
    }
    s->bit_left = 32;
    s->bit_buf  = 0;
}

static inline void flush_put_bits_le(PutBitContext *s)
{
    while (s->bit_left < 32) {
        av_assert0(s->buf_ptr < s->buf_end);
        *s->buf_ptr++ = s->bit_buf;
        s->bit_buf  >>= 8;
        s->bit_left  += 8;
    }
    s->bit_left = 32;
    s->bit_buf  = 0;
}

#ifdef BITSTREAM_WRITER_LE
#define avpriv_align_put_bits align_put_bits_unsupported_here
#define avpriv_put_string ff_put_string_unsupported_here
#define avpriv_copy_bits avpriv_copy_bits_unsupported_here
#else
/**
 * Pad the bitstream with zeros up to the next byte boundary.
 */
void avpriv_align_put_bits(PutBitContext *s);

/**
 * Put the string string in the bitstream.
 *
 * @param terminate_string 0-terminates the written string if value is 1
 */
void avpriv_put_string(PutBitContext *pb, const char *string,
                       int terminate_string);

/**
 * Copy the content of src to the bitstream.
 *
 * @param length the number of bits of src to copy
 */
void avpriv_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
#endif

/**
 * Write up to 31 bits into a bitstream.
 * Use put_bits32 to write 32 bits.
 */
static inline void put_bits(PutBitContext *s, int n, unsigned int value)
{
    unsigned int bit_buf;
    int bit_left;

    av_assert2(n <= 31 && value < (1U << n));

    bit_buf  = s->bit_buf;
    bit_left = s->bit_left;

    /* XXX: optimize */
#ifdef BITSTREAM_WRITER_LE
    bit_buf |= value << (32 - bit_left);
    if (n >= bit_left) {
        if (3 < s->buf_end - s->buf_ptr) {
            AV_WL32(s->buf_ptr, bit_buf);
            s->buf_ptr += 4;
        } else {
            av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
            av_assert2(0);
        }
        bit_buf     = value >> bit_left;
        bit_left   += 32;
    }
    bit_left -= n;
#else
    if (n < bit_left) {
        bit_buf     = (bit_buf << n) | value;
        bit_left   -= n;
    } else {
        bit_buf   <<= bit_left;
        bit_buf    |= value >> (n - bit_left);
        if (3 < s->buf_end - s->buf_ptr) {
            AV_WB32(s->buf_ptr, bit_buf);
            s->buf_ptr += 4;
        } else {
            av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
            av_assert2(0);
        }
        bit_left   += 32 - n;
        bit_buf     = value;
    }
#endif

    s->bit_buf  = bit_buf;
    s->bit_left = bit_left;
}

static inline void put_bits_le(PutBitContext *s, int n, unsigned int value)
{
    unsigned int bit_buf;
    int bit_left;

    av_assert2(n <= 31 && value < (1U << n));

    bit_buf  = s->bit_buf;
    bit_left = s->bit_left;

    bit_buf |= value << (32 - bit_left);
    if (n >= bit_left) {
        if (3 < s->buf_end - s->buf_ptr) {
            AV_WL32(s->buf_ptr, bit_buf);
            s->buf_ptr += 4;
        } else {
            av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
            av_assert2(0);
        }
        bit_buf     = value >> bit_left;
        bit_left   += 32;
    }
    bit_left -= n;

    s->bit_buf  = bit_buf;
    s->bit_left = bit_left;
}

static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
{
    av_assert2(n >= 0 && n <= 31);

    put_bits(pb, n, av_mod_uintp2(value, n));
}

/**
 * Write exactly 32 bits into a bitstream.
 */
static void av_unused put_bits32(PutBitContext *s, uint32_t value)
{
    unsigned int bit_buf;
    int bit_left;

    bit_buf  = s->bit_buf;
    bit_left = s->bit_left;

#ifdef BITSTREAM_WRITER_LE
    bit_buf |= value << (32 - bit_left);
    if (3 < s->buf_end - s->buf_ptr) {
        AV_WL32(s->buf_ptr, bit_buf);
        s->buf_ptr += 4;
    } else {
        av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
        av_assert2(0);
    }
    bit_buf     = (uint64_t)value >> bit_left;
#else
    bit_buf     = (uint64_t)bit_buf << bit_left;
    bit_buf    |= value >> (32 - bit_left);
    if (3 < s->buf_end - s->buf_ptr) {
        AV_WB32(s->buf_ptr, bit_buf);
        s->buf_ptr += 4;
    } else {
        av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
        av_assert2(0);
    }
    bit_buf     = value;
#endif

    s->bit_buf  = bit_buf;
    s->bit_left = bit_left;
}

/**
 * Write up to 64 bits into a bitstream.
 */
static inline void put_bits64(PutBitContext *s, int n, uint64_t value)
{
    av_assert2((n == 64) || (n < 64 && value < (UINT64_C(1) << n)));

    if (n < 32)
        put_bits(s, n, value);
    else if (n == 32)
        put_bits32(s, value);
    else if (n < 64) {
        uint32_t lo = value & 0xffffffff;
        uint32_t hi = value >> 32;
#ifdef BITSTREAM_WRITER_LE
        put_bits32(s, lo);
        put_bits(s, n - 32, hi);
#else
        put_bits(s, n - 32, hi);
        put_bits32(s, lo);
#endif
    } else {
        uint32_t lo = value & 0xffffffff;
        uint32_t hi = value >> 32;
#ifdef BITSTREAM_WRITER_LE
        put_bits32(s, lo);
        put_bits32(s, hi);
#else
        put_bits32(s, hi);
        put_bits32(s, lo);
#endif

    }
}

/**
 * Return the pointer to the byte where the bitstream writer will put
 * the next bit.
 */
static inline uint8_t *put_bits_ptr(PutBitContext *s)
{
    return s->buf_ptr;
}

/**
 * Skip the given number of bytes.
 * PutBitContext must be flushed & aligned to a byte boundary before calling this.
 */
static inline void skip_put_bytes(PutBitContext *s, int n)
{
    av_assert2((put_bits_count(s) & 7) == 0);
    av_assert2(s->bit_left == 32);
    av_assert0(n <= s->buf_end - s->buf_ptr);
    s->buf_ptr += n;
}

/**
 * Skip the given number of bits.
 * Must only be used if the actual values in the bitstream do not matter.
 * If n is 0 the behavior is undefined.
 */
static inline void skip_put_bits(PutBitContext *s, int n)
{
    s->bit_left -= n;
    s->buf_ptr  -= 4 * (s->bit_left >> 5);
    s->bit_left &= 31;
}

/**
 * Change the end of the buffer.
 *
 * @param size the new size in bytes of the buffer where to put bits
 */
static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
{
    av_assert0(size <= INT_MAX/8 - 32);
    s->buf_end = s->buf + size;
    s->size_in_bits = 8*size;
}

#endif /* AVCODEC_PUT_BITS_H */


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			/*
2			* copyright (c) 2004 Michael Niedermayer <michaelni@gmx.at>
3			*
4			* This file is part of FFmpeg.
5			*
6			* FFmpeg is free software; you can redistribute it and/or
7			* modify it under the terms of the GNU Lesser General Public
8			* License as published by the Free Software Foundation; either
9			* version 2.1 of the License, or (at your option) any later version.
10			*
11			* FFmpeg is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14			* Lesser General Public License for more details.
15			*
16			* You should have received a copy of the GNU Lesser General Public
17			* License along with FFmpeg; if not, write to the Free Software
18			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19			*/
20
21			/**
22			* @file
23			* bitstream writer API
24			*/
25
26			#ifndef AVCODEC_PUT_BITS_H
27			#define AVCODEC_PUT_BITS_H
28
29			#include <stdint.h>
30			#include <stddef.h>
31
32			#include "libavutil/intreadwrite.h"
33			#include "libavutil/avassert.h"
34
35			typedef struct PutBitContext {
36			uint32_t bit_buf;
37			int bit_left;
38			uint8_t buf, buf_ptr, *buf_end;
39			int size_in_bits;
40			} PutBitContext;
41
42			/**
43			* Initialize the PutBitContext s.
44			*
45			* @param buffer the buffer where to put bits
46			* @param buffer_size the size in bytes of buffer
47			*/
48		25844740	static inline void init_put_bits(PutBitContext s, uint8_t buffer,
49			int buffer_size)
50			{
51	✗✓	25844740	if (buffer_size < 0) {
52			buffer_size = 0;
53			buffer = NULL;
54			}
55
56		25844740	s->size_in_bits = 8 * buffer_size;
57		25844740	s->buf = buffer;
58		25844740	s->buf_end = s->buf + buffer_size;
59		25844740	s->buf_ptr = s->buf;
60		25844740	s->bit_left = 32;
61		25844740	s->bit_buf = 0;
62		25844740	}
63
64			/**
65			* @return the total number of bits written to the bitstream.
66			*/
67		48038705	static inline int put_bits_count(PutBitContext *s)
68			{
69		48038705	return (s->buf_ptr - s->buf) * 8 + 32 - s->bit_left;
70			}
71
72			/**
73			* Rebase the bit writer onto a reallocated buffer.
74			*
75			* @param buffer the buffer where to put bits
76			* @param buffer_size the size in bytes of buffer,
77			* must be large enough to hold everything written so far
78			*/
79		25	static inline void rebase_put_bits(PutBitContext s, uint8_t buffer,
80			int buffer_size)
81			{
82	✗✓	25	av_assert0(8*buffer_size >= put_bits_count(s));
83
84		25	s->buf_end = buffer + buffer_size;
85		25	s->buf_ptr = buffer + (s->buf_ptr - s->buf);
86		25	s->buf = buffer;
87		25	s->size_in_bits = 8 * buffer_size;
88		25	}
89
90			/**
91			* @return the number of bits available in the bitstream.
92			*/
93		271353732	static inline int put_bits_left(PutBitContext* s)
94			{
95		271353732	return (s->buf_end - s->buf_ptr) * 8 - 32 + s->bit_left;
96			}
97
98			/**
99			* Pad the end of the output stream with zeros.
100			*/
101		27037925	static inline void flush_put_bits(PutBitContext *s)
102			{
103			#ifndef BITSTREAM_WRITER_LE
104	✓✓	27035844	if (s->bit_left < 32)
105		23859426	s->bit_buf <<= s->bit_left;
106			#endif
107	✓✓	77734828	while (s->bit_left < 32) {
108	✗✓	50696903	av_assert0(s->buf_ptr < s->buf_end);
109			#ifdef BITSTREAM_WRITER_LE
110		4245	*s->buf_ptr++ = s->bit_buf;
111		4245	s->bit_buf >>= 8;
112			#else
113		50692658	*s->buf_ptr++ = s->bit_buf >> 24;
114		50692658	s->bit_buf <<= 8;
115			#endif
116		50696903	s->bit_left += 8;
117			}
118		27037925	s->bit_left = 32;
119		27037925	s->bit_buf = 0;
120		27037925	}
121
122			static inline void flush_put_bits_le(PutBitContext *s)
123			{
124			while (s->bit_left < 32) {
125			av_assert0(s->buf_ptr < s->buf_end);
126			*s->buf_ptr++ = s->bit_buf;
127			s->bit_buf >>= 8;
128			s->bit_left += 8;
129			}
130			s->bit_left = 32;
131			s->bit_buf = 0;
132			}
133
134			#ifdef BITSTREAM_WRITER_LE
135			#define avpriv_align_put_bits align_put_bits_unsupported_here
136			#define avpriv_put_string ff_put_string_unsupported_here
137			#define avpriv_copy_bits avpriv_copy_bits_unsupported_here
138			#else
139			/**
140			* Pad the bitstream with zeros up to the next byte boundary.
141			*/
142			void avpriv_align_put_bits(PutBitContext *s);
143
144			/**
145			* Put the string string in the bitstream.
146			*
147			* @param terminate_string 0-terminates the written string if value is 1
148			*/
149			void avpriv_put_string(PutBitContext pb, const char string,
150			int terminate_string);
151
152			/**
153			* Copy the content of src to the bitstream.
154			*
155			* @param length the number of bits of src to copy
156			*/
157			void avpriv_copy_bits(PutBitContext pb, const uint8_t src, int length);
158			#endif
159
160			/**
161			* Write up to 31 bits into a bitstream.
162			* Use put_bits32 to write 32 bits.
163			*/
164		2506448016	static inline void put_bits(PutBitContext *s, int n, unsigned int value)
165			{
166			unsigned int bit_buf;
167			int bit_left;
168
169			av_assert2(n <= 31 && value < (1U << n));
170
171		2506448016	bit_buf = s->bit_buf;
172		2506448016	bit_left = s->bit_left;
173
174			/* XXX: optimize */
175			#ifdef BITSTREAM_WRITER_LE
176		4499639	bit_buf \|= value << (32 - bit_left);
177	✓✓	4499639	if (n >= bit_left) {
178	✓✗	834637	if (3 < s->buf_end - s->buf_ptr) {
179		834637	AV_WL32(s->buf_ptr, bit_buf);
180		834637	s->buf_ptr += 4;
181			} else {
182			av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
183			av_assert2(0);
184			}
185		834637	bit_buf = value >> bit_left;
186		834637	bit_left += 32;
187			}
188		4499639	bit_left -= n;
189			#else
190	✓✓	2501948377	if (n < bit_left) {
191		2148815033	bit_buf = (bit_buf << n) \| value;
192		2148815033	bit_left -= n;
193			} else {
194		353133344	bit_buf <<= bit_left;
195		353133344	bit_buf \|= value >> (n - bit_left);
196	✓✗	353133344	if (3 < s->buf_end - s->buf_ptr) {
197		353133344	AV_WB32(s->buf_ptr, bit_buf);
198		353133344	s->buf_ptr += 4;
199			} else {
200			av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
201			av_assert2(0);
202			}
203		353133344	bit_left += 32 - n;
204		353133344	bit_buf = value;
205			}
206			#endif
207
208		2506448016	s->bit_buf = bit_buf;
209		2506448016	s->bit_left = bit_left;
210		2506448016	}
211
212			static inline void put_bits_le(PutBitContext *s, int n, unsigned int value)
213			{
214			unsigned int bit_buf;
215			int bit_left;
216
217			av_assert2(n <= 31 && value < (1U << n));
218
219			bit_buf = s->bit_buf;
220			bit_left = s->bit_left;
221
222			bit_buf \|= value << (32 - bit_left);
223			if (n >= bit_left) {
224			if (3 < s->buf_end - s->buf_ptr) {
225			AV_WL32(s->buf_ptr, bit_buf);
226			s->buf_ptr += 4;
227			} else {
228			av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
229			av_assert2(0);
230			}
231			bit_buf = value >> bit_left;
232			bit_left += 32;
233			}
234			bit_left -= n;
235
236			s->bit_buf = bit_buf;
237			s->bit_left = bit_left;
238			}
239
240		198869504	static inline void put_sbits(PutBitContext *pb, int n, int32_t value)
241			{
242			av_assert2(n >= 0 && n <= 31);
243
244		198869504	put_bits(pb, n, av_mod_uintp2(value, n));
245		198869504	}
246
247			/**
248			* Write exactly 32 bits into a bitstream.
249			*/
250		3677993	static void av_unused put_bits32(PutBitContext *s, uint32_t value)
251			{
252			unsigned int bit_buf;
253			int bit_left;
254
255		3677993	bit_buf = s->bit_buf;
256		3677993	bit_left = s->bit_left;
257
258			#ifdef BITSTREAM_WRITER_LE
259		41	bit_buf \|= value << (32 - bit_left);
260	✓✗	41	if (3 < s->buf_end - s->buf_ptr) {
261		41	AV_WL32(s->buf_ptr, bit_buf);
262		41	s->buf_ptr += 4;
263			} else {
264			av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
265			av_assert2(0);
266			}
267		41	bit_buf = (uint64_t)value >> bit_left;
268			#else
269		3677952	bit_buf = (uint64_t)bit_buf << bit_left;
270		3677952	bit_buf \|= value >> (32 - bit_left);
271	✓✗	3677952	if (3 < s->buf_end - s->buf_ptr) {
272		3677952	AV_WB32(s->buf_ptr, bit_buf);
273		3677952	s->buf_ptr += 4;
274			} else {
275			av_log(NULL, AV_LOG_ERROR, "Internal error, put_bits buffer too small\n");
276			av_assert2(0);
277			}
278		3677952	bit_buf = value;
279			#endif
280
281		3677993	s->bit_buf = bit_buf;
282		3677993	s->bit_left = bit_left;
283		3677993	}
284
285			/**
286			* Write up to 64 bits into a bitstream.
287			*/
288		8175	static inline void put_bits64(PutBitContext *s, int n, uint64_t value)
289			{
290			av_assert2((n == 64) \|\| (n < 64 && value < (UINT64_C(1) << n)));
291
292	✓✓	8175	if (n < 32)
293		4079	put_bits(s, n, value);
294	✗✓	4096	else if (n == 32)
295			put_bits32(s, value);
296	✓✗	4096	else if (n < 64) {
297		4096	uint32_t lo = value & 0xffffffff;
298		4096	uint32_t hi = value >> 32;
299			#ifdef BITSTREAM_WRITER_LE
300			put_bits32(s, lo);
301			put_bits(s, n - 32, hi);
302			#else
303		4096	put_bits(s, n - 32, hi);
304		4096	put_bits32(s, lo);
305			#endif
306			} else {
307			uint32_t lo = value & 0xffffffff;
308			uint32_t hi = value >> 32;
309			#ifdef BITSTREAM_WRITER_LE
310			put_bits32(s, lo);
311			put_bits32(s, hi);
312			#else
313			put_bits32(s, hi);
314			put_bits32(s, lo);
315			#endif
316
317			}
318		8175	}
319
320			/**
321			* Return the pointer to the byte where the bitstream writer will put
322			* the next bit.
323			*/
324		639765	static inline uint8_t put_bits_ptr(PutBitContext s)
325			{
326		639765	return s->buf_ptr;
327			}
328
329			/**
330			* Skip the given number of bytes.
331			* PutBitContext must be flushed & aligned to a byte boundary before calling this.
332			*/
333		168047	static inline void skip_put_bytes(PutBitContext *s, int n)
334			{
335			av_assert2((put_bits_count(s) & 7) == 0);
336			av_assert2(s->bit_left == 32);
337	✗✓	168047	av_assert0(n <= s->buf_end - s->buf_ptr);
338		168047	s->buf_ptr += n;
339		168047	}
340
341			/**
342			* Skip the given number of bits.
343			* Must only be used if the actual values in the bitstream do not matter.
344			* If n is 0 the behavior is undefined.
345			*/
346		200	static inline void skip_put_bits(PutBitContext *s, int n)
347			{
348		200	s->bit_left -= n;
349		200	s->buf_ptr -= 4 * (s->bit_left >> 5);
350		200	s->bit_left &= 31;
351		200	}
352
353			/**
354			* Change the end of the buffer.
355			*
356			* @param size the new size in bytes of the buffer where to put bits
357			*/
358		4054	static inline void set_put_bits_buffer_size(PutBitContext *s, int size)
359			{
360	✗✓	4054	av_assert0(size <= INT_MAX/8 - 32);
361		4054	s->buf_end = s->buf + size;
362		4054	s->size_in_bits = 8*size;
363		4054	}
364
365			#endif /* AVCODEC_PUT_BITS_H */