/src/FreeImage/Source/LibOpenJPEG/bio.h

  1/*
  2 * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
  3 * Copyright (c) 2002-2007, Professor Benoit Macq
  4 * Copyright (c) 2001-2003, David Janssens
  5 * Copyright (c) 2002-2003, Yannick Verschueren
  6 * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
  7 * Copyright (c) 2005, Herve Drolon, FreeImage Team
  8 * All rights reserved.
  9 *
 10 * Redistribution and use in source and binary forms, with or without
 11 * modification, are permitted provided that the following conditions
 12 * are met:
 13 * 1. Redistributions of source code must retain the above copyright
 14 *    notice, this list of conditions and the following disclaimer.
 15 * 2. Redistributions in binary form must reproduce the above copyright
 16 *    notice, this list of conditions and the following disclaimer in the
 17 *    documentation and/or other materials provided with the distribution.
 18 *
 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 29 * POSSIBILITY OF SUCH DAMAGE.
 30 */
 31
 32#ifndef __BIO_H
 33#define __BIO_H
 34/** 
 35@file bio.h
 36@brief Implementation of an individual bit input-output (BIO)
 37
 38The functions in BIO.C have for goal to realize an individual bit input - output.
 39*/
 40
 41/** @defgroup BIO BIO - Individual bit input-output stream */
 42/*@{*/
 43
 44/**
 45Individual bit input-output stream (BIO)
 46*/
 47typedef struct opj_bio {
 48	/** pointer to the start of the buffer */
 49	unsigned char *start;
 50	/** pointer to the end of the buffer */
 51	unsigned char *end;
 52	/** pointer to the present position in the buffer */
 53	unsigned char *bp;
 54	/** temporary place where each byte is read or written */
 55	unsigned int buf;
 56	/** coder : number of bits free to write. decoder : number of bits read */
 57	int ct;
 58} opj_bio_t;
 59
 60/** @name Exported functions */
 61/*@{*/
 62/* ----------------------------------------------------------------------- */
 63/**
 64Create a new BIO handle 
 65@return Returns a new BIO handle if successful, returns NULL otherwise
 66*/
 67opj_bio_t* bio_create(void);
 68/**
 69Destroy a previously created BIO handle
 70@param bio BIO handle to destroy
 71*/
 72void bio_destroy(opj_bio_t *bio);
 73/**
 74Number of bytes written.
 75@param bio BIO handle
 76@return Returns the number of bytes written
 77*/
 78int bio_numbytes(opj_bio_t *bio);
 79/**
 80Init encoder
 81@param bio BIO handle
 82@param bp Output buffer
 83@param len Output buffer length 
 84*/
 85void bio_init_enc(opj_bio_t *bio, unsigned char *bp, int len);
 86/**
 87Init decoder
 88@param bio BIO handle
 89@param bp Input buffer
 90@param len Input buffer length 
 91*/
 92void bio_init_dec(opj_bio_t *bio, unsigned char *bp, int len);
 93/**
 94Write bits
 95@param bio BIO handle
 96@param v Value of bits
 97@param n Number of bits to write
 98*/
 99void bio_write(opj_bio_t *bio, int v, int n);
100/**
101Read bits
102@param bio BIO handle
103@param n Number of bits to read 
104@return Returns the corresponding read number
105*/
106int bio_read(opj_bio_t *bio, int n);
107/**
108Flush bits
109@param bio BIO handle
110@return Returns 1 if successful, returns 0 otherwise
111*/
112int bio_flush(opj_bio_t *bio);
113/**
114Passes the ending bits (coming from flushing)
115@param bio BIO handle
116@return Returns 1 if successful, returns 0 otherwise
117*/
118int bio_inalign(opj_bio_t *bio);
119/* ----------------------------------------------------------------------- */
120/*@}*/
121
122/*@}*/
123
124#endif /* __BIO_H */
125