src/tbm_surface_queue.h

   1 /**************************************************************************
   2
   3 libtbm
   4
   5 Copyright 2014 Samsung Electronics co., Ltd. All Rights Reserved.
   6
   7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
   8 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
   9
  10 Permission is hereby granted, free of charge, to any person obtaining a
  11 copy of this software and associated documentation files (the
  12 "Software"), to deal in the Software without restriction, including
  13 without limitation the rights to use, copy, modify, merge, publish,
  14 distribute, sub license, and/or sell copies of the Software, and to
  15 permit persons to whom the Software is furnished to do so, subject to
  16 the following conditions:
  17
  18 The above copyright notice and this permission notice (including the
  19 next paragraph) shall be included in all copies or substantial portions
  20 of the Software.
  21
  22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  23 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  25 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  27 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  28 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30 **************************************************************************/
  31
  32 #ifndef _TBM_SURFACE_QUEUE_H_
  33 #define _TBM_SURFACE_QUEUE_H_
  34
  35 #include <tbm_surface.h>
  36
  37 typedef enum {
  38         TBM_SURFACE_QUEUE_ERROR_NONE = 0,                                         /**< Successful */
  39         TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE = -1,
  40         TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE = -2,
  41         TBM_SURFACE_QUEUE_ERROR_EMPTY = -3,
  42         TBM_SURFACE_QUEUE_ERROR_INVALID_PARAMETER = -4,
  43         TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED = -5,
  44         TBM_SURFACE_QUEUE_ERROR_ALREADY_EXIST = -6,
  45         TBM_SURFACE_QUEUE_ERROR_UNKNOWN_SURFACE = -7,
  46 } tbm_surface_queue_error_e;
  47
  48 typedef enum {
  49         TBM_SURFACE_QUEUE_TRACE_NONE = 0,                                         /**< Successful */
  50         TBM_SURFACE_QUEUE_TRACE_DEQUEUE = 1,
  51         TBM_SURFACE_QUEUE_TRACE_ENQUEUE = 2,
  52         TBM_SURFACE_QUEUE_TRACE_ACQUIRE = 3,
  53         TBM_SURFACE_QUEUE_TRACE_RELEASE = 4,
  54 } tbm_surface_queue_trace;
  55
  56 typedef struct _tbm_surface_queue *tbm_surface_queue_h;
  57
  58 typedef void (*tbm_surface_queue_notify_cb)(tbm_surface_queue_h surface_queue,
  59                 void *data);
  60
  61 typedef tbm_surface_h(*tbm_surface_alloc_cb)(tbm_surface_queue_h surface_queue,
  62                 void *data);
  63
  64 typedef void (*tbm_surface_free_cb)(tbm_surface_queue_h surface_queue,
  65                 void *data, tbm_surface_h surface);
  66
  67 typedef void (*tbm_surface_queue_trace_cb)(tbm_surface_queue_h surface_queue,
  68                 tbm_surface_h surface, tbm_surface_queue_trace trace, void *data);
  69
  70 #ifdef __cplusplus
  71 extern "C" {
  72 #endif
  73
  74 tbm_surface_queue_error_e tbm_surface_queue_enqueue(
  75                 tbm_surface_queue_h surface_queue, tbm_surface_h surface);
  76
  77 tbm_surface_queue_error_e tbm_surface_queue_dequeue(
  78                 tbm_surface_queue_h surface_queue, tbm_surface_h *surface);
  79
  80 tbm_surface_queue_error_e tbm_surface_queue_release(
  81                 tbm_surface_queue_h surface_queue, tbm_surface_h surface);
  82
  83 tbm_surface_queue_error_e tbm_surface_queue_acquire(
  84                 tbm_surface_queue_h surface_queue, tbm_surface_h *surface);
  85
  86 int tbm_surface_queue_can_dequeue(tbm_surface_queue_h surface_queue, int wait);
  87
  88 int tbm_surface_queue_can_acquire(tbm_surface_queue_h surface_queue, int wait);
  89
  90 void tbm_surface_queue_destroy(tbm_surface_queue_h surface_queue);
  91
  92 int tbm_surface_queue_get_width(tbm_surface_queue_h surface_queue);
  93
  94 int tbm_surface_queue_get_height(tbm_surface_queue_h surface_queue);
  95
  96 int tbm_surface_queue_get_format(tbm_surface_queue_h surface_queue);
  97
  98 int tbm_surface_queue_get_size(tbm_surface_queue_h surface_queue);
  99
 100 tbm_surface_queue_error_e tbm_surface_queue_reset(
 101                 tbm_surface_queue_h surface_queue, int width, int height, int format);
 102
 103 tbm_surface_queue_error_e tbm_surface_queue_set_size(
 104                 tbm_surface_queue_h surface_queue, int queue_size, int flush);
 105
 106 tbm_surface_queue_error_e tbm_surface_queue_flush(tbm_surface_queue_h surface_queue);
 107
 108 tbm_surface_queue_error_e tbm_surface_queue_notify_reset(tbm_surface_queue_h surface_queue);
 109
 110 tbm_surface_queue_error_e tbm_surface_queue_add_reset_cb(
 111         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb reset_cb,
 112         void *data);
 113
 114 tbm_surface_queue_error_e tbm_surface_queue_remove_reset_cb(
 115         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb reset_cb,
 116         void *data);
 117
 118 tbm_surface_queue_error_e tbm_surface_queue_add_destroy_cb(
 119         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb destroy_cb,
 120         void *data);
 121
 122 tbm_surface_queue_error_e tbm_surface_queue_remove_destroy_cb(
 123         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb destroy_cb,
 124         void *data);
 125
 126 tbm_surface_queue_error_e tbm_surface_queue_add_dequeuable_cb(
 127         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeuable_cb,
 128         void *data);
 129
 130 tbm_surface_queue_error_e tbm_surface_queue_remove_dequeuable_cb(
 131         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeuable_cb,
 132         void *data);
 133
 134 tbm_surface_queue_error_e tbm_surface_queue_add_dequeue_cb(
 135         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeue_cb,
 136         void *data);
 137
 138 tbm_surface_queue_error_e tbm_surface_queue_remove_dequeue_cb(
 139         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeue_cb,
 140         void *data);
 141
 142 tbm_surface_queue_error_e tbm_surface_queue_add_can_dequeue_cb(
 143         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb can_dequeue_cb,
 144         void *data);
 145
 146 tbm_surface_queue_error_e tbm_surface_queue_remove_can_dequeue_cb(
 147         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb can_dequeue_cb,
 148         void *data);
 149
 150 tbm_surface_queue_error_e tbm_surface_queue_add_acquirable_cb(
 151         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb acquirable_cb,
 152         void *data);
 153
 154 tbm_surface_queue_error_e tbm_surface_queue_remove_acquirable_cb(
 155         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb acquirable_cb,
 156         void *data);
 157
 158 tbm_surface_queue_error_e tbm_surface_queue_add_trace_cb(
 159         tbm_surface_queue_h surface_queue, tbm_surface_queue_trace_cb trace_cb,
 160         void *data);
 161
 162 tbm_surface_queue_error_e tbm_surface_queue_remove_trace_cb(
 163         tbm_surface_queue_h surface_queue, tbm_surface_queue_trace_cb trace_cb,
 164         void *data);
 165
 166 tbm_surface_queue_error_e tbm_surface_queue_set_alloc_cb(
 167         tbm_surface_queue_h surface_queue,
 168         tbm_surface_alloc_cb alloc_cb,
 169         tbm_surface_free_cb free_cb,
 170         void *data);
 171
 172 tbm_surface_queue_error_e tbm_surface_queue_get_surfaces(
 173         tbm_surface_queue_h surface_queue,
 174         tbm_surface_h *surfaces, int *num);
 175
 176 /*The functions of queue factory*/
 177 tbm_surface_queue_h tbm_surface_queue_create(int queue_size, int width,
 178                 int height, int format, int flags);
 179 tbm_surface_queue_h tbm_surface_queue_sequence_create(int queue_size, int width,
 180                 int height, int format, int flags);
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185 #endif                                                  /* _TBM_SURFACE_H_ */