Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenfont / intern / blf_thumbs.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup blf
18  *
19  * Utility function to generate font preview images.
20  *
21  * Isolate since this needs to be called by #ImBuf code (bad level call).
22  */
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27
28 #include <ft2build.h>
29
30 #include FT_FREETYPE_H
31
32 #include "BLI_utildefines.h"
33 #include "BLI_listbase.h"
34 #include "BLI_rect.h"
35 #include "BLI_threads.h"
36
37 #include "blf_internal.h"
38 #include "blf_internal_types.h"
39
40 #include "BLF_api.h"
41 #include "BLT_translation.h"
42
43 #include "BLI_strict_flags.h"
44
45 /**
46  * This function is used for generating thumbnail previews.
47  *
48  * \note called from a thread, so it bypasses the normal BLF_* api (which isn't thread-safe).
49  */
50 void BLF_thumb_preview(
51         const char *filename,
52         const char **draw_str, const unsigned char draw_str_lines,
53         const float font_color[4], const int font_size,
54         unsigned char *buf, int w, int h, int channels)
55 {
56         const unsigned int dpi = 72;
57         const int font_size_min = 6;
58         int font_size_curr;
59         /* shrink 1/th each line */
60         int font_shrink = 4;
61
62         FontBLF *font;
63         int i;
64
65         /* Create a new blender font obj and fill it with default values */
66         font = blf_font_new("thumb_font", filename);
67         if (!font) {
68                 printf("Info: Can't load font '%s', no preview possible\n", filename);
69                 return;
70         }
71
72         /* Would be done via the BLF API, but we're not using a fontid here */
73         font->buf_info.cbuf = buf;
74         font->buf_info.ch = channels;
75         font->buf_info.w = w;
76         font->buf_info.h = h;
77
78         /* Always create the image with a white font,
79          * the caller can theme how it likes */
80         memcpy(font->buf_info.col_init, font_color, sizeof(font->buf_info.col_init));
81         font->pos[1] = (float)h;
82
83         font_size_curr = font_size;
84
85         blf_draw_buffer__start(font);
86
87         for (i = 0; i < draw_str_lines; i++) {
88                 const char *draw_str_i18n = BLT_translate_do(BLT_I18NCONTEXT_DEFAULT, draw_str[i]);
89                 const size_t draw_str_i18n_len = strlen(draw_str_i18n);
90                 int draw_str_i18n_nbr = 0;
91
92                 blf_font_size(font, (unsigned int)MAX2(font_size_min, font_size_curr), dpi);
93
94                 /* font->glyph_cache remains NULL if blf_font_size() failed to set font size */
95                 if (!font->glyph_cache)
96                         break;
97
98                 /* decrease font size each time */
99                 font_size_curr -= (font_size_curr / font_shrink);
100                 font_shrink += 1;
101
102                 font->pos[1] -= font->glyph_cache->ascender * 1.1f;
103
104                 /* We fallback to default english strings in case not enough chars are available in current font for given
105                  * translated string (useful in non-latin i18n context, like chinese, since many fonts will then show
106                  * nothing but ugly 'missing char' in their preview).
107                  * Does not handle all cases, but much better than nothing.
108                  */
109                 if (blf_font_count_missing_chars(
110                         font, draw_str_i18n, draw_str_i18n_len, &draw_str_i18n_nbr) > (draw_str_i18n_nbr / 2))
111                 {
112                         blf_font_draw_buffer(font, draw_str[i], strlen(draw_str[i]), NULL);
113                 }
114                 else {
115                         blf_font_draw_buffer(font, draw_str_i18n, draw_str_i18n_len, NULL);
116                 }
117         }
118
119         blf_draw_buffer__end();
120         blf_font_free(font);
121 }