-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathicoconvert.py
271 lines (239 loc) · 11.4 KB
/
icoconvert.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# https://en.wikipedia.org/wiki/ICO_(file_format)
# All values in ICO/CUR files are represented in little-endian byte order.
# Broad file structure:
# _______________________
# | ICO header |
# |-----------------------|
# | Icon directories 1..n |
# |-----------------------|
# | Image data 1..n |
# |_______________________|
# ICO header:
# _______________________________________________________________________________
# | Offset | Size (bytes) | Purpose |
# |--------|--------------|-------------------------------------------------------|
# | 0 | 2 | Reserved. Must always be 0. |
# |--------|--------------|-------------------------------------------------------|
# | 2 | 2 | Specifies image type: 1 for icon (.ICO) image, |
# | | | 2 for cursor (.CUR) image. Other values are invalid. |
# |--------|--------------|-------------------------------------------------------|
# | 4 | 2 | Specifies number of images in the file. |
# |________|______________|_______________________________________________________|
# Icon directory structure:
# _______________________________________________________________________________
# | Offset | Size (bytes) | Purpose |
# |--------|--------------|-------------------------------------------------------|
# | 0 | 1 | Specifies image width in pixels. Can be any number |
# | | | between 0 and 255. Value 0 means image width is 256 |
# | | | pixels. |
# |--------|--------------|-------------------------------------------------------|
# | 1 | 1 | Specifies image height in pixels. Can be any number |
# | | | between 0 and 255. Value 0 means image height is 256 |
# | | | pixels. |
# |--------|--------------|-------------------------------------------------------|
# | 2 | 1 | Specifies number of colors in the color palette. |
# | | | Should be 0 if the image does not use a color palette |
# |--------|--------------|-------------------------------------------------------|
# | 3 | 1 | Reserved. Should be 0. |
# |--------|--------------|-------------------------------------------------------|
# | 4 | 2 | In ICO format: Specifies color planes. |
# | | | Should be 0 or 1. |
# | | | In CUR format: Specifies the horizontal coordinates |
# | | | of the hotspot in number of pixels from the left. |
# |--------|--------------|-------------------------------------------------------|
# | 6 | 2 | In ICO format: Specifies bits per pixel. |
# | | | In CUR format: Specifies the vertical coordinates of |
# | | | the hotspot in number of pixels from the top. |
# |--------|--------------|-------------------------------------------------------|
# | 8 | 4 | Specifies the size of the image's data in bytes |
# |--------|--------------|-------------------------------------------------------|
# | 12 | 4 | Specifies the offset of BMP or PNG data from the |
# | | | beginning of the ICO/CUR file |
# |________|______________|_______________________________________________________|
# Image data structure
# BMP, starting from the BITMAPINFOHEADER, ignoring normal file header:
# _______________________________________________________________________________
# | Offset | Size (bytes) | Purpose |
# |--------|--------------|-------------------------------------------------------|
# | 0 | 4 | The size of this header. Always 40. |
# |--------|--------------|-------------------------------------------------------|
# | 4 | 4 | Image width in pixels, signed. |
# |--------|--------------|-------------------------------------------------------|
# | 8 | 4 | Image height in pixels, signed. |
# |--------|--------------|-------------------------------------------------------|
# | 12 | 2 | Number of color planes. Always 1. |
# |--------|--------------|-------------------------------------------------------|
# | 14 | 2 | Bits per pixel aka color depth. |
# |--------|--------------|-------------------------------------------------------|
# | 16 | 4 | Compression method. 0 for None aka BI_RGB. |
# |--------|--------------|-------------------------------------------------------|
# | 20 | 4 | Image bytes length. 0 for BI_RGB because inferred. |
# |--------|--------------|-------------------------------------------------------|
# | 24 | 4 | Horizontal print resolution. |
# |--------|--------------|-------------------------------------------------------|
# | 28 | 4 | Vertical print resolution |
# |--------|--------------|-------------------------------------------------------|
# | 32 | 4 | Number of colors in palette. 0 for 2^n. |
# |--------|--------------|-------------------------------------------------------|
# | 36 | 4 | Number of important colors. 0 for all. |
# |--------|--------------|-------------------------------------------------------|
# | 40 | n | Pixel bytes, r, g, b, a. |
# |________|______________|_______________________________________________________|
import argparse
import os
import PIL.Image
import sys
from voussoirkit import betterhelp
from voussoirkit import imagetools
from voussoirkit import pipeable
from voussoirkit import vlogging
log = vlogging.get_logger(__name__, 'icoconvert')
ICO_HEADER_LENGTH = 6
ICON_DIRECTORY_ENTRY_LENGTH = 16
BMP_HEADER_LENGTH = 40
def chunk_sequence(sequence, chunk_length, allow_incomplete=True):
'''
Given a sequence, divide it into sequences of length `chunk_length`.
allow_incomplete:
If True, allow the final chunk to be shorter if the
given sequence is not an exact multiple of `chunk_length`.
If False, the incomplete chunk will be discarded.
'''
(complete, leftover) = divmod(len(sequence), chunk_length)
if not allow_incomplete:
leftover = 0
chunk_count = complete + min(leftover, 1)
chunks = []
for x in range(chunk_count):
left = chunk_length * x
right = left + chunk_length
chunks.append(sequence[left:right])
return chunks
def little(x, length):
return x.to_bytes(length, byteorder='little')
def load_image(filename):
image = PIL.Image.open(filename)
(w, h) = image.size
(new_w, new_h) = imagetools.fit_into_bounds(w, h, 256, 256, only_shrink=True)
image = image.resize((new_w, new_h), resample=PIL.Image.LANCZOS)
image = image.convert('RGBA')
image = imagetools.pad_to_square(image)
return image
def build_ico_header_blob(image_count):
datablob = b''.join([
# reserved
little(0, 2),
# 1 = ico type
little(1, 2),
little(image_count, 2),
])
return datablob
def build_icon_directory_blob(image, offset_from_start):
(width, height) = image.size
datablob = b''.join([
little(width if width < 256 else 0, 1),
little(height if height < 256 else 0, 1),
# colors in palette
little(0, 1),
# reserved
little(0, 1),
# color planes
little(1, 2),
# bit depth
little(32, 2),
# image bytes length
little((width * height * 4) + BMP_HEADER_LENGTH, 4),
little(offset_from_start, 4),
])
return datablob
def build_image_data_blob(image):
datablob = b''.join([
# header size
little(40, 4),
little(image.size[0], 4),
# "Even if the AND mask is not supplied, if the image is in Windows BMP
# format, the BMP header must still specify a doubled height." - wikipedia
little(image.size[1] * 2, 4),
# color planes
little(1, 2),
# bit depth
little(32, 2),
# no compression
little(0, 4),
# bytes length, inferred
little(0, 4),
# hor print
little(0, 4),
# ver print
little(0, 4),
# palette
little(0, 4),
# important palette
little(0, 4),
])
pixeldata = []
# Image.getdata() is a list of (r, g, b, a) channels
# But the BMP are written (b, g, r, a)
# Also they are written from bottom to top.
pixels = list(image.getdata())
pixels = reversed(chunk_sequence(pixels, image.size[0]))
pixels = [line for chunk in pixels for line in chunk]
for pixel in pixels:
(r, g, b, a) = pixel
pixeldata.extend((b, g, r, a))
datablob += bytes(pixeldata)
return datablob
def images_to_ico(images):
# For some reason Windows reads the icons in reverse order.
images.reverse()
# The directory entries need to know their image's address, so therefore
# we must know the lengths of all the image binaries before we can write
# any directory entries.
# We will calculate the image blobs first, store them separately,
# and then put them after the directory blobs.
datablobs = []
imageblobs = []
ico_header_blob = build_ico_header_blob(image_count=len(images))
datablobs.append(ico_header_blob)
for (index, image) in enumerate(images):
imageblob = build_image_data_blob(image)
imageblobs.append(imageblob)
# Since the ICO header and directory entries are of fixed length, we know
# the location of the first image.
# After that, the offset just gains the size of the previous image.
offset_from_start = ICO_HEADER_LENGTH + (len(images) * ICON_DIRECTORY_ENTRY_LENGTH)
for (index, (image, imageblob)) in enumerate(zip(images, imageblobs)):
directoryblob = build_icon_directory_blob(image, offset_from_start=offset_from_start)
datablobs.append(directoryblob)
offset_from_start += len(imageblob)
datablobs.extend(imageblobs)
final_data = b''.join(datablobs)
return final_data
def icoconvert_argparse(args):
log.info('Iconifying %s', args.files)
images = [load_image(filename) for filename in args.files]
final_data = images_to_ico(images)
iconame = os.path.splitext(args.files[0])[0] + '.ico'
output_file = open(iconame, 'wb')
output_file.write(final_data)
output_file.close()
pipeable.stderr(iconame)
return 0
@vlogging.main_decorator
def main(argv):
parser = argparse.ArgumentParser(
description='''
Create a Windows .ico icon file from one or more images.
''',
)
parser.add_argument(
'files',
nargs='+',
help='''
One or more image files to put into the ico.
''',
)
parser.set_defaults(func=icoconvert_argparse)
return betterhelp.go(parser, argv)
if __name__ == '__main__':
raise SystemExit(main(sys.argv[1:]))