1 /**************************************************************************** 2 * 3 * ftbzip2.h 4 * 5 * Bzip2-compressed stream support. 6 * 7 * Copyright (C) 2010-2021 by 8 * Joel Klinghed. 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 #ifndef FTBZIP2_H_ 20 #define FTBZIP2_H_ 21 22 #include <freetype/freetype.h> 23 24 #ifdef FREETYPE_H 25 #error "freetype.h of FreeType 1 has been loaded!" 26 #error "Please fix the directory search order for header files" 27 #error "so that freetype.h of FreeType 2 is found first." 28 #endif 29 30 31 FT_BEGIN_HEADER 32 33 /************************************************************************** 34 * 35 * @section: 36 * bzip2 37 * 38 * @title: 39 * BZIP2 Streams 40 * 41 * @abstract: 42 * Using bzip2-compressed font files. 43 * 44 * @description: 45 * In certain builds of the library, bzip2 compression recognition is 46 * automatically handled when calling @FT_New_Face or @FT_Open_Face. 47 * This means that if no font driver is capable of handling the raw 48 * compressed file, the library will try to open a bzip2 compressed 49 * stream from it and re-open the face with it. 50 * 51 * The stream implementation is very basic and resets the decompression 52 * process each time seeking backwards is needed within the stream, 53 * which significantly undermines the performance. 54 * 55 * This section contains the declaration of Bzip2-specific functions. 56 * 57 */ 58 59 60 /************************************************************************** 61 * 62 * @function: 63 * FT_Stream_OpenBzip2 64 * 65 * @description: 66 * Open a new stream to parse bzip2-compressed font files. This is 67 * mainly used to support the compressed `*.pcf.bz2` fonts that come with 68 * XFree86. 69 * 70 * @input: 71 * stream :: 72 * The target embedding stream. 73 * 74 * source :: 75 * The source stream. 76 * 77 * @return: 78 * FreeType error code. 0~means success. 79 * 80 * @note: 81 * The source stream must be opened _before_ calling this function. 82 * 83 * Calling the internal function `FT_Stream_Close` on the new stream will 84 * **not** call `FT_Stream_Close` on the source stream. None of the 85 * stream objects will be released to the heap. 86 * 87 * This function may return `FT_Err_Unimplemented_Feature` if your build 88 * of FreeType was not compiled with bzip2 support. 89 */ 90 FT_EXPORT( FT_Error ) 91 FT_Stream_OpenBzip2( FT_Stream stream, 92 FT_Stream source ); 93 94 /* */ 95 96 97 FT_END_HEADER 98 99 #endif /* FTBZIP2_H_ */ 100 101 102 /* END */ 103