miscutils/fbsplash.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Copyright (C) 2008 Michele Sanges <michele.sanges@gmail.com>
   4  *
   5  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   6  *
   7  * Usage:
   8  * - use kernel option 'vga=xxx' or otherwise enable framebuffer device.
   9  * - put somewhere fbsplash.cfg file and an image in .ppm format.
  10  * - run applet: $ setsid fbsplash [params] &
  11  *      -c: hide cursor
  12  *      -d /dev/fbN: framebuffer device (if not /dev/fb0)
  13  *      -s path_to_image_file (can be "-" for stdin)
  14  *      -i path_to_cfg_file
  15  *      -f path_to_fifo (can be "-" for stdin)
  16  * - if you want to run it only in presence of a kernel parameter
  17  *   (for example fbsplash=on), use:
  18  *   grep -q "fbsplash=on" </proc/cmdline && setsid fbsplash [params]
  19  * - commands for fifo:
  20  *   "NN" (ASCII decimal number) - percentage to show on progress bar.
  21  *   "exit" (or just close fifo) - well you guessed it.
  22  */
  23
  24 //usage:#define fbsplash_trivial_usage
  25 //usage:       "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
  26 //usage:#define fbsplash_full_usage "\n\n"
  27 //usage:       "        -s      Image"
  28 //usage:     "\n        -c      Hide cursor"
  29 //usage:     "\n        -d      Framebuffer device (default /dev/fb0)"
  30 //usage:     "\n        -i      Config file (var=value):"
  31 //usage:     "\n                        BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT"
  32 //usage:     "\n                        BAR_R,BAR_G,BAR_B"
  33 //usage:     "\n        -f      Control pipe (else exit after drawing image)"
  34 //usage:     "\n                        commands: 'NN' (% for progress bar) or 'exit'"
  35
  36 #include "libbb.h"
  37 #include <linux/fb.h>
  38
  39 /* If you want logging messages on /tmp/fbsplash.log... */
  40 #define DEBUG 0
  41
  42 struct globals {
  43 #if DEBUG
  44         bool bdebug_messages;   // enable/disable logging
  45         FILE *logfile_fd;       // log file
  46 #endif
  47         unsigned char *addr;    // pointer to framebuffer memory
  48         unsigned ns[7];         // n-parameters
  49         const char *image_filename;
  50         struct fb_var_screeninfo scr_var;
  51         struct fb_fix_screeninfo scr_fix;
  52         unsigned bytes_per_pixel;
  53 };
  54 #define G (*ptr_to_globals)
  55 #define INIT_G() do { \
  56         SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
  57 } while (0)
  58
  59 #define nbar_width      ns[0]   // progress bar width
  60 #define nbar_height     ns[1]   // progress bar height
  61 #define nbar_posx       ns[2]   // progress bar horizontal position
  62 #define nbar_posy       ns[3]   // progress bar vertical position
  63 #define nbar_colr       ns[4]   // progress bar color red component
  64 #define nbar_colg       ns[5]   // progress bar color green component
  65 #define nbar_colb       ns[6]   // progress bar color blue component
  66
  67 #if DEBUG
  68 #define DEBUG_MESSAGE(strMessage, args...) \
  69         if (G.bdebug_messages) { \
  70                 fprintf(G.logfile_fd, "[%s][%s] - %s\n", \
  71                 __FILE__, __FUNCTION__, strMessage);    \
  72         }
  73 #else
  74 #define DEBUG_MESSAGE(...) ((void)0)
  75 #endif
  76
  77
  78 /**
  79  * Open and initialize the framebuffer device
  80  * \param *strfb_device pointer to framebuffer device
  81  */
  82 static void fb_open(const char *strfb_device)
  83 {
  84         int fbfd = xopen(strfb_device, O_RDWR);
  85
  86         // framebuffer properties
  87         xioctl(fbfd, FBIOGET_VSCREENINFO, &G.scr_var);
  88         xioctl(fbfd, FBIOGET_FSCREENINFO, &G.scr_fix);
  89
  90         if (G.scr_var.bits_per_pixel < 16 || G.scr_var.bits_per_pixel > 32)
  91                 bb_error_msg_and_die("unsupported %u bpp", (int)G.scr_var.bits_per_pixel);
  92         G.bytes_per_pixel = (G.scr_var.bits_per_pixel + 7) >> 3;
  93
  94         // map the device in memory
  95         G.addr = mmap(NULL,
  96                         G.scr_var.xres * G.scr_var.yres * G.bytes_per_pixel,
  97                         PROT_WRITE, MAP_SHARED, fbfd, 0);
  98         if (G.addr == MAP_FAILED)
  99                 bb_perror_msg_and_die("mmap");
 100
 101         // point to the start of the visible screen
 102         G.addr += G.scr_var.yoffset * G.scr_fix.line_length + G.scr_var.xoffset * G.bytes_per_pixel;
 103         close(fbfd);
 104 }
 105
 106
 107 /**
 108  * Return pixel value of the passed RGB color
 109  */
 110 static unsigned fb_pixel_value(unsigned r, unsigned g, unsigned b)
 111 {
 112         if (G.bytes_per_pixel == 2) {
 113                 r >>= 3;  // 5-bit red
 114                 g >>= 2;  // 6-bit green
 115                 b >>= 3;  // 5-bit blue
 116                 return b + (g << 5) + (r << (5+6));
 117         }
 118         // RGB 888
 119         return b + (g << 8) + (r << 16);
 120 }
 121
 122 /**
 123  * Draw pixel on framebuffer
 124  */
 125 static void fb_write_pixel(unsigned char *addr, unsigned pixel)
 126 {
 127         switch (G.bytes_per_pixel) {
 128         case 2:
 129                 *(uint16_t *)addr = pixel;
 130                 break;
 131         case 4:
 132                 *(uint32_t *)addr = pixel;
 133                 break;
 134         default: // 24 bits per pixel
 135                 addr[0] = pixel;
 136                 addr[1] = pixel >> 8;
 137                 addr[2] = pixel >> 16;
 138         }
 139 }
 140
 141
 142 /**
 143  * Draw hollow rectangle on framebuffer
 144  */
 145 static void fb_drawrectangle(void)
 146 {
 147         int cnt;
 148         unsigned thispix;
 149         unsigned char *ptr1, *ptr2;
 150         unsigned char nred = G.nbar_colr/2;
 151         unsigned char ngreen =  G.nbar_colg/2;
 152         unsigned char nblue = G.nbar_colb/2;
 153
 154         thispix = fb_pixel_value(nred, ngreen, nblue);
 155
 156         // horizontal lines
 157         ptr1 = G.addr + (G.nbar_posy * G.scr_var.xres + G.nbar_posx) * G.bytes_per_pixel;
 158         ptr2 = G.addr + ((G.nbar_posy + G.nbar_height - 1) * G.scr_var.xres + G.nbar_posx) * G.bytes_per_pixel;
 159         cnt = G.nbar_width - 1;
 160         do {
 161                 fb_write_pixel(ptr1, thispix);
 162                 fb_write_pixel(ptr2, thispix);
 163                 ptr1 += G.bytes_per_pixel;
 164                 ptr2 += G.bytes_per_pixel;
 165         } while (--cnt >= 0);
 166
 167         // vertical lines
 168         ptr1 = G.addr + (G.nbar_posy * G.scr_var.xres + G.nbar_posx) * G.bytes_per_pixel;
 169         ptr2 = G.addr + (G.nbar_posy * G.scr_var.xres + G.nbar_posx + G.nbar_width - 1) * G.bytes_per_pixel;
 170         cnt = G.nbar_height - 1;
 171         do {
 172                 fb_write_pixel(ptr1, thispix);
 173                 fb_write_pixel(ptr2, thispix);
 174                 ptr1 += G.scr_var.xres * G.bytes_per_pixel;
 175                 ptr2 += G.scr_var.xres * G.bytes_per_pixel;
 176         } while (--cnt >= 0);
 177 }
 178
 179
 180 /**
 181  * Draw filled rectangle on framebuffer
 182  * \param nx1pos,ny1pos upper left position
 183  * \param nx2pos,ny2pos down right position
 184  * \param nred,ngreen,nblue rgb color
 185  */
 186 static void fb_drawfullrectangle(int nx1pos, int ny1pos, int nx2pos, int ny2pos,
 187         unsigned char nred, unsigned char ngreen, unsigned char nblue)
 188 {
 189         int cnt1, cnt2, nypos;
 190         unsigned thispix;
 191         unsigned char *ptr;
 192
 193         thispix = fb_pixel_value(nred, ngreen, nblue);
 194
 195         cnt1 = ny2pos - ny1pos;
 196         nypos = ny1pos;
 197         do {
 198                 ptr = G.addr + (nypos * G.scr_var.xres + nx1pos) * G.bytes_per_pixel;
 199                 cnt2 = nx2pos - nx1pos;
 200                 do {
 201                         fb_write_pixel(ptr, thispix);
 202                         ptr += G.bytes_per_pixel;
 203                 } while (--cnt2 >= 0);
 204
 205                 nypos++;
 206         } while (--cnt1 >= 0);
 207 }
 208
 209
 210 /**
 211  * Draw a progress bar on framebuffer
 212  * \param percent percentage of loading
 213  */
 214 static void fb_drawprogressbar(unsigned percent)
 215 {
 216         int i, left_x, top_y, width, height;
 217
 218         // outer box
 219         left_x = G.nbar_posx;
 220         top_y = G.nbar_posy;
 221         width = G.nbar_width - 1;
 222         height = G.nbar_height - 1;
 223         if ((height | width) < 0)
 224                 return;
 225         // NB: "width" of 1 actually makes rect with width of 2!
 226         fb_drawrectangle();
 227
 228         // inner "empty" rectangle
 229         left_x++;
 230         top_y++;
 231         width -= 2;
 232         height -= 2;
 233         if ((height | width) < 0)
 234                 return;
 235         fb_drawfullrectangle(
 236                         left_x, top_y,
 237                                         left_x + width, top_y + height,
 238                         G.nbar_colr, G.nbar_colg, G.nbar_colb);
 239
 240         if (percent > 0) {
 241                 // actual progress bar
 242                 width = width * percent / 100;
 243                 i = height;
 244                 if (height == 0)
 245                         height++; // divide by 0 is bad
 246                 while (i >= 0) {
 247                         // draw one-line thick "rectangle"
 248                         // top line will have gray lvl 200, bottom one 100
 249                         unsigned gray_level = 100 + i*100/height;
 250                         fb_drawfullrectangle(
 251                                         left_x, top_y, left_x + width, top_y,
 252                                         gray_level, gray_level, gray_level);
 253                         top_y++;
 254                         i--;
 255                 }
 256         }
 257 }
 258
 259
 260 /**
 261  * Draw image from PPM file
 262  */
 263 static void fb_drawimage(void)
 264 {
 265         FILE *theme_file;
 266         char *read_ptr;
 267         unsigned char *pixline;
 268         unsigned i, j, width, height, line_size;
 269
 270         if (LONE_DASH(G.image_filename)) {
 271                 theme_file = stdin;
 272         } else {
 273                 int fd = open_zipped(G.image_filename);
 274                 if (fd < 0)
 275                         bb_simple_perror_msg_and_die(G.image_filename);
 276                 theme_file = xfdopen_for_read(fd);
 277         }
 278
 279         /* Parse ppm header:
 280          * - Magic: two characters "P6".
 281          * - Whitespace (blanks, TABs, CRs, LFs).
 282          * - A width, formatted as ASCII characters in decimal.
 283          * - Whitespace.
 284          * - A height, ASCII decimal.
 285          * - Whitespace.
 286          * - The maximum color value, ASCII decimal, in 0..65535
 287          * - Newline or other single whitespace character.
 288          *   (we support newline only)
 289          * - A raster of Width * Height pixels in triplets of rgb
 290          *   in pure binary by 1 or 2 bytes. (we support only 1 byte)
 291          */
 292 #define concat_buf bb_common_bufsiz1
 293         read_ptr = concat_buf;
 294         while (1) {
 295                 int w, h, max_color_val;
 296                 int rem = concat_buf + sizeof(concat_buf) - read_ptr;
 297                 if (rem < 2
 298                  || fgets(read_ptr, rem, theme_file) == NULL
 299                 ) {
 300                         bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
 301                 }
 302                 read_ptr = strchrnul(read_ptr, '#');
 303                 *read_ptr = '\0'; /* ignore #comments */
 304                 if (sscanf(concat_buf, "P6 %u %u %u", &w, &h, &max_color_val) == 3
 305                  && max_color_val <= 255
 306                 ) {
 307                         width = w; /* w is on stack, width may be in register */
 308                         height = h;
 309                         break;
 310                 }
 311         }
 312
 313         line_size = width*3;
 314         pixline = xmalloc(line_size);
 315
 316         if (width > G.scr_var.xres)
 317                 width = G.scr_var.xres;
 318         if (height > G.scr_var.yres)
 319                 height = G.scr_var.yres;
 320         for (j = 0; j < height; j++) {
 321                 unsigned char *pixel;
 322                 unsigned char *src;
 323
 324                 if (fread(pixline, 1, line_size, theme_file) != line_size)
 325                         bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
 326                 pixel = pixline;
 327                 src = G.addr + j * G.scr_fix.line_length;
 328                 for (i = 0; i < width; i++) {
 329                         unsigned thispix = fb_pixel_value(pixel[0], pixel[1], pixel[2]);
 330                         fb_write_pixel(src, thispix);
 331                         src += G.bytes_per_pixel;
 332                         pixel += 3;
 333                 }
 334         }
 335         free(pixline);
 336         fclose(theme_file);
 337 }
 338
 339
 340 /**
 341  * Parse configuration file
 342  * \param *cfg_filename name of the configuration file
 343  */
 344 static void init(const char *cfg_filename)
 345 {
 346         static const char param_names[] ALIGN1 =
 347                 "BAR_WIDTH\0" "BAR_HEIGHT\0"
 348                 "BAR_LEFT\0" "BAR_TOP\0"
 349                 "BAR_R\0" "BAR_G\0" "BAR_B\0"
 350 #if DEBUG
 351                 "DEBUG\0"
 352 #endif
 353                 ;
 354         char *token[2];
 355         parser_t *parser = config_open2(cfg_filename, xfopen_stdin);
 356         while (config_read(parser, token, 2, 2, "#=",
 357                                 (PARSE_NORMAL | PARSE_MIN_DIE) & ~(PARSE_TRIM | PARSE_COLLAPSE))) {
 358                 unsigned val = xatoi_positive(token[1]);
 359                 int i = index_in_strings(param_names, token[0]);
 360                 if (i < 0)
 361                         bb_error_msg_and_die("syntax error: %s", token[0]);
 362                 if (i >= 0 && i < 7)
 363                         G.ns[i] = val;
 364 #if DEBUG
 365                 if (i == 7) {
 366                         G.bdebug_messages = val;
 367                         if (G.bdebug_messages)
 368                                 G.logfile_fd = xfopen_for_write("/tmp/fbsplash.log");
 369                 }
 370 #endif
 371         }
 372         config_close(parser);
 373 }
 374
 375
 376 int fbsplash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 377 int fbsplash_main(int argc UNUSED_PARAM, char **argv)
 378 {
 379         const char *fb_device, *cfg_filename, *fifo_filename;
 380         FILE *fp = fp; // for compiler
 381         char *num_buf;
 382         unsigned num;
 383         bool bCursorOff;
 384
 385         INIT_G();
 386
 387         // parse command line options
 388         fb_device = "/dev/fb0";
 389         cfg_filename = NULL;
 390         fifo_filename = NULL;
 391         bCursorOff = 1 & getopt32(argv, "cs:d:i:f:",
 392                         &G.image_filename, &fb_device, &cfg_filename, &fifo_filename);
 393
 394         // parse configuration file
 395         if (cfg_filename)
 396                 init(cfg_filename);
 397
 398         // We must have -s IMG
 399         if (!G.image_filename)
 400                 bb_show_usage();
 401
 402         fb_open(fb_device);
 403
 404         if (fifo_filename && bCursorOff) {
 405                 // hide cursor (BEFORE any fb ops)
 406                 full_write(STDOUT_FILENO, "\033[?25l", 6);
 407         }
 408
 409         fb_drawimage();
 410
 411         if (!fifo_filename)
 412                 return EXIT_SUCCESS;
 413
 414         fp = xfopen_stdin(fifo_filename);
 415         if (fp != stdin) {
 416                 // For named pipes, we want to support this:
 417                 //  mkfifo cmd_pipe
 418                 //  fbsplash -f cmd_pipe .... &
 419                 //  ...
 420                 //  echo 33 >cmd_pipe
 421                 //  ...
 422                 //  echo 66 >cmd_pipe
 423                 // This means that we don't want fbsplash to get EOF
 424                 // when last writer closes input end.
 425                 // The simplest way is to open fifo for writing too
 426                 // and become an additional writer :)
 427                 open(fifo_filename, O_WRONLY); // errors are ignored
 428         }
 429
 430         fb_drawprogressbar(0);
 431         // Block on read, waiting for some input.
 432         // Use of <stdio.h> style I/O allows to correctly
 433         // handle a case when we have many buffered lines
 434         // already in the pipe
 435         while ((num_buf = xmalloc_fgetline(fp)) != NULL) {
 436                 if (strncmp(num_buf, "exit", 4) == 0) {
 437                         DEBUG_MESSAGE("exit");
 438                         break;
 439                 }
 440                 num = atoi(num_buf);
 441                 if (isdigit(num_buf[0]) && (num <= 100)) {
 442 #if DEBUG
 443                         DEBUG_MESSAGE(itoa(num));
 444 #endif
 445                         fb_drawprogressbar(num);
 446                 }
 447                 free(num_buf);
 448         }
 449
 450         if (bCursorOff) // restore cursor
 451                 full_write(STDOUT_FILENO, "\033[?25h", 6);
 452
 453         return EXIT_SUCCESS;
 454 }