openjpeg/src/lib/openjpip/query_parser.h

98 lines
4.1 KiB
C
Raw Normal View History

/*
* $Id$
*
* Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
* Copyright (c) 2002-2014, Professor Benoit Macq
* Copyright (c) 2010-2011, Kaori Hagihara
2011-09-30 17:31:06 +02:00
* Copyright (c) 2011, Lucian Corlaciu, GSoC
* 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 QUERY_PARSER_H_
# define QUERY_PARSER_H_
#include "opj_includes.h"
/** maximum number of meta request box */
#define MAX_NUMOFBOX 10
/** cnew aux transport name */
2012-03-02 11:46:04 +01:00
typedef enum cnew_transport { non, http, tcp, udp} cnew_transport_t;
/** image return type */
2011-09-30 17:31:06 +02:00
typedef enum image_return { JPPstream, JPTstream, UNKNOWN=-1} image_return_t;
/** Query parameters */
typedef struct query_param{
char *target; /**< target name */
char *tid; /**< target identifier */
int fx, fy; /**< frame size (fx,fy) */
int rx, ry, rw, rh; /**< roi region */
int layers; /**< quality layers */
int lastcomp; /**< last component number */
OPJ_BOOL *comps; /**< components (dynamic array) for jpp-stream, null means all components */
char *cid; /**< channel identifier */
cnew_transport_t cnew; /**< transport name if there is new channel request, else non */
char *cclose; /**< list of closing channel identifiers, separated by '\\0' */
int numOfcclose; /**< number of closing channels */
char box_type[MAX_NUMOFBOX][4]; /**< interested box-types */
int limit[MAX_NUMOFBOX]; /**< limit value, -1: skeleton request "r", 0: entire contents */
OPJ_BOOL w[MAX_NUMOFBOX]; /**< Metadata request qualifier flags */
OPJ_BOOL s[MAX_NUMOFBOX];
OPJ_BOOL g[MAX_NUMOFBOX];
OPJ_BOOL a[MAX_NUMOFBOX];
OPJ_BOOL priority[MAX_NUMOFBOX]; /**< priority flag */
int root_bin; /**< root-bin */
int max_depth; /**< max-depth */
OPJ_BOOL metadata_only; /**< metadata-only request */
image_return_t return_type; /**< image return type */
int len; /**< maximum response length */
} query_param_t;
/**
* parse query
*
* @param[in] query_string request query string
* @return pointer to query parameters
*/
query_param_t * parse_query( const char *query_string);
/**
* print query parameters
*
* @param[in] query_param query parameters
*/
void print_queryparam( query_param_t query_param);
/**
* delete query
*
* @param[in] query address of the deleting query pointer
*/
void delete_query( query_param_t **query);
#endif /* !QUERY_PARSER_H_ */