cpfspd.h

Go to the documentation of this file.

/*
 *  CVS id      :  $Id: cpfspd.h,v 2.61 2009/08/25 11:41:57 riemens Exp $ 
 *
 *  Name        :  cpfspd.h
 *
 *  Authors     :  Robert Jan Schutten
 *                 Bram Riemens
 *
 *  Function    :  Header file for cpfspd library
 */

#ifndef CPFSPD_H_INCLUDED
#define CPFSPD_H_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* mandatory include of stdio.h; because of use of (FILE *) */
#include <stdio.h>


typedef enum {
    P_OK                            = 0,
    P_FILE_OPEN_FAILED              = 100,
    P_FILE_CREATE_FAILED            = 101,
    P_FILE_MODIFY_FAILED            = 102,
    P_FILE_IS_NOT_PFSPD_FILE        = 103,
    P_WRITE_FAILED                  = 110,
    P_READ_FAILED                   = 111,
    P_SEEK_FAILED                   = 112,
    P_NEGATIVE_SEEK_ON_STDIO        = 113,
    P_WRITE_BEYOND_EOF_STDOUT       = 115,
    P_REWRITE_ON_STDOUT             = 116,
    P_REWRITE_MODIFIED_HEADER       = 117,
    P_TOO_MANY_IMAGES               = 199,
    P_TOO_MANY_COMPONENTS           = 200,
    P_INVALID_COMPONENT             = 201,
    P_NO_IH_RECORDS_ALLOWED         = 202,
    P_ILLEGAL_BYTES_PER_REC         = 203,
    P_ILLEGAL_TEM_SBSMPL            = 204,
    P_INVALID_AUXILIARY             = 205,
    P_ILLEGAL_LIN_SBSMPL            = 206,
    P_ILLEGAL_PIX_SBSMPL            = 207,
    P_SHOULD_BE_INTERLACED          = 210,
    P_READ_CHR_FROM_LUM_ONLY        = 211,
    P_READ_RGB_FROM_LUM_ONLY        = 212,
    P_READ_PLANAR_CHR_FROM_MULT_CHR = 213,
    P_READ_RGB_FROM_YUV             = 214,
    P_READ_CHR_FROM_RGB             = 215,
    P_READ_CHR_FROM_STREAM          = 216,
    P_READ_RGB_FROM_STREAM          = 217,
    P_READ_INVALID_COMPONENT        = 218,
    P_WRITE_INVALID_COMPONENT       = 219,
    P_WRONG_LUM_COMP_SIZE           = 220,
    P_WRONG_CHR_COMP_SIZE           = 221,
    P_WRONG_RGB_COMP_SIZE           = 222,
    P_WRONG_STREAM_COMP_SIZE        = 223,
    P_WRONG_XYZ_COMP_SIZE           = 224,
    P_EXCEEDING_DESCRIPTION_SIZE    = 225,
    P_WRONG_EXTRA_COMP_SIZE         = 226,
    P_WRONG_SUBSAMPLE_FACTOR        = 227,
    P_EXCEEDING_AUXILIARY_DATA_SIZE = 228,
    P_EXCEEDING_AUXILIARY_HDR_SIZE  = 229,
    P_HEADER_IS_MODIFIED            = 230,
    P_INCOMP_MULT_COLOR_FORMAT      = 242,
    P_INCOMP_PLANAR_COLOR_FORMAT    = 243,
    P_ILLEGAL_COLOR_FORMAT          = 300,
    P_ILLEGAL_IMAGE_FREQUENCY       = 400,
    P_ILLEGAL_IMAGE_FREQ_MOD        = 410,
    P_ILLEGAL_ILP_FREQ_MOD          = 420,
    P_ILLEGAL_IMAGE_SIZE            = 500,
    P_ILLEGAL_INTERLACE             = 501,
    P_ILLEGAL_COMP_SIZE             = 502,
    P_ILLEGAL_PHSHFT                = 503,
    P_ILLEGAL_ASPECT_RATIO          = 600,
    P_ILLEGAL_SIZE_FREQUENCY        = 700,
    P_ILLEGAL_SIZE_INTERLACED_MODE  = 701,
    P_ILLEGAL_SIZE_PROGRESSIVE_MODE = 702,
    P_ILLEGAL_FORMAT_INTERL_MODE    = 703,
    P_ILLEGAL_NUM_OF_PIX_PER_LINE   = 710,
    P_ILLEGAL_FILE_DATA_FORMAT      = 800,
    P_FILE_DATA_FORMATS_NOT_EQUAL   = 810,
    P_ILLEGAL_MEM_DATA_FORMAT       = 820,
    P_UNKNOWN_FILE_TYPE             = 830,
    P_UNKNOWN_MEM_TYPE              = 840,
    P_INCOMP_FLOAT_CONVERSION       = 850,
    P_MALLOC_FAILED                 = 900
} pT_status;
#define P_FILENAME_MAX 1024

