include/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 #include <tbm_type_common.h>
  37 #include <tbm_error.h>
  38
  39 typedef enum {
  40         TBM_SURFACE_QUEUE_TRACE_NONE = 0,                                         /**< Successful */
  41         TBM_SURFACE_QUEUE_TRACE_DEQUEUE = 1,
  42         TBM_SURFACE_QUEUE_TRACE_ENQUEUE = 2,
  43         TBM_SURFACE_QUEUE_TRACE_ACQUIRE = 3,
  44         TBM_SURFACE_QUEUE_TRACE_RELEASE = 4,
  45         TBM_SURFACE_QUEUE_TRACE_CANCEL_DEQUEUE = 5,
  46         TBM_SURFACE_QUEUE_TRACE_CANCEL_ACQUIRE = 6,
  47 } tbm_surface_queue_trace;
  48
  49 typedef enum {
  50         TBM_SURFACE_QUEUE_MODE_NONE = 0,
  51         /**
  52          * GUARANTEE_CYCLE mode must do enqueue/aquire/release or cancel_dequeue
  53          * for the tbm_surface which is dequeued before tbm_surface_queue is reset.
  54          */
  55         TBM_SURFACE_QUEUE_MODE_GUARANTEE_CYCLE = (1 << 0),
  56 } tbm_surface_queue_mode;
  57
  58 typedef struct _tbm_surface_queue *tbm_surface_queue_h;
  59
  60 typedef void (*tbm_surface_queue_notify_cb)(tbm_surface_queue_h surface_queue,
  61                 void *data);
  62
  63 typedef tbm_surface_h(*tbm_surface_alloc_cb)(tbm_surface_queue_h surface_queue,
  64                 void *data);
  65
  66 typedef void (*tbm_surface_free_cb)(tbm_surface_queue_h surface_queue,
  67                 void *data, tbm_surface_h surface);
  68
  69 typedef void (*tbm_surface_queue_trace_cb)(tbm_surface_queue_h surface_queue,
  70                 tbm_surface_h surface, tbm_surface_queue_trace trace, void *data);
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 /*The functions of queue factory*/
  77 tbm_surface_queue_h tbm_surface_queue_create(int queue_size, int width,
  78                 int height, int format, int flags);
  79
  80 tbm_surface_queue_h tbm_surface_queue_sequence_create(int queue_size, int width,
  81                 int height, int format, int flags);
  82
  83 void tbm_surface_queue_destroy(tbm_surface_queue_h surface_queue);
  84
  85 tbm_surface_queue_error_e tbm_surface_queue_set_alloc_cb(
  86         tbm_surface_queue_h surface_queue,
  87         tbm_surface_alloc_cb alloc_cb,
  88         tbm_surface_free_cb free_cb,
  89         void *data);
  90
  91 int tbm_surface_queue_get_width(tbm_surface_queue_h surface_queue);
  92
  93 int tbm_surface_queue_get_height(tbm_surface_queue_h surface_queue);
  94
  95 int tbm_surface_queue_get_format(tbm_surface_queue_h surface_queue);
  96
  97 int tbm_surface_queue_get_size(tbm_surface_queue_h surface_queue);
  98
  99 tbm_surface_queue_error_e tbm_surface_queue_get_surfaces(
 100         tbm_surface_queue_h surface_queue,
 101         tbm_surface_h *surfaces, int *num);
 102
 103 tbm_surface_queue_error_e tbm_surface_queue_get_trace_surface_num(
 104                         tbm_surface_queue_h surface_queue, tbm_surface_queue_trace trace, int *num);
 105
 106 tbm_surface_queue_error_e tbm_surface_queue_set_size(
 107                 tbm_surface_queue_h surface_queue, int queue_size, int flush);
 108
 109 tbm_surface_queue_error_e tbm_surface_queue_set_modes(
 110                         tbm_surface_queue_h surface_queue, int modes);
 111
 112 tbm_surface_queue_error_e tbm_surface_queue_set_sync_count(
 113                         tbm_surface_queue_h surface_queue, unsigned int sync_count);
 114
 115 int tbm_surface_queue_can_dequeue(tbm_surface_queue_h surface_queue, int wait);
 116
 117 int tbm_surface_queue_can_acquire(tbm_surface_queue_h surface_queue, int wait);
 118
 119 tbm_surface_queue_error_e tbm_surface_queue_dequeue(
 120                 tbm_surface_queue_h surface_queue, tbm_surface_h *surface);
 121
 122 tbm_surface_queue_error_e tbm_surface_queue_enqueue(
 123                 tbm_surface_queue_h surface_queue, tbm_surface_h surface);
 124
 125 tbm_surface_queue_error_e tbm_surface_queue_acquire(
 126                 tbm_surface_queue_h surface_queue, tbm_surface_h *surface);
 127
 128 tbm_surface_queue_error_e tbm_surface_queue_release(
 129                 tbm_surface_queue_h surface_queue, tbm_surface_h surface);
 130
 131 tbm_surface_queue_error_e tbm_surface_queue_cancel_dequeue(
 132                 tbm_surface_queue_h surface_queue, tbm_surface_h surface);
 133
 134 tbm_surface_queue_error_e tbm_surface_queue_cancel_acquire(
 135                 tbm_surface_queue_h surface_queue, tbm_surface_h surface);
 136
 137 tbm_surface_queue_error_e tbm_surface_queue_reset(
 138                 tbm_surface_queue_h surface_queue, int width, int height, int format);
 139
 140 tbm_surface_queue_error_e tbm_surface_queue_flush(tbm_surface_queue_h surface_queue);
 141
 142 tbm_surface_queue_error_e tbm_surface_queue_free_flush(tbm_surface_queue_h surface_queue);
 143
 144 tbm_surface_queue_error_e tbm_surface_queue_notify_reset(tbm_surface_queue_h surface_queue);
 145
 146 tbm_surface_queue_error_e tbm_surface_queue_notify_dequeuable(tbm_surface_queue_h surface_queue);
 147
 148 tbm_surface_queue_error_e tbm_surface_queue_add_destroy_cb(
 149         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb destroy_cb,
 150         void *data);
 151
 152 tbm_surface_queue_error_e tbm_surface_queue_remove_destroy_cb(
 153         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb destroy_cb,
 154         void *data);
 155
 156 tbm_surface_queue_error_e tbm_surface_queue_add_reset_cb(
 157         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb reset_cb,
 158         void *data);
 159
 160 tbm_surface_queue_error_e tbm_surface_queue_remove_reset_cb(
 161         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb reset_cb,
 162         void *data);
 163
 164 tbm_surface_queue_error_e tbm_surface_queue_add_dequeuable_cb(
 165         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeuable_cb,
 166         void *data);
 167
 168 tbm_surface_queue_error_e tbm_surface_queue_remove_dequeuable_cb(
 169         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeuable_cb,
 170         void *data);
 171
 172 tbm_surface_queue_error_e tbm_surface_queue_add_dequeue_cb(
 173         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeue_cb,
 174         void *data);
 175
 176 tbm_surface_queue_error_e tbm_surface_queue_remove_dequeue_cb(
 177         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeue_cb,
 178         void *data);
 179
 180 tbm_surface_queue_error_e tbm_surface_queue_add_can_dequeue_cb(
 181         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb can_dequeue_cb,
 182         void *data);
 183
 184 tbm_surface_queue_error_e tbm_surface_queue_remove_can_dequeue_cb(
 185         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb can_dequeue_cb,
 186         void *data);
 187
 188 tbm_surface_queue_error_e tbm_surface_queue_add_acquirable_cb(
 189         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb acquirable_cb,
 190         void *data);
 191
 192 tbm_surface_queue_error_e tbm_surface_queue_remove_acquirable_cb(
 193         tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb acquirable_cb,
 194         void *data);
 195
 196 tbm_surface_queue_error_e tbm_surface_queue_add_trace_cb(
 197         tbm_surface_queue_h surface_queue, tbm_surface_queue_trace_cb trace_cb,
 198         void *data);
 199
 200 tbm_surface_queue_error_e tbm_surface_queue_remove_trace_cb(
 201         tbm_surface_queue_h surface_queue, tbm_surface_queue_trace_cb trace_cb,
 202         void *data);
 203
 204 #ifdef __cplusplus
 205 }
 206 #endif
 207 #endif                                                  /* _TBM_SURFACE_H_ */