BaseTools: support generating image package from BMP/JPEG/PNG files

BaseTools add support to generating image package from BMP/JPEG/PNG
files.
1) New file type *.idf Image definition file to describe HII image
resource. It is the ASCII text file, and includes one or more "#image
IMAGE_ID [TRANSPARENT] ImageFileName".
2) New IMAGE_TOKEN macro is used to refer to IMAGE_ID.
3) New AutoGen header file $(MODULE_NAME)ImgDefs.h to include the
generated ImageId definition.
4) New $(MODULE_NAME)Idf.hpk or $(MODULE_NAME)Images are generated
as the output binary HII image package.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

1 files changed, 159 insertions, 0 deletions

diff --git a/BaseTools/Source/Python/AutoGen/IdfClassObject.py b/BaseTools/Source/Python/AutoGen/IdfClassObject.py
new file mode 100644
index 0000000000..76bc6d1b93
--- /dev/null
+++ b/BaseTools/Source/Python/AutoGen/IdfClassObject.py
@@ -0,0 +1,159 @@
+## @file

+# This file is used to collect all defined strings in Image Definition files

+#

+# Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>

+# This program and the accompanying materials

+# are licensed and made available under the terms and conditions of the BSD License

+# which accompanies this distribution.  The full text of the license may be found at

+# http://opensource.org/licenses/bsd-license.php

+#

+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+##

+# Import Modules

+#

+import Common.EdkLogger as EdkLogger

+import StringIO

+from Common.BuildToolError import *

+from Common.String import GetLineNo

+from Common.Misc import PathClass

+from Common.LongFilePathSupport import LongFilePath

+import re

+import os

+

+IMAGE_TOKEN = re.compile('IMAGE_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)

+

+#

+# Value of different image information block types

+#

+EFI_HII_IIBT_END               = 0x00

+EFI_HII_IIBT_IMAGE_1BIT        = 0x10

+EFI_HII_IIBT_IMAGE_1BIT_TRANS  = 0x11

+EFI_HII_IIBT_IMAGE_4BIT        = 0x12

+EFI_HII_IIBT_IMAGE_4BIT_TRANS  = 0x13

+EFI_HII_IIBT_IMAGE_8BIT        = 0x14

+EFI_HII_IIBT_IMAGE_8BIT_TRANS  = 0x15

+EFI_HII_IIBT_IMAGE_24BIT       = 0x16

+EFI_HII_IIBT_IMAGE_24BIT_TRANS = 0x17

+EFI_HII_IIBT_IMAGE_JPEG        = 0x18

+EFI_HII_IIBT_IMAGE_PNG         = 0x19

+EFI_HII_IIBT_DUPLICATE         = 0x20

+EFI_HII_IIBT_SKIP2             = 0x21

+EFI_HII_IIBT_SKIP1             = 0x22

+EFI_HII_IIBT_EXT1              = 0x30

+EFI_HII_IIBT_EXT2              = 0x31

+EFI_HII_IIBT_EXT4              = 0x32

+

+#

+# Value of HII package type

+#

+EFI_HII_PACKAGE_TYPE_ALL           = 0x00

+EFI_HII_PACKAGE_TYPE_GUID          = 0x01

+EFI_HII_PACKAGE_FORMS              = 0x02

+EFI_HII_PACKAGE_STRINGS            = 0x04

+EFI_HII_PACKAGE_FONTS              = 0x05

+EFI_HII_PACKAGE_IMAGES             = 0x06

+EFI_HII_PACKAGE_SIMPLE_FONTS       = 0x07

+EFI_HII_PACKAGE_DEVICE_PATH        = 0x08

+EFI_HII_PACKAGE_KEYBOARD_LAYOUT    = 0x09

+EFI_HII_PACKAGE_ANIMATIONS         = 0x0A

+EFI_HII_PACKAGE_END                = 0xDF

+EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN  = 0xE0

+EFI_HII_PACKAGE_TYPE_SYSTEM_END    = 0xFF

+

+class IdfFileClassObject(object):

+    def __init__(self, FileList = []):

+        self.FileList = FileList

+        self.ImageFilesDict = {}

+        self.ImageIDList = []

+        if len(self.FileList) > 0:

+            self.LoadIdfFiles(FileList)

+

+    def LoadIdfFiles(self, FileList):

+        if len(FileList) > 0:

+            for File in FileList:

+                self.LoadIdfFile(File)

+

+    def LoadIdfFile(self, File = None):

+        if File == None:

+            EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'No Image definition file is given.')

