]> git.proxmox.com Git - mirror_edk2.git/commitdiff
BaseTools: support generating image package from BMP/JPEG/PNG files
authorYonghong Zhu <yonghong.zhu@intel.com>
Wed, 21 Sep 2016 02:39:11 +0000 (10:39 +0800)
committerLiming Gao <liming.gao@intel.com>
Tue, 27 Sep 2016 01:43:28 +0000 (09:43 +0800)
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>
BaseTools/Conf/build_rule.template
BaseTools/Source/Python/AutoGen/AutoGen.py
BaseTools/Source/Python/AutoGen/GenC.py
BaseTools/Source/Python/AutoGen/IdfClassObject.py [new file with mode: 0644]
BaseTools/Source/Python/AutoGen/StrGather.py
BaseTools/Source/Python/Common/DataType.py

index 7e2c6a96583dbd1a52b9b8b905ab7d5765ed461a..1db94b696f898c65c995c7da08cdcd8e6c592bd0 100755 (executable)
 \r
     <Command>\r
 \r
+[Image-Definition-File]\r
+    <InputFile>\r
+        *.idf, *.Idf, *.IDF\r
+\r
+    <OutputFile>\r
+        $(DEBUG_DIR)(+)AutoGen.c\r
+        $(DEBUG_DIR)(+)$(MODULE_NAME)ImgDefs.h\r
+        $(OUTPUT_DIR)(+)$(MODULE_NAME)Idf.hpk\r
+\r
+    <Command>\r
+\r
 [Efi-Image.UEFI_OPTIONROM]\r
     <InputFile>\r
         ?.efi, ?.EFI, ?.Efi\r
 \r
     <Command>\r
 \r
+[Image-Definition-File.UEFI_HII]\r
+    <InputFile>\r
+        *.idf, *.Idf, *.IDF\r
+\r
+    <OutputFile>\r
+        $(DEBUG_DIR)(+)$(MODULE_NAME)ImgDefs.h\r
+        $(OUTPUT_DIR)(+)$(MODULE_NAME)Idf.hpk\r
+\r
+    <Command>\r
+\r
 [Visual-Form-Representation-File.UEFI_HII]\r
     <InputFile>\r
         ?.vfr\r
index 79bc7c6ced839c091002011a75b43f4c7e1bb412..f35ae252b0c6cbd13a2f584af63932f3be4bc864 100644 (file)
@@ -72,7 +72,8 @@ gAutoGenHeaderFileName = "AutoGen.h"
 gAutoGenStringFileName = "%(module_name)sStrDefs.h"\r
 gAutoGenStringFormFileName = "%(module_name)sStrDefs.hpk"\r
 gAutoGenDepexFileName = "%(module_name)s.depex"\r
-\r
+gAutoGenImageDefFileName = "%(module_name)sImgDefs.h"\r
+gAutoGenIdfFileName = "%(module_name)sIdf.hpk"\r
 gInfSpecVersion = "0x00010017"\r
 \r
 #\r
@@ -2590,6 +2591,7 @@ class ModuleAutoGen(AutoGen):
         self._IncludePathLength = 0\r
         self._AutoGenFileList = None\r
         self._UnicodeFileList = None\r
+        self._IdfFileList = None\r
         self._SourceFileList  = None\r
         self._ObjectFileList  = None\r
         self._BinaryFileList  = None\r
@@ -3114,6 +3116,15 @@ class ModuleAutoGen(AutoGen):
                 self._UnicodeFileList = []\r
         return self._UnicodeFileList\r
 \r
+    ## Return the list of Image Definition files\r
+    def _GetIdfFileList(self):\r
+        if self._IdfFileList == None:\r
+            if TAB_IMAGE_FILE in self.FileTypes:\r
+                self._IdfFileList = self.FileTypes[TAB_IMAGE_FILE]\r
+            else:\r
+                self._IdfFileList = []\r
+        return self._IdfFileList\r
+\r
     ## Return a list of files which can be built from binary\r
     #\r
     #  "Build" binary files are just to copy them to build directory.\r
