OpenJPEG 1.5.1
Data Structures | Typedefs
bio.h File Reference

Implementation of an individual bit input-output (BIO) More...

Go to the source code of this file.

Data Structures

struct  opj_bio
 Individual bit input-output stream (BIO) More...
 

Typedefs

typedef struct opj_bio opj_bio_t
 Individual bit input-output stream (BIO)
 

Functions

Exported functions
opj_bio_tbio_create (void)
 Create a new BIO handle.
 
void bio_destroy (opj_bio_t *bio)
 Destroy a previously created BIO handle.
 
int bio_numbytes (opj_bio_t *bio)
 Number of bytes written.
 
void bio_init_enc (opj_bio_t *bio, unsigned char *bp, int len)
 Init encoder.
 
void bio_init_dec (opj_bio_t *bio, unsigned char *bp, int len)
 Init decoder.
 
void bio_write (opj_bio_t *bio, int v, int n)
 Write bits.
 
int bio_read (opj_bio_t *bio, int n)
 Read bits.
 
int bio_flush (opj_bio_t *bio)
 Flush bits.
 
int bio_inalign (opj_bio_t *bio)
 Passes the ending bits (coming from flushing)
 

Detailed Description

Implementation of an individual bit input-output (BIO)

The functions in BIO.C have for goal to realize an individual bit input - output.

Typedef Documentation

◆ opj_bio_t

typedef struct opj_bio opj_bio_t

Individual bit input-output stream (BIO)

Function Documentation

◆ bio_create()

opj_bio_t * bio_create ( void )

Create a new BIO handle.

Returns
Returns a new BIO handle if successful, returns NULL otherwise

References opj_malloc.

Referenced by t2_decode_packet(), and t2_encode_packet().

◆ bio_destroy()

void bio_destroy ( opj_bio_t * bio)

Destroy a previously created BIO handle.

Parameters
bioBIO handle to destroy

References opj_free.

Referenced by t2_decode_packet(), and t2_encode_packet().

◆ bio_flush()

int bio_flush ( opj_bio_t * bio)

Flush bits.

Parameters
bioBIO handle
Returns
Returns 1 if successful, returns 0 otherwise

References bio_byteout(), and opj_bio::ct.

Referenced by t2_encode_packet().

◆ bio_inalign()

int bio_inalign ( opj_bio_t * bio)

Passes the ending bits (coming from flushing)

Parameters
bioBIO handle
Returns
Returns 1 if successful, returns 0 otherwise

References bio_bytein(), opj_bio::buf, and opj_bio::ct.

Referenced by t2_decode_packet().

◆ bio_init_dec()

void bio_init_dec ( opj_bio_t * bio,
unsigned char * bp,
int len )

Init decoder.

Parameters
bioBIO handle
bpInput buffer
lenInput buffer length

References opj_bio::bp, opj_bio::buf, opj_bio::ct, opj_bio::end, and opj_bio::start.

Referenced by t2_decode_packet().

◆ bio_init_enc()

void bio_init_enc ( opj_bio_t * bio,
unsigned char * bp,
int len )

Init encoder.

Parameters
bioBIO handle
bpOutput buffer
lenOutput buffer length

References opj_bio::bp, opj_bio::buf, opj_bio::ct, opj_bio::end, and opj_bio::start.

Referenced by t2_encode_packet().

◆ bio_numbytes()

int bio_numbytes ( opj_bio_t * bio)

Number of bytes written.

Parameters
bioBIO handle
Returns
Returns the number of bytes written

References opj_bio::bp, and opj_bio::start.

Referenced by t2_decode_packet(), and t2_encode_packet().

◆ bio_read()

int bio_read ( opj_bio_t * bio,
int n )

Read bits.

Parameters
bioBIO handle
nNumber of bits to read
Returns
Returns the corresponding read number

References bio_getbit().

Referenced by t2_decode_packet(), t2_getcommacode(), t2_getnumpasses(), and tgt_decode().

◆ bio_write()

void bio_write ( opj_bio_t * bio,
int v,
int n )

Write bits.

Parameters
bioBIO handle
vValue of bits
nNumber of bits to write

References bio_putbit().

Referenced by t2_encode_packet(), t2_putcommacode(), t2_putnumpasses(), and tgt_encode().