1 /* vi: set sw=4 ts=4: */
3 * Copyright (C) 2008 Michele Sanges <michele.sanges@gmail.com>
5 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
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] &
12 * -d /dev/fbN: framebuffer device (if not /dev/fb0)
13 * -s path_to_image_file (can be "-" for stdin)
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.
27 /* If you want logging messages on /tmp/fbsplash.log... */
30 #define BYTES_PER_PIXEL 2
32 typedef unsigned short DATA;
36 bool bdebug_messages; // enable/disable logging
37 FILE *logfile_fd; // log file
39 unsigned char *addr; // pointer to framebuffer memory
40 unsigned ns[7]; // n-parameters
41 const char *image_filename;
42 struct fb_var_screeninfo scr_var;
43 struct fb_fix_screeninfo scr_fix;
45 #define G (*ptr_to_globals)
46 #define INIT_G() do { \
47 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
50 #define nbar_width ns[0] // progress bar width
51 #define nbar_height ns[1] // progress bar height
52 #define nbar_posx ns[2] // progress bar horizontal position
53 #define nbar_posy ns[3] // progress bar vertical position
54 #define nbar_colr ns[4] // progress bar color red component
55 #define nbar_colg ns[5] // progress bar color green component
56 #define nbar_colb ns[6] // progress bar color blue component
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("mmap");
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_height - 1;
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)
221 unsigned char *pixline;
222 unsigned i, j, width, height, line_size;
224 if (LONE_DASH(G.image_filename)) {
227 int fd = open_zipped(G.image_filename);
229 bb_simple_perror_msg_and_die(G.image_filename);
230 theme_file = xfdopen_for_read(fd);
234 * - Magic: two characters "P6".
235 * - Whitespace (blanks, TABs, CRs, LFs).
236 * - A width, formatted as ASCII characters in decimal.
238 * - A height, ASCII decimal.
240 * - The maximum color value, ASCII decimal, in 0..65535
241 * - Newline or other single whitespace character.
242 * (we support newline only)
243 * - A raster of Width * Height pixels in triplets of rgb
244 * in pure binary by 1 or 2 bytes. (we support only 1 byte)
246 #define concat_buf bb_common_bufsiz1
247 read_ptr = concat_buf;
249 int w, h, max_color_val;
250 int rem = concat_buf + sizeof(concat_buf) - read_ptr;
252 || fgets(read_ptr, rem, theme_file) == NULL
254 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
256 read_ptr = strchrnul(read_ptr, '#');
257 *read_ptr = '\0'; /* ignore #comments */
258 if (sscanf(concat_buf, "P6 %u %u %u", &w, &h, &max_color_val) == 3
259 && max_color_val <= 255
261 width = w; /* w is on stack, width may be in register */
268 pixline = xmalloc(line_size);
270 if (width > G.scr_var.xres)
271 width = G.scr_var.xres;
272 if (height > G.scr_var.yres)
273 height = G.scr_var.yres;
274 for (j = 0; j < height; j++) {
275 unsigned char *pixel;
278 if (fread(pixline, 1, line_size, theme_file) != line_size)
279 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
281 src = (DATA *)(G.addr + j * G.scr_fix.line_length);
282 for (i = 0; i < width; i++) {
284 thispix = (((unsigned)pixel[0] << 8) & 0xf800)
285 | (((unsigned)pixel[1] << 3) & 0x07e0)
286 | (((unsigned)pixel[2] >> 3));
297 * Parse configuration file
298 * \param *cfg_filename name of the configuration file
300 static void init(const char *cfg_filename)
302 static const char param_names[] ALIGN1 =
303 "BAR_WIDTH\0" "BAR_HEIGHT\0"
304 "BAR_LEFT\0" "BAR_TOP\0"
305 "BAR_R\0" "BAR_G\0" "BAR_B\0"
311 parser_t *parser = config_open2(cfg_filename, xfopen_stdin);
312 while (config_read(parser, token, 2, 2, "#=",
313 (PARSE_NORMAL | PARSE_MIN_DIE) & ~(PARSE_TRIM | PARSE_COLLAPSE))) {
314 unsigned val = xatoi_positive(token[1]);
315 int i = index_in_strings(param_names, token[0]);
317 bb_error_msg_and_die("syntax error: %s", token[0]);
322 G.bdebug_messages = val;
323 if (G.bdebug_messages)
324 G.logfile_fd = xfopen_for_write("/tmp/fbsplash.log");
328 config_close(parser);
332 int fbsplash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
333 int fbsplash_main(int argc UNUSED_PARAM, char **argv)
335 const char *fb_device, *cfg_filename, *fifo_filename;
336 FILE *fp = fp; // for compiler
343 // parse command line options
344 fb_device = "/dev/fb0";
346 fifo_filename = NULL;
347 bCursorOff = 1 & getopt32(argv, "cs:d:i:f:",
348 &G.image_filename, &fb_device, &cfg_filename, &fifo_filename);
350 // parse configuration file
354 // We must have -s IMG
355 if (!G.image_filename)
360 if (fifo_filename && bCursorOff) {
361 // hide cursor (BEFORE any fb ops)
362 full_write(STDOUT_FILENO, "\033[?25l", 6);
370 fp = xfopen_stdin(fifo_filename);
372 // For named pipes, we want to support this:
374 // fbsplash -f cmd_pipe .... &
379 // This means that we don't want fbsplash to get EOF
380 // when last writer closes input end.
381 // The simplest way is to open fifo for writing too
382 // and become an additional writer :)
383 open(fifo_filename, O_WRONLY); // errors are ignored
386 fb_drawprogressbar(0);
387 // Block on read, waiting for some input.
388 // Use of <stdio.h> style I/O allows to correctly
389 // handle a case when we have many buffered lines
390 // already in the pipe
391 while ((num_buf = xmalloc_fgetline(fp)) != NULL) {
392 if (strncmp(num_buf, "exit", 4) == 0) {
393 DEBUG_MESSAGE("exit");
397 if (isdigit(num_buf[0]) && (num <= 100)) {
399 DEBUG_MESSAGE(itoa(num));
401 fb_drawprogressbar(num);
406 if (bCursorOff) // restore cursor
407 full_write(STDOUT_FILENO, "\033[?25h", 6);