@@ -3276,15 +3287,19 @@ class ModuleAutoGen(AutoGen):
     #\r
     def _GetAutoGenFileList(self):\r
         UniStringAutoGenC = True\r
+        IdfStringAutoGenC = True\r
         UniStringBinBuffer = StringIO()\r
+        IdfGenBinBuffer = StringIO()\r
         if self.BuildType == 'UEFI_HII':\r
             UniStringAutoGenC = False\r
+            IdfStringAutoGenC = False\r
         if self._AutoGenFileList == None:\r
             self._AutoGenFileList = {}\r
             AutoGenC = TemplateString()\r
             AutoGenH = TemplateString()\r
             StringH = TemplateString()\r
-            GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer)\r
+            StringIdf = TemplateString()\r
+            GenC.CreateCode(self, AutoGenC, AutoGenH, StringH, UniStringAutoGenC, UniStringBinBuffer, StringIdf, IdfStringAutoGenC, IdfGenBinBuffer)\r
             #\r
             # AutoGen.c is generated if there are library classes in inf, or there are object files\r
             #\r
@@ -3308,6 +3323,17 @@ class ModuleAutoGen(AutoGen):
                 self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
             if UniStringBinBuffer != None:\r
                 UniStringBinBuffer.close()\r
+            if str(StringIdf) != "":\r
+                AutoFile = PathClass(gAutoGenImageDefFileName % {"module_name":self.Name}, self.DebugDir)\r
+                self._AutoGenFileList[AutoFile] = str(StringIdf)\r
+                self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
+            if IdfGenBinBuffer != None and IdfGenBinBuffer.getvalue() != "":\r
+                AutoFile = PathClass(gAutoGenIdfFileName % {"module_name":self.Name}, self.OutputDir)\r
+                self._AutoGenFileList[AutoFile] = IdfGenBinBuffer.getvalue()\r
+                AutoFile.IsBinary = True\r
+                self._ApplyBuildRule(AutoFile, TAB_UNKNOWN_FILE)\r
+            if IdfGenBinBuffer != None:\r
+                IdfGenBinBuffer.close()\r
         return self._AutoGenFileList\r
 \r
     ## Return the list of library modules explicitly or implicityly used by this module\r
@@ -4061,6 +4087,7 @@ class ModuleAutoGen(AutoGen):
     CodaTargetList  = property(_GetFinalTargetList)\r
     FileTypes       = property(_GetFileTypes)\r
     BuildRules      = property(_GetBuildRules)\r
+    IdfFileList     = property(_GetIdfFileList)\r
 \r
     DependentPackageList    = property(_GetDependentPackageList)\r
     DependentLibraryList    = property(_GetLibraryList)\r
index 29951e39690d4cc5d6374e7e37dc6930065d2daa..8089e3aae3d2d08d0ac67355dfcb79d1598a6200 100644 (file)
@@ -14,7 +14,8 @@
 ## Import Modules\r
 #\r
 import string\r
-\r
+import collections\r
+import struct\r
 from Common import EdkLogger\r
 \r
 from Common.BuildToolError import *\r
@@ -23,6 +24,7 @@ from Common.Misc import *
 from Common.String import StringToArray\r
 from StrGather import *\r
 from GenPcdDb import CreatePcdDatabaseCode\r