/* Total number of global header records: global header structure and attributes */
#define P_NUM_GLOB_RECS   2

/* Global header structure */
#define P_SNR_IMAGES        7      /* number of images                          */
#define P_SNR_COMPON        5      /* number of components                      */
#define P_SNR_FD_RECS       5      /* number of file description records        */
#define P_SNR_AUXDAT_RECS   5      /* number of auxiliary data records          */
#define P_SAPPL_TYPE       25      /* application type                          */
#define P_SBYTES_REC        7      /* bytes per record                          */
#define P_SENDIAN_CODE      1      /* A: big endian U: little endian            */
#define P_SAUX_HDR_RECS     5      /* number of aux header records              */
#define P_LEN_GLOB_STR     60      /* length of global header structure record  */
                                   /* = sum of all above record lengths         */

/* Global header attributes */
#define P_SIMA_FREQ        12      /* image frequency                           */
#define P_SLIN_FREQ        12      /* line frequency                            */
#define P_SPIX_FREQ        12      /* pixel frequency                           */
#define P_SACT_LINES        6      /* active lines                              */
#define P_SACT_PIXEL        6      /* active pixels                             */
#define P_SINTERLACE        2      /* interlace factor                          */
#define P_SH_PP_SIZE        5      /* horizontal proportional  picture size     */
#define P_SV_PP_SIZE        5      /* vertical proportional picture size        */
#define P_LEN_GLOB_ATT     60      /* length of global header attributes record */
                                   /* = sum of all above record lengths         */

/* Total number of component records: component structure and attributes */
#define P_NUM_COMP_RECS     2

/* Component structure */
#define P_SLIN_IMAGE        6      /* lines per image                           */
#define P_SPIX_LINE         6      /* pixels per line                           */
#define P_SDATA_FMT         4      /* data format                               */
#define P_LEN_COMP_STR     16      /* length of component structure record      */
                                   /* = sum of all above record lengths         */

/* Component attributes */
#define P_STEM_SBSMPL       2      /* temporal subsampling                      */
#define P_SLIN_SBSMPL       2      /* line subsampling                          */
#define P_SPIX_SBSMPL       2      /* pixel subsampling                         */
#define P_STEM_PHSHFT       2      /* temporal phase shift                      */
#define P_SLIN_PHSHFT       2      /* line phase shift                          */
#define P_SPIX_PHSHFT       2      /* pixel phase shift                         */
#define P_SCOM_CODE         5      /* component code                            */
#define P_LEN_COMP_ATT     17      /* length of component attributes record     */
                                   /* = sum of all above record lengths         */

/* Description and auxilliary data */
#define P_SDESCRIPTION   2048      /* description                               */
#define P_BYTES_REC       512      /* alignment size for nr of bytes/rec        */
#define P_SAUX_NAME        16      /* name of auxiliary data                    */
#define P_SAUX_HDR      16384      /* size of auxiliary header                  */

#define P_PFSPD_MAX_COMP 128

