calculate-plymouth/src/splash-plugins/fedora-fade-in/fedora-fade-in.c

/* fedora-fade-in.c - boot splash plugin
 *
 * Copyright (C) 2007, 2008 Red Hat, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 *
 * Written by: Ray Strode <rstrode@redhat.com>
 */
#include "config.h"

#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <math.h>
#include <signal.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <sys/ioctl.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/types.h>
#include <values.h>
#include <unistd.h>
#include <wchar.h>

#include "ply-boot-splash-plugin.h"
#include "ply-buffer.h"
#include "ply-event-loop.h"
#include "ply-list.h"
#include "ply-logger.h"
#include "ply-frame-buffer.h"
#include "ply-image.h"
#include "ply-utils.h"
#include "ply-window.h"

#include <linux/kd.h>

#ifndef FRAMES_PER_SECOND
#define FRAMES_PER_SECOND 30
#endif

typedef struct
{
  int x; 
  int y;
  double start_time;
  double speed;
} star_t;

typedef struct
{
  int x;
  int y;
  int number_of_bullets;
} entry_t;

struct _ply_boot_splash_plugin
{
  ply_event_loop_t *loop;
  ply_frame_buffer_t *frame_buffer;
  ply_image_t *logo_image;
  ply_image_t *star_image;
  ply_image_t *bullet_image;
  ply_image_t *lock_image;
  ply_image_t *entry_image;
  ply_list_t *stars;
  ply_window_t *window;

  entry_t *entry;

  ply_boot_splash_password_answer_handler_t password_answer_handler;
  void *password_answer_data;

  ply_buffer_t *keyboard_input_buffer;

  double start_time;
  double now;
};

ply_boot_splash_plugin_t *
create_plugin (void)
{
  ply_boot_splash_plugin_t *plugin;

  srand ((int) ply_get_timestamp ());
  plugin = calloc (1, sizeof (ply_boot_splash_plugin_t));
  plugin->start_time = 0.0;

  plugin->keyboard_input_buffer = ply_buffer_new ();

  plugin->frame_buffer = ply_frame_buffer_new (NULL);
  plugin->logo_image = ply_image_new (PLYMOUTH_IMAGE_DIR "fedora-logo.png");
  plugin->star_image = ply_image_new (PLYMOUTH_IMAGE_DIR "star.png");
  plugin->lock_image = ply_image_new (PLYMOUTH_IMAGE_DIR "lock.png");
  plugin->bullet_image = ply_image_new (PLYMOUTH_IMAGE_DIR "bullet.png");
  plugin->entry_image = ply_image_new (PLYMOUTH_IMAGE_DIR "entry.png");
  plugin->stars = ply_list_new ();

  return plugin;
}

static entry_t *
entry_new (int x,
           int y)
{

  entry_t *entry;

  entry = calloc (1, sizeof (entry_t));
  entry->x = x;
  entry->y = y;

  return entry;
}

static void
entry_free (entry_t *entry)
{
  free (entry);
}

star_t *
star_new (int    x,
          int    y,
          double speed)
{
  star_t *star;

  star = calloc (1, sizeof (star_t));
  star->x = x;
  star->y = y;
  star->speed = speed;
  star->start_time = ply_get_timestamp ();

  return star;
}

static void
star_free (star_t *star)
{
  free (star);
}

static void
free_stars (ply_boot_splash_plugin_t *plugin)
{
  ply_list_node_t *node;

  assert (plugin != NULL);

  node = ply_list_get_first_node (plugin->stars);
  while (node != NULL)
    {
      ply_list_node_t *next_node;
      star_t *star;

      star = (star_t *) ply_list_node_get_data (node);

      next_node = ply_list_get_next_node (plugin->stars, node);

      star_free (star);
      node = next_node;
    }

  ply_list_free (plugin->stars);
  plugin->stars = NULL;
}

static void detach_from_event_loop (ply_boot_splash_plugin_t *plugin);