+from IdfClassObject import *\r
 \r
 ## PCD type string\r
 gItemTypeStringDatabase  = {\r
@@ -1619,6 +1621,232 @@ def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuff
         AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r
     os.chdir(WorkingDir)\r
 \r
+def CreateIdfFileCode(Info, AutoGenC, StringH, IdfGenCFlag, IdfGenBinBuffer):\r
+    if len(Info.IdfFileList) > 0:\r
+        ImageFiles = IdfFileClassObject(sorted (Info.IdfFileList))\r
+        if ImageFiles.ImageFilesDict:\r
+            Index = 1\r
+            PaletteIndex = 1\r
+            IncList = [Info.MetaFile.Dir]\r
+            SrcList = [F for F in Info.SourceFileList]\r
+            SkipList = ['.jpg', '.png', '.bmp', '.inf', '.idf']\r
+            FileList = GetFileList(SrcList, IncList, SkipList)\r
+            ValueStartPtr = 60\r
+            StringH.Append("\n//\n//Image ID\n//\n")\r
+            ImageInfoOffset = 0\r
+            PaletteInfoOffset = 0\r
+            ImageBuffer = pack('x')\r
+            PaletteBuffer = pack('x')\r
+            BufferStr = ''\r
+            PaletteStr = ''\r
+            for Idf in ImageFiles.ImageFilesDict:\r
+                if ImageFiles.ImageFilesDict[Idf]:\r
+                    for FileObj in ImageFiles.ImageFilesDict[Idf]:\r
+                        for sourcefile in Info.SourceFileList:\r
+                            if FileObj.FileName == sourcefile.File:\r
+                                if not sourcefile.Ext.upper() in ['.PNG', '.BMP', '.JPG']:\r
+                                    EdkLogger.error("build", AUTOGEN_ERROR, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj.FileName), ExtraData="[%s]" % str(Info))\r
+                                FileObj.File = sourcefile\r
+                                break\r
+                        else:\r
+                            EdkLogger.error("build", AUTOGEN_ERROR, "The %s in %s is not defined in the driver's [Sources] section" % (FileObj.FileName, Idf), ExtraData="[%s]" % str(Info))\r
+\r
+                    for FileObj in ImageFiles.ImageFilesDict[Idf]:\r
+                        ID = FileObj.ImageID\r
+                        File = FileObj.File\r
+                        if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r
+                            EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=File.Path)\r
+                        SearchImageID (FileObj, FileList)\r
+                        if FileObj.Referenced:\r
+                            if (ValueStartPtr - len(DEFINE_STR + ID)) <= 0:\r
+                                Line = DEFINE_STR + ' ' + ID + ' ' + DecToHexStr(Index, 4) + '\n'\r
+                            else:\r
+                                Line = DEFINE_STR + ' ' + ID + ' ' * (ValueStartPtr - len(DEFINE_STR + ID)) + DecToHexStr(Index, 4) + '\n'\r
+\r
+                            TmpFile = open(File.Path, 'rb')\r
+                            Buffer = TmpFile.read()\r
+                            TmpFile.close()\r
+                            if File.Ext.upper() == '.PNG':\r
+                                TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_PNG)\r
+                                TempBuffer += pack('I', len(Buffer))\r
+                                TempBuffer += Buffer\r
+                            elif File.Ext.upper() == '.JPG':\r
+                                ImageType, = struct.unpack('4s', Buffer[6:10])\r
+                                if ImageType != 'JFIF':\r
+                                    EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard JPG file." % File.Path)\r
+                                TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_JPEG)\r
+                                TempBuffer += pack('I', len(Buffer))\r
+                                TempBuffer += Buffer\r
+                            elif File.Ext.upper() == '.BMP':\r
+                                TempBuffer, TempPalette = BmpImageDecoder(File, Buffer, PaletteIndex, FileObj.TransParent)\r
+                                if len(TempPalette) > 1:\r
+                                    PaletteIndex += 1\r
+                                    PaletteBuffer += pack('H', len(TempPalette))\r
+                                    PaletteBuffer += TempPalette\r
+                                    PaletteStr = WriteLine(PaletteStr, '// %s: %s: %s' % (DecToHexStr(PaletteIndex - 1, 4), ID, DecToHexStr(PaletteIndex - 1, 4)))\r
+                                    TempPaletteList = AscToHexList(TempPalette)\r
+                                    PaletteStr = WriteLine(PaletteStr, CreateArrayItem(TempPaletteList, 16) + '\n')\r
+                            ImageBuffer += TempBuffer\r
+                            BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r
+                            TempBufferList = AscToHexList(TempBuffer)\r
+                            BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r
+\r
+                            StringH.Append(Line)\r
+                            Index += 1\r
+\r
+            BufferStr = WriteLine(BufferStr, '// End of the Image Info')\r
+            BufferStr = WriteLine(BufferStr, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END, 2)) + '\n')\r
+            ImageEnd = pack('B', EFI_HII_IIBT_END)\r
+            ImageBuffer += ImageEnd\r
+\r
+            if len(ImageBuffer) > 1:\r
+                ImageInfoOffset = 12\r
+            if len(PaletteBuffer) > 1:\r
+                PaletteInfoOffset = 12 + len(ImageBuffer) - 1 # -1 is for the first empty pad byte of ImageBuffer\r
+\r
+            IMAGE_PACKAGE_HDR = pack('=II', ImageInfoOffset, PaletteInfoOffset)\r
+            # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length\r
+            if len(PaletteBuffer) > 1:\r
+                PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1 + 2 + len(PaletteBuffer) - 1\r
+            else:\r
+                PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1\r
+            if PaletteIndex > 1:\r
+                PALETTE_INFO_HEADER = pack('H', PaletteIndex - 1)\r
+            # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF\r
+            Hex_Length = '%06X' % PACKAGE_HEADER_Length\r
+            if PACKAGE_HEADER_Length > 0xFFFFFF:\r
+                EdkLogger.error("build", AUTOGEN_ERROR, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData="[%s]" % str(Info))\r
+            PACKAGE_HEADER = pack('=HBB', int('0x' + Hex_Length[2:], 16), int('0x' + Hex_Length[0:2], 16), EFI_HII_PACKAGE_IMAGES)\r
+\r
+            IdfGenBinBuffer.write(PACKAGE_HEADER)\r
+            IdfGenBinBuffer.write(IMAGE_PACKAGE_HDR)\r
+            if len(ImageBuffer) > 1 :\r
+                IdfGenBinBuffer.write(ImageBuffer[1:])\r
+            if PaletteIndex > 1:\r
+                IdfGenBinBuffer.write(PALETTE_INFO_HEADER)\r
+            if len(PaletteBuffer) > 1:\r
+                IdfGenBinBuffer.write(PaletteBuffer[1:])\r
+\r
+            if IdfGenCFlag:\r
+                TotalLength = EFI_HII_ARRAY_SIZE_LENGTH + PACKAGE_HEADER_Length\r
+                AutoGenC.Append("\n//\n//Image Pack Definition\n//\n")\r
+                AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + Info.Module.BaseName + 'Images' + '[] = {\n')\r
+                AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r
+                AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r
+                AllStr = WriteLine(AllStr, '// Image PACKAGE HEADER\n')\r
+                IMAGE_PACKAGE_HDR_List = AscToHexList(PACKAGE_HEADER)\r
+                IMAGE_PACKAGE_HDR_List += AscToHexList(IMAGE_PACKAGE_HDR)\r
+                AllStr = WriteLine(AllStr, CreateArrayItem(IMAGE_PACKAGE_HDR_List, 16) + '\n')\r
+                AllStr = WriteLine(AllStr, '// Image DATA\n')\r
+                if BufferStr:\r
+                    AllStr = WriteLine(AllStr, BufferStr)\r
+                if PaletteStr:\r
+                    AllStr = WriteLine(AllStr, '// Palette Header\n')\r
+                    PALETTE_INFO_HEADER_List = AscToHexList(PALETTE_INFO_HEADER)\r
+                    AllStr = WriteLine(AllStr, CreateArrayItem(PALETTE_INFO_HEADER_List, 16) + '\n')\r
+                    AllStr = WriteLine(AllStr, '// Palette Data\n')\r
+                    AllStr = WriteLine(AllStr, PaletteStr)\r
+                AllStr = WriteLine(AllStr, '};')\r
+                AutoGenC.Append(AllStr)\r
+                AutoGenC.Append("\n")\r
+                StringH.Append('\nextern unsigned char ' + Info.Module.BaseName + 'Images[];\n')\r
+                StringH.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info.Module.BaseName)\r
+\r
+# typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r
+#   EFI_HII_PACKAGE_HEADER  Header;          # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES\r
+#   UINT32                  ImageInfoOffset;\r
+#   UINT32                  PaletteInfoOffset;\r
+# } EFI_HII_IMAGE_PACKAGE_HDR;\r
+\r
+# typedef struct {\r
+#   UINT32   Length:24;\r
+#   UINT32   Type:8;\r
+#   UINT8    Data[];\r
+# } EFI_HII_PACKAGE_HEADER;\r
+\r
+# typedef struct _EFI_HII_IMAGE_BLOCK {\r
+#   UINT8    BlockType;\r
+#   UINT8    BlockBody[];\r
+# } EFI_HII_IMAGE_BLOCK;\r
+\r
+def BmpImageDecoder(File, Buffer, PaletteIndex, TransParent):\r
+    ImageType, = struct.unpack('2s', Buffer[0:2])\r
+    if ImageType!= 'BM': # BMP file type is 'BM'\r
+        EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard BMP file." % File.Path)\r
+    BMP_IMAGE_HEADER = collections.namedtuple('BMP_IMAGE_HEADER', ['bfSize','bfReserved1','bfReserved2','bfOffBits','biSize','biWidth','biHeight','biPlanes','biBitCount', 'biCompression', 'biSizeImage','biXPelsPerMeter','biYPelsPerMeter','biClrUsed','biClrImportant'])\r
+    BMP_IMAGE_HEADER_STRUCT = struct.Struct('IHHIIIIHHIIIIII')\r
+    BmpHeader = BMP_IMAGE_HEADER._make(BMP_IMAGE_HEADER_STRUCT.unpack_from(Buffer[2:]))\r
+    #\r
+    # Doesn't support compress.\r
+    #\r
+    if BmpHeader.biCompression != 0:\r
+        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The compress BMP file %s is not support." % File.Path)\r
+\r
+    # The Width and Height is UINT16 type in Image Package\r
+    if BmpHeader.biWidth > 0xFFFF:\r
+        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Width is exceed 0xFFFF." % File.Path)\r
+    if BmpHeader.biHeight > 0xFFFF:\r
+        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Height is exceed 0xFFFF." % File.Path)\r
+\r
+    PaletteBuffer = pack('x')\r
+    if BmpHeader.biBitCount == 1:\r
+        if TransParent:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS)\r
+        else:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT)\r
+        ImageBuffer += pack('B', PaletteIndex)\r
+        Width = (BmpHeader.biWidth + 7)/8\r
+        if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
+            PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
+    elif BmpHeader.biBitCount == 4:\r
+        if TransParent:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS)\r
+        else:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT)\r
+        ImageBuffer += pack('B', PaletteIndex)\r
+        Width = (BmpHeader.biWidth + 1)/2\r
+        if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
+            PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
+    elif BmpHeader.biBitCount == 8:\r
+        if TransParent:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS)\r
+        else:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT)\r
+        ImageBuffer += pack('B', PaletteIndex)\r
+        Width = BmpHeader.biWidth\r
+        if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
+            PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
+    elif BmpHeader.biBitCount == 24:\r
+        if TransParent:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS)\r
+        else:\r
+            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT)\r
+        Width = BmpHeader.biWidth * 3\r
+    else:\r
+        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData="[%s]" % str(File.Path))\r
+\r
+    ImageBuffer += pack('H', BmpHeader.biWidth)\r
+    ImageBuffer += pack('H', BmpHeader.biHeight)\r
+    Start = BmpHeader.bfOffBits\r
+    End = BmpHeader.bfSize - 1\r
+    for Height in range(0, BmpHeader.biHeight):\r
+        if Width % 4 != 0:\r
+            Start = End + (Width % 4) - 4 - Width\r
+        else:\r
+            Start = End - Width\r
+        ImageBuffer += Buffer[Start + 1 : Start + Width + 1]\r
+        End = Start\r
+\r
+    # handle the Palette info,  BMP use 4 bytes for R, G, B and Reserved info while EFI_HII_RGB_PIXEL only have the R, G, B info\r
+    if PaletteBuffer and len(PaletteBuffer) > 1:\r
+        PaletteTemp = pack('x')\r
+        for Index in range(0, len(PaletteBuffer)):\r
+            if Index % 4 == 3:\r
+                continue\r
+            PaletteTemp += PaletteBuffer[Index]\r
+        PaletteBuffer = PaletteTemp[1:]\r
+    return ImageBuffer, PaletteBuffer\r
+\r
 ## Create common code\r
 #\r
 #   @param      Info        The ModuleAutoGen object\r
