src/lib/openjpip/query_parser.h

   1 /*
   2  * $Id$
   3  *
   4  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2014, 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 "opj_includes.h"
  36
  37 /** maximum number of meta request box */
  38 #define MAX_NUMOFBOX 10
  39
  40 /** cnew aux transport name */
  41 typedef enum cnew_transport { non, http, tcp, udp} cnew_transport_t;
  42
  43 /** image return type */
  44 typedef enum image_return { JPPstream, JPTstream, UNKNOWN = -1} image_return_t;
  45
  46 /** Query parameters */
  47 typedef struct query_param {
  48     char *target;                               /**< target name */
  49     char *tid;                                  /**< target identifier */
  50     int fx, fy;                                 /**< frame size (fx,fy) */
  51     int rx, ry, rw, rh;                         /**< roi region */
  52     int layers;                                 /**< quality layers */
  53     int lastcomp;                               /**< last component number */
  54     OPJ_BOOL *comps;                                /**< components (dynamic array) for jpp-stream, null means all components */
  55     char *cid;                                  /**< channel identifier */
  56     cnew_transport_t
  57     cnew;                      /**< transport name if there is new channel request, else non */
  58     char *cclose;                               /**< list of closing channel identifiers, separated by '\\0' */
  59     int numOfcclose;                            /**< number of closing channels */
  60     char box_type[MAX_NUMOFBOX][4];             /**< interested box-types */
  61     int limit[MAX_NUMOFBOX];                    /**< limit value, -1: skeleton request "r", 0: entire contents */
  62     OPJ_BOOL w[MAX_NUMOFBOX];                       /**< Metadata request qualifier flags */
  63     OPJ_BOOL s[MAX_NUMOFBOX];
  64     OPJ_BOOL g[MAX_NUMOFBOX];
  65     OPJ_BOOL a[MAX_NUMOFBOX];
  66     OPJ_BOOL priority[MAX_NUMOFBOX];                /**< priority flag */
  67     int root_bin;                               /**< root-bin */
  68     int max_depth;                              /**< max-depth */
  69     OPJ_BOOL metadata_only;                         /**< metadata-only request */
  70     image_return_t return_type;                 /**< image return type */
  71     int len;                                    /**< maximum response length */
  72 } query_param_t;
  73
  74
  75 /**
  76  * parse query
  77  *
  78  * @param[in]  query_string request query string
  79  * @return     pointer to query parameters
  80  */
  81 query_param_t * parse_query(const char *query_string);
  82
  83 /**
  84  * print query parameters
  85  *
  86  * @param[in] query_param  query parameters
  87  */
  88 void print_queryparam(query_param_t query_param);
  89
  90
  91 /**
  92  * delete query
  93  *
  94  * @param[in] query address of the deleting query pointer
  95  */
  96 void delete_query(query_param_t **query);
  97
  98 #endif      /* !QUERY_PARSER_H_ */