apps/misc.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Daniel Stenberg
  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 #include <stdlib.h>
  22 #include <ctype.h>
  23 #include <stdio.h>
  24 #include <stdarg.h>
  25 #include <errno.h>
  26 #include "string-extra.h"
  27 #include "config.h"
  28 #include "misc.h"
  29 #include "system.h"
  30 #include "lcd.h"
  31 #include "file.h"
  32 #include "filefuncs.h"
  33 #ifndef __PCTOOL__
  34 #include "lang.h"
  35 #include "dir.h"
  36 #include "lcd-remote.h"
  37 #include "timefuncs.h"
  38 #include "screens.h"
  39 #include "usb_screen.h"
  40 #include "talk.h"
  41 #include "audio.h"
  42 #include "mp3_playback.h"
  43 #include "settings.h"
  44 #include "storage.h"
  45 #include "ata_idle_notify.h"
  46 #include "kernel.h"
  47 #include "power.h"
  48 #include "powermgmt.h"
  49 #include "backlight.h"
  50 #include "version.h"
  51 #include "font.h"
  52 #include "splash.h"
  53 #include "tagcache.h"
  54 #include "scrobbler.h"
  55 #include "sound.h"
  56 #include "playlist.h"
  57 #include "yesno.h"
  58 #include "viewport.h"
  59 #include "list.h"
  60
  61 #include "debug.h"
  62
  63 #if CONFIG_TUNER
  64 #include "radio.h"
  65 #endif
  66
  67 #ifdef IPOD_ACCESSORY_PROTOCOL
  68 #include "iap.h"
  69 #endif
  70
  71 #if (CONFIG_STORAGE & STORAGE_MMC)
  72 #include "ata_mmc.h"
  73 #endif
  74 #include "tree.h"
  75 #include "eeprom_settings.h"
  76 #if defined(HAVE_RECORDING) && !defined(__PCTOOL__)
  77 #include "recording.h"
  78 #endif
  79 #if defined(HAVE_LCD_BITMAP) && !defined(__PCTOOL__)
  80 #include "bmp.h"
  81 #include "icons.h"
  82 #endif /* End HAVE_LCD_BITMAP */
  83 #include "bookmark.h"
  84 #include "wps.h"
  85 #include "playback.h"
  86 #if CONFIG_CODEC == SWCODEC
  87 #include "voice_thread.h"
  88 #endif
  89
  90 #ifdef BOOTFILE
  91 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF) \
  92         || defined(HAVE_HOTSWAP_STORAGE_AS_MAIN)
  93 #include "rolo.h"
  94 #endif
  95 #endif
  96
  97 #ifdef HAVE_HARDWARE_CLICK
  98 #include "piezo.h"
  99 #endif
 100
 101 /* units used with output_dyn_value */
 102 const unsigned char * const byte_units[] =
 103 {
 104     ID2P(LANG_BYTE),
 105     ID2P(LANG_KILOBYTE),
 106     ID2P(LANG_MEGABYTE),
 107     ID2P(LANG_GIGABYTE)
 108 };
 109
 110 const unsigned char * const * const kbyte_units = &byte_units[1];
 111
 112 /* Format a large-range value for output, using the appropriate unit so that
 113  * the displayed value is in the range 1 <= display < 1000 (1024 for "binary"
 114  * units) if possible, and 3 significant digits are shown. If a buffer is
 115  * given, the result is snprintf()'d into that buffer, otherwise the result is
 116  * voiced.*/
 117 char *output_dyn_value(char *buf, int buf_size, int value,
 118                        const unsigned char * const *units, bool bin_scale)
 119 {
 120     int scale = bin_scale ? 1024 : 1000;
 121     int fraction = 0;
 122     int unit_no = 0;
 123     char tbuf[5];
 124
 125     while (value >= scale)
 126     {
 127         fraction = value % scale;
 128         value /= scale;
 129         unit_no++;
 130     }
 131     if (bin_scale)
 132         fraction = fraction * 1000 / 1024;
 133
 134     if (value >= 100 || !unit_no)
 135         tbuf[0] = '\0';
 136     else if (value >= 10)
 137         snprintf(tbuf, sizeof(tbuf), "%01d", fraction / 100);
 138     else
 139         snprintf(tbuf, sizeof(tbuf), "%02d", fraction / 10);
 140
 141     if (buf)
 142     {
 143         if (*tbuf)
 144             snprintf(buf, buf_size, "%d%s%s%s", value, str(LANG_POINT),
 145                      tbuf, P2STR(units[unit_no]));
 146         else
 147             snprintf(buf, buf_size, "%d%s", value, P2STR(units[unit_no]));
 148     }
 149     else
 150     {
 151         talk_fractional(tbuf, value, P2ID(units[unit_no]));
 152     }
 153     return buf;
 154 }
 155
 156 /* Ask the user if they really want to erase the current dynamic playlist
 157  * returns true if the playlist should be replaced */
 158 bool warn_on_pl_erase(void)
 159 {
 160     if (global_settings.warnon_erase_dynplaylist &&
 161         !global_settings.party_mode &&
 162         playlist_modified(NULL))
 163     {
 164         static const char *lines[] =
 165             {ID2P(LANG_WARN_ERASEDYNPLAYLIST_PROMPT)};
 166         static const struct text_message message={lines, 1};
 167
 168         return (gui_syncyesno_run(&message, NULL, NULL) == YESNO_YES);
 169     }
 170     else
 171         return true;
 172 }
 173
 174
 175 /* Performance optimized version of the read_line() (see below) function. */
 176 int fast_readline(int fd, char *buf, int buf_size, void *parameters,
 177                   int (*callback)(int n, char *buf, void *parameters))
 178 {
 179     char *p, *next;
 180     int rc, pos = 0;
 181     int count = 0;
 182
 183     while ( 1 )
 184     {
 185         next = NULL;
 186
 187         rc = read(fd, &buf[pos], buf_size - pos - 1);
 188         if (rc >= 0)
 189             buf[pos+rc] = '\0';
 190
 191         if ( (p = strchr(buf, '\n')) != NULL)
 192         {
 193             *p = '\0';
 194             next = ++p;
 195         }
 196
 197         rc = callback(count, buf, parameters);
 198         if (rc < 0)
 199             return rc;
 200
 201         count++;
 202         if (next)
 203         {
 204             pos = buf_size - ((long)next - (long)buf) - 1;
 205             memmove(buf, next, pos);
 206         }
 207         else
 208             break ;
 209     }
 210
 211     return 0;
 212 }
 213
 214 /* parse a line from a configuration file. the line format is:
 215
 216    name: value
 217
 218    Any whitespace before setting name or value (after ':') is ignored.
 219    A # as first non-whitespace character discards the whole line.
 220    Function sets pointers to null-terminated setting name and value.
 221    Returns false if no valid config entry was found.
 222 */
 223
 224 bool settings_parseline(char* line, char** name, char** value)
 225 {
 226     char* ptr;
 227
 228     line = skip_whitespace(line);
 229
 230     if ( *line == '#' )
 231         return false;
 232
 233     ptr = strchr(line, ':');
 234     if ( !ptr )
 235         return false;
 236
 237     *name = line;
 238     *ptr = 0;
 239     ptr++;
 240     ptr = skip_whitespace(ptr);
 241     *value = ptr;
 242     return true;
 243 }
 244
 245 static void system_flush(void)
 246 {
 247     playlist_shutdown();
 248     tree_flush();
 249     call_storage_idle_notifys(true); /*doesnt work on usb and shutdown from ata thread */
 250 }
 251
 252 static void system_restore(void)
 253 {
 254     tree_restore();
 255 }
 256
 257 static bool clean_shutdown(void (*callback)(void *), void *parameter)
 258 {
 259     long msg_id = -1;
 260
 261     scrobbler_poweroff();
 262
 263 #if CONFIG_CHARGING && !defined(HAVE_POWEROFF_WHILE_CHARGING)
 264     if(!charger_inserted())
 265 #endif
 266     {
 267         bool batt_safe = battery_level_safe();
 268 #if CONFIG_CODEC != SWCODEC || defined(HAVE_RECORDING)
 269         int audio_stat = audio_status();
 270 #endif
 271
 272         FOR_NB_SCREENS(i)
 273         {
 274             screens[i].clear_display();
 275             screens[i].update();
 276         }
 277
 278         if (batt_safe)
 279         {
 280             int level;
 281 #ifdef HAVE_TAGCACHE
 282             if (!tagcache_prepare_shutdown())
 283             {
 284                 cancel_shutdown();
 285                 splash(HZ, ID2P(LANG_TAGCACHE_BUSY));
 286                 return false;
 287             }
 288 #endif
 289             level = battery_level();
 290             if (level > 10 || level < 0)
 291                 splash(0, str(LANG_SHUTTINGDOWN));
 292             else
 293             {
 294                 msg_id = LANG_WARNING_BATTERY_LOW;
 295                 splashf(0, "%s %s", str(LANG_WARNING_BATTERY_LOW),
 296                                     str(LANG_SHUTTINGDOWN));
 297             }
 298         }
 299         else
 300         {
 301             msg_id = LANG_WARNING_BATTERY_EMPTY;
 302             splashf(0, "%s %s", str(LANG_WARNING_BATTERY_EMPTY),
 303                                 str(LANG_SHUTTINGDOWN));
 304         }
 305 #if CONFIG_CODEC != SWCODEC
 306         if (global_settings.fade_on_stop
 307             && (audio_stat & AUDIO_STATUS_PLAY))
 308         {
 309             fade(false, false);
 310         }
 311 #endif
 312
 313         if (batt_safe) /* do not save on critical battery */
 314         {
 315 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
 316             if (audio_stat & AUDIO_STATUS_RECORD)
 317             {
 318                 rec_command(RECORDING_CMD_STOP);
 319                 /* wait for stop to complete */
 320                 while (audio_status() & AUDIO_STATUS_RECORD)
 321                     sleep(1);
 322             }
 323 #endif
 324             bookmark_autobookmark(false);
 325
 326             /* audio_stop_recording == audio_stop for HWCODEC */
 327             audio_stop();
 328
 329             if (callback != NULL)
 330                 callback(parameter);
 331
 332 #if CONFIG_CODEC != SWCODEC
 333             /* wait for audio_stop or audio_stop_recording to complete */
 334             while (audio_status())
 335                 sleep(1);
 336 #endif
 337
 338 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
 339             audio_close_recording();
 340 #endif
 341
 342             if(global_settings.talk_menu)
 343             {
 344                 bool enqueue = false;
 345                 if(msg_id != -1)
 346                 {
 347                     talk_id(msg_id, enqueue);
 348                     enqueue = true;
 349                 }
 350                 talk_id(LANG_SHUTTINGDOWN, enqueue);
 351 #if CONFIG_CODEC == SWCODEC
 352                 voice_wait();
 353 #endif
 354             }
 355
 356             system_flush();
 357 #ifdef HAVE_EEPROM_SETTINGS
 358             if (firmware_settings.initialized)
 359             {
 360                 firmware_settings.disk_clean = true;
 361                 firmware_settings.bl_version = 0;
 362                 eeprom_settings_store();
 363             }
 364 #endif
 365         }
 366 #ifdef HAVE_DIRCACHE
 367         else
 368             dircache_disable();
 369 #endif
 370
 371         shutdown_hw();
 372     }
 373     return false;
 374 }
 375
 376 bool list_stop_handler(void)
 377 {
 378     bool ret = false;
 379
 380 #if CONFIG_TUNER
 381     radio_stop();
 382 #endif
 383
 384     /* Stop the music if it is playing */
 385     if(audio_status())
 386     {
 387         if (!global_settings.party_mode)
 388         {
 389 #if CONFIG_CODEC != SWCODEC
 390             if (global_settings.fade_on_stop)
 391                 fade(false, false);
 392 #endif
 393             bookmark_autobookmark(true);
 394             audio_stop();
 395             ret = true;  /* bookmarking can make a refresh necessary */
 396         }
 397     }
 398 #if CONFIG_CHARGING
 399 #if (CONFIG_KEYPAD == RECORDER_PAD) && !defined(HAVE_SW_POWEROFF)
 400     else
 401     {
 402         if (charger_inserted())
 403             charging_splash();
 404         else
 405             shutdown_screen(); /* won't return if shutdown actually happens */
 406
 407         ret = true;  /* screen is dirty, caller needs to refresh */
 408     }
 409 #endif
 410 #ifndef HAVE_POWEROFF_WHILE_CHARGING
 411     {
 412         static long last_off = 0;
 413
 414         if (TIME_BEFORE(current_tick, last_off + HZ/2))
 415         {
 416             if (charger_inserted())
 417             {
 418                 charging_splash();
 419                 ret = true;  /* screen is dirty, caller needs to refresh */
 420             }
 421         }
 422         last_off = current_tick;
 423     }
 424 #endif
 425 #endif /* CONFIG_CHARGING */
 426     return ret;
 427 }
 428
 429 #if CONFIG_CHARGING
 430 static bool waiting_to_resume_play = false;
 431 static long play_resume_tick;
 432
 433 static void car_adapter_mode_processing(bool inserted)
 434 {
 435     if (global_settings.car_adapter_mode)
 436     {
 437         if(inserted)
 438         {
 439             /*
 440              * Just got plugged in, delay & resume if we were playing
 441              */
 442             if (audio_status() & AUDIO_STATUS_PAUSE)
 443             {
 444                 /* delay resume a bit while the engine is cranking */
 445                 play_resume_tick = current_tick + HZ*5;
 446                 waiting_to_resume_play = true;
 447             }
 448         }
 449         else
 450         {
 451             /*
 452              * Just got unplugged, pause if playing
 453              */
 454             if ((audio_status() & AUDIO_STATUS_PLAY) &&
 455                 !(audio_status() & AUDIO_STATUS_PAUSE))
 456             {
 457                 pause_action(true, true);
 458             }
 459             waiting_to_resume_play = false;
 460         }
 461     }
 462 }
 463
 464 static void car_adapter_tick(void)
 465 {
 466     if (waiting_to_resume_play)
 467     {
 468         if (TIME_AFTER(current_tick, play_resume_tick))
 469         {
 470             if (audio_status() & AUDIO_STATUS_PAUSE)
 471             {
 472                 queue_broadcast(SYS_CAR_ADAPTER_RESUME, 0);
 473             }
 474             waiting_to_resume_play = false;
 475         }
 476     }
 477 }
 478
 479 void car_adapter_mode_init(void)
 480 {
 481     tick_add_task(car_adapter_tick);
 482 }
 483 #endif
 484
 485 #ifdef HAVE_HEADPHONE_DETECTION
 486 static void unplug_change(bool inserted)
 487 {
 488     static bool headphone_caused_pause = false;
 489
 490     if (global_settings.unplug_mode)
 491     {
 492         int audio_stat = audio_status();
 493         if (inserted)
 494         {
 495             backlight_on();
 496             if ((audio_stat & AUDIO_STATUS_PLAY) &&
 497                     headphone_caused_pause &&
 498                     global_settings.unplug_mode > 1 )
 499                 unpause_action(true, true);
 500             headphone_caused_pause = false;
 501         } else {
 502             if ((audio_stat & AUDIO_STATUS_PLAY) &&
 503                     !(audio_stat & AUDIO_STATUS_PAUSE))
 504             {
 505                 headphone_caused_pause = true;
 506                 pause_action(false, false);
 507             }
 508         }
 509     }
 510 }
 511 #endif
 512
 513 long default_event_handler_ex(long event, void (*callback)(void *), void *parameter)
 514 {
 515 #if CONFIG_PLATFORM & (PLATFORM_ANDROID|PLATFORM_MAEMO)
 516     static bool resume = false;
 517 #endif
 518
 519     switch(event)
 520     {
 521         case SYS_BATTERY_UPDATE:
 522             if(global_settings.talk_battery_level)
 523             {
 524                 talk_ids(true, VOICE_PAUSE, VOICE_PAUSE,
 525                          LANG_BATTERY_TIME,
 526                          TALK_ID(battery_level(), UNIT_PERCENT),
 527                          VOICE_PAUSE);
 528                 talk_force_enqueue_next();
 529             }
 530             break;
 531         case SYS_USB_CONNECTED:
 532             if (callback != NULL)
 533                 callback(parameter);
 534 #if (CONFIG_STORAGE & STORAGE_MMC) && (defined(ARCHOS_ONDIOSP) || defined(ARCHOS_ONDIOFM))
 535             if (!mmc_touched() ||
 536                 (mmc_remove_request() == SYS_HOTSWAP_EXTRACTED))
 537 #endif
 538             {
 539                 system_flush();
 540 #ifdef BOOTFILE
 541 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF)
 542                 check_bootfile(false); /* gets initial size */
 543 #endif
 544 #endif
 545                 gui_usb_screen_run(false);
 546 #ifdef BOOTFILE
 547 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF)
 548                 check_bootfile(true);
 549 #endif
 550 #endif
 551                 system_restore();
 552             }
 553             return SYS_USB_CONNECTED;
 554
 555         case SYS_POWEROFF:
 556             if (!clean_shutdown(callback, parameter))
 557                 return SYS_POWEROFF;
 558             break;
 559 #if CONFIG_CHARGING
 560         case SYS_CHARGER_CONNECTED:
 561             car_adapter_mode_processing(true);
 562             return SYS_CHARGER_CONNECTED;
 563
 564         case SYS_CHARGER_DISCONNECTED:
 565             car_adapter_mode_processing(false);
 566             /*reset rockbox battery runtime*/
 567             global_status.runtime = 0;
 568             return SYS_CHARGER_DISCONNECTED;
 569
 570         case SYS_CAR_ADAPTER_RESUME:
 571             unpause_action(true, true);
 572             return SYS_CAR_ADAPTER_RESUME;
 573 #endif
 574 #ifdef HAVE_HOTSWAP_STORAGE_AS_MAIN
 575         case SYS_FS_CHANGED:
 576         {
 577             /* simple sanity: assume rockbox is on the first hotswappable
 578              * driver, abort out if that one isn't inserted */
 579             int i;
 580             for (i = 0; i < NUM_DRIVES; i++)
 581             {
 582                 if (storage_removable(i) && !storage_present(i))
 583                     return SYS_FS_CHANGED;
 584             }
 585             system_flush();
 586             check_bootfile(true); /* state gotten in main.c:init() */
 587             system_restore();
 588         }
 589             return SYS_FS_CHANGED;
 590 #endif
 591 #ifdef HAVE_HEADPHONE_DETECTION
 592         case SYS_PHONE_PLUGGED:
 593             unplug_change(true);
 594             return SYS_PHONE_PLUGGED;
 595
 596         case SYS_PHONE_UNPLUGGED:
 597             unplug_change(false);
 598             return SYS_PHONE_UNPLUGGED;
 599 #endif
 600 #ifdef IPOD_ACCESSORY_PROTOCOL
 601         case SYS_IAP_PERIODIC:
 602             iap_periodic();
 603             return SYS_IAP_PERIODIC;
 604         case SYS_IAP_HANDLEPKT:
 605             iap_handlepkt();
 606             return SYS_IAP_HANDLEPKT;
 607 #endif
 608 #if CONFIG_PLATFORM & (PLATFORM_ANDROID|PLATFORM_MAEMO)
 609         /* stop playback if we receive a call */
 610         case SYS_CALL_INCOMING:
 611             resume = audio_status() == AUDIO_STATUS_PLAY;
 612             list_stop_handler();
 613             return SYS_CALL_INCOMING;
 614         /* resume playback if needed */
 615         case SYS_CALL_HUNG_UP:
 616             if (resume && playlist_resume() != -1)
 617             {
 618                 playlist_start(global_status.resume_index,
 619                                global_status.resume_offset);
 620             }
 621             resume = false;
 622             return SYS_CALL_HUNG_UP;
 623 #endif
 624 #if (CONFIG_PLATFORM & PLATFORM_HOSTED) && defined(PLATFORM_HAS_VOLUME_CHANGE)
 625         case SYS_VOLUME_CHANGED:
 626         {
 627             static bool firstvolume = true;
 628             /* kludge: since this events go to the button_queue,
 629              * event data is available in the last button data */
 630             int volume = button_get_data();
 631             DEBUGF("SYS_VOLUME_CHANGED: %d\n", volume);
 632             if (global_settings.volume != volume) {
 633                 global_settings.volume = volume;
 634                 if (firstvolume) {
 635                     setvol();
 636                     firstvolume = false;
 637                 }
 638             }
 639             return 0;
 640         }
 641 #endif
 642 #ifdef HAVE_MULTIMEDIA_KEYS
 643         /* multimedia keys on keyboards, headsets */
 644         case BUTTON_MULTIMEDIA_PLAYPAUSE:
 645         {
 646             int status = audio_status();
 647             if (status & AUDIO_STATUS_PLAY)
 648             {
 649                 if (status & AUDIO_STATUS_PAUSE)
 650                     unpause_action(true, true);
 651                 else
 652                     pause_action(true, true);
 653             }
 654             else
 655                 if (playlist_resume() != -1)
 656                 {
 657                     playlist_start(global_status.resume_index,
 658                                    global_status.resume_offset);
 659                 }
 660             return event;
 661         }
 662         case BUTTON_MULTIMEDIA_NEXT:
 663             audio_next();
 664             return event;
 665         case BUTTON_MULTIMEDIA_PREV:
 666             audio_prev();
 667             return event;
 668         case BUTTON_MULTIMEDIA_STOP:
 669             list_stop_handler();
 670             return event;
 671         case BUTTON_MULTIMEDIA_REW:
 672         case BUTTON_MULTIMEDIA_FFWD:
 673             /* not supported yet, needs to be done in the WPS */
 674             return 0;
 675 #endif
 676     }
 677     return 0;
 678 }
 679
 680 long default_event_handler(long event)
 681 {
 682     return default_event_handler_ex(event, NULL, NULL);
 683 }
 684
 685 int show_logo( void )
 686 {
 687 #ifdef HAVE_LCD_BITMAP
 688     char version[32];
 689     int font_h, font_w;
 690
 691     snprintf(version, sizeof(version), "Ver. %s", rbversion);
 692
 693     lcd_clear_display();
 694 #if defined(SANSA_CLIP) || defined(SANSA_CLIPV2) || defined(SANSA_CLIPPLUS)
 695     /* display the logo in the blue area of the screen */
 696     lcd_setfont(FONT_SYSFIXED);
 697     lcd_getstringsize((unsigned char *)"A", &font_w, &font_h);
 698     lcd_putsxy((LCD_WIDTH/2) - ((strlen(version)*font_w)/2),
 699                0, (unsigned char *)version);
 700     lcd_bmp(&bm_rockboxlogo, (LCD_WIDTH - BMPWIDTH_rockboxlogo) / 2, 16);
 701 #else
 702     lcd_bmp(&bm_rockboxlogo, (LCD_WIDTH - BMPWIDTH_rockboxlogo) / 2, 10);
 703     lcd_setfont(FONT_SYSFIXED);
 704     lcd_getstringsize((unsigned char *)"A", &font_w, &font_h);
 705     lcd_putsxy((LCD_WIDTH/2) - ((strlen(version)*font_w)/2),
 706                LCD_HEIGHT-font_h, (unsigned char *)version);
 707 #endif
 708     lcd_setfont(FONT_UI);
 709
 710 #else
 711     char *rockbox = "  ROCKbox!";
 712
 713     lcd_clear_display();
 714     lcd_double_height(true);
 715     lcd_puts(0, 0, rockbox);
 716     lcd_puts_scroll(0, 1, rbversion);
 717 #endif
 718     lcd_update();
 719
 720 #ifdef HAVE_REMOTE_LCD
 721     lcd_remote_clear_display();
 722     lcd_remote_bmp(&bm_remote_rockboxlogo, 0, 10);
 723     lcd_remote_setfont(FONT_SYSFIXED);
 724     lcd_remote_getstringsize((unsigned char *)"A", &font_w, &font_h);
 725     lcd_remote_putsxy((LCD_REMOTE_WIDTH/2) - ((strlen(version)*font_w)/2),
 726                        LCD_REMOTE_HEIGHT-font_h, (unsigned char *)version);
 727     lcd_remote_setfont(FONT_UI);
 728     lcd_remote_update();
 729 #endif
 730
 731     return 0;
 732 }
 733
 734 #ifdef BOOTFILE
 735 #if !defined(USB_NONE) && !defined(USB_HANDLED_BY_OF) || defined(HAVE_HOTSWAP_STORAGE_AS_MAIN)
 736 /*
 737     memorize/compare details about the BOOTFILE
 738     we don't use dircache because it may not be up to date after
 739     USB disconnect (scanning in the background)
 740 */
 741 void check_bootfile(bool do_rolo)
 742 {
 743     static unsigned short wrtdate = 0;
 744     static unsigned short wrttime = 0;
 745     DIR* dir = NULL;
 746     struct dirent* entry = NULL;
 747
 748     /* 1. open BOOTDIR and find the BOOTFILE dir entry */
 749     dir = opendir(BOOTDIR);
 750
 751     if(!dir) return; /* do we want an error splash? */
 752
 753     /* loop all files in BOOTDIR */
 754     while(0 != (entry = readdir(dir)))
 755     {
 756         if(!strcasecmp(entry->d_name, BOOTFILE))
 757         {
 758             struct dirinfo info = dir_get_info(dir, entry);
 759             /* found the bootfile */
 760             if(wrtdate && do_rolo)
 761             {
 762                 if((info.wrtdate != wrtdate) ||
 763                    (info.wrttime != wrttime))
 764                 {
 765                     static const char *lines[] = { ID2P(LANG_BOOT_CHANGED),
 766                                                    ID2P(LANG_REBOOT_NOW) };
 767                     static const struct text_message message={ lines, 2 };
 768                     button_clear_queue(); /* Empty the keyboard buffer */
 769                     if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_YES)
 770                     {
 771                         audio_hard_stop();
 772                         rolo_load(BOOTDIR "/" BOOTFILE);
 773                     }
 774                 }
 775             }
 776             wrtdate = info.wrtdate;
 777             wrttime = info.wrttime;
 778         }
 779     }
 780     closedir(dir);
 781 }
 782 #endif
 783 #endif
 784
 785 /* check range, set volume and save settings */
 786 void setvol(void)
 787 {
 788     const int min_vol = sound_min(SOUND_VOLUME);
 789     const int max_vol = sound_max(SOUND_VOLUME);
 790     if (global_settings.volume < min_vol)
 791         global_settings.volume = min_vol;
 792     if (global_settings.volume > max_vol)
 793         global_settings.volume = max_vol;
 794     sound_set_volume(global_settings.volume);
 795     global_status.last_volume_change = current_tick;
 796     settings_save();
 797 }
 798
 799 char* strrsplt(char* str, int c)
 800 {
 801     char* s = strrchr(str, c);
 802
 803     if (s != NULL)
 804     {
 805         *s++ = '\0';
 806     }
 807     else
 808     {
 809         s = str;
 810     }
 811
 812     return s;
 813 }
 814
 815 /*
 816  * removes the extension of filename (if it doesn't start with a .)
 817  * puts the result in buffer
 818  */
 819 char *strip_extension(char* buffer, int buffer_size, const char *filename)
 820 {
 821     char *dot = strrchr(filename, '.');
 822     int len;
 823
 824     if (buffer_size <= 0)
 825     {
 826         return NULL;
 827     }
 828
 829     buffer_size--;  /* Make room for end nil */
 830
 831     if (dot != 0 && filename[0] != '.')
 832     {
 833         len = dot - filename;
 834         len = MIN(len, buffer_size);
 835     }
 836     else
 837     {
 838         len = buffer_size;
 839     }
 840
 841     strlcpy(buffer, filename, len + 1);
 842
 843     return buffer;
 844 }
 845
 846 #if CONFIG_CODEC == SWCODEC
 847 /* Play a standard sound */
 848 void system_sound_play(enum system_sound sound)
 849 {
 850     static const struct beep_params
 851     {
 852         int *setting;
 853         unsigned short frequency;
 854         unsigned short duration;
 855         unsigned short amplitude;
 856     } beep_params[] =
 857     {
 858         [SOUND_KEYCLICK] =
 859         { &global_settings.keyclick,
 860           4000, KEYCLICK_DURATION, 2500 },
 861         [SOUND_TRACK_SKIP] =
 862         { &global_settings.beep,
 863           2000, 100, 2500 },
 864         [SOUND_TRACK_NO_MORE] =
 865         { &global_settings.beep,
 866           1000, 100, 1500 },
 867     };
 868
 869     const struct beep_params *params = &beep_params[sound];
 870
 871     if (*params->setting)
 872     {
 873         beep_play(params->frequency, params->duration,
 874                   params->amplitude * *params->setting);
 875     }
 876 }
 877
 878 /* Produce keyclick based upon button and global settings */
 879 void keyclick_click(int button)
 880 {
 881     static long last_button = BUTTON_NONE;
 882     bool do_beep = false;
 883     /* Settings filters */
 884     if (
 885 #ifdef HAVE_HARDWARE_CLICK
 886         (global_settings.keyclick || global_settings.keyclick_hardware)
 887 #else
 888         global_settings.keyclick
 889 #endif
 890         )
 891     {
 892         if (global_settings.keyclick_repeats || !(button & BUTTON_REPEAT))
 893         {
 894             /* Button filters */
 895             if (button != BUTTON_NONE && !(button & BUTTON_REL)
 896                 && !(button & (SYS_EVENT|BUTTON_MULTIMEDIA)) )
 897             {
 898                 do_beep = true;
 899             }
 900         }
 901         else if ((button & BUTTON_REPEAT) && (last_button == BUTTON_NONE))
 902         {
 903             do_beep = true;
 904         }
 905 #ifdef HAVE_SCROLLWHEEL
 906         else if (button & (BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD))
 907         {
 908             do_beep  = true;
 909         }
 910 #endif
 911     }
 912     if (button&BUTTON_REPEAT)
 913         last_button = button;
 914     else
 915         last_button = BUTTON_NONE;
 916     if (do_beep)
 917     {
 918 #ifdef HAVE_HARDWARE_CLICK
 919         if (global_settings.keyclick)
 920         {
 921             system_sound_play(SOUND_KEYCLICK);
 922         }
 923         if (global_settings.keyclick_hardware)
 924         {
 925 #if !defined(SIMULATOR)
 926             piezo_button_beep(false, false);
 927 #endif
 928         }
 929 #else
 930         system_sound_play(SOUND_KEYCLICK);
 931 #endif
 932     }
 933 }
 934 #endif /* CONFIG_CODEC == SWCODEC */
 935
 936 #endif /* !defined(__PCTOOL__) */
 937
 938 /* Read (up to) a line of text from fd into buffer and return number of bytes
 939  * read (which may be larger than the number of bytes stored in buffer). If
 940  * an error occurs, -1 is returned (and buffer contains whatever could be
 941  * read). A line is terminated by a LF char. Neither LF nor CR chars are
 942  * stored in buffer.
 943  */
 944 int read_line(int fd, char* buffer, int buffer_size)
 945 {
 946     int count = 0;
 947     int num_read = 0;
 948
 949     errno = 0;
 950
 951     while (count < buffer_size)
 952     {
 953         unsigned char c;
 954
 955         if (1 != read(fd, &c, 1))
 956             break;
 957
 958         num_read++;
 959
 960         if ( c == '\n' )
 961             break;
 962
 963         if ( c == '\r' )
 964             continue;
 965
 966         buffer[count++] = c;
 967     }
 968
 969     buffer[MIN(count, buffer_size - 1)] = 0;
 970
 971     return errno ? -1 : num_read;
 972 }
 973
 974
 975 char* skip_whitespace(char* const str)
 976 {
 977     char *s = str;
 978
 979     while (isspace(*s))
 980         s++;
 981
 982     return s;
 983 }
 984
 985 /* Format time into buf.
 986  *
 987  * buf      - buffer to format to.
 988  * buf_size - size of buffer.
 989  * t        - time to format, in milliseconds.
 990  */
 991 void format_time(char* buf, int buf_size, long t)
 992 {
 993     int const time = abs(t / 1000);
 994     int const hours = time / 3600;
 995     int const minutes = time / 60 - hours * 60;
 996     int const seconds = time % 60;
 997     const char * const sign = &"-"[t < 0 ? 0 : 1];
 998
 999     if ( hours == 0 )
1000     {
1001         snprintf(buf, buf_size, "%s%d:%02d", sign, minutes, seconds);
1002     }
1003     else
1004     {
1005         snprintf(buf, buf_size, "%s%d:%02d:%02d", sign, hours, minutes,
1006                  seconds);
1007     }
1008 }
1009
1010
1011 /** Open a UTF-8 file and set file descriptor to first byte after BOM.
1012  *  If no BOM is present this behaves like open().
1013  *  If the file is opened for writing and O_TRUNC is set, write a BOM to
1014  *  the opened file and leave the file pointer set after the BOM.
1015  */
1016
1017 int open_utf8(const char* pathname, int flags)
1018 {
1019     int fd;
1020     unsigned char bom[BOM_UTF_8_SIZE];
1021
1022     fd = open(pathname, flags, 0666);
1023     if(fd < 0)
1024         return fd;
1025
1026     if(flags & (O_TRUNC | O_WRONLY))
1027     {
1028         write(fd, BOM_UTF_8, BOM_UTF_8_SIZE);
1029     }
1030     else
1031     {
1032         read(fd, bom, BOM_UTF_8_SIZE);
1033         /* check for BOM */
1034         if(memcmp(bom, BOM_UTF_8, BOM_UTF_8_SIZE))
1035             lseek(fd, 0, SEEK_SET);
1036     }
1037     return fd;
1038 }
1039
1040
1041 #ifdef HAVE_LCD_COLOR
1042 /*
1043  * Helper function to convert a string of 6 hex digits to a native colour
1044  */
1045
1046 static int hex2dec(int c)
1047 {
1048     return  (((c) >= '0' && ((c) <= '9')) ? (c) - '0' :
1049                                             (toupper(c)) - 'A' + 10);
1050 }
1051
1052 int hex_to_rgb(const char* hex, int* color)
1053 {
1054     int red, green, blue;
1055     int i = 0;
1056
1057     while ((i < 6) && (isxdigit(hex[i])))
1058         i++;
1059
1060     if (i < 6)
1061         return -1;
1062
1063     red = (hex2dec(hex[0]) << 4) | hex2dec(hex[1]);
1064     green = (hex2dec(hex[2]) << 4) | hex2dec(hex[3]);
1065     blue = (hex2dec(hex[4]) << 4) | hex2dec(hex[5]);
1066
1067     *color = LCD_RGBPACK(red,green,blue);
1068
1069     return 0;
1070 }
1071 #endif /* HAVE_LCD_COLOR */
1072
1073 #ifdef HAVE_LCD_BITMAP
1074 /* '0'-'3' are ASCII 0x30 to 0x33 */
1075 #define is0123(x) (((x) & 0xfc) == 0x30)
1076 #if !defined(__PCTOOL__) || defined(CHECKWPS)
1077 bool parse_color(enum screen_type screen, char *text, int *value)
1078 {
1079     (void)text; (void)value; /* silence warnings on mono bitmap */
1080     (void)screen;
1081
1082 #ifdef HAVE_LCD_COLOR
1083     if (screens[screen].depth > 2)
1084     {
1085         if (hex_to_rgb(text, value) < 0)
1086             return false;
1087         else
1088             return true;
1089     }
1090 #endif
1091
1092 #if LCD_DEPTH == 2 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH == 2)
1093     if (screens[screen].depth == 2)
1094     {
1095         if (text[1] != '\0' || !is0123(*text))
1096             return false;
1097         *value = *text - '0';
1098         return true;
1099     }
1100 #endif
1101     return false;
1102 }
1103 #endif /* !defined(__PCTOOL__) || defined(CHECKWPS) */
1104
1105 /* only used in USB HID and set_time screen */
1106 #if defined(USB_ENABLE_HID) || (CONFIG_RTC != 0)
1107 int clamp_value_wrap(int value, int max, int min)
1108 {
1109     if (value > max)
1110         return min;
1111     if (value < min)
1112         return max;
1113     return value;
1114 }
1115 #endif
1116 #endif
1117 #define MAX_ACTIVITY_DEPTH 12
1118 static enum current_activity
1119         current_activity[MAX_ACTIVITY_DEPTH] = {ACTIVITY_UNKNOWN};
1120 static int current_activity_top = 0;
1121 void push_current_activity(enum current_activity screen)
1122 {
1123     current_activity[current_activity_top++] = screen;
1124 #if defined(HAVE_LCD_BITMAP) && !defined(__PCTOOL__)
1125     FOR_NB_SCREENS(i)
1126         skinlist_set_cfg(i, NULL);
1127 #endif
1128 }
1129 void pop_current_activity(void)
1130 {
1131     current_activity_top--;
1132 #if defined(HAVE_LCD_BITMAP) && !defined(__PCTOOL__)
1133     FOR_NB_SCREENS(i)
1134         skinlist_set_cfg(i, NULL);
1135 #endif
1136 }
1137 enum current_activity get_current_activity(void)
1138 {
1139     return current_activity[current_activity_top?current_activity_top-1:0];
1140 }