@@ -1684,10 +1912,14 @@ def CreateFooterCode(Info, AutoGenC, AutoGenH):
 #   @param      Info        The ModuleAutoGen object\r
 #   @param      AutoGenC    The TemplateString object for C code\r
 #   @param      AutoGenH    The TemplateString object for header file\r
+#   @param      StringH     The TemplateString object for header file\r
 #   @param      UniGenCFlag     UniString is generated into AutoGen C file when it is set to True\r
 #   @param      UniGenBinBuffer Buffer to store uni string package data\r
+#   @param      StringIdf       The TemplateString object for header file\r
+#   @param      IdfGenCFlag     IdfString is generated into AutoGen C file when it is set to True\r
+#   @param      IdfGenBinBuffer Buffer to store Idf string package data\r
 #\r
-def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer):\r
+def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer, StringIdf, IdfGenCFlag, IdfGenBinBuffer):\r
     CreateHeaderCode(Info, AutoGenC, AutoGenH)\r
 \r
     if Info.AutoGenVersion >= 0x00010005:\r
@@ -1719,6 +1951,15 @@ def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer):
         StringH.Append("\n#endif\n")\r
         AutoGenH.Append('#include "%s"\n' % FileName)\r
 \r
+    if Info.IdfFileList:\r
+        FileName = "%sImgDefs.h" % Info.Name\r
+        StringIdf.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
+        StringIdf.Append(gAutoGenHPrologueString.Replace({'File':'IMAGEDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
+        CreateIdfFileCode(Info, AutoGenC, StringIdf, IdfGenCFlag, IdfGenBinBuffer)\r
+\r
+        StringIdf.Append("\n#endif\n")\r
+        AutoGenH.Append('#include "%s"\n' % FileName)\r
+\r
     CreateFooterCode(Info, AutoGenC, AutoGenH)\r
 \r
     # no generation of AutoGen.c for Edk modules without unicode file\r
diff --git a/BaseTools/Source/Python/AutoGen/IdfClassObject.py b/BaseTools/Source/Python/AutoGen/IdfClassObject.py
new file mode 100644 (file)
index 0000000..76bc6d1
--- /dev/null
@@ -0,0 +1,159 @@
+## @file\r
+# This file is used to collect all defined strings in Image Definition files\r
+#\r
+# Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
+# This program and the accompanying materials\r
+# are licensed and made available under the terms and conditions of the BSD License\r
+# which accompanies this distribution.  The full text of the license may be found at\r
+# http://opensource.org/licenses/bsd-license.php\r
+#\r
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+##\r
+# Import Modules\r
+#\r
+import Common.EdkLogger as EdkLogger\r
+import StringIO\r
+from Common.BuildToolError import *\r
+from Common.String import GetLineNo\r
+from Common.Misc import PathClass\r
+from Common.LongFilePathSupport import LongFilePath\r
+import re\r
+import os\r
+\r
+IMAGE_TOKEN = re.compile('IMAGE_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r
+\r
+#\r
+# Value of different image information block types\r
+#\r
+EFI_HII_IIBT_END               = 0x00\r
+EFI_HII_IIBT_IMAGE_1BIT        = 0x10\r
+EFI_HII_IIBT_IMAGE_1BIT_TRANS  = 0x11\r
+EFI_HII_IIBT_IMAGE_4BIT        = 0x12\r
+EFI_HII_IIBT_IMAGE_4BIT_TRANS  = 0x13\r
+EFI_HII_IIBT_IMAGE_8BIT        = 0x14\r
+EFI_HII_IIBT_IMAGE_8BIT_TRANS  = 0x15\r
+EFI_HII_IIBT_IMAGE_24BIT       = 0x16\r
+EFI_HII_IIBT_IMAGE_24BIT_TRANS = 0x17\r
+EFI_HII_IIBT_IMAGE_JPEG        = 0x18\r
+EFI_HII_IIBT_IMAGE_PNG         = 0x19\r
+EFI_HII_IIBT_DUPLICATE         = 0x20\r
+EFI_HII_IIBT_SKIP2             = 0x21\r
+EFI_HII_IIBT_SKIP1             = 0x22\r
+EFI_HII_IIBT_EXT1              = 0x30\r
+EFI_HII_IIBT_EXT2              = 0x31\r
+EFI_HII_IIBT_EXT4              = 0x32\r
+\r
+#\r
+# Value of HII package type\r
+#\r
+EFI_HII_PACKAGE_TYPE_ALL           = 0x00\r
+EFI_HII_PACKAGE_TYPE_GUID          = 0x01\r
+EFI_HII_PACKAGE_FORMS              = 0x02\r
+EFI_HII_PACKAGE_STRINGS            = 0x04\r
+EFI_HII_PACKAGE_FONTS              = 0x05\r
+EFI_HII_PACKAGE_IMAGES             = 0x06\r
+EFI_HII_PACKAGE_SIMPLE_FONTS       = 0x07\r
+EFI_HII_PACKAGE_DEVICE_PATH        = 0x08\r
+EFI_HII_PACKAGE_KEYBOARD_LAYOUT    = 0x09\r
+EFI_HII_PACKAGE_ANIMATIONS         = 0x0A\r
+EFI_HII_PACKAGE_END                = 0xDF\r
+EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN  = 0xE0\r
+EFI_HII_PACKAGE_TYPE_SYSTEM_END    = 0xFF\r
+\r
+class IdfFileClassObject(object):\r
+    def __init__(self, FileList = []):\r
+        self.FileList = FileList\r
+        self.ImageFilesDict = {}\r
+        self.ImageIDList = []\r
+        if len(self.FileList) > 0:\r
+            self.LoadIdfFiles(FileList)\r
+\r
+    def LoadIdfFiles(self, FileList):\r
+        if len(FileList) > 0:\r
+            for File in FileList:\r
+                self.LoadIdfFile(File)\r
+\r
+    def LoadIdfFile(self, File = None):\r
+        if File == None:\r
+            EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'No Image definition file is given.')\r
+        self.File = File\r
+\r
+        try:\r
+            IdfFile = open(LongFilePath(File.Path), mode='r')\r
+            FileIn = IdfFile.read()\r
+            IdfFile.close()\r
+        except:\r
+            EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File)\r
+\r
+        ImageFileList = []\r
+        for Line in FileIn.splitlines():\r
+            Line = Line.strip()\r
+            Line = self.StripComments(Line)\r
+            if len(Line) == 0:\r
+                continue\r
+\r
+            if Line.find('#image ') >= 0:\r
+                LineDetails = Line.split()\r
+                LineNo = GetLineNo(FileIn, Line, False)\r
+                Len = len(LineDetails)\r
+                if Len != 3 and Len != 4:\r
+                    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))\r
+                if Len == 4 and LineDetails[2] != 'TRANSPARENT':\r
+                    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))\r
+                MatchString = re.match('^[a-zA-Z][a-zA-Z0-9_]*$', LineDetails[1], re.UNICODE)\r
+                if MatchString == None or MatchString.end(0) != len(LineDetails[1]):\r
+                    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))\r
+                if LineDetails[1] not in self.ImageIDList:\r
+                    self.ImageIDList.append(LineDetails[1])\r
+                else:\r
+                    EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The %s in Line %s of File %s is already defined.' % (LineDetails[1], LineNo, File.Path))\r
+                if Len == 4:\r
+                    ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], True)\r
+                else:\r
+                    ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], False)\r
+                ImageFileList.append(ImageFile)\r
+        if ImageFileList:\r
+            self.ImageFilesDict[File] = ImageFileList\r
+\r
+    def StripComments(self, Line):\r
+        Comment = '//'\r
+        CommentPos = Line.find(Comment)\r
+        while CommentPos >= 0:\r
+        # if there are non matched quotes before the comment header\r
+        # then we are in the middle of a string\r
+        # but we need to ignore the escaped quotes and backslashes.\r
+            if ((Line.count('"', 0, CommentPos) - Line.count('\\"', 0, CommentPos)) & 1) == 1:\r
+                CommentPos = Line.find (Comment, CommentPos + 1)\r
+            else:\r
+                return Line[:CommentPos].strip()\r
+        return Line.strip()\r
+\r
+    def ImageDecoder(self, File):\r
+        pass\r
+\r
+def SearchImageID(ImageFileObject, FileList):\r
+    if FileList == []:\r
+        return ImageFileObject\r
+\r
+    for File in FileList:\r
+        if os.path.isfile(File):\r
+            Lines = open(File, 'r')\r
+            for Line in Lines:\r
+                ImageIdList = IMAGE_TOKEN.findall(Line)\r
+                for ID in ImageIdList:\r
+                    EdkLogger.debug(EdkLogger.DEBUG_5, "Found ImageID identifier: " + ID)\r
+                    ImageFileObject.SetImageIDReferenced(ID)\r
+\r
+class ImageFileObject(object):\r
+    def __init__(self, FileName, ImageID, TransParent = False):\r
+        self.FileName = FileName\r
+        self.File = ''\r
+        self.ImageID = ImageID\r
+        self.TransParent = TransParent\r
+        self.Referenced = False\r
+\r
+    def SetImageIDReferenced(self, ImageID):\r
+        if ImageID == self.ImageID:\r
+            self.Referenced = True\r
index 60840041ba22ce2fc290808efc0ace05e615b6b0..ed33554cd7d285da70ec4ee56936c5f214fb313e 100644 (file)
@@ -19,7 +19,7 @@ import Common.EdkLogger as EdkLogger
 from Common.BuildToolError import *\r
 from UniClassObject import *\r
 from StringIO import StringIO\r
