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