svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r20855:20928
[blender.git] / source / blender / blenfont / intern / blf_font.c
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <math.h>
33
34 #include <ft2build.h>
35
36 #include FT_FREETYPE_H
37 #include FT_GLYPH_H
38
39 #include "MEM_guardedalloc.h"
40
41 #include "DNA_listBase.h"
42 #include "DNA_vec_types.h"
43
44 #include "BKE_utildefines.h"
45
46 #include "BLI_blenlib.h"
47 #include "BLI_linklist.h"       /* linknode */
48 #include "BLI_string.h"
49 #include "BLI_arithb.h"
50
51 #include "BIF_gl.h"
52 #include "BLF_api.h"
53
54 #include "blf_internal_types.h"
55 #include "blf_internal.h"
56
57
58 /* freetype2 handle. */
59 FT_Library global_ft_lib;
60
61 int blf_font_init(void)
62 {
63         return(FT_Init_FreeType(&global_ft_lib));
64 }
65
66 void blf_font_exit(void)
67 {
68         FT_Done_FreeType(global_ft_lib);
69 }
70
71 void blf_font_size(FontBLF *font, int size, int dpi)
72 {
73         GlyphCacheBLF *gc;
74         FT_Error err;
75
76         err= FT_Set_Char_Size(font->face, 0, (size * 64), dpi, dpi);
77         if (err) {
78                 /* FIXME: here we can go through the fixed size and choice a close one */
79                 printf("The current font don't support the size, %d and dpi, %d\n", size, dpi);
80                 return;
81         }
82
83         font->size= size;
84         font->dpi= dpi;
85
86         gc= blf_glyph_cache_find(font, size, dpi);
87         if (gc)
88                 font->glyph_cache= gc;
89         else {
90                 gc= blf_glyph_cache_new(font);
91                 if (gc)
92                         font->glyph_cache= gc;
93                 else
94                         font->glyph_cache= NULL;
95         }
96 }
97
98 void blf_font_draw(FontBLF *font, char *str)
99 {
100         unsigned int c;
101         GlyphBLF *g, *g_prev;
102         FT_Vector delta;
103         FT_UInt glyph_index, g_prev_index;
104         float pen_x, pen_y, old_pen_x;
105         int i, has_kerning;
106
107         if (!font->glyph_cache)
108                 return;
109
110         i= 0;
111         pen_x= 0;
112         pen_y= 0;
113         has_kerning= FT_HAS_KERNING(font->face);
114         g_prev= NULL;
115         g_prev_index= 0;
116
117         while (str[i]) {
118                 c= blf_utf8_next((unsigned char *)str, &i);
119                 if (c == 0)
120                         break;
121
122                 glyph_index= FT_Get_Char_Index(font->face, c);
123                 g= blf_glyph_search(font->glyph_cache, c);
124                 if (!g)
125                         g= blf_glyph_add(font, glyph_index, c);
126
127                 /* if we don't found a glyph, skip it. */
128                 if (!g)
129                         continue;
130
131                 /*
132                  * This happen if we change the mode of the
133                  * font, we don't drop the glyph cache, so it's
134                  * possible that some glyph don't have the
135                  * bitmap or texture information.
136                  */
137                 if (font->mode == BLF_MODE_BITMAP && (!g->bitmap_data))
138                         g= blf_glyph_add(font, glyph_index, c);
139                 else if (font->mode == BLF_MODE_TEXTURE && (!g->tex_data))
140                         g= blf_glyph_add(font, glyph_index, c);
141
142                 if ((font->flags & BLF_FONT_KERNING) && has_kerning && g_prev) {
143                         old_pen_x= pen_x;
144                         delta.x= 0;
145                         delta.y= 0;
146
147                         if (FT_Get_Kerning(font->face, g_prev_index, glyph_index, FT_KERNING_UNFITTED, &delta) == 0) {
148                                 pen_x += delta.x >> 6;
149
150                                 if (pen_x < old_pen_x)
151                                         pen_x= old_pen_x;
152                         }
153                 }
154
155                 if (font->flags & BLF_USER_KERNING) {
156                         old_pen_x= pen_x;
157                         pen_x += font->kerning;
158
159                         if (pen_x < old_pen_x)
160                                 pen_x= old_pen_x;
161                 }
162
163                 /* do not return this loop if clipped, we want every character tested */
164                 blf_glyph_render(font, g, pen_x, pen_y);
165
166                 pen_x += g->advance;
167                 g_prev= g;
168                 g_prev_index= glyph_index;
169         }
170 }
171
172 void blf_font_boundbox(FontBLF *font, char *str, rctf *box)
173 {
174         unsigned int c;
175         GlyphBLF *g, *g_prev;
176         FT_Vector delta;
177         FT_UInt glyph_index, g_prev_index;
178         rctf gbox;
179         float pen_x, pen_y, old_pen_x;
180         int i, has_kerning;
181
182         if (!font->glyph_cache)
183                 return;
184
185         box->xmin= 32000.0f;
186         box->xmax= -32000.0f;
187         box->ymin= 32000.0f;
188         box->ymax= -32000.0f;
189
190         i= 0;
191         pen_x= 0;
192         pen_y= 0;
193         has_kerning= FT_HAS_KERNING(font->face);
194         g_prev= NULL;
195         g_prev_index= 0;
196
197         while (str[i]) {
198                 c= blf_utf8_next((unsigned char *)str, &i);
199                 if (c == 0)
200                         break;
201
202                 glyph_index= FT_Get_Char_Index(font->face, c);
203                 g= blf_glyph_search(font->glyph_cache, c);
204                 if (!g)
205                         g= blf_glyph_add(font, glyph_index, c);
206
207                 /* if we don't found a glyph, skip it. */
208                 if (!g)
209                         continue;
210
211                 /*
212                  * This happen if we change the mode of the
213                  * font, we don't drop the glyph cache, so it's
214                  * possible that some glyph don't have the
215                  * bitmap or texture information.
216                  */
217                 if (font->mode == BLF_MODE_BITMAP && (!g->bitmap_data))
218                         g= blf_glyph_add(font, glyph_index, c);
219                 else if (font->mode == BLF_MODE_TEXTURE && (!g->tex_data))
220                         g= blf_glyph_add(font, glyph_index, c);
221
222                 if ((font->flags & BLF_FONT_KERNING) && has_kerning && g_prev) {
223                         old_pen_x= pen_x;
224                         delta.x= 0;
225                         delta.y= 0;
226
227                         if (FT_Get_Kerning(font->face, g_prev_index, glyph_index, FT_KERNING_UNFITTED, &delta) == 0) {
228                                 pen_x += delta.x >> 6;
229
230                                 if (pen_x < old_pen_x)
231                                         old_pen_x= pen_x;
232                         }
233                 }
234
235                 if (font->flags & BLF_USER_KERNING) {
236                         old_pen_x= pen_x;
237                         pen_x += font->kerning;
238
239                         if (pen_x < old_pen_x)
240                                 old_pen_x= pen_x;
241                 }
242
243                 gbox.xmin= g->box.xmin + pen_x;
244                 gbox.xmax= g->box.xmax + pen_x;
245                 gbox.ymin= g->box.ymin + pen_y;
246                 gbox.ymax= g->box.ymax + pen_y;
247
248                 if (gbox.xmin < box->xmin)
249                         box->xmin= gbox.xmin;
250                 if (gbox.ymin < box->ymin)
251                         box->ymin= gbox.ymin;
252
253                 if (gbox.xmax > box->xmax)
254                         box->xmax= gbox.xmax;
255                 if (gbox.ymax > box->ymax)
256                         box->ymax= gbox.ymax;
257
258                 pen_x += g->advance;
259                 g_prev= g;
260                 g_prev_index= glyph_index;
261         }
262
263         if (box->xmin > box->xmax) {
264                 box->xmin= 0.0f;
265                 box->ymin= 0.0f;
266                 box->xmax= 0.0f;
267                 box->ymax= 0.0f;
268         }
269 }
270
271 float blf_font_width(FontBLF *font, char *str)
272 {
273         rctf box;
274
275         if (!font->glyph_cache)
276                 return(0.0f);
277
278         blf_font_boundbox(font, str, &box);
279         return((box.xmax - box.xmin) * font->aspect);
280 }
281
282 float blf_font_height(FontBLF *font, char *str)
283 {
284         rctf box;
285
286         if (!font->glyph_cache)
287                 return(0.0f);
288
289         blf_font_boundbox(font, str, &box);
290         return((box.ymax - box.ymin) * font->aspect);
291 }
292
293 void blf_font_free(FontBLF *font)
294 {
295         GlyphCacheBLF *gc;
296
297         font->glyph_cache= NULL;
298         while (font->cache.first) {
299                 gc= font->cache.first;
300                 BLI_remlink(&font->cache, gc);
301                 blf_glyph_cache_free(gc);
302         }
303
304         FT_Done_Face(font->face);
305         if (font->filename)
306                 MEM_freeN(font->filename);
307         if (font->name)
308                 MEM_freeN(font->name);
309         MEM_freeN(font);
310 }
311
312 void blf_font_fill(FontBLF *font)
313 {
314         font->mode= BLF_MODE_TEXTURE;
315         font->aspect= 1.0f;
316         font->pos[0]= 0.0f;
317         font->pos[1]= 0.0f;
318         font->angle= 0.0f;
319         Mat4One(font->mat);
320         font->clip_rec.xmin= 0.0f;
321         font->clip_rec.xmax= 0.0f;
322         font->clip_rec.ymin= 0.0f;
323         font->clip_rec.ymax= 0.0f;
324         font->flags= BLF_USER_KERNING | BLF_FONT_KERNING;
325         font->dpi= 0;
326         font->size= 0;
327         font->kerning= 0.0f;
328         font->cache.first= NULL;
329         font->cache.last= NULL;
330         font->glyph_cache= NULL;
331         font->blur= 0;
332         glGetIntegerv(GL_MAX_TEXTURE_SIZE, (GLint *)&font->max_tex_size);
333 }
334
335 FontBLF *blf_font_new(char *name, char *filename)
336 {
337         FontBLF *font;
338         FT_Error err;
339         char *mfile;
340
341         font= (FontBLF *)MEM_mallocN(sizeof(FontBLF), "blf_font_new");
342         err= FT_New_Face(global_ft_lib, filename, 0, &font->face);
343         if (err) {
344                 MEM_freeN(font);
345                 return(NULL);
346         }
347
348         err= FT_Select_Charmap(font->face, ft_encoding_unicode);
349         if (err) {
350                 printf("Can't set the unicode character map!\n");
351                 FT_Done_Face(font->face);
352                 MEM_freeN(font);
353                 return(NULL);
354         }
355
356         mfile= blf_dir_metrics_search(filename);
357         if (mfile) {
358                 err= FT_Attach_File(font->face, mfile);
359                 MEM_freeN(mfile);
360         }
361
362         font->name= BLI_strdup(name);
363         font->filename= BLI_strdup(filename);
364         blf_font_fill(font);
365         return(font);
366 }
367
368 void blf_font_attach_from_mem(FontBLF *font, const unsigned char *mem, int mem_size)
369 {
370         FT_Open_Args open;
371
372         open.flags= FT_OPEN_MEMORY;
373         open.memory_base= (FT_Byte *)mem;
374         open.memory_size= mem_size;
375         FT_Attach_Stream(font->face, &open);
376 }
377
378 FontBLF *blf_font_new_from_mem(char *name, unsigned char *mem, int mem_size)
379 {
380         FontBLF *font;
381         FT_Error err;
382
383         font= (FontBLF *)MEM_mallocN(sizeof(FontBLF), "blf_font_new_from_mem");
384         err= FT_New_Memory_Face(global_ft_lib, mem, mem_size, 0, &font->face);
385         if (err) {
386                 MEM_freeN(font);
387                 return(NULL);
388         }
389
390         err= FT_Select_Charmap(font->face, ft_encoding_unicode);
391         if (err) {
392                 printf("Can't set the unicode character map!\n");
393                 FT_Done_Face(font->face);
394                 MEM_freeN(font);
395                 return(NULL);
396         }
397
398         font->name= BLI_strdup(name);
399         font->filename= NULL;
400         blf_font_fill(font);
401         return(font);
402 }