opc.h

Go to the documentation of this file.

#ifndef OPC_H
#define OPC_H

#ifndef RECT_H
#include "rect.h"
#endif

typedef struct OPC
{
    uint8*      origin; /* Points at 0,0  */
    int         pitch;  /* Byte offset from current line to next lower line */
    Rect        clip;   /* Clipping rectangle */
} OPC;
#define OPC_GetOrigin(opc)  ((opc)->origin) 
#define OPC_GetPitch(opc)   ((opc)->pitch)  
#define OPC_GetClip(opc)    ((opc)->clip)   
#define OPC_Init_Basic( opc, org, lineOff, cl,ct,cr,cb ) \
{\
    (opc)->clip.left = (cl); (opc)->clip.top = (ct); (opc)->clip.right = (cr); (opc)->clip.bottom = (cb);\
    (opc)->pitch = (lineOff);\
    (opc)->origin = (uint8*)(org) - ((opc)->pitch*(ct)) - (sizeof(PIXEL)*(cl));\
}

#define OPC_Init_SDL_Surface( opc, sdl ) \
    OPC_Init_Basic( opc, (sdl)->pixels, (sdl)->pitch, (sdl)->clip_rect.x, (sdl)->clip_rect.y, (sdl)->clip_rect.x + (sdl)->clip_rect.w, (sdl)->clip_rect.y + (sdl)->clip_rect.h )
/* See bmp.h for a windows BITMAPINFO version - BMI_OPC */


typedef struct OPCShape
{
    int16       xOff;   /* Add to x, aligns upper-left corner of shape */
    int16       yOff;   /* Add to y, aligns upper-left corner of shape */
    uint16      wide;   /* Width of shape */
    uint16      high;   /* Height of shape */
    /*
     * Define OPC_POINTERS if OPCShape contains pointers to its data, instead of data offsets
     */
#ifdef OPC_POINTERS
    const int8* code;   /* Pack code array */
    const void* data;   /* Pointer to color data array, or NULL if there isn't any */
    const void* pack;   /* Pointer to packed data index array, or NULL if there isn't any */
#else
    uint32      code;   /* Byte offset to pack code array from OPCShape* */
    uint32      data;   /* Byte offset to color data array, or 0 if there isn't any */
    uint32      pack;   /* Byte offset to packed data index array, or 0 if there isn't any */
#endif
} OPCShape;
/*
 * RLE/SKIP compression constants
 * The odd construction of RUN+DUMP is so we can do mask shapes a little more simple
 * Since minimum size of RUN is DUMP, and RUN>DUMP, any run/dump code is equivalent to masking code.
 * Since DUMP copies are short, they are more matchable, and unrollable
 * Since RUN copy matches are longer, we don't eat extra time to 'switch channels' between run/dump 
 */
#define MAX_SKIP        127 /* We want to favor runs divisible by 4 */
#define MAX_DUMP        48  /* We want to favor runs divisible by 4, and short, readily matched dumps for external compression */
#define MIN_RUN         MAX_DUMP+1  /* We don't want to wast time switching channels over short runs */
#define MAX_RUN         127         /* Skip encoding: Len > MAX_DUMP is RUN of color; one pixel is stored in output data */
#define IS_EOL(v)       ((v)==-128)
#define IS_EOS(v)       (0 == (v))
#define IS_SKIP(v)      ((v)<0)
#define SKIP_CODE(v)    ((int8)(-(v)))
#define SKIP_LEN(v)     (-(v))
#define IS_RUNDUMP(v)   ((v)>0)
#define IS_RUN(v)       ((v) >= MIN_RUN)
#define RUN_CODE(v)     ((int8)(v))
#define RUN_LEN(v)      (v)
#define IS_DUMP(v)      ((v) > 0 && (v) <= MAX_DUMP)
#define DUMP_CODE(v)    ((int8)(v))
#define DUMP_LEN(v)     (v)
#define opc_pack_type   uint8
#define opc_pack_max    255

#endif /* OPC_H */


#ifdef PIXEL

#ifndef OPC_NAMING
#define OPC_NAMING(label)   OPC_##label
#endif

typedef PIXEL   OPC_NAMING(Pixel);

size_t OPC_NAMING(Needs)( int wide, int high );
void OPC_NAMING(Init)( OPC* opc, int xOff, int yOff, const Rect* clip, void* buffer );
void OPC_NAMING(Clip)( OPC* opc, const OPC* src, const Rect* clip );
void OPC_NAMING(Window)( OPC* opc, const OPC* src, const Rect* clip, int orgX, int orgY );
OPC_NAMING(Pixel)* OPC_NAMING(Ptr)( const OPC* dst, int x, int y );
void OPC_NAMING(Plot)( const OPC* dst, int x, int y, OPC_NAMING(Pixel) color );
OPC_NAMING(Pixel) OPC_NAMING(Peek)( const OPC* opc, int x, int y );
void OPC_NAMING(HLine)( const OPC* dst, int x, int y, int wide, OPC_NAMING(Pixel) color );
void OPC_NAMING(VLine)( const OPC* dst, int x, int y, int high, OPC_NAMING(Pixel) color );
void OPC_NAMING(HCopy)( const OPC* dst, int x, int y, int wide, const OPC_NAMING(Pixel)* src );
void OPC_NAMING(Blit)( const OPC* dst, const Rect* rdst, const OPC* src, int sx, int sy );
void OPC_NAMING(Stamp)( const OPC* dst, int dx, int dy, const OPC* src );
void OPC_NAMING(Fill)( const OPC* dst, const Rect* rdst, OPC_NAMING(Pixel) color );
void OPC_NAMING(Shape)( const OPC* dst, const OPCShape* shape, int x, int y );
void OPC_NAMING(Shape_Mask)( const OPC* dst, const OPCShape* shape, int x, int y, OPC_NAMING(Pixel) color );
void OPC_NAMING(Shape_Bound)( Rect* posn, const OPCShape* shape, int x, int y );
OPC_NAMING(Pixel) OPC_NAMING(Shape_MaskColor)( OPC_NAMING(Pixel) color );
size_t OPC_NAMING(Shape_TotalSize)( const OPCShape* shape );
size_t OPC_NAMING(Shape_PackLutSize)( const OPCShape* shape );
size_t OPC_NAMING(Shape_CodeSize)( const OPCShape* shape );
size_t OPC_NAMING(Shape_DataSize)( const OPCShape* shape );


#endif /* PIXEL */