#define P_Y_COM_CODE            "Y    "
#define P_UV_COM_CODE           "U/V  "
#define P_U_COM_CODE            "U    "
#define P_V_COM_CODE            "V    "
#define P_R_COM_CODE            "R    "
#define P_G_COM_CODE            "G    "
#define P_B_COM_CODE            "B    "
#define P_S_COM_CODE            "S    "
#define P_P_COM_CODE            "P    "
#define P_XYZX_COM_CODE         "X    "
#define P_XYZY_COM_CODE         "Y    "
#define P_XYZZ_COM_CODE         "Z    "
#define P_VOID_COM_CODE         "void "

#define P_VIDEO_APPL_TYPE       "VIDEO                    "

#define P_AUX_LAST              "       8"

#define P_B8_DATA_FMT           "B*8 "
#define P_B10_DATA_FMT          "B*10"
#define P_B12_DATA_FMT          "B*12"
#define P_B14_DATA_FMT          "B*14"
#define P_I2_DATA_FMT           "I*2 "
#define P_R2_DATA_FMT           "R*2 "

/*
 * The following structures contain all information that is 
 * present in the pfspd headers.
 *
 * N.B. The names of all fields are identical to the names
 *      that are used in the standard pfspd access library.
 */

typedef struct {
    int             lin_image;                  
    int             pix_line;                   
    char            data_fmt[P_SDATA_FMT + 1];  
    int             tem_sbsmpl;                 
    int             lin_sbsmpl;                 
    int             pix_sbsmpl;                 
    int             tem_phshft;                 
    int             lin_phshft;                 
    int             pix_phshft;                 
    char            com_code[P_SCOM_CODE + 1];  
} pT_component;

typedef struct {
    /*
     * These fields are actually written on disk.
     */
    int            nr_images;
    int            nr_compon;
    int            nr_fd_recs;
    int            nr_aux_data_recs;
    char           appl_type[P_SAPPL_TYPE + 1];
    int            bytes_rec;
    int            little_endian;    /* boolean: file endian mode */
    int            nr_aux_hdr_recs;
    double         ima_freq;
    double         lin_freq;
    double         pix_freq;
    int            act_lines;
    int            act_pixel;
    int            interlace;
    int            h_pp_size;
    int            v_pp_size;
    pT_component   comp[P_PFSPD_MAX_COMP];

    /*
     * The following field is an extension to the original header structure.
     * This is also written on disk.
     */
    char           description[P_SDESCRIPTION];

    /*
     * The following field modifies the behaviour of cpfspd functions.
     * The application may use this to control cpfspd.
     *
     * Note that the value is initialized at 0 in all functions that
     * initialize a header structure:
     *    p_create_header(), p_create_ext_header(), p_read_header().
     */
    int            disable_hdr_checks; /* boolean: 0: normal behaviour        */
                                       /* Value 1: function p_check_header()  */
                                       /* returns always P_OK. This function  */
                                       /* is also used internally by others.  */
                                       /* With checking disabled, and using   */
                                       /* the low level data access functions */
                                       /* on single components, any pfspd     */
                                       /* file can be accessed. This flag     */
                                       /* must be set by the application (no  */
                                       /* API support) and all risks of       */
                                       /* incorrect use are with the          */
                                       /* application programmer.             */

    /*
     * The following fields are internal administration of cpfspd.
     * They shall not be modified by the application.
     */
    int            modified;   /* this bit tells if the header has been    */
                               /* modified, when compared to a header that */
                               /* exists on disk                           */
    unsigned long  offset_lo;  /* position of current file pointer;        */
                               /* used for stdin/stdout read/write         */
                               /* the offset is maintained by cpfspd_low.c */
    unsigned long  offset_hi;  /* the offset_hi and offset_lo parts are    */
                               /* used to construct a 64 bit value on      */
                               /* platforms that support large files       */
                               /* this way, the cpfspd external interface  */
                               /* still complies to ANSI-C                 */
                               /* see module cpfspd_fio.c for more info    */
    unsigned char  aux_hdrs[P_SAUX_HDR];  /* (when used) auxiliary headers */
} pT_header;

