diff options
Diffstat (limited to 'src/lib/openjpip/box_manager.h')
| -rw-r--r-- | src/lib/openjpip/box_manager.h | 77 |
1 files changed, 40 insertions, 37 deletions
diff --git a/src/lib/openjpip/box_manager.h b/src/lib/openjpip/box_manager.h index d45d84e6..250ef640 100644 --- a/src/lib/openjpip/box_manager.h +++ b/src/lib/openjpip/box_manager.h @@ -28,26 +28,26 @@ * POSSIBILITY OF SUCH DAMAGE. */ -#ifndef BOX_MANAGER_H_ -# define BOX_MANAGER_H_ +#ifndef BOX_MANAGER_H_ +# define BOX_MANAGER_H_ #include "byte_manager.h" /** box parameters*/ -typedef struct box_param{ - int fd; /**< file descriptor*/ - OPJ_OFF_T offset; /**< byte position of the whole Box (LBox) in the file*/ - Byte_t headlen; /**< header length 8 or 16*/ - Byte8_t length; /**< length of the whole Box*/ - char type[4]; /**< type of information in the DBox*/ - struct box_param *next; /**< pointer to the next box*/ +typedef struct box_param { + int fd; /**< file descriptor*/ + OPJ_OFF_T offset; /**< byte position of the whole Box (LBox) in the file*/ + Byte_t headlen; /**< header length 8 or 16*/ + Byte8_t length; /**< length of the whole Box*/ + char type[4]; /**< type of information in the DBox*/ + struct box_param *next; /**< pointer to the next box*/ } box_param_t; /** Box list parameters*/ -typedef struct boxlist_param{ - box_param_t *first; /**< first box pointer of the list*/ - box_param_t *last; /**< last box pointer of the list*/ +typedef struct boxlist_param { + box_param_t *first; /**< first box pointer of the list*/ + box_param_t *last; /**< last box pointer of the list*/ } boxlist_param_t; @@ -66,7 +66,7 @@ boxlist_param_t * gene_boxlist(void); * @param[in] length length of the decomposing region * @return pointer to the generated boxlist */ -boxlist_param_t * get_boxstructure( int fd, OPJ_OFF_T offset, OPJ_SIZE_T length); +boxlist_param_t * get_boxstructure(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length); /** @@ -76,7 +76,7 @@ boxlist_param_t * get_boxstructure( int fd, OPJ_OFF_T offset, OPJ_SIZE_T length) * @param[in] offset Box offset * @return pointer to the structure of generate box parameters */ -box_param_t * gene_boxbyOffset( int fd, OPJ_OFF_T offset); +box_param_t * gene_boxbyOffset(int fd, OPJ_OFF_T offset); /** @@ -86,29 +86,31 @@ box_param_t * gene_boxbyOffset( int fd, OPJ_OFF_T offset); * @param[in] offset Box offset of the whole stream * @return pointer to the structure of generate box parameters */ -box_param_t * gene_boxbyOffinStream( Byte_t *stream, OPJ_OFF_T offset); +box_param_t * gene_boxbyOffinStream(Byte_t *stream, OPJ_OFF_T offset); /** * generate(search) box from JP2 file * * @param[in] fd file discriptor of the JP2 file * @param[in] offset start Byte position of the search - * @param[in] length Byte length of the search, if 0, size to the end of file + * @param[in] length Byte length of the search, if 0, size to the end of file * @param[in] TBox Box Type * @return pointer to the structure of generate/found box parameters */ -box_param_t * gene_boxbyType( int fd, OPJ_OFF_T offset, OPJ_SIZE_T length, const char TBox[]); +box_param_t * gene_boxbyType(int fd, OPJ_OFF_T offset, OPJ_SIZE_T length, + const char TBox[]); /** * generate(search) box from code stream * * @param[in] stream code stream ( from the first byte) * @param[in] offset start Byte position of the search - * @param[in] length Byte length of the search, if 0, size to the end of file + * @param[in] length Byte length of the search, if 0, size to the end of file * @param[in] TBox Box Type * @return pointer to the structure of generate/found box parameters */ -box_param_t * gene_boxbyTypeinStream( Byte_t *stream, OPJ_OFF_T offset, OPJ_SIZE_T length, const char TBox[]); +box_param_t * gene_boxbyTypeinStream(Byte_t *stream, OPJ_OFF_T offset, + OPJ_SIZE_T length, const char TBox[]); /** * generate child box from JP2 file at the given offset @@ -117,7 +119,7 @@ box_param_t * gene_boxbyTypeinStream( Byte_t *stream, OPJ_OFF_T offset, OPJ_SIZE * @param[in] offset offset from DBox first byte of superbox * @return pointer to the structure of generate box parameters */ -box_param_t * gene_childboxbyOffset( box_param_t *superbox, OPJ_OFF_T offset); +box_param_t * gene_childboxbyOffset(box_param_t *superbox, OPJ_OFF_T offset); /** * generate(search) box from JP2 file @@ -127,7 +129,8 @@ box_param_t * gene_childboxbyOffset( box_param_t *superbox, OPJ_OFF_T offset); * @param[in] TBox Box Type * @return pointer to the structure of generate/found box parameters */ -box_param_t * gene_childboxbyType( box_param_t *superbox, OPJ_OFF_T offset, const char TBox[]); +box_param_t * gene_childboxbyType(box_param_t *superbox, OPJ_OFF_T offset, + const char TBox[]); /** * get DBox offset @@ -135,7 +138,7 @@ box_param_t * gene_childboxbyType( box_param_t *superbox, OPJ_OFF_T offset, cons * @param[in] box box pointer * @return DBox offset (byte position) in the file */ -OPJ_OFF_T get_DBoxoff( box_param_t *box); +OPJ_OFF_T get_DBoxoff(box_param_t *box); /** @@ -144,7 +147,7 @@ OPJ_OFF_T get_DBoxoff( box_param_t *box); * @param[in] box box pointer * @return DBox length ( content length) */ -OPJ_SIZE_T get_DBoxlen( box_param_t *box); +OPJ_SIZE_T get_DBoxlen(box_param_t *box); /** @@ -153,7 +156,7 @@ OPJ_SIZE_T get_DBoxlen( box_param_t *box); * @param[in] box box pointer * @return pointer to the fetched bytes */ -Byte_t * fetch_headbytes( box_param_t *box); +Byte_t * fetch_headbytes(box_param_t *box); /** @@ -164,7 +167,7 @@ Byte_t * fetch_headbytes( box_param_t *box); * @param[in] size Byte length * @return pointer to the fetched data */ -Byte_t * fetch_DBoxbytes( box_param_t *box, OPJ_OFF_T offset, OPJ_SIZE_T size); +Byte_t * fetch_DBoxbytes(box_param_t *box, OPJ_OFF_T offset, OPJ_SIZE_T size); /** * fetch DBox (Box Contents) 1-byte Byte codes in file stream @@ -173,7 +176,7 @@ Byte_t * fetch_DBoxbytes( box_param_t *box, OPJ_OFF_T offset, OPJ_SIZE_T size); * @param[in] offset start Byte position in DBox * @return fetched code */ -Byte_t fetch_DBox1byte( box_param_t *box, OPJ_OFF_T offset); +Byte_t fetch_DBox1byte(box_param_t *box, OPJ_OFF_T offset); /** * fetch DBox (Box Contents) 2-byte big endian Byte codes in file stream @@ -182,7 +185,7 @@ Byte_t fetch_DBox1byte( box_param_t *box, OPJ_OFF_T offset); * @param[in] offset start Byte position in DBox * @return fetched code */ -Byte2_t fetch_DBox2bytebigendian( box_param_t *box, OPJ_OFF_T offset); +Byte2_t fetch_DBox2bytebigendian(box_param_t *box, OPJ_OFF_T offset); /** * fetch DBox (Box Contents) 4-byte big endian Byte codes in file stream @@ -191,7 +194,7 @@ Byte2_t fetch_DBox2bytebigendian( box_param_t *box, OPJ_OFF_T offset); * @param[in] offset start Byte position in DBox * @return fetched code */ -Byte4_t fetch_DBox4bytebigendian( box_param_t *box, OPJ_OFF_T offset); +Byte4_t fetch_DBox4bytebigendian(box_param_t *box, OPJ_OFF_T offset); /** * fetch DBox (Box Contents) 8-byte big endian Byte codes in file stream @@ -200,7 +203,7 @@ Byte4_t fetch_DBox4bytebigendian( box_param_t *box, OPJ_OFF_T offset); * @param[in] offset start Byte position in DBox * @return fetched code */ -Byte8_t fetch_DBox8bytebigendian( box_param_t *box, OPJ_OFF_T offset); +Byte8_t fetch_DBox8bytebigendian(box_param_t *box, OPJ_OFF_T offset); /** @@ -210,14 +213,14 @@ Byte8_t fetch_DBox8bytebigendian( box_param_t *box, OPJ_OFF_T offset); * @param[in] boxlist box list pointer * @return found box pointer */ -box_param_t * search_box( const char type[], boxlist_param_t *boxlist); +box_param_t * search_box(const char type[], boxlist_param_t *boxlist); /** * print box parameters * * @param[in] box box pointer */ -void print_box( box_param_t *box); +void print_box(box_param_t *box); /** @@ -225,7 +228,7 @@ void print_box( box_param_t *box); * * @param[in] boxlist box list pointer */ -void print_allbox( boxlist_param_t *boxlist); +void print_allbox(boxlist_param_t *boxlist); /** * delete a box in list @@ -233,7 +236,7 @@ void print_allbox( boxlist_param_t *boxlist); * @param[in,out] box address of the deleting box pointer * @param[in] boxlist box list pointer */ -void delete_box_in_list( box_param_t **box, boxlist_param_t *boxlist); +void delete_box_in_list(box_param_t **box, boxlist_param_t *boxlist); /** @@ -242,7 +245,7 @@ void delete_box_in_list( box_param_t **box, boxlist_param_t *boxlist); * @param[in,out] type box type * @param[in] boxlist box list pointer */ -void delete_box_in_list_by_type( const char type[], boxlist_param_t *boxlist); +void delete_box_in_list_by_type(const char type[], boxlist_param_t *boxlist); /** @@ -250,7 +253,7 @@ void delete_box_in_list_by_type( const char type[], boxlist_param_t *boxlist); * * @param[in,out] boxlist address of the box list pointer */ -void delete_boxlist( boxlist_param_t **boxlist); +void delete_boxlist(boxlist_param_t **boxlist); /** @@ -259,6 +262,6 @@ void delete_boxlist( boxlist_param_t **boxlist); * @param[in] box box pointer * @param[in] boxlist box list pointer */ -void insert_box_into_list( box_param_t *box, boxlist_param_t *boxlist); +void insert_box_into_list(box_param_t *box, boxlist_param_t *boxlist); -#endif /* !BOX_MANAGER_H_ */ +#endif /* !BOX_MANAGER_H_ */ |