images/build_images.py

#!/usr/bin/env python
# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

'''
Prepares image resources into output folder, and generates final bitmap block
output file.

Usage:
  ./build_images.py <board-names>

  Use 'ALL' in <board-names> if you want to build every boards defined in
  configuration file.
'''

import copy
from collections import defaultdict
import glob
import Image
import os
import shutil
import subprocess
import sys
import yaml

ASSET_DIR = 'assets'
LOCALE_DIR = 'locale'
FONT_DIR = 'font'
PNG_FILES = '*.png'
SVG_FILES = '*.svg'

# YAML key names.
BOARDS_CONFIG = 'boards.yaml'
DEFAULT_NAME = '_DEFAULT_'
SCREEN_KEY = 'screen'
PANEL_KEY = 'panel'
SDCARD_KEY = 'sdcard'
BAD_USB3_KEY = 'bad_usb3'
PHY_REC_KEY = 'phy_rec'
LOCALES_KEY = 'locales'
HI_RES_KEY = 'hi_res'
TEXT_COLORS_KEY = 'text_colors'

# Set scale for each image. Key is image name and value is (x, y) where x is
# the width and the height relative to the screen size. For example, if
# SCALE_BASE is 1000, (500, 100) means the image will be scaled to 50.0% of
# the screen width and 10.0% of the screen height.
#
# These are supposed to be kept in sync with the numbers set in Depthcharge to
# avoid runtime scaling, which makes images blurry.
SCALE_BASE = 1000  # 100.0%
DEFAULT_ASSET_SCALE = (0, 169)
TEXT_HEIGHT = 36   #   3.6%
DEFAULT_TEXT_SCALE = (0, TEXT_HEIGHT)
ASSET_SCALES = {
    'arrow_left': DEFAULT_TEXT_SCALE,
    'arrow_right': DEFAULT_TEXT_SCALE,
    'chrome_logo': (0, 39),
    'divider_btm': (900, 0),
    'divider_top': (900, 0),
    'globe': DEFAULT_TEXT_SCALE,
    'InsertDevices': (0, 371),
    'RemoveDevices': (0, 371),
    'reserve_charging': (0, 117),
    'reserve_charging_empty': (0, 117),
}
TEXT_SCALES = {
    'tonorm': (0, 4 * TEXT_HEIGHT),
    'insert_sd_usb2': (0, 2 * TEXT_HEIGHT),
    'insert_usb2': (0, 2 * TEXT_HEIGHT),
    'os_broken': (0, 2 * TEXT_HEIGHT),
    'todev': (0, 4 * TEXT_HEIGHT),
    'todev_phyrec': (0, 4 * TEXT_HEIGHT),
    'tonorm': (0, 4 * TEXT_HEIGHT),
    'update': (0, 3 * TEXT_HEIGHT),
    'wrong_power_supply': (0, 4 * TEXT_HEIGHT),
    'navigate': (0, 2 * TEXT_HEIGHT),
    'disable_warn': (0, 2 * TEXT_HEIGHT),
    'enable_hint': (0, 2 * TEXT_HEIGHT),
    'confirm_hint': (0, 2 * TEXT_HEIGHT),
}
# Background colors
DEFAULT_BACKGROUND = (255, 255, 255)
CHARGE_BACKGROUND = (0, 0, 0)
BACKGROUND_COLORS = {
    'reserve_charging': CHARGE_BACKGROUND,
    'reserve_charging_empty': CHARGE_BACKGROUND,
}
ASSET_MAX_COLORS = 128


class BuildImageError(Exception):
  """The exception class for all errors generated during build image process"""
  pass


