src/lib/openjp2/opj_codec.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  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32 #ifndef OPJ_CODEC_H
  33 #define OPJ_CODEC_H
  34 /**
  35 @file opj_codec.h
  36 */
  37
  38
  39 /**
  40  * Main codec handler used for compression or decompression.
  41  */
  42 typedef struct opj_codec_private {
  43     /** FIXME DOC */
  44     union {
  45         /**
  46          * Decompression handler.
  47          */
  48         struct opj_decompression {
  49             /** Main header reading function handler */
  50             OPJ_BOOL(*opj_read_header)(struct opj_stream_private * cio,
  51                                        void * p_codec,
  52                                        opj_image_t **p_image,
  53                                        struct opj_event_mgr * p_manager);
  54
  55             /** Decoding function */
  56             OPJ_BOOL(*opj_decode)(void * p_codec,
  57                                   struct opj_stream_private * p_cio,
  58                                   opj_image_t * p_image,
  59                                   struct opj_event_mgr * p_manager);
  60
  61             /** FIXME DOC */
  62             OPJ_BOOL(*opj_read_tile_header)(void * p_codec,
  63                                             OPJ_UINT32 * p_tile_index,
  64                                             OPJ_UINT32 * p_data_size,
  65                                             OPJ_INT32 * p_tile_x0,
  66                                             OPJ_INT32 * p_tile_y0,
  67                                             OPJ_INT32 * p_tile_x1,
  68                                             OPJ_INT32 * p_tile_y1,
  69                                             OPJ_UINT32 * p_nb_comps,
  70                                             OPJ_BOOL * p_should_go_on,
  71                                             struct opj_stream_private * p_cio,
  72                                             struct opj_event_mgr * p_manager);
  73
  74             /** FIXME DOC */
  75             OPJ_BOOL(*opj_decode_tile_data)(void * p_codec,
  76                                             OPJ_UINT32 p_tile_index,
  77                                             OPJ_BYTE * p_data,
  78                                             OPJ_UINT32 p_data_size,
  79                                             struct opj_stream_private * p_cio,
  80                                             struct opj_event_mgr * p_manager);
  81
  82             /** Reading function used after codestream if necessary */
  83             OPJ_BOOL(* opj_end_decompress)(void *p_codec,
  84                                            struct opj_stream_private * cio,
  85                                            struct opj_event_mgr * p_manager);
  86
  87             /** Codec destroy function handler */
  88             void (*opj_destroy)(void * p_codec);
  89
  90             /** Setup decoder function handler */
  91             void (*opj_setup_decoder)(void * p_codec, opj_dparameters_t * p_param);
  92
  93             /** Strict mode function handler */
  94             void (*opj_decoder_set_strict_mode)(void * p_codec, OPJ_BOOL strict);
  95
  96             /** Set decode area function handler */
  97             OPJ_BOOL(*opj_set_decode_area)(void * p_codec,
  98                                            opj_image_t * p_image,
  99                                            OPJ_INT32 p_start_x,
 100                                            OPJ_INT32 p_end_x,
 101                                            OPJ_INT32 p_start_y,
 102                                            OPJ_INT32 p_end_y,
 103                                            struct opj_event_mgr * p_manager);
 104
 105             /** Get tile function */
 106             OPJ_BOOL(*opj_get_decoded_tile)(void *p_codec,
 107                                             opj_stream_private_t * p_cio,
 108                                             opj_image_t *p_image,
 109                                             struct opj_event_mgr * p_manager,
 110                                             OPJ_UINT32 tile_index);
 111
 112             /** Set the decoded resolution factor */
 113             OPJ_BOOL(*opj_set_decoded_resolution_factor)(void * p_codec,
 114                     OPJ_UINT32 res_factor,
 115                     opj_event_mgr_t * p_manager);
 116
 117             /** Set the decoded components */
 118             OPJ_BOOL(*opj_set_decoded_components)(void * p_codec,
 119                                                   OPJ_UINT32 num_comps,
 120                                                   const OPJ_UINT32* comps_indices,
 121                                                   opj_event_mgr_t * p_manager);
 122         } m_decompression;
 123
 124         /**
 125          * Compression handler. FIXME DOC
 126          */
 127         struct opj_compression {
 128             OPJ_BOOL(* opj_start_compress)(void *p_codec,
 129                                            struct opj_stream_private * cio,
 130                                            struct opj_image * p_image,
 131                                            struct opj_event_mgr * p_manager);
 132
 133             OPJ_BOOL(* opj_encode)(void * p_codec,
 134                                    struct opj_stream_private *p_cio,
 135                                    struct opj_event_mgr * p_manager);
 136
 137             OPJ_BOOL(* opj_write_tile)(void * p_codec,
 138                                        OPJ_UINT32 p_tile_index,
 139                                        OPJ_BYTE * p_data,
 140                                        OPJ_UINT32 p_data_size,
 141                                        struct opj_stream_private * p_cio,
 142                                        struct opj_event_mgr * p_manager);
 143
 144             OPJ_BOOL(* opj_end_compress)(void * p_codec,
 145                                          struct opj_stream_private * p_cio,
 146                                          struct opj_event_mgr * p_manager);
 147
 148             void (* opj_destroy)(void * p_codec);
 149
 150             OPJ_BOOL(* opj_setup_encoder)(void * p_codec,
 151                                           opj_cparameters_t * p_param,
 152                                           struct opj_image * p_image,
 153                                           struct opj_event_mgr * p_manager);
 154
 155             OPJ_BOOL(* opj_encoder_set_extra_options)(void * p_codec,
 156                     const char* const* p_options,
 157                     struct opj_event_mgr * p_manager);
 158
 159         } m_compression;
 160     } m_codec_data;
 161     /** FIXME DOC*/
 162     void * m_codec;
 163     /** Event handler */
 164     opj_event_mgr_t m_event_mgr;
 165     /** Flag to indicate if the codec is used to decode or encode*/
 166     OPJ_BOOL is_decompressor;
 167     void (*opj_dump_codec)(void * p_codec, OPJ_INT32 info_flag,
 168                            FILE* output_stream);
 169     opj_codestream_info_v2_t* (*opj_get_codec_info)(void* p_codec);
 170     opj_codestream_index_t* (*opj_get_codec_index)(void* p_codec);
 171
 172     /** Set number of threads */
 173     OPJ_BOOL(*opj_set_threads)(void * p_codec, OPJ_UINT32 num_threads);
 174 }
 175 opj_codec_private_t;
 176
 177
 178 #endif /* OPJ_CODEC_H */
 179