5d2dd958a9257b98fa6db554c9a793d393be326c
[blender.git] / release / bin / blender-thumbnailer.py
1 #!/usr/bin/env python3
2
3 # ##### BEGIN GPL LICENSE BLOCK #####
4 #
5 #  This program is free software; you can redistribute it and/or
6 #  modify it under the terms of the GNU General Public License
7 #  as published by the Free Software Foundation; either version 2
8 #  of the License, or (at your option) any later version.
9 #
10 #  This program is distributed in the hope that it will be useful,
11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 #  GNU General Public License for more details.
14 #
15 #  You should have received a copy of the GNU General Public License
16 #  along with this program; if not, write to the Free Software Foundation,
17 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 #
19 # ##### END GPL LICENSE BLOCK #####
20
21 # <pep8 compliant>
22
23 """
24 Thumbnailer runs with python 2.7 and 3.x.
25 To run automatically with a file manager such as Nautilus, save this file
26 in a directory that is listed in PATH environment variable, and create
27 blender.thumbnailer file in ${HOME}/.local/share/thumbnailers/ directory
28 with the following contents:
29
30 [Thumbnailer Entry]
31 TryExec=blender-thumbnailer.py
32 Exec=blender-thumbnailer.py %u %o
33 MimeType=application/x-blender;
34 """
35
36 import struct
37
38
39 def open_wrapper_get():
40     """ wrap OS spesific read functionality here, fallback to 'open()'
41     """
42
43     class GFileWrapper:
44         __slots__ = ("mode", "g_file")
45
46         def __init__(self, url, mode='r'):
47             self.mode = mode  # used in gzip module
48             self.g_file = Gio.File.parse_name(url).read(None)
49
50         def read(self, size):
51             return self.g_file.read_bytes(size, None).get_data()
52
53         def seek(self, offset, whence=0):
54             self.g_file.seek(offset, [1, 0, 2][whence], None)
55             return self.g_file.tell()
56
57         def tell(self):
58             return self.g_file.tell()
59
60         def close(self):
61             self.g_file.close(None)
62
63     def open_local_url(url, mode='r'):
64         o = urlparse(url)
65         if o.scheme == '':
66             path = o.path
67         elif o.scheme == 'file':
68             path = unquote(o.path)
69         else:
70             raise(IOError('URL scheme "%s" needs gi.repository.Gio module' % o.scheme))
71         return open(path, mode)
72
73     try:
74         from gi.repository import Gio
75         return GFileWrapper
76     except ImportError:
77         try:
78             # Python 3
79             from urllib.parse import urlparse, unquote
80         except ImportError:
81             # Python 2
82             from urlparse import urlparse
83             from urllib import unquote
84         return open_local_url
85
86
87 def blend_extract_thumb(path):
88     import os
89     open_wrapper = open_wrapper_get()
90
91     REND = b'REND'
92     TEST = b'TEST'
93
94     blendfile = open_wrapper(path, 'rb')
95
96     head = blendfile.read(12)
97
98     if head[0:2] == b'\x1f\x8b':  # gzip magic
99         import gzip
100         blendfile.close()
101         blendfile = gzip.GzipFile('', 'rb', 0, open_wrapper(path, 'rb'))
102         head = blendfile.read(12)
103
104     if not head.startswith(b'BLENDER'):
105         blendfile.close()
106         return None, 0, 0
107
108     is_64_bit = (head[7] == b'-'[0])
109
110     # true for PPC, false for X86
111     is_big_endian = (head[8] == b'V'[0])
112
113     # blender pre 2.5 had no thumbs
114     if head[9:11] <= b'24':
115         return None, 0, 0
116
117     sizeof_bhead = 24 if is_64_bit else 20
118     int_endian = '>i' if is_big_endian else '<i'
119     int_endian_pair = int_endian + 'i'
120
121     while True:
122         bhead = blendfile.read(sizeof_bhead)
123
124         if len(bhead) < sizeof_bhead:
125             return None, 0, 0
126
127         code = bhead[:4]
128         length = struct.unpack(int_endian, bhead[4:8])[0]  # 4 == sizeof(int)
129
130         if code == REND:
131             blendfile.seek(length, os.SEEK_CUR)
132         else:
133             break
134
135     if code != TEST:
136         return None, 0, 0
137
138     try:
139         x, y = struct.unpack(int_endian_pair, blendfile.read(8))  # 8 == sizeof(int) * 2
140     except struct.error:
141         return None, 0, 0
142
143     length -= 8  # sizeof(int) * 2
144
145     if length != x * y * 4:
146         return None, 0, 0
147
148     image_buffer = blendfile.read(length)
149
150     if len(image_buffer) != length:
151         return None, 0, 0
152
153     return image_buffer, x, y
154
155
156 def write_png(buf, width, height):
157     import zlib
158
159     # reverse the vertical line order and add null bytes at the start
160     width_byte_4 = width * 4
161     raw_data = b"".join(b'\x00' + buf[span:span + width_byte_4] for span in range((height - 1) * width * 4, -1, - width_byte_4))
162
163     def png_pack(png_tag, data):
164         chunk_head = png_tag + data
165         return struct.pack("!I", len(data)) + chunk_head + struct.pack("!I", 0xFFFFFFFF & zlib.crc32(chunk_head))
166
167     return b"".join([
168         b'\x89PNG\r\n\x1a\n',
169         png_pack(b'IHDR', struct.pack("!2I5B", width, height, 8, 6, 0, 0, 0)),
170         png_pack(b'IDAT', zlib.compress(raw_data, 9)),
171         png_pack(b'IEND', b'')])
172
173
174 def main():
175     import sys
176
177     if len(sys.argv) < 3:
178         print("Expected 2 arguments <input.blend> <output.png>")
179     else:
180         file_in = sys.argv[-2]
181
182         buf, width, height = blend_extract_thumb(file_in)
183
184         if buf:
185             file_out = sys.argv[-1]
186
187             f = open(file_out, "wb")
188             f.write(write_png(buf, width, height))
189             f.close()
190
191
192 if __name__ == '__main__':
193     main()