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