1 /* vi: set sw=4 ts=4: */
3 * Copyright (C) 2008 Michele Sanges <michele.sanges@otomelara.it>,
4 * <michele.sanges@gmail.it>
6 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
9 * - use kernel option 'vga=xxx' or otherwise enable framebuffer device.
10 * - put somewhere fbsplash.cfg file and an image in .ppm format.
11 * - run applet: $ setsid fbsplash [params] &
13 * -d /dev/fbN: framebuffer device (if not /dev/fb0)
14 * -s path_to_image_file (can be "-" for stdin)
16 * -f path_to_fifo (can be "-" for stdin)
17 * - if you want to run it only in presence of a kernel parameter
18 * (for example fbsplash=on), use:
19 * grep -q "fbsplash=on" </proc/cmdline && setsid fbsplash [params]
20 * - commands for fifo:
21 * "NN" (ASCII decimal number) - percentage to show on progress bar.
22 * "exit" (or just close fifo) - well you guessed it.
28 /* If you want logging messages on /tmp/fbsplash.log... */
31 #define BYTES_PER_PIXEL 2
33 typedef unsigned short DATA;
37 bool bdebug_messages; // enable/disable logging
38 FILE *logfile_fd; // log file
40 unsigned char *addr; // pointer to framebuffer memory
41 unsigned nbar_width; // progress bar width
42 unsigned nbar_height; // progress bar height
43 unsigned nbar_posx; // progress bar horizontal position
44 unsigned nbar_posy; // progress bar vertical position
45 unsigned char nbar_colr; // progress bar color red component
46 unsigned char nbar_colg; // progress bar color green component
47 unsigned char nbar_colb; // progress bar color blue component
48 const char *image_filename;
49 struct fb_var_screeninfo scr_var;
50 struct fb_fix_screeninfo scr_fix;
52 #define G (*ptr_to_globals)
53 #define INIT_G() do { \
54 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
59 #define DEBUG_MESSAGE(strMessage, args...) \
60 if (G.bdebug_messages) { \
61 fprintf(G.logfile_fd, "[%s][%s] - %s\n", \
62 __FILE__, __FUNCTION__, strMessage); \
65 #define DEBUG_MESSAGE(...) ((void)0)
70 * Open and initialize the framebuffer device
71 * \param *strfb_device pointer to framebuffer device
73 static void fb_open(const char *strfb_device)
75 int fbfd = xopen(strfb_device, O_RDWR);
77 // framebuffer properties
78 xioctl(fbfd, FBIOGET_VSCREENINFO, &G.scr_var);
79 xioctl(fbfd, FBIOGET_FSCREENINFO, &G.scr_fix);
81 if (G.scr_var.bits_per_pixel != 16)
82 bb_error_msg_and_die("only 16 bpp is supported");
84 // map the device in memory
86 G.scr_var.xres * G.scr_var.yres
87 * BYTES_PER_PIXEL /*(G.scr_var.bits_per_pixel / 8)*/ ,
88 PROT_WRITE, MAP_SHARED, fbfd, 0);
89 if (G.addr == MAP_FAILED)
90 bb_perror_msg_and_die("can't mmap %s", strfb_device);
96 * Draw hollow rectangle on framebuffer
98 static void fb_drawrectangle(void)
103 unsigned char nred = G.nbar_colr/2;
104 unsigned char ngreen = G.nbar_colg/2;
105 unsigned char nblue = G.nbar_colb/2;
107 nred >>= 3; // 5-bit red
108 ngreen >>= 2; // 6-bit green
109 nblue >>= 3; // 5-bit blue
110 thispix = nblue + (ngreen << 5) + (nred << (5+6));
113 ptr1 = (DATA*)(G.addr + (G.nbar_posy * G.scr_var.xres + G.nbar_posx) * BYTES_PER_PIXEL);
114 ptr2 = (DATA*)(G.addr + ((G.nbar_posy + G.nbar_height - 1) * G.scr_var.xres + G.nbar_posx) * BYTES_PER_PIXEL);
115 cnt = G.nbar_width - 1;
119 } while (--cnt >= 0);
122 ptr1 = (DATA*)(G.addr + (G.nbar_posy * G.scr_var.xres + G.nbar_posx) * BYTES_PER_PIXEL);
123 ptr2 = (DATA*)(G.addr + (G.nbar_posy * G.scr_var.xres + G.nbar_posx + G.nbar_width - 1) * BYTES_PER_PIXEL);
124 cnt = G.nbar_posy + G.nbar_height - 1 - G.nbar_posy;
126 *ptr1 = thispix; ptr1 += G.scr_var.xres;
127 *ptr2 = thispix; ptr2 += G.scr_var.xres;
128 } while (--cnt >= 0);
133 * Draw filled rectangle on framebuffer
134 * \param nx1pos,ny1pos upper left position
135 * \param nx2pos,ny2pos down right position
136 * \param nred,ngreen,nblue rgb color
138 static void fb_drawfullrectangle(int nx1pos, int ny1pos, int nx2pos, int ny2pos,
139 unsigned char nred, unsigned char ngreen, unsigned char nblue)
141 int cnt1, cnt2, nypos;
145 nred >>= 3; // 5-bit red
146 ngreen >>= 2; // 6-bit green
147 nblue >>= 3; // 5-bit blue
148 thispix = nblue + (ngreen << 5) + (nred << (5+6));
150 cnt1 = ny2pos - ny1pos;
153 ptr = (DATA*)(G.addr + (nypos * G.scr_var.xres + nx1pos) * BYTES_PER_PIXEL);
154 cnt2 = nx2pos - nx1pos;
157 } while (--cnt2 >= 0);
160 } while (--cnt1 >= 0);
165 * Draw a progress bar on framebuffer
166 * \param percent percentage of loading
168 static void fb_drawprogressbar(unsigned percent)
170 int i, left_x, top_y, width, height;
173 left_x = G.nbar_posx;
175 width = G.nbar_width - 1;
176 height = G.nbar_height - 1;
177 if ((height | width) < 0)
179 // NB: "width" of 1 actually makes rect with width of 2!
182 // inner "empty" rectangle
187 if ((height | width) < 0)
189 fb_drawfullrectangle(
191 left_x + width, top_y + height,
192 G.nbar_colr, G.nbar_colg, G.nbar_colb);
195 // actual progress bar
196 width = width * percent / 100;
199 height++; // divide by 0 is bad
201 // draw one-line thick "rectangle"
202 // top line will have gray lvl 200, bottom one 100
203 unsigned gray_level = 100 + i*100/height;
204 fb_drawfullrectangle(
205 left_x, top_y, left_x + width, top_y,
206 gray_level, gray_level, gray_level);
215 * Draw image from PPM file
217 static void fb_drawimage(void)
222 unsigned char *pixline;
223 unsigned i, j, width, height, line_size;
225 memset(head, 0, sizeof(head));
226 theme_file = xfopen_stdin(G.image_filename);
230 if (fgets(s, sizeof(s), theme_file) == NULL)
231 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
236 if (strlen(head) + strlen(s) >= sizeof(head))
237 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
240 if (head[0] != 'P' || head[1] != '6')
241 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
243 // width, height, max_color_val
244 if (sscanf(head, "P6 %u %u %u", &width, &height, &i) == 3)
246 // TODO: i must be <= 255!
250 if (width > G.scr_var.xres)
251 width = G.scr_var.xres;
252 if (height > G.scr_var.yres)
253 height = G.scr_var.yres;
255 pixline = xmalloc(line_size);
256 for (j = 0; j < height; j++) {
257 unsigned char *pixel = pixline;
258 DATA *src = (DATA *)(G.addr + j * G.scr_fix.line_length);
260 if (fread(pixline, 1, line_size, theme_file) != line_size)
261 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
262 for (i = 0; i < width; i++) {
264 thispix = (((unsigned)pixel[0] << 8) & 0xf800)
265 | (((unsigned)pixel[1] << 3) & 0x07e0)
266 | (((unsigned)pixel[2] >> 3));
277 * Parse configuration file
278 * \param *cfg_filename name of the configuration file
280 static void init(const char *cfg_filename)
282 static const char const param_names[] ALIGN1 =
283 "BAR_LEFT\0" "BAR_TOP\0"
284 "BAR_WIDTH\0" "BAR_HEIGHT\0"
285 "BAR_R\0" "BAR_G\0" "BAR_B\0"
294 inifile = xfopen_stdin(cfg_filename);
296 while ((buf = xmalloc_fgetline(inifile)) != NULL) {
300 if (*buf == '#') { // it's a comment
305 value_str = strchr(buf, '=');
309 val = xatoi_u(value_str);
311 switch (index_in_strings(param_names, buf)) {
313 // progress bar horizontal position
317 // progress bar vertical position
321 // progress bar width
325 // progress bar height
329 // progress bar color - red component
333 // progress bar color - green component
337 // progress bar color - blue component
342 G.bdebug_messages = val;
343 if (G.bdebug_messages)
344 G.logfile_fd = xfopen("/tmp/fbsplash.log", "w");
349 bb_error_msg_and_die("syntax error: '%s'", buf);
357 int fbsplash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
358 int fbsplash_main(int argc ATTRIBUTE_UNUSED, char **argv)
360 const char *fb_device, *cfg_filename, *fifo_filename;
361 FILE *fp = fp; // for compiler
368 // parse command line options
369 fb_device = "/dev/fb0";
371 fifo_filename = NULL;
372 bCursorOff = 1 & getopt32(argv, "cs:d:i:f:",
373 &G.image_filename, &fb_device, &cfg_filename, &fifo_filename);
375 // parse configuration file
379 // We must have -s IMG
380 if (!G.image_filename)
385 if (fifo_filename && bCursorOff) {
386 // hide cursor (BEFORE any fb ops)
387 full_write(STDOUT_FILENO, "\x1b" "[?25l", 6);
395 fp = xfopen_stdin(fifo_filename);
397 // For named pipes, we want to support this:
399 // fbsplash -f cmd_pipe .... &
404 // This means that we don't want fbsplash to get EOF
405 // when last writer closes input end.
406 // The simplest way is to open fifo for writing too
407 // and become an additional writer :)
408 open(fifo_filename, O_WRONLY); // errors are ignored
411 fb_drawprogressbar(0);
412 // Block on read, waiting for some input.
413 // Use of <stdio.h> style I/O allows to correctly
414 // handle a case when we have many buffered lines
415 // already in the pipe
416 while ((num_buf = xmalloc_fgetline(fp)) != NULL) {
417 if (strncmp(num_buf, "exit", 4) == 0) {
418 DEBUG_MESSAGE("exit");
422 if (isdigit(num_buf[0]) && (num <= 100)) {
425 sprintf(strVal, "%d", num);
426 DEBUG_MESSAGE(strVal);
428 fb_drawprogressbar(num);
433 if (bCursorOff) // restore cursor
434 full_write(STDOUT_FILENO, "\x1b" "[?25h", 6);