apps/gui/quickscreen.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2008 by Jonathan Gordon
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #include <stdio.h>
  23 #include "config.h"
  24 #include "system.h"
  25 #include "icons.h"
  26 #include "font.h"
  27 #include "kernel.h"
  28 #include "misc.h"
  29 #include "action.h"
  30 #include "settings_list.h"
  31 #include "lang.h"
  32 #include "playlist.h"
  33 #include "dsp.h"
  34 #include "viewport.h"
  35 #include "audio.h"
  36 #include "quickscreen.h"
  37 #include "talk.h"
  38 #include "list.h"
  39 #include "option_select.h"
  40 #include "debug.h"
  41
  42  /* 1 top, 1 bottom, 2 on either side, 1 for the icons
  43   * if enough space, top and bottom have 2 lines */
  44 #define MIN_LINES 5
  45 #define MAX_NEEDED_LINES 10
  46  /* pixels between the 2 center items minimum or between text and icons,
  47   * and between text and parent boundaries */
  48 #define MARGIN 10
  49 #define CENTER_ICONAREA_SIZE (MARGIN+8*2)
  50
  51 static void quickscreen_fix_viewports(struct gui_quickscreen *qs,
  52                                         struct screen *display,
  53                                         struct viewport *parent,
  54                                         struct viewport
  55                                                   vps[QUICKSCREEN_ITEM_COUNT],
  56                                         struct viewport *vp_icons)
  57 {
  58     int char_height, width, pad = 0;
  59     int left_width = 0, right_width = 0, vert_lines;
  60     unsigned char *s;
  61     int nb_lines = viewport_get_nb_lines(parent);
  62
  63     /* nb_lines only returns the number of fully visible lines, small screens
  64         or really large fonts could cause problems with the calculation below.
  65      */
  66     if (nb_lines == 0)
  67         nb_lines++;
  68
  69     char_height = parent->height/nb_lines;
  70
  71     /* center the icons VP first */
  72     *vp_icons = *parent;
  73     vp_icons->width = CENTER_ICONAREA_SIZE; /* abosulte smallest allowed */
  74     vp_icons->x = parent->x;
  75     vp_icons->x += (parent->width-CENTER_ICONAREA_SIZE)/2;
  76
  77     vps[QUICKSCREEN_BOTTOM] = *parent;
  78     vps[QUICKSCREEN_TOP] = *parent;
  79     /* depending on the space the top/buttom items use 1 or 2 lines */
  80     if (nb_lines < MIN_LINES)
  81         vert_lines = 1;
  82     else
  83         vert_lines = 2;
  84     vps[QUICKSCREEN_TOP].y = parent->y;
  85     vps[QUICKSCREEN_TOP].height = vps[QUICKSCREEN_BOTTOM].height
  86             = vert_lines*char_height;
  87     vps[QUICKSCREEN_BOTTOM].y
  88             = parent->y + parent->height - vps[QUICKSCREEN_BOTTOM].height;
  89
  90     /* enough space vertically, so put a nice margin */
  91     if (nb_lines >= MAX_NEEDED_LINES)
  92     {
  93         vps[QUICKSCREEN_TOP].y += MARGIN;
  94         vps[QUICKSCREEN_BOTTOM].y -= MARGIN;
  95     }
  96
  97     vp_icons->y = vps[QUICKSCREEN_TOP].y
  98             + vps[QUICKSCREEN_TOP].height;
  99     vp_icons->height = vps[QUICKSCREEN_BOTTOM].y - vp_icons->y;
 100
 101     /* adjust the left/right items widths to fit the screen nicely */
 102     if (qs->items[QUICKSCREEN_LEFT])
 103     {
 104         s = P2STR(ID2P(qs->items[QUICKSCREEN_LEFT]->lang_id));
 105         left_width = display->getstringsize(s, NULL, NULL);
 106     }
 107     if (qs->items[QUICKSCREEN_RIGHT])
 108     {
 109         s = P2STR(ID2P(qs->items[QUICKSCREEN_RIGHT]->lang_id));
 110         right_width = display->getstringsize(s, NULL, NULL);
 111     }
 112
 113     width = MAX(left_width, right_width);
 114     if (width*2 + vp_icons->width > parent->width)
 115     {   /* crop text viewports */
 116         width = (parent->width - vp_icons->width)/2;
 117     }
 118     else
 119     {   /* add more gap in icons vp */
 120         int excess = parent->width - vp_icons->width - width*2;
 121         if (excess > MARGIN*4)
 122         {
 123             pad = MARGIN;
 124             excess -= MARGIN*2;
 125         }
 126         vp_icons->x -= excess/2;
 127         vp_icons->width += excess;
 128     }
 129
 130     vps[QUICKSCREEN_LEFT] = *parent;
 131     vps[QUICKSCREEN_LEFT].x = parent->x + pad;
 132     vps[QUICKSCREEN_LEFT].width = width;
 133
 134     vps[QUICKSCREEN_RIGHT] = *parent;
 135     vps[QUICKSCREEN_RIGHT].x = parent->x + parent->width - width - pad;
 136     vps[QUICKSCREEN_RIGHT].width = width;
 137
 138     vps[QUICKSCREEN_LEFT].height = vps[QUICKSCREEN_RIGHT].height
 139             = 2*char_height;
 140
 141     vps[QUICKSCREEN_LEFT].y = vps[QUICKSCREEN_RIGHT].y
 142             = parent->y + (parent->height/2) - char_height;
 143
 144     /* shrink the icons vp by a few pixels if there is room so the arrows
 145        aren't drawn right next to the text */
 146     if (vp_icons->width > CENTER_ICONAREA_SIZE*2)
 147     {
 148         vp_icons->width -= CENTER_ICONAREA_SIZE*2/3;
 149         vp_icons->x += CENTER_ICONAREA_SIZE*2/6;
 150     }
 151     if (vp_icons->height > CENTER_ICONAREA_SIZE*2)
 152     {
 153         vp_icons->height -= CENTER_ICONAREA_SIZE*2/3;
 154         vp_icons->y += CENTER_ICONAREA_SIZE*2/6;
 155     }
 156
 157     /* text alignment */
 158     vps[QUICKSCREEN_LEFT].flags &= ~VP_FLAG_ALIGNMENT_MASK; /* left-aligned */
 159     vps[QUICKSCREEN_TOP].flags    |= VP_FLAG_ALIGN_CENTER;  /* centered */
 160     vps[QUICKSCREEN_BOTTOM].flags |= VP_FLAG_ALIGN_CENTER;  /* centered */
 161     vps[QUICKSCREEN_RIGHT].flags  &= ~VP_FLAG_ALIGNMENT_MASK;/* right aligned*/
 162     vps[QUICKSCREEN_RIGHT].flags  |= VP_FLAG_ALIGN_RIGHT;
 163 }
 164
 165 static void gui_quickscreen_draw(const struct gui_quickscreen *qs,
 166                                  struct screen *display,
 167                                  struct viewport *parent,
 168                                  struct viewport vps[QUICKSCREEN_ITEM_COUNT],
 169                                  struct viewport *vp_icons)
 170 {
 171     int i;
 172     char buf[MAX_PATH];
 173     unsigned const char *title, *value;
 174     void *setting;
 175     int temp;
 176     display->set_viewport(parent);
 177     display->clear_viewport();
 178
 179     for (i = 0; i < QUICKSCREEN_ITEM_COUNT; i++)
 180     {
 181         struct viewport *vp = &vps[i];
 182         if (!qs->items[i])
 183             continue;
 184         display->set_viewport(vp);
 185
 186         title = P2STR(ID2P(qs->items[i]->lang_id));
 187         setting = qs->items[i]->setting;
 188         temp = option_value_as_int(qs->items[i]);
 189         value = option_get_valuestring(qs->items[i],
 190                                        buf, MAX_PATH, temp);
 191
 192         if (viewport_get_nb_lines(vp) < 2)
 193         {
 194             char text[MAX_PATH];
 195             snprintf(text, MAX_PATH, "%s: %s", title, value);
 196             display->puts_scroll(0, 0, text);
 197         }
 198         else
 199         {
 200             display->puts_scroll(0, 0, title);
 201             display->puts_scroll(0, 1, value);
 202         }
 203     }
 204     /* draw the icons */
 205     display->set_viewport(vp_icons);
 206
 207     if (qs->items[QUICKSCREEN_TOP] != NULL)
 208     {
 209         display->mono_bitmap(bitmap_icons_7x8[Icon_UpArrow],
 210             (vp_icons->width/2) - 4, 0, 7, 8);
 211     }
 212     if (qs->items[QUICKSCREEN_RIGHT] != NULL)
 213     {
 214         display->mono_bitmap(bitmap_icons_7x8[Icon_FastForward],
 215             vp_icons->width - 8, (vp_icons->height/2) - 4, 7, 8);
 216     }
 217     if (qs->items[QUICKSCREEN_LEFT] != NULL)
 218     {
 219         display->mono_bitmap(bitmap_icons_7x8[Icon_FastBackward],
 220             0, (vp_icons->height/2) - 4, 7, 8);
 221     }
 222     if (qs->items[QUICKSCREEN_BOTTOM] != NULL)
 223     {
 224         display->mono_bitmap(bitmap_icons_7x8[Icon_DownArrow],
 225             (vp_icons->width/2) - 4, vp_icons->height - 8, 7, 8);
 226     }
 227
 228     display->set_viewport(parent);
 229     display->update_viewport();
 230     display->set_viewport(NULL);
 231 }
 232
 233 static void talk_qs_option(const struct settings_list *opt, bool enqueue)
 234 {
 235     if (!global_settings.talk_menu || !opt)
 236         return;
 237
 238     if (!enqueue)
 239         talk_shutup();
 240     talk_id(opt->lang_id, true);
 241     option_talk_value(opt, option_value_as_int(opt), true);
 242 }
 243
 244 /*
 245  * Does the actions associated to the given button if any
 246  *  - qs : the quickscreen
 247  *  - button : the key we are going to analyse
 248  * returns : true if the button corresponded to an action, false otherwise
 249  */
 250 static bool gui_quickscreen_do_button(struct gui_quickscreen * qs, int button)
 251 {
 252     int item;
 253     bool invert = false;
 254     switch(button)
 255     {
 256         case ACTION_QS_TOP:
 257             invert = true;
 258             item = QUICKSCREEN_TOP;
 259             break;
 260         case ACTION_QS_LEFT:
 261             invert = true;
 262             item = QUICKSCREEN_LEFT;
 263             break;
 264
 265         case ACTION_QS_DOWN:
 266             item = QUICKSCREEN_BOTTOM;
 267             break;
 268
 269         case ACTION_QS_RIGHT:
 270             item = QUICKSCREEN_RIGHT;
 271             break;
 272
 273         default:
 274             return false;
 275     }
 276     if (qs->items[item] == NULL)
 277         return false;
 278
 279     option_select_next_val(qs->items[item], invert, true);
 280     talk_qs_option(qs->items[item], false);
 281     return true;
 282 }
 283
 284 #ifdef HAVE_TOUCHSCREEN
 285 static int quickscreen_touchscreen_button(const struct viewport
 286                                                     vps[QUICKSCREEN_ITEM_COUNT])
 287 {
 288     short x,y;
 289     /* only hitting the text counts, everything else is exit */
 290     if (action_get_touchscreen_press(&x, &y) != BUTTON_REL)
 291         return ACTION_NONE;
 292     else if (viewport_point_within_vp(&vps[QUICKSCREEN_TOP], x, y))
 293         return ACTION_QS_TOP;
 294     else if (viewport_point_within_vp(&vps[QUICKSCREEN_BOTTOM], x, y))
 295         return ACTION_QS_DOWN;
 296     else if (viewport_point_within_vp(&vps[QUICKSCREEN_LEFT], x, y))
 297         return ACTION_QS_LEFT;
 298     else if (viewport_point_within_vp(&vps[QUICKSCREEN_RIGHT], x, y))
 299         return ACTION_QS_RIGHT;
 300     return ACTION_STD_CANCEL;
 301 }
 302 #endif
 303
 304 static bool gui_syncquickscreen_run(struct gui_quickscreen * qs, int button_enter)
 305 {
 306     int button, i, j;
 307     struct viewport parent[NB_SCREENS];
 308     struct viewport vps[NB_SCREENS][QUICKSCREEN_ITEM_COUNT];
 309     struct viewport vp_icons[NB_SCREENS];
 310     bool changed = false;
 311     /* To quit we need either :
 312      *  - a second press on the button that made us enter
 313      *  - an action taken while pressing the enter button,
 314      *    then release the enter button*/
 315     bool can_quit = false;
 316     FOR_NB_SCREENS(i)
 317     {
 318         screens[i].set_viewport(NULL);
 319         screens[i].stop_scroll();
 320         viewportmanager_theme_enable(i, true, &parent[i]);
 321         quickscreen_fix_viewports(qs, &screens[i], &parent[i], vps[i], &vp_icons[i]);
 322         gui_quickscreen_draw(qs, &screens[i], &parent[i], vps[i], &vp_icons[i]);
 323     }
 324     /* Announce current selection on entering this screen. This is all
 325        queued up, but can be interrupted as soon as a setting is
 326        changed. */
 327     cond_talk_ids(VOICE_QUICKSCREEN);
 328     talk_qs_option(qs->items[QUICKSCREEN_TOP], true);
 329     talk_qs_option(qs->items[QUICKSCREEN_LEFT], true);
 330     talk_qs_option(qs->items[QUICKSCREEN_BOTTOM], true);
 331     talk_qs_option(qs->items[QUICKSCREEN_RIGHT], true);
 332     while (true) {
 333         button = get_action(CONTEXT_QUICKSCREEN, HZ/5);
 334 #ifdef HAVE_TOUCHSCREEN
 335         if (button == ACTION_TOUCHSCREEN)
 336             button = quickscreen_touchscreen_button(vps[SCREEN_MAIN]);
 337 #endif
 338         if (default_event_handler(button) == SYS_USB_CONNECTED)
 339             return(true);
 340         if (gui_quickscreen_do_button(qs, button))
 341         {
 342             changed = true;
 343             can_quit = true;
 344             FOR_NB_SCREENS(i)
 345                 gui_quickscreen_draw(qs, &screens[i], &parent[i],
 346                                      vps[i], &vp_icons[i]);
 347             if (qs->callback)
 348                 qs->callback(qs);
 349         }
 350         else if (button == button_enter)
 351             can_quit = true;
 352
 353         if ((button == button_enter) && can_quit)
 354             break;
 355
 356         if (button == ACTION_STD_CANCEL)
 357             break;
 358     }
 359     /* Notify that we're exiting this screen */
 360     cond_talk_ids_fq(VOICE_OK);
 361     FOR_NB_SCREENS(i)
 362     {   /* stop scrolling before exiting */
 363         for (j = 0; j < QUICKSCREEN_ITEM_COUNT; j++)
 364             screens[i].scroll_stop(&vps[i][j]);
 365         viewportmanager_theme_undo(i, true);
 366     }
 367
 368     return changed;
 369 }
 370
 371 static const struct settings_list *get_setting(int gs_value,
 372                                         const struct settings_list *defaultval)
 373 {
 374     if (gs_value != -1 && gs_value < nb_settings &&
 375         is_setting_quickscreenable(&settings[gs_value]))
 376         return &settings[gs_value];
 377     return defaultval;
 378 }
 379
 380 bool quick_screen_quick(int button_enter)
 381 {
 382     struct gui_quickscreen qs;
 383     bool oldshuffle = global_settings.playlist_shuffle;
 384     int oldrepeat = global_settings.repeat_mode;
 385
 386     qs.items[QUICKSCREEN_TOP] =
 387             get_setting(global_settings.qs_items[QUICKSCREEN_TOP],
 388                         find_setting(&global_settings.party_mode, NULL));
 389     qs.items[QUICKSCREEN_LEFT] =
 390             get_setting(global_settings.qs_items[QUICKSCREEN_LEFT],
 391                         find_setting(&global_settings.playlist_shuffle, NULL));
 392     qs.items[QUICKSCREEN_RIGHT] =
 393             get_setting(global_settings.qs_items[QUICKSCREEN_RIGHT],
 394                         find_setting(&global_settings.repeat_mode, NULL));
 395     qs.items[QUICKSCREEN_BOTTOM] =
 396             get_setting(global_settings.qs_items[QUICKSCREEN_BOTTOM],
 397                         find_setting(&global_settings.dirfilter, NULL));
 398
 399     qs.callback = NULL;
 400     if (gui_syncquickscreen_run(&qs, button_enter))
 401     {
 402         settings_save();
 403         settings_apply(false);
 404         /* make sure repeat/shuffle/any other nasty ones get updated */
 405         if ( oldrepeat != global_settings.repeat_mode &&
 406              (audio_status() & AUDIO_STATUS_PLAY) )
 407         {
 408             audio_flush_and_reload_tracks();
 409         }
 410         if (oldshuffle != global_settings.playlist_shuffle
 411             && audio_status() & AUDIO_STATUS_PLAY)
 412         {
 413 #if CONFIG_CODEC == SWCODEC
 414             dsp_set_replaygain();
 415 #endif
 416             if (global_settings.playlist_shuffle)
 417                 playlist_randomise(NULL, current_tick, true);
 418             else
 419                 playlist_sort(NULL, true);
 420         }
 421     }
 422     return(0);
 423 }
 424
 425 #ifdef BUTTON_F3
 426 bool quick_screen_f3(int button_enter)
 427 {
 428     struct gui_quickscreen qs;
 429     qs.items[QUICKSCREEN_TOP] = NULL;
 430     qs.items[QUICKSCREEN_LEFT] =
 431                     find_setting(&global_settings.scrollbar, NULL);
 432     qs.items[QUICKSCREEN_RIGHT] =
 433                     find_setting(&global_settings.statusbar, NULL);
 434     qs.items[QUICKSCREEN_BOTTOM] =
 435                     find_setting(&global_settings.flip_display, NULL);
 436     qs.callback = NULL;
 437     if (gui_syncquickscreen_run(&qs, button_enter))
 438     {
 439         settings_save();
 440         settings_apply(false);
 441     }
 442     return(0);
 443 }
 444 #endif /* BUTTON_F3 */
 445
 446 /* stuff to make the quickscreen configurable */
 447 bool is_setting_quickscreenable(const struct settings_list *setting)
 448 {
 449     /* to keep things simple, only settings which have a lang_id set are ok */
 450     if (setting->lang_id < 0 || (setting->flags&F_BANFROMQS))
 451         return false;
 452     switch (setting->flags&F_T_MASK)
 453     {
 454         case F_T_BOOL:
 455             return true;
 456         case F_T_INT:
 457         case F_T_UINT:
 458             return (setting->RESERVED != NULL);
 459         default:
 460             return false;
 461     }
 462 }
 463
 464 void set_as_qs_item(const struct settings_list *setting,
 465                     enum quickscreen_item item)
 466 {
 467     int i;
 468     for (i = 0; i < nb_settings; i++)
 469     {
 470         if (&settings[i] == setting)
 471             break;
 472     }
 473
 474     global_settings.qs_items[item] = i;
 475 }