void
destroy_plugin (ply_boot_splash_plugin_t *plugin)
{
  if (plugin == NULL)
    return;

  ply_buffer_free (plugin->keyboard_input_buffer);

  free_stars (plugin);
  ply_image_free (plugin->logo_image);
  ply_image_free (plugin->star_image);
  ply_image_free (plugin->bullet_image);
  ply_image_free (plugin->entry_image);
  ply_image_free (plugin->lock_image);
  ply_frame_buffer_free (plugin->frame_buffer);
  free (plugin);
}

static void
animate_at_time (ply_boot_splash_plugin_t *plugin,
                 double                    time)
{
  ply_list_node_t *node;
  ply_frame_buffer_area_t logo_area, star_area;
  uint32_t *logo_data, *star_data;
  long width, height;
  static double last_opacity = 0.0;
  double opacity = 0.0;

  ply_frame_buffer_pause_updates (plugin->frame_buffer);

  width = ply_image_get_width (plugin->logo_image);
  height = ply_image_get_height (plugin->logo_image);
  logo_data = ply_image_get_data (plugin->logo_image);
  ply_frame_buffer_get_size (plugin->frame_buffer, &logo_area);
  logo_area.x = (logo_area.width / 2) - (width / 2);
  logo_area.y = (logo_area.height / 2) - (height / 2);
  logo_area.width = width;
  logo_area.height = height;

  star_data = ply_image_get_data (plugin->star_image);
  star_area.width = ply_image_get_width (plugin->star_image);
  star_area.height = ply_image_get_height (plugin->star_image);

  node = ply_list_get_first_node (plugin->stars);
  while (node != NULL)
    {
      ply_list_node_t *next_node;
      star_t *star;

      star = (star_t *) ply_list_node_get_data (node);
      next_node = ply_list_get_next_node (plugin->stars, node);

      star_area.x = star->x;
      star_area.y = star->y;

      opacity = .5 * sin (((plugin->now - star->start_time) / star->speed) * (2 * M_PI)) + .5;
      opacity = CLAMP (opacity, 0, 1.0);

      ply_frame_buffer_fill_with_color (plugin->frame_buffer, &star_area,
                                        0.1, 0.1, .7, 1.0);
      ply_frame_buffer_fill_with_argb32_data_at_opacity (plugin->frame_buffer, 
                                                         &star_area, 0, 0, 
                                                         star_data, opacity);

      node = next_node;
    }

  opacity = .5 * sin ((time / 5) * (2 * M_PI)) + .8;
  opacity = CLAMP (opacity, 0, 1.0);

  if (fabs (opacity - last_opacity) <= DBL_MIN)
    {
      ply_frame_buffer_unpause_updates (plugin->frame_buffer);
      return;
    }

  last_opacity = opacity;

  ply_frame_buffer_fill_with_color (plugin->frame_buffer, &logo_area,
                                    0.1, 0.1, .7, 1.0);
  ply_frame_buffer_fill_with_argb32_data_at_opacity (plugin->frame_buffer, 
                                                     &logo_area, 0, 0,
                                                     logo_data, opacity);
  ply_frame_buffer_unpause_updates (plugin->frame_buffer);
}

static void draw_password_entry (ply_boot_splash_plugin_t *plugin);
static void
on_timeout (ply_boot_splash_plugin_t *plugin)
{
  double sleep_time;

  ply_window_set_mode (plugin->window, PLY_WINDOW_MODE_GRAPHICS);
  plugin->now = ply_get_timestamp ();

  /* The choice below is between
   *
   * 1) keeping a constant animation speed, and dropping
   * frames when necessary
   * 2) showing every frame, but slowing down the animation
   * when a frame would be otherwise dropped.
   *
   * It turns out there are parts of boot up where the animation
   * can get sort of choppy.  By default we choose 2, since the
   * nature of this animation means it looks natural even when it
   * is slowed down
   */
#ifdef REAL_TIME_ANIMATION
  animate_at_time (plugin,
                   plugin->now - plugin->start_time);
#else
  static double time = 0.0;
  time += 1.0 / FRAMES_PER_SECOND;
  animate_at_time (plugin, time);
#endif

  sleep_time = 1.0 / FRAMES_PER_SECOND;
  sleep_time = MAX (sleep_time - (ply_get_timestamp () - plugin->now),
                    0.005);

  ply_event_loop_watch_for_timeout (plugin->loop, 
                                    sleep_time,
                                    (ply_event_loop_timeout_handler_t)
                                    on_timeout, plugin);
}

