code.delx.au - refind/blob - refind/icns.c

   1 /*
   2  * refit/icns.c
   3  * Loader for .icns icon files
   4  *
   5  * Copyright (c) 2006-2007 Christoph Pfisterer
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are
  10  * met:
  11  *
  12  *  * Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  *  * Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  *  * Neither the name of Christoph Pfisterer nor the names of the
  21  *    contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "global.h"
  38 #include "lib.h"
  39 #include "icns.h"
  40 #include "config.h"
  41 #include "../refind/screen.h"
  42
  43 //
  44 // well-known icons
  45 //
  46
  47 typedef struct {
  48     EG_IMAGE    *Image;
  49     CHAR16      *FileName;
  50     UINTN       PixelSize;
  51 } BUILTIN_ICON;
  52
  53 BUILTIN_ICON BuiltinIconTable[BUILTIN_ICON_COUNT] = {
  54    { NULL, L"func_about.icns", 48 },
  55    { NULL, L"func_reset.icns", 48 },
  56    { NULL, L"func_shutdown.icns", 48 },
  57    { NULL, L"func_exit.icns", 48 },
  58    { NULL, L"tool_shell.icns", 48 },
  59    { NULL, L"tool_part.icns", 48 },
  60    { NULL, L"tool_rescue.icns", 48 },
  61    { NULL, L"tool_apple_rescue.icns", 48 },
  62    { NULL, L"tool_mok_tool.icns", 48 },
  63    { NULL, L"vol_internal.icns", 32 },
  64    { NULL, L"vol_external.icns", 32 },
  65    { NULL, L"vol_optical.icns", 32 },
  66 };
  67
  68 EG_IMAGE * BuiltinIcon(IN UINTN Id)
  69 {
  70     CHAR16 FileName[256];
  71
  72     if (Id >= BUILTIN_ICON_COUNT)
  73         return NULL;
  74
  75     if (BuiltinIconTable[Id].Image == NULL) {
  76         SPrint(FileName, 255, L"%s\\%s", GlobalConfig.IconsDir ? GlobalConfig.IconsDir : DEFAULT_ICONS_DIR,
  77                BuiltinIconTable[Id].FileName);
  78         BuiltinIconTable[Id].Image = LoadIcnsFallback(SelfDir, FileName, BuiltinIconTable[Id].PixelSize);
  79     } // if
  80
  81     return BuiltinIconTable[Id].Image;
  82 }
  83
  84 // Construct filename for all valid icon extensions and try to load it.
  85 // Returns image data or NULL if it can't be found.
  86 static EG_IMAGE * LoadIconAnyFormat(IN CHAR16 *IconsDir, IN CHAR16 *BaseName, IN CHAR16 *OsName) {
  87    CHAR16     FileName[256];
  88    CHAR16     *Extension;
  89    EG_IMAGE   *Image = NULL;
  90    UINTN      Index = 0;
  91
  92    while (((Extension = FindCommaDelimited(ICON_EXTENSIONS, Index++)) != NULL) && (Image == NULL)) {
  93       SPrint(FileName, 255, L"%s\\%s_%s.%s", IconsDir, BaseName, OsName, Extension);
  94
  95       // try to load it
  96       Image = egLoadIcon(SelfDir, FileName, 128);
  97       MyFreePool(Extension);
  98    } // while()
  99    return Image;
 100 } // EG_IMAGE * LoadIconAnyFormat()
 101
 102 //
 103 // Load an icon for an operating system
 104 //
 105
 106 // Load an OS icon from among the comma-delimited list provided in OSIconName.
 107 // Searches for icons with extensions in the ICON_EXTENSIONS list (via
 108 // LoadIconAnyFormat()).
 109 // Returns image data. On failure, returns an ugly "dummy" icon.
 110 EG_IMAGE * LoadOSIcon(IN CHAR16 *OSIconName OPTIONAL, IN CHAR16 *FallbackIconName, BOOLEAN BootLogo)
 111 {
 112     EG_IMAGE        *Image = NULL;
 113     CHAR16          *CutoutName;
 114     UINTN           Index = 0;
 115
 116     if (GlobalConfig.TextOnly)      // skip loading if it's not used anyway
 117         return NULL;
 118
 119     // try the names from OSIconName
 120     while (((CutoutName = FindCommaDelimited(OSIconName, Index++)) != NULL) && (Image == NULL)) {
 121        Image = LoadIconAnyFormat(GlobalConfig.IconsDir ? GlobalConfig.IconsDir : DEFAULT_ICONS_DIR,
 122                                  BootLogo ? L"boot" : L"os", CutoutName);
 123        MyFreePool(CutoutName);
 124     } // while()
 125
 126     // try the fallback name
 127     if (Image == NULL)
 128        Image = LoadIconAnyFormat(GlobalConfig.IconsDir ? GlobalConfig.IconsDir : DEFAULT_ICONS_DIR,
 129                                  BootLogo ? L"boot" : L"os", FallbackIconName);
 130
 131     // try the fallback name with os_ instead of boot_
 132     if (BootLogo && (Image == NULL))
 133        Image = LoadIconAnyFormat(GlobalConfig.IconsDir ? GlobalConfig.IconsDir : DEFAULT_ICONS_DIR,
 134                                  L"os", FallbackIconName);
 135
 136     if (Image != NULL)
 137         return Image;
 138     else
 139        return DummyImage(128);
 140 } /* EG_IMAGE * LoadOSIcon() */
 141
 142
 143 //
 144 // Load an image from a .icns file
 145 //
 146
 147 EG_IMAGE * LoadIcns(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN UINTN PixelSize)
 148 {
 149     if (GlobalConfig.TextOnly)      // skip loading if it's not used anyway
 150         return NULL;
 151     return egLoadIcon(BaseDir, FileName, PixelSize);
 152 }
 153
 154 static EG_PIXEL BlackPixel  = { 0x00, 0x00, 0x00, 0 };
 155 //static EG_PIXEL YellowPixel = { 0x00, 0xff, 0xff, 0 };
 156
 157 EG_IMAGE * DummyImage(IN UINTN PixelSize)
 158 {
 159     EG_IMAGE        *Image;
 160     UINTN           x, y, LineOffset;
 161     CHAR8           *Ptr, *YPtr;
 162
 163     Image = egCreateFilledImage(PixelSize, PixelSize, TRUE, &BlackPixel);
 164
 165     LineOffset = PixelSize * 4;
 166
 167     YPtr = (CHAR8 *)Image->PixelData + ((PixelSize - 32) >> 1) * (LineOffset + 4);
 168     for (y = 0; y < 32; y++) {
 169         Ptr = YPtr;
 170         for (x = 0; x < 32; x++) {
 171             if (((x + y) % 12) < 6) {
 172                 *Ptr++ = 0;
 173                 *Ptr++ = 0;
 174                 *Ptr++ = 0;
 175             } else {
 176                 *Ptr++ = 0;
 177                 *Ptr++ = 255;
 178                 *Ptr++ = 255;
 179             }
 180             *Ptr++ = 144;
 181         }
 182         YPtr += LineOffset;
 183     }
 184
 185     return Image;
 186 }
 187
 188 EG_IMAGE * LoadIcnsFallback(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN UINTN PixelSize)
 189 {
 190     EG_IMAGE *Image;
 191     if (GlobalConfig.TextOnly)      // skip loading if it's not used anyway
 192         return NULL;
 193
 194     Image = LoadIcns(BaseDir, FileName, PixelSize);
 195     if (Image == NULL) {
 196         Image = DummyImage(PixelSize);
 197     }
 198     return Image;
 199 }