libopenjpeg/cio.h

   1 /*
   2  * Copyright (c) 2001-2002, David Janssens
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24  * POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef __CIO_H
  28 #define __CIO_H
  29
  30 /*
  31  * Number of bytes written.
  32  *
  33  * returns number of bytes written
  34  */
  35 int cio_numbytes();
  36
  37 /*
  38  * Get position in byte stream.
  39  *
  40  * return position in bytes
  41  */
  42 int cio_tell();
  43
  44 /*
  45  * Set position in byte stream.
  46  *
  47  * pos : position, in number of bytes, from the beginning of the stream
  48  */
  49 void cio_seek(int pos);
  50
  51 /*
  52  * Number of bytes left before the end of the stream.
  53  *
  54  * Returns the number of bytes before the end of the stream
  55  */
  56 int cio_numbytesleft();
  57
  58 /*
  59  * Get pointer to the current position in the stream.
  60  *
  61  * return : pointer to the position
  62  */
  63 unsigned char *cio_getbp();
  64
  65 /*
  66  * Initialize byte IO
  67  *
  68  * bp  : destination/source stream
  69  * len : length of the stream
  70  */
  71 void cio_init(unsigned char *bp, int len);
  72
  73 /*
  74  * Write some bytes.
  75  *
  76  * v : value to write
  77  * n : number of bytes to write
  78  */
  79 void cio_write(unsigned int v, int n);
  80
  81 /*
  82  * Read some bytes.
  83  *
  84  * n : number of bytes to read
  85  *
  86  * return : value of the n bytes read
  87  */
  88 unsigned int cio_read(int n);
  89
  90 /*
  91  * Skip some bytes.
  92  *
  93  * n : number of bytes to skip
  94  */
  95 void cio_skip(int n);
  96
  97 /*
  98  * Read n bytes, copy to buffer
  99  */
 100 void cio_read_to_buf(unsigned char* src_buf, int n);/* Glenn Pearson adds */
 101
 102 /*
 103  * Write n bytes, copy from buffer
 104  */
 105 void cio_write_from_buf(unsigned char* dest_buf, int n);/* Glenn Pearson adds */
 106
 107 #endif