1 /**************************************************************************
5 * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
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>
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:
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
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.
34 **************************************************************************/
40 #include <tbm_surface.h>
41 #include <tbm_surface_queue.h>
42 #include <tbm_surface_internal.h>
44 #include "tdm_types.h"
52 * @brief The header file for a frontend user.
55 * #include <tdm.h> //for a frontend user
60 * @brief The display capability enumeration
63 TDM_DISPLAY_CAPABILITY_PP = (1 << 0), /**< if hardware supports pp operation */
64 TDM_DISPLAY_CAPABILITY_CAPTURE = (1 << 1), /**< if hardware supports capture operation */
65 } tdm_display_capability;
68 * @brief The output change handler
69 * @details This handler will be called when the status of a output object is
72 typedef void (*tdm_output_change_handler)(tdm_output *output,
73 tdm_output_change_type type,
78 * @brief Initialize a display object
79 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
80 * @return A display object
81 * @see tdm_display_deinit
84 tdm_display_init(tdm_error *error);
87 * @brief Deinitialize a display object
88 * @param[in] dpy A display object
89 * @see tdm_display_init
92 tdm_display_deinit(tdm_display *dpy);
95 * @brief Update a display object
97 * When new output is connected, a frontend user need to call this function.
98 * And a frontend user can the new output information with tdm_output_get_xxx functions.
99 * @param[in] dpy A display object
100 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
103 tdm_display_update(tdm_display *dpy);
106 * @brief Get the file descriptor
107 * @details TDM handles the events of fd with #tdm_display_handle_events.
108 * @param[in] dpy A display object
109 * @param[out] fd The file descriptor
110 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
111 * @see tdm_display_handle_events
114 tdm_display_get_fd(tdm_display *dpy, int *fd);
117 * @brief Handle the events
118 * @param[in] dpy A display object
119 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
120 * @see tdm_display_get_fd
123 tdm_display_handle_events(tdm_display *dpy);
126 * @brief Get the information of the TDM backend module.
127 * @param[in] dpy A display object
128 * @param[out] name The name of the TDM backend module
129 * @param[out] vendor The vendor of the TDM backend module
130 * @param[out] version The version of the TDM backend module
131 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
134 tdm_display_get_backend_info(tdm_display *dpy, const char **name,
135 const char **vendor, int *major, int *minor);
138 * @brief Get the capabilities of a display object.
139 * @details A frontend user can get whether TDM supports pp/capture functionality with this function.
140 * @param[in] dpy A display object
141 * @param[out] capabilities The capabilities of a display object
142 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
145 tdm_display_get_capabilities(tdm_display *dpy,
146 tdm_display_capability *capabilities);
149 * @brief Get the pp capabilities of a display object.
150 * @param[in] dpy A display object
151 * @param[out] capabilities The pp capabilities
152 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
155 tdm_display_get_pp_capabilities(tdm_display *dpy,
156 tdm_pp_capability *capabilities);
159 * @brief Get the pp available format array of a display object.
160 * @param[in] dpy A display object
161 * @param[out] formats The pp available format array
162 * @param[out] count The count of formats
163 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
166 tdm_display_get_pp_available_formats(tdm_display *dpy,
167 const tbm_format **formats, int *count);
170 * @brief Get the pp available size of a display object.
171 * @details -1 means that a TDM backend module doesn't define the value.
172 * @param[in] dpy A display object
173 * @param[out] min_w The minimum width which TDM can handle
174 * @param[out] min_h The minimum height which TDM can handle
175 * @param[out] max_w The maximum width which TDM can handle
176 * @param[out] max_h The maximum height which TDM can handle
177 * @param[out] preferred_align The preferred align width which TDM can handle
178 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
181 tdm_display_get_pp_available_size(tdm_display *dpy, int *min_w, int *min_h,
182 int *max_w, int *max_h, int *preferred_align);
185 * @brief Get the capture capabilities of a display object.
186 * @param[in] dpy A display object
187 * @param[out] capabilities The capture capabilities
188 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
191 tdm_display_get_capture_capabilities(tdm_display *dpy,
192 tdm_capture_capability *capabilities);
195 * @brief Get the capture available format array of a display object.
196 * @param[in] dpy A display object
197 * @param[out] formats The capture available format array
198 * @param[out] count The count of formats
199 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
202 tdm_display_get_catpure_available_formats(tdm_display *dpy,
203 const tbm_format **formats, int *count);
206 * @brief Get the capture available size of a display object.
207 * @details -1 means that a TDM backend module doesn't define the value.
208 * @param[in] dpy A display object
209 * @param[out] min_w The minimum width which TDM can handle
210 * @param[out] min_h The minimum height which TDM can handle
211 * @param[out] max_w The maximum width which TDM can handle
212 * @param[out] max_h The maximum height which TDM can handle
213 * @param[out] preferred_align The preferred align width which TDM can handle
214 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
217 tdm_display_get_capture_available_size(tdm_display *dpy, int *min_w, int *min_h,
218 int *max_w, int *max_h, int *preferred_align);
221 * @brief Get the max layer counts which a display object can show on screen.
222 * @details -1 means that a TDM backend module doesn't define the value.
223 * @param[in] dpy A display object
224 * @param[out] count The max count of layers
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
228 tdm_display_get_max_layer_count(tdm_display *dpy, int *max_count);
231 * @brief Get the output counts which a display object has.
232 * @param[in] dpy A display object
233 * @param[out] count The count of outputs
234 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
235 * @see tdm_display_get_output
238 tdm_display_get_output_count(tdm_display *dpy, int *count);
241 * @brief Get a output object which has the given index.
242 * @param[in] dpy A display object
243 * @param[in] index The index of a output object
244 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
245 * @return A output object if success. Otherwise, NULL.
246 * @see tdm_display_get_output_count
249 tdm_display_get_output(tdm_display *dpy, int index, tdm_error *error);
252 * @brief Create a pp object.
253 * @param[in] dpy A display object
254 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
255 * @return A pp object if success. Otherwise, NULL.
256 * @see tdm_pp_destroy
259 tdm_display_create_pp(tdm_display *dpy, tdm_error *error);
262 * @brief Get the capabilities of a output object.
263 * @param[in] output A output object
264 * @param[out] capabilities The capabilities of a output object
265 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
268 tdm_output_get_capabilities(tdm_output *output,
269 tdm_output_capability *capabilities);
272 * @brief Get the model information of a output object.
273 * @param[in] output A output object
274 * @param[out] maker The output maker.
275 * @param[out] model The output model.
276 * @param[out] name The output name.
277 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
280 tdm_output_get_model_info(tdm_output *output, const char **maker,
281 const char **model, const char **name);
284 * @brief Get the connection status of a output object.
285 * @param[in] output A output object
286 * @param[out] status The connection status.
287 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
290 tdm_output_get_conn_status(tdm_output *output, tdm_output_conn_status *status);
293 * @brief Add a output change handler
294 * @details The handler will be called when the status of a
295 * output object is changed. connection, DPMS, etc.
296 * @param[in] output A output object
297 * @param[in] func A output change handler
298 * @param[in] user_data The user data
299 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
302 tdm_output_add_change_handler(tdm_output *output,
303 tdm_output_change_handler func,
307 * @brief Remove a output change handler
308 * @param[in] output A output object
309 * @param[in] func A output change handler
310 * @param[in] user_data The user data
311 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314 tdm_output_remove_change_handler(tdm_output *output,
315 tdm_output_change_handler func,
319 * @brief Get the connection type of a output object.
320 * @param[in] output A output object
321 * @param[out] type The connection type.
322 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
325 tdm_output_get_output_type(tdm_output *output, tdm_output_type *type);
328 * @brief Get the layer counts which a output object has.
329 * @param[in] output A output object
330 * @param[out] count The count of layers
331 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
332 * @see tdm_output_get_layer
335 tdm_output_get_layer_count(tdm_output *output, int *count);
338 * @brief Get a layer object which has the given index.
339 * @param[in] output A output object
340 * @param[in] index The index of a layer object
341 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
342 * @return A layer object if success. Otherwise, NULL.
343 * @see tdm_output_get_layer_count
346 tdm_output_get_layer(tdm_output *output, int index, tdm_error *error);
349 * @brief Get the available property array of a output object.
350 * @param[in] output A output object
351 * @param[out] props The available property array
352 * @param[out] count The count of properties
353 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
356 tdm_output_get_available_properties(tdm_output *output, const tdm_prop **props,
360 * @brief Get the available mode array of a output object.
361 * @param[in] output A output object
362 * @param[out] modes The available mode array
363 * @param[out] count The count of modes
364 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
367 tdm_output_get_available_modes(tdm_output *output,
368 const tdm_output_mode **modes, int *count);
371 * @brief Get the available size of a output object.
372 * @details -1 means that a TDM backend module doesn't define the value.
373 * @param[in] output A output object
374 * @param[out] min_w The minimum width which TDM can handle
375 * @param[out] min_h The minimum height which TDM can handle
376 * @param[out] max_w The maximum width which TDM can handle
377 * @param[out] max_h The maximum height which TDM can handle
378 * @param[out] preferred_align The preferred align width which TDM can handle
379 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
382 tdm_output_get_available_size(tdm_output *output, int *min_w, int *min_h,
383 int *max_w, int *max_h, int *preferred_align);
386 * @brief Get the available cursor size of a output object.
387 * @details -1 means that a TDM backend module doesn't define the value.
388 * @param[in] output A output object
389 * @param[out] min_w The minimum width which TDM can handle
390 * @param[out] min_h The minimum height which TDM can handle
391 * @param[out] max_w The maximum width which TDM can handle
392 * @param[out] max_h The maximum height which TDM can handle
393 * @param[out] preferred_align The preferred align width which TDM can handle
394 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
397 tdm_output_get_cursor_available_size(tdm_output *output, int *min_w, int *min_h,
398 int *max_w, int *max_h, int *preferred_align);
401 * @brief Get the physical size of a output object.
402 * @param[in] output A output object
403 * @param[out] mmWidth The milimeter width
404 * @param[out] mmHeight The milimeter height
405 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
408 tdm_output_get_physical_size(tdm_output *output, unsigned int *mmWidth,
409 unsigned int *mmHeight);
412 * @brief Get the subpixel of a output object.
413 * @param[in] output A output object
414 * @param[out] subpixel The subpixel
415 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
418 tdm_output_get_subpixel(tdm_output *output, unsigned int *subpixel);
421 * @brief Get the pipe of a output object.
422 * @param[in] output A output object
423 * @param[out] pipe The pipe
424 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
427 tdm_output_get_pipe(tdm_output *output, unsigned int *pipe);
430 * @brief Get the index of a primary layer.
431 * @param[in] output A output object
432 * @param[out] index The primary layer index
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
436 tdm_output_get_primary_index(tdm_output *output, int *index);
439 * @brief Set the property which has a given id.
440 * @param[in] output A output object
441 * @param[in] id The property id
442 * @param[in] value The value
443 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
446 tdm_output_set_property(tdm_output *output, unsigned int id, tdm_value value);
449 * @brief Get the property which has a given id
450 * @param[in] output A output object
451 * @param[in] id The property id
452 * @param[out] value The value
453 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
456 tdm_output_get_property(tdm_output *output, unsigned int id, tdm_value *value);
459 * @brief Wait for VBLANK
460 * @details After interval vblanks, a user vblank handler will be called.
461 * @param[in] output A output object
462 * @param[in] interval vblank interval
463 * @param[in] sync 0: asynchronous, 1:synchronous
464 * @param[in] func A user vblank handler
465 * @param[in] user_data The user data
466 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
467 * @see #tdm_output_vblank_handler
470 tdm_output_wait_vblank(tdm_output *output, int interval, int sync,
471 tdm_output_vblank_handler func, void *user_data);
474 * @brief Commit changes for a output object
475 * @details After all change of a output object are applied, a user commit handler
477 * @param[in] output A output object
478 * @param[in] sync 0: asynchronous, 1:synchronous
479 * @param[in] func A user commit handler
480 * @param[in] user_data The user data
481 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
482 * @see #tdm_layer_commit
485 tdm_output_commit(tdm_output *output, int sync, tdm_output_commit_handler func,
489 * @brief Remove the user vblank handler
490 * @param[in] output A output object
491 * @param[in] func A user vblank handler
492 * @param[in] user_data The user data
493 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
496 tdm_output_remove_vblank_handler(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
499 * @brief Remove the user commit handler
500 * @param[in] output A output object
501 * @param[in] func A user commit handler
502 * @param[in] user_data The user data
503 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
506 tdm_output_remove_commit_handler(tdm_output *output, tdm_output_commit_handler func, void *user_data);
509 * @brief Set one of available modes of a output object
510 * @param[in] output A output object
511 * @param[in] mode A output mode
512 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
515 tdm_output_set_mode(tdm_output *output, const tdm_output_mode *mode);
518 * @brief Get the mode of a output object
519 * @param[in] output A output object
520 * @param[out] mode A output mode
521 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
524 tdm_output_get_mode(tdm_output *output, const tdm_output_mode **mode);
527 * @brief Set DPMS of a output object
528 * @param[in] output A output object
529 * @param[in] dpms_value DPMS value
530 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
533 tdm_output_set_dpms(tdm_output *output, tdm_output_dpms dpms_value);
536 * @brief Get DPMS of a output object
537 * @param[in] output A output object
538 * @param[out] dpms_value DPMS value
539 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
542 tdm_output_get_dpms(tdm_output *output, tdm_output_dpms *dpms_value);
545 * @brief Create a capture object of a output object
546 * @param[in] output A output object
547 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
548 * @return A capture object
549 * @see tdm_capture_destroy
552 tdm_output_create_capture(tdm_output *output, tdm_error *error);
555 * @brief Get the capabilities of a layer object.
556 * @param[in] layer A layer object
557 * @param[out] capabilities The capabilities of a layer object
558 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
561 tdm_layer_get_capabilities(tdm_layer *layer,
562 tdm_layer_capability *capabilities);
565 * @brief Get the available format array of a layer object.
566 * @param[in] layer A layer object
567 * @param[out] formats The available format array
568 * @param[out] count The count of formats
569 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
572 tdm_layer_get_available_formats(tdm_layer *layer, const tbm_format **formats,
576 * @brief Get the available property array of a layer object.
577 * @param[in] layer A layer object
578 * @param[out] props The available property array
579 * @param[out] count The count of properties
580 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
583 tdm_layer_get_available_properties(tdm_layer *layer, const tdm_prop **props,
587 * @brief Get the zpos of a layer object.
589 * - GRAPHIC layers have fixed zpos. It starts from 0. It's @b non-changeable.
590 * - But the zpos of VIDEO layers will be decided by a backend module side.
591 * - A frontend user only can set the relative zpos to VIDEO layers via #tdm_layer_set_video_pos
592 * - The zpos of video layers is less than GRAPHIC layers or more than GRAPHIC
593 * layers. ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
594 * -------------------------------- graphic layer 3 <-- top most layer
595 * -------------------------------- graphic layer 2
596 * -------------------------------- graphic layer 1
597 * -------------------------------- graphic layer 0
598 * -------------------------------- video layer -1
599 * -------------------------------- video layer -2 <-- lowest layer
600 * @param[in] layer A layer object
601 * @param[out] zpos The zpos
602 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
603 * @see tdm_layer_set_video_pos, tdm_layer_capability
606 tdm_layer_get_zpos(tdm_layer *layer, int *zpos);
609 * @brief Set the property which has a given id.
610 * @param[in] layer A layer object
611 * @param[in] id The property id
612 * @param[in] value The value
613 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
616 tdm_layer_set_property(tdm_layer *layer, unsigned int id, tdm_value value);
619 * @brief Get the property which has a given id.
620 * @param[in] layer A layer object
621 * @param[in] id The property id
622 * @param[out] value The value
623 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
626 tdm_layer_get_property(tdm_layer *layer, unsigned int id, tdm_value *value);
629 * @brief Set the geometry information to a layer object
630 * @details The geometry information will be applied when the output object
631 * of a layer object is committed. If a layer has TDM_LAYER_CAPABILITY_NO_CROP
632 * capability, a layer will ignore the pos(crop) information of #tdm_info_layer's
634 * @param[in] layer A layer object
635 * @param[in] info The geometry information
636 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
637 * @see tdm_layer_commit
640 tdm_layer_set_info(tdm_layer *layer, tdm_info_layer *info);
643 * @brief Get the geometry information to a layer object
644 * @param[in] layer A layer object
645 * @param[out] info The geometry information
646 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
649 tdm_layer_get_info(tdm_layer *layer, tdm_info_layer *info);
652 * @brief Set a TDM buffer to a layer object
653 * @details A TDM buffer will be applied when the output object
654 * of a layer object is committed.
655 * @param[in] layer A layer object
656 * @param[in] buffer A TDM buffer
657 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
658 * @see tdm_layer_commit
661 tdm_layer_set_buffer(tdm_layer *layer, tbm_surface_h buffer);
664 * @brief Unset a TDM buffer from a layer object
665 * @details When this function is called, a current showing buffer will be
666 * disappeared from screen. Then nothing is showing on a layer object.
667 * @param[in] layer A layer object
668 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
671 tdm_layer_unset_buffer(tdm_layer *layer);
674 * @brief Commit changes for a layer object
675 * @details After all change of a layer object are applied, a user commit handler
677 * @param[in] layer A layer object
678 * @param[in] func A user commit handler
679 * @param[in] user_data The user data
680 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
683 tdm_layer_commit(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
686 tdm_layer_is_committing(tdm_layer *layer, unsigned int *committing);
689 * @brief Remove the user commit handler
690 * @param[in] layer A layer object
691 * @param[in] func A user commit handler
692 * @param[in] user_data The user data
693 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
696 tdm_layer_remove_commit_handler(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
699 * @brief Get a displaying TDM buffer from a layer object
700 * @details A displaying TDM buffer is a current showing buffer on screen
701 * that is set to layer object and applied output object of a layer object.
702 * @param[in] layer A layer object
703 * @return A TDM buffer if success. Otherwise, NULL.
706 tdm_layer_get_displaying_buffer(tdm_layer *layer, tdm_error *error);
709 * @brief Set a TBM surface_queue to a layer object
710 * @details A TBM surface_queue will be applied when the output object
711 * of a layer object is committed. and TDM layer will be automatically updated
712 * @param[in] layer A layer object
713 * @param[in] buffer_queue A TBM surface_queue
714 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
715 * @see tdm_layer_commit
718 tdm_layer_set_buffer_queue(tdm_layer *layer, tbm_surface_queue_h buffer_queue);
721 * @brief Unset a TBM surface_queue from a layer object
722 * @details When this function is called, a current surface_queue will be
723 * disappeared from screen. Then nothing is showing on a layer object.
724 * @param[in] layer A layer object
725 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
728 tdm_layer_unset_buffer_queue(tdm_layer *layer);
731 * @brief Check wheter a layer object is available for a frontend user to use.
732 * @details A layer object is not usable if a TDM buffer is showing on screen
733 * via this layer object. By calling #tdm_layer_unset_buffer, this layer object
734 * will become usable.
735 * @param[in] layer A layer object
736 * @param[out] usable 1 if usable, 0 if not usable
737 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
740 tdm_layer_is_usable(tdm_layer *layer, unsigned int *usable);
743 * @brief Set the relative zpos to a VIDEO layer object
744 * @details The zpos value is less than the minimum zpos of GRAPHIC layers, or
745 * it is more than the maximum zpos of GRAPHIC layers.
746 * @param[in] layer A VIDEO layer object
747 * @param[in] zpos The zpos
748 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
749 * @see tdm_layer_get_zpos, tdm_layer_capability
752 tdm_layer_set_video_pos(tdm_layer *layer, int zpos);
755 * @brief Create a capture object of a layer object
756 * @param[in] layer A layer object
757 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
758 * @return A capture object
759 * @see tdm_capture_destroy
762 tdm_layer_create_capture(tdm_layer *layer, tdm_error *error);
765 * @brief Get buffer flags from a layer object
766 * @param[in] layer A layer object
767 * @param[out] flags a buffer flags value
768 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
771 tdm_layer_get_buffer_flags(tdm_layer *layer, unsigned int *flags);
774 * @brief Destroy a pp object
775 * @param[in] pp A pp object
776 * @see tdm_display_create_pp
779 tdm_pp_destroy(tdm_pp *pp);
782 * @brief Set the geometry information to a pp object
783 * @param[in] pp A pp object
784 * @param[in] info The geometry information
785 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
789 tdm_pp_set_info(tdm_pp *pp, tdm_info_pp *info);
792 * @brief Set the PP done handler to a pp object
794 * The user PP done handler will be called after converting a source buffer's image
795 * to a destination buffer.
796 * @param[in] pp A pp object
797 * @param[in] func A user PP done handler
798 * @param[in] user_data The user data
799 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
802 tdm_pp_set_done_handler(tdm_pp *pp, tdm_pp_done_handler func, void *user_data);
805 * @brief Attach a source buffer and a destination buffer to a pp object
806 * @param[in] pp A pp object
807 * @param[in] src A source buffer
808 * @param[in] dst A destination buffer
809 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
810 * @see tdm_pp_commit, tdm_pp_set_done_handler
813 tdm_pp_attach(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
816 * @brief Commit changes for a pp object
817 * @param[in] pp A pp object
818 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
821 tdm_pp_commit(tdm_pp *pp);
824 * @brief Destroy a capture object
825 * @param[in] capture A capture object
826 * @see tdm_output_create_capture, tdm_layer_create_capture
829 tdm_capture_destroy(tdm_capture *capture);
832 * @brief Set the geometry information to a capture object
833 * @param[in] capture A capture object
834 * @param[in] info The geometry information
835 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
836 * @see tdm_capture_commit
839 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info);
842 * @brief Set the capture done handler to a capture object
844 * The user capture done handler will be called after capturing a screen into a
846 * @param[in] capture A capture object
847 * @param[in] func A user capture done handler
848 * @param[in] user_data The user data
849 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
852 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data);
855 * @brief Attach a TDM buffer to a capture object
856 * @param[in] capture A capture object
857 * @param[in] buffer A TDM buffer
858 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
859 * @see tdm_capture_commit, tdm_capture_set_done_handler
862 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer);
865 * @brief Commit changes for a capture object
866 * @param[in] capture A capture object
867 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
870 tdm_capture_commit(tdm_capture *capture);
873 * @brief The release handler of a TDM buffer
874 * @param[in] buffer A TDM buffer
875 * @param[in] user_data user data
876 * @see tdm_buffer_add_release_handler, tdm_buffer_remove_release_handler
878 typedef void (*tdm_buffer_release_handler)(tbm_surface_h buffer,
882 * @brief Add a release handler to a TDM buffer
884 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
885 * becomes available for a next job. A TDM buffer can be used for TDM to show
886 * it on screen or to capture an output and a layer. After all operations,
887 * TDM will release it immediately when TDM doesn't need it any more.
888 * @param[in] buffer A TDM buffer
889 * @param[in] func A release handler
890 * @param[in] user_data user data
891 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
892 * @see tdm_buffer_remove_release_handler
895 tdm_buffer_add_release_handler(tbm_surface_h buffer,
896 tdm_buffer_release_handler func, void *user_data);
899 * @brief Remove a release handler from a TDM buffer
900 * @param[in] buffer A TDM buffer
901 * @param[in] func A release handler
902 * @param[in] user_data user data
903 * @see tdm_buffer_add_release_handler
906 tdm_buffer_remove_release_handler(tbm_surface_h buffer,
907 tdm_buffer_release_handler func, void *user_data);
910 * @brief The handler of a vblank object
911 * @see #tdm_vblank_wait, #tdm_vblank_wait_seq
913 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
914 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
917 * @brief Set the vblank fps for the given PID and name.
918 * @param[in] pid The process ID
919 * @param[in] name The client vblank name
920 * @param[in] fps The client vblank fps
921 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
924 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
927 * @brief Create a vblank object
928 * @param[in] dpy A display object
929 * @param[in] output A output object
930 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
931 * @return A vblank object
932 * @see #tdm_vblank_destroy
935 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
938 * @brief Destroy a vblank object
939 * @param[in] vblank A vblank object
940 * @see #tdm_vblank_create
943 tdm_vblank_destroy(tdm_vblank *vblank);
946 * @brief Set the name to a vblank object
947 * @details The default name is "unknown"
948 * @param[in] vblank A vblank object
949 * @param[in] name vblank name
950 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
953 tdm_vblank_set_name(tdm_vblank *vblank, const char *name);
956 * @brief Get the name for a vblank object
957 * @details The default name is "unknown"
958 * @param[in] vblank A vblank object
959 * @param[out] name vblank name
960 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
963 tdm_vblank_get_name(tdm_vblank *vblank, const char **name);
966 * @brief Set the fps to a vblank object
967 * @details Default is the @b vertical @b refresh @b rate of the given output.
968 * @param[in] vblank A vblank object
969 * @param[in] fps over 0
970 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
973 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
976 * @brief Get the fps for a vblank object
977 * @param[in] vblank A vblank object
978 * @param[out] fps over 0
979 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
982 tdm_vblank_get_fps(tdm_vblank *vblank, unsigned int *fps);
985 * @brief Set the offset(milli-second) to a vblank object
986 * @details Default is @b 0.
987 * @param[in] vblank A vblank object
988 * @param[in] offset the offset(milli-second)
989 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
992 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
995 * @brief Get the offset(milli-second) for a vblank object
996 * @param[in] vblank A vblank object
997 * @param[out] offset the offset(milli-second)
998 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1001 tdm_vblank_get_offset(tdm_vblank *vblank, int *offset);
1004 * @brief Enable/Disable the fake vblank to a vblank object
1006 * If enable_fake == 0, #tdm_vblank_wait will return TDM_ERROR_DPMS_OFF
1007 * when DPMS off. Otherwise, #tdm_vblank_wait will return TDM_ERROR_NONE
1009 * @param[in] vblank A vblank object
1010 * @param[in] enable_fake 1:enable, 0:disable
1011 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1014 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
1017 * @brief Get the fake vblank
1018 * @param[in] vblank A vblank object
1019 * @param[out] enable_fake 1:enable, 0:disable
1020 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1023 tdm_vblank_get_enable_fake(tdm_vblank *vblank, unsigned int *enable_fake);
1026 * @brief Wait for a vblank
1028 * Once #tdm_vblank_wait returns TDM_ERROR_NONE, the user vblank handler(#tdm_vblank_handler)
1029 * SHOULD be called after the given interval. \n
1030 * The sequence value of tdm_vblank_handler is the relative value of fps.
1031 * If fps = 10, this sequence value should be increased by 10 during 1 second.
1032 * @param[in] vblank A vblank object
1033 * @param[in] req_sec The vblank request time(second)
1034 * @param[in] req_usec The vblank request time(micro-second)
1035 * @param[in] interval The vblank interval
1036 * @param[in] func The user vblank handler
1037 * @param[in] user_data The user data
1038 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1041 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1042 unsigned int interval, tdm_vblank_handler func, void *user_data);
1045 * @brief Wait for a vblank with the target sequence number
1046 * @param[in] vblank A vblank object
1047 * @param[in] req_sec The vblank request time(second)
1048 * @param[in] req_usec The vblank request time(micro-second)
1049 * @param[in] sequence The target sequence number
1050 * @param[in] func The user client vblank handler
1051 * @param[in] user_data The user data
1052 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1055 tdm_vblank_wait_seq(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec,
1056 unsigned int sequence, tdm_vblank_handler func, void *user_data);
1062 #endif /* _TDM_H_ */