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