src/lib/openjp2/raw.h

   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) 2003-2007, Francois-Olivier Devaux
  10  * Copyright (c) 2003-2014, Antonin Descampe
  11  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  24  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  * POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 #ifndef __RAW_H
  37 #define __RAW_H
  38 /**
  39 @file raw.h
  40 @brief Implementation of operations for raw encoding (RAW)
  41
  42 The functions in RAW.C have for goal to realize the operation of raw encoding linked
  43 with the corresponding mode switch.
  44 */
  45
  46 /** @defgroup RAW RAW - Implementation of operations for raw encoding */
  47 /*@{*/
  48
  49 /**
  50 RAW encoding operations
  51 */
  52 typedef struct opj_raw {
  53         /** temporary buffer where bits are coded or decoded */
  54         OPJ_BYTE c;
  55         /** number of bits already read or free to write */
  56         OPJ_UINT32 ct;
  57         /** maximum length to decode */
  58         OPJ_UINT32 lenmax;
  59         /** length decoded */
  60         OPJ_UINT32 len;
  61         /** pointer to the current position in the buffer */
  62         OPJ_BYTE *bp;
  63         /** pointer to the start of the buffer */
  64         OPJ_BYTE *start;
  65         /** pointer to the end of the buffer */
  66         OPJ_BYTE *end;
  67 } opj_raw_t;
  68
  69 /** @name Exported functions */
  70 /*@{*/
  71 /* ----------------------------------------------------------------------- */
  72 /**
  73 Create a new RAW handle
  74 @return Returns a new RAW handle if successful, returns NULL otherwise
  75 */
  76 opj_raw_t* opj_raw_create(void);
  77 /**
  78 Destroy a previously created RAW handle
  79 @param raw RAW handle to destroy
  80 */
  81 void opj_raw_destroy(opj_raw_t *raw);
  82 /**
  83 Return the number of bytes written/read since initialisation
  84 @param raw RAW handle to destroy
  85 @return Returns the number of bytes already encoded
  86 */
  87 OPJ_UINT32 opj_raw_numbytes(opj_raw_t *raw);
  88 /**
  89 Initialize the decoder
  90 @param raw RAW handle
  91 @param bp Pointer to the start of the buffer from which the bytes will be read
  92 @param len Length of the input buffer
  93 */
  94 void opj_raw_init_dec(opj_raw_t *raw, OPJ_BYTE *bp, OPJ_UINT32 len);
  95 /**
  96 Decode a symbol using raw-decoder. Cfr p.506 TAUBMAN
  97 @param raw RAW handle
  98 @return Returns the decoded symbol (0 or 1)
  99 */
 100 OPJ_UINT32 opj_raw_decode(opj_raw_t *raw);
 101 /* ----------------------------------------------------------------------- */
 102 /*@}*/
 103
 104 /*@}*/
 105
 106 #endif /* __RAW_H */