高通 Splash Logo 镜像生成脚本解读_高通uefi中的splash分析-CSDN博客

本文链接：https://blog.csdn.net/wangjun7121/article/details/88237642
前言

因为需要做默认高通平台的 splash.img 为单张图片，需要修改支持多张，所以就看了下这块代码，贴出来备份下
源码

#===========================================================================

#  This script read the logo png and creates the logo.img

# when          who     what, where, why
# --------      ---     -------------------------------------------------------
# 2013-04       QRD     init
# 2015-04       QRD     support the RLE24 compression

# Environment requirement:
#     Python + PIL
#     PIL install:
#         (ubuntu)  sudo apt-get install python-imaging
#         (windows) (http://www.pythonware.com/products/pil/)

# limit:
#    a This script only support Python 2.7.x, 2.6.x,
#      Can't use in py3x for StringIO module
#    b This script's input can be a png, jpeg, bmp, gif file.
#    But if it is a gif, only get the first frame by default.
#
# description:
#    struct logo_header {
#       unsigned char[8]; // "SPLASH!!"
#       unsigned width;   // logo's width, little endian
#       unsigned height;  // logo's height, little endian
#       unsigned type;    // 0, Raw Image; 1, RLE24 Compressed Image
#       unsigned blocks;  // block number, real size / 512
#       ......
#    };

#    the logo Image layout:
#       logo_header + Payload data

# ===========================================================================*/

"""
一张 10x10 全红图片生成的 splash.img 

    00000000h: 53 50 4C 41 53 48 21 21 0A 00 00 00 0A 00 00 00 ; SPLASH!!........
    00000010h: 01 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000020h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000030h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000040h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000050h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000060h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000070h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000080h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000090h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000000a0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000000b0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000000c0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000000d0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000000e0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000000f0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000100h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000110h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000120h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000130h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000140h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000150h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000160h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000170h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000180h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000190h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000001a0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000001b0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000001c0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000001d0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000001e0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    000001f0h: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ; ................
    00000200h: 89 00 00 FF 89 00 00 FF 89 00 00 FF 89 00 00 FF ; ?.?.?.?.
    00000210h: 89 00 00 FF 89 00 00 FF 89 00 00 FF 89 00 00 FF ; ?.?.?.?.
    00000220h: 89 00 00 FF 89 00 00 FF                         ; ?.?.
    
    89: 137 - 127 = 10  压缩是以行为单位的
    00 00 FF: 红色
    
"""

from __future__ import print_function
import sys,os
import struct
import StringIO
from PIL import Image

SUPPORT_RLE24_COMPRESSIONT = 1
 
## get header
## 保存文件头
##   参数：  size: 文件大小
#           compressed: 是否压缩 
#           real_bytes: 压缩后实际文件大小
def GetImgHeader(size, compressed=0, real_bytes=0):
    SECTOR_SIZE_IN_BYTES = 512   # Header size
    header = [0 for i in range(SECTOR_SIZE_IN_BYTES)]

    width, height = size
    real_size = (real_bytes  + 511) / 512

    # magic
    header[:8] = [ord('S'),ord('P'), ord('L'), ord('A'),
                   ord('S'),ord('H'), ord('!'), ord('!')]

    # width
    header[8] = ( width        & 0xFF)
    header[9] = ((width >> 8 ) & 0xFF)
    header[10]= ((width >> 16) & 0xFF)
    header[11]= ((width >> 24) & 0xFF)

    # height
    header[12]= ( height        & 0xFF)
    header[13]= ((height >>  8) & 0xFF)
    header[14]= ((height >> 16) & 0xFF)
    header[15]= ((height >> 24) & 0xFF)

    #type
    header[16]= ( compressed    & 0xFF)
    #header[17]= 0
    #header[18]= 0
    #header[19]= 0

    # block number
    header[20] = ( real_size        & 0xFF)
    header[21] = ((real_size >>  8) & 0xFF)
    header[22] = ((real_size >> 16) & 0xFF)
    header[23] = ((real_size >> 24) & 0xFF)

    output = StringIO.StringIO()
    for i in header:
        output.write(struct.pack("B", i))
    content = output.getvalue()
    output.close()
    return content