+        self.File = File

+

+        try:

+            IdfFile = open(LongFilePath(File.Path), mode='r')

+            FileIn = IdfFile.read()

+            IdfFile.close()

+        except:

+            EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File)

+

+        ImageFileList = []

+        for Line in FileIn.splitlines():

+            Line = Line.strip()

+            Line = self.StripComments(Line)

+            if len(Line) == 0:

+                continue

+

+            if Line.find('#image ') >= 0:

+                LineDetails = Line.split()

+                LineNo = GetLineNo(FileIn, Line, False)

+                Len = len(LineDetails)

+                if Len != 3 and Len != 4:

+                    EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The format is not match #image IMAGE_ID [TRANSPARENT] ImageFileName in Line %s of File %s.' % (LineNo, File.Path))

+                if Len == 4 and LineDetails[2] != 'TRANSPARENT':

+                    EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'Please use the keyword "TRANSPARENT" to describe the transparency setting in Line %s of File %s.' % (LineNo, File.Path))

+                MatchString = re.match('^[a-zA-Z][a-zA-Z0-9_]*$', LineDetails[1], re.UNICODE)

+                if MatchString == None or MatchString.end(0) != len(LineDetails[1]):

+                    EdkLogger.error('Image Definition  File Parser', FORMAT_INVALID, 'The Image token name %s defined in Idf file %s contains the invalid character.' % (LineDetails[1], File.Path))

+                if LineDetails[1] not in self.ImageIDList:

+                    self.ImageIDList.append(LineDetails[1])

+                else:

+                    EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The %s in Line %s of File %s is already defined.' % (LineDetails[1], LineNo, File.Path))

+                if Len == 4:

+                    ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], True)

+                else:

+                    ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], False)

+                ImageFileList.append(ImageFile)

+        if ImageFileList:

+            self.ImageFilesDict[File] = ImageFileList

+

+    def StripComments(self, Line):

+        Comment = '//'

+        CommentPos = Line.find(Comment)

+        while CommentPos >= 0:

+        # if there are non matched quotes before the comment header

+        # then we are in the middle of a string

+        # but we need to ignore the escaped quotes and backslashes.

+            if ((Line.count('"', 0, CommentPos) - Line.count('\\"', 0, CommentPos)) & 1) == 1:

+                CommentPos = Line.find (Comment, CommentPos + 1)

+            else:

+                return Line[:CommentPos].strip()

+        return Line.strip()

+

+    def ImageDecoder(self, File):

+        pass

+

+def SearchImageID(ImageFileObject, FileList):

+    if FileList == []:

+        return ImageFileObject

+

+    for File in FileList:

+        if os.path.isfile(File):

+            Lines = open(File, 'r')

+            for Line in Lines:

+                ImageIdList = IMAGE_TOKEN.findall(Line)

+                for ID in ImageIdList:

+                    EdkLogger.debug(EdkLogger.DEBUG_5, "Found ImageID identifier: " + ID)

+                    ImageFileObject.SetImageIDReferenced(ID)

+

+class ImageFileObject(object):

+    def __init__(self, FileName, ImageID, TransParent = False):

+        self.FileName = FileName

+        self.File = ''

+        self.ImageID = ImageID

+        self.TransParent = TransParent

+        self.Referenced = False

+

+    def SetImageIDReferenced(self, ImageID):

+        if ImageID == self.ImageID:

+            self.Referenced = True