src/text.h

   1 /*
   2  * kmscon - Text Renderer
   3  *
   4  * Copyright (c) 2012 David Herrmann <dh.herrmann@googlemail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files
   8  * (the "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  21  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /*
  27  * Text Renderer
  28  * The Text-Renderer subsystem provides a simple way to draw text into a
  29  * framebuffer. The system is modular and several different backends are
  30  * available that can be used.
  31  * The system is split into:
  32  *  - Font renderer: The font renderer allows selecting fonts and rendering
  33  *    single glyphs into memory-buffers
  34  *  - Text renderer: The text renderer uses the font renderer to draw a whole
  35  *    console into a framebuffer.
  36  */
  37
  38 #ifndef KMSCON_TEXT_H
  39 #define KMSCON_TEXT_H
  40
  41 #include <errno.h>
  42 #include <stdlib.h>
  43 #include "tsm_screen.h"
  44 #include "uterm.h"
  45
  46 /* fonts */
  47
  48 struct kmscon_font_attr;
  49 struct kmscon_glyph;
  50 struct kmscon_font;
  51 struct kmscon_font_ops;
  52
  53 #define KMSCON_FONT_MAX_NAME 128
  54 #define KMSCON_FONT_DEFAULT_NAME "monospace"
  55 #define KMSCON_FONT_DEFAULT_PPI 72
  56
  57 struct kmscon_font_attr {
  58         char name[KMSCON_FONT_MAX_NAME];
  59         unsigned int ppi;
  60         unsigned int points;
  61         bool bold;
  62         bool italic;
  63         unsigned int height;
  64         unsigned int width;
  65 };
  66
  67 void kmscon_font_attr_normalize(struct kmscon_font_attr *attr);
  68 bool kmscon_font_attr_match(const struct kmscon_font_attr *a1,
  69                             const struct kmscon_font_attr *a2);
  70
  71 struct kmscon_glyph {
  72         struct uterm_video_buffer buf;
  73         void *data;
  74 };
  75
  76 struct kmscon_font {
  77         unsigned long ref;
  78         const struct kmscon_font_ops *ops;
  79         struct kmscon_font_attr attr;
  80         unsigned int baseline;
  81         void *data;
  82 };
  83
  84 struct kmscon_font_ops {
  85         const char *name;
  86         int (*init) (struct kmscon_font *out,
  87                      const struct kmscon_font_attr *attr);
  88         void (*destroy) (struct kmscon_font *font);
  89         int (*render) (struct kmscon_font *font,
  90                        uint32_t id, const uint32_t *ch, size_t len,
  91                        const struct kmscon_glyph **out);
  92         int (*render_empty) (struct kmscon_font *font,
  93                              const struct kmscon_glyph **out);
  94         int (*render_inval) (struct kmscon_font *font,
  95                              const struct kmscon_glyph **out);
  96 };
  97
  98 int kmscon_font_register(const struct kmscon_font_ops *ops);
  99 void kmscon_font_unregister(const char *name);
 100
 101 int kmscon_font_find(struct kmscon_font **out,
 102                      const struct kmscon_font_attr *attr,
 103                      const char *backend);
 104 void kmscon_font_ref(struct kmscon_font *font);
 105 void kmscon_font_unref(struct kmscon_font *font);
 106
 107 int kmscon_font_render(struct kmscon_font *font,
 108                        uint32_t id, const uint32_t *ch, size_t len,
 109                        const struct kmscon_glyph **out);
 110 int kmscon_font_render_empty(struct kmscon_font *font,
 111                              const struct kmscon_glyph **out);
 112 int kmscon_font_render_inval(struct kmscon_font *font,
 113                              const struct kmscon_glyph **out);
 114
 115 /* text renderer */
 116
 117 struct kmscon_text;
 118 struct kmscon_text_ops;
 119
 120 struct kmscon_text {
 121         unsigned long ref;
 122         const struct kmscon_text_ops *ops;
 123         void *data;
 124
 125         struct kmscon_font *font;
 126         struct kmscon_font *bold_font;
 127         struct uterm_screen *screen;
 128         unsigned int cols;
 129         unsigned int rows;
 130         bool rendering;
 131 };
 132
 133 struct kmscon_text_ops {
 134         const char *name;
 135         int (*init) (struct kmscon_text *txt);
 136         void (*destroy) (struct kmscon_text *txt);
 137         int (*set) (struct kmscon_text *txt);
 138         void (*unset) (struct kmscon_text *txt);
 139         int (*prepare) (struct kmscon_text *txt);
 140         int (*draw) (struct kmscon_text *txt,
 141                      uint32_t id, const uint32_t *ch, size_t len,
 142                      unsigned int posx, unsigned int posy,
 143                      const struct tsm_screen_attr *attr);
 144         int (*render) (struct kmscon_text *txt);
 145         void (*abort) (struct kmscon_text *txt);
 146 };
 147
 148 int kmscon_text_register(const struct kmscon_text_ops *ops);
 149 void kmscon_text_unregister(const char *name);
 150
 151 int kmscon_text_new(struct kmscon_text **out, const char *backend);
 152 void kmscon_text_ref(struct kmscon_text *txt);
 153 void kmscon_text_unref(struct kmscon_text *txt);
 154
 155 int kmscon_text_set(struct kmscon_text *txt,
 156                     struct kmscon_font *font,
 157                     struct kmscon_font *bold_font,
 158                     struct uterm_screen *screen);
 159 void kmscon_text_unset(struct kmscon_text *txt);
 160 unsigned int kmscon_text_get_cols(struct kmscon_text *txt);
 161 unsigned int kmscon_text_get_rows(struct kmscon_text *txt);
 162
 163 int kmscon_text_prepare(struct kmscon_text *txt);
 164 int kmscon_text_draw(struct kmscon_text *txt,
 165                      uint32_t id, const uint32_t *ch, size_t len,
 166                      unsigned int posx, unsigned int posy,
 167                      const struct tsm_screen_attr *attr);
 168 int kmscon_text_render(struct kmscon_text *txt);
 169 void kmscon_text_abort(struct kmscon_text *txt);
 170
 171 int kmscon_text_prepare_cb(struct tsm_screen *con, void *data);
 172 int kmscon_text_draw_cb(struct tsm_screen *con,
 173                         uint32_t id, const uint32_t *ch, size_t len,
 174                         unsigned int posx, unsigned int posy,
 175                         const struct tsm_screen_attr *attr, void *data);
 176 int kmscon_text_render_cb(struct tsm_screen *con, void *data);
 177
 178 /* modularized backends */
 179
 180 #ifdef BUILD_ENABLE_FONT_8X16
 181
 182 int kmscon_font_8x16_load(void);
 183 void kmscon_font_8x16_unload(void);
 184
 185 #else
 186
 187 static inline int kmscon_font_8x16_load(void)
 188 {
 189         return -EOPNOTSUPP;
 190 }
 191
 192 static inline void kmscon_font_8x16_unload(void)
 193 {
 194 }
 195
 196 #endif
 197
 198 #ifdef BUILD_ENABLE_FONT_UNIFONT
 199
 200 int kmscon_font_unifont_load(void);
 201 void kmscon_font_unifont_unload(void);
 202
 203 #else
 204
 205 static inline int kmscon_font_unifont_load(void)
 206 {
 207         return -EOPNOTSUPP;
 208 }
 209
 210 static inline void kmscon_font_unifont_unload(void)
 211 {
 212 }
 213
 214 #endif
 215
 216 #ifdef BUILD_ENABLE_FONT_FREETYPE2
 217
 218 int kmscon_font_freetype2_load(void);
 219 void kmscon_font_freetype2_unload(void);
 220
 221 #else
 222
 223 static inline int kmscon_font_freetype2_load(void)
 224 {
 225         return -EOPNOTSUPP;
 226 }
 227
 228 static inline void kmscon_font_freetype2_unload(void)
 229 {
 230 }
 231
 232 #endif
 233
 234 #ifdef BUILD_ENABLE_FONT_PANGO
 235
 236 int kmscon_font_pango_load(void);
 237 void kmscon_font_pango_unload(void);
 238
 239 #else
 240
 241 static inline int kmscon_font_pango_load(void)
 242 {
 243         return -EOPNOTSUPP;
 244 }
 245
 246 static inline void kmscon_font_pango_unload(void)
 247 {
 248 }
 249
 250 #endif
 251
 252 #ifdef BUILD_ENABLE_RENDERER_BBLIT
 253
 254 int kmscon_text_bblit_load(void);
 255 void kmscon_text_bblit_unload(void);
 256
 257 #else
 258
 259 static inline int kmscon_text_bblit_load(void)
 260 {
 261         return -EOPNOTSUPP;
 262 }
 263
 264 static inline void kmscon_text_bblit_unload(void)
 265 {
 266 }
 267
 268 #endif
 269
 270 #ifdef BUILD_ENABLE_RENDERER_BBULK
 271
 272 int kmscon_text_bbulk_load(void);
 273 void kmscon_text_bbulk_unload(void);
 274
 275 #else
 276
 277 static inline int kmscon_text_bbulk_load(void)
 278 {
 279         return -EOPNOTSUPP;
 280 }
 281
 282 static inline void kmscon_text_bbulk_unload(void)
 283 {
 284 }
 285
 286 #endif
 287
 288 #ifdef BUILD_ENABLE_RENDERER_GLTEX
 289
 290 int kmscon_text_gltex_load(void);
 291 void kmscon_text_gltex_unload(void);
 292
 293 #else
 294
 295 static inline int kmscon_text_gltex_load(void)
 296 {
 297         return -EOPNOTSUPP;
 298 }
 299
 300 static inline void kmscon_text_gltex_unload(void)
 301 {
 302 }
 303
 304 #endif
 305
 306 static inline void kmscon_font_load_all(void)
 307 {
 308         kmscon_font_8x16_load();
 309         kmscon_font_unifont_load();
 310         kmscon_font_pango_load();
 311         kmscon_font_freetype2_load();
 312 }
 313
 314 static inline void kmscon_font_unload_all(void)
 315 {
 316         kmscon_font_freetype2_unload();
 317         kmscon_font_pango_unload();
 318         kmscon_font_unifont_unload();
 319         kmscon_font_8x16_unload();
 320 }
 321
 322 static inline void kmscon_text_load_all(void)
 323 {
 324         kmscon_text_bbulk_load();
 325         kmscon_text_bblit_load();
 326         kmscon_text_gltex_load();
 327 }
 328
 329 static inline void kmscon_text_unload_all(void)
 330 {
 331         kmscon_text_gltex_unload();
 332         kmscon_text_bblit_unload();
 333         kmscon_text_bbulk_unload();
 334 }
 335
 336 #endif /* KMSCON_TEXT_H */