3 FreeType font driver for bdf files
5 Copyright (C) 2001-2008, 2011, 2013, 2014 by
6 Francesco Zappa Nardelli
8 Permission is hereby granted, free of charge, to any person obtaining a copy
9 of this software and associated documentation files (the "Software"), to deal
10 in the Software without restriction, including without limitation the rights
11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 copies of the Software, and to permit persons to whom the Software is
13 furnished to do so, subject to the following conditions:
15 The above copyright notice and this permission notice shall be included in
16 all copies or substantial portions of the Software.
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 #include FT_INTERNAL_DEBUG_H
30 #include FT_INTERNAL_STREAM_H
31 #include FT_INTERNAL_OBJECTS_H
33 #include FT_TRUETYPE_IDS_H
35 #include FT_SERVICE_BDF_H
36 #include FT_SERVICE_XFREE86_NAME_H
44 /*************************************************************************/
46 /* The macro FT_COMPONENT is used in trace mode. It is an implicit */
47 /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log */
48 /* messages during execution. */
51 #define FT_COMPONENT trace_bdfdriver
54 typedef struct BDF_CMapRec_
57 FT_ULong num_encodings; /* ftobjs.h: FT_CMap->clazz->size */
58 BDF_encoding_el* encodings;
60 } BDF_CMapRec, *BDF_CMap;
63 FT_CALLBACK_DEF( FT_Error )
64 bdf_cmap_init( FT_CMap bdfcmap,
65 FT_Pointer init_data )
67 BDF_CMap cmap = (BDF_CMap)bdfcmap;
68 BDF_Face face = (BDF_Face)FT_CMAP_FACE( cmap );
69 FT_UNUSED( init_data );
72 cmap->num_encodings = face->bdffont->glyphs_used;
73 cmap->encodings = face->en_table;
79 FT_CALLBACK_DEF( void )
80 bdf_cmap_done( FT_CMap bdfcmap )
82 BDF_CMap cmap = (BDF_CMap)bdfcmap;
85 cmap->encodings = NULL;
86 cmap->num_encodings = 0;
90 FT_CALLBACK_DEF( FT_UInt )
91 bdf_cmap_char_index( FT_CMap bdfcmap,
94 BDF_CMap cmap = (BDF_CMap)bdfcmap;
95 BDF_encoding_el* encodings = cmap->encodings;
96 FT_ULong min, max, mid; /* num_encodings */
97 FT_UShort result = 0; /* encodings->glyph */
101 max = cmap->num_encodings;
108 mid = ( min + max ) >> 1;
109 code = encodings[mid].enc;
111 if ( charcode == code )
113 /* increase glyph index by 1 -- */
114 /* we reserve slot 0 for the undefined glyph */
115 result = encodings[mid].glyph + 1;
119 if ( charcode < code )
129 FT_CALLBACK_DEF( FT_UInt )
130 bdf_cmap_char_next( FT_CMap bdfcmap,
131 FT_UInt32 *acharcode )
133 BDF_CMap cmap = (BDF_CMap)bdfcmap;
134 BDF_encoding_el* encodings = cmap->encodings;
135 FT_ULong min, max, mid; /* num_encodings */
136 FT_UShort result = 0; /* encodings->glyph */
137 FT_ULong charcode = *acharcode + 1;
141 max = cmap->num_encodings;
145 FT_ULong code; /* same as BDF_encoding_el.enc */
148 mid = ( min + max ) >> 1;
149 code = encodings[mid].enc;
151 if ( charcode == code )
153 /* increase glyph index by 1 -- */
154 /* we reserve slot 0 for the undefined glyph */
155 result = encodings[mid].glyph + 1;
159 if ( charcode < code )
166 if ( min < cmap->num_encodings )
168 charcode = encodings[min].enc;
169 result = encodings[min].glyph + 1;
173 if ( charcode > 0xFFFFFFFFUL )
175 FT_TRACE1(( "bdf_cmap_char_next: charcode 0x%x > 32bit API" ));
177 /* XXX: result should be changed to indicate an overflow error */
180 *acharcode = (FT_UInt32)charcode;
186 const FT_CMap_ClassRec bdf_cmap_class =
188 sizeof ( BDF_CMapRec ),
194 NULL, NULL, NULL, NULL, NULL
199 bdf_interpret_style( BDF_Face bdf )
201 FT_Error error = FT_Err_Ok;
202 FT_Face face = FT_FACE( bdf );
203 FT_Memory memory = face->memory;
204 bdf_font_t* font = bdf->bdffont;
205 bdf_property_t* prop;
207 char* strings[4] = { NULL, NULL, NULL, NULL };
208 size_t nn, len, lengths[4];
211 face->style_flags = 0;
213 prop = bdf_get_font_property( font, (char *)"SLANT" );
214 if ( prop && prop->format == BDF_ATOM &&
216 ( *(prop->value.atom) == 'O' || *(prop->value.atom) == 'o' ||
217 *(prop->value.atom) == 'I' || *(prop->value.atom) == 'i' ) )
219 face->style_flags |= FT_STYLE_FLAG_ITALIC;
220 strings[2] = ( *(prop->value.atom) == 'O' || *(prop->value.atom) == 'o' )
225 prop = bdf_get_font_property( font, (char *)"WEIGHT_NAME" );
226 if ( prop && prop->format == BDF_ATOM &&
228 ( *(prop->value.atom) == 'B' || *(prop->value.atom) == 'b' ) )
230 face->style_flags |= FT_STYLE_FLAG_BOLD;
231 strings[1] = (char *)"Bold";
234 prop = bdf_get_font_property( font, (char *)"SETWIDTH_NAME" );
235 if ( prop && prop->format == BDF_ATOM &&
236 prop->value.atom && *(prop->value.atom) &&
237 !( *(prop->value.atom) == 'N' || *(prop->value.atom) == 'n' ) )
238 strings[3] = (char *)(prop->value.atom);
240 prop = bdf_get_font_property( font, (char *)"ADD_STYLE_NAME" );
241 if ( prop && prop->format == BDF_ATOM &&
242 prop->value.atom && *(prop->value.atom) &&
243 !( *(prop->value.atom) == 'N' || *(prop->value.atom) == 'n' ) )
244 strings[0] = (char *)(prop->value.atom);
246 for ( len = 0, nn = 0; nn < 4; nn++ )
251 lengths[nn] = ft_strlen( strings[nn] );
252 len += lengths[nn] + 1;
258 strings[0] = (char *)"Regular";
259 lengths[0] = ft_strlen( strings[0] );
260 len = lengths[0] + 1;
267 if ( FT_ALLOC( face->style_name, len ) )
270 s = face->style_name;
272 for ( nn = 0; nn < 4; nn++ )
274 char* src = strings[nn];
282 /* separate elements with a space */
283 if ( s != face->style_name )
286 ft_memcpy( s, src, len );
288 /* need to convert spaces to dashes for */
289 /* add_style_name and setwidth_name */
290 if ( nn == 0 || nn == 3 )
295 for ( mm = 0; mm < len; mm++ )
309 FT_CALLBACK_DEF( void )
310 BDF_Face_Done( FT_Face bdfface ) /* BDF_Face */
312 BDF_Face face = (BDF_Face)bdfface;
319 memory = FT_FACE_MEMORY( face );
321 bdf_free_font( face->bdffont );
323 FT_FREE( face->en_table );
325 FT_FREE( face->charset_encoding );
326 FT_FREE( face->charset_registry );
327 FT_FREE( bdfface->family_name );
328 FT_FREE( bdfface->style_name );
330 FT_FREE( bdfface->available_sizes );
332 FT_FREE( face->bdffont );
336 FT_CALLBACK_DEF( FT_Error )
337 BDF_Face_Init( FT_Stream stream,
338 FT_Face bdfface, /* BDF_Face */
341 FT_Parameter* params )
343 FT_Error error = FT_Err_Ok;
344 BDF_Face face = (BDF_Face)bdfface;
345 FT_Memory memory = FT_FACE_MEMORY( face );
347 bdf_font_t* font = NULL;
348 bdf_options_t options;
350 FT_UNUSED( num_params );
354 FT_TRACE2(( "BDF driver\n" ));
356 if ( FT_STREAM_SEEK( 0 ) )
359 options.correct_metrics = 1; /* FZ XXX: options semantics */
360 options.keep_unencoded = 1;
361 options.keep_comments = 0;
362 options.font_spacing = BDF_PROPORTIONAL;
364 error = bdf_load_font( stream, memory, &options, &font );
365 if ( FT_ERR_EQ( error, Missing_Startfont_Field ) )
367 FT_TRACE2(( " not a BDF file\n" ));
373 /* we have a bdf font: let's construct the face object */
374 face->bdffont = font;
376 /* BDF could not have multiple face in single font file.
377 * XXX: non-zero face_index is already invalid argument, but
378 * Type1, Type42 driver has a convention to return
379 * an invalid argument error when the font could be
380 * opened by the specified driver.
382 if ( face_index > 0 ) {
383 FT_ERROR(( "BDF_Face_Init: invalid face index\n" ));
384 BDF_Face_Done( bdfface );
385 return FT_THROW( Invalid_Argument );
389 bdf_property_t* prop = NULL;
392 FT_TRACE4(( " number of glyphs: allocated %d (used %d)\n",
394 font->glyphs_used ));
395 FT_TRACE4(( " number of unencoded glyphs: allocated %d (used %d)\n",
396 font->unencoded_size,
397 font->unencoded_used ));
399 bdfface->num_faces = 1;
400 bdfface->face_index = 0;
402 bdfface->face_flags |= FT_FACE_FLAG_FIXED_SIZES |
403 FT_FACE_FLAG_HORIZONTAL |
404 FT_FACE_FLAG_FAST_GLYPHS;
406 prop = bdf_get_font_property( font, "SPACING" );
407 if ( prop && prop->format == BDF_ATOM &&
409 ( *(prop->value.atom) == 'M' || *(prop->value.atom) == 'm' ||
410 *(prop->value.atom) == 'C' || *(prop->value.atom) == 'c' ) )
411 bdfface->face_flags |= FT_FACE_FLAG_FIXED_WIDTH;
413 /* FZ XXX: TO DO: FT_FACE_FLAGS_VERTICAL */
414 /* FZ XXX: I need a font to implement this */
416 prop = bdf_get_font_property( font, "FAMILY_NAME" );
417 if ( prop && prop->value.atom )
419 if ( FT_STRDUP( bdfface->family_name, prop->value.atom ) )
423 bdfface->family_name = 0;
425 if ( ( error = bdf_interpret_style( face ) ) != 0 )
428 /* the number of glyphs (with one slot for the undefined glyph */
429 /* at position 0 and all unencoded glyphs) */
430 bdfface->num_glyphs = font->glyphs_size + 1;
432 bdfface->num_fixed_sizes = 1;
433 if ( FT_NEW_ARRAY( bdfface->available_sizes, 1 ) )
437 FT_Bitmap_Size* bsize = bdfface->available_sizes;
438 FT_Short resolution_x = 0, resolution_y = 0;
441 FT_MEM_ZERO( bsize, sizeof ( FT_Bitmap_Size ) );
443 bsize->height = (FT_Short)( font->font_ascent + font->font_descent );
445 prop = bdf_get_font_property( font, "AVERAGE_WIDTH" );
447 bsize->width = (FT_Short)( ( prop->value.l + 5 ) / 10 );
449 bsize->width = (FT_Short)( bsize->height * 2/3 );
451 prop = bdf_get_font_property( font, "POINT_SIZE" );
453 /* convert from 722.7 decipoints to 72 points per inch */
455 (FT_Pos)( ( prop->value.l * 64 * 7200 + 36135L ) / 72270L );
457 bsize->size = bsize->width << 6;
459 prop = bdf_get_font_property( font, "PIXEL_SIZE" );
461 bsize->y_ppem = (FT_Short)prop->value.l << 6;
463 prop = bdf_get_font_property( font, "RESOLUTION_X" );
465 resolution_x = (FT_Short)prop->value.l;
467 prop = bdf_get_font_property( font, "RESOLUTION_Y" );
469 resolution_y = (FT_Short)prop->value.l;
471 if ( bsize->y_ppem == 0 )
473 bsize->y_ppem = bsize->size;
475 bsize->y_ppem = bsize->y_ppem * resolution_y / 72;
477 if ( resolution_x && resolution_y )
478 bsize->x_ppem = bsize->y_ppem * resolution_x / resolution_y;
480 bsize->x_ppem = bsize->y_ppem;
485 bdf_glyph_t* cur = font->glyphs;
489 if ( FT_NEW_ARRAY( face->en_table, font->glyphs_size ) )
492 face->default_glyph = 0;
493 for ( n = 0; n < font->glyphs_size; n++ )
495 (face->en_table[n]).enc = cur[n].encoding;
496 FT_TRACE4(( " idx %d, val 0x%lX\n", n, cur[n].encoding ));
497 (face->en_table[n]).glyph = (FT_Short)n;
499 if ( cur[n].encoding == font->default_char )
501 if ( n < FT_UINT_MAX )
502 face->default_glyph = (FT_UInt)n;
504 FT_TRACE1(( "BDF_Face_Init:"
505 " idx %d is too large for this system\n", n ));
512 bdf_property_t *charset_registry = 0, *charset_encoding = 0;
513 FT_Bool unicode_charmap = 0;
517 bdf_get_font_property( font, "CHARSET_REGISTRY" );
519 bdf_get_font_property( font, "CHARSET_ENCODING" );
520 if ( charset_registry && charset_encoding )
522 if ( charset_registry->format == BDF_ATOM &&
523 charset_encoding->format == BDF_ATOM &&
524 charset_registry->value.atom &&
525 charset_encoding->value.atom )
530 if ( FT_STRDUP( face->charset_encoding,
531 charset_encoding->value.atom ) ||
532 FT_STRDUP( face->charset_registry,
533 charset_registry->value.atom ) )
536 /* Uh, oh, compare first letters manually to avoid dependency */
538 s = face->charset_registry;
539 if ( ( s[0] == 'i' || s[0] == 'I' ) &&
540 ( s[1] == 's' || s[1] == 'S' ) &&
541 ( s[2] == 'o' || s[2] == 'O' ) )
544 if ( !ft_strcmp( s, "10646" ) ||
545 ( !ft_strcmp( s, "8859" ) &&
546 !ft_strcmp( face->charset_encoding, "1" ) ) )
551 FT_CharMapRec charmap;
554 charmap.face = FT_FACE( face );
555 charmap.encoding = FT_ENCODING_NONE;
556 /* initial platform/encoding should indicate unset status? */
557 charmap.platform_id = TT_PLATFORM_APPLE_UNICODE;
558 charmap.encoding_id = TT_APPLE_ID_DEFAULT;
560 if ( unicode_charmap )
562 charmap.encoding = FT_ENCODING_UNICODE;
563 charmap.platform_id = TT_PLATFORM_MICROSOFT;
564 charmap.encoding_id = TT_MS_ID_UNICODE_CS;
567 error = FT_CMap_New( &bdf_cmap_class, NULL, &charmap, NULL );
570 /* Select default charmap */
571 if ( bdfface->num_charmaps )
572 bdfface->charmap = bdfface->charmaps[0];
580 /* otherwise assume Adobe standard encoding */
583 FT_CharMapRec charmap;
586 charmap.face = FT_FACE( face );
587 charmap.encoding = FT_ENCODING_ADOBE_STANDARD;
588 charmap.platform_id = TT_PLATFORM_ADOBE;
589 charmap.encoding_id = TT_ADOBE_ID_STANDARD;
591 error = FT_CMap_New( &bdf_cmap_class, NULL, &charmap, NULL );
593 /* Select default charmap */
594 if ( bdfface->num_charmaps )
595 bdfface->charmap = bdfface->charmaps[0];
604 BDF_Face_Done( bdfface );
605 return FT_THROW( Unknown_File_Format );
609 FT_CALLBACK_DEF( FT_Error )
610 BDF_Size_Select( FT_Size size,
611 FT_ULong strike_index )
613 bdf_font_t* bdffont = ( (BDF_Face)size->face )->bdffont;
616 FT_Select_Metrics( size->face, strike_index );
618 size->metrics.ascender = bdffont->font_ascent << 6;
619 size->metrics.descender = -bdffont->font_descent << 6;
620 size->metrics.max_advance = bdffont->bbx.width << 6;
626 FT_CALLBACK_DEF( FT_Error )
627 BDF_Size_Request( FT_Size size,
628 FT_Size_Request req )
630 FT_Face face = size->face;
631 FT_Bitmap_Size* bsize = face->available_sizes;
632 bdf_font_t* bdffont = ( (BDF_Face)face )->bdffont;
633 FT_Error error = FT_ERR( Invalid_Pixel_Size );
637 height = FT_REQUEST_HEIGHT( req );
638 height = ( height + 32 ) >> 6;
642 case FT_SIZE_REQUEST_TYPE_NOMINAL:
643 if ( height == ( ( bsize->y_ppem + 32 ) >> 6 ) )
647 case FT_SIZE_REQUEST_TYPE_REAL_DIM:
648 if ( height == ( bdffont->font_ascent +
649 bdffont->font_descent ) )
654 error = FT_THROW( Unimplemented_Feature );
661 return BDF_Size_Select( size, 0 );
666 FT_CALLBACK_DEF( FT_Error )
667 BDF_Glyph_Load( FT_GlyphSlot slot,
670 FT_Int32 load_flags )
672 BDF_Face bdf = (BDF_Face)FT_SIZE_FACE( size );
673 FT_Face face = FT_FACE( bdf );
674 FT_Error error = FT_Err_Ok;
675 FT_Bitmap* bitmap = &slot->bitmap;
677 int bpp = bdf->bdffont->bpp;
679 FT_UNUSED( load_flags );
684 error = FT_THROW( Invalid_Face_Handle );
688 if ( glyph_index >= (FT_UInt)face->num_glyphs )
690 error = FT_THROW( Invalid_Argument );
694 FT_TRACE1(( "BDF_Glyph_Load: glyph index %d\n", glyph_index ));
696 /* index 0 is the undefined glyph */
697 if ( glyph_index == 0 )
698 glyph_index = bdf->default_glyph;
702 /* slot, bitmap => freetype, glyph => bdflib */
703 glyph = bdf->bdffont->glyphs[glyph_index];
705 bitmap->rows = glyph.bbx.height;
706 bitmap->width = glyph.bbx.width;
707 if ( glyph.bpr > INT_MAX )
708 FT_TRACE1(( "BDF_Glyph_Load: too large pitch %d is truncated\n",
710 bitmap->pitch = (int)glyph.bpr; /* same as FT_Bitmap.pitch */
712 /* note: we don't allocate a new array to hold the bitmap; */
713 /* we can simply point to it */
714 ft_glyphslot_set_bitmap( slot, glyph.bitmap );
719 bitmap->pixel_mode = FT_PIXEL_MODE_MONO;
722 bitmap->pixel_mode = FT_PIXEL_MODE_GRAY2;
725 bitmap->pixel_mode = FT_PIXEL_MODE_GRAY4;
728 bitmap->pixel_mode = FT_PIXEL_MODE_GRAY;
729 bitmap->num_grays = 256;
733 slot->format = FT_GLYPH_FORMAT_BITMAP;
734 slot->bitmap_left = glyph.bbx.x_offset;
735 slot->bitmap_top = glyph.bbx.ascent;
737 slot->metrics.horiAdvance = glyph.dwidth << 6;
738 slot->metrics.horiBearingX = glyph.bbx.x_offset << 6;
739 slot->metrics.horiBearingY = glyph.bbx.ascent << 6;
740 slot->metrics.width = bitmap->width << 6;
741 slot->metrics.height = bitmap->rows << 6;
744 * XXX DWIDTH1 and VVECTOR should be parsed and
745 * used here, provided such fonts do exist.
747 ft_synthesize_vertical_metrics( &slot->metrics,
748 bdf->bdffont->bbx.height << 6 );
762 bdf_get_bdf_property( BDF_Face face,
763 const char* prop_name,
764 BDF_PropertyRec *aproperty )
766 bdf_property_t* prop;
769 FT_ASSERT( face && face->bdffont );
771 prop = bdf_get_font_property( face->bdffont, prop_name );
774 switch ( prop->format )
777 aproperty->type = BDF_PROPERTY_TYPE_ATOM;
778 aproperty->u.atom = prop->value.atom;
782 if ( prop->value.l > 0x7FFFFFFFL || prop->value.l < ( -1 - 0x7FFFFFFFL ) )
784 FT_TRACE1(( "bdf_get_bdf_property:"
785 " too large integer 0x%x is truncated\n" ));
787 aproperty->type = BDF_PROPERTY_TYPE_INTEGER;
788 aproperty->u.integer = (FT_Int32)prop->value.l;
792 if ( prop->value.ul > 0xFFFFFFFFUL )
794 FT_TRACE1(( "bdf_get_bdf_property:"
795 " too large cardinal 0x%x is truncated\n" ));
797 aproperty->type = BDF_PROPERTY_TYPE_CARDINAL;
798 aproperty->u.cardinal = (FT_UInt32)prop->value.ul;
808 return FT_THROW( Invalid_Argument );
813 bdf_get_charset_id( BDF_Face face,
814 const char* *acharset_encoding,
815 const char* *acharset_registry )
817 *acharset_encoding = face->charset_encoding;
818 *acharset_registry = face->charset_registry;
824 static const FT_Service_BDFRec bdf_service_bdf =
826 (FT_BDF_GetCharsetIdFunc)bdf_get_charset_id,
827 (FT_BDF_GetPropertyFunc) bdf_get_bdf_property
837 static const FT_ServiceDescRec bdf_services[] =
839 { FT_SERVICE_ID_BDF, &bdf_service_bdf },
840 { FT_SERVICE_ID_XF86_NAME, FT_XF86_FORMAT_BDF },
845 FT_CALLBACK_DEF( FT_Module_Interface )
846 bdf_driver_requester( FT_Module module,
851 return ft_service_list_lookup( bdf_services, name );
856 FT_CALLBACK_TABLE_DEF
857 const FT_Driver_ClassRec bdf_driver_class =
860 FT_MODULE_FONT_DRIVER |
861 FT_MODULE_DRIVER_NO_OUTLINES,
862 sizeof ( FT_DriverRec ),
870 0, /* FT_Module_Constructor */
871 0, /* FT_Module_Destructor */
875 sizeof ( BDF_FaceRec ),
876 sizeof ( FT_SizeRec ),
877 sizeof ( FT_GlyphSlotRec ),
881 0, /* FT_Size_InitFunc */
882 0, /* FT_Size_DoneFunc */
883 0, /* FT_Slot_InitFunc */
884 0, /* FT_Slot_DoneFunc */
888 0, /* FT_Face_GetKerningFunc */
889 0, /* FT_Face_AttachFunc */
890 0, /* FT_Face_GetAdvancesFunc */