#define P_COMPONENT_INIT   {0, 0, "", 0, 0, 0, 0, 0, 0, ""}
#define P_HEADER_INIT      {0, 0, 0, 0, "", 0, 0, 0, \
                            0.0, 0.0, 0.0, 0, 0, 0, 0, 0, \
                            {P_COMPONENT_INIT, P_COMPONENT_INIT, /*   2 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*   4 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*   6 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*   8 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  10 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  12 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  14 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  16 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  18 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  20 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  22 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  24 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  26 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  28 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  30 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  32 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  34 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  36 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  38 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  40 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  42 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  44 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  46 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  48 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  50 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  52 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  54 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  56 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  58 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  60 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  62 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  64 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  66 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  68 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  70 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  72 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  74 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  76 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  78 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  80 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  82 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  84 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  86 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  88 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  90 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  92 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  94 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  96 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /*  98 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 100 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 102 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 104 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 106 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 108 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 110 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 112 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 114 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 116 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 118 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 120 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 122 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 124 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT, /* 126 */ \
                             P_COMPONENT_INIT, P_COMPONENT_INIT},/* 128 */ \
                            "", 0, 0, 0, 0, P_AUX_LAST}

/********************
* Header data types *
********************/


#define P_STD_IMA_FREQ_50HZ      (50.00)
#define P_STD_IMA_FREQ_60HZ      (59.94)
#define P_STD_IMA_FREQ_REAL_60HZ (60.00)

typedef enum {
    P_50HZ = 0,             /* 50 Hz                                          */
    P_60HZ,                 /* 60 Hz = 59.94 Hz !!                            */
    P_REAL_60HZ,            /* Real 60 Hz frequency;                          */
                            /*   (i.s.o. 59.94 Hz defined in ITU-R BT.470-6)  */
    P_75HZ,                 /* 1.5 times P_50HZ                               */
    P_90HZ,                 /* 1.5 times P_60HZ                               */
    P_REAL_90HZ,            /* 1.5 times P_REAL_60HZ                          */
    P_100HZ,                /* 2 times P_50HZ                                 */
    P_120HZ,                /* 2 times P_60HZ                                 */
    P_REAL_120HZ,           /* 2 times P_REAL_60HZ                            */
    P_25HZ,                 /* >   'Special' frequency types for movie        */
    P_24HZ,                 /*  >  material (note that these formats cannot   */
    P_REAL_24HZ,            /*   > be displayed directly by a regular         */
    P_30HZ,                 /*  >  display. The accompanying line/pixel       */
    P_REAL_30HZ,            /* >   frequencies will be set to zero!)          */
    P_UNKNOWN_FREQ          /* unknown frequency                              */
} pT_freq;

typedef enum {
    P_NO_COLOR = 0,         /* no color; only luminance                       */
    P_COLOR_422,            /* multiplexed yuv formats: YUV 4:2:2             */
    P_COLOR_420,            /*                          YUV 4:2:0             */
    P_COLOR_444_PL,         /* planar yuv formats:      YUV 4:4:4             */
    P_COLOR_422_PL,         /*                          YUV 4:2:2             */
    P_COLOR_420_PL,         /*                          YUV 4:2:0             */
    P_COLOR_RGB,            /* RGB format                                     */
    P_STREAM,               /* streaming ("S") format; used for CVBS streams; */
                            /* only frames are supported in the "S" format    */
    P_COLOR_XYZ,            /* XYZ format                                     */
    P_UNKNOWN_COLOR         /* unknown color format                           */
} pT_color;

typedef enum {
    P_4_3 = 0,              /* 4:3 aspect ratio                               */
    P_16_9,                 /* 16:9 aspect ratio                              */
    P_AS_WH,                /* as image width/height (square pixel)           */
    P_UNKNOWN_ASPECT_RATIO  /* unknown aspect ratio                           */
} pT_asp_rat;

