1 /***************************************************************************/
5 /* FreeType support for .gz compressed files. */
7 /* This optional component relies on zlib. It should mainly be used to */
8 /* parse compressed PCF fonts, as found with many X11 server */
11 /* Copyright 2002-2006, 2009-2014 by */
12 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
14 /* This file is part of the FreeType project, and may only be used, */
15 /* modified, and distributed under the terms of the FreeType project */
16 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
17 /* this file you indicate that you have read the license and */
18 /* understand and accept it fully. */
20 /***************************************************************************/
24 #include FT_INTERNAL_MEMORY_H
25 #include FT_INTERNAL_STREAM_H
26 #include FT_INTERNAL_DEBUG_H
28 #include FT_CONFIG_STANDARD_LIBRARY_H
31 #include FT_MODULE_ERRORS_H
36 #define FT_ERR_PREFIX Gzip_Err_
37 #define FT_ERR_BASE FT_Mod_Err_Gzip
42 #ifdef FT_CONFIG_OPTION_USE_ZLIB
44 #ifdef FT_CONFIG_OPTION_PIC
45 #error "gzip code does not support PIC yet"
48 #ifdef FT_CONFIG_OPTION_SYSTEM_ZLIB
52 #else /* !FT_CONFIG_OPTION_SYSTEM_ZLIB */
54 /* In this case, we include our own modified sources of the ZLib */
55 /* within the "ftgzip" component. The modifications were necessary */
56 /* to #include all files without conflicts, as well as preventing */
57 /* the definition of "extern" functions that may cause linking */
58 /* conflicts when a program is linked with both FreeType and the */
62 #ifndef USE_ZLIB_ZCALLOC
63 #define MY_ZCALLOC /* prevent all zcalloc() & zfree() in zutils.c */
69 #define SLOW 1 /* we can't use asm-optimized sources here! */
71 #if defined( _MSC_VER ) /* Visual C++ (and Intel C++) */
72 /* We disable the warning `conversion from XXX to YYY, */
73 /* possible loss of data' in order to compile cleanly with */
74 /* the maximum level of warnings: zlib is non-FreeType */
76 #pragma warning( push )
77 #pragma warning( disable : 4244 )
80 /* Urgh. `inflate_mask' must not be declared twice -- C++ doesn't like
81 this. We temporarily disable it and load all necessary header files. */
82 #define NO_INFLATE_MASK
88 #undef NO_INFLATE_MASK
90 /* infutil.c must be included before infcodes.c */
99 #if defined( _MSC_VER )
100 #pragma warning( pop )
103 #endif /* !FT_CONFIG_OPTION_SYSTEM_ZLIB */
106 /***************************************************************************/
107 /***************************************************************************/
109 /***** Z L I B M E M O R Y M A N A G E M E N T *****/
111 /***************************************************************************/
112 /***************************************************************************/
114 /* it is better to use FreeType memory routines instead of raw
118 ft_gzip_alloc( FT_Memory memory,
122 FT_ULong sz = (FT_ULong)size * items;
127 (void)FT_ALLOC( p, sz );
133 ft_gzip_free( FT_Memory memory,
136 FT_MEM_FREE( address );
140 #if !defined( FT_CONFIG_OPTION_SYSTEM_ZLIB ) && !defined( USE_ZLIB_ZCALLOC )
143 zcalloc ( voidpf opaque,
147 return ft_gzip_alloc( (FT_Memory)opaque, items, size );
151 zcfree( voidpf opaque,
154 ft_gzip_free( (FT_Memory)opaque, ptr );
157 #endif /* !SYSTEM_ZLIB && !USE_ZLIB_ZCALLOC */
160 /***************************************************************************/
161 /***************************************************************************/
163 /***** Z L I B F I L E D E S C R I P T O R *****/
165 /***************************************************************************/
166 /***************************************************************************/
168 #define FT_GZIP_BUFFER_SIZE 4096
170 typedef struct FT_GZipFileRec_
172 FT_Stream source; /* parent/source stream */
173 FT_Stream stream; /* embedding stream */
174 FT_Memory memory; /* memory allocator */
175 z_stream zstream; /* zlib input stream */
177 FT_ULong start; /* starting position, after .gz header */
178 FT_Byte input[FT_GZIP_BUFFER_SIZE]; /* input read buffer */
180 FT_Byte buffer[FT_GZIP_BUFFER_SIZE]; /* output buffer */
181 FT_ULong pos; /* position in output */
185 } FT_GZipFileRec, *FT_GZipFile;
189 #define FT_GZIP_ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
190 #define FT_GZIP_HEAD_CRC 0x02 /* bit 1 set: header CRC present */
191 #define FT_GZIP_EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
192 #define FT_GZIP_ORIG_NAME 0x08 /* bit 3 set: original file name present */
193 #define FT_GZIP_COMMENT 0x10 /* bit 4 set: file comment present */
194 #define FT_GZIP_RESERVED 0xE0 /* bits 5..7: reserved */
197 /* check and skip .gz header - we don't support `transparent' compression */
199 ft_gzip_check_header( FT_Stream stream )
205 if ( FT_STREAM_SEEK( 0 ) ||
206 FT_STREAM_READ( head, 4 ) )
209 /* head[0] && head[1] are the magic numbers; */
210 /* head[2] is the method, and head[3] the flags */
211 if ( head[0] != 0x1F ||
213 head[2] != Z_DEFLATED ||
214 (head[3] & FT_GZIP_RESERVED) )
216 error = FT_THROW( Invalid_File_Format );
220 /* skip time, xflags and os code */
221 (void)FT_STREAM_SKIP( 6 );
223 /* skip the extra field */
224 if ( head[3] & FT_GZIP_EXTRA_FIELD )
229 if ( FT_READ_USHORT_LE( len ) ||
230 FT_STREAM_SKIP( len ) )
234 /* skip original file name */
235 if ( head[3] & FT_GZIP_ORIG_NAME )
241 if ( FT_READ_BYTE( c ) )
248 /* skip .gz comment */
249 if ( head[3] & FT_GZIP_COMMENT )
255 if ( FT_READ_BYTE( c ) )
263 if ( head[3] & FT_GZIP_HEAD_CRC )
264 if ( FT_STREAM_SKIP( 2 ) )
273 ft_gzip_file_init( FT_GZipFile zip,
277 z_stream* zstream = &zip->zstream;
278 FT_Error error = FT_Err_Ok;
281 zip->stream = stream;
282 zip->source = source;
283 zip->memory = stream->memory;
285 zip->limit = zip->buffer + FT_GZIP_BUFFER_SIZE;
286 zip->cursor = zip->limit;
289 /* check and skip .gz header */
293 error = ft_gzip_check_header( stream );
297 zip->start = FT_STREAM_POS();
300 /* initialize zlib -- there is no zlib header in the compressed stream */
301 zstream->zalloc = (alloc_func)ft_gzip_alloc;
302 zstream->zfree = (free_func) ft_gzip_free;
303 zstream->opaque = stream->memory;
305 zstream->avail_in = 0;
306 zstream->next_in = zip->buffer;
308 if ( inflateInit2( zstream, -MAX_WBITS ) != Z_OK ||
309 zstream->next_in == NULL )
310 error = FT_THROW( Invalid_File_Format );
318 ft_gzip_file_done( FT_GZipFile zip )
320 z_stream* zstream = &zip->zstream;
323 inflateEnd( zstream );
326 zstream->zalloc = NULL;
327 zstream->zfree = NULL;
328 zstream->opaque = NULL;
329 zstream->next_in = NULL;
330 zstream->next_out = NULL;
331 zstream->avail_in = 0;
332 zstream->avail_out = 0;
341 ft_gzip_file_reset( FT_GZipFile zip )
343 FT_Stream stream = zip->source;
347 if ( !FT_STREAM_SEEK( zip->start ) )
349 z_stream* zstream = &zip->zstream;
352 inflateReset( zstream );
354 zstream->avail_in = 0;
355 zstream->next_in = zip->input;
356 zstream->avail_out = 0;
357 zstream->next_out = zip->buffer;
359 zip->limit = zip->buffer + FT_GZIP_BUFFER_SIZE;
360 zip->cursor = zip->limit;
369 ft_gzip_file_fill_input( FT_GZipFile zip )
371 z_stream* zstream = &zip->zstream;
372 FT_Stream stream = zip->source;
378 size = stream->read( stream, stream->pos, zip->input,
379 FT_GZIP_BUFFER_SIZE );
381 return FT_THROW( Invalid_Stream_Operation );
385 size = stream->size - stream->pos;
386 if ( size > FT_GZIP_BUFFER_SIZE )
387 size = FT_GZIP_BUFFER_SIZE;
390 return FT_THROW( Invalid_Stream_Operation );
392 FT_MEM_COPY( zip->input, stream->base + stream->pos, size );
396 zstream->next_in = zip->input;
397 zstream->avail_in = size;
404 ft_gzip_file_fill_output( FT_GZipFile zip )
406 z_stream* zstream = &zip->zstream;
407 FT_Error error = FT_Err_Ok;
410 zip->cursor = zip->buffer;
411 zstream->next_out = zip->cursor;
412 zstream->avail_out = FT_GZIP_BUFFER_SIZE;
414 while ( zstream->avail_out > 0 )
419 if ( zstream->avail_in == 0 )
421 error = ft_gzip_file_fill_input( zip );
426 err = inflate( zstream, Z_NO_FLUSH );
428 if ( err == Z_STREAM_END )
430 zip->limit = zstream->next_out;
431 if ( zip->limit == zip->cursor )
432 error = FT_THROW( Invalid_Stream_Operation );
435 else if ( err != Z_OK )
437 error = FT_THROW( Invalid_Stream_Operation );
446 /* fill output buffer; `count' must be <= FT_GZIP_BUFFER_SIZE */
448 ft_gzip_file_skip_output( FT_GZipFile zip,
451 FT_Error error = FT_Err_Ok;
457 delta = (FT_ULong)( zip->limit - zip->cursor );
458 if ( delta >= count )
461 zip->cursor += delta;
468 error = ft_gzip_file_fill_output( zip );
478 ft_gzip_file_io( FT_GZipFile zip,
487 /* Reset inflate stream if we're seeking backwards. */
488 /* Yes, that is not too efficient, but it saves memory :-) */
489 if ( pos < zip->pos )
491 error = ft_gzip_file_reset( zip );
496 /* skip unwanted bytes */
497 if ( pos > zip->pos )
499 error = ft_gzip_file_skip_output( zip, (FT_ULong)( pos - zip->pos ) );
507 /* now read the data */
513 delta = (FT_ULong)( zip->limit - zip->cursor );
514 if ( delta >= count )
517 FT_MEM_COPY( buffer, zip->cursor, delta );
520 zip->cursor += delta;
527 error = ft_gzip_file_fill_output( zip );
537 /***************************************************************************/
538 /***************************************************************************/
540 /***** G Z E M B E D D I N G S T R E A M *****/
542 /***************************************************************************/
543 /***************************************************************************/
546 ft_gzip_stream_close( FT_Stream stream )
548 FT_GZipFile zip = (FT_GZipFile)stream->descriptor.pointer;
549 FT_Memory memory = stream->memory;
554 /* finalize gzip file descriptor */
555 ft_gzip_file_done( zip );
559 stream->descriptor.pointer = NULL;
565 ft_gzip_stream_io( FT_Stream stream,
570 FT_GZipFile zip = (FT_GZipFile)stream->descriptor.pointer;
573 return ft_gzip_file_io( zip, pos, buffer, count );
578 ft_gzip_get_uncompressed_size( FT_Stream stream )
585 old_pos = stream->pos;
586 if ( !FT_Stream_Seek( stream, stream->size - 4 ) )
588 result = FT_Stream_ReadULong( stream, &error );
592 (void)FT_Stream_Seek( stream, old_pos );
599 /* documentation is in ftgzip.h */
601 FT_EXPORT_DEF( FT_Error )
602 FT_Stream_OpenGzip( FT_Stream stream,
607 FT_GZipFile zip = NULL;
610 if ( !stream || !source )
612 error = FT_THROW( Invalid_Stream_Handle );
616 memory = source->memory;
619 * check the header right now; this prevents allocating un-necessary
620 * objects when we don't need them
622 error = ft_gzip_check_header( source );
627 stream->memory = memory;
629 if ( !FT_QNEW( zip ) )
631 error = ft_gzip_file_init( zip, stream, source );
638 stream->descriptor.pointer = zip;
642 * We use the following trick to try to dramatically improve the
643 * performance while dealing with small files. If the original stream
644 * size is less than a certain threshold, we try to load the whole font
645 * file into memory. This saves us from using the 32KB buffer needed
646 * to inflate the file, plus the two 4KB intermediate input/output
647 * buffers used in the `FT_GZipFile' structure.
650 FT_ULong zip_size = ft_gzip_get_uncompressed_size( source );
653 if ( zip_size != 0 && zip_size < 40 * 1024 )
655 FT_Byte* zip_buff = NULL;
658 if ( !FT_ALLOC( zip_buff, zip_size ) )
663 count = ft_gzip_file_io( zip, 0, zip_buff, zip_size );
664 if ( count == zip_size )
666 ft_gzip_file_done( zip );
669 stream->descriptor.pointer = NULL;
671 stream->size = zip_size;
673 stream->base = zip_buff;
675 stream->close = ft_gzip_stream_close;
680 ft_gzip_file_io( zip, 0, NULL, 0 );
687 stream->size = 0x7FFFFFFFL; /* don't know the real size! */
690 stream->read = ft_gzip_stream_io;
691 stream->close = ft_gzip_stream_close;
698 /* documentation is in ftgzip.h */
700 FT_EXPORT_DEF( FT_Error )
701 FT_Gzip_Uncompress( FT_Memory memory,
703 FT_ULong* output_len,
704 const FT_Byte* input,
711 /* check for `input' delayed to `inflate' */
713 if ( !memory || ! output_len || !output )
714 return FT_THROW( Invalid_Argument );
716 /* this function is modeled after zlib's `uncompress' function */
718 stream.next_in = (Bytef*)input;
719 stream.avail_in = (uInt)input_len;
721 stream.next_out = output;
722 stream.avail_out = (uInt)*output_len;
724 stream.zalloc = (alloc_func)ft_gzip_alloc;
725 stream.zfree = (free_func) ft_gzip_free;
726 stream.opaque = memory;
728 err = inflateInit2( &stream, MAX_WBITS );
730 return FT_THROW( Invalid_Argument );
732 err = inflate( &stream, Z_FINISH );
733 if ( err != Z_STREAM_END )
735 inflateEnd( &stream );
741 *output_len = stream.total_out;
743 err = inflateEnd( &stream );
746 if ( err == Z_MEM_ERROR )
747 return FT_THROW( Out_Of_Memory );
749 if ( err == Z_BUF_ERROR )
750 return FT_THROW( Array_Too_Large );
752 if ( err == Z_DATA_ERROR )
753 return FT_THROW( Invalid_Table );
759 #else /* !FT_CONFIG_OPTION_USE_ZLIB */
761 FT_EXPORT_DEF( FT_Error )
762 FT_Stream_OpenGzip( FT_Stream stream,
768 return FT_THROW( Unimplemented_Feature );
772 FT_EXPORT_DEF( FT_Error )
773 FT_Gzip_Uncompress( FT_Memory memory,
775 FT_ULong* output_len,
776 const FT_Byte* input,
781 FT_UNUSED( output_len );
783 FT_UNUSED( input_len );
785 return FT_THROW( Unimplemented_Feature );
788 #endif /* !FT_CONFIG_OPTION_USE_ZLIB */