OpenJPEG: bio.h Source File

OpenJPEG 2.5.4

bio.h
Go to the documentation of this file.
1/*
2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
6 *
7 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
8 * Copyright (c) 2002-2014, Professor Benoit Macq
9 * Copyright (c) 2001-2003, David Janssens
10 * Copyright (c) 2002-2003, Yannick Verschueren
11 * Copyright (c) 2003-2007, Francois-Olivier Devaux
12 * Copyright (c) 2003-2014, Antonin Descampe
13 * Copyright (c) 2005, Herve Drolon, FreeImage Team
14 * All rights reserved.
15 *
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38#ifndef OPJ_BIO_H
39#define OPJ_BIO_H
40
41#include <stddef.h> /* ptrdiff_t */
42
49
52
56 typedef struct opj_bio {
58 OPJ_BYTE *start;
60 OPJ_BYTE *end;
62 OPJ_BYTE *bp;
64 OPJ_UINT32 buf;
66 OPJ_UINT32 ct;
67} opj_bio_t;
68
71/* ----------------------------------------------------------------------- */
76 opj_bio_t* opj_bio_create(void);
81void opj_bio_destroy(opj_bio_t *bio);
87ptrdiff_t opj_bio_numbytes(opj_bio_t *bio);
94void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len);
101void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len);
108void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n);
109
115void opj_bio_putbit(opj_bio_t *bio, OPJ_UINT32 b);
116
123 OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n);
129 OPJ_BOOL opj_bio_flush(opj_bio_t *bio);
135 OPJ_BOOL opj_bio_inalign(opj_bio_t *bio);
136/* ----------------------------------------------------------------------- */
138
140
141#endif /* OPJ_BIO_H */
142
opj_bio_init_enc
void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
Init encoder.
Definition bio.c:131
opj_bio_write
void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n)
Write bits.
Definition bio.c:159
opj_bio_destroy
void opj_bio_destroy(opj_bio_t *bio)
Destroy a previously created BIO handle.
Definition bio.c:119
opj_bio_inalign
OPJ_BOOL opj_bio_inalign(opj_bio_t *bio)
Passes the ending bits (coming from flushing)
Definition bio.c:202
opj_bio_init_dec
void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
Init decoder.
Definition bio.c:140
opj_bio_putbit
void opj_bio_putbit(opj_bio_t *bio, OPJ_UINT32 b)
Write a bit.
Definition bio.c:149
opj_bio_numbytes
ptrdiff_t opj_bio_numbytes(opj_bio_t *bio)
Number of bytes written.
Definition bio.c:126
opj_bio_flush
OPJ_BOOL opj_bio_flush(opj_bio_t *bio)
Flush bits.
Definition bio.c:189
opj_bio_t
struct opj_bio opj_bio_t
Individual bit input-output stream (BIO)
opj_bio_create
opj_bio_t * opj_bio_create(void)
Create a new BIO handle.
Definition bio.c:113
opj_bio_read
OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n)
Read bits.
Definition bio.c:169
OPJ_BYTE
unsigned char OPJ_BYTE
Definition openjpeg.h:123
OPJ_UINT32
uint32_t OPJ_UINT32
Definition openjpeg.h:132
OPJ_BOOL
int OPJ_BOOL
Definition openjpeg.h:116
opj_bio
Individual bit input-output stream (BIO)
Definition bio.h:56
opj_bio::start
OPJ_BYTE * start
pointer to the start of the buffer
Definition bio.h:58
opj_bio::ct
OPJ_UINT32 ct
coder : number of bits free to write.
Definition bio.h:66
opj_bio::end
OPJ_BYTE * end
pointer to the end of the buffer
Definition bio.h:60
opj_bio::buf
OPJ_UINT32 buf
temporary place where each byte is read or written
Definition bio.h:64
opj_bio::bp
OPJ_BYTE * bp
pointer to the present position in the buffer
Definition bio.h:62