1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2012-today OpenERP s.a. (<http://openerp.com>).
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
26 from PIL import ImageOps
27 from random import random
29 # ----------------------------------------
31 # ----------------------------------------
33 def image_resize_image(base64_source, size=(1024, 1024), encoding='base64', filetype='PNG', avoid_if_small=False):
34 """ Function to resize an image. The image will be resized to the given
35 size, while keeping the aspect ratios, and holes in the image will be
36 filled with transparent background. The image will not be stretched if
37 smaller than the expected size.
38 Steps of the resizing:
39 - Compute width and height if not specified.
40 - if avoid_if_small: if both image sizes are smaller than the requested
41 sizes, the original image is returned. This is used to avoid adding
42 transparent content around images that we do not want to alter but
43 just resize if too big. This is used for example when storing images
44 in the 'image' field: we keep the original image, resized to a maximal
45 size, without adding transparent content around it if smaller.
46 - create a thumbnail of the source image through using the thumbnail
47 function. Aspect ratios are preserved when using it. Note that if the
48 source image is smaller than the expected size, it will not be
49 extended, but filled to match the size.
50 - create a transparent background that will hold the final image.
51 - paste the thumbnail on the transparent background and center it.
53 :param base64_source: base64-encoded version of the source
54 image; if False, returns False
55 :param size: 2-tuple(width, height). A None value for any of width or
56 height mean an automatically computed value based respectivelly
57 on height or width of the source image.
58 :param encoding: the output encoding
59 :param filetype: the output filetype
60 :param avoid_if_small: do not resize if image height and width
61 are smaller than the expected size.
65 if size == (None, None):
67 image_stream = io.BytesIO(base64_source.decode(encoding))
68 image = Image.open(image_stream)
70 asked_width, asked_height = size
71 if asked_width is None:
72 asked_width = int(image.size[0] * (float(asked_height) / image.size[1]))
73 if asked_height is None:
74 asked_height = int(image.size[1] * (float(asked_width) / image.size[0]))
75 size = asked_width, asked_height
77 # check image size: do not create a thumbnail if avoiding smaller images
78 if avoid_if_small and image.size[0] <= size[0] and image.size[1] <= size[1]:
81 if image.size <> size:
82 # If you need faster thumbnails you may use use Image.NEAREST
83 image = ImageOps.fit(image, size, Image.ANTIALIAS)
84 if image.mode not in ["1", "L", "P", "RGB", "RGBA"]:
85 image = image.convert("RGB")
87 background_stream = StringIO.StringIO()
88 image.save(background_stream, filetype)
89 return background_stream.getvalue().encode(encoding)
91 def image_resize_image_big(base64_source, size=(1204, 1204), encoding='base64', filetype='PNG', avoid_if_small=True):
92 """ Wrapper on image_resize_image, to resize images larger than the standard
93 'big' image size: 1024x1024px.
94 :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
96 return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
98 def image_resize_image_medium(base64_source, size=(128, 128), encoding='base64', filetype='PNG', avoid_if_small=False):
99 """ Wrapper on image_resize_image, to resize to the standard 'medium'
101 :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
103 return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
105 def image_resize_image_small(base64_source, size=(64, 64), encoding='base64', filetype='PNG', avoid_if_small=False):
106 """ Wrapper on image_resize_image, to resize to the standard 'small' image
108 :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
110 return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
112 # ----------------------------------------
114 # ---------------------------------------
116 def image_colorize(original, randomize=True, color=(255, 255, 255)):
117 """ Add a color to the transparent background of an image.
118 :param original: file object on the original image file
119 :param randomize: randomize the background color
120 :param color: background-color, if not randomize
122 # create a new image, based on the original one
123 original = Image.open(io.BytesIO(original))
124 image = Image.new('RGB', original.size)
125 # generate the background color, past it as background
127 color = (int(random() * 192 + 32), int(random() * 192 + 32), int(random() * 192 + 32))
129 image.paste(original, mask=original)
130 # return the new image
131 buffer = StringIO.StringIO()
132 image.save(buffer, 'PNG')
133 return buffer.getvalue()
135 # ----------------------------------------
137 # ---------------------------------------
139 def image_get_resized_images(base64_source, return_big=False, return_medium=True, return_small=True,
140 big_name='image', medium_name='image_medium', small_name='image_small',
141 avoid_resize_big=True, avoid_resize_medium=False, avoid_resize_small=False):
142 """ Standard tool function that returns a dictionary containing the
143 big, medium and small versions of the source image. This function
144 is meant to be used for the methods of functional fields for
147 Default parameters are given to be used for the getter of functional
148 image fields, for example with res.users or res.partner. It returns
149 only image_medium and image_small values, to update those fields.
151 :param base64_source: base64-encoded version of the source
152 image; if False, all returnes values will be False
153 :param return_{..}: if set, computes and return the related resizing
155 :param {..}_name: key of the resized image in the return dictionary;
156 'image', 'image_medium' and 'image_small' by default.
157 :param avoid_resize_[..]: see avoid_if_small parameter
158 :return return_dict: dictionary with resized images, depending on
163 return_dict[big_name] = image_resize_image_big(base64_source, avoid_if_small=avoid_resize_big)
165 return_dict[medium_name] = image_resize_image_medium(base64_source, avoid_if_small=avoid_resize_medium)
167 return_dict[small_name] = image_resize_image_small(base64_source, avoid_if_small=avoid_resize_small)
171 if __name__=="__main__":
174 assert len(sys.argv)==3, 'Usage to Test: image.py SRC.png DEST.png'
176 img = file(sys.argv[1],'rb').read().encode('base64')
177 new = image_resize_image(img, (128,100))
178 file(sys.argv[2], 'wb').write(new.decode('base64'))