Home | History | Annotate | Download | only in libopenjpeg20
      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 {
     44     /** FIXME DOC */
     45     union
     46     {
     47         /**
     48          * Decompression handler.
     49          */
     50         struct opj_decompression
     51         {
     52             /** Main header reading function handler */
     53             OPJ_BOOL (*opj_read_header) ( struct opj_stream_private * cio,
     54                                           void * p_codec,
     55                                           opj_image_t **p_image,
     56                                           struct opj_event_mgr * p_manager);
     57 
     58             /** Decoding function */
     59             OPJ_BOOL (*opj_decode) ( void * p_codec,
     60                                      struct opj_stream_private * p_cio,
     61                                      opj_image_t * p_image,
     62                                      struct opj_event_mgr * p_manager);
     63 
     64             /** FIXME DOC */
     65             OPJ_BOOL (*opj_read_tile_header)( void * p_codec,
     66                                               OPJ_UINT32 * p_tile_index,
     67                                               OPJ_UINT32 * p_data_size,
     68                                               OPJ_INT32 * p_tile_x0,
     69                                               OPJ_INT32 * p_tile_y0,
     70                                               OPJ_INT32 * p_tile_x1,
     71                                               OPJ_INT32 * p_tile_y1,
     72                                               OPJ_UINT32 * p_nb_comps,
     73                                               OPJ_BOOL * p_should_go_on,
     74                                               struct opj_stream_private * p_cio,
     75                                               struct opj_event_mgr * p_manager);
     76 
     77             /** FIXME DOC */
     78             OPJ_BOOL (*opj_decode_tile_data)( void * p_codec,
     79                                               OPJ_UINT32 p_tile_index,
     80                                               OPJ_BYTE * p_data,
     81                                               OPJ_UINT32 p_data_size,
     82                                               struct opj_stream_private * p_cio,
     83                                               struct opj_event_mgr * p_manager);
     84 
     85             /** Reading function used after codestream if necessary */
     86             OPJ_BOOL (* opj_end_decompress) ( void *p_codec,
     87                                               struct opj_stream_private * cio,
     88                                               struct opj_event_mgr * p_manager);
     89 
     90             /** Codec destroy function handler */
     91             void (*opj_destroy) (void * p_codec);
     92 
     93             /** Setup decoder function handler */
     94             void (*opj_setup_decoder) ( void * p_codec, opj_dparameters_t * p_param);
     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         } m_decompression;
    117 
    118         /**
    119          * Compression handler. FIXME DOC
    120          */
    121         struct opj_compression
    122         {
    123             OPJ_BOOL (* opj_start_compress) ( void *p_codec,
    124                                               struct opj_stream_private * cio,
    125                                               struct opj_image * p_image,
    126                                               struct opj_event_mgr * p_manager);
    127 
    128             OPJ_BOOL (* opj_encode) ( void * p_codec,
    129                                       struct opj_stream_private *p_cio,
    130                                       struct opj_event_mgr * p_manager);
    131 
    132             OPJ_BOOL (* opj_write_tile) ( void * p_codec,
    133                                           OPJ_UINT32 p_tile_index,
    134                                           OPJ_BYTE * p_data,
    135                                           OPJ_UINT32 p_data_size,
    136                                           struct opj_stream_private * p_cio,
    137                                           struct opj_event_mgr * p_manager);
    138 
    139             OPJ_BOOL (* opj_end_compress) (	void * p_codec,
    140                                             struct opj_stream_private * p_cio,
    141                                             struct opj_event_mgr * p_manager);
    142 
    143             void (* opj_destroy) (void * p_codec);
    144 
    145             void (* opj_setup_encoder) ( void * p_codec,
    146                                          opj_cparameters_t * p_param,
    147                                          struct opj_image * p_image,
    148                                          struct opj_event_mgr * p_manager);
    149         } m_compression;
    150     } m_codec_data;
    151     /** FIXME DOC*/
    152     void * m_codec;
    153     /** Event handler */
    154     opj_event_mgr_t m_event_mgr;
    155     /** Flag to indicate if the codec is used to decode or encode*/
    156     OPJ_BOOL is_decompressor;
    157     void (*opj_dump_codec) (void * p_codec, OPJ_INT32 info_flag, FILE* output_stream);
    158     opj_codestream_info_v2_t* (*opj_get_codec_info)(void* p_codec);
    159     opj_codestream_index_t* (*opj_get_codec_index)(void* p_codec);
    160 }
    161 opj_codec_private_t;
    162 
    163 
    164 #endif /* __OPJ_CODEC_H */
    165 
    166