########################################################################
# RLE 压缩实现核心，以行为单位进行压缩的
# 压缩算法：
#   相邻几个单像素，保存成如下格式：
#           [单像素总数（从0计数）, 各颜色值]
#   相邻多个像素一样，保存成如下格式：
#           [127+像素数，颜色值]
#   相邻多个像素超过 128 个，则需要分成多个颜色组保存：
#             [256，颜色值] [256，颜色值] ... [127+像素数，颜色值]
#########################################################################    
def encode(line):
    # 相同像素重复次数计数
    count = 0
    lst = []
    # 上一个像素与当前像素是否重复
    repeat = -1
    run = []
    total = len(line) - 1
    
    # enumerate 返回一个带索引的列表, 用法如下：
    #   >>> seasons = ['Spring', 'Summer', 'Fall', 'Winter']
    #   >>> list(enumerate(seasons))
    #   [(0, 'Spring'), (1, 'Summer'), (2, 'Fall'), (3, 'Winter')]
    #   >>> list(enumerate(seasons, start=1))
    #   [(1, 'Spring'), (2, 'Summer'), (3, 'Fall'), (4, 'Winter')]
    for index, current in enumerate(line[:-1]):
        
        # 如果当前值 =/= 下一个像素值
        if current != line[index + 1]:
            # run 中保存当前值 
            run.append(current)
            # 计数器加 1
            count += 1
            # 如果上一个字符与当前一样
            if repeat == 1:
                entry = (count+128,run)
                lst.append(entry)
                count = 0
                run = []
                repeat = -1
                # 遍历到最后一个字符，需要特殊处理
                if index == total - 1:
                    run = [line[index + 1]]
                    entry = (1,run)
                    lst.append(entry)
            # 如果上一个字符与当前不一样
            else:
                repeat = 0
                
                if count == 128:
                    entry = (128,run)
                    lst.append(entry)
                    count = 0
                    run = []
                    repeat = -1
                if index == total - 1:
                    run.append(line[index + 1])
                    entry = (count+1,run)
                    lst.append(entry)
                    
        # 如果当前值 == 下一个要遍历的像素值
        else:
            # 如果是首次累加，则保存到 1st 中
            if repeat == 0:
                entry = (count,run)
                lst.append(entry)
                count = 0
                run = []
                repeat = -1
                # 遍历到最后一个字符，需要特殊处理
                if index == total - 1:
                    run.append( line[index + 1])
                    run.append( line[index + 1])
                    entry = (2+128,run)
                    lst.append(entry)
                    break
            
            run.append(current)
            repeat = 1
            count += 1
            # 重复了 128 次？则保存一个 256 再次重新循环保存
            # 主要是因为计数从 127 开始，最大只能后 256
            if count == 128:
                entry = (256,run)
                lst.append(entry)
                count = 0
                run = []
                repeat = -1
            # 如果遍历后最后一次字符前
            if index == total - 1:
                if count == 0:
                    run = [line[index + 1]]
                    entry = (1,run)
                    lst.append(entry)
                else:
                    run.append(current)
                    entry = (count+1+128,run)
                    lst.append(entry)
    return lst

