applications/jpip/libopenjpip/query_parser.h

   1 /*
   2  * $Id: query_parser.h 53 2011-05-09 16:55:39Z kaori $
   3  *
   4  * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2011, Professor Benoit Macq
   6  * Copyright (c) 2010-2011, Kaori Hagihara
   7  * Copyright (c) 2011,      Lucian Corlaciu, GSoC
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef         QUERY_PARSER_H_
  33 # define        QUERY_PARSER_H_
  34
  35 #include "bool.h"
  36
  37 //! maximum length of target name
  38 #define MAX_LENOFTARGET 128
  39
  40 //! maximum length of target identifier
  41 #define MAX_LENOFTID 30
  42
  43 //! maximum length of channel identifier
  44 #define MAX_LENOFCID 30
  45
  46 //! maximum number of closing channel
  47 #define MAX_NUMOFCCLOSE 10
  48
  49 //! maximum number of meta request box
  50 #define MAX_NUMOFBOX 10
  51
  52 //! image return type
  53 typedef enum image_return { JPPstream, JPTstream, UNKNOWN=-1} image_return_t;
  54
  55 //! Query parameters
  56 typedef struct query_param{
  57   char target[MAX_LENOFTARGET];               //!< target name
  58   char tid[MAX_LENOFTID];                     //!< target identifier
  59   int fx, fy;                                 //!< frame size (fx,fy)
  60   int rx, ry, rw, rh;                         //!< roi region
  61   int layers;                                 //!< quality layers
  62   int lastcomp;                               //!< last component number
  63   bool *comps;                                //!< components (dynamic array) for jpp-stream, null means all components
  64   char cid[MAX_LENOFCID];                     //!< channel identifier
  65   bool cnew;                                  //!< if there is new channel request(true) or not (false)
  66   char cclose[MAX_NUMOFCCLOSE][MAX_LENOFCID]; //!< closing channel identifiers
  67   char box_type[MAX_NUMOFBOX][4];             //!< interested box-types
  68   int limit[MAX_NUMOFBOX];                    //!< limit value, -1: skeleton request "r", 0: entire contents
  69   bool w[MAX_NUMOFBOX];                       //!< Metadata request qualifier flags
  70   bool s[MAX_NUMOFBOX];
  71   bool g[MAX_NUMOFBOX];
  72   bool a[MAX_NUMOFBOX];
  73   bool priority[MAX_NUMOFBOX];                //!< priority flag
  74   int root_bin;                               //!< root-bin
  75   int max_depth;                              //!< max-depth
  76   bool metadata_only;                         //!< metadata-only request
  77   image_return_t return_type;                 //!< image return type
  78   int len;                                    //!< maximum response length
  79 } query_param_t;
  80
  81
  82 /**
  83  * parse query
  84  *
  85  * @param[in]  query_string request query string
  86  * @return     pointer to query parameters
  87  */
  88 query_param_t * parse_query( char *query_string);
  89
  90 /**
  91  * print query parameters
  92  *
  93  * @param[in] query_param  query parameters
  94  */
  95 void print_queryparam( query_param_t query_param);
  96
  97
  98 /**
  99  * delete query
 100  *
 101  * @param[in] query address of the deleting query pointer
 102  */
 103 void delete_query( query_param_t **query);
 104
 105 #endif      /* !QUERY_PARSER_H_ */