openjpip.h

Go to the documentation of this file.

/*
 * $Id$
 *
 * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
 * Copyright (c) 2002-2014, Professor Benoit Macq
 * Copyright (c) 2010-2011, Kaori Hagihara
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef         OPENJPIP_H_
# define        OPENJPIP_H_

#include "session_manager.h"
#include "target_manager.h"
#include "query_parser.h"
#include "msgqueue_manager.h"
#include "sock_manager.h"
#include "auxtrans_manager.h"

#ifdef SERVER

#include "fcgi_stdio.h"
#define logstream FCGI_stdout

#else

#define FCGI_stdout stdout
#define FCGI_stderr stderr
#define logstream stderr

#include "cache_manager.h"
#include "byte_manager.h"
#include "imgsock_manager.h"

#include "metadata_manager.h"
#include "ihdrbox_manager.h"
#include "index_manager.h"

#endif /*SERVER*/

/*
 *==========================================================
 * JPIP server API
 *==========================================================
 */

#ifdef SERVER

typedef struct server_record {
    sessionlist_param_t *sessionlist; 
    targetlist_param_t *targetlist;   
    auxtrans_param_t auxtrans;
} server_record_t;

typedef struct QR {
    query_param_t *query;             
    msgqueue_param_t *msgqueue;       
    channel_param_t *channel;         
} QR_t;

server_record_t * init_JPIPserver(int tcp_auxport, int udp_auxport);

void terminate_JPIPserver(server_record_t **rec);

QR_t * parse_querystring(const char *query_string);

OPJ_BOOL process_JPIPrequest(server_record_t *rec, QR_t *qr);

void send_responsedata(server_record_t *rec, QR_t *qr);

void end_QRprocess(server_record_t *rec, QR_t **qr);

void local_log(OPJ_BOOL query, OPJ_BOOL messages, OPJ_BOOL sessions,
               OPJ_BOOL targets, QR_t *qr, server_record_t *rec);

#endif /*SERVER*/

/*
 *==========================================================
 *      JPIP decoding server API
 *==========================================================
 */

#ifndef SERVER

typedef struct dec_server_record {
    cachelist_param_t *cachelist; 
    Byte_t *jpipstream;           
    OPJ_SIZE_T jpipstreamlen;            
    msgqueue_param_t *msgqueue;   
    SOCKET listening_socket;      
} dec_server_record_t;


typedef SOCKET client_t;

OPJ_API dec_server_record_t * OPJ_CALLCONV init_dec_server(int port);

OPJ_API void OPJ_CALLCONV terminate_dec_server(dec_server_record_t **rec);

OPJ_API client_t OPJ_CALLCONV accept_connection(dec_server_record_t *rec);

OPJ_API OPJ_BOOL OPJ_CALLCONV handle_clientreq(client_t client,
        dec_server_record_t *rec);

#endif /*SERVER*/

/*
 *==========================================================
 *     JPIP tool API
 *==========================================================
 */

#ifndef SERVER

/*
 * jpip to JP2 or J2K
 */

typedef struct jpip_dec_param {
    Byte_t *jpipstream;                 
    Byte8_t jpiplen;                    
    msgqueue_param_t *msgqueue;         
    metadatalist_param_t *metadatalist; 
    ihdrbox_param_t *ihdrbox;           
    Byte_t *jp2kstream;                 
    Byte8_t jp2klen;                    
} jpip_dec_param_t;

OPJ_API jpip_dec_param_t * OPJ_CALLCONV init_jpipdecoder(OPJ_BOOL jp2);

OPJ_API void OPJ_CALLCONV destroy_jpipdecoder(jpip_dec_param_t **dec);

OPJ_API OPJ_BOOL OPJ_CALLCONV fread_jpip(const char fname[],
        jpip_dec_param_t *dec);

OPJ_API void OPJ_CALLCONV decode_jpip(jpip_dec_param_t *dec);

OPJ_API OPJ_BOOL OPJ_CALLCONV fwrite_jp2k(const char fname[],
        jpip_dec_param_t *dec);

OPJ_API void OPJ_CALLCONV output_log(OPJ_BOOL messages, OPJ_BOOL metadata,
                                     OPJ_BOOL ihdrbox, jpip_dec_param_t *dec);

/*
 *  test the format of index (cidx) box in JP2 file
 */

typedef index_param_t index_t;

OPJ_API index_t * OPJ_CALLCONV get_index_from_JP2file(int fd);

OPJ_API void OPJ_CALLCONV destroy_index(index_t **idx);


OPJ_API void OPJ_CALLCONV output_index(index_t *index);

#endif /*SERVER*/

#endif /* !OPENJPIP_H_ */