bandfile.h

Go to the documentation of this file.

#ifndef _BANDFILE_H
#define _BANDFILE_H

#pragma pack(push, 1)

typedef struct _bandfile
{
        FILE *file;                                     
        uint32_t frame;                         
        uint16_t channel;                       
        uint16_t wavelet;                       
        uint16_t band;                          
        uint16_t type;                          
        uint32_t size;                          

        uint16_t width;                         
        uint16_t height;                        

        uint16_t max_band_width;        
        uint16_t max_band_height;       

        uint32_t max_band_size;         

        // Flags that indicate the state of the band data file
        uint8_t file_header_flag;               
        uint8_t frame_header_flag;              
        uint8_t channel_header_flag;    
        uint8_t wavelet_header_flag;    
        uint8_t band_header_flag;               

        uint8_t padding[3];                             

} BANDFILE;

#pragma pack(pop)

typedef enum
{
        BAND_TYPE_UINT16 = 0,
        BAND_TYPE_SINT16,

        // Reserve a block of values for encoded bands
        BAND_TYPE_ENCODED = 16,
        BAND_TYPE_ENCODED_RUNLENGTHS,           // Encoding method used by the codec

} BAND_TYPE;

//typedef enum
enum
{
        BANDFILE_ERROR_OKAY = 0,
        BANDFILE_ERROR_OPEN_FAILED,
        BANDFILE_ERROR_READ_FAILED,
        BANDFILE_ERROR_UNKNOWN_HEADER,
        BANDFILE_ERROR_CREATE_FAILED,
        BANDFILE_ERROR_WRITE_FAILED,
        BANDFILE_ERROR_END_OF_DATA,
};

typedef int BANDFILE_ERROR;


#ifdef __cplusplus
extern "C" {
#endif

int OpenBandFile(BANDFILE *bandfile, const char *pathname);

int FindNextBand(BANDFILE *bandfile);

int ReadFileHeader(BANDFILE *bandfile);

int ReadFrameHeader(BANDFILE *bandfile);

int ReadChannelHeader(BANDFILE *bandfile);

int ReadWaveletHeader(BANDFILE *bandfile);

int ReadBandHeader(BANDFILE *bandfile);

int ReadBandData(BANDFILE *bandfile, void *data, size_t size);

int CreateBandFile(BANDFILE *bandfile, const char *pathname);

int WriteFileHeader(BANDFILE *bandfile, int max_band_width, int max_band_height);

int WriteWaveletBand(BANDFILE *bandfile,
                                         int frame,
                                         int channel,
                                         int wavelet,
                                         int band,
                                         int type,
                                         int width,
                                         int height,
                                         void *data,
                                         size_t size);

int WriteFrameHeader(BANDFILE *bandfile, int frame);

int WriteChannelHeader(BANDFILE *bandfile, int channel);

int WriteWaveletHeader(BANDFILE *bandfile, int wavelet);

int WriteBandHeader(BANDFILE *bandfile, int band, int type, int width, int height, size_t size);

int WriteBandData(BANDFILE *bandfile, void *data, size_t size);

int CloseBandFile(BANDFILE *bandfile);

#ifdef __cplusplus
}
#endif

#endif