OpenJPEG 2.3.1

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
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);
81 void opj_bio_destroy(opj_bio_t *bio);
87 ptrdiff_t opj_bio_numbytes(opj_bio_t *bio);
94 void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len);
101 void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len);
108 void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n);
115 OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n);
121 OPJ_BOOL opj_bio_flush(opj_bio_t *bio);
127 OPJ_BOOL opj_bio_inalign(opj_bio_t *bio);
128 /* ----------------------------------------------------------------------- */
132
133 #endif /* OPJ_BIO_H */
134
opj_bio::end
OPJ_BYTE * end
pointer to the end of the buffer
Definition: bio.h:60
OPJ_BYTE
unsigned char OPJ_BYTE
Definition: openjpeg.h:117
OPJ_FLOAT32
float OPJ_FLOAT32
Definition: openjpeg.h:115
opj_bio_numbytes
ptrdiff_t opj_bio_numbytes(opj_bio_t *bio)
Number of bytes written.
Definition: bio.c:142
opj_calloc
void * opj_calloc(size_t num, size_t size)
Allocate a memory block with elements initialized to 0.
Definition: opj_malloc.c:198
opj_clock
OPJ_FLOAT64 opj_clock(void)
Difference in successive opj_clock() calls tells you the elapsed time.
Definition: bench_dwt.c:116
opj_tcd::image
opj_image_t * image
image header
Definition: tcd.h:265
opj_image_comp::dy
OPJ_UINT32 dy
YRsiz: vertical separation of a sample of ith component with respect to the reference grid.
Definition: openjpeg.h:675
opj_bio_init_enc
void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
Init encoder.
Definition: bio.c:147
opj_thread_pool_destroy
void opj_thread_pool_destroy(opj_thread_pool_t *tp)
Destroy a thread pool.
Definition: thread.c:919
usage
void usage(void)
Definition: bench_dwt.c:106
opj_bio_destroy
void opj_bio_destroy(opj_bio_t *bio)
Destroy a previously created BIO handle.
Definition: bio.c:135
opj_tcd_resolution::x0
OPJ_INT32 x0
Definition: tcd.h:173
opj_bio_flush
OPJ_BOOL opj_bio_flush(opj_bio_t *bio)
Flush bits.
Definition: bio.c:195
main
int main(int argc, char **argv)
Definition: bench_dwt.c:153
opj_tcd_resolution::y1
OPJ_INT32 y1
Definition: tcd.h:173
opj_tcd_resolution::x1
OPJ_INT32 x1
Definition: tcd.h:173
opj_image::numcomps
OPJ_UINT32 numcomps
number of components in the image
Definition: openjpeg.h:713
opj_bio_read
OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n)
Read bits.
Definition: bio.c:175
opj_bio_create
opj_bio_t * opj_bio_create(void)
Create a new BIO handle.
Definition: bio.c:129
opj_bio_destroy
void opj_bio_destroy(opj_bio_t *bio)
Destroy a previously created BIO handle.
Definition: bio.c:135
opj_tcd_tilecomp::x1
OPJ_INT32 x1
Definition: tcd.h:191
opj_bio_init_dec
void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
Init decoder.
Definition: bio.c:156
opj_bio_write
void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n)
Write bits.
Definition: bio.c:165
opj_image_comp
Defines a single image component.
Definition: openjpeg.h:671
opj_tcd_tilecomp::resolutions
opj_tcd_resolution_t * resolutions
Definition: tcd.h:199
opj_dwt_encode
OPJ_BOOL opj_dwt_encode(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *tilec)
Forward 5-3 wavelet transform in 2-D.
Definition: dwt.c:1899
opj_bio_putbit
static void opj_bio_putbit(opj_bio_t *bio, OPJ_UINT32 b)
Write a bit.
Definition: bio.c:103
opj_bio_flush
OPJ_BOOL opj_bio_flush(opj_bio_t *bio)
Flush bits.
Definition: bio.c:195
OPJ_FLOAT64
double OPJ_FLOAT64
Definition: openjpeg.h:116
opj_tcd_tilecomp::x0
OPJ_INT32 x0
Definition: tcd.h:191
opj_bio::start
OPJ_BYTE * start
pointer to the start of the buffer
Definition: bio.h:58
opj_tcd::win_y0
OPJ_UINT32 win_y0
Definition: tcd.h:278
opj_dwt_encode_real
OPJ_BOOL opj_dwt_encode_real(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *tilec)
Forward 9-7 wavelet transform in 2-D.
Definition: dwt.c:1939
opj_tcd_tile::x1
OPJ_INT32 x1
Definition: tcd.h:230
opj_tcd::whole_tile_decoding
OPJ_BOOL whole_tile_decoding
Only valid for decoding.
Definition: tcd.h:282
opj_tcd_image
FIXME DOC.
Definition: tcd.h:242
opj_bio::buf
OPJ_UINT32 buf
temporary place where each byte is read or written
Definition: bio.h:64
opj_tcd_tilecomp::minimum_num_resolutions
OPJ_UINT32 minimum_num_resolutions
Definition: tcd.h:197
OPJ_BOOL
int OPJ_BOOL
Definition: openjpeg.h:110
OPJ_SIZE_T
size_t OPJ_SIZE_T
Definition: openjpeg.h:133
opj_includes.h
opj_bio
Individual bit input-output stream (BIO)
Definition: bio.h:56
getValue
OPJ_INT32 getValue(OPJ_UINT32 i)
Definition: bench_dwt.c:42
opj_tcd_resolution
Tile-component resolution structure.
Definition: tcd.h:171
opj_tcd::win_y1
OPJ_UINT32 win_y1
Definition: tcd.h:280
opj_tcd_image::tiles
opj_tcd_tile_t * tiles
Definition: tcd.h:243
opj_tcd_tilecomp
Tile-component structure.
Definition: tcd.h:189
OPJ_INT32
int32_t OPJ_INT32
Definition: openjpeg.h:125
init_tilec
void init_tilec(opj_tcd_tilecomp_t *l_tilec, OPJ_INT32 x0, OPJ_INT32 y0, OPJ_INT32 x1, OPJ_INT32 y1, OPJ_UINT32 numresolutions, OPJ_BOOL irreversible)
Definition: bench_dwt.c:47
opj_bio::bp
OPJ_BYTE * bp
pointer to the present position in the buffer
Definition: bio.h:62
opj_bio_getbit
static OPJ_UINT32 opj_bio_getbit(opj_bio_t *bio)
Read a bit.
Definition: bio.c:113
opj_bio_write
void opj_bio_write(opj_bio_t *bio, OPJ_UINT32 v, OPJ_UINT32 n)
Write bits.
Definition: bio.c:165
opj_tcd_resolution::y0
OPJ_INT32 y0
Definition: tcd.h:173
opj_bio_numbytes
ptrdiff_t opj_bio_numbytes(opj_bio_t *bio)
Number of bytes written.
Definition: bio.c:142
opj_tcd_tile::x0
OPJ_INT32 x0
Definition: tcd.h:230
OPJ_TRUE
#define OPJ_TRUE
Definition: openjpeg.h:111
opj_malloc
void * opj_malloc(size_t size)
Allocate an uninitialized memory block.
Definition: opj_malloc.c:191
opj_tcd_tile::y1
OPJ_INT32 y1
Definition: tcd.h:230
opj_tcd_tilecomp::numresolutions
OPJ_UINT32 numresolutions
Definition: tcd.h:195
opj_tcd_tilecomp::y0
OPJ_INT32 y0
Definition: tcd.h:191
opj_bio_init_dec
void opj_bio_init_dec(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
Init decoder.
Definition: bio.c:156
opj_free
void opj_free(void *ptr)
Deallocates or frees a memory block.
Definition: opj_malloc.c:246
opj_tcd_tile::numcomps
OPJ_UINT32 numcomps
Definition: tcd.h:231
opj_tcd::win_x1
OPJ_UINT32 win_x1
Definition: tcd.h:279
opj_bio_init_enc
void opj_bio_init_enc(opj_bio_t *bio, OPJ_BYTE *bp, OPJ_UINT32 len)
Init encoder.
Definition: bio.c:147
opj_bio_inalign
OPJ_BOOL opj_bio_inalign(opj_bio_t *bio)
Passes the ending bits (coming from flushing)
Definition: bio.c:208
opj_tcd_tilecomp::data
OPJ_INT32 * data
Definition: tcd.h:204
opj_tcd::tcd_image
opj_tcd_image_t * tcd_image
info on each image tile
Definition: tcd.h:263
opj_bio_byteout
static OPJ_BOOL opj_bio_byteout(opj_bio_t *bio)
Write a byte.
Definition: bio.c:81
opj_dwt_decode
OPJ_BOOL opj_dwt_decode(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *tilec, OPJ_UINT32 numres)
Inverse 5-3 wavelet transform in 2-D.
Definition: dwt.c:1910
opj_thread_pool_create
opj_thread_pool_t * opj_thread_pool_create(int num_threads)
Create a new thread pool.
Definition: thread.c:625
opj_tcd::thread_pool
opj_thread_pool_t * thread_pool
Thread pool.
Definition: tcd.h:275
opj_tcd_tile
FIXME DOC.
Definition: tcd.h:228
opj_bio_inalign
OPJ_BOOL opj_bio_inalign(opj_bio_t *bio)
Passes the ending bits (coming from flushing)
Definition: bio.c:208
opj_wallclock
static OPJ_FLOAT64 opj_wallclock(void)
Definition: bench_dwt.c:142
opj_image::comps
opj_image_comp_t * comps
image components
Definition: openjpeg.h:717
opj_bio_bytein
static OPJ_BOOL opj_bio_bytein(opj_bio_t *bio)
Read a byte.
Definition: bio.c:92
opj_tcd_tilecomp::y1
OPJ_INT32 y1
Definition: tcd.h:191
OPJ_UINT32
uint32_t OPJ_UINT32
Definition: openjpeg.h:126
opj_image_comp::dx
OPJ_UINT32 dx
XRsiz: horizontal separation of a sample of ith component with respect to the reference grid.
Definition: openjpeg.h:673
opj_bio_read
OPJ_UINT32 opj_bio_read(opj_bio_t *bio, OPJ_UINT32 n)
Read bits.
Definition: bio.c:175
opj_bio_create
opj_bio_t * opj_bio_create(void)
Create a new BIO handle.
Definition: bio.c:129
OPJ_FALSE
#define OPJ_FALSE
Definition: openjpeg.h:112
opj_tcd_tile::y0
OPJ_INT32 y0
Definition: tcd.h:230
opj_bio_t
struct opj_bio opj_bio_t
Individual bit input-output stream (BIO)
opj_dwt_decode_real
OPJ_BOOL opj_dwt_decode_real(opj_tcd_t *p_tcd, opj_tcd_tilecomp_t *OPJ_RESTRICT tilec, OPJ_UINT32 numres)
Inverse 9-7 wavelet transform in 2-D.
Definition: dwt.c:3747
opj_tcd::win_x0
OPJ_UINT32 win_x0
Coordinates of the window of interest, in grid reference space.
Definition: tcd.h:277
free_tilec
void free_tilec(opj_tcd_tilecomp_t *l_tilec)
Definition: bench_dwt.c:100
opj_image
Defines image data and characteristics.
Definition: openjpeg.h:703
opj_tcd_tile::comps
opj_tcd_tilecomp_t * comps
Definition: tcd.h:232
opj_int_ceildivpow2
static INLINE OPJ_INT32 opj_int_ceildivpow2(OPJ_INT32 a, OPJ_INT32 b)
Divide an integer by a power of 2 and round upwards.
Definition: opj_intmath.h:180
opj_thread_pool_t
Definition: thread.c:605
opj_tcd
Tile coder/decoder.
Definition: tcd.h:251
opj_bio::ct
OPJ_UINT32 ct
coder : number of bits free to write.
Definition: bio.h:66