frames.h

Go to the documentation of this file.

#ifndef __FRAMES_H__
#define __FRAMES_H__



#include "common.h"


#define BRP_FRAME_INVALID_SIZE    ((size_t) -1)


typedef struct brp_frame_t
{
    brp_buf ptr;    
    size_t act_size;   
    size_t total_size; 
} * brp_frame;


#define BRP_FRAME_PTR(frm)    ((frm)->ptr)


#define BRP_FRAME_SIZE(frm)    ((frm)->act_size)



typedef struct brp_frame_reader_t
{
    brp_frame frame;  
    brp_buf ptr;      
    bool err;         
} brp_frame_reader;


BRP_LIB void brp_frame_reader_start
(
    brp_frame_reader * frame_rdr, 
    brp_frame frame               
);


BRP_LIB brp_buf brp_frame_reader_next
(
    brp_frame_reader * frame_rdr, 
    size_t block_size             
);


BRP_LIB void brp_frame_init(brp_frame frame);


BRP_LIB void brp_frame_deinit(brp_frame frame);


BRP_LIB void brp_frame_write_start(brp_frame frame);


BRP_LIB bool brp_frame_write_err(brp_frame frame);


BRP_LIB void brp_frame_write(brp_frame frame, brp_buf data, size_t data_len);


BRP_LIB void brp_frame_write_int8(brp_frame frame, unsigned value);


BRP_LIB void brp_frame_write_int16(brp_frame frame, unsigned value);


BRP_LIB void brp_frame_write_int24(brp_frame frame, unsigned value);


BRP_LIB void brp_frame_write_int32(brp_frame frame, unsigned value);


BRP_LIB void brp_frame_write_frm(
        brp_frame dst_frame, brp_frame_reader * src_frame_rdr, size_t cnt);


BRP_LIB void brp_frame_write_frm_rest(
        brp_frame dst_frame, brp_frame_reader * src_frame_rdr);


BRP_LIB void brp_frame_write_fill(brp_frame frame, int val, size_t cnt);


BRP_LIB brp_buf brp_frame_write_buf
(
    brp_frame frame,    
    size_t add_size     
);


BRP_LIB void brp_frame_read_start(brp_frame_reader *frame_rdr, brp_frame frame);


BRP_LIB void brp_frame_read(
        brp_frame_reader * frame_rdr, brp_buf data, size_t data_len);


BRP_LIB void brp_frame_read_var(brp_frame_reader * frame_rdr, brp_buf data,
        size_t max_data_len, size_t * data_len_ptr);


BRP_LIB void brp_frame_skip(brp_frame_reader * frame_rdr, size_t cnt);


BRP_LIB unsigned brp_frame_read_int8(brp_frame_reader * frame_rdr);


BRP_LIB unsigned brp_frame_read_int16(brp_frame_reader * frame_rdr);


BRP_LIB unsigned brp_frame_read_int24(brp_frame_reader * frame_rdr);


BRP_LIB unsigned brp_frame_read_int32(brp_frame_reader * frame_rdr);


BRP_LIB void brp_frame_read_frm(
        brp_frame_reader * frame_rdr, brp_frame dst_frame, size_t cnt);


BRP_LIB void brp_frame_read_frm_rest(
        brp_frame_reader * frame_rdr, brp_frame dst_frame);


BRP_LIB bool brp_frame_read_err(brp_frame_reader * frame_rdr);


BRP_LIB size_t brp_frame_rest(brp_frame_reader * frame_rdr);


BRP_LIB bool brp_frame_read_eof(brp_frame_reader * frame_rdr);


BRP_LIB size_t brp_frame_read_diff(
        brp_frame_reader * new_rdr, brp_frame_reader * old_rdr);
     
     
BRP_LIB void brp_frame_unread(brp_frame_reader * frame_rdr, size_t byte_cnt);


#endif
 // end of defgroup brp_lib