PUI: add manual render set/get APIs and move ani get/set/update APIs to PUI from...
[platform/core/uifw/libpui.git] / backends / default_backend.c
1 /*
2  * Copyright © 2019 Samsung Electronics co., Ltd. All Rights Reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sublicense, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the
13  * next paragraph) shall be included in all copies or substantial
14  * portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  */
25
26 #include "default_backend.h"
27
28 pui_backend_ani_func *ani_func = NULL;
29 Eina_Hash *_animations_hash = NULL;
30 pui_backend_ani_data *g_ani_data = NULL;
31
32 #if 0
33 static double
34 _ani_backend_ease_function_get_intensity(pui_effect_func func, double interval)
35 {
36         double intensity = interval;
37         switch (func)
38         {
39                 case None:
40                         break;
41                 case Linear:
42                         break;
43                 case EaseInSine:
44                         intensity = 1 - cos(PI / 2 * interval);
45                         break;
46                 case EaseOutSine:
47                         intensity = sin(PI / 2 * interval);
48                         break;
49                 case EaseInQuart:
50                         intensity = interval * interval;
51                         break;
52                 case EaseOutQuart:
53                         intensity = interval * (2 - interval);
54                         break;
55                 default:
56                         break;
57         }
58
59         return intensity;
60 }
61
62 static unsigned int
63 _ani_backend_get_value(unsigned int end_frame, unsigned int start_frame, double interval)
64 {
65         double res = 0.0;
66
67         // interval: frame ratio between key frame to key frame
68         // end_frame and start_frame is key frame
69
70         res = (end_frame - start_frame) * interval + start_frame;
71
72         return res;
73 }
74 #endif
75
76 static pui_bool
77 _ani_backend_frame_cb(void *data, int serial)
78 {
79         pui_int_error e = PUI_INT_ERROR_NONE;
80         pui_ani_t *ani = (pui_ani_t *)data;
81         pui_backend_ani_data *ani_data = NULL;
82         pui_ani_control_buffer *buffer = NULL;
83         double now;
84
85         ani_data = pui_backend_ani_get_ani_data(ani);
86         default_ani_info *ani_info = (default_ani_info *)ani_data->ani_info;
87
88         now = ecore_time_unix_get();
89
90         pui_info("[time:%.3f] serial=%d\n", now, serial);
91
92         /* TODO : make use of ani_info */
93         (void) ani_info;
94
95         buffer = pui_backend_ani_get_buffer(ani);
96
97         if (!buffer)
98         {
99                 pui_err("Failed to get buffer !\n");
100                 return 0;
101         }
102
103         /* test example */
104         for(int i = 0; i<12; i++)
105         {
106                 buffer->ptr[4*i] = 0;
107                 buffer->ptr[4*i + 1] = (ani_info->frames[ani_info->frame_idx].leds[i].color & LED_MASK_RED) >> 16;//R
108                 buffer->ptr[4*i + 2] = (ani_info->frames[ani_info->frame_idx].leds[i].color & LED_MASK_GREEN) >> 8;//G
109                 buffer->ptr[4*i + 3] = ani_info->frames[ani_info->frame_idx].leds[i].color & LED_MASK_BLUE;//B
110         }
111
112         e = pui_backend_ani_set_buffer(ani, buffer);
113
114         if (e != PUI_INT_ERROR_NONE)
115         {
116                 pui_err("Failed on setting buffer on animation !(e=%d)\n", e);
117                 return (pui_bool)0;
118         }
119
120         e = pui_backend_ani_update(ani);
121
122         if (e != PUI_INT_ERROR_NONE)
123         {
124                 pui_err("Failed on updating animation !(e=%d)\n", e);
125                 return (pui_bool)0;
126         }
127
128         pui_info("... update (serial=%d)\n", serial);
129
130         return (pui_bool)1;
131 }
132
133 default_ani_info *
134 get_ani_info_from_ani_collection(pui_id id)
135 {
136         default_ani_info *ani_info = NULL;
137
138         if (!_animations_hash)
139                 return NULL;
140
141         pui_info("... id: %s\n", id);
142
143         ani_info = eina_hash_find(_animations_hash, id);
144
145         if (!ani_info)
146         {
147                 pui_err("ani_info has NOT been found ! (id:%s)\n", id);
148                 return NULL;
149         }
150
151         pui_info("ani_info has been found ! (id:%s)\n", id);
152
153         return ani_info;
154 }
155
156 pui_error
157 _ani_start(pui_ani_t *ani, int repeat)
158 {
159         pui_bool ret = 0;
160         pui_int_error e = PUI_INT_ERROR_NONE;
161         pui_backend_ani_data *ani_data = NULL;
162
163         ani_data = pui_backend_ani_get_ani_data(ani);
164         default_ani_info *ani_info = (default_ani_info *)ani_data->ani_info;
165
166         pui_info("... info->id: %s, repeat : %d\n", ani_info->id, repeat);
167
168         pui_backend_ani_status_update(ani, PUI_ANI_STATUS_STARTED);
169         ret = pui_backend_ani_add_frame_cb(ani, _ani_backend_frame_cb, (double)ani_info->interval / 1000);
170
171         if (!ret)
172         {
173                 pui_err("Failed to add frame callback !\n");
174                 e = PUI_INT_ERROR_INVALID_RESOURCES;
175         }
176
177         return e;
178 }
179
180 pui_error
181 _ani_stop(pui_ani_t *ani, pui_bool force)
182 {
183         pui_int_error e = PUI_INT_ERROR_NONE;
184         pui_backend_ani_data *ani_data = NULL;
185
186         ani_data = pui_backend_ani_get_ani_data(ani);
187         default_ani_info *info = (default_ani_info *)ani_data->ani_info;
188
189         //TODO
190         (void) info;
191
192         pui_info("... info->id: %s, force=%d\n", info->id, force);
193
194         pui_backend_ani_remove_frame_cb(ani);
195
196         if (force)
197                 pui_backend_ani_status_update(ani, PUI_ANI_STATUS_PAUSED);
198         else
199                 pui_backend_ani_status_update(ani, PUI_ANI_STATUS_STOPPED);
200
201         return e;
202 }
203
204 static char *
205 _read_json_file(const char *path, int *data_size)
206 {
207         FILE *fp = fopen(path, "rb");
208         int size;
209         char *buffer;
210         ERROR_CHECK(fp, return NULL, "Failed to open file: %s\n", path);
211
212         fseek(fp, 0, SEEK_END);
213         size = ftell(fp);
214         fseek(fp, 0, SEEK_SET);
215
216         buffer = (char *)calloc(sizeof(char), size + 1);
217
218         if (fread(buffer, size, 1, fp) < 1) {
219                 *data_size = 0;
220                 free(buffer);
221                 fclose(fp);
222                 return NULL;
223         }
224
225         *data_size = size;
226         fclose(fp);
227         return buffer;
228 }
229
230 static default_ani_info *
231 _read_json(const char *path)
232 {
233         char *buffer, *type;
234         json_object *root_obj, *data_obj, *frame_obj, *frame_data_obj, *led_obj, *led_data_obj;
235         default_ani_info *ani_info = NULL;
236         int frame_id = 0, frame_len = 0, led_id = 0, led_len = 0;
237         int data_size = 0, i, j;
238
239         buffer = _read_json_file(path, &data_size);
240         ERROR_CHECK(buffer && data_size > 0, return EINA_FALSE, "File %s has no data\n", path);
241         root_obj = json_tokener_parse(buffer);
242         ERROR_CHECK(root_obj, goto error, "Failed to tokenize json object\n");
243
244         ani_info = (default_ani_info *)calloc(1, sizeof(default_ani_info));
245         ERROR_CHECK(ani_info, goto error, "Failed to alloc for animation info\n");
246
247         data_obj = json_object_object_get(root_obj, "type");
248         //printf("type: %s\n", json_object_get_string(data_obj));
249         type = (char *)json_object_get_string(data_obj);
250         ani_info->id = strndup(type, strlen(type));
251
252         data_obj = json_object_object_get(root_obj, "interval");
253         //printf("interval: %d\n", json_object_get_int(data_obj));
254         ani_info->interval = json_object_get_int(data_obj);
255
256         data_obj = json_object_object_get(root_obj, "frame");
257         frame_len = json_object_array_length(data_obj);
258
259         ani_info->num_key_frames = frame_len;
260         ani_info->frames = (default_frame_info_t *)calloc(sizeof(default_frame_info_t), frame_len);
261         ERROR_CHECK(ani_info->frames, goto error, "Failed to alloc for default_frame_info_t\n");
262
263         for (i = 0; i < frame_len; i++) {
264                 frame_obj = json_object_array_get_idx(data_obj, i);
265
266                 frame_data_obj = json_object_object_get(frame_obj, "frame_id");
267                 //printf("\tframe id: %d\n", json_object_get_int(frame_data_obj));
268                 frame_id = json_object_get_int(frame_data_obj);
269
270                 frame_data_obj = json_object_object_get(frame_obj, "frame_duration");
271                 if (frame_data_obj)
272                         ani_info->frames[frame_id - 1].frame_duration = json_object_get_int(frame_data_obj);
273                 else
274                         ani_info->frames[frame_id - 1].frame_duration = ani_info->interval;
275
276                 frame_data_obj = json_object_object_get(frame_obj, "led");
277                 led_len = json_object_array_length(frame_data_obj);
278
279                 ani_info->frames[frame_id - 1].num_led = led_len;
280                 ani_info->frames[frame_id - 1].leds = (default_led_info_t *)calloc(sizeof(default_led_info_t), led_len);
281                 ERROR_CHECK(ani_info->frames[frame_id - 1].leds, goto error, "Failed to alloc for default_led_info_t\n");
282
283                 for (j = 0; j < led_len; j++) {
284                         led_obj = json_object_array_get_idx(frame_data_obj, j);
285
286                         led_data_obj = json_object_object_get(led_obj, "id");
287                         //printf("\t\tid: %2d  ", json_object_get_int(led_data_obj));
288                         led_id = json_object_get_int(led_data_obj);
289
290                         led_data_obj = json_object_object_get(led_obj, "color");
291                         //printf("color: %s\n", json_object_get_string(led_data_obj));
292                         ani_info->frames[frame_id - 1].leds[led_id - 1].color =
293                                 strtol(json_object_get_string(led_data_obj), NULL, 16);
294                 }
295         }
296
297         free(buffer);
298         return ani_info;
299
300 error:
301         free(buffer);
302         if (ani_info) {
303                 if (ani_info->frames) {
304                         for (i = 0; i < ani_info->num_key_frames; i++) {
305                                 if (ani_info->frames[i].leds)
306                                         free(ani_info->frames[i].leds);
307                         }
308                         free(ani_info->frames);
309                 }
310                 free(ani_info->id);
311                 free(ani_info);
312         }
313         return NULL;
314 }
315
316 int
317 _find_directory(const char *path, Eina_List **json_list)
318 {
319         DIR *dir;
320         struct dirent *cur;
321         int count = 0, ret_cnt = 0;
322
323         dir = opendir(path);
324         if (!dir)
325         {
326                 pui_err("Failed to open %s.\n", path);
327                 return count;
328         }
329
330         while ((cur = readdir(dir)) != NULL)
331         {
332                 char next_path[MAX_STR] = {0, };
333                 if (cur->d_type == DT_DIR)
334                 {
335                         if (!strncmp(cur->d_name, ".", sizeof(".")) ||
336                                 !strncmp(cur->d_name, "..", sizeof("..")))
337                                 continue;
338
339                         snprintf(next_path, MAX_STR, "%s/%s", path, cur->d_name);
340                         ret_cnt = _find_directory(next_path, json_list);
341                         count += ret_cnt;
342                 }
343                 else
344                 {
345                         if (strstr(cur->d_name, ".json"))
346                         {
347                                 snprintf(next_path, MAX_STR, "%s/%s", path, cur->d_name);
348                                 *json_list = eina_list_append(*json_list, eina_stringshare_add(next_path));
349                                 count++;
350                         }
351                 }
352         }
353         closedir(dir);
354
355         return count;
356 }
357
358
359 pui_int_error
360 _create_ani_collection(void)
361 {
362         pui_int_error e = PUI_INT_ERROR_NONE;
363         default_ani_info *ani_info;
364         Eina_List *json_list = NULL;
365         Eina_List *l, *l_next;
366         Eina_Stringshare *path;
367
368         // load and store all of animation data
369
370         _find_directory(ANI_COLLECTION_DIR, &json_list);
371
372         EINA_LIST_FOREACH_SAFE(json_list, l, l_next, path)
373         {
374                 ani_info = _read_json(path);
375                 if (ani_info) {
376                         eina_hash_add(_animations_hash, ani_info->id, ani_info);
377                         pui_info("Success to load %s animation (id: %s)\n", path, ani_info->id);
378                 }
379                 eina_stringshare_del(path);
380                 json_list = eina_list_remove_list(json_list, l);
381         }
382
383         //TODO
384
385         return e;
386 }
387
388 pui_bool
389 _geometry_get(int *width, int *height)
390 {
391         if (!width || !height)
392                 return 0;
393
394         if (width)
395                 *width = DEFAULT_BACKEND_GEOM_WIDTH;
396         if (height)
397                 *height = DEFAULT_BACKEND_GEOM_HEIGHT;
398
399         return 1;
400 }
401
402 pui_int_error
403 _is_ani_supported(pui_id id)
404 {
405         pui_int_error e = PUI_INT_ERROR_NONE;
406         default_ani_info *ani_info;
407
408         //TODO
409         /* if the given id is not supported, return PUI_INT_ERROR_ID_NOT_SUPPORTED. */
410         if (!id) {
411                 e = PUI_INT_ERROR_ID_NOT_SUPPORTED;
412                 return e;
413         }
414         ani_info = eina_hash_find(_animations_hash, id);
415
416         if (!ani_info)
417                 e = PUI_INT_ERROR_ID_NOT_SUPPORTED;
418
419         return e;
420 }
421
422 static void
423 _ani_info_cleanup(default_ani_info *ani_info)
424 {
425         int i;
426
427         if (!ani_info)
428                 return;
429
430         if (ani_info->frames)
431         {
432                 for (i = 0; i < ani_info->num_key_frames; i++)
433                 {
434                         if (ani_info->frames[i].leds)
435                                 free(ani_info->frames[i].leds);
436                 }
437
438                 free(ani_info->frames);
439         }
440
441         free(ani_info->id);
442 }
443
444 pui_backend_ani_data *
445 _ani_create(pui_id id)
446 {
447         pui_backend_ani_data *ani_data = NULL;
448         pui_backend_ani_func *ani_func = NULL;
449
450         /* backend's animation specific info */
451         default_ani_info *ani_info = NULL;
452
453         //TODO : return NULL if the animation correspond to the given id dones't exist.
454         if (PUI_INT_ERROR_NONE != _is_ani_supported(id))
455         {
456                 pui_err("The animation(%s) doesn't supported !\n", id);
457                 return NULL;
458         }
459
460         /* allocation of the structure of function pointers that will be called from pui_ani_control() */
461         ani_func = pui_backend_ani_alloc_ani_func();
462
463         if (!ani_func)
464         {
465                 pui_err("Failed to allocate memory ! (pui backend ani func)\n");
466                 return NULL;
467         }
468
469         /* get animation info associate with the given id from animation collection */
470         ani_info = get_ani_info_from_ani_collection(id);
471
472         if (!ani_info)
473         {
474                 pui_err("Failed to get ani info from animation collection !\n");
475                 goto err;
476         }
477
478         /* allocate backend ani_data and return it to pui ani core */
479         ani_data = (pui_backend_ani_data *)calloc(1, sizeof(pui_backend_ani_data));
480
481         if (!ani_data)
482         {
483                 pui_err("Failed to allocate memory for pui backend ani data !\n");
484                 goto err;
485         }
486
487         /* Assign each function pointer that corresponds to the given id if needed. */
488         if (!strncmp(ani_info->id, "system/easy_setup", sizeof("system/easy_setup")))
489         {
490                 pui_default_backend_ani_easysetup_func_set(ani_func);
491         }
492         else if (!strncmp(ani_info->id, "system/processing", sizeof("system/processing")))
493         {
494                 pui_default_backend_ani_system_processing_func_set(ani_func);
495         }
496         else if (!strncmp(ani_info->id, "system/sw_update_done", sizeof("system/sw_update_done")))
497         {
498                 pui_default_backend_ani_swupdatedone_func_set(ani_func);
499         }
500         else if (!strncmp(ani_info->id, "system/mic_off", sizeof("system/mic_off")))
501         {
502                 pui_default_backend_ani_micoff_func_set(ani_func);
503         }
504         else if (!strncmp(ani_info->id, "voice/listening", sizeof("voice/listening")))
505         {
506                 pui_default_backend_ani_listening_func_set(ani_func);
507         }
508         else if (!strncmp(ani_info->id, "voice/streaming", sizeof("voice/streaming")))
509         {
510                 pui_default_backend_ani_streaming_func_set(ani_func);
511         }
512         else if (!strncmp(ani_info->id, "voice/processing", sizeof("voice/processing")))
513         {
514                 pui_default_backend_ani_processing_func_set(ani_func);
515         }
516         else if (!strncmp(ani_info->id, "voice/speaking", sizeof("voice/speaking")))
517         {
518                 pui_default_backend_ani_speaking_func_set(ani_func);
519         }
520         else if (!strncmp(ani_info->id, "voice/timeout", sizeof("voice/timeout")))
521         {
522                 pui_default_backend_ani_timeout_func_set(ani_func);
523         }
524         else if (!strncmp(ani_info->id, "notification/normal", sizeof("notification/normal")))
525         {
526                 pui_default_backend_ani_normal_func_set(ani_func);
527         }
528         else if (!strncmp(ani_info->id, "notification/emergency", sizeof("notification/emergency")))
529         {
530                 pui_default_backend_ani_emergency_func_set(ani_func);
531         }
532         else if (!strncmp(ani_info->id, "notification/network_error", sizeof("notification/network_error")))
533         {
534                 pui_default_backend_ani_networkerror_func_set(ani_func);
535         }
536         else if (!strncmp(ani_info->id, "notification/error", sizeof("notification/error")))
537         {
538                 pui_default_backend_ani_error_func_set(ani_func);
539         }
540         else if (!strncmp(ani_info->id, "notification/alarm", sizeof("notification/alarm")))
541         {
542                 pui_default_backend_ani_alarm_func_set(ani_func);
543         }
544         else if (!strncmp(ani_info->id, "bt/pairing", sizeof("bt/pairing")))
545         {
546                 pui_default_backend_ani_pairing_func_set(ani_func);
547         }
548         else if (!strncmp(ani_info->id, "bt/connected", sizeof("bt/connected")))
549         {
550                 pui_default_backend_ani_connected_func_set(ani_func);
551         }
552         else
553         {
554                 pui_info("%s animation has no animation handler, using default handler\n", ani_info->id);
555                 /* Assign each function pointer that corresponds to the given id if needed. */
556                 ani_func->ani_start = _ani_start;
557                 ani_func->ani_stop = _ani_stop;
558         }
559
560         ani_data->ani_func = ani_func;
561         ani_data->ani_info = (pui_backend_ani_info *)ani_info;
562
563         g_ani_data = ani_data;
564
565         return ani_data;
566
567 err:
568         if (ani_func)
569         {
570                 pui_backend_ani_free_ani_func(ani_func);
571                 ani_func = NULL;
572         }
573
574         return NULL;
575 }
576
577 void
578 _ani_destroy(pui_backend_ani_data *ani_data)
579 {
580         if (!ani_data)
581                 return;
582
583         if (ani_data->ani_func)
584         {
585                 pui_backend_ani_free_ani_func(ani_data->ani_func);
586                 ani_data->ani_func = NULL;
587         }
588
589         ani_data->ani_info = NULL;
590         g_ani_data = NULL;
591 }
592
593 static void
594 _animation_data_free_cb(void *data)
595 {
596         default_ani_info *ani_info = (default_ani_info *)data;
597
598         _ani_info_cleanup(ani_info);
599 }
600
601 static pui_backend_module_data *
602 pui_default_backend_init(void)
603 {
604         pui_backend_module_data *backend_data = NULL;
605
606         backend_data = (pui_backend_module_data *)calloc(1, sizeof(pui_backend_module_data));
607
608         if (!backend_data)
609         {
610                 pui_err("Failed to allocate memory for pui backend module data !\n");
611                 return NULL;
612         }
613
614         backend_data->create_ani_collection = _create_ani_collection;
615         backend_data->geometry_get = _geometry_get;
616         backend_data->ani_create = _ani_create;
617         backend_data->ani_destroy = _ani_destroy;
618
619         /* Allocate backend specific data if needed. Now it will be empty. */
620         backend_data->data = NULL;
621         _animations_hash = eina_hash_string_superfast_new(NULL);
622
623         return backend_data;
624 }
625
626 static void
627 pui_default_backend_deinit(pui_backend_module_data *backend_data)
628 {
629         Eina_Iterator *it;
630         default_ani_info *ani_info = NULL;
631
632         if (!backend_data)
633                 return;
634
635         if (backend_data->data)
636         {
637                 //TODO : free variables of backend_data
638
639                 free(backend_data->data);
640         }
641
642         if (g_ani_data)
643         {
644                 if (g_ani_data->ani_func)
645                 {
646                         pui_backend_ani_free_ani_func(g_ani_data->ani_func);
647                         g_ani_data->ani_func = NULL;
648                 }
649
650                 g_ani_data->ani_info = NULL;
651         }
652
653         if (_animations_hash)
654         {
655                 it = eina_hash_iterator_data_new(_animations_hash);
656
657                 EINA_ITERATOR_FOREACH(it, ani_info)
658                 {
659                         _animation_data_free_cb(ani_info);
660                         free(ani_info);
661                 }
662
663                 eina_iterator_free(it);
664
665                 eina_hash_free(_animations_hash);
666                 _animations_hash = NULL;
667         }
668
669         backend_data->create_ani_collection = NULL;
670         backend_data->geometry_get = NULL;
671         backend_data->ani_create = NULL;
672         backend_data->ani_destroy = NULL;
673
674         free(backend_data);
675         backend_data = NULL;
676 }
677
678 pui_backend_module pui_backend_module_info = {
679         "Tizen Reference Speaker Backend",
680         "Samsung",
681         PUI_BACKEND_SET_ABI_VERSION(1, 0),
682         pui_default_backend_init,
683         pui_default_backend_deinit
684 };
685