static void
start_animation (ply_boot_splash_plugin_t *plugin)
{
  assert (plugin != NULL);
  assert (plugin->loop != NULL);
    
  ply_event_loop_watch_for_timeout (plugin->loop, 
                                    1.0 / FRAMES_PER_SECOND,
                                    (ply_event_loop_timeout_handler_t)
                                    on_timeout, plugin);

  plugin->start_time = ply_get_timestamp ();
  ply_frame_buffer_fill_with_color (plugin->frame_buffer, NULL, 
                                    0.1, 0.1, .7, 1.0);
}

static void
stop_animation (ply_boot_splash_plugin_t *plugin)
{
  int i;

  assert (plugin != NULL);
  assert (plugin->loop != NULL);
    
  for (i = 0; i < 10; i++)
    {
      ply_frame_buffer_fill_with_color (plugin->frame_buffer, NULL,
                                        0.1, 0.1, .7, .1 + .1 * i);
    }

  ply_frame_buffer_fill_with_color (plugin->frame_buffer, NULL,
                                    0.1, 0.1, 0.7, 1.0);

  for (i = 0; i < 20; i++)
    {
      ply_frame_buffer_fill_with_color (plugin->frame_buffer, NULL,
                                        0.0, 0.0, 0.0, .05 + .05 * i);
    }

  ply_frame_buffer_fill_with_color (plugin->frame_buffer, NULL,
                                    0.0, 0.0, 0.0, 1.0);

  if (plugin->loop != NULL)
    {
      ply_event_loop_stop_watching_for_timeout (plugin->loop,
                                                (ply_event_loop_timeout_handler_t)
                                                on_timeout, plugin);
    }
}

static void
on_interrupt (ply_boot_splash_plugin_t *plugin)
{
  ply_event_loop_exit (plugin->loop, 1);
  stop_animation (plugin);
  ply_window_set_mode (plugin->window, PLY_WINDOW_MODE_TEXT);
}

static void
detach_from_event_loop (ply_boot_splash_plugin_t *plugin)
{
  plugin->loop = NULL;

  ply_window_set_mode (plugin->window, PLY_WINDOW_MODE_TEXT);
}

bool
show_splash_screen (ply_boot_splash_plugin_t *plugin,
                    ply_event_loop_t         *loop,
                    ply_window_t             *window,
                    ply_buffer_t             *boot_buffer)
{
  assert (plugin != NULL);
  assert (plugin->logo_image != NULL);
  assert (plugin->frame_buffer != NULL);

  plugin->loop = loop;
  ply_event_loop_watch_for_exit (loop, (ply_event_loop_exit_handler_t)
                                 detach_from_event_loop,
                                 plugin);

  ply_trace ("loading logo image");
  if (!ply_image_load (plugin->logo_image))
    return false;

  ply_trace ("loading star image");
  if (!ply_image_load (plugin->star_image))
    return false;

  ply_trace ("loading lock image");
  if (!ply_image_load (plugin->lock_image))
    return false;

  ply_trace ("loading bullet image");
  if (!ply_image_load (plugin->bullet_image))
    return false;

  ply_trace ("loading entry image");
  if (!ply_image_load (plugin->entry_image))
    return false;

  ply_trace ("opening frame buffer");
  if (!ply_frame_buffer_open (plugin->frame_buffer))
    {
      ply_event_loop_stop_watching_for_exit (plugin->loop, (ply_event_loop_exit_handler_t)
                                             detach_from_event_loop,
                                             plugin);
      return false;
    }

  plugin->window = window;

  if (!ply_window_set_mode (plugin->window, PLY_WINDOW_MODE_GRAPHICS))
    return false;

  ply_event_loop_watch_signal (plugin->loop,
                               SIGINT,
                               (ply_event_handler_t) 
                               on_interrupt, plugin);
  
  ply_trace ("starting boot animation");
  start_animation (plugin);

  return true;
}

