pix_internal.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_PIX_INTERNAL_H
#define  LEPTONICA_PIX_INTERNAL_H
 
/*-------------------------------------------------------------------------*
 *                              Basic Pix                                  *
 *-------------------------------------------------------------------------*/
    /* The 'special' field is by default 0, but it can hold integers
     * that direct non-default actions, e.g., in png and jpeg I/O. */
 
struct Pix
{
    l_uint32             w;         
    l_uint32             h;         
    l_uint32             d;         
    l_uint32             spp;       
    l_uint32             wpl;       
    l_atomic             refcount;  
    l_int32              xres;      
    l_int32              yres;      
    l_int32              informat;  
    l_int32              special;   
    char                *text;      
    struct PixColormap  *colormap;  
    l_uint32            *data;      
};
 
struct PixColormap
{
    void            *array;   
    l_int32          depth;   
    l_int32          nalloc;  
    l_int32          n;       
};
 
 
struct RGBA_Quad
{
    l_uint8     blue;         
    l_uint8     green;        
    l_uint8     red;          
    l_uint8     alpha;        
};
 
 
/*-------------------------------------------------------------------------*
 *                              Array of pix                               *
 *-------------------------------------------------------------------------*/
    /*  Serialization for primary data structures */
#define  PIXAA_VERSION_NUMBER      2  
#define  PIXA_VERSION_NUMBER       2  
#define  BOXA_VERSION_NUMBER       2  
#define  BOXAA_VERSION_NUMBER      3  
struct Pixa
{
    l_int32             n;          
    l_int32             nalloc;     
    l_atomic            refcount;   
    struct Pix        **pix;        
    struct Boxa        *boxa;       
};
 
struct Pixaa
{
    l_int32             n;          
    l_int32             nalloc;     
    struct Pixa       **pixa;       
    struct Boxa        *boxa;       
};
 
 
/*-------------------------------------------------------------------------*
 *                    Basic rectangle and rectangle arrays                 *
 *-------------------------------------------------------------------------*/
struct Box
{
    l_int32            x;           
    l_int32            y;           
    l_int32            w;           
    l_int32            h;           
    l_atomic           refcount;    
};
 
struct Boxa
{
    l_int32            n;           
    l_int32            nalloc;      
    l_atomic           refcount;    
    struct Box       **box;         
};
 
struct Boxaa
{
    l_int32            n;           
    l_int32            nalloc;      
    struct Boxa      **boxa;        
};
 
 
/*-------------------------------------------------------------------------*
 *                               Array of points                           *
 *-------------------------------------------------------------------------*/
#define  PTA_VERSION_NUMBER      1  
struct Pta
{
    l_int32            n;           
    l_int32            nalloc;      
    l_atomic           refcount;    
    l_float32         *x, *y;       
};
 
 
/*-------------------------------------------------------------------------*
 *                              Array of Pta                               *
 *-------------------------------------------------------------------------*/
struct Ptaa
{
    l_int32              n;         
    l_int32              nalloc;    
    struct Pta         **pta;       
};
 
 
/*-------------------------------------------------------------------------*
 *                       Pix accumulator container                         *
 *-------------------------------------------------------------------------*/
struct Pixacc
{
    l_int32             w;          
    l_int32             h;          
    l_int32             offset;     
    struct Pix         *pix;        
};
 
 
/*-------------------------------------------------------------------------*
 *                              Pix tiling                                 *
 *-------------------------------------------------------------------------*/
struct PixTiling
{
    struct Pix          *pix;       
    l_int32              nx;        
    l_int32              ny;        
    l_int32              w;         
    l_int32              h;         
    l_int32              xoverlap;  
    l_int32              yoverlap;  
    l_int32              strip;     
};
 
 
/*-------------------------------------------------------------------------*
 *                       FPix: pix with float array                        *
 *-------------------------------------------------------------------------*/
#define  FPIX_VERSION_NUMBER      2 
struct FPix
{
    l_int32              w;         
    l_int32              h;         
    l_int32              wpl;       
    l_atomic             refcount;  
    l_int32              xres;      
    l_int32              yres;      
    l_float32           *data;      
};
 
struct FPixa
{
    l_int32             n;          
    l_int32             nalloc;     
    l_atomic            refcount;   
    struct FPix       **fpix;       
};
 
 
/*-------------------------------------------------------------------------*
 *                       DPix: pix with double array                       *
 *-------------------------------------------------------------------------*/
#define  DPIX_VERSION_NUMBER      2 
struct DPix
{
    l_int32              w;         
    l_int32              h;         
    l_int32              wpl;       
    l_atomic             refcount;  
    l_int32              xres;      
    l_int32              yres;      
    l_float64           *data;      
};
 
 
/*-------------------------------------------------------------------------*
 *                        PixComp: compressed pix                          *
 *-------------------------------------------------------------------------*/
struct PixComp
{
    l_int32              w;         
    l_int32              h;         
    l_int32              d;         
    l_int32              xres;      
    l_int32              yres;      
    l_int32              comptype;  
    char                *text;      
    l_int32              cmapflag;  
    l_uint8             *data;      
    size_t               size;      
};
 
 
/*-------------------------------------------------------------------------*
 *                     PixaComp: array of compressed pix                   *
 *-------------------------------------------------------------------------*/
#define  PIXACOMP_VERSION_NUMBER 2  
struct PixaComp
{
    l_int32              n;         
    l_int32              nalloc;    
    l_int32              offset;    
    struct PixComp     **pixc;      
    struct Boxa         *boxa;      
};
 
#endif  /* LEPTONICA_PIX_INTERNAL_H */