├── README.md
├── logo_dumper.py
└── LICENSE


/README.md:
--------------------------------------------------------------------------------
 1 | # logo_dumper
 2 | Dump Xiaomi any logo.img file and extract bitmap pictures and repack    
 3 | looks like it only work on k30 5g
 4 | # usage
 5 | ``` sh
 6 | # Unpack xiaomi logo
 7 | python logo_dumper.py logo.img unpack
 8 | 
 9 | # Repack xiaomi logo
10 | python logo_dumper.py logo.img repack
11 | 
12 | ```
13 | 


--------------------------------------------------------------------------------
/logo_dumper.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python3
  2 | # Python script by affggh
  3 | 
  4 | import os
  5 | import struct
  6 | 
  7 | class DUMPCFG:
  8 |     def __init__(self):
  9 |         self.blksz = 0x1<<0xc
 10 |         self.headoff = 0x4000
 11 |         self.magic = b"LOGO!!!!"
 12 |         self.imgnum = 0
 13 |         self.imgblkoffs = []
 14 |         self.imgblkszs = []
 15 | 
 16 | class BMPHEAD(object):
 17 |     def __init__(self, buf:bytes=None): # Read bytes buf and use this struct to parse
 18 |         if buf == None:
 19 |             raise SyntaxError("buf Should be bytes not %s" %type(buf))
 20 |         # print(buf)
 21 |         self.structstr = "<H6I"
 22 |         (
 23 |             self.magic,
 24 |             self.fsize,
 25 |             self.reserved,
 26 |             self.hsize,
 27 |             self.dib,
 28 |             self.width,
 29 |             self.height,
 30 |         ) = struct.unpack(self.structstr, buf)
 31 | 
 32 | class XIAOMI_BLKSTRUCT(object):
 33 |     def __init__(self, buf:bytes):
 34 |         self.structstr = "2I"
 35 |         (
 36 |             self.imgoff,
 37 |             self.blksz,
 38 |         ) = struct.unpack(self.structstr, buf)
 39 | 
 40 | class LOGODUMPER(object):
 41 |     def __init__(self, img:str, out:str):
 42 |         self.out = out
 43 |         self.img = img
 44 |         self.structstr = "<8s"
 45 |         self.cfg = DUMPCFG()
 46 |         self.chkimg(img)
 47 | 
 48 |     def chkimg(self, img:str):
 49 |         if not os.access(img, os.F_OK):
 50 |             raise FileNotFoundError(f"{img} does not found!")
 51 |         with open(img, 'rb') as f:
 52 |             f.seek(self.cfg.headoff, 0)
 53 |             self.magic = struct.unpack(
 54 |                 self.structstr, f.read(struct.calcsize(self.structstr))
 55 |             )[0]
 56 |             while(True):
 57 |                 m = XIAOMI_BLKSTRUCT(f.read(8))
 58 |                 if m.imgoff != 0:
 59 |                     # print(blksz<<0xc)
 60 |                     self.cfg.imgblkszs.append(m.blksz<<0xc)
 61 |                     self.cfg.imgblkoffs.append(m.imgoff<<0xc)
 62 |                     self.cfg.imgnum += 1
 63 |                 else:
 64 |                     break
 65 |         # print(self.magic)
 66 |         if self.magic != b"LOGO!!!!":
 67 |             raise TypeError("File does not match xiaomi logo magic!")
 68 |         else:
 69 |             print("Xiaomi LOGO!!!! format check pass!")
 70 |     
 71 |     def unpack(self):
 72 |         with open(self.img, 'rb') as f:
 73 |             print("Unpack:\n"
 74 |                   "BMP\tSize\tWidth\tHeight")
 75 |             for i in range(self.cfg.imgnum):
 76 |                 f.seek(self.cfg.imgblkoffs[i], 0)
 77 |                 bmph = BMPHEAD(f.read(26))
 78 |                 f.seek(self.cfg.imgblkoffs[i], 0)
 79 |                 print("%d\t%d\t%d\t%d" %(i ,bmph.fsize, bmph.width, bmph.height))
 80 |                 with open(os.path.join(self.out, "%d.bmp" %i), 'wb') as o:
 81 |                     o.write(f.read(bmph.fsize))
 82 |             print("\tDone!")
 83 |     
 84 |     def repack(self):
 85 |         with open(self.out, 'wb') as o:
 86 |             off = 0x5
 87 |             for i in range(self.cfg.imgnum):
 88 |                 print("Write BMP [%d.bmp] at offset 0x%X" %(i, off<<0xc))
 89 |                 with open(os.path.join("pic", "%d.bmp" %i), 'rb') as b:
 90 |                     bhead = BMPHEAD(b.read(26))
 91 |                     b.seek(0, 0)
 92 |                     # print("%x" %off)
 93 |                     self.cfg.imgblkszs[i] = (bhead.fsize>>0xc) + 1
 94 |                     self.cfg.imgblkoffs[i] = off
 95 | 
 96 |                     o.seek(off<<0xc)
 97 |                     o.write(b.read(bhead.fsize))
 98 | 
 99 |                     off += self.cfg.imgblkszs[i]
100 |             # self.cfg.imgblkoffs[0] = 0x5   # override
101 |             o.seek(self.cfg.headoff)
102 |             o.write(self.magic)
103 |             #print(self.cfg.imgblkoffs)
104 |             #print(self.cfg.imgblkszs)
105 |             for i in range(self.cfg.imgnum):
106 |                 o.write(struct.pack("<I", self.cfg.imgblkoffs[i]))
107 |                 o.write(struct.pack("<I", self.cfg.imgblkszs[i]))
108 |             print("\tDone!")
109 | 
110 | if __name__ == '__main__':
111 |     import argparse
112 | 
113 |     parser = argparse.ArgumentParser(
114 |         prog="logo_dumper", 
115 |         description="Dump Xiaomi bmp format logo and repack.",
116 |         )
117 |     parser.add_argument("IMAGE",
118 |         help="Image path, and it must be set.")
119 |     parser.add_argument("FUNC", 
120 |         help="Function, available functions: unpack repack.")
121 |     parser.add_argument("-o, --out", help="Set output dir or image path", dest="out")
122 | 
123 |     args = parser.parse_args()
124 |     print(f"Function : {args.FUNC}")
125 |     if args.FUNC.lower() == 'unpack':
126 |         if args.out != None:
127 |             if not os.path.isdir(args.out):
128 |                 os.makedirs(args.out)
129 |             LOGODUMPER(args.IMAGE, args.out).unpack()
130 |         else:
131 |             if not os.path.isdir("pic"):
132 |                 os.mkdir("pic")
133 |             LOGODUMPER(args.IMAGE, "pic").unpack()
134 |     elif args.FUNC.lower() == 'repack':
135 |         if args.out != None:
136 |             LOGODUMPER(args.IMAGE, args.out).repack()
137 |         else:
138 |             LOGODUMPER(args.IMAGE, "new-logo.img").repack()
139 |     else:
140 |         parser.error("Invalid function !")
141 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------