static void
add_star (ply_boot_splash_plugin_t *plugin)
{
  ply_frame_buffer_area_t area, logo_area;
  star_t *star;
  int x, y;
  int width, height;
  ply_list_node_t *node;

  assert (plugin != NULL);

  ply_frame_buffer_get_size (plugin->frame_buffer, &area);
  width = ply_image_get_width (plugin->logo_image);
  height = ply_image_get_height (plugin->logo_image);
  logo_area.x = (area.width / 2) - (width / 2);
  logo_area.y = (area.height / 2) - (height / 2);
  logo_area.width = width;
  logo_area.height = height;

  width = ply_image_get_width (plugin->star_image);
  height = ply_image_get_height (plugin->star_image);

  node = NULL;
  do
    {
      x = rand () % area.width;
      y = rand () % area.height;

      if ((x <= logo_area.x + logo_area.width)
           && (x >= logo_area.x)
          && (y >= logo_area.y)
           && (y <= logo_area.y + logo_area.height))
          continue;

      if ((x + width >= logo_area.x)
           && (x + width <= logo_area.x + logo_area.width)
          && (y + height >= logo_area.y)
           && (y + height <= logo_area.y + logo_area.height))
          continue;

      node = ply_list_get_first_node (plugin->stars);
      while (node != NULL)
        {
          ply_list_node_t *next_node;

          star = (star_t *) ply_list_node_get_data (node);
          next_node = ply_list_get_next_node (plugin->stars, node);

          if ((x <= star->x + width)
               && (x >= star->x)
              && (y >= star->y)
               && (y <= star->y + height))
              break;

          if ((x + width >= star->x)
               && (x + width <= star->x + width)
              && (y + height >= star->y)
               && (y + height <= star->y + height))
              break;

          node = next_node;
        }

    } while (node != NULL);

  star = star_new (x, y, (double) ((rand () % 50) + 1));
  ply_list_append_data (plugin->stars, star);
}

void
update_status (ply_boot_splash_plugin_t *plugin,
               const char               *status)
{
  assert (plugin != NULL);

  add_star (plugin);
}

void
hide_splash_screen (ply_boot_splash_plugin_t *plugin,
                    ply_event_loop_t         *loop,
                    ply_window_t             *window)
{
  assert (plugin != NULL);

  if (plugin->loop != NULL)
    {
      stop_animation (plugin);

      ply_event_loop_stop_watching_for_exit (plugin->loop, (ply_event_loop_exit_handler_t)
                                             detach_from_event_loop,
                                             plugin);
      detach_from_event_loop (plugin);
    }

  ply_frame_buffer_close (plugin->frame_buffer);
  ply_window_set_mode (plugin->window, PLY_WINDOW_MODE_TEXT);
}
static void
draw_password_entry (ply_boot_splash_plugin_t *plugin)
{
  ply_frame_buffer_area_t lock_area, entry_area, bullet_area;
  uint32_t *lock_data, *entry_data, *bullet_data;
  int x, y, i;

  ply_frame_buffer_pause_updates (plugin->frame_buffer);
  entry_data = ply_image_get_data (plugin->entry_image);
  entry_area.width = ply_image_get_width (plugin->entry_image);
  entry_area.height = ply_image_get_height (plugin->entry_image);
  entry_area.x = plugin->entry->x;
  entry_area.y = plugin->entry->y;

  ply_frame_buffer_fill_with_argb32_data (plugin->frame_buffer,
                                          &entry_area, 0, 0,
                                          entry_data);

  lock_data = ply_image_get_data (plugin->lock_image);
  lock_area.width = ply_image_get_width (plugin->lock_image);
  lock_area.height = ply_image_get_height (plugin->lock_image);

  x = plugin->entry->x - lock_area.width;
  y = plugin->entry->y + entry_area.height / 2.0 - lock_area.height / 2.0;

  lock_area.x = x;
  lock_area.y = y;
  ply_frame_buffer_fill_with_argb32_data (plugin->frame_buffer,
                                          &lock_area, 0, 0,
                                          lock_data);


  bullet_data = ply_image_get_data (plugin->bullet_image);
  bullet_area.width = ply_image_get_width (plugin->bullet_image);
  bullet_area.height = ply_image_get_height (plugin->bullet_image);

  for (i = 0; i < plugin->entry->number_of_bullets; i++)
    {
      bullet_area.x = plugin->entry->x + (i + 1) * bullet_area.width;
      bullet_area.y = plugin->entry->y + entry_area.height / 2.0 - bullet_area.height / 2.0;

      ply_frame_buffer_fill_with_argb32_data (plugin->frame_buffer,
                                              &bullet_area, 0, 0,
                                              bullet_data);
    }
  ply_frame_buffer_unpause_updates (plugin->frame_buffer);
}

