libopenjpeg/jp2.h

   1 /*
   2  * Copyright (c) 2003, Yannick Verschueren
   3  * Copyright (c) 2003,  Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27 #ifndef __JP2_H
  28 #define __JP2_H
  29
  30 #include "j2k.h"
  31
  32 typedef struct {
  33   int depth;
  34   int sgnd;
  35   int bpcc;
  36 } jp2_comps_t;
  37
  38 typedef struct {
  39   unsigned int w;
  40   unsigned int h;
  41   unsigned int numcomps;
  42   unsigned int bpc;
  43   unsigned int C;
  44   unsigned int UnkC;
  45   unsigned int IPR;
  46   unsigned int meth;
  47   unsigned int approx;
  48   unsigned int enumcs;
  49   unsigned int precedence;
  50   unsigned int brand;
  51   unsigned int minversion;
  52   unsigned int numcl;
  53   unsigned int *cl;
  54   jp2_comps_t *comps;
  55   j2k_image_t *image;
  56   unsigned int j2k_codestream_offset;
  57   unsigned int j2k_codestream_len;
  58 } jp2_struct_t;
  59
  60 typedef struct {
  61   int length;
  62   int type;
  63   int init_pos;
  64 } jp2_box_t;
  65
  66 /* int jp2_init_stdjp2(jp2_struct_t * jp2_struct, j2k_image_t * img);
  67  *
  68  * Create a standard jp2_structure
  69  * jp2_struct: the structure you are creating
  70  * img: a j2k_image_t wich will help you to create the jp2_structure
  71  */
  72 int jp2_init_stdjp2(jp2_struct_t * jp2_struct);
  73
  74 /* int jp2_write_jp2c(int j2k_len, int *j2k_codestream_offset, char *j2k_codestream)
  75  *
  76  * Write the jp2c codestream box
  77  * j2k_len: the j2k codestream length
  78  * j2k_codestream_offset: the function will return the j2k codestream offset
  79  * j2k_codestream: the j2k codestream to include in jp2 file
  80  */
  81 int jp2_write_jp2c(int j2k_len, int *j2k_codestream_offset, char *j2k_codestream);
  82
  83 /* int jp2_write_jp2h(jp2_struct_t * jp2_struct);
  84  *
  85  * Write the jp2h header box
  86  * jp2_struct: the jp2 structure you are working with
  87  */
  88 void jp2_write_jp2h(jp2_struct_t * jp2_struct);
  89
  90 /* int jp2_read_jp2h(jp2_struct_t * jp2_struct);
  91  *
  92  * Read the jp2h header box
  93  * jp2_struct: the jp2 structure you are working with
  94  */
  95 int jp2_read_jp2h(jp2_struct_t * jp2_struct);
  96
  97 /* int jp2_wrap_j2k(jp2_struct_t * jp2_struct, char *j2k_codestream,
  98           int j2k_len, char *output)
  99  *
 100  * Wrap a J2K codestream in a JP2 file
 101  * jp2_struct: the jp2 structure used to create jp2 boxes
 102  * j2k_codestream: the j2k codestream to include in jp2 file
 103  * output: pointer to jp2 codestream that will be created
 104  */
 105 int jp2_wrap_j2k(jp2_struct_t * jp2_struct, char *j2k_codestream,
 106                   char *output);
 107
 108
 109 /* int jp2_read_struct(unsigned char *src, jp2_struct_t * jp2_struct);
 110  *
 111  * Decode the structure of a JP2 file
 112  * src: pointer to memory where compressed data is stored
 113  * jp2_struct: the jp2 structure that will be created
 114  * len: length of jp2 codestream
 115  */
 116 int jp2_read_struct(unsigned char *src, jp2_struct_t * jp2_struct, int len);
 117
 118 #endif