Merge from 2.5 -r 21285:21515. Thanks Joshua!
[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         int pen_x, pen_y;
105         int i, has_kerning, st;
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 (has_kerning && g_prev) {
143                         delta.x= 0;
144                         delta.y= 0;
145
146                         if (font->flags & BLF_KERNING_DEFAULT)
147                                 st= FT_Get_Kerning(font->face, g_prev_index, glyph_index, ft_kerning_default, &delta);
148                         else
149                                 st= FT_Get_Kerning(font->face, g_prev_index, glyph_index, FT_KERNING_UNFITTED, &delta);
150
151                         if (st == 0)
152                                 pen_x += delta.x >> 6;
153                 }
154
155                 /* do not return this loop if clipped, we want every character tested */
156                 blf_glyph_render(font, g, (float)pen_x, (float)pen_y);
157
158                 pen_x += g->advance;
159                 g_prev= g;
160                 g_prev_index= glyph_index;
161         }
162 }
163
164 void blf_font_boundbox(FontBLF *font, char *str, rctf *box)
165 {
166         unsigned int c;
167         GlyphBLF *g, *g_prev;
168         FT_Vector delta;
169         FT_UInt glyph_index, g_prev_index;
170         rctf gbox;
171         int pen_x, pen_y;
172         int i, has_kerning, st;
173
174         if (!font->glyph_cache)
175                 return;
176
177         box->xmin= 32000.0f;
178         box->xmax= -32000.0f;
179         box->ymin= 32000.0f;
180         box->ymax= -32000.0f;
181
182         i= 0;
183         pen_x= 0;
184         pen_y= 0;
185         has_kerning= FT_HAS_KERNING(font->face);
186         g_prev= NULL;
187         g_prev_index= 0;
188
189         while (str[i]) {
190                 c= blf_utf8_next((unsigned char *)str, &i);
191                 if (c == 0)
192                         break;
193
194                 glyph_index= FT_Get_Char_Index(font->face, c);
195                 g= blf_glyph_search(font->glyph_cache, c);
196                 if (!g)
197                         g= blf_glyph_add(font, glyph_index, c);
198
199                 /* if we don't found a glyph, skip it. */
200                 if (!g)
201                         continue;
202
203                 /*
204                  * This happen if we change the mode of the
205                  * font, we don't drop the glyph cache, so it's
206                  * possible that some glyph don't have the
207                  * bitmap or texture information.
208                  */
209                 if (font->mode == BLF_MODE_BITMAP && (!g->bitmap_data))
210                         g= blf_glyph_add(font, glyph_index, c);
211                 else if (font->mode == BLF_MODE_TEXTURE && (!g->tex_data))
212                         g= blf_glyph_add(font, glyph_index, c);
213
214                 if (has_kerning && g_prev) {
215                         delta.x= 0;
216                         delta.y= 0;
217
218                         if (font->flags & BLF_KERNING_DEFAULT)
219                                 st= FT_Get_Kerning(font->face, g_prev_index, glyph_index, ft_kerning_default, &delta);
220                         else
221                                 st= FT_Get_Kerning(font->face, g_prev_index, glyph_index, FT_KERNING_UNFITTED, &delta);
222
223                         if (st == 0)
224                                 pen_x += delta.x >> 6;
225                 }
226
227                 gbox.xmin= g->box.xmin + pen_x;
228                 gbox.xmax= g->box.xmax + pen_x;
229                 gbox.ymin= g->box.ymin + pen_y;
230                 gbox.ymax= g->box.ymax + pen_y;
231
232                 if (gbox.xmin < box->xmin)
233                         box->xmin= gbox.xmin;
234                 if (gbox.ymin < box->ymin)
235                         box->ymin= gbox.ymin;
236
237                 if (gbox.xmax > box->xmax)
238                         box->xmax= gbox.xmax;
239                 if (gbox.ymax > box->ymax)
240                         box->ymax= gbox.ymax;
241
242                 pen_x += g->advance;
243                 g_prev= g;
244                 g_prev_index= glyph_index;
245         }
246
247         if (box->xmin > box->xmax) {
248                 box->xmin= 0.0f;
249                 box->ymin= 0.0f;
250                 box->xmax= 0.0f;
251                 box->ymax= 0.0f;
252         }
253 }
254
255 float blf_font_width(FontBLF *font, char *str)
256 {
257         rctf box;
258
259         if (!font->glyph_cache)
260                 return(0.0f);
261
262         blf_font_boundbox(font, str, &box);
263         return((box.xmax - box.xmin) * font->aspect);
264 }
265
266 float blf_font_height(FontBLF *font, char *str)
267 {
268         rctf box;
269
270         if (!font->glyph_cache)
271                 return(0.0f);
272
273         blf_font_boundbox(font, str, &box);
274         return((box.ymax - box.ymin) * font->aspect);
275 }
276
277 void blf_font_free(FontBLF *font)
278 {
279         GlyphCacheBLF *gc;
280
281         font->glyph_cache= NULL;
282         while (font->cache.first) {
283                 gc= font->cache.first;
284                 BLI_remlink(&font->cache, gc);
285                 blf_glyph_cache_free(gc);
286         }
287
288         FT_Done_Face(font->face);
289         if (font->filename)
290                 MEM_freeN(font->filename);
291         if (font->name)
292                 MEM_freeN(font->name);
293         MEM_freeN(font);
294 }
295
296 void blf_font_fill(FontBLF *font)
297 {
298         font->mode= BLF_MODE_TEXTURE;
299         font->aspect= 1.0f;
300         font->pos[0]= 0.0f;
301         font->pos[1]= 0.0f;
302         font->angle= 0.0f;
303         Mat4One(font->mat);
304         font->clip_rec.xmin= 0.0f;
305         font->clip_rec.xmax= 0.0f;
306         font->clip_rec.ymin= 0.0f;
307         font->clip_rec.ymax= 0.0f;
308         font->flags= 0;
309         font->dpi= 0;
310         font->size= 0;
311         font->cache.first= NULL;
312         font->cache.last= NULL;
313         font->glyph_cache= NULL;
314         font->blur= 0;
315         glGetIntegerv(GL_MAX_TEXTURE_SIZE, (GLint *)&font->max_tex_size);
316 }
317
318 FontBLF *blf_font_new(char *name, char *filename)
319 {
320         FontBLF *font;
321         FT_Error err;
322         char *mfile;
323
324         font= (FontBLF *)MEM_mallocN(sizeof(FontBLF), "blf_font_new");
325         err= FT_New_Face(global_ft_lib, filename, 0, &font->face);
326         if (err) {
327                 MEM_freeN(font);
328                 return(NULL);
329         }
330
331         err= FT_Select_Charmap(font->face, ft_encoding_unicode);
332         if (err) {
333                 printf("Can't set the unicode character map!\n");
334                 FT_Done_Face(font->face);
335                 MEM_freeN(font);
336                 return(NULL);
337         }
338
339         mfile= blf_dir_metrics_search(filename);
340         if (mfile) {
341                 err= FT_Attach_File(font->face, mfile);
342                 MEM_freeN(mfile);
343         }
344
345         font->name= BLI_strdup(name);
346         font->filename= BLI_strdup(filename);
347         blf_font_fill(font);
348         return(font);
349 }
350
351 void blf_font_attach_from_mem(FontBLF *font, const unsigned char *mem, int mem_size)
352 {
353         FT_Open_Args open;
354
355         open.flags= FT_OPEN_MEMORY;
356         open.memory_base= (FT_Byte *)mem;
357         open.memory_size= mem_size;
358         FT_Attach_Stream(font->face, &open);
359 }
360
361 FontBLF *blf_font_new_from_mem(char *name, unsigned char *mem, int mem_size)
362 {
363         FontBLF *font;
364         FT_Error err;
365
366         font= (FontBLF *)MEM_mallocN(sizeof(FontBLF), "blf_font_new_from_mem");
367         err= FT_New_Memory_Face(global_ft_lib, mem, mem_size, 0, &font->face);
368         if (err) {
369                 MEM_freeN(font);
370                 return(NULL);
371         }
372
373         err= FT_Select_Charmap(font->face, ft_encoding_unicode);
374         if (err) {
375                 printf("Can't set the unicode character map!\n");
376                 FT_Done_Face(font->face);
377                 MEM_freeN(font);
378                 return(NULL);
379         }
380
381         font->name= BLI_strdup(name);
382         font->filename= NULL;
383         blf_font_fill(font);
384         return(font);
385 }