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