1/***************************************************************************/
2/*                                                                         */
3/*  ftrend1.c                                                              */
4/*                                                                         */
5/*    The FreeType glyph rasterizer interface (body).                      */
6/*                                                                         */
7/*  Copyright 1996-2003, 2005, 2006, 2011 by                               */
8/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
9/*                                                                         */
10/*  This file is part of the FreeType project, and may only be used,       */
11/*  modified, and distributed under the terms of the FreeType project      */
12/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
13/*  this file you indicate that you have read the license and              */
14/*  understand and accept it fully.                                        */
15/*                                                                         */
16/***************************************************************************/
17
18
19#include <ft2build.h>
20#include FT_INTERNAL_OBJECTS_H
21#include FT_OUTLINE_H
22#include "ftrend1.h"
23#include "ftraster.h"
24#include "rastpic.h"
25
26#include "rasterrs.h"
27
28
29  /* initialize renderer -- init its raster */
30  static FT_Error
31  ft_raster1_init( FT_Renderer  render )
32  {
33    FT_Library  library = FT_MODULE_LIBRARY( render );
34
35
36    render->clazz->raster_class->raster_reset( render->raster,
37                                               library->raster_pool,
38                                               library->raster_pool_size );
39
40    return Raster_Err_Ok;
41  }
42
43
44  /* set render-specific mode */
45  static FT_Error
46  ft_raster1_set_mode( FT_Renderer  render,
47                       FT_ULong     mode_tag,
48                       FT_Pointer   data )
49  {
50    /* we simply pass it to the raster */
51    return render->clazz->raster_class->raster_set_mode( render->raster,
52                                                         mode_tag,
53                                                         data );
54  }
55
56
57  /* transform a given glyph image */
58  static FT_Error
59  ft_raster1_transform( FT_Renderer       render,
60                        FT_GlyphSlot      slot,
61                        const FT_Matrix*  matrix,
62                        const FT_Vector*  delta )
63  {
64    FT_Error error = Raster_Err_Ok;
65
66
67    if ( slot->format != render->glyph_format )
68    {
69      error = Raster_Err_Invalid_Argument;
70      goto Exit;
71    }
72
73    if ( matrix )
74      FT_Outline_Transform( &slot->outline, matrix );
75
76    if ( delta )
77      FT_Outline_Translate( &slot->outline, delta->x, delta->y );
78
79  Exit:
80    return error;
81  }
82
83
84  /* return the glyph's control box */
85  static void
86  ft_raster1_get_cbox( FT_Renderer   render,
87                       FT_GlyphSlot  slot,
88                       FT_BBox*      cbox )
89  {
90    FT_MEM_ZERO( cbox, sizeof ( *cbox ) );
91
92    if ( slot->format == render->glyph_format )
93      FT_Outline_Get_CBox( &slot->outline, cbox );
94  }
95
96
97  /* convert a slot's glyph image into a bitmap */
98  static FT_Error
99  ft_raster1_render( FT_Renderer       render,
100                     FT_GlyphSlot      slot,
101                     FT_Render_Mode    mode,
102                     const FT_Vector*  origin )
103  {
104    FT_Error     error;
105    FT_Outline*  outline;
106    FT_BBox      cbox;
107    FT_UInt      width, height, pitch;
108    FT_Bitmap*   bitmap;
109    FT_Memory    memory;
110
111    FT_Raster_Params  params;
112
113
114    /* check glyph image format */
115    if ( slot->format != render->glyph_format )
116    {
117      error = Raster_Err_Invalid_Argument;
118      goto Exit;
119    }
120
121    /* check rendering mode */
122#ifndef FT_CONFIG_OPTION_PIC
123    if ( mode != FT_RENDER_MODE_MONO )
124    {
125      /* raster1 is only capable of producing monochrome bitmaps */
126      if ( render->clazz == &ft_raster1_renderer_class )
127        return Raster_Err_Cannot_Render_Glyph;
128    }
129    else
130    {
131      /* raster5 is only capable of producing 5-gray-levels bitmaps */
132      if ( render->clazz == &ft_raster5_renderer_class )
133        return Raster_Err_Cannot_Render_Glyph;
134    }
135#else /* FT_CONFIG_OPTION_PIC */
136    /* When PIC is enabled, we cannot get to the class object      */
137    /* so instead we check the final character in the class name   */
138    /* ("raster5" or "raster1"). Yes this is a hack.               */
139    /* The "correct" thing to do is have different render function */
140    /* for each of the classes.                                    */
141    if ( mode != FT_RENDER_MODE_MONO )
142    {
143      /* raster1 is only capable of producing monochrome bitmaps */
144      if ( render->clazz->root.module_name[6] == '1' )
145        return Raster_Err_Cannot_Render_Glyph;
146    }
147    else
148    {
149      /* raster5 is only capable of producing 5-gray-levels bitmaps */
150      if ( render->clazz->root.module_name[6] == '5' )
151        return Raster_Err_Cannot_Render_Glyph;
152    }
153#endif /* FT_CONFIG_OPTION_PIC */
154
155    outline = &slot->outline;
156
157    /* translate the outline to the new origin if needed */
158    if ( origin )
159      FT_Outline_Translate( outline, origin->x, origin->y );
160
161    /* compute the control box, and grid fit it */
162    FT_Outline_Get_CBox( outline, &cbox );
163
164    /* undocumented but confirmed: bbox values get rounded */
165#if 1
166    cbox.xMin = FT_PIX_ROUND( cbox.xMin );
167    cbox.yMin = FT_PIX_ROUND( cbox.yMin );
168    cbox.xMax = FT_PIX_ROUND( cbox.xMax );
169    cbox.yMax = FT_PIX_ROUND( cbox.yMax );
170#else
171    cbox.xMin = FT_PIX_FLOOR( cbox.xMin );
172    cbox.yMin = FT_PIX_FLOOR( cbox.yMin );
173    cbox.xMax = FT_PIX_CEIL( cbox.xMax );
174    cbox.yMax = FT_PIX_CEIL( cbox.yMax );
175#endif
176
177    width  = (FT_UInt)( ( cbox.xMax - cbox.xMin ) >> 6 );
178    height = (FT_UInt)( ( cbox.yMax - cbox.yMin ) >> 6 );
179
180    if ( width > FT_USHORT_MAX || height > FT_USHORT_MAX )
181    {
182      error = Raster_Err_Invalid_Argument;
183      goto Exit;
184    }
185
186    bitmap = &slot->bitmap;
187    memory = render->root.memory;
188
189    /* release old bitmap buffer */
190    if ( slot->internal->flags & FT_GLYPH_OWN_BITMAP )
191    {
192      FT_FREE( bitmap->buffer );
193      slot->internal->flags &= ~FT_GLYPH_OWN_BITMAP;
194    }
195
196    /* allocate new one, depends on pixel format */
197    if ( !( mode & FT_RENDER_MODE_MONO ) )
198    {
199      /* we pad to 32 bits, only for backwards compatibility with FT 1.x */
200      pitch              = FT_PAD_CEIL( width, 4 );
201      bitmap->pixel_mode = FT_PIXEL_MODE_GRAY;
202      bitmap->num_grays  = 256;
203    }
204    else
205    {
206      pitch              = ( ( width + 15 ) >> 4 ) << 1;
207      bitmap->pixel_mode = FT_PIXEL_MODE_MONO;
208    }
209
210    bitmap->width = width;
211    bitmap->rows  = height;
212    bitmap->pitch = pitch;
213
214    if ( FT_ALLOC_MULT( bitmap->buffer, pitch, height ) )
215      goto Exit;
216
217    slot->internal->flags |= FT_GLYPH_OWN_BITMAP;
218
219    /* translate outline to render it into the bitmap */
220    FT_Outline_Translate( outline, -cbox.xMin, -cbox.yMin );
221
222    /* set up parameters */
223    params.target = bitmap;
224    params.source = outline;
225    params.flags  = 0;
226
227    if ( bitmap->pixel_mode == FT_PIXEL_MODE_GRAY )
228      params.flags |= FT_RASTER_FLAG_AA;
229
230    /* render outline into the bitmap */
231    error = render->raster_render( render->raster, &params );
232
233    FT_Outline_Translate( outline, cbox.xMin, cbox.yMin );
234
235    if ( error )
236      goto Exit;
237
238    slot->format      = FT_GLYPH_FORMAT_BITMAP;
239    slot->bitmap_left = (FT_Int)( cbox.xMin >> 6 );
240    slot->bitmap_top  = (FT_Int)( cbox.yMax >> 6 );
241
242  Exit:
243    return error;
244  }
245
246
247  FT_DEFINE_RENDERER( ft_raster1_renderer_class,
248
249      FT_MODULE_RENDERER,
250      sizeof ( FT_RendererRec ),
251
252      "raster1",
253      0x10000L,
254      0x20000L,
255
256      0,    /* module specific interface */
257
258      (FT_Module_Constructor)ft_raster1_init,
259      (FT_Module_Destructor) 0,
260      (FT_Module_Requester)  0
261    ,
262
263    FT_GLYPH_FORMAT_OUTLINE,
264
265    (FT_Renderer_RenderFunc)   ft_raster1_render,
266    (FT_Renderer_TransformFunc)ft_raster1_transform,
267    (FT_Renderer_GetCBoxFunc)  ft_raster1_get_cbox,
268    (FT_Renderer_SetModeFunc)  ft_raster1_set_mode,
269
270    (FT_Raster_Funcs*)    &FT_STANDARD_RASTER_GET
271  )
272
273
274  /* This renderer is _NOT_ part of the default modules; you will need */
275  /* to register it by hand in your application.  It should only be    */
276  /* used for backwards-compatibility with FT 1.x anyway.              */
277  /*                                                                   */
278  FT_DEFINE_RENDERER( ft_raster5_renderer_class,
279
280      FT_MODULE_RENDERER,
281      sizeof ( FT_RendererRec ),
282
283      "raster5",
284      0x10000L,
285      0x20000L,
286
287      0,    /* module specific interface */
288
289      (FT_Module_Constructor)ft_raster1_init,
290      (FT_Module_Destructor) 0,
291      (FT_Module_Requester)  0
292    ,
293
294    FT_GLYPH_FORMAT_OUTLINE,
295
296    (FT_Renderer_RenderFunc)   ft_raster1_render,
297    (FT_Renderer_TransformFunc)ft_raster1_transform,
298    (FT_Renderer_GetCBoxFunc)  ft_raster1_get_cbox,
299    (FT_Renderer_SetModeFunc)  ft_raster1_set_mode,
300
301    (FT_Raster_Funcs*)    &FT_STANDARD_RASTER_GET
302  )
303
304
305/* END */
306