[IMP] better thumbnail generation
[odoo/odoo.git] / openerp / tools / image.py
1 # -*- coding: utf-8 -*-
2 ##############################################################################
3 #
4 #    OpenERP, Open Source Management Solution
5 #    Copyright (C) 2012-today OpenERP s.a. (<http://openerp.com>).
6 #
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.
11 #
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.
16 #
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/>.
19 #
20 ##############################################################################
21
22 import io
23 import StringIO
24
25 from PIL import Image
26 from PIL import ImageEnhance, ImageOps
27 from random import random
28
29 # ----------------------------------------
30 # Image resizing
31 # ----------------------------------------
32
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.
52
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.
62     """
63     if not base64_source:
64         return False
65     if size == (None, None):
66         return base64_source
67     image_stream = io.BytesIO(base64_source.decode(encoding))
68     image = Image.open(image_stream)
69     background = ImageOps.fit(image, size, Image.ANTIALIAS)
70     background_stream = StringIO.StringIO()
71     background.save(background_stream, filetype)
72     return background_stream.getvalue().encode(encoding)
73
74 def image_resize_image_big(base64_source, size=(1204, 1204), encoding='base64', filetype='PNG', avoid_if_small=True):
75     """ Wrapper on image_resize_image, to resize images larger than the standard
76         'big' image size: 1024x1024px.
77         :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
78     """
79     return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
80
81 def image_resize_image_medium(base64_source, size=(128, 128), encoding='base64', filetype='PNG', avoid_if_small=False):
82     """ Wrapper on image_resize_image, to resize to the standard 'medium'
83         image size: 180x180.
84         :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
85     """
86     return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
87
88 def image_resize_image_small(base64_source, size=(64, 64), encoding='base64', filetype='PNG', avoid_if_small=False):
89     """ Wrapper on image_resize_image, to resize to the standard 'small' image
90         size: 50x50.
91         :param size, encoding, filetype, avoid_if_small: refer to image_resize_image
92     """
93     return image_resize_image(base64_source, size, encoding, filetype, avoid_if_small)
94
95 # ----------------------------------------
96 # Colors
97 # ---------------------------------------
98
99 def image_colorize(original, randomize=True, color=(255, 255, 255)):
100     """ Add a color to the transparent background of an image.
101         :param original: file object on the original image file
102         :param randomize: randomize the background color
103         :param color: background-color, if not randomize
104     """
105     # create a new image, based on the original one
106     original = Image.open(io.BytesIO(original))
107     image = Image.new('RGB', original.size)
108     # generate the background color, past it as background
109     if randomize:
110         color = (int(random() * 192 + 32), int(random() * 192 + 32), int(random() * 192 + 32))
111     image.paste(color)
112     image.paste(original, mask=original)
113     # return the new image
114     buffer = StringIO.StringIO()
115     image.save(buffer, 'PNG')
116     return buffer.getvalue()
117
118 # ----------------------------------------
119 # Misc image tools
120 # ---------------------------------------
121
122 def image_get_resized_images(base64_source, return_big=False, return_medium=True, return_small=True,
123     big_name='image', medium_name='image_medium', small_name='image_small',
124     avoid_resize_big=True, avoid_resize_medium=False, avoid_resize_small=False):
125     """ Standard tool function that returns a dictionary containing the
126         big, medium and small versions of the source image. This function
127         is meant to be used for the methods of functional fields for
128         models using images.
129
130         Default parameters are given to be used for the getter of functional
131         image fields,  for example with res.users or res.partner. It returns
132         only image_medium and image_small values, to update those fields.
133
134         :param base64_source: base64-encoded version of the source
135             image; if False, all returnes values will be False
136         :param return_{..}: if set, computes and return the related resizing
137             of the image
138         :param {..}_name: key of the resized image in the return dictionary;
139             'image', 'image_medium' and 'image_small' by default.
140         :param avoid_resize_[..]: see avoid_if_small parameter
141         :return return_dict: dictionary with resized images, depending on
142             previous parameters.
143     """
144     return_dict = dict()
145     if return_big:
146         return_dict[big_name] = image_resize_image_big(base64_source, avoid_if_small=avoid_resize_big)
147     if return_medium:
148         return_dict[medium_name] = image_resize_image_medium(base64_source, avoid_if_small=avoid_resize_medium)
149     if return_small:
150         return_dict[small_name] = image_resize_image_small(base64_source, avoid_if_small=avoid_resize_small)
151     return return_dict
152
153
154 if __name__=="__main__":
155     import sys
156
157     assert len(sys.argv)==3, 'Usage to Test: image.py SRC.png DEST.png'
158
159     img = file(sys.argv[1],'rb').read().encode('base64')
160     new = image_resize_image(img, (128,100))
161     file(sys.argv[2], 'wb').write(new.decode('base64'))
162