cccecd00bf7124da01ff3d17a895e213703de0b6
[blender.git] / source / blender / blenfont / intern / blf.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file blender/blenfont/intern/blf.c
30  *  \ingroup blf
31  */
32
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <math.h>
38
39 #include <ft2build.h>
40
41 #include FT_FREETYPE_H
42 #include FT_GLYPH_H
43
44 #include "MEM_guardedalloc.h"
45
46 #include "DNA_listBase.h"
47 #include "DNA_vec_types.h"
48
49 #include "BIF_gl.h"
50 #include "BLF_api.h"
51
52 #include "blf_internal_types.h"
53 #include "blf_internal.h"
54
55
56 /* Max number of font in memory.
57  * Take care that now every font have a glyph cache per size/dpi,
58  * so we don't need load the same font with different size, just
59  * load one and call BLF_size.
60  */
61 #define BLF_MAX_FONT 16
62
63 /* Font array. */
64 static FontBLF *global_font[BLF_MAX_FONT];
65
66 /* Number of font. */
67 static int global_font_num= 0;
68
69 /* Default size and dpi, for BLF_draw_default. */
70 static int global_font_default= -1;
71 static int global_font_points= 11;
72 static int global_font_dpi= 72;
73
74 // XXX, should these be made into global_font_'s too?
75 int blf_mono_font= -1;
76 int blf_mono_font_render= -1;
77
78 static FontBLF *BLF_get(int fontid)
79 {
80         if (fontid >= 0 && fontid < BLF_MAX_FONT)
81                 return global_font[fontid];
82         return NULL;
83 }
84
85 int BLF_init(int points, int dpi)
86 {
87         int i;
88
89         for (i= 0; i < BLF_MAX_FONT; i++)
90                 global_font[i]= NULL;
91
92         global_font_points= points;
93         global_font_dpi= dpi;
94         return blf_font_init();
95 }
96
97 void BLF_exit(void)
98 {
99         FontBLF *font;
100         int i;
101
102         for (i= 0; i < global_font_num; i++) {
103                 font= global_font[i];
104                 if (font)
105                         blf_font_free(font);
106         }
107
108         blf_font_exit();
109 }
110
111 void BLF_cache_clear(void)
112 {
113         FontBLF *font;
114         int i;
115
116         for (i= 0; i < global_font_num; i++) {
117                 font= global_font[i];
118                 if (font)
119                         blf_glyph_cache_clear(font);
120         }
121 }
122
123 static int blf_search(const char *name)
124 {
125         FontBLF *font;
126         int i;
127
128         for (i= 0; i < BLF_MAX_FONT; i++) {
129                 font= global_font[i];
130                 if (font && (!strcmp(font->name, name)))
131                         return i;
132         }
133         return -1;
134 }
135
136 int BLF_load(const char *name)
137 {
138         FontBLF *font;
139         char *filename;
140         int i;
141
142         if (!name)
143                 return -1;
144
145         /* check if we already load this font. */
146         i= blf_search(name);
147         if (i >= 0) {
148                 /*font= global_font[i];*/ /*UNUSED*/
149                 return i;
150         }
151
152         if (global_font_num+1 >= BLF_MAX_FONT) {
153                 printf("Too many fonts!!!\n");
154                 return -1;
155         }
156
157         filename= blf_dir_search(name);
158         if (!filename) {
159                 printf("Can't find font: %s\n", name);
160                 return -1;
161         }
162
163         font= blf_font_new(name, filename);
164         MEM_freeN(filename);
165
166         if (!font) {
167                 printf("Can't load font: %s\n", name);
168                 return -1;
169         }
170
171         global_font[global_font_num]= font;
172         i= global_font_num;
173         global_font_num++;
174         return i;
175 }
176
177 int BLF_load_unique(const char *name)
178 {
179         FontBLF *font;
180         char *filename;
181         int i;
182
183         if (!name)
184                 return -1;
185
186         /* Don't search in the cache!! make a new
187          * object font, this is for keep fonts threads safe.
188          */
189         if (global_font_num+1 >= BLF_MAX_FONT) {
190                 printf("Too many fonts!!!\n");
191                 return -1;
192         }
193
194         filename= blf_dir_search(name);
195         if (!filename) {
196                 printf("Can't find font: %s\n", name);
197                 return -1;
198         }
199
200         font= blf_font_new(name, filename);
201         MEM_freeN(filename);
202
203         if (!font) {
204                 printf("Can't load font: %s\n", name);
205                 return -1;
206         }
207
208         global_font[global_font_num]= font;
209         i= global_font_num;
210         global_font_num++;
211         return i;
212 }
213
214 void BLF_metrics_attach(int fontid, unsigned char *mem, int mem_size)
215 {
216         FontBLF *font= BLF_get(fontid);
217
218         if (font) {
219                 blf_font_attach_from_mem(font, mem, mem_size);
220         }
221 }
222
223 int BLF_load_mem(const char *name, unsigned char *mem, int mem_size)
224 {
225         FontBLF *font;
226         int i;
227
228         if (!name)
229                 return -1;
230
231         i= blf_search(name);
232         if (i >= 0) {
233                 /*font= global_font[i];*/ /*UNUSED*/
234                 return i;
235         }
236
237         if (global_font_num+1 >= BLF_MAX_FONT) {
238                 printf("Too many fonts!!!\n");
239                 return -1;
240         }
241
242         if (!mem || !mem_size) {
243                 printf("Can't load font: %s from memory!!\n", name);
244                 return -1;
245         }
246
247         font= blf_font_new_from_mem(name, mem, mem_size);
248         if (!font) {
249                 printf("Can't load font: %s from memory!!\n", name);
250                 return -1;
251         }
252
253         global_font[global_font_num]= font;
254         i= global_font_num;
255         global_font_num++;
256         return i;
257 }
258
259 int BLF_load_mem_unique(const char *name, unsigned char *mem, int mem_size)
260 {
261         FontBLF *font;
262         int i;
263
264         if (!name)
265                 return -1;
266
267         /*
268          * Don't search in the cache, make a new object font!
269          * this is to keep the font thread safe.
270          */
271         if (global_font_num+1 >= BLF_MAX_FONT) {
272                 printf("Too many fonts!!!\n");
273                 return -1;
274         }
275
276         if (!mem || !mem_size) {
277                 printf("Can't load font: %s from memory!!\n", name);
278                 return -1;
279         }
280
281         font= blf_font_new_from_mem(name, mem, mem_size);
282         if (!font) {
283                 printf("Can't load font: %s from memory!!\n", name);
284                 return -1;
285         }
286
287         global_font[global_font_num]= font;
288         i= global_font_num;
289         global_font_num++;
290         return i;
291 }
292
293 void BLF_enable(int fontid, int option)
294 {
295         FontBLF *font= BLF_get(fontid);
296
297         if (font) {
298                 font->flags |= option;
299         }
300 }
301
302 void BLF_disable(int fontid, int option)
303 {
304         FontBLF *font= BLF_get(fontid);
305
306         if (font) {
307                 font->flags &= ~option;
308         }
309 }
310
311 void BLF_enable_default(int option)
312 {
313         FontBLF *font= BLF_get(global_font_default);
314
315         if (font) {
316                 font->flags |= option;
317         }
318 }
319
320 void BLF_disable_default(int option)
321 {
322         FontBLF *font= BLF_get(global_font_default);
323
324         if (font) {
325                 font->flags &= ~option;
326         }
327 }
328
329 void BLF_aspect(int fontid, float x, float y, float z)
330 {
331         FontBLF *font= BLF_get(fontid);
332
333         if (font) {
334                 font->aspect[0]= x;
335                 font->aspect[1]= y;
336                 font->aspect[2]= z;
337         }
338 }
339
340 void BLF_matrix(int fontid, const double m[16])
341 {
342         FontBLF *font= BLF_get(fontid);
343
344         if (font) {
345                 memcpy(font->m, m, sizeof(font->m));
346         }
347 }
348
349 void BLF_position(int fontid, float x, float y, float z)
350 {
351         FontBLF *font= BLF_get(fontid);
352
353         if (font) {
354                 float xa, ya, za;
355                 float remainder;
356
357                 if (font->flags & BLF_ASPECT) {
358                         xa= font->aspect[0];
359                         ya= font->aspect[1];
360                         za= font->aspect[2];
361                 }
362                 else {
363                         xa= 1.0f;
364                         ya= 1.0f;
365                         za= 1.0f;
366                 }
367
368                 remainder= x - floorf(x);
369                 if (remainder > 0.4f && remainder < 0.6f) {
370                         if (remainder < 0.5f)
371                                 x -= 0.1f * xa;
372                         else
373                                 x += 0.1f * xa;
374                 }
375
376                 remainder= y - floorf(y);
377                 if (remainder > 0.4f && remainder < 0.6f) {
378                         if (remainder < 0.5f)
379                                 y -= 0.1f * ya;
380                         else
381                                 y += 0.1f * ya;
382                 }
383
384                 remainder= z - floorf(z);
385                 if (remainder > 0.4f && remainder < 0.6f) {
386                         if (remainder < 0.5f)
387                                 z -= 0.1f * za;
388                         else
389                                 z += 0.1f * za;
390                 }
391
392                 font->pos[0]= x;
393                 font->pos[1]= y;
394                 font->pos[2]= z;
395         }
396 }
397
398 void BLF_size(int fontid, int size, int dpi)
399 {
400         FontBLF *font= BLF_get(fontid);
401
402         if (font) {
403                 blf_font_size(font, size, dpi);
404         }
405 }
406
407 void BLF_blur(int fontid, int size)
408 {
409         FontBLF *font= BLF_get(fontid);
410
411         if (font) {
412                 font->blur= size;
413         }
414 }
415
416 void BLF_draw_default(float x, float y, float z, const char *str, size_t len)
417 {
418         if (!str)
419                 return;
420
421         if (global_font_default == -1)
422                 global_font_default= blf_search("default");
423
424         if (global_font_default == -1) {
425                 printf("Warning: Can't found default font!!\n");
426                 return;
427         }
428
429         BLF_size(global_font_default, global_font_points, global_font_dpi);
430         BLF_position(global_font_default, x, y, z);
431         BLF_draw(global_font_default, str, len);
432 }
433
434 /* same as above but call 'BLF_draw_ascii' */
435 void BLF_draw_default_ascii(float x, float y, float z, const char *str, size_t len)
436 {
437         if (!str)
438                 return;
439
440         if (global_font_default == -1)
441                 global_font_default= blf_search("default");
442
443         if (global_font_default == -1) {
444                 printf("Warning: Can't found default font!!\n");
445                 return;
446         }
447
448         BLF_size(global_font_default, global_font_points, global_font_dpi);
449         BLF_position(global_font_default, x, y, z);
450         BLF_draw_ascii(global_font_default, str, len); /* XXX, use real length */
451 }
452
453 void BLF_rotation_default(float angle)
454 {
455         FontBLF *font= BLF_get(global_font_default);
456
457         if (font) {
458                 font->angle= angle;
459         }
460 }
461
462 static void blf_draw__start(FontBLF *font)
463 {
464         /*
465          * The pixmap alignment hack is handle
466          * in BLF_position (old ui_rasterpos_safe).
467          */
468
469         glEnable(GL_BLEND);
470         glEnable(GL_TEXTURE_2D);
471         glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
472
473         glPushMatrix();
474
475         if (font->flags & BLF_MATRIX)
476                 glMultMatrixd((GLdouble *)&font->m);
477
478         glTranslatef(font->pos[0], font->pos[1], font->pos[2]);
479
480         if (font->flags & BLF_ASPECT)
481                 glScalef(font->aspect[0], font->aspect[1], font->aspect[2]);
482
483         if (font->flags & BLF_ROTATION)
484                 glRotatef(font->angle, 0.0f, 0.0f, 1.0f);
485
486         if(font->shadow || font->blur)
487                 glGetFloatv(GL_CURRENT_COLOR, font->orig_col);
488
489         /* always bind the texture for the first glyph */
490         font->tex_bind_state= -1;
491
492 }
493
494 static void blf_draw__end(void)
495 {
496         glPopMatrix();
497         glDisable(GL_BLEND);
498         glDisable(GL_TEXTURE_2D);
499 }
500
501 void BLF_draw(int fontid, const char *str, size_t len)
502 {
503         FontBLF *font= BLF_get(fontid);
504
505         if (font && font->glyph_cache) {
506                 blf_draw__start(font);
507                 blf_font_draw(font, str, len);
508                 blf_draw__end();
509         }
510 }
511
512 void BLF_draw_ascii(int fontid, const char *str, size_t len)
513 {
514         FontBLF *font= BLF_get(fontid);
515
516         if (font && font->glyph_cache) {
517                 blf_draw__start(font);
518                 blf_font_draw_ascii(font, str, len);
519                 blf_draw__end();
520         }
521 }
522
523 void BLF_boundbox(int fontid, const char *str, rctf *box)
524 {
525         FontBLF *font= BLF_get(fontid);
526
527         if (font) {
528                 blf_font_boundbox(font, str, box);
529         }
530 }
531
532 void BLF_width_and_height(int fontid, const char *str, float *width, float *height)
533 {
534         FontBLF *font= BLF_get(fontid);
535
536         if (font && font->glyph_cache) {
537                 blf_font_width_and_height(font, str, width, height);
538         }
539 }
540
541 float BLF_width(int fontid, const char *str)
542 {
543         FontBLF *font= BLF_get(fontid);
544
545         if (font && font->glyph_cache) {
546                 return blf_font_width(font, str);
547         }
548
549         return 0.0f;
550 }
551
552 float BLF_fixed_width(int fontid)
553 {
554         FontBLF *font= BLF_get(fontid);
555
556         if (font && font->glyph_cache) {
557                 return blf_font_fixed_width(font);
558         }
559
560         return 0.0f;
561 }
562
563 float BLF_width_default(const char *str)
564 {
565         if (global_font_default == -1)
566                 global_font_default= blf_search("default");
567
568         if (global_font_default == -1) {
569                 printf("Error: Can't found default font!!\n");
570                 return 0.0f;
571         }
572
573         BLF_size(global_font_default, global_font_points, global_font_dpi);
574         return BLF_width(global_font_default, str);
575 }
576
577 float BLF_height(int fontid, const char *str)
578 {
579         FontBLF *font= BLF_get(fontid);
580
581         if (font && font->glyph_cache) {
582                 return blf_font_height(font, str);
583         }
584
585         return 0.0f;
586 }
587
588 float BLF_height_max(int fontid)
589 {
590         FontBLF *font= BLF_get(fontid);
591
592         if (font && font->glyph_cache) {
593                 return font->glyph_cache->max_glyph_height;
594         }
595
596         return 0.0f;
597 }
598
599 float BLF_width_max(int fontid)
600 {
601         FontBLF *font= BLF_get(fontid);
602
603         if (font && font->glyph_cache) {
604                 return font->glyph_cache->max_glyph_width;
605         }
606
607         return 0.0f;
608 }
609
610 float BLF_descender(int fontid)
611 {
612         FontBLF *font= BLF_get(fontid);
613
614         if (font && font->glyph_cache) {
615                 return font->glyph_cache->descender;
616         }
617
618         return 0.0f;
619 }
620
621 float BLF_ascender(int fontid)
622 {
623         FontBLF *font= BLF_get(fontid);
624
625         if (font && font->glyph_cache) {
626                 return font->glyph_cache->ascender;
627         }
628
629         return 0.0f;
630 }
631
632 float BLF_height_default(const char *str)
633 {
634         if (global_font_default == -1)
635                 global_font_default= blf_search("default");
636
637         if (global_font_default == -1) {
638                 printf("Error: Can't found default font!!\n");
639                 return 0.0f;
640         }
641
642         BLF_size(global_font_default, global_font_points, global_font_dpi);
643
644         return BLF_height(global_font_default, str);
645 }
646
647 void BLF_rotation(int fontid, float angle)
648 {
649         FontBLF *font= BLF_get(fontid);
650
651         if (font) {
652                 font->angle= angle;
653         }
654 }
655
656 void BLF_clipping(int fontid, float xmin, float ymin, float xmax, float ymax)
657 {
658         FontBLF *font= BLF_get(fontid);
659
660         if (font) {
661                 font->clip_rec.xmin= xmin;
662                 font->clip_rec.ymin= ymin;
663                 font->clip_rec.xmax= xmax;
664                 font->clip_rec.ymax= ymax;
665         }
666 }
667
668 void BLF_clipping_default(float xmin, float ymin, float xmax, float ymax)
669 {
670         FontBLF *font= BLF_get(global_font_default);
671
672         if (font) {
673                 font->clip_rec.xmin= xmin;
674                 font->clip_rec.ymin= ymin;
675                 font->clip_rec.xmax= xmax;
676                 font->clip_rec.ymax= ymax;
677         }
678 }
679
680 void BLF_shadow(int fontid, int level, float r, float g, float b, float a)
681 {
682         FontBLF *font= BLF_get(fontid);
683
684         if (font) {
685                 font->shadow= level;
686                 font->shadow_col[0]= r;
687                 font->shadow_col[1]= g;
688                 font->shadow_col[2]= b;
689                 font->shadow_col[3]= a;
690         }
691 }
692
693 void BLF_shadow_offset(int fontid, int x, int y)
694 {
695         FontBLF *font= BLF_get(fontid);
696
697         if (font) {
698                 font->shadow_x= x;
699                 font->shadow_y= y;
700         }
701 }
702
703 void BLF_buffer(int fontid, float *fbuf, unsigned char *cbuf, int w, int h, int nch)
704 {
705         FontBLF *font= BLF_get(fontid);
706
707         if (font) {
708                 font->b_fbuf= fbuf;
709                 font->b_cbuf= cbuf;
710                 font->bw= w;
711                 font->bh= h;
712                 font->bch= nch;
713         }
714 }
715
716 void BLF_buffer_col(int fontid, float r, float g, float b, float a)
717 {
718         FontBLF *font= BLF_get(fontid);
719
720         if (font) {
721                 font->b_col[0]= r;
722                 font->b_col[1]= g;
723                 font->b_col[2]= b;
724                 font->b_col[3]= a;
725         }
726 }
727
728 void BLF_draw_buffer(int fontid, const char *str)
729 {
730         FontBLF *font= BLF_get(fontid);
731
732         if (font && font->glyph_cache && (font->b_fbuf || font->b_cbuf)) {
733                 blf_font_buffer(font, str);
734         }
735 }