client/tdm_client.h

   1 /**************************************************************************
   2  *
   3  * libtdm
   4  *
   5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
   6  *
   7  * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
   8  *          JinYoung Jeon <jy0.jeon@samsung.com>,
   9  *          Taeheon Kim <th908.kim@samsung.com>,
  10  *          YoungJun Cho <yj44.cho@samsung.com>,
  11  *          SooChan Lim <sc1.lim@samsung.com>,
  12  *          Boram Park <sc1.lim@samsung.com>
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the
  16  * "Software"), to deal in the Software without restriction, including
  17  * without limitation the rights to use, copy, modify, merge, publish,
  18  * distribute, sub license, and/or sell copies of the Software, and to
  19  * permit persons to whom the Software is furnished to do so, subject to
  20  * the following conditions:
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  27  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  29  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  30  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  31  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  32  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33  *
  34 **************************************************************************/
  35
  36 #ifndef _TDM_CLIENT_H_
  37 #define _TDM_CLIENT_H_
  38
  39 #include "tdm_client_types.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * @file tdm_client.h
  47  * @brief The header file for a client of TDM.
  48  * @par Example
  49  * @code
  50  * #include <tdm_client.h>    //for a client of TDM
  51  * @endcode
  52  */
  53
  54 /**
  55  * @brief Create a TDM client object.
  56  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
  57  * @return A TDM client object if success. Otherwise, NULL.
  58  * @see #tdm_client_destroy
  59  */
  60 tdm_client*
  61 tdm_client_create(tdm_error *error);
  62
  63 /**
  64  * @brief Destroy a TDM client object
  65  * @param[in] client A TDM client object
  66  * @see #tdm_client_create
  67  */
  68 void
  69 tdm_client_destroy(tdm_client *client);
  70
  71 /**
  72  * @brief Get the file descriptor
  73  * @param[in] client A TDM client object
  74  * @param[out] fd The file descriptor
  75  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
  76  * @see #tdm_client_handle_events
  77  * @par Example
  78  * @code
  79  * #include <tdm_client.h>    //for a client of TDM
  80  *
  81  * err = tdm_client_get_fd(client, &fd);
  82  * if (err != TDM_ERROR_NONE) {
  83  *     //error handling
  84  * }
  85  *
  86  * fds.events = POLLIN;
  87  * fds.fd = fd;
  88  * fds.revents = 0;
  89  *
  90  * while(1) {
  91  *    ret = poll(&fds, 1, -1);
  92  *    if (ret < 0) {
  93  *       if (errno == EINTR || errno == EAGAIN)
  94  *          continue;
  95  *       else {
  96  *          //error handling
  97  *       }
  98  *    }
  99  *
 100  *    err = tdm_client_handle_events(client);
 101  *    if (err != TDM_ERROR_NONE) {
 102  *        //error handling
 103  *    }
 104  * }
 105  * @endcode
 106  */
 107 tdm_error
 108 tdm_client_get_fd(tdm_client *client, int *fd);
 109
 110 /**
 111  * @brief Handle the events of the given file descriptor
 112  * @param[in] client A TDM client object
 113  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 114  * @see #tdm_client_get_fd
 115  */
 116 tdm_error
 117 tdm_client_handle_events(tdm_client *client);
 118
 119 /**
 120  * @brief @b Deprecated. Wait for VBLANK.
 121  * @deprecated
 122  * @details After interval vblanks, a client vblank handler will be called.
 123  * If 'sw_timer' param is 1 in case of DPMS off, TDM will use the SW timer and
 124  * call a client vblank handler. Otherwise, this function will return error.
 125  * @param[in] client A TDM client object
 126  * @param[in] name The name of a TDM output
 127  * @param[in] sw_timer 0: not using SW timer, 1: using SW timer
 128  * @param[in] interval vblank interval
 129  * @param[in] sync 0: asynchronous, 1:synchronous
 130  * @param[in] func A client vblank handler
 131  * @param[in] user_data The user data
 132  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 133  * @see #tdm_client_vblank_handler
 134  */
 135 tdm_error
 136 tdm_client_wait_vblank(tdm_client *client, char *name,
 137                                            int sw_timer, int interval, int sync,
 138                                            tdm_client_vblank_handler2 func, void *user_data);
 139
 140 /**
 141  * @brief Get the client output object which has the given name.
 142  * @details
 143  * The client output name can be @b 'primary' or @b 'default' to get the main output.
 144  * @param[in] client The TDM client object
 145  * @param[in] name The name of the TDM client output object
 146  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 147  * @return A client output object if success. Otherwise, NULL.
 148  */
 149 tdm_client_output*
 150 tdm_client_get_output(tdm_client *client, char *name, tdm_error *error);
 151
 152 /**
 153  * @brief Add the client output change handler
 154  * @details The handler will be called when the status of a
 155  * client output object is changed. connection, DPMS, etc.
 156  * @param[in] output The client output object
 157  * @param[in] func The client output change handler
 158  * @param[in] user_data The user data
 159  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 160  * @par Example
 161  * @code
 162  * #include <tdm_client.h>    //for a client of TDM
 163  *
 164  * static void
 165  * _client_output_handler(tdm_client_output *output, tdm_output_change_type type,
 166  *                        tdm_value value, void *user_data)
 167  * {
 168  *     char *conn_str[3] = {"disconnected", "connected", "mode_setted"};
 169  *     char *dpms_str[4] = {"on", "standy", "suspend", "off"};
 170  *
 171  *     if (type == TDM_OUTPUT_CHANGE_CONNECTION)
 172  *         printf("output %s.\n", conn_str[value.u32]);
 173  *     else if (type == TDM_OUTPUT_CHANGE_DPMS)
 174  *         printf("dpms %s.\n", dpms_str[value.u32]);
 175  * }
 176  * ...
 177  * tdm_client_output_add_change_handler(output, _client_output_handler, NULL);
 178  * ...
 179  * tdm_client_output_remove_change_handler(output, _client_output_handler, NULL);
 180  *
 181  * @endcode
 182  */
 183 tdm_error
 184 tdm_client_output_add_change_handler(tdm_client_output *output,
 185                                                                          tdm_client_output_change_handler func,
 186                                                                          void *user_data);
 187
 188 /**
 189  * @brief Remove the client output change handler
 190  * @param[in] output The client output object
 191  * @param[in] func The client output change handler
 192  * @param[in] user_data The user data
 193  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 194  */
 195 void
 196 tdm_client_output_remove_change_handler(tdm_client_output *output,
 197                                                                                 tdm_client_output_change_handler func,
 198                                                                                 void *user_data);
 199
 200 /**
 201  * @brief Get the vertical refresh rate of the given client output
 202  * @param[in] output The client output object
 203  * @param[out] refresh The refresh rate
 204  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 205  */
 206 tdm_error
 207 tdm_client_output_get_refresh_rate(tdm_client_output *output, unsigned int *refresh);
 208
 209 /**
 210  * @brief Get the connection status of the given client output
 211  * @param[in] output The client output object
 212  * @param[out] status The connection status
 213  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 214  */
 215 tdm_error
 216 tdm_client_output_get_conn_status(tdm_client_output *output, tdm_output_conn_status *status);
 217
 218 /**
 219  * @brief Get the DPMS value of the given client output
 220  * @param[in] output The client output object
 221  * @param[out] dpms The DPMS value
 222  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 223  */
 224 tdm_error
 225 tdm_client_output_get_dpms(tdm_client_output *output, tdm_output_dpms *dpms);
 226
 227 /**
 228  * @brief Create the client vblank object of the given client output
 229  * @details
 230  * tdm client vblank basically uses the HW vblank resource. Therefore, if HW vblank
 231  * is not available for some reasons, such as output disconnection and dpms off,
 232  * #tdm_client_vblank_wait will return error. If you want it to work propery in spite
 233  * of these reasons, you can use #tdm_client_vblank_set_enable_fake to get SW fake
 234  * vblank events.
 235  * @param[in] output The client output object
 236  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 237  * @return A client vblank object if success. Otherwise, NULL.
 238  */
 239 tdm_client_vblank*
 240 tdm_client_output_create_vblank(tdm_client_output *output, tdm_error *error);
 241
 242 /**
 243  * @brief Destroy the client vblank object
 244  * @param[in] vblank The client vblank object
 245  */
 246 void
 247 tdm_client_vblank_destroy(tdm_client_vblank *vblank);
 248
 249 /**
 250  * @brief Set the name to the client vblank object
 251  * @param[in] vblank The client vblank object
 252  * @param[in] name The client vblank name
 253  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 254  */
 255 tdm_error
 256 tdm_client_vblank_set_name(tdm_client_vblank *vblank, const char *name);
 257
 258 /**
 259  * @brief Set the sync value to the client vblank object
 260  * @details
 261  * If sync == 1, the user client vblank handler of #tdm_client_vblank_wait
 262  * will be called before #tdm_client_vblank_wait returns the result. If sync == 0,
 263  * the user client vblank handler of #tdm_client_vblank_wait will be called
 264  * asynchronously after #tdm_client_vblank_wait returns. Default is @b asynchronous.
 265  * @param[in] vblank The client vblank object
 266  * @param[in] sync 0: asynchronous, 1:synchronous
 267  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 268  */
 269 tdm_error
 270 tdm_client_vblank_set_sync(tdm_client_vblank *vblank, unsigned int sync);
 271
 272 /**
 273  * @brief Set the fps to the client vblank object
 274  * @details Default is the @b vertical @b refresh @b rate of the given client output.
 275  * @param[in] vblank The client vblank object
 276  * @param[in] fps more than 0
 277  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 278  */
 279 tdm_error
 280 tdm_client_vblank_set_fps(tdm_client_vblank *vblank, unsigned int fps);
 281
 282 /**
 283  * @brief Set the offset(milli-second) to the client vblank object
 284  * @details Default is @b 0.
 285  * @param[in] vblank The client vblank object
 286  * @param[in] offset_ms the offset(milli-second)
 287  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 288  */
 289 tdm_error
 290 tdm_client_vblank_set_offset(tdm_client_vblank *vblank, int offset_ms);
 291
 292 /**
 293  * @brief Enable/Disable the fake vblank to the client vblank object
 294  * @details
 295  * If enable_fake == 0, #tdm_client_vblank_wait will return error when HW vblank is
 296  * not available. Otherwise, #tdm_client_vblank_wait will return TDM_ERROR_NONE
 297  * as success. Once #tdm_client_vblank_wait returns TDM_ERROR_NONE, the user client
 298  * vblank handler(#tdm_client_vblank_handler) SHOULD be called after the given
 299  * interval of #tdm_client_vblank_wait. Default is @b disable.
 300  * @param[in] vblank The client vblank object
 301  * @param[in] enable_fake 1:enable, 0:disable
 302  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 303  */
 304 tdm_error
 305 tdm_client_vblank_set_enable_fake(tdm_client_vblank *vblank, unsigned int enable_fake);
 306
 307 /**
 308  * @brief Wait for a vblank
 309  * @details
 310  * This function will return error when HW vblank resource is not available. However,
 311  * #tdm_client_vblank_wait will return TDM_ERROR_NONE as success if
 312  * #tdm_client_vblank_set_enable_fake sets true. Once #tdm_client_vblank_wait
 313  * returns TDM_ERROR_NONE, the user client vblank handler(#tdm_client_vblank_handler)
 314  * SHOULD be called after the given interval. \n
 315  * The sequence value of tdm_client_vblank_handler is the relative value of fps.
 316  * If fps = 10, this sequence value should be increased by 10 during 1 second.
 317  * @param[in] vblank The client vblank object
 318  * @param[in] interval The vblank interval
 319  * @param[in] func The user client vblank handler
 320  * @param[in] user_data The user data
 321  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 322  * @par Example
 323  * @code
 324  * #include <tdm_client.h>    //for a client of TDM
 325  *
 326  * static void
 327  * _client_vblank_handler(tdm_client_vblank *vblank, tdm_error error, unsigned int sequence,
 328  *                        unsigned int tv_sec, unsigned int tv_usec, void *user_data)
 329  * {
 330  *     if (error != TDM_ERROR_NONE)
 331  *         //error handling
 332  * }
 333  *
 334  * {
 335  *     tdm_client_output *output;
 336  *     tdm_client_vblank *vblank;
 337  *     tdm_error error;
 338  *     struct pollfd fds;
 339  *     int fd = -1;
 340  *
 341  *     cliet = tdm_client_create(&error);
 342  *     if (error != TDM_ERROR_NONE)
 343  *         //error handling
 344  *
 345  *     output = tdm_client_get_output(client, NULL, &error);
 346  *     if (error != TDM_ERROR_NONE)
 347  *         //error handling
 348  *
 349  *     vblank = tdm_client_output_create_vblank(output, &error);
 350  *     if (error != TDM_ERROR_NONE)
 351  *         //error handling
 352  *
 353  *     tdm_client_vblank_set_enable_fake(vblank, enable_fake); //default: disable
 354  *     tdm_client_vblank_set_sync(vblank, 0); //default: async
 355  *     tdm_client_vblank_set_fps(vblank, fps); //default: refresh rate of output
 356  *     tdm_client_vblank_set_offset(vblank, offset); //default: 0
 357  *
 358  *     error = tdm_client_get_fd(data->client, &fd);
 359  *     if (error != TDM_ERROR_NONE)
 360  *         //error handling
 361  *
 362  *     fds.events = POLLIN;
 363  *     fds.fd = fd;
 364  *     fds.revents = 0;
 365  *
 366  *     while (1) {
 367  *         int ret;
 368  *
 369  *         error = tdm_client_vblank_wait(vblank, interval,
 370  *                                        _client_vblank_handler, NULL);
 371  *         if (error != TDM_ERROR_NONE)
 372  *             //error handling
 373  *
 374  *         ret = poll(&fds, 1, -1);
 375  *         if (ret < 0) {
 376  *             if (errno == EINTR || errno == EAGAIN)  // normal case
 377  *                 continue;
 378  *             else
 379  *                 //error handling
 380  *         }
 381  *
 382  *         error = tdm_client_handle_events(client);
 383  *         if (error != TDM_ERROR_NONE)
 384  *             //error handling
 385  *     }
 386  *
 387  *     tdm_client_vblank_destroy(vblank);
 388  *     tdm_client_destroy(client);
 389  * }
 390  * @endcode
 391  */
 392 tdm_error
 393 tdm_client_vblank_wait(tdm_client_vblank *vblank, unsigned int interval, tdm_client_vblank_handler func, void *user_data);
 394
 395 /**
 396  * @brief Wait for a vblank with the target sequence number
 397  * @details
 398  * This function will return error when HW vblank resource is not available. However,
 399  * #tdm_client_vblank_wait will return TDM_ERROR_NONE as success if
 400  * #tdm_client_vblank_set_enable_fake sets true. Once #tdm_client_vblank_wait_seq
 401  * returns TDM_ERROR_NONE, the user client vblank handler(#tdm_client_vblank_handler)
 402  * SHOULD be called on reaching the target sequence.
 403  * @param[in] vblank The client vblank object
 404  * @param[in] sequence The target sequence number
 405  * @param[in] func The user client vblank handler
 406  * @param[in] user_data The user data
 407  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 408  */
 409 tdm_error
 410 tdm_client_vblank_wait_seq(tdm_client_vblank *vblank, unsigned int sequence, tdm_client_vblank_handler func, void *user_data);
 411
 412 /**
 413  * @brief Check if the client vblank object is waiting a vblank event
 414  * @param[in] vblank The client vblank object
 415  * @return 1 if waiting. 0 if not waiting.
 416  */
 417 unsigned int
 418 tdm_client_vblank_is_waiting(tdm_client_vblank *vblank);
 419
 420 #ifdef __cplusplus
 421 }
 422 #endif
 423
 424 #endif /* _TDM_CLIENT_H_ */