static void
show_password_entry (ply_boot_splash_plugin_t *plugin)
{
  ply_frame_buffer_area_t area;
  int x, y;
  int lock_width, lock_height;
  int entry_width, entry_height;

  assert (plugin != NULL);

  ply_frame_buffer_get_size (plugin->frame_buffer, &area);
  lock_width = ply_image_get_width (plugin->lock_image);
  lock_height = ply_image_get_height (plugin->lock_image);

  entry_width = ply_image_get_width (plugin->entry_image);
  entry_height = ply_image_get_height (plugin->entry_image);

  x = area.width / 2.0 - (lock_width + entry_width) / 2.0 + lock_width;
  y = area.height / 2.0 - entry_height / 2.0;

  plugin->entry = entry_new (x, y);
  ply_frame_buffer_fill_with_color (plugin->frame_buffer, NULL,
                                    0.1, 0.1, .7, 1.0);
  draw_password_entry (plugin);
}

void
ask_for_password (ply_boot_splash_plugin_t *plugin,
                  ply_boot_splash_password_answer_handler_t answer_handler,
                  void *answer_data)
{
  plugin->password_answer_handler = answer_handler;
  plugin->password_answer_data = answer_data;

  stop_animation (plugin);
  show_password_entry (plugin);
}

void
on_keyboard_input (ply_boot_splash_plugin_t *plugin,
                   const char               *keyboard_input)
{

  ssize_t character_size;

  character_size = (ssize_t) mbrlen (keyboard_input, MB_CUR_MAX, NULL);

  if (character_size < 0)
    return;

  if (plugin->password_answer_handler == NULL)
    return;

  if (character_size == 1 && keyboard_input[0] == '\r')
    {
      plugin->password_answer_handler (plugin->password_answer_data,
                                       ply_buffer_get_bytes (plugin->keyboard_input_buffer));
      ply_buffer_clear (plugin->keyboard_input_buffer);
      plugin->password_answer_handler = NULL;

      start_animation (plugin);
      return;
    }

  ply_buffer_append_bytes (plugin->keyboard_input_buffer,
                           keyboard_input, character_size);

  plugin->entry->number_of_bullets++;
  draw_password_entry (plugin);
}

ply_boot_splash_plugin_interface_t *
ply_boot_splash_plugin_get_interface (void)
{
  static ply_boot_splash_plugin_interface_t plugin_interface =
    {
      .create_plugin = create_plugin,
      .destroy_plugin = destroy_plugin,
      .show_splash_screen = show_splash_screen,
      .update_status = update_status,
      .hide_splash_screen = hide_splash_screen,
      .ask_for_password = ask_for_password,
      .on_keyboard_input = on_keyboard_input
    };

  return &plugin_interface;
}

/* vim: set ts=4 sw=4 expandtab autoindent cindent cino={.5s,(0: */