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 "config.h"
  24 #include "lcd.h"
  25 #include "file.h"
  26 #ifdef __PCTOOL__
  27 #include <stdint.h>
  28 #include <stdarg.h>
  29 #else
  30 #include "sprintf.h"
  31 #include "lang.h"
  32 #include "string.h"
  33 #include "dir.h"
  34 #include "lcd-remote.h"
  35 #include "errno.h"
  36 #include "system.h"
  37 #include "timefuncs.h"
  38 #include "screens.h"
  39 #include "talk.h"
  40 #include "mpeg.h"
  41 #include "audio.h"
  42 #include "mp3_playback.h"
  43 #include "settings.h"
  44 #include "ata.h"
  45 #include "ata_idle_notify.h"
  46 #include "kernel.h"
  47 #include "power.h"
  48 #include "powermgmt.h"
  49 #include "backlight.h"
  50 #include "version.h"
  51 #include "font.h"
  52 #include "splash.h"
  53 #include "tagcache.h"
  54 #include "scrobbler.h"
  55 #include "sound.h"
  56 #include "playlist.h"
  57 #include "yesno.h"
  58
  59 #ifdef HAVE_MMC
  60 #include "ata_mmc.h"
  61 #endif
  62 #include "tree.h"
  63 #include "eeprom_settings.h"
  64 #if defined(HAVE_RECORDING) && !defined(__PCTOOL__)
  65 #include "recording.h"
  66 #endif
  67 #if defined(HAVE_LCD_BITMAP) && !defined(__PCTOOL__)
  68 #include "bmp.h"
  69 #include "icons.h"
  70 #endif /* End HAVE_LCD_BITMAP */
  71 #include "gui/gwps-common.h"
  72 #include "bookmark.h"
  73
  74 #include "misc.h"
  75 #include "playback.h"
  76
  77 #ifdef BOOTFILE
  78 #if !defined(USB_NONE) && !defined(USB_IPODSTYLE)
  79 #include "rolo.h"
  80 #include "yesno.h"
  81 #endif
  82 #endif
  83
  84 /* Format a large-range value for output, using the appropriate unit so that
  85  * the displayed value is in the range 1 <= display < 1000 (1024 for "binary"
  86  * units) if possible, and 3 significant digits are shown. If a buffer is
  87  * given, the result is snprintf()'d into that buffer, otherwise the result is
  88  * voiced.*/
  89 char *output_dyn_value(char *buf, int buf_size, int value,
  90                        const unsigned char **units, bool bin_scale)
  91 {
  92     int scale = bin_scale ? 1024 : 1000;
  93     int fraction = 0;
  94     int unit_no = 0;
  95     char tbuf[5];
  96
  97     while (value >= scale)
  98     {
  99         fraction = value % scale;
 100         value /= scale;
 101         unit_no++;
 102     }
 103     if (bin_scale)
 104         fraction = fraction * 1000 / 1024;
 105
 106     if (value >= 100 || !unit_no)
 107         tbuf[0] = '\0';
 108     else if (value >= 10)
 109         snprintf(tbuf, sizeof(tbuf), "%01d", fraction / 100);
 110     else
 111         snprintf(tbuf, sizeof(tbuf), "%02d", fraction / 10);
 112
 113     if (buf)
 114     {
 115         if (strlen(tbuf))
 116             snprintf(buf, buf_size, "%d%s%s%s", value, str(LANG_POINT),
 117                      tbuf, P2STR(units[unit_no]));
 118         else
 119             snprintf(buf, buf_size, "%d%s", value, P2STR(units[unit_no]));
 120     }
 121     else
 122     {
 123         talk_fractional(tbuf, value, P2ID(units[unit_no]));
 124     }
 125     return buf;
 126 }
 127
 128 /* Create a filename with a number part in a way that the number is 1
 129  * higher than the highest numbered file matching the same pattern.
 130  * It is allowed that buffer and path point to the same memory location,
 131  * saving a strcpy(). Path must always be given without trailing slash.
 132  * "num" can point to an int specifying the number to use or NULL or a value
 133  * less than zero to number automatically. The final number used will also
 134  * be returned in *num. If *num is >= 0 then *num will be incremented by
 135  * one. */
 136 char *create_numbered_filename(char *buffer, const char *path,
 137                                const char *prefix, const char *suffix,
 138                                int numberlen IF_CNFN_NUM_(, int *num))
 139 {
 140     DIR *dir;
 141     struct dirent *entry;
 142     int max_num;
 143     int pathlen;
 144     int prefixlen = strlen(prefix);
 145     char fmtstring[12];
 146
 147     if (buffer != path)
 148         strncpy(buffer, path, MAX_PATH);
 149
 150     pathlen = strlen(buffer);
 151
 152 #ifdef IF_CNFN_NUM
 153     if (num && *num >= 0)
 154     {
 155         /* number specified */
 156         max_num = *num;
 157     }
 158     else
 159 #endif
 160     {
 161         /* automatic numbering */
 162         max_num = 0;
 163
 164     dir = opendir(pathlen ? buffer : "/");
 165     if (!dir)
 166         return NULL;
 167
 168     while ((entry = readdir(dir)))
 169     {
 170         int curr_num;
 171
 172         if (strncasecmp((char *)entry->d_name, prefix, prefixlen)
 173             || strcasecmp((char *)entry->d_name + prefixlen + numberlen, suffix))
 174             continue;
 175
 176         curr_num = atoi((char *)entry->d_name + prefixlen);
 177         if (curr_num > max_num)
 178             max_num = curr_num;
 179     }
 180
 181     closedir(dir);
 182     }
 183
 184     max_num++;
 185
 186     snprintf(fmtstring, sizeof(fmtstring), "/%%s%%0%dd%%s", numberlen);
 187     snprintf(buffer + pathlen, MAX_PATH - pathlen, fmtstring, prefix,
 188              max_num, suffix);
 189
 190 #ifdef IF_CNFN_NUM
 191     if (num)
 192         *num = max_num;
 193 #endif
 194
 195     return buffer;
 196 }
 197
 198 /* Format time into buf.
 199  *
 200  * buf      - buffer to format to.
 201  * buf_size - size of buffer.
 202  * t        - time to format, in milliseconds.
 203  */
 204 void format_time(char* buf, int buf_size, long t)
 205 {
 206     if ( t < 3600000 )
 207     {
 208       snprintf(buf, buf_size, "%d:%02d",
 209                (int) (t / 60000), (int) (t % 60000 / 1000));
 210     }
 211     else
 212     {
 213       snprintf(buf, buf_size, "%d:%02d:%02d",
 214                (int) (t / 3600000), (int) (t % 3600000 / 60000),
 215                (int) (t % 60000 / 1000));
 216     }
 217 }
 218
 219 #if CONFIG_RTC
 220 /* Create a filename with a date+time part.
 221    It is allowed that buffer and path point to the same memory location,
 222    saving a strcpy(). Path must always be given without trailing slash.
 223    unique_time as true makes the function wait until the current time has
 224    changed. */
 225 char *create_datetime_filename(char *buffer, const char *path,
 226                                const char *prefix, const char *suffix,
 227                                bool unique_time)
 228 {
 229     struct tm *tm = get_time();
 230     static struct tm last_tm;
 231     int pathlen;
 232
 233     while (unique_time && !memcmp(get_time(), &last_tm, sizeof (struct tm)))
 234         sleep(HZ/10);
 235
 236     last_tm = *tm;
 237
 238     if (buffer != path)
 239         strncpy(buffer, path, MAX_PATH);
 240
 241     pathlen = strlen(buffer);
 242     snprintf(buffer + pathlen, MAX_PATH - pathlen,
 243              "/%s%02d%02d%02d-%02d%02d%02d%s", prefix,
 244              tm->tm_year % 100, tm->tm_mon + 1, tm->tm_mday,
 245              tm->tm_hour, tm->tm_min, tm->tm_sec, suffix);
 246
 247     return buffer;
 248 }
 249 #endif /* CONFIG_RTC */
 250
 251 /* Ask the user if they really want to erase the current dynamic playlist
 252  * returns true if the playlist should be replaced */
 253 bool warn_on_pl_erase(void)
 254 {
 255     if (global_settings.warnon_erase_dynplaylist &&
 256         !global_settings.party_mode &&
 257         playlist_modified(NULL))
 258     {
 259         static const char *lines[] =
 260             {ID2P(LANG_WARN_ERASEDYNPLAYLIST_PROMPT)};
 261         static const struct text_message message={lines, 1};
 262
 263         return (gui_syncyesno_run(&message, NULL, NULL) == YESNO_YES);
 264     }
 265     else
 266         return true;
 267 }
 268
 269 /* Read (up to) a line of text from fd into buffer and return number of bytes
 270  * read (which may be larger than the number of bytes stored in buffer). If
 271  * an error occurs, -1 is returned (and buffer contains whatever could be
 272  * read). A line is terminated by a LF char. Neither LF nor CR chars are
 273  * stored in buffer.
 274  */
 275 int read_line(int fd, char* buffer, int buffer_size)
 276 {
 277     int count = 0;
 278     int num_read = 0;
 279
 280     errno = 0;
 281
 282     while (count < buffer_size)
 283     {
 284         unsigned char c;
 285
 286         if (1 != read(fd, &c, 1))
 287             break;
 288
 289         num_read++;
 290
 291         if ( c == '\n' )
 292             break;
 293
 294         if ( c == '\r' )
 295             continue;
 296
 297         buffer[count++] = c;
 298     }
 299
 300     buffer[MIN(count, buffer_size - 1)] = 0;
 301
 302     return errno ? -1 : num_read;
 303 }
 304
 305 /* Performance optimized version of the previous function. */
 306 int fast_readline(int fd, char *buf, int buf_size, void *parameters,
 307                   int (*callback)(int n, const char *buf, void *parameters))
 308 {
 309     char *p, *next;
 310     int rc, pos = 0;
 311     int count = 0;
 312
 313     while ( 1 )
 314     {
 315         next = NULL;
 316
 317         rc = read(fd, &buf[pos], buf_size - pos - 1);
 318         if (rc >= 0)
 319             buf[pos+rc] = '\0';
 320
 321         if ( (p = strchr(buf, '\r')) != NULL)
 322         {
 323             *p = '\0';
 324             next = ++p;
 325         }
 326         else
 327             p = buf;
 328
 329         if ( (p = strchr(p, '\n')) != NULL)
 330         {
 331             *p = '\0';
 332             next = ++p;
 333         }
 334
 335         rc = callback(count, buf, parameters);
 336         if (rc < 0)
 337             return rc;
 338
 339         count++;
 340         if (next)
 341         {
 342             pos = buf_size - ((long)next - (long)buf) - 1;
 343             memmove(buf, next, pos);
 344         }
 345         else
 346             break ;
 347     }
 348
 349     return 0;
 350 }
 351
 352 #ifdef HAVE_LCD_BITMAP
 353
 354 #if LCD_DEPTH == 16
 355 #define BMP_COMPRESSION 3 /* BI_BITFIELDS */
 356 #define BMP_NUMCOLORS 3
 357 #else
 358 #define BMP_COMPRESSION 0 /* BI_RGB */
 359 #if LCD_DEPTH <= 8
 360 #define BMP_NUMCOLORS (1 << LCD_DEPTH)
 361 #else
 362 #define BMP_NUMCOLORS 0
 363 #endif
 364 #endif
 365
 366 #if LCD_DEPTH == 1
 367 #define BMP_BPP 1
 368 #define BMP_LINESIZE ((LCD_WIDTH/8 + 3) & ~3)
 369 #elif LCD_DEPTH <= 4
 370 #define BMP_BPP 4
 371 #define BMP_LINESIZE ((LCD_WIDTH/2 + 3) & ~3)
 372 #elif LCD_DEPTH <= 8
 373 #define BMP_BPP 8
 374 #define BMP_LINESIZE ((LCD_WIDTH + 3) & ~3)
 375 #elif LCD_DEPTH <= 16
 376 #define BMP_BPP 16
 377 #define BMP_LINESIZE ((LCD_WIDTH*2 + 3) & ~3)
 378 #else
 379 #define BMP_BPP 24
 380 #define BMP_LINESIZE ((LCD_WIDTH*3 + 3) & ~3)
 381 #endif
 382
 383 #define BMP_HEADERSIZE (54 + 4 * BMP_NUMCOLORS)
 384 #define BMP_DATASIZE   (BMP_LINESIZE * LCD_HEIGHT)
 385 #define BMP_TOTALSIZE  (BMP_HEADERSIZE + BMP_DATASIZE)
 386
 387 #define LE16_CONST(x) (x)&0xff, ((x)>>8)&0xff
 388 #define LE32_CONST(x) (x)&0xff, ((x)>>8)&0xff, ((x)>>16)&0xff, ((x)>>24)&0xff
 389
 390 static const unsigned char bmpheader[] =
 391 {
 392     0x42, 0x4d,                 /* 'BM' */
 393     LE32_CONST(BMP_TOTALSIZE),  /* Total file size */
 394     0x00, 0x00, 0x00, 0x00,     /* Reserved */
 395     LE32_CONST(BMP_HEADERSIZE), /* Offset to start of pixel data */
 396
 397     0x28, 0x00, 0x00, 0x00,     /* Size of (2nd) header */
 398     LE32_CONST(LCD_WIDTH),      /* Width in pixels */
 399     LE32_CONST(LCD_HEIGHT),     /* Height in pixels */
 400     0x01, 0x00,                 /* Number of planes (always 1) */
 401     LE16_CONST(BMP_BPP),        /* Bits per pixel 1/4/8/16/24 */
 402     LE32_CONST(BMP_COMPRESSION),/* Compression mode */
 403     LE32_CONST(BMP_DATASIZE),   /* Size of bitmap data */
 404     0xc4, 0x0e, 0x00, 0x00,     /* Horizontal resolution (pixels/meter) */
 405     0xc4, 0x0e, 0x00, 0x00,     /* Vertical resolution (pixels/meter) */
 406     LE32_CONST(BMP_NUMCOLORS),  /* Number of used colours */
 407     LE32_CONST(BMP_NUMCOLORS),  /* Number of important colours */
 408
 409 #if LCD_DEPTH == 1
 410 #ifdef MROBE_100
 411     2, 2, 94,  0x00,            /* Colour #0 */
 412     3, 6, 241, 0x00             /* Colour #1 */
 413 #else
 414     0x90, 0xee, 0x90, 0x00,     /* Colour #0 */
 415     0x00, 0x00, 0x00, 0x00      /* Colour #1 */
 416 #endif
 417 #elif LCD_DEPTH == 2
 418     0xe6, 0xd8, 0xad, 0x00,     /* Colour #0 */
 419     0x99, 0x90, 0x73, 0x00,     /* Colour #1 */
 420     0x4c, 0x48, 0x39, 0x00,     /* Colour #2 */
 421     0x00, 0x00, 0x00, 0x00      /* Colour #3 */
 422 #elif LCD_DEPTH == 16
 423     0x00, 0xf8, 0x00, 0x00,     /* red bitfield mask */
 424     0xe0, 0x07, 0x00, 0x00,     /* green bitfield mask */
 425     0x1f, 0x00, 0x00, 0x00      /* blue bitfield mask */
 426 #endif
 427 };
 428
 429 static void (*screen_dump_hook)(int fh) = NULL;
 430
 431 void screen_dump(void)
 432 {
 433     int fh;
 434     char filename[MAX_PATH];
 435     int bx, by;
 436 #if LCD_DEPTH == 1
 437     static unsigned char line_block[8][BMP_LINESIZE];
 438 #elif LCD_DEPTH == 2
 439 #if LCD_PIXELFORMAT == HORIZONTAL_PACKING
 440     static unsigned char line_block[BMP_LINESIZE];
 441 #elif LCD_PIXELFORMAT == VERTICAL_PACKING
 442     static unsigned char line_block[4][BMP_LINESIZE];
 443 #elif LCD_PIXELFORMAT == VERTICAL_INTERLEAVED
 444     static unsigned char line_block[8][BMP_LINESIZE];
 445 #endif
 446 #elif LCD_DEPTH == 16
 447     static unsigned short line_block[BMP_LINESIZE/2];
 448 #endif
 449
 450 #if CONFIG_RTC
 451     create_datetime_filename(filename, "", "dump ", ".bmp", false);
 452 #else
 453     create_numbered_filename(filename, "", "dump_", ".bmp", 4
 454                              IF_CNFN_NUM_(, NULL));
 455 #endif
 456
 457     fh = creat(filename);
 458     if (fh < 0)
 459         return;
 460
 461     if (screen_dump_hook)
 462     {
 463         screen_dump_hook(fh);
 464     }
 465     else
 466     {
 467         write(fh, bmpheader, sizeof(bmpheader));
 468
 469         /* BMP image goes bottom up */
 470 #if LCD_DEPTH == 1
 471         for (by = LCD_FBHEIGHT - 1; by >= 0; by--)
 472         {
 473             unsigned char *src = &lcd_framebuffer[by][0];
 474             unsigned char *dst = &line_block[0][0];
 475
 476             memset(line_block, 0, sizeof(line_block));
 477             for (bx = LCD_WIDTH/8; bx > 0; bx--)
 478             {
 479                 unsigned dst_mask = 0x80;
 480                 int ix;
 481
 482                 for (ix = 8; ix > 0; ix--)
 483                 {
 484                     unsigned char *dst_blk = dst;
 485                     unsigned src_byte = *src++;
 486                     int iy;
 487
 488                     for (iy = 8; iy > 0; iy--)
 489                     {
 490                         if (src_byte & 0x80)
 491                             *dst_blk |= dst_mask;
 492                         src_byte <<= 1;
 493                         dst_blk += BMP_LINESIZE;
 494                     }
 495                     dst_mask >>= 1;
 496                 }
 497                 dst++;
 498             }
 499
 500             write(fh, line_block, sizeof(line_block));
 501         }
 502 #elif LCD_DEPTH == 2
 503 #if LCD_PIXELFORMAT == HORIZONTAL_PACKING
 504         for (by = LCD_FBHEIGHT - 1; by >= 0; by--)
 505         {
 506             unsigned char *src = &lcd_framebuffer[by][0];
 507             unsigned char *dst = line_block;
 508
 509             memset(line_block, 0, sizeof(line_block));
 510             for (bx = LCD_FBWIDTH; bx > 0; bx--)
 511             {
 512                 unsigned src_byte = *src++;
 513
 514                 *dst++ = ((src_byte >> 2) & 0x30) | ((src_byte >> 4) & 0x03);
 515                 *dst++ = ((src_byte << 2) & 0x30) | (src_byte & 0x03);
 516             }
 517
 518             write(fh, line_block, sizeof(line_block));
 519         }
 520 #elif LCD_PIXELFORMAT == VERTICAL_PACKING
 521         for (by = LCD_FBHEIGHT - 1; by >= 0; by--)
 522         {
 523             unsigned char *src = &lcd_framebuffer[by][0];
 524             unsigned char *dst = &line_block[3][0];
 525
 526             memset(line_block, 0, sizeof(line_block));
 527             for (bx = LCD_WIDTH/2; bx > 0; bx--)
 528             {
 529                 unsigned char *dst_blk = dst++;
 530                 unsigned src_byte0 = *src++ << 4;
 531                 unsigned src_byte1 = *src++;
 532                 int iy;
 533
 534                 for (iy = 4; iy > 0; iy--)
 535                 {
 536                     *dst_blk = (src_byte0 & 0x30) | (src_byte1 & 0x03);
 537                     src_byte0 >>= 2;
 538                     src_byte1 >>= 2;
 539                     dst_blk -= BMP_LINESIZE;
 540                 }
 541             }
 542
 543             write(fh, line_block, sizeof(line_block));
 544         }
 545 #elif LCD_PIXELFORMAT == VERTICAL_INTERLEAVED
 546         for (by = LCD_FBHEIGHT - 1; by >= 0; by--)
 547         {
 548             const fb_data *src = &lcd_framebuffer[by][0];
 549             unsigned char *dst = &line_block[7][0];
 550
 551             memset(line_block, 0, sizeof(line_block));
 552             for (bx = LCD_WIDTH/2; bx > 0; bx--)
 553             {
 554                 unsigned char *dst_blk = dst++;
 555                 unsigned src_data0 = *src++ << 4;
 556                 unsigned src_data1 = *src++;
 557                 int iy;
 558
 559                 for (iy = 8; iy > 0; iy--)
 560                 {
 561                     *dst_blk = (src_data0 & 0x10) | (src_data1 & 0x01)
 562                              | ((src_data0 & 0x1000) | (src_data1 & 0x0100)) >> 7;
 563                     src_data0 >>= 1;
 564                     src_data1 >>= 1;
 565                     dst_blk -= BMP_LINESIZE;
 566                 }
 567             }
 568
 569             write(fh, line_block, sizeof(line_block));
 570         }
 571 #endif
 572 #elif LCD_DEPTH == 16
 573         for (by = LCD_HEIGHT - 1; by >= 0; by--)
 574         {
 575             unsigned short *src = &lcd_framebuffer[by][0];
 576             unsigned short *dst = line_block;
 577
 578             memset(line_block, 0, sizeof(line_block));
 579             for (bx = LCD_WIDTH; bx > 0; bx--)
 580             {
 581 #if (LCD_PIXELFORMAT == RGB565SWAPPED)
 582                 /* iPod LCD data is big endian although the CPU is not */
 583                 *dst++ = htobe16(*src++);
 584 #else
 585                 *dst++ = htole16(*src++);
 586 #endif
 587             }
 588
 589             write(fh, line_block, sizeof(line_block));
 590         }
 591 #endif /* LCD_DEPTH */
 592     }
 593
 594     close(fh);
 595 }
 596
 597 void screen_dump_set_hook(void (*hook)(int fh))
 598 {
 599     screen_dump_hook = hook;
 600 }
 601
 602 #endif /* HAVE_LCD_BITMAP */
 603
 604 /* parse a line from a configuration file. the line format is:
 605
 606    name: value
 607
 608    Any whitespace before setting name or value (after ':') is ignored.
 609    A # as first non-whitespace character discards the whole line.
 610    Function sets pointers to null-terminated setting name and value.
 611    Returns false if no valid config entry was found.
 612 */
 613
 614 bool settings_parseline(char* line, char** name, char** value)
 615 {
 616     char* ptr;
 617
 618     while ( isspace(*line) )
 619         line++;
 620
 621     if ( *line == '#' )
 622         return false;
 623
 624     ptr = strchr(line, ':');
 625     if ( !ptr )
 626         return false;
 627
 628     *name = line;
 629     *ptr = 0;
 630     ptr++;
 631     while (isspace(*ptr))
 632         ptr++;
 633     *value = ptr;
 634     return true;
 635 }
 636
 637 static void system_flush(void)
 638 {
 639     tree_flush();
 640     call_ata_idle_notifys(true); /*doesnt work on usb and shutdown from ata thread */
 641 }
 642
 643 static void system_restore(void)
 644 {
 645     tree_restore();
 646 }
 647
 648 static bool clean_shutdown(void (*callback)(void *), void *parameter)
 649 {
 650 #ifdef SIMULATOR
 651     (void)callback;
 652     (void)parameter;
 653     bookmark_autobookmark();
 654     call_ata_idle_notifys(true);
 655     exit(0);
 656 #else
 657     long msg_id = -1;
 658     int i;
 659
 660     scrobbler_poweroff();
 661
 662 #if CONFIG_CHARGING && !defined(HAVE_POWEROFF_WHILE_CHARGING)
 663     if(!charger_inserted())
 664 #endif
 665     {
 666         bool batt_safe = battery_level_safe();
 667         int audio_stat = audio_status();
 668
 669         FOR_NB_SCREENS(i)
 670             screens[i].clear_display();
 671
 672         if (batt_safe)
 673         {
 674 #ifdef HAVE_TAGCACHE
 675             if (!tagcache_prepare_shutdown())
 676             {
 677                 cancel_shutdown();
 678                 splash(HZ, ID2P(LANG_TAGCACHE_BUSY));
 679                 return false;
 680             }
 681 #endif
 682             if (battery_level() > 10)
 683                 splash(0, str(LANG_SHUTTINGDOWN));
 684             else
 685             {
 686                 msg_id = LANG_WARNING_BATTERY_LOW;
 687                 splashf(0, "%s %s", str(LANG_WARNING_BATTERY_LOW),
 688                                     str(LANG_SHUTTINGDOWN));
 689             }
 690         }
 691         else
 692         {
 693             msg_id = LANG_WARNING_BATTERY_EMPTY;
 694             splashf(0, "%s %s", str(LANG_WARNING_BATTERY_EMPTY),
 695                                 str(LANG_SHUTTINGDOWN));
 696         }
 697
 698         if (global_settings.fade_on_stop
 699             && (audio_stat & AUDIO_STATUS_PLAY))
 700         {
 701             fade(false, false);
 702         }
 703
 704         if (batt_safe) /* do not save on critical battery */
 705         {
 706 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
 707             if (audio_stat & AUDIO_STATUS_RECORD)
 708             {
 709                 rec_command(RECORDING_CMD_STOP);
 710                 /* wait for stop to complete */
 711                 while (audio_status() & AUDIO_STATUS_RECORD)
 712                     sleep(1);
 713             }
 714 #endif
 715             bookmark_autobookmark();
 716
 717             /* audio_stop_recording == audio_stop for HWCODEC */
 718             audio_stop();
 719
 720             if (callback != NULL)
 721                 callback(parameter);
 722
 723 #if CONFIG_CODEC != SWCODEC
 724             /* wait for audio_stop or audio_stop_recording to complete */
 725             while (audio_status())
 726                 sleep(1);
 727 #endif
 728
 729 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
 730             audio_close_recording();
 731 #endif
 732
 733             if(global_settings.talk_menu)
 734             {
 735                 bool enqueue = false;
 736                 if(msg_id != -1)
 737                 {
 738                     talk_id(msg_id, enqueue);
 739                     enqueue = true;
 740                 }
 741                 talk_id(LANG_SHUTTINGDOWN, enqueue);
 742 #if CONFIG_CODEC == SWCODEC
 743                 voice_wait();
 744 #endif
 745             }
 746
 747             system_flush();
 748 #ifdef HAVE_EEPROM_SETTINGS
 749             if (firmware_settings.initialized)
 750             {
 751                 firmware_settings.disk_clean = true;
 752                 firmware_settings.bl_version = 0;
 753                 eeprom_settings_store();
 754             }
 755 #endif
 756         }
 757 #ifdef HAVE_DIRCACHE
 758         else
 759             dircache_disable();
 760 #endif
 761
 762         shutdown_hw();
 763     }
 764 #endif
 765     return false;
 766 }
 767
 768 bool list_stop_handler(void)
 769 {
 770     bool ret = false;
 771
 772     /* Stop the music if it is playing */
 773     if(audio_status())
 774     {
 775         if (!global_settings.party_mode)
 776         {
 777             if (global_settings.fade_on_stop)
 778                 fade(false, false);
 779             bookmark_autobookmark();
 780             audio_stop();
 781             ret = true;  /* bookmarking can make a refresh necessary */
 782         }
 783     }
 784 #if CONFIG_CHARGING
 785 #if (CONFIG_KEYPAD == RECORDER_PAD) && !defined(HAVE_SW_POWEROFF)
 786     else
 787     {
 788         if (charger_inserted())
 789             charging_splash();
 790         else
 791             shutdown_screen(); /* won't return if shutdown actually happens */
 792
 793         ret = true;  /* screen is dirty, caller needs to refresh */
 794     }
 795 #endif
 796 #ifndef HAVE_POWEROFF_WHILE_CHARGING
 797     {
 798         static long last_off = 0;
 799
 800         if (TIME_BEFORE(current_tick, last_off + HZ/2))
 801         {
 802             if (charger_inserted())
 803             {
 804                 charging_splash();
 805                 ret = true;  /* screen is dirty, caller needs to refresh */
 806             }
 807         }
 808         last_off = current_tick;
 809     }
 810 #endif
 811 #endif /* CONFIG_CHARGING */
 812     return ret;
 813 }
 814
 815 #if CONFIG_CHARGING
 816 static bool waiting_to_resume_play = false;
 817 static long play_resume_tick;
 818
 819 static void car_adapter_mode_processing(bool inserted)
 820 {
 821     if (global_settings.car_adapter_mode)
 822     {
 823         if(inserted)
 824         {
 825             /*
 826              * Just got plugged in, delay & resume if we were playing
 827              */
 828             if (audio_status() & AUDIO_STATUS_PAUSE)
 829             {
 830                 /* delay resume a bit while the engine is cranking */
 831                 play_resume_tick = current_tick + HZ*5;
 832                 waiting_to_resume_play = true;
 833             }
 834         }
 835         else
 836         {
 837             /*
 838              * Just got unplugged, pause if playing
 839              */
 840             if ((audio_status() & AUDIO_STATUS_PLAY) &&
 841                 !(audio_status() & AUDIO_STATUS_PAUSE))
 842             {
 843                 if (global_settings.fade_on_stop)
 844                     fade(false, false);
 845                 else
 846                     audio_pause();
 847             }
 848             waiting_to_resume_play = false;
 849         }
 850     }
 851 }
 852
 853 static void car_adapter_tick(void)
 854 {
 855     if (waiting_to_resume_play)
 856     {
 857         if (TIME_AFTER(current_tick, play_resume_tick))
 858         {
 859             if (audio_status() & AUDIO_STATUS_PAUSE)
 860             {
 861                 queue_broadcast(SYS_CAR_ADAPTER_RESUME, 0);
 862             }
 863             waiting_to_resume_play = false;
 864         }
 865     }
 866 }
 867
 868 void car_adapter_mode_init(void)
 869 {
 870     tick_add_task(car_adapter_tick);
 871 }
 872 #endif
 873
 874 #ifdef HAVE_HEADPHONE_DETECTION
 875 static void unplug_change(bool inserted)
 876 {
 877     static bool headphone_caused_pause = false;
 878
 879     if (global_settings.unplug_mode)
 880     {
 881         int audio_stat = audio_status();
 882         if (inserted)
 883         {
 884             if ((audio_stat & AUDIO_STATUS_PLAY) &&
 885                     headphone_caused_pause &&
 886                     global_settings.unplug_mode > 1 )
 887                 audio_resume();
 888             backlight_on();
 889             headphone_caused_pause = false;
 890         } else {
 891             if ((audio_stat & AUDIO_STATUS_PLAY) &&
 892                     !(audio_stat & AUDIO_STATUS_PAUSE))
 893             {
 894                 headphone_caused_pause = true;
 895                 audio_pause();
 896
 897                 if (global_settings.unplug_rw)
 898                 {
 899                     if (audio_current_track()->elapsed >
 900                             (unsigned long)(global_settings.unplug_rw*1000))
 901                         audio_ff_rewind(audio_current_track()->elapsed -
 902                                 (global_settings.unplug_rw*1000));
 903                     else
 904                         audio_ff_rewind(0);
 905                 }
 906             }
 907         }
 908     }
 909 }
 910 #endif
 911
 912 long default_event_handler_ex(long event, void (*callback)(void *), void *parameter)
 913 {
 914     switch(event)
 915     {
 916         case SYS_BATTERY_UPDATE:
 917             if(global_settings.talk_battery_level)
 918             {
 919                 talk_ids(true, VOICE_PAUSE, VOICE_PAUSE,
 920                          LANG_BATTERY_TIME,
 921                          TALK_ID(battery_level(), UNIT_PERCENT),
 922                          VOICE_PAUSE);
 923                 talk_force_enqueue_next();
 924             }
 925             break;
 926         case SYS_USB_CONNECTED:
 927             if (callback != NULL)
 928                 callback(parameter);
 929 #ifdef HAVE_MMC
 930             if (!mmc_touched() ||
 931                 (mmc_remove_request() == SYS_HOTSWAP_EXTRACTED))
 932 #endif
 933             {
 934                 scrobbler_flush_cache();
 935                 system_flush();
 936 #ifdef BOOTFILE
 937 #if !defined(USB_NONE) && !defined(USB_IPODSTYLE)
 938                 check_bootfile(false); /* gets initial size */
 939 #endif
 940 #endif
 941                 usb_screen();
 942 #ifdef BOOTFILE
 943 #if !defined(USB_NONE) && !defined(USB_IPODSTYLE)
 944                 check_bootfile(true);
 945 #endif
 946 #endif
 947                 system_restore();
 948             }
 949             return SYS_USB_CONNECTED;
 950         case SYS_POWEROFF:
 951             if (!clean_shutdown(callback, parameter))
 952                 return SYS_POWEROFF;
 953             break;
 954 #if CONFIG_CHARGING
 955         case SYS_CHARGER_CONNECTED:
 956             car_adapter_mode_processing(true);
 957             return SYS_CHARGER_CONNECTED;
 958
 959         case SYS_CHARGER_DISCONNECTED:
 960             car_adapter_mode_processing(false);
 961             return SYS_CHARGER_DISCONNECTED;
 962
 963         case SYS_CAR_ADAPTER_RESUME:
 964             audio_resume();
 965             return SYS_CAR_ADAPTER_RESUME;
 966 #endif
 967 #ifdef HAVE_HEADPHONE_DETECTION
 968         case SYS_PHONE_PLUGGED:
 969             unplug_change(true);
 970             return SYS_PHONE_PLUGGED;
 971
 972         case SYS_PHONE_UNPLUGGED:
 973             unplug_change(false);
 974             return SYS_PHONE_UNPLUGGED;
 975 #endif
 976     }
 977     return 0;
 978 }
 979
 980 long default_event_handler(long event)
 981 {
 982     return default_event_handler_ex(event, NULL, NULL);
 983 }
 984
 985 int show_logo( void )
 986 {
 987 #ifdef HAVE_LCD_BITMAP
 988     char version[32];
 989     int font_h, font_w;
 990
 991     snprintf(version, sizeof(version), "Ver. %s", appsversion);
 992
 993     lcd_clear_display();
 994     lcd_bitmap(rockboxlogo, 0, 10, BMPWIDTH_rockboxlogo, BMPHEIGHT_rockboxlogo);
 995     lcd_setfont(FONT_SYSFIXED);
 996     lcd_getstringsize((unsigned char *)"A", &font_w, &font_h);
 997     lcd_putsxy((LCD_WIDTH/2) - ((strlen(version)*font_w)/2),
 998                LCD_HEIGHT-font_h, (unsigned char *)version);
 999     lcd_setfont(FONT_UI);
1000
1001 #else
1002     char *rockbox = "  ROCKbox!";
1003
1004     lcd_clear_display();
1005     lcd_double_height(true);
1006     lcd_puts(0, 0, rockbox);
1007     lcd_puts_scroll(0, 1, appsversion);
1008 #endif
1009     lcd_update();
1010
1011 #ifdef HAVE_REMOTE_LCD
1012     lcd_remote_clear_display();
1013     lcd_remote_bitmap(remote_rockboxlogo, 0, 10, BMPWIDTH_remote_rockboxlogo,
1014                       BMPHEIGHT_remote_rockboxlogo);
1015     lcd_remote_setfont(FONT_SYSFIXED);
1016     lcd_remote_getstringsize((unsigned char *)"A", &font_w, &font_h);
1017     lcd_remote_putsxy((LCD_REMOTE_WIDTH/2) - ((strlen(version)*font_w)/2),
1018                        LCD_REMOTE_HEIGHT-font_h, (unsigned char *)version);
1019     lcd_remote_setfont(FONT_UI);
1020     lcd_remote_update();
1021 #endif
1022
1023     return 0;
1024 }
1025
1026 #if CONFIG_CODEC == SWCODEC
1027 int get_replaygain_mode(bool have_track_gain, bool have_album_gain)
1028 {
1029     int type;
1030
1031     bool track = ((global_settings.replaygain_type == REPLAYGAIN_TRACK)
1032         || ((global_settings.replaygain_type == REPLAYGAIN_SHUFFLE)
1033             && global_settings.playlist_shuffle));
1034
1035     type = (!track && have_album_gain) ? REPLAYGAIN_ALBUM
1036         : have_track_gain ? REPLAYGAIN_TRACK : -1;
1037
1038     return type;
1039 }
1040 #endif
1041
1042 #ifdef BOOTFILE
1043 #if !defined(USB_NONE) && !defined(USB_IPODSTYLE)
1044 /*
1045     memorize/compare details about the BOOTFILE
1046     we don't use dircache because it may not be up to date after
1047     USB disconnect (scanning in the background)
1048 */
1049 void check_bootfile(bool do_rolo)
1050 {
1051     static unsigned short wrtdate = 0;
1052     static unsigned short wrttime = 0;
1053     DIR* dir = NULL;
1054     struct dirent* entry = NULL;
1055
1056     /* 1. open BOOTDIR and find the BOOTFILE dir entry */
1057     dir = opendir(BOOTDIR);
1058
1059     if(!dir) return; /* do we want an error splash? */
1060
1061     /* loop all files in BOOTDIR */
1062     while(0 != (entry = readdir(dir)))
1063     {
1064         if(!strcasecmp(entry->d_name, BOOTFILE))
1065         {
1066             /* found the bootfile */
1067             if(wrtdate && do_rolo)
1068             {
1069                 if((entry->wrtdate != wrtdate) ||
1070                    (entry->wrttime != wrttime))
1071                 {
1072                     static const char *lines[] = { ID2P(LANG_BOOT_CHANGED),
1073                                                    ID2P(LANG_REBOOT_NOW) };
1074                     static const struct text_message message={ lines, 2 };
1075                     button_clear_queue(); /* Empty the keyboard buffer */
1076                     if(gui_syncyesno_run(&message, NULL, NULL) == YESNO_YES)
1077                     rolo_load(BOOTDIR "/" BOOTFILE);
1078                 }
1079             }
1080             wrtdate = entry->wrtdate;
1081             wrttime = entry->wrttime;
1082         }
1083     }
1084     closedir(dir);
1085 }
1086 #endif
1087 #endif
1088
1089 /* check range, set volume and save settings */
1090 void setvol(void)
1091 {
1092     const int min_vol = sound_min(SOUND_VOLUME);
1093     const int max_vol = sound_max(SOUND_VOLUME);
1094     if (global_settings.volume < min_vol)
1095         global_settings.volume = min_vol;
1096     if (global_settings.volume > max_vol)
1097         global_settings.volume = max_vol;
1098     sound_set_volume(global_settings.volume);
1099     settings_save();
1100 }
1101
1102 char* strrsplt(char* str, int c)
1103 {
1104     char* s = strrchr(str, c);
1105
1106     if (s != NULL)
1107     {
1108         *s++ = '\0';
1109     }
1110     else
1111     {
1112         s = str;
1113     }
1114
1115     return s;
1116 }
1117
1118 /* Test file existence, using dircache of possible */
1119 bool file_exists(const char *file)
1120 {
1121     int fd;
1122
1123     if (!file || strlen(file) <= 0)
1124         return false;
1125
1126 #ifdef HAVE_DIRCACHE
1127     if (dircache_is_enabled())
1128         return (dircache_get_entry_ptr(file) != NULL);
1129 #endif
1130
1131     fd = open(file, O_RDONLY);
1132     if (fd < 0)
1133         return false;
1134     close(fd);
1135     return true;
1136 }
1137
1138 bool dir_exists(const char *path)
1139 {
1140     DIR* d = opendir(path);
1141     if (!d)
1142         return false;
1143     closedir(d);
1144     return true;
1145 }
1146
1147 /*
1148  * removes the extension of filename (if it doesn't start with a .)
1149  * puts the result in buffer
1150  */
1151 char *strip_extension(char* buffer, int buffer_size, const char *filename)
1152 {
1153     char *dot = strrchr(filename, '.');
1154     int len;
1155
1156     if (buffer_size <= 0)
1157     {
1158         return NULL;
1159     }
1160
1161     buffer_size--;  /* Make room for end nil */
1162
1163     if (dot != 0 && filename[0] != '.')
1164     {
1165         len = dot - filename;
1166         len = MIN(len, buffer_size);
1167         strncpy(buffer, filename, len);
1168     }
1169     else
1170     {
1171         len = buffer_size;
1172         strncpy(buffer, filename, buffer_size);
1173     }
1174
1175     buffer[len] = 0;
1176
1177     return buffer;
1178 }
1179 #endif /* !defined(__PCTOOL__) */
1180
1181 /** Open a UTF-8 file and set file descriptor to first byte after BOM.
1182  *  If no BOM is present this behaves like open().
1183  *  If the file is opened for writing and O_TRUNC is set, write a BOM to
1184  *  the opened file and leave the file pointer set after the BOM.
1185  */
1186 int open_utf8(const char* pathname, int flags)
1187 {
1188     int fd;
1189     unsigned char bom[BOM_SIZE];
1190
1191     fd = open(pathname, flags);
1192     if(fd < 0)
1193         return fd;
1194
1195     if(flags & (O_TRUNC | O_WRONLY))
1196     {
1197         write(fd, BOM, BOM_SIZE);
1198     }
1199     else
1200     {
1201         read(fd, bom, BOM_SIZE);
1202         /* check for BOM */
1203         if(memcmp(bom, BOM, BOM_SIZE))
1204             lseek(fd, 0, SEEK_SET);
1205     }
1206     return fd;
1207 }
1208
1209
1210 #ifdef HAVE_LCD_COLOR
1211 /*
1212  * Helper function to convert a string of 6 hex digits to a native colour
1213  */
1214
1215 static int hex2dec(int c)
1216 {
1217    return  (((c) >= '0' && ((c) <= '9')) ? (c) - '0' :
1218                                            (toupper(c)) - 'A' + 10);
1219 }
1220
1221 int hex_to_rgb(const char* hex, int* color)
1222 {
1223     int red, green, blue;
1224     int i = 0;
1225
1226     while ((i < 6) && (isxdigit(hex[i])))
1227         i++;
1228
1229     if (i < 6)
1230         return -1;
1231
1232     red = (hex2dec(hex[0]) << 4) | hex2dec(hex[1]);
1233     green = (hex2dec(hex[2]) << 4) | hex2dec(hex[3]);
1234     blue = (hex2dec(hex[4]) << 4) | hex2dec(hex[5]);
1235
1236     *color = LCD_RGBPACK(red,green,blue);
1237
1238     return 0;
1239 }
1240 #endif /* HAVE_LCD_COLOR */
1241
1242 #ifdef HAVE_LCD_BITMAP
1243 /* A simplified scanf - used (at time of writing) by wps parsing functions.
1244
1245    fmt - char array specifying the format of each list option.  Valid values
1246          are:  d - int
1247                s - string (sets pointer to string, without copying)
1248                c - hex colour (RGB888 - e.g. ff00ff)
1249                g - greyscale "colour" (0-3)
1250    set_vals - if not NULL 1 is set in the bitplace if the item was read OK
1251                 0 if not read.
1252                 first item is LSB, (max 32 items! )
1253                 Stops parseing if an item is invalid unless the item == '-'
1254    sep - list separator (e.g. ',' or '|')
1255    str  - string to parse, must be terminated by 0 or sep
1256    ... - pointers to store the parsed values
1257
1258    return value - pointer to char after parsed data, 0 if there was an error.
1259
1260 */
1261
1262 /* '0'-'3' are ASCII 0x30 to 0x33 */
1263 #define is0123(x) (((x) & 0xfc) == 0x30)
1264
1265 const char* parse_list(const char *fmt, uint32_t *set_vals,
1266                        const char sep, const char* str, ...)
1267 {
1268     va_list ap;
1269     const char* p = str, *f = fmt;
1270     const char** s;
1271     int* d;
1272     bool set;
1273     int i=0;
1274
1275     va_start(ap, str);
1276     if (set_vals)
1277         *set_vals = 0;
1278     while (*fmt)
1279     {
1280         /* Check for separator, if we're not at the start */
1281         if (f != fmt)
1282         {
1283             if (*p != sep)
1284                 goto err;
1285             p++;
1286         }
1287         set = false;
1288         switch (*fmt++)
1289         {
1290             case 's': /* string - return a pointer to it (not a copy) */
1291                 s = va_arg(ap, const char **);
1292
1293                 *s = p;
1294                 while (*p && *p != sep)
1295                    p++;
1296                 set = (s[0][0]!='-') && (s[0][1]!=sep) ;
1297                 break;
1298
1299             case 'd': /* int */
1300                 d = va_arg(ap, int*);
1301                 if (!isdigit(*p))
1302                 {
1303                     if (!set_vals || *p != '-')
1304                         goto err;
1305                     while (*p && *p != sep)
1306                         p++;
1307                 }
1308                 else
1309                 {
1310                    *d = *p++ - '0';
1311                     while (isdigit(*p))
1312                        *d = (*d * 10) + (*p++ - '0');
1313                     set = true;
1314                 }
1315
1316                 break;
1317
1318 #ifdef HAVE_LCD_COLOR
1319             case 'c': /* colour (rrggbb - e.g. f3c1a8) */
1320                 d = va_arg(ap, int*);
1321
1322                 if (hex_to_rgb(p, d) < 0)
1323                 {
1324                     if (!set_vals || *p != '-')
1325                         goto err;
1326                     while (*p && *p != sep)
1327                         p++;
1328                 }
1329                 else
1330                 {
1331                     p += 6;
1332                     set = true;
1333                 }
1334
1335                 break;
1336 #endif
1337
1338 #if LCD_DEPTH == 2 || (defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH == 2)
1339             case 'g': /* greyscale colour (0-3) */
1340                 d = va_arg(ap, int*);
1341
1342                 if (is0123(*p))
1343                 {
1344                     *d = *p++ - '0';
1345                     set = true;
1346                 }
1347                 else if (!set_vals || *p != '-')
1348                     goto err;
1349                 else
1350                 {
1351                     while (*p && *p != sep)
1352                         p++;
1353                 }
1354
1355                 break;
1356 #endif
1357
1358             default:  /* Unknown format type */
1359                 goto err;
1360                 break;
1361         }
1362         if (set_vals && set)
1363             *set_vals |= (1<<i);
1364         i++;
1365     }
1366
1367     va_end(ap);
1368     return p;
1369
1370 err:
1371     va_end(ap);
1372     return 0;
1373 }
1374 #endif