-from struct import pack\r
+from struct import pack, unpack\r
 from Common.LongFilePathSupport import OpenLongFilePath as open\r
 \r
 ##\r
@@ -131,7 +131,7 @@ def DecToHexList(Dec, Digit = 8):
 def AscToHexList(Ascii):\r
     List = []\r
     for Item in Ascii:\r
-        List.append('0x%2X' % ord(Item))\r
+        List.append('0x%02X' % ord(Item))\r
 \r
     return List\r
 \r
index 1fe1ee458b9d1b43039be0653ea63ebd1740e686..60cbfbed2dcda961222d9fd1aa4cac12e5b615a0 100644 (file)
@@ -469,6 +469,7 @@ TAB_FRAMEWORK_IMAGE = "EFI-IMAGE-FILE"
 TAB_C_CODE_FILE = "C-CODE-FILE"\r
 TAB_C_HEADER_FILE = "C-HEADER-FILE"\r
 TAB_UNICODE_FILE = "UNICODE-TEXT-FILE"\r
+TAB_IMAGE_FILE = "IMAGE-DEFINITION-FILE"\r
 TAB_DEPENDENCY_EXPRESSION_FILE = "DEPENDENCY-EXPRESSION-FILE"\r
 TAB_UNKNOWN_FILE = "UNKNOWN-TYPE-FILE"\r
 TAB_DEFAULT_BINARY_FILE = "_BINARY_FILE_"\r