# 对 RGB 图像进行 RLE 压缩 
# 压缩算法原理如下：
# 行程编码：
#   原字符串：11111TTTUUUUUUTTTREABCDTTTTT
#   压缩字符：1#5#TTTU#6#TTTREABCDT#5#
#   解压字符：11111TTTUUUUUUTTTREABCDTTTTT
def encodeRLE24(img):
    width, height = img.size
    output = StringIO.StringIO()

    for h in range(height):
        # line 原图像数据列表 
        line = []
        # 压缩后的图像数据列表
        result=[]
        for w in range(width):
            # 返回给定位置的像素值，如果图像是一个多通道，则返回一个元组
            (r, g, b) = img.getpixel((w,h))
            # 添加到列表中
            line.append((r << 16)+(g << 8) + b)
            
        # 对每一行的数据进行压缩操作，
        #   他会将每个像素都变成 count:piexl 的格式？
        #   不然后面如何循环
        result = encode(line)
        
        # 
        for count, pixel in result:
            # struct.pack(fmt,v1,v2…) 按照给定的格式(fmt),把数据转换成字符串(字节流),并将该字符串返回.
            #   B: unsigned char 
            
            # 先写 count 值 
            output.write(struct.pack("B", count-1))
            
            # 再保存 piexl 值 
            if count > 128:
                output.write(struct.pack("B", (pixel[0]) & 0xFF))
                output.write(struct.pack("B", ((pixel[0]) >> 8) & 0xFF))
                output.write(struct.pack("B", ((pixel[0]) >> 16) & 0xFF))
            else:
                for item in pixel:
                    output.write(struct.pack("B", (item) & 0xFF))
                    output.write(struct.pack("B", (item >> 8) & 0xFF))
                    output.write(struct.pack("B", (item >> 16) & 0xFF))
    content = output.getvalue()
    output.close()
    return content


## get payload data : BGR Interleaved
def GetImageBody(img, compressed=0):
    # 定义了一个 元组
    color = (0, 0, 0)
    
    ##################################################
    # 判断图像的模式：定义的图像的类型和像素的位宽
    ##################################################
    if img.mode == "RGB":
    # RGB 颜色直接使用 
        background = img
    elif img.mode == "RGBA":
    # RGBA 的话，则截取 A 保存在 RGB 中
        background = Image.new("RGB", img.size, color)
        img.load()
        background.paste(img, mask=img.split()[3]) # alpha channel
    elif img.mode == "P" or img.mode == "L":
    # P 或者 L 类型的，直接粘贴到 RGB 类型中 
        background = Image.new("RGB", img.size, color)
        img.load()
        background.paste(img)
        #background.save("splash.png")
    else:
        print ("sorry, can't support this format")
        sys.exit()

    ##############################
    # 图像压缩？
    if compressed == 1:
        return encodeRLE24(background)
    else:
        # 获取各通道上的元组
        r, g, b = background.split()
        
        # 将 RGB 颠倒为 BGR 再保存了
        return Image.merge("RGB",(b,g,r)).tostring()

        
#############################################        
## make a image
# 核心函数：
def MakeLogoImage(logo, out):
    # 打开图片 
    img = Image.open(logo)
    
    # 打开文件
    file = open(out, "wb")
    
    # 获取文件内容，注会使用 RLE 进行压缩
    body = GetImageBody(img, SUPPORT_RLE24_COMPRESSIONT)
    
    # 1. 先写文件头 
    file.write(GetImgHeader(img.size, SUPPORT_RLE24_COMPRESSIONT, len(body)))
    
    # 2. 再写图像内容
    file.write(body)
    
    # 关闭文件
    file.close()


## mian

def ShowUsage():
    print(" usage: python logo_gen.py [logo.png]")

# 获取 png 文件路径，这里对传入的路径参数进行检查，判断文件是否存在    
def GetPNGFile():
    infile = "logo.png" #default file name
    num = len(sys.argv)
    if num > 3:
        ShowUsage()
        sys.exit(); # error arg

    if num == 2:
        infile = sys.argv[1]

    if os.access(infile, os.R_OK) != True:
        ShowUsage()
        sys.exit(); # error file
    return infile

#####################################################
# 函数入口 
#####################################################    
if __name__ == "__main__":
    MakeLogoImage(GetPNGFile(), "splash.img")