imageio.h

Go to the documentation of this file.

/*====================================================================*
 -  Copyright (C) 2001 Leptonica.  All rights reserved.
 -
 -  Redistribution and use in source and binary forms, with or without
 -  modification, are permitted provided that the following conditions
 -  are met:
 -  1. Redistributions of source code must retain the above copyright
 -     notice, this list of conditions and the following disclaimer.
 -  2. Redistributions in binary form must reproduce the above
 -     copyright notice, this list of conditions and the following
 -     disclaimer in the documentation and/or other materials
 -     provided with the distribution.
 -
 -  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 -  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 -  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 -  A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ANY
 -  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 -  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 -  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 -  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 -  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 -  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 -  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *====================================================================*/
 
#ifndef  LEPTONICA_IMAGEIO_H
#define  LEPTONICA_IMAGEIO_H
 
/* --------------------------------------------------------------- *
 *                    Image file format types                      *
 * --------------------------------------------------------------- */
/*
 *  The IFF_DEFAULT flag is used to write the file out in the
 *  same (input) file format that the pix was read from.  If the pix
 *  was not read from file, the input format field will be
 *  IFF_UNKNOWN and the output file format will be chosen to
 *  be compressed and lossless; namely, IFF_TIFF_G4 for d = 1
 *  and IFF_PNG for everything else.
 *
 *  In the future, new format types that have defined extensions
 *  will be added before IFF_DEFAULT, and will be kept in sync with
 *  the file format extensions in writefile.c.  The positions of
 *  file formats before IFF_DEFAULT will remain invariant.
 */
 
enum {
    IFF_UNKNOWN        = 0,
    IFF_BMP            = 1,
    IFF_JFIF_JPEG      = 2,
    IFF_PNG            = 3,
    IFF_TIFF           = 4,
    IFF_TIFF_PACKBITS  = 5,
    IFF_TIFF_RLE       = 6,
    IFF_TIFF_G3        = 7,
    IFF_TIFF_G4        = 8,
    IFF_TIFF_LZW       = 9,
    IFF_TIFF_ZIP       = 10,
    IFF_PNM            = 11,
    IFF_PS             = 12,
    IFF_GIF            = 13,
    IFF_JP2            = 14,
    IFF_WEBP           = 15,
    IFF_LPDF           = 16,
    IFF_TIFF_JPEG      = 17,
    IFF_DEFAULT        = 18,
    IFF_SPIX           = 19
};
 
/* Convenient macro for checking requested tiff output */
#define  L_FORMAT_IS_TIFF(f)  ((f) == IFF_TIFF || (f) == IFF_TIFF_PACKBITS || \
                               (f) == IFF_TIFF_RLE || (f) == IFF_TIFF_G3 || \
                               (f) == IFF_TIFF_G4 || (f) == IFF_TIFF_LZW || \
                               (f) == IFF_TIFF_ZIP || (f) == IFF_TIFF_JPEG)
 
 
/* --------------------------------------------------------------- *
 *                         Format header ids                       *
 * --------------------------------------------------------------- */
enum {
    BMP_ID             = 0x4d42,     
    TIFF_BIGEND_ID     = 0x4d4d,     
    TIFF_LITTLEEND_ID  = 0x4949      
};
 
 
/* --------------------------------------------------------------- *
 *                Hinting bit flags in jpeg reader                 *
 * --------------------------------------------------------------- */
/* The default behavior is now to fail on data corruption. */
enum {
    L_JPEG_READ_LUMINANCE = 1,    
    L_JPEG_CONTINUE_WITH_BAD_DATA = 2  
};
 
 
/* --------------------------------------------------------------- *
 *                            Jp2k codecs                          *
 * --------------------------------------------------------------- */
enum {
    L_J2K_CODEC = 1,    
    L_JP2_CODEC = 2     
};
 
 
/* --------------------------------------------------------------- *
 *                    Pdf formatted encoding types                 *
 * --------------------------------------------------------------- */
enum {
    L_DEFAULT_ENCODE  = 0,  
    L_JPEG_ENCODE     = 1,  
    L_G4_ENCODE       = 2,  
    L_FLATE_ENCODE    = 3,  
    L_JP2K_ENCODE     = 4   
};
 
 
/* --------------------------------------------------------------- *
 *                    Compressed image data                        *
 * --------------------------------------------------------------- */
/*
 *  In use, either datacomp or data85 will be produced, depending
 *  on whether the data needs to be ascii85 encoded.  PostScript
 *  requires ascii85 encoding; pdf does not.
 *
 *  For the colormap (flate compression only), PostScript uses ascii85
 *  encoding and pdf uses a bracketed array of space-separated
 *  hex-encoded rgb triples.  Only tiff g4 (type == L_G4_ENCODE) uses
 *  the minisblack field.
 */
 
struct L_Compressed_Data
{
    l_int32            type;         
    l_uint8           *datacomp;     
    size_t             nbytescomp;   
    char              *data85;       
    size_t             nbytes85;     
    char              *cmapdata85;   
    char              *cmapdatahex;  
    l_int32            ncolors;      
    l_int32            w;            
    l_int32            h;            
    l_int32            bps;          
    l_int32            spp;          
    l_int32            minisblack;   
    l_int32            predictor;    
    size_t             nbytes;       
    l_int32            res;          
};
typedef struct L_Compressed_Data  L_COMP_DATA;
 
 
/* ------------------------------------------------------------------------- *
 *                           Pdf multi image flags                           *
 * ------------------------------------------------------------------------- */
enum {
    L_FIRST_IMAGE   = 1,    
    L_NEXT_IMAGE    = 2,    
    L_LAST_IMAGE    = 3     
};
 
 
/* ------------------------------------------------------------------------- *
 *                     Intermediate pdf generation data                      *
 * ------------------------------------------------------------------------- */
/*
 *  This accumulates data for generating a pdf of a single page consisting
 *  of an arbitrary number of images.
 *
 *  None of the strings have a trailing newline.
 */
 
struct L_Pdf_Data
{
    char              *title;        
    l_int32            n;            
    l_int32            ncmap;        
    struct L_Ptra     *cida;         
    char              *id;           
    char              *obj1;         
    char              *obj2;         
    char              *obj3;         
    char              *obj4;         
    char              *obj5;         
    char              *poststream;   
    char              *trailer;      
    struct Pta        *xy;           
    struct Pta        *wh;           
    struct Box        *mediabox;     
    struct Sarray     *saprex;       
    struct Sarray     *sacmap;       
    struct L_Dna      *objsize;      
    struct L_Dna      *objloc;       
    l_int32            xrefloc;      
};
typedef struct L_Pdf_Data  L_PDF_DATA;
 
#endif  /* LEPTONICA_IMAGEIO_H */