|
| PIXA * | pixaReadFiles (const char *dirname, const char *substr) |
| |
| PIXA * | pixaReadFilesSA (SARRAY *sa) |
| |
| PIX * | pixRead (const char *filename) |
| |
| PIX * | pixReadWithHint (const char *filename, l_int32 hint) |
| |
| PIX * | pixReadIndexed (SARRAY *sa, l_int32 index) |
| |
| PIX * | pixReadStream (FILE *fp, l_int32 hint) |
| |
| l_ok | pixReadHeader (const char *filename, l_int32 *pformat, l_int32 *pw, l_int32 *ph, l_int32 *pbps, l_int32 *pspp, l_int32 *piscmap) |
| |
| l_ok | findFileFormat (const char *filename, l_int32 *pformat) |
| |
| l_ok | findFileFormatStream (FILE *fp, l_int32 *pformat) |
| |
| l_ok | findFileFormatBuffer (const l_uint8 *buf, l_int32 *pformat) |
| |
| l_int32 | fileFormatIsTiff (FILE *fp) |
| |
| PIX * | pixReadMem (const l_uint8 *data, size_t size) |
| |
| l_ok | pixReadHeaderMem (const l_uint8 *data, size_t size, l_int32 *pformat, l_int32 *pw, l_int32 *ph, l_int32 *pbps, l_int32 *pspp, l_int32 *piscmap) |
| |
| l_ok | writeImageFileInfo (const char *filename, FILE *fpout, l_int32 headeronly) |
| |
| l_ok | ioFormatTest (const char *filename) |
| |
|
| static const char * | FILE_BMP = "/tmp/lept/format/file.bmp" |
| |
| static const char * | FILE_PNG = "/tmp/lept/format/file.png" |
| |
| static const char * | FILE_PNM = "/tmp/lept/format/file.pnm" |
| |
| static const char * | FILE_G3 = "/tmp/lept/format/file_g3.tif" |
| |
| static const char * | FILE_G4 = "/tmp/lept/format/file_g4.tif" |
| |
| static const char * | FILE_RLE = "/tmp/lept/format/file_rle.tif" |
| |
| static const char * | FILE_PB = "/tmp/lept/format/file_packbits.tif" |
| |
| static const char * | FILE_LZW = "/tmp/lept/format/file_lzw.tif" |
| |
| static const char * | FILE_ZIP = "/tmp/lept/format/file_zip.tif" |
| |
| static const char * | FILE_TIFF_JPEG = "/tmp/lept/format/file_jpeg.tif" |
| |
| static const char * | FILE_TIFF = "/tmp/lept/format/file.tif" |
| |
| static const char * | FILE_JPG = "/tmp/lept/format/file.jpg" |
| |
| static const char * | FILE_GIF = "/tmp/lept/format/file.gif" |
| |
| static const char * | FILE_WEBP = "/tmp/lept/format/file.webp" |
| |
| static const char * | FILE_JP2K = "/tmp/lept/format/file.jp2" |
| |
| static const unsigned char | JP2K_CODESTREAM [4] = { 0xff, 0x4f, 0xff, 0x51 } |
| |
| static const unsigned char | JP2K_IMAGE_DATA [12] |
| |
| const char * | ImageFileFormatExtensions [] |
| |
: reads image on file into memory
Top-level functions for reading images from file
PIXA *pixaReadFiles()
PIXA *pixaReadFilesSA()
PIX *pixRead()
PIX *pixReadWithHint()
PIX *pixReadIndexed()
PIX *pixReadStream()
Read header information from file
l_int32 pixReadHeader()
Format finders
l_int32 findFileFormat()
l_int32 findFileFormatStream()
l_int32 findFileFormatBuffer()
l_int32 fileFormatIsTiff()
Read from memory
PIX *pixReadMem()
l_int32 pixReadHeaderMem()
Output image file information
void writeImageFileInfo()
Test function for I/O with different formats
l_int32 ioFormatTest()
Supported file formats:
(1) Reading is supported without any external libraries:
bmp
pnm (including pbm, pgm, etc)
spix (raw serialized)
(2) Reading is supported with installation of external libraries:
png
jpg (standard jfif version)
tiff (including most varieties of compression)
gif
webp
jp2 (jpeg 2000)
(3) Other file types will get an "unknown format" error.
Definition in file readfile.c.
| l_ok findFileFormatBuffer |
( |
const l_uint8 * | buf, |
|
|
l_int32 * | pformat ) |
| l_ok ioFormatTest |
( |
const char * | filename | ) |
|
ioFormatTest()
- Parameters
-
| [in] | filename | input image file |
- Returns
- 0 if OK; 1 on error or if the test fails
Notes:
(1) This writes and reads a set of output files losslessly
in different formats to /tmp/format/, and tests that the
result before and after is unchanged.
(2) This should work properly on input images of any depth,
with and without colormaps.
(3) All supported formats are tested for bmp, png, tiff and
non-ascii pnm. Ascii pnm also works (but who'd ever want
to use it?) We allow 2 bpp bmp, although it's not
supported elsewhere. And we don't support reading
16 bpp png, although this can be turned on in pngio.c.
(4) This silently skips png or tiff testing if HAVE_LIBPNG
or HAVE_LIBTIFF are 0, respectively.
Definition at line 1265 of file readfile.c.
References pixRead(), and REMOVE_CMAP_BASED_ON_SRC.
| l_ok pixReadHeader |
( |
const char * | filename, |
|
|
l_int32 * | pformat, |
|
|
l_int32 * | pw, |
|
|
l_int32 * | ph, |
|
|
l_int32 * | pbps, |
|
|
l_int32 * | pspp, |
|
|
l_int32 * | piscmap ) |
pixReadHeader()
- Parameters
-
| [in] | filename | with full pathname or in local directory |
| [out] | pformat | [optional] file format |
| [out] | pw,ph | [optional] width and height |
| [out] | pbps | [optional] bits/sample |
| [out] | pspp | [optional] samples/pixel 1, 3 or 4 |
| [out] | piscmap | [optional] 1 if cmap exists; 0 otherwise |
- Returns
- 0 if OK, 1 on error
Notes:
(1) This reads the actual headers for jpeg, png, tiff and pnm.
For bmp and gif, we cheat and read the entire file into a pix,
from which we extract the "header" information.
Definition at line 435 of file readfile.c.
References findFileFormatStream(), and pixRead().
Referenced by writeImageFileInfo().
| l_ok pixReadHeaderMem |
( |
const l_uint8 * | data, |
|
|
size_t | size, |
|
|
l_int32 * | pformat, |
|
|
l_int32 * | pw, |
|
|
l_int32 * | ph, |
|
|
l_int32 * | pbps, |
|
|
l_int32 * | pspp, |
|
|
l_int32 * | piscmap ) |
pixReadHeaderMem()
- Parameters
-
| [in] | data | const; encoded |
| [in] | size | size of data |
| [out] | pformat | [optional] image format |
| [out] | pw,ph | [optional] width and height |
| [out] | pbps | [optional] bits/sample |
| [out] | pspp | [optional] samples/pixel 1, 3 or 4 |
| [out] | piscmap | [optional] 1 if cmap exists; 0 otherwise |
- Returns
- 0 if OK, 1 on error
Notes:
(1) This reads the actual headers for jpeg, png, tiff, jp2k and pnm.
For bmp and gif, we cheat and read all the data into a pix,
from which we extract the "header" information.
(2) The amount of data required depends on the format. For
png, it requires less than 30 bytes, but for jpeg it can
require most of the compressed file. In practice, the data
is typically the entire compressed file in memory.
(3) findFileFormatBuffer() requires up to 12 bytes to decide on
the format, which we require.
Definition at line 954 of file readfile.c.
References findFileFormatBuffer().
| PIX * pixReadIndexed |
( |
SARRAY * | sa, |
|
|
l_int32 | index ) |
pixReadIndexed()
- Parameters
-
| [in] | sa | string array of full pathnames |
| [in] | index | into pathname array |
- Returns
- pix if OK; null if not found
Notes:
(1) This function is useful for selecting image files from a
directory, where the integer index is embedded into
the file name.
(2) This is typically done by generating the sarray using
getNumberedPathnamesInDirectory(), so that the index
pathname would have the number index in it. The size
of the sarray should be the largest number (plus 1) appearing
in the file names, respecting the constraints in the
call to getNumberedPathnamesInDirectory().
(3) Consequently, for some indices into the sarray, there may
be no pathnames in the directory containing that number.
By convention, we place empty C strings ("") in those
locations in the sarray, and it is not an error if such
a string is encountered and no pix is returned.
Therefore, the caller must verify that a pix is returned.
(4) See convertSegmentedPagesToPS() in src/psio1.c for an
example of usage.
Definition at line 274 of file readfile.c.
References L_NOCOPY, and pixRead().
1.12.0