scene.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Implementation of a scene, a collection of text/image/menu items in an expo
  4. *
  5. * Copyright 2022 Google LLC
  6. * Written by Simon Glass <sjg@chromium.org>
  7. */
  8. #define LOG_CATEGORY LOGC_EXPO
  9. #include <common.h>
  10. #include <dm.h>
  11. #include <expo.h>
  12. #include <malloc.h>
  13. #include <mapmem.h>
  14. #include <menu.h>
  15. #include <video.h>
  16. #include <video_console.h>
  17. #include <linux/input.h>
  18. #include "scene_internal.h"
  19. int scene_new(struct expo *exp, const char *name, uint id, struct scene **scnp)
  20. {
  21. struct scene *scn;
  22. scn = calloc(1, sizeof(struct scene));
  23. if (!scn)
  24. return log_msg_ret("expo", -ENOMEM);
  25. scn->name = strdup(name);
  26. if (!scn->name) {
  27. free(scn);
  28. return log_msg_ret("name", -ENOMEM);
  29. }
  30. INIT_LIST_HEAD(&scn->obj_head);
  31. scn->id = resolve_id(exp, id);
  32. scn->expo = exp;
  33. list_add_tail(&scn->sibling, &exp->scene_head);
  34. *scnp = scn;
  35. return scn->id;
  36. }
  37. void scene_obj_destroy(struct scene_obj *obj)
  38. {
  39. if (obj->type == SCENEOBJT_MENU)
  40. scene_menu_destroy((struct scene_obj_menu *)obj);
  41. free(obj->name);
  42. free(obj);
  43. }
  44. void scene_destroy(struct scene *scn)
  45. {
  46. struct scene_obj *obj, *next;
  47. list_for_each_entry_safe(obj, next, &scn->obj_head, sibling)
  48. scene_obj_destroy(obj);
  49. free(scn->name);
  50. free(scn);
  51. }
  52. int scene_title_set(struct scene *scn, uint id)
  53. {
  54. scn->title_id = id;
  55. return 0;
  56. }
  57. int scene_obj_count(struct scene *scn)
  58. {
  59. struct scene_obj *obj;
  60. int count = 0;
  61. list_for_each_entry(obj, &scn->obj_head, sibling)
  62. count++;
  63. return count;
  64. }
  65. void *scene_obj_find(struct scene *scn, uint id, enum scene_obj_t type)
  66. {
  67. struct scene_obj *obj;
  68. list_for_each_entry(obj, &scn->obj_head, sibling) {
  69. if (obj->id == id &&
  70. (type == SCENEOBJT_NONE || obj->type == type))
  71. return obj;
  72. }
  73. return NULL;
  74. }
  75. void *scene_obj_find_by_name(struct scene *scn, const char *name)
  76. {
  77. struct scene_obj *obj;
  78. list_for_each_entry(obj, &scn->obj_head, sibling) {
  79. if (!strcmp(name, obj->name))
  80. return obj;
  81. }
  82. return NULL;
  83. }
  84. int scene_obj_add(struct scene *scn, const char *name, uint id,
  85. enum scene_obj_t type, uint size, struct scene_obj **objp)
  86. {
  87. struct scene_obj *obj;
  88. obj = calloc(1, size);
  89. if (!obj)
  90. return log_msg_ret("obj", -ENOMEM);
  91. obj->name = strdup(name);
  92. if (!obj->name) {
  93. free(obj);
  94. return log_msg_ret("name", -ENOMEM);
  95. }
  96. obj->id = resolve_id(scn->expo, id);
  97. obj->scene = scn;
  98. obj->type = type;
  99. list_add_tail(&obj->sibling, &scn->obj_head);
  100. *objp = obj;
  101. return obj->id;
  102. }
  103. int scene_img(struct scene *scn, const char *name, uint id, char *data,
  104. struct scene_obj_img **imgp)
  105. {
  106. struct scene_obj_img *img;
  107. int ret;
  108. ret = scene_obj_add(scn, name, id, SCENEOBJT_IMAGE,
  109. sizeof(struct scene_obj_img),
  110. (struct scene_obj **)&img);
  111. if (ret < 0)
  112. return log_msg_ret("obj", -ENOMEM);
  113. img->data = data;
  114. if (imgp)
  115. *imgp = img;
  116. return img->obj.id;
  117. }
  118. int scene_txt(struct scene *scn, const char *name, uint id, uint str_id,
  119. struct scene_obj_txt **txtp)
  120. {
  121. struct scene_obj_txt *txt;
  122. int ret;
  123. ret = scene_obj_add(scn, name, id, SCENEOBJT_TEXT,
  124. sizeof(struct scene_obj_txt),
  125. (struct scene_obj **)&txt);
  126. if (ret < 0)
  127. return log_msg_ret("obj", -ENOMEM);
  128. txt->str_id = str_id;
  129. if (txtp)
  130. *txtp = txt;
  131. return txt->obj.id;
  132. }
  133. int scene_txt_str(struct scene *scn, const char *name, uint id, uint str_id,
  134. const char *str, struct scene_obj_txt **txtp)
  135. {
  136. struct scene_obj_txt *txt;
  137. int ret;
  138. ret = expo_str(scn->expo, name, str_id, str);
  139. if (ret < 0)
  140. return log_msg_ret("str", ret);
  141. else if (ret != str_id)
  142. return log_msg_ret("id", -EEXIST);
  143. ret = scene_obj_add(scn, name, id, SCENEOBJT_TEXT,
  144. sizeof(struct scene_obj_txt),
  145. (struct scene_obj **)&txt);
  146. if (ret < 0)
  147. return log_msg_ret("obj", -ENOMEM);
  148. txt->str_id = str_id;
  149. if (txtp)
  150. *txtp = txt;
  151. return txt->obj.id;
  152. }
  153. int scene_txt_set_font(struct scene *scn, uint id, const char *font_name,
  154. uint font_size)
  155. {
  156. struct scene_obj_txt *txt;
  157. txt = scene_obj_find(scn, id, SCENEOBJT_TEXT);
  158. if (!txt)
  159. return log_msg_ret("find", -ENOENT);
  160. txt->font_name = font_name;
  161. txt->font_size = font_size;
  162. return 0;
  163. }
  164. int scene_obj_set_pos(struct scene *scn, uint id, int x, int y)
  165. {
  166. struct scene_obj *obj;
  167. obj = scene_obj_find(scn, id, SCENEOBJT_NONE);
  168. if (!obj)
  169. return log_msg_ret("find", -ENOENT);
  170. obj->dim.x = x;
  171. obj->dim.y = y;
  172. return 0;
  173. }
  174. int scene_obj_set_size(struct scene *scn, uint id, int w, int h)
  175. {
  176. struct scene_obj *obj;
  177. obj = scene_obj_find(scn, id, SCENEOBJT_NONE);
  178. if (!obj)
  179. return log_msg_ret("find", -ENOENT);
  180. obj->dim.w = w;
  181. obj->dim.h = h;
  182. return 0;
  183. }
  184. int scene_obj_set_hide(struct scene *scn, uint id, bool hide)
  185. {
  186. int ret;
  187. ret = scene_obj_flag_clrset(scn, id, SCENEOF_HIDE,
  188. hide ? SCENEOF_HIDE : 0);
  189. if (ret)
  190. return log_msg_ret("flg", ret);
  191. return 0;
  192. }
  193. int scene_obj_flag_clrset(struct scene *scn, uint id, uint clr, uint set)
  194. {
  195. struct scene_obj *obj;
  196. obj = scene_obj_find(scn, id, SCENEOBJT_NONE);
  197. if (!obj)
  198. return log_msg_ret("find", -ENOENT);
  199. obj->flags &= ~clr;
  200. obj->flags |= set;
  201. return 0;
  202. }
  203. int scene_obj_get_hw(struct scene *scn, uint id, int *widthp)
  204. {
  205. struct scene_obj *obj;
  206. obj = scene_obj_find(scn, id, SCENEOBJT_NONE);
  207. if (!obj)
  208. return log_msg_ret("find", -ENOENT);
  209. switch (obj->type) {
  210. case SCENEOBJT_NONE:
  211. case SCENEOBJT_MENU:
  212. break;
  213. case SCENEOBJT_IMAGE: {
  214. struct scene_obj_img *img = (struct scene_obj_img *)obj;
  215. ulong width, height;
  216. uint bpix;
  217. video_bmp_get_info(img->data, &width, &height, &bpix);
  218. if (widthp)
  219. *widthp = width;
  220. return height;
  221. }
  222. case SCENEOBJT_TEXT: {
  223. struct scene_obj_txt *txt = (struct scene_obj_txt *)obj;
  224. struct expo *exp = scn->expo;
  225. struct vidconsole_bbox bbox;
  226. const char *str;
  227. int len, ret;
  228. str = expo_get_str(exp, txt->str_id);
  229. if (!str)
  230. return log_msg_ret("str", -ENOENT);
  231. len = strlen(str);
  232. /* if there is no console, make it up */
  233. if (!exp->cons) {
  234. if (widthp)
  235. *widthp = 8 * len;
  236. return 16;
  237. }
  238. ret = vidconsole_measure(scn->expo->cons, txt->font_name,
  239. txt->font_size, str, &bbox);
  240. if (ret)
  241. return log_msg_ret("mea", ret);
  242. if (widthp)
  243. *widthp = bbox.x1;
  244. return bbox.y1;
  245. }
  246. }
  247. return 0;
  248. }
  249. /**
  250. * scene_obj_render() - Render an object
  251. *
  252. */
  253. static int scene_obj_render(struct scene_obj *obj, bool text_mode)
  254. {
  255. struct scene *scn = obj->scene;
  256. struct expo *exp = scn->expo;
  257. const struct expo_theme *theme = &exp->theme;
  258. struct udevice *dev = exp->display;
  259. struct udevice *cons = text_mode ? NULL : exp->cons;
  260. int x, y, ret;
  261. x = obj->dim.x;
  262. y = obj->dim.y;
  263. switch (obj->type) {
  264. case SCENEOBJT_NONE:
  265. break;
  266. case SCENEOBJT_IMAGE: {
  267. struct scene_obj_img *img = (struct scene_obj_img *)obj;
  268. if (!cons)
  269. return -ENOTSUPP;
  270. ret = video_bmp_display(dev, map_to_sysmem(img->data), x, y,
  271. true);
  272. if (ret < 0)
  273. return log_msg_ret("img", ret);
  274. break;
  275. }
  276. case SCENEOBJT_TEXT: {
  277. struct scene_obj_txt *txt = (struct scene_obj_txt *)obj;
  278. const char *str;
  279. if (!cons)
  280. return -ENOTSUPP;
  281. if (txt->font_name || txt->font_size) {
  282. ret = vidconsole_select_font(cons,
  283. txt->font_name,
  284. txt->font_size);
  285. } else {
  286. ret = vidconsole_select_font(cons, NULL, 0);
  287. }
  288. if (ret && ret != -ENOSYS)
  289. return log_msg_ret("font", ret);
  290. str = expo_get_str(exp, txt->str_id);
  291. if (str) {
  292. struct video_priv *vid_priv;
  293. struct vidconsole_colour old;
  294. enum colour_idx fore, back;
  295. if (CONFIG_IS_ENABLED(SYS_WHITE_ON_BLACK)) {
  296. fore = VID_BLACK;
  297. back = VID_WHITE;
  298. } else {
  299. fore = VID_LIGHT_GRAY;
  300. back = VID_BLACK;
  301. }
  302. vid_priv = dev_get_uclass_priv(dev);
  303. if (obj->flags & SCENEOF_POINT) {
  304. vidconsole_push_colour(cons, fore, back, &old);
  305. video_fill_part(dev, x - theme->menu_inset, y,
  306. x + obj->dim.w,
  307. y + obj->dim.h,
  308. vid_priv->colour_bg);
  309. }
  310. vidconsole_set_cursor_pos(cons, x, y);
  311. vidconsole_put_string(cons, str);
  312. if (obj->flags & SCENEOF_POINT)
  313. vidconsole_pop_colour(cons, &old);
  314. }
  315. break;
  316. }
  317. case SCENEOBJT_MENU: {
  318. struct scene_obj_menu *menu = (struct scene_obj_menu *)obj;
  319. if (exp->popup && (obj->flags & SCENEOF_OPEN)) {
  320. if (!cons)
  321. return -ENOTSUPP;
  322. /* draw a background behind the menu items */
  323. scene_menu_render(menu);
  324. }
  325. /*
  326. * With a vidconsole, the text and item pointer are rendered as
  327. * normal objects so we don't need to do anything here. The menu
  328. * simply controls where they are positioned.
  329. */
  330. if (cons)
  331. return -ENOTSUPP;
  332. ret = scene_menu_display(menu);
  333. if (ret < 0)
  334. return log_msg_ret("img", ret);
  335. break;
  336. }
  337. }
  338. return 0;
  339. }
  340. int scene_arrange(struct scene *scn)
  341. {
  342. struct scene_obj *obj;
  343. int ret;
  344. list_for_each_entry(obj, &scn->obj_head, sibling) {
  345. if (obj->type == SCENEOBJT_MENU) {
  346. struct scene_obj_menu *menu;
  347. menu = (struct scene_obj_menu *)obj,
  348. ret = scene_menu_arrange(scn, menu);
  349. if (ret)
  350. return log_msg_ret("arr", ret);
  351. }
  352. }
  353. return 0;
  354. }
  355. int scene_render_deps(struct scene *scn, uint id)
  356. {
  357. struct scene_obj *obj;
  358. int ret;
  359. if (!id)
  360. return 0;
  361. obj = scene_obj_find(scn, id, SCENEOBJT_NONE);
  362. if (!obj)
  363. return log_msg_ret("obj", -ENOENT);
  364. if (!(obj->flags & SCENEOF_HIDE)) {
  365. ret = scene_obj_render(obj, false);
  366. if (ret && ret != -ENOTSUPP)
  367. return log_msg_ret("ren", ret);
  368. if (obj->type == SCENEOBJT_MENU)
  369. scene_menu_render_deps(scn,
  370. (struct scene_obj_menu *)obj);
  371. }
  372. return 0;
  373. }
  374. int scene_render(struct scene *scn)
  375. {
  376. struct expo *exp = scn->expo;
  377. struct scene_obj *obj;
  378. int ret;
  379. list_for_each_entry(obj, &scn->obj_head, sibling) {
  380. if (!(obj->flags & SCENEOF_HIDE)) {
  381. ret = scene_obj_render(obj, exp->text_mode);
  382. if (ret && ret != -ENOTSUPP)
  383. return log_msg_ret("ren", ret);
  384. }
  385. }
  386. /* render any highlighted object on top of the others */
  387. if (scn->highlight_id && !exp->text_mode) {
  388. ret = scene_render_deps(scn, scn->highlight_id);
  389. if (ret && ret != -ENOTSUPP)
  390. return log_msg_ret("dep", ret);
  391. }
  392. return 0;
  393. }
  394. /**
  395. * send_key_obj() - Handle a keypress for moving between objects
  396. *
  397. * @scn: Scene to receive the key
  398. * @key: Key to send (KEYCODE_UP)
  399. * @event: Returns resulting event from this keypress
  400. * Returns: 0 if OK, -ve on error
  401. */
  402. static void send_key_obj(struct scene *scn, struct scene_obj *obj, int key,
  403. struct expo_action *event)
  404. {
  405. switch (key) {
  406. case BKEY_UP:
  407. while (obj != list_first_entry(&scn->obj_head, struct scene_obj,
  408. sibling)) {
  409. obj = list_entry(obj->sibling.prev,
  410. struct scene_obj, sibling);
  411. if (obj->type == SCENEOBJT_MENU) {
  412. event->type = EXPOACT_POINT_OBJ;
  413. event->select.id = obj->id;
  414. log_debug("up to obj %d\n", event->select.id);
  415. break;
  416. }
  417. }
  418. break;
  419. case BKEY_DOWN:
  420. while (!list_is_last(&obj->sibling, &scn->obj_head)) {
  421. obj = list_entry(obj->sibling.next, struct scene_obj,
  422. sibling);
  423. if (obj->type == SCENEOBJT_MENU) {
  424. event->type = EXPOACT_POINT_OBJ;
  425. event->select.id = obj->id;
  426. log_debug("down to obj %d\n", event->select.id);
  427. break;
  428. }
  429. }
  430. break;
  431. case BKEY_SELECT:
  432. if (obj->type == SCENEOBJT_MENU) {
  433. event->type = EXPOACT_OPEN;
  434. event->select.id = obj->id;
  435. log_debug("open obj %d\n", event->select.id);
  436. }
  437. break;
  438. case BKEY_QUIT:
  439. event->type = EXPOACT_QUIT;
  440. log_debug("obj quit\n");
  441. break;
  442. }
  443. }
  444. int scene_send_key(struct scene *scn, int key, struct expo_action *event)
  445. {
  446. struct scene_obj_menu *menu;
  447. struct scene_obj *obj;
  448. int ret;
  449. event->type = EXPOACT_NONE;
  450. /*
  451. * In 'popup' mode, arrow keys move betwen objects, unless a menu is
  452. * opened
  453. */
  454. if (scn->expo->popup) {
  455. obj = NULL;
  456. if (scn->highlight_id) {
  457. obj = scene_obj_find(scn, scn->highlight_id,
  458. SCENEOBJT_NONE);
  459. }
  460. if (!obj)
  461. return 0;
  462. if (!(obj->flags & SCENEOF_OPEN)) {
  463. send_key_obj(scn, obj, key, event);
  464. return 0;
  465. }
  466. menu = (struct scene_obj_menu *)obj,
  467. ret = scene_menu_send_key(scn, menu, key, event);
  468. if (ret)
  469. return log_msg_ret("key", ret);
  470. return 0;
  471. }
  472. list_for_each_entry(obj, &scn->obj_head, sibling) {
  473. if (obj->type == SCENEOBJT_MENU) {
  474. struct scene_obj_menu *menu;
  475. menu = (struct scene_obj_menu *)obj,
  476. ret = scene_menu_send_key(scn, menu, key, event);
  477. if (ret)
  478. return log_msg_ret("key", ret);
  479. break;
  480. }
  481. }
  482. return 0;
  483. }
  484. int scene_calc_dims(struct scene *scn, bool do_menus)
  485. {
  486. struct scene_obj *obj;
  487. int ret;
  488. list_for_each_entry(obj, &scn->obj_head, sibling) {
  489. switch (obj->type) {
  490. case SCENEOBJT_NONE:
  491. case SCENEOBJT_TEXT:
  492. case SCENEOBJT_IMAGE: {
  493. int width;
  494. if (!do_menus) {
  495. ret = scene_obj_get_hw(scn, obj->id, &width);
  496. if (ret < 0)
  497. return log_msg_ret("get", ret);
  498. obj->dim.w = width;
  499. obj->dim.h = ret;
  500. }
  501. break;
  502. }
  503. case SCENEOBJT_MENU: {
  504. struct scene_obj_menu *menu;
  505. if (do_menus) {
  506. menu = (struct scene_obj_menu *)obj;
  507. ret = scene_menu_calc_dims(menu);
  508. if (ret)
  509. return log_msg_ret("men", ret);
  510. }
  511. break;
  512. }
  513. }
  514. }
  515. return 0;
  516. }
  517. int scene_apply_theme(struct scene *scn, struct expo_theme *theme)
  518. {
  519. struct scene_obj *obj;
  520. int ret;
  521. /* Avoid error-checking optional items */
  522. scene_txt_set_font(scn, scn->title_id, NULL, theme->font_size);
  523. list_for_each_entry(obj, &scn->obj_head, sibling) {
  524. switch (obj->type) {
  525. case SCENEOBJT_NONE:
  526. case SCENEOBJT_IMAGE:
  527. case SCENEOBJT_MENU:
  528. break;
  529. case SCENEOBJT_TEXT:
  530. scene_txt_set_font(scn, obj->id, NULL,
  531. theme->font_size);
  532. break;
  533. }
  534. }
  535. ret = scene_arrange(scn);
  536. if (ret)
  537. return log_msg_ret("arr", ret);
  538. return 0;
  539. }
  540. void scene_set_highlight_id(struct scene *scn, uint id)
  541. {
  542. scn->highlight_id = id;
  543. }
  544. void scene_highlight_first(struct scene *scn)
  545. {
  546. struct scene_obj *obj;
  547. list_for_each_entry(obj, &scn->obj_head, sibling) {
  548. switch (obj->type) {
  549. case SCENEOBJT_MENU:
  550. scene_set_highlight_id(scn, obj->id);
  551. return;
  552. default:
  553. break;
  554. }
  555. }
  556. }
  557. int scene_set_open(struct scene *scn, uint id, bool open)
  558. {
  559. int ret;
  560. ret = scene_obj_flag_clrset(scn, id, SCENEOF_OPEN,
  561. open ? SCENEOF_OPEN : 0);
  562. if (ret)
  563. return log_msg_ret("flg", ret);
  564. return 0;
  565. }