class Convert(object):
  """Converts assets, texts, URLs, and fonts to bitmap images"""

  DEFAULT_OUTPUT_EXT = '.bmp'

  replace_map = {
      'BadSD': '',
      'BadUSB': '',
      'InsertUSB': '',
      'RemoveDevices': '',
      'RemoveSD': '',
      'RemoveUSB': '',
      'boot_usb_only': '',
      'insert_sd_usb2': '',
      'insert_usb2': '',
      'insert_usb': '',
      'todev_phyrec': '',
      'reserve_charging': '',
      'reserve_charging_empty': '',
  }

  def __init__(self, board, config):
    """
    Args:
      board: a string, name of the board to use.
      config: a dictionary of configuration parameters.
    """
    self.board = board
    self.config = config
    self.set_dirs()
    self.set_screen()
    self.set_replace_map()
    self.set_locales()
    self.text_max_colors = self.config[TEXT_COLORS_KEY]

  def set_dirs(self):
    """Set output directory and stage directory"""
    output_base = os.getenv('OUTPUT', os.path.join('..', 'build'))
    self.output_dir = os.path.join(output_base, self.board)
    self.stage_dir = os.path.join(output_base, '.stage')

  def set_screen(self):
    """Set screen width and height"""
    self.screen_width, self.screen_height = self.config[SCREEN_KEY]

    self.stretch = (1, 1)
    if self.config[PANEL_KEY]:
      # Calculate 'stretch'. It's used to shrink images horizontally so that
      # resulting images will look proportional to the original image on the
      # stretched display. If the display is not stretched, meaning aspect
      # ratio is same as the screen where images were rendered (1366x766),
      # no shrinking is performed.
      panel_width, panel_height = self.config[PANEL_KEY]
      self.stretch = (self.screen_width * panel_height,
                      self.screen_height * panel_width)

    if self.stretch[0] > self.stretch[1]:
      raise BuildImageError('Panel aspect ratio (%f) is smaller than screen '
                            'aspect ratio (%f). It indicates screen will be '
                            'shrunk horizontally. It is currently unsupported.'
                            % (float(panel_width) / panel_height,
                               float(self.screen_width) / self.screen_height))

    # Set up square drawing area
    # TODO: Depthcharge should narrow the canvas if the screen is stretched.
    self.canvas_px = min(self.screen_width, self.screen_height)

  def set_replace_map(self):
    """Builds a map replacing images

    For each (key, value), image 'key' will be replaced by image 'value'
    """
    sdcard = self.config[SDCARD_KEY]
    bad_usb3 = self.config[BAD_USB3_KEY]
    physical_recovery = self.config[PHY_REC_KEY]

    if not sdcard:
      self.replace_map['BadDevices'] = 'BadUSB'
      self.replace_map['InsertDevices'] = 'InsertUSB'
      self.replace_map['insert'] = ('insert_usb2' if bad_usb3 else 'insert_usb')
      self.replace_map['boot_usb'] = 'boot_usb_only'
    elif bad_usb3:
      self.replace_map['insert'] = 'insert_sd_usb2'

    if physical_recovery:
      self.replace_map['todev'] = 'todev_phyrec'

    if os.getenv("DETACHABLE_UI") == "1":
      self.replace_map['VerificationOff'] = ''

  def set_locales(self):
    """Set a list of locales for which localized images are converted"""
    # LOCALES environment variable can overwrite boards.yaml
    locales = os.getenv('LOCALES')
    if locales:
      self.locales = locales.split()
    else:
      self.locales = self.config[LOCALES_KEY]
    self.hi_res_locales = self.config[HI_RES_KEY]

  def calculate_dimension(self, original, scale):
      """Calculate scaled width and height

      This imitates the function of Depthcharge with the same name.

      Args:
        original: (width, height) of the original image
        scale: (x, y) scale parameter relative to the canvas size using
            SCALE_BASE as a base.

      Returns:
        (width, height) of the scaled image
      """
      dim_width, dim_height = (0, 0)
      scale_x, scale_y = scale
      org_width, org_height = original

      if scale_x == 0 and scale_y == 0:
        raise BuildImageError('Invalid scale parameter: %s' % (scale))
      if scale_x > 0:
        dim_width = self.canvas_px * scale_x / SCALE_BASE
      if scale_y > 0:
        dim_height = self.canvas_px * scale_y / SCALE_BASE
      if scale_x == 0:
        dim_width = org_width * dim_height / org_height
      if scale_y == 0:
        dim_height = org_height * dim_width / org_width

      dim_width = dim_width * self.stretch[0] / self.stretch[1]

      return (dim_width, dim_height)

  def convert_to_bitmap(self, input, scale, background, output, max_colors):
    """Convert an image file to the bitmap format"""
    image = Image.open(input)

    # Process alpha channel and transparency.
    if image.mode == 'RGBA':
      target = Image.new('RGB', image.size, background)
      image.load()  # required for image.split()
      mask = image.split()[-1]
      target.paste(image, mask=mask)
    elif (image.mode == 'P') and ('transparency' in image.info):
      exit('Sorry, PNG with RGBA palette is not supported.')
    elif image.mode != 'RGB':
      target = image.convert('RGB')
    else:
      target = image

    # Process scaling
    if scale:
      new_size = self.calculate_dimension(image.size, scale)
      if new_size[0] == 0 or new_size[1] == 0:
        print 'Scaling', input
        print 'Warning: width or height is 0 after resizing:',
        print 'scale=%s size=%s stretch=%s new_size=%s' % (
              scale, image.size, self.stretch, new_size)
        return
      target = target.resize(new_size, Image.ANTIALIAS)

    # Export and downsample color space.
    target.convert('P', dither=None, colors=max_colors, palette=Image.ADAPTIVE
                   ).save(output)

  def convert(self, input, output_dir, scales, max_colors):
    """Convert file(s) to bitmap format"""
    files = glob.glob(input)
    if not files:
      raise BuildImageError('Unable to find file(s): %s' % input)

    for file in files:
      name, ext = os.path.splitext(os.path.basename(file))
      output = os.path.join(output_dir, name + self.DEFAULT_OUTPUT_EXT)

      background = DEFAULT_BACKGROUND
      if name in BACKGROUND_COLORS:
        background = BACKGROUND_COLORS[name]

      scale = scales[name]

      if name in self.replace_map:
        name = self.replace_map[name]
        if not name:
          continue
        print 'Replace: %s => %s' % (file, name)
        file = os.path.join(os.path.dirname(file), name + ext)

      self.convert_to_bitmap(file, scale, background, output, max_colors)

  def convert_assets(self):
    """Convert images in assets folder"""
    scales = defaultdict(lambda: DEFAULT_ASSET_SCALE)
    scales.update(ASSET_SCALES)
    self.convert(os.path.join(ASSET_DIR, PNG_FILES), self.output_dir,
                 scales, ASSET_MAX_COLORS)

  def convert_url(self):
    """Convert URL and arrows"""
    # URL and arrows should be default height
    scales = defaultdict(lambda: DEFAULT_TEXT_SCALE)
    files = os.path.join(self.stage_dir, PNG_FILES)
    self.convert(files, self.output_dir, scales, self.text_max_colors)

  def convert_texts(self):
    """Convert localized texts"""
    locale_dir = os.path.join(self.stage_dir, LOCALE_DIR)
    # Using stderr to report progress synchronously
    sys.stderr.write('  processing:')
    for locale in self.locales:
      output_dir = os.path.join(self.output_dir, LOCALE_DIR, locale)
      if locale in self.hi_res_locales:
        scales = defaultdict(lambda: DEFAULT_TEXT_SCALE)
        scales.update(TEXT_SCALES)
      else:
        # We use low-res images for these locales and turn off scaling
        # to make the files fit in a ROM. Note that these text images will
        # be scaled by Depthcharge to be the same height as hi-res texts.
        locale += '/lo'
        scales = defaultdict(lambda: None)
      sys.stderr.write(' ' + locale)
      os.makedirs(output_dir)
      self.convert(os.path.join(locale_dir, locale, PNG_FILES),
                   output_dir, scales, self.text_max_colors)
    sys.stderr.write('\n')

  def convert_fonts(self):
    """Convert font images"""
    scales = defaultdict(lambda: DEFAULT_TEXT_SCALE)
    font_dir = os.path.join(self.stage_dir, FONT_DIR)
    files = os.path.join(font_dir, PNG_FILES)
    font_output_dir = os.path.join(self.output_dir, FONT_DIR)
    os.makedirs(font_output_dir)
    self.convert(files, font_output_dir, scales, self.text_max_colors)

  def create_locale_list(self):
    """Create locale list"""
    with open(os.path.join(self.output_dir, 'locales'), 'w') as locale_list:
      locale_list.write('\n'.join(self.locales))

  def build_image(self):
    """Builds all images required by a board"""
    # Clean up output directory
    if os.path.exists(self.output_dir):
      shutil.rmtree(self.output_dir)
    os.makedirs(self.output_dir)

    print 'Converting asset images...'
    self.convert_assets()

    if not os.path.exists(self.stage_dir):
      raise BuildImageError('Missing stage folder. Run make in strings dir.')

    print 'Converting URL images...'
    self.convert_url()

    print 'Converting localized text images...'
    self.convert_texts()

    print 'Creating locale list file...'
    self.create_locale_list()

    print 'Converting fonts...'
    self.convert_fonts()


def load_boards_config(filename):
  """Loads the configuration of all boards from a YAML file

  Args:
    filename: file name of a YAML config file.

  Returns:
    A dictionary with keys as board names and values as config parameters.
  """
  with open(filename, 'r') as file:
    raw = yaml.load(file)

  configs = {}
  default = raw[DEFAULT_NAME]
  if not default:
    raise BuildImageError('Default configuration is not found')
  for boards, params in raw.iteritems():
    if boards == DEFAULT_NAME:
      continue
    config = copy.deepcopy(default)
    if params:
      config.update(params)
    for board in boards.replace(',', ' ').split():
      configs[board] = config

  return configs


def main(args):
  """Entry point when executed from command line

  Args:
    args: a list, boards to build. None for all boards.
  """
  configs = load_boards_config(BOARDS_CONFIG)

  targets = args
  if not targets:
    targets = configs.keys()

  print 'Building for', ', '.join(targets)

  for board in targets:
    if board not in configs:
      raise BuildImageError('%s not found in %s' % (board, BOARDS_CONFIG))
    print 'Building for', board
    convert = Convert(board, configs[board])
    convert.build_image()


if __name__ == '__main__':
  try:
    main(sys.argv[1:])
  except BuildImageError, err:
    sys.stderr.write("ERROR: %s\n" % err)