typedef enum {
    P_8_BIT_FILE = 0,       /* 8 bits file format                             */
    P_10_BIT_FILE,          /* 10 bits file format                            */
    P_12_BIT_FILE,          /* 12 bits file format                            */
    P_14_BIT_FILE,          /* 14 bits file format                            */
    P_16_BIT_FILE,          /* 16 bits file format                            */
    P_16_REAL_FILE,         /* 16 bits real file format                       */
    P_UNKNOWN_DATA_FORMAT   /* unknown data format                            */
} pT_data_fmt;

typedef enum {
    P_SD = 0,               /* Standard definition                            */
    P_CIF,                  /* CIF & QCIF size (note that for CIF & QCIF      */
    P_QCIF,                 /* sized images line/pixel frequencies will be    */
                            /* set such that they can be displayed as SD      */
                            /* images, i.e. 13.5 MHz sample frequency &       */
                            /* approx. 16 or 32 kHz line frequency            */
    P_HDp,                  /* Progressive HD format                          */
    P_HDi,                  /* Interlaced HD format                           */
    P_UNKNOWN_SIZE          /* Unknown size                                   */
} pT_size;

typedef enum {
  P_FLOAT = 0,              /* float *abuf                                    */
  P_DOUBLE,                 /* double *abuf                                   */
  P_LONG,                   /* signed long *abuf                              */
  P_ULONG,                  /* unsigned long *abuf                            */
  P_INT,                    /* signed int *abuf                               */
  P_UINT,                   /* unsigned int *abuf                             */
  P_SHORT,                  /* signed short *abuf                             */
  P_USHORT,                 /* unsigned short *abuf                           */
  P_CHAR,                   /* signed char *abuf                              */
  P_UCHAR                   /* unsigned char *abuf                            */
} pT_buf_type;


extern pT_status p_check_header (const pT_header *header);

extern pT_status p_read_header (const char *filename, 
                                pT_header *header);

extern pT_status p_write_header (const char *filename, 
                                 pT_header *header);

extern pT_status p_rewrite_header (const char *filename, 
                                   pT_header *header);

extern pT_status p_copy_header (pT_header *new_header, 
                                const pT_header *header);

extern pT_status p_print_header (const pT_header *header, 
                                 FILE *stream);

extern pT_status p_create_header (pT_header *header, 
                                  pT_color color, 
                                  pT_freq image_freq);

extern pT_status p_create_ext_header (pT_header *header, 
                                      pT_color color, 
                                      pT_freq image_freq,
                                      pT_size image_size,
                                      int pixels_per_line,
                                      int progressive,
                                      pT_asp_rat ratio);
extern pT_status p_mod_num_frames (pT_header *header, 
                                   int num_frames);
extern pT_status p_mod_color_format (pT_header *header, 
                                     pT_color color_format);
extern pT_status p_mod_aspect_ratio (pT_header *header, 
                                     pT_asp_rat ratio);

extern pT_status p_mod_to_progressive (pT_header *header);

extern pT_status p_mod_to_interlaced (pT_header *header);

extern pT_status p_mod_to_dbl_image_rate (pT_header *header);

extern pT_status p_mod_to_onehalf_image_rate (pT_header *header);

extern pT_status p_mod_image_size (pT_header* header,
                                   int width,
                                   int height);

extern pT_status p_mod_defined_image_size (pT_header* header,
                                           pT_size image_size,
                                           int pixels_per_line);

extern pT_status p_mod_all_freqs (pT_header *header,
                                  double image_freq,
                                  double line_freq,
                                  double pixel_freq);

extern pT_status p_mod_defined_image_freq (pT_header* header,
                                           pT_freq image_freq);

extern pT_status p_mod_file_data_format (pT_header *header, 
                                         pT_data_fmt file_data_fmt);

extern pT_status p_mod_file_description (pT_header *header, 
                                         char *description);
extern int         p_get_num_frames (const pT_header *header);
extern int         p_is_interlaced (const pT_header *header);
extern int         p_is_progressive (const pT_header *header);
extern int         p_get_frame_width (const pT_header *header);
extern int         p_get_frame_height (const pT_header *header);


extern void        p_get_y_buffer_size (const pT_header *header, 
                                        int *width, 
                                        int *height);
extern void        p_get_uv_buffer_size (const pT_header *header, 
                                         int *width, 
                                         int *height);
extern void        p_get_rgb_buffer_size (const pT_header *header, 
                                          int *width, 
                                          int *height);
extern void        p_get_s_buffer_size (const pT_header *header, 
                                        int *width, 
                                        int *height);

extern pT_color    p_get_color_format (const pT_header *header);

extern void        p_get_all_freqs (const pT_header *header, 
                                    double *image_freq, 
                                    double *line_freq, 
                                    double *pixel_freq);

extern pT_freq     p_get_image_freq (const pT_header *header);

extern pT_size     p_get_image_size (const pT_header *header);

extern pT_asp_rat  p_get_aspect_ratio (const pT_header *header);

extern pT_data_fmt p_get_file_data_format (const pT_header *header);

extern char       *p_get_file_description (const pT_header *header);

#define P_READ_Y         0
#define P_READ_ALL       1
#define P_READ_UV        2
#define P_READ_U         3
#define P_READ_V         4
#define P_READ_R         5
#define P_READ_G         6
#define P_READ_B         7

#define P_8_BIT_MEM      (0 * 16)
#define P_10_BIT_MEM     (1 * 16)
#define P_12_BIT_MEM     (2 * 16)
#define P_14_BIT_MEM     (3 * 16)
#define P_16_BIT_MEM     (4 * 16)
#define P_16_BIT_MEM_LSB (5 * 16)
#define P_AF_BIT_MEM     (7 * 16)

/*
 * Multiplexed luminance/chrominance (YUV) or streaming (S) files.
 *
 * Supported color_format: P_NO_COLOR, 
 *                         P_COLOR_422, 
 *                         P_COLOR_420, 
 *                         P_STREAM.
 *
 */
extern pT_status p_read_field
        (const char *filename, pT_header *header,
         int frame, int field,
         unsigned char *y_fld,
         unsigned char *uv_fld,
         int read_mode,
         int width, int fld_height, int stride);
extern pT_status p_read_frame
        (const char *filename, pT_header *header,
         int frame,
         unsigned char *y_or_s_frm,
         unsigned char *uv_frm,
         int read_mode,
         int width, int frm_height, int stride);
extern pT_status p_write_field
        (const char *filename, pT_header *header,
         int frame, int field,
         const unsigned char *y_fld,
         const unsigned char *uv_fld,
         int width, int fld_height, int stride);
extern pT_status p_write_frame
        (const char *filename, pT_header *header,
         int frame,
         const unsigned char *y_or_s_frm,
         const unsigned char *uv_frm,
         int width, int frm_height, int stride);

extern pT_status p_read_field_16
        (const char *filename, pT_header *header,
         int frame, int field,
         unsigned short *y_fld,
         unsigned short *uv_fld,
         int read_mode,
         int width, int fld_height, int stride);
extern pT_status p_read_frame_16
        (const char *filename, pT_header *header,
         int frame,
         unsigned short *y_or_s_frm,
         unsigned short *uv_frm,
         int read_mode,
         int width, int frm_height, int stride);
extern pT_status p_write_field_16
        (const char *filename, pT_header *header,
         int frame, int field,
         const unsigned short *y_fld,
         const unsigned short *uv_fld,
         int write_mode,
         int width, int fld_height, int stride);
extern pT_status p_write_frame_16
        (const char *filename, pT_header *header,
         int frame,
         const unsigned short *y_or_s_frm,
         const unsigned short *uv_frm,
         int write_mode,
         int width, int frm_height, int stride);

/*
 * Planar luminance/chrominance (YUV) or red/green/blue (RGB) files.
 *
 * Supported color_format: P_NO_COLOR, 
 *                         P_COLOR_444_PL, 
 *                         P_COLOR_422_PL, 
 *                         P_COLOR_420_PL, 
 *                         P_COLOR_RGB.
 *
 */
extern pT_status p_read_field_planar
        (const char *filename, pT_header *header,
         int frame, int field,
         unsigned char *y_or_r_fld,
         unsigned char *u_or_g_fld,
         unsigned char *v_or_b_fld,
         int read_mode,
         int width, int fld_height, int stride, int uv_stride);
extern pT_status p_read_frame_planar
        (const char *filename, pT_header *header,
         int frame,
         unsigned char *y_or_r_frm,
         unsigned char *u_or_g_frm,
         unsigned char *v_or_b_frm,
         int read_mode,
         int width, int frm_height, int stride, int uv_stride);
extern pT_status p_write_field_planar
        (const char *filename, pT_header *header,
         int frame, int field,
         const unsigned char *y_or_r_fld,
         const unsigned char *u_or_g_fld,
         const unsigned char *v_or_b_fld,
         int width, int fld_height, int stride, int uv_stride);
extern pT_status p_write_frame_planar
        (const char *filename, pT_header *header,
         int frame,
         const unsigned char *y_or_r_frm,
         const unsigned char *u_or_g_frm,
         const unsigned char *v_or_b_frm,
         int width, int frm_height, int stride, int uv_stride);

extern pT_status p_read_field_planar_16
        (const char *filename, pT_header *header,
         int frame, int field,
         unsigned short *y_or_r_fld,
         unsigned short *u_or_g_fld,
         unsigned short *v_or_b_fld,
         int read_mode,
         int width, int fld_height, int stride, int uv_stride);
extern pT_status p_read_frame_planar_16
        (const char *filename, pT_header *header,
         int frame,
         unsigned short *y_or_r_frm,
         unsigned short *u_or_g_frm,
         unsigned short *v_or_b_frm,
         int read_mode,
         int width, int frm_height, int stride, int uv_stride);
extern pT_status p_write_field_planar_16
        (const char *filename, pT_header *header,
         int frame, int field,
         const unsigned short *y_or_r_fld,
         const unsigned short *u_or_g_fld,
         const unsigned short *v_or_b_fld,
         int write_mode,
         int width, int fld_height, int stride, int uv_stride);
extern pT_status p_write_frame_planar_16
        (const char *filename, pT_header *header,
         int frame,
         const unsigned short *y_or_r_frm,
         const unsigned short *u_or_g_frm,
         const unsigned short *v_or_b_frm,
         int write_mode,
         int width, int frm_height, int stride, int uv_stride);

extern pT_status p_read_field_comp
        (const char *filename, pT_header *header,
         int frame, int field, int comp,
         unsigned char *c_fld,
         int read_mode,
         int width, int fld_height, int stride);
extern pT_status p_read_frame_comp
        (const char *filename, pT_header *header,
         int frame, int comp,
         unsigned char *c_frm,
         int read_mode,
         int width, int frm_height, int stride);
extern pT_status p_write_field_comp
        (const char *filename, pT_header *header,
         int frame, int field, int comp,
         const unsigned char *c_fld,
         int width, int fld_height, int stride);
extern pT_status p_write_frame_comp
        (const char *filename, pT_header *header,
         int frame, int comp,
         const unsigned char *c_frm,
         int width, int frm_height, int stride);

extern pT_status p_read_field_comp_16
        (const char *filename, pT_header *header,
         int frame, int field, int comp,
         unsigned short *c_fld,
         int read_mode,
         int width, int fld_height, int stride);
extern pT_status p_read_frame_comp_16
        (const char *filename, pT_header *header,
         int frame, int comp,
         unsigned short *c_frm,
         int read_mode,
         int width, int frm_height, int stride);
extern pT_status p_write_field_comp_16
        (const char *filename, pT_header *header,
         int frame, int field, int comp,
         const unsigned short *c_fld,
         int write_mode,
         int width, int fld_height, int stride);
extern pT_status p_write_frame_comp_16
        (const char *filename, pT_header *header,
         int frame, int comp,
         const unsigned short *c_frm,
         int write_mode,
         int width, int frm_height, int stride);
extern int p_mod_add_comp (pT_header *header);

extern int p_get_comp_by_name (const pT_header *header, const char *name);

extern int p_get_num_comps (const pT_header *header);

extern pT_status p_mod_set_comp_2
        (pT_header *header, const int comp,
         const char *name,
         const pT_data_fmt file_data_fmt,
         const int pix_subsample,
         const int line_subsample,
         const int multiplex_factor);

#define p_mod_set_comp(h,c,n,d,p,l) p_mod_set_comp_2((h),(c),(n),(d),(p),(l),1)

extern pT_status p_mod_rm_comp (pT_header *header, const int comp);

extern pT_status p_mod_rm_extra_comps (pT_header *header);

extern pT_status p_get_comp_2
        (const pT_header *header, const int comp,
         char *name,
         pT_data_fmt *file_data_fmt,
         int *pix_subsample,
         int *line_subsample,
         int *multiplex_factor);

#define p_get_comp(h,c,n,d,p,l) p_get_comp_2((h),(c),(n),(d),(p),(l),NULL)

extern pT_status p_get_comp_buffer_size (const pT_header *header, const int comp,
                                         int *width, int *height);
extern pT_status p_cce_read_comp
        (const char *filename, pT_header *header,
         int frame, int field, int comp,
         void *abuf, pT_buf_type atype,
         int offset, int gain,
         int width, int height, int stride);

extern pT_status p_cce_write_comp
        (const char *filename, pT_header *header,
         int frame, int field, int comp,
         const void *abuf, pT_buf_type atype,
         int offset, int gain,
         int width, int height, int stride);
extern pT_status p_cce_read_float_xyz(
         const char *filename,
         pT_header *header,
         int frame,
         int field,
         float *r_or_x_frm,
         float *g_or_y_frm,
         float *b_or_z_frm,
         int width, int height, int stride );
extern pT_status p_cce_write_float_xyz(
         const char *filename,
         pT_header *header,
         int frame,
         int field,
         float *r_or_x_frm,
         float *g_or_y_frm,
         float *b_or_z_frm,
         int width, int height, int stride );

extern int p_mod_add_aux (
        pT_header     * header,
        int             max_size,
        const char    * name,
        int             descr_len,
        const char    * description );

extern int p_get_num_aux (
        const pT_header *header );

extern int p_get_aux_by_name (
        const pT_header * header,
        const char      * name );

extern pT_status p_mod_rm_aux (
        pT_header     * header,
        int             aux_id );

extern pT_status p_get_aux (
        const pT_header *header,
        int              aux_id,
        int  * max_size,
        char * name,
        int  * descr_len,
        char * description );

extern pT_status p_read_aux (
        const char    * filename,
        pT_header     * header,
        int             frame,
        int             field,
        int             aux_id,
        int           * size,
        unsigned char * buf );


extern pT_status p_write_aux (
        const char    * filename,
        pT_header     * header,
        int             frame,
        int             field,
        int             aux_id,
        int             size,
        unsigned char * buf );

extern pT_status p_open_file (const char *filename, int write);
extern pT_status p_close_file (const char *filename);
extern pT_status p_set_file_buf_size (const int size_kb);
extern int       p_get_file_buf_size (void);
extern void     p_fatal_error (pT_status status, 
                               FILE *stream);
extern void     p_fatal_error_fileio (pT_status status, 
                                      const char *filename,
                                      FILE *stream);
extern char    *p_get_error_string (pT_status status);
extern char *p_revision_str;

extern char *p_get_version (void);

extern char *p_get_magic (void);

#ifdef __cplusplus
} /* extern "C" */
#endif /* __cplusplus */

#endif /* end of #ifndef CPFSPD_H_INCLUDED */

---