correct capture behavior
[platform/core/uifw/libtdm.git] / src / tdm_capture.c
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 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #include "tdm.h"
41 #include "tdm_backend.h"
42 #include "tdm_private.h"
43 #include "tdm_helper.h"
44
45 #define CAPTURE_FUNC_ENTRY() \
46         tdm_func_capture *func_capture; \
47         tdm_private_display *private_display; \
48         tdm_private_capture *private_capture; \
49         tdm_error ret = TDM_ERROR_NONE; \
50         TDM_RETURN_VAL_IF_FAIL(capture != NULL, TDM_ERROR_INVALID_PARAMETER); \
51         private_capture = (tdm_private_capture*)capture; \
52         private_display = private_capture->private_display; \
53         func_capture = &private_display->func_capture
54
55 static void
56 _tdm_capture_print_list(struct list_head *list)
57 {
58         tdm_capture_private_buffer *b = NULL;
59         char str[512], *p;
60         int len = sizeof(str);
61
62         TDM_RETURN_IF_FAIL(list != NULL);
63
64         p = str;
65         LIST_FOR_EACH_ENTRY(b, list, link) {
66                 if (len > 0) {
67                         int l = snprintf(p, len, " (%p)", b->buffer);
68                         p += l;
69                         len -= l;
70                 } else
71                         break;
72         }
73
74         TDM_INFO("\t %s", str);
75 }
76
77 static tdm_capture_private_buffer *
78 _tdm_capture_find_tbm_buffer(struct list_head *list, tbm_surface_h buffer)
79 {
80         tdm_capture_private_buffer *b = NULL, *bb = NULL;
81
82         LIST_FOR_EACH_ENTRY_SAFE(b, bb, list, link) {
83                 if (b->buffer == buffer)
84                         return b;
85         }
86
87         return NULL;
88 }
89
90 static tdm_capture_private_buffer *
91 _tdm_capture_find_buffer(struct list_head *list, tdm_capture_private_buffer *capture_buffer)
92 {
93         tdm_capture_private_buffer *b = NULL, *bb = NULL;
94
95         LIST_FOR_EACH_ENTRY_SAFE(b, bb, list, link) {
96                 if (b == capture_buffer)
97                         return b;
98         }
99
100         return NULL;
101 }
102
103 INTERN void
104 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
105                                         void *user_data)
106 {
107         tdm_private_capture *private_capture = user_data;
108         tdm_private_display *private_display = private_capture->private_display;
109         tdm_capture_private_buffer *capture_buffer = NULL, *first_entry = NULL;
110
111         TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
112
113         if (private_capture->owner_tid != syscall(SYS_gettid)) {
114                 tdm_thread_cb_capture_done capture_done;
115                 tdm_error ret;
116
117                 capture_done.base.type = TDM_THREAD_CB_CAPTURE_DONE;
118                 capture_done.base.length = sizeof capture_done;
119                 capture_done.capture_stamp = private_capture->stamp;
120                 capture_done.buffer = buffer;
121                 capture_done.user_data = user_data;
122
123                 ret = tdm_thread_send_cb(private_display->private_loop, &capture_done.base);
124                 TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
125
126                 return;
127         }
128
129         if (private_capture->owner_tid != syscall(SYS_gettid))
130                 TDM_NEVER_GET_HERE();
131
132         if (tdm_debug_dump & TDM_DUMP_FLAG_CAPTURE) {
133                 char str[TDM_PATH_LEN];
134                 static int i;
135                 snprintf(str, TDM_PATH_LEN, "capture_%03d", i++);
136                 tdm_helper_dump_buffer_str(buffer, tdm_debug_dump_dir, str);
137         }
138
139         if (tdm_debug_module & TDM_DEBUG_BUFFER)
140                 TDM_INFO("capture(%p) done: %p", private_capture, buffer);
141
142         if (!LIST_IS_EMPTY(&private_capture->buffer_list)) {
143                 first_entry = container_of((&private_capture->buffer_list)->next, capture_buffer, link);
144                 if (first_entry->buffer != buffer)
145                         TDM_ERR("buffer(%p) is skipped", first_entry->buffer);
146         } else {
147                 TDM_NEVER_GET_HERE();
148         }
149
150         if ((capture_buffer = _tdm_capture_find_tbm_buffer(&private_capture->buffer_list, buffer))) {
151                 LIST_DEL(&capture_buffer->link);
152
153                 _pthread_mutex_unlock(&private_display->lock);
154                 if (private_capture->done_func)
155                         private_capture->done_func(capture_buffer, buffer, private_capture->done_user_data);
156                 tdm_buffer_unref_backend(buffer);
157                 _pthread_mutex_lock(&private_display->lock);
158
159                 free(capture_buffer);
160         }
161 }
162
163 INTERN tdm_private_capture *
164 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp)
165 {
166         tdm_private_capture *private_capture = NULL;
167
168         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), NULL);
169
170         LIST_FOR_EACH_ENTRY(private_capture, &private_display->capture_list, display_link) {
171                 if (private_capture->stamp == stamp)
172                         return private_capture;
173         }
174
175         return NULL;
176 }
177
178 INTERN tdm_private_capture *
179 tdm_capture_create_output_internal(tdm_private_output *private_output,
180                                                                    tdm_error *error)
181 {
182         tdm_private_display *private_display = private_output->private_display;
183         tdm_func_output *func_output = &private_display->func_output;
184         tdm_func_capture *func_capture = &private_display->func_capture;
185         tdm_private_capture *private_capture = NULL;
186         tdm_capture *capture_backend = NULL;
187         tdm_error ret = TDM_ERROR_NONE;
188
189         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), NULL);
190
191         if (!(private_display->capabilities & TDM_DISPLAY_CAPABILITY_CAPTURE)) {
192                 TDM_ERR("no capture capability");
193                 if (error)
194                         *error = TDM_ERROR_NO_CAPABILITY;
195                 return NULL;
196         }
197
198         if (!(private_display->caps_capture.capabilities & TDM_CAPTURE_CAPABILITY_OUTPUT)) {
199                 TDM_ERR("no output capture capability");
200                 if (error)
201                         *error = TDM_ERROR_NO_CAPABILITY;
202                 return NULL;
203         }
204
205         capture_backend = func_output->output_create_capture(
206                                                   private_output->output_backend, &ret);
207         if (ret != TDM_ERROR_NONE) {
208                 if (error)
209                         *error = ret;
210                 return NULL;
211         }
212
213         private_capture = calloc(1, sizeof(tdm_private_capture));
214         if (!private_capture) {
215                 TDM_ERR("failed: alloc memory");
216                 func_capture->capture_destroy(capture_backend);
217                 if (error)
218                         *error = TDM_ERROR_OUT_OF_MEMORY;
219                 return NULL;
220         }
221
222         ret = func_capture->capture_set_done_handler(capture_backend,
223                         tdm_capture_cb_done, private_capture);
224         if (ret != TDM_ERROR_NONE) {
225                 TDM_ERR("capture(%p) set capture_done_handler failed", private_capture);
226                 func_capture->capture_destroy(capture_backend);
227                 if (error)
228                         *error = ret;
229                 return NULL;
230         }
231
232         private_capture->stamp = tdm_helper_get_time();
233         while (tdm_capture_find_stamp(private_display, private_capture->stamp))
234                 private_capture->stamp++;
235
236         LIST_ADD(&private_capture->link, &private_output->capture_list);
237         LIST_ADD(&private_capture->display_link, &private_display->capture_list);
238
239         private_capture->target = TDM_CAPTURE_TARGET_OUTPUT;
240         private_capture->private_display = private_display;
241         private_capture->private_output = private_output;
242         private_capture->private_layer = NULL;
243         private_capture->capture_backend = capture_backend;
244         private_capture->owner_tid = syscall(SYS_gettid);
245
246         LIST_INITHEAD(&private_capture->pending_buffer_list);
247         LIST_INITHEAD(&private_capture->buffer_list);
248
249         TDM_DBG("capture(%p) create", private_capture);
250
251         if (error)
252                 *error = TDM_ERROR_NONE;
253
254         return private_capture;
255 }
256
257 INTERN tdm_private_capture *
258 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
259                                                                   tdm_error *error)
260 {
261         tdm_private_output *private_output = private_layer->private_output;
262         tdm_private_display *private_display = private_output->private_display;
263         tdm_func_layer *func_layer = &private_display->func_layer;
264         tdm_func_capture *func_capture = &private_display->func_capture;
265         tdm_private_capture *private_capture = NULL;
266         tdm_capture *capture_backend = NULL;
267         tdm_error ret = TDM_ERROR_NONE;
268
269         TDM_RETURN_VAL_IF_FAIL(TDM_MUTEX_IS_LOCKED(), NULL);
270
271         if (!(private_display->capabilities & TDM_DISPLAY_CAPABILITY_CAPTURE)) {
272                 TDM_ERR("no capture capability");
273                 if (error)
274                         *error = TDM_ERROR_NO_CAPABILITY;
275                 return NULL;
276         }
277
278         if (!(private_display->caps_capture.capabilities & TDM_CAPTURE_CAPABILITY_LAYER)) {
279                 TDM_ERR("no layer capture capability");
280                 if (error)
281                         *error = TDM_ERROR_NO_CAPABILITY;
282                 return NULL;
283         }
284
285         capture_backend = func_layer->layer_create_capture(private_layer->layer_backend,
286                                           &ret);
287         if (ret != TDM_ERROR_NONE)
288                 return NULL;
289
290         private_capture = calloc(1, sizeof(tdm_private_capture));
291         if (!private_capture) {
292                 TDM_ERR("failed: alloc memory");
293                 func_capture->capture_destroy(capture_backend);
294                 if (error)
295                         *error = TDM_ERROR_OUT_OF_MEMORY;
296                 return NULL;
297         }
298
299         private_capture->stamp = tdm_helper_get_time();
300         while (tdm_capture_find_stamp(private_display, private_capture->stamp))
301                 private_capture->stamp++;
302
303         LIST_ADD(&private_capture->link, &private_layer->capture_list);
304         LIST_ADD(&private_capture->display_link, &private_display->capture_list);
305
306         private_capture->target = TDM_CAPTURE_TARGET_LAYER;
307         private_capture->private_display = private_display;
308         private_capture->private_output = private_output;
309         private_capture->private_layer = private_layer;
310         private_capture->capture_backend = capture_backend;
311         private_capture->owner_tid = syscall(SYS_gettid);
312
313         LIST_INITHEAD(&private_capture->pending_buffer_list);
314         LIST_INITHEAD(&private_capture->buffer_list);
315
316         TDM_DBG("capture(%p) create", private_capture);
317
318         if (error)
319                 *error = TDM_ERROR_NONE;
320
321         return private_capture;
322 }
323
324 INTERN void
325 tdm_capture_destroy_internal(tdm_private_capture *private_capture)
326 {
327         tdm_private_display *private_display;
328         tdm_func_capture *func_capture;
329         tdm_buffer_info *b = NULL, *bb = NULL;
330
331         TDM_RETURN_IF_FAIL(TDM_MUTEX_IS_LOCKED());
332
333         if (!private_capture)
334                 return;
335
336         private_display = private_capture->private_display;
337
338         LIST_DEL(&private_capture->link);
339         LIST_DEL(&private_capture->display_link);
340
341         func_capture = &private_capture->private_display->func_capture;
342         func_capture->capture_destroy(private_capture->capture_backend);
343
344         if (!LIST_IS_EMPTY(&private_capture->pending_buffer_list)) {
345                 TDM_WRN("capture(%p) not finished:", private_capture);
346                 _tdm_capture_print_list(&private_capture->pending_buffer_list);
347
348                 LIST_FOR_EACH_ENTRY_SAFE(b, bb, &private_capture->pending_buffer_list, link) {
349                         LIST_DEL(&b->link);
350                         _pthread_mutex_unlock(&private_display->lock);
351                         tdm_buffer_unref_backend(b->buffer);
352                         _pthread_mutex_lock(&private_display->lock);
353                         free(b);
354                 }
355         }
356
357         if (!LIST_IS_EMPTY(&private_capture->buffer_list)) {
358                 TDM_WRN("capture(%p) not finished:", private_capture);
359                 _tdm_capture_print_list(&private_capture->buffer_list);
360
361                 LIST_FOR_EACH_ENTRY_SAFE(b, bb, &private_capture->buffer_list, link) {
362                         LIST_DEL(&b->link);
363                         _pthread_mutex_unlock(&private_display->lock);
364                         tdm_buffer_unref_backend(b->buffer);
365                         _pthread_mutex_lock(&private_display->lock);
366                         free(b);
367                 }
368         }
369
370         private_capture->stamp = 0;
371         free(private_capture);
372 }
373
374 EXTERN void
375 tdm_capture_destroy(tdm_capture *capture)
376 {
377         tdm_private_capture *private_capture = capture;
378         tdm_private_display *private_display;
379
380         if (!private_capture)
381                 return;
382
383         TDM_DBG("capture(%p) destroy", private_capture);
384
385         private_display = private_capture->private_display;
386
387         _pthread_mutex_lock(&private_display->lock);
388         tdm_capture_destroy_internal(private_capture);
389         _pthread_mutex_unlock(&private_display->lock);
390 }
391
392 EXTERN tdm_error
393 tdm_capture_set_info(tdm_capture *capture, tdm_info_capture *info)
394 {
395         CAPTURE_FUNC_ENTRY();
396
397         TDM_RETURN_VAL_IF_FAIL(info != NULL, TDM_ERROR_INVALID_PARAMETER);
398         TDM_RETURN_VAL_IF_FAIL(info->type != 0, TDM_ERROR_INVALID_PARAMETER);
399
400         _pthread_mutex_lock(&private_display->lock);
401
402         if (!func_capture->capture_set_info) {
403                 _pthread_mutex_unlock(&private_display->lock);
404                 TDM_DBG("failed: not implemented!!");
405                 return TDM_ERROR_NOT_IMPLEMENTED;
406         }
407
408         if (info->type == TDM_CAPTURE_TYPE_STREAM && info->frequency == 0) {
409                 tdm_private_output *private_output = private_capture->private_output;
410                 info->frequency = private_output->current_mode->vrefresh;
411         }
412
413         TDM_INFO("capture(%p) info: dst(%dx%d %d,%d %dx%d %c%c%c%c) trans(%d) type(%d) freq(%d) flags(%x)",
414                          private_capture,
415                          info->dst_config.size.h, info->dst_config.size.v,
416                          info->dst_config.pos.x, info->dst_config.pos.y,
417                          info->dst_config.pos.w, info->dst_config.pos.h,
418                          FOURCC_STR(info->dst_config.format),
419                          info->transform, info->type, info->frequency, info->flags);
420
421         ret = func_capture->capture_set_info(private_capture->capture_backend, info);
422         TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
423
424         private_capture->info = *info;
425
426         _pthread_mutex_unlock(&private_display->lock);
427
428         return ret;
429 }
430
431 EXTERN tdm_error
432 tdm_capture_set_done_handler(tdm_capture *capture, tdm_capture_done_handler func, void *user_data)
433 {
434         tdm_private_display *private_display;
435         tdm_private_capture *private_capture;
436         tdm_error ret = TDM_ERROR_NONE;
437
438         TDM_RETURN_VAL_IF_FAIL(capture != NULL, TDM_ERROR_INVALID_PARAMETER);
439
440         private_capture = (tdm_private_capture*)capture;
441         private_display = private_capture->private_display;
442
443         TDM_RETURN_VAL_IF_FAIL(func != NULL, TDM_ERROR_INVALID_PARAMETER);
444
445         _pthread_mutex_lock(&private_display->lock);
446
447         private_capture->done_func = func;
448         private_capture->done_user_data = user_data;
449
450         _pthread_mutex_unlock(&private_display->lock);
451
452         return ret;
453 }
454
455 EXTERN tdm_error
456 tdm_capture_attach(tdm_capture *capture, tbm_surface_h buffer)
457 {
458         tdm_capture_private_buffer *capture_buffer;
459
460         CAPTURE_FUNC_ENTRY();
461
462         TDM_RETURN_VAL_IF_FAIL(buffer != NULL, TDM_ERROR_INVALID_PARAMETER);
463
464         _pthread_mutex_lock(&private_display->lock);
465
466         if (!func_capture->capture_attach) {
467                 _pthread_mutex_unlock(&private_display->lock);
468                 TDM_DBG("failed: not implemented!!");
469                 return TDM_ERROR_NOT_IMPLEMENTED;
470         }
471
472         if (tdm_display_check_module_abi(private_display, 1, 2) &&
473                 private_display->caps_capture.max_attach_count > 0) {
474                 int length = LIST_LENGTH(&private_capture->pending_buffer_list) +
475                                          LIST_LENGTH(&private_capture->buffer_list);
476                 if (length >= private_display->caps_capture.max_attach_count) {
477                         _pthread_mutex_unlock(&private_display->lock);
478                         TDM_DBG("failed: too many attached!! max_attach_count(%d)",
479                                         private_display->caps_capture.max_attach_count);
480                         return TDM_ERROR_BAD_REQUEST;
481                 }
482         }
483
484         capture_buffer = calloc(1, sizeof *capture_buffer);
485         if (!capture_buffer) {
486                 _pthread_mutex_unlock(&private_display->lock);
487                 TDM_ERR("alloc failed");
488                 return TDM_ERROR_OUT_OF_MEMORY;
489         }
490
491         ret = func_capture->capture_attach(private_capture->capture_backend, buffer);
492         TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
493
494         if (ret != TDM_ERROR_NONE) {
495                 free(capture_buffer);
496                 _pthread_mutex_unlock(&private_display->lock);
497                 TDM_ERR("attach failed");
498                 return ret;
499         }
500
501         LIST_ADDTAIL(&capture_buffer->link, &private_capture->pending_buffer_list);
502         capture_buffer->buffer = tdm_buffer_ref_backend(buffer);
503
504         if (tdm_debug_module & TDM_DEBUG_BUFFER) {
505                 TDM_INFO("capture(%p) attached:", private_capture);
506                 tdm_buffer_list_dump(&private_capture->buffer_list);
507         }
508
509         _pthread_mutex_unlock(&private_display->lock);
510
511         return ret;
512 }
513
514 EXTERN tdm_error
515 tdm_capture_commit(tdm_capture *capture)
516 {
517         tdm_capture_private_buffer *b = NULL, *bb = NULL;
518         tdm_private_output *private_output;
519         struct list_head commit_buffer_list;
520
521         CAPTURE_FUNC_ENTRY();
522
523         _pthread_mutex_lock(&private_display->lock);
524
525         private_output = private_capture->private_output;
526         if (private_output->current_dpms_value > TDM_OUTPUT_DPMS_ON) {
527                 TDM_ERR("output(%d) dpms: %s", private_output->pipe,
528                                 tdm_dpms_str(private_output->current_dpms_value));
529                 _pthread_mutex_unlock(&private_display->lock);
530                 return TDM_ERROR_BAD_REQUEST;
531         }
532
533         if (!func_capture->capture_commit) {
534                 _pthread_mutex_unlock(&private_display->lock);
535                 TDM_DBG("failed: not implemented!!");
536                 return TDM_ERROR_NOT_IMPLEMENTED;
537         }
538
539         LIST_INITHEAD(&commit_buffer_list);
540
541         LIST_FOR_EACH_ENTRY_SAFE(b, bb, &private_capture->pending_buffer_list, link) {
542                 LIST_DEL(&b->link);
543                 LIST_ADDTAIL(&b->link, &private_capture->buffer_list);
544                 LIST_ADDTAIL(&b->commit_link, &commit_buffer_list);
545         }
546
547         ret = func_capture->capture_commit(private_capture->capture_backend);
548         TDM_WARNING_IF_FAIL(ret == TDM_ERROR_NONE);
549
550         LIST_FOR_EACH_ENTRY_SAFE(b, bb, &commit_buffer_list, commit_link) {
551                 LIST_DEL(&b->commit_link);
552
553                 if (!_tdm_capture_find_buffer(&private_capture->buffer_list, b))
554                         continue;
555
556                 if (ret != TDM_ERROR_NONE) {
557                         /* Not to call the user release handler when failed.
558                          * Do we have to call this function here really?
559                          * User better use set_done_handler to know when pp is done. Using
560                          * buffer_release_handler is not good.
561                          */
562                         tdm_buffer_remove_release_handler_internal(b->buffer);
563
564                         _pthread_mutex_unlock(&private_display->lock);
565                         tdm_buffer_unref_backend(b->buffer);
566                         _pthread_mutex_lock(&private_display->lock);
567                         LIST_DEL(&b->link);
568                 }
569         }
570
571         _pthread_mutex_unlock(&private_display->lock);
572
573         return ret;
574 }