OpenJPEG  2.1.0
Data Structures | Macros | Typedefs | Functions
openjpip.h File Reference
#include "session_manager.h"
#include "target_manager.h"
#include "query_parser.h"
#include "msgqueue_manager.h"
#include "sock_manager.h"
#include "auxtrans_manager.h"
#include "cache_manager.h"
#include "byte_manager.h"
#include "imgsock_manager.h"
#include "metadata_manager.h"
#include "ihdrbox_manager.h"
#include "index_manager.h"

Go to the source code of this file.

Data Structures

struct  dec_server_record
 Decoding server static records. More...
 
struct  jpip_dec_param
 JPIP decoding parameters. More...
 

Macros

#define FCGI_stdout   stdout
 
#define FCGI_stderr   stderr
 
#define logstream   stderr
 

Typedefs

typedef struct dec_server_record dec_server_record_t
 Decoding server static records. More...
 
typedef SOCKET client_t
 Client socket identifier. More...
 
typedef struct jpip_dec_param jpip_dec_param_t
 JPIP decoding parameters. More...
 
typedef index_param_t index_t
 Redefinition of index parameters. More...
 

Functions

OPJ_API dec_server_record_t *OPJ_CALLCONV init_dec_server (int port)
 Initialize the image decoding server. More...
 
OPJ_API void OPJ_CALLCONV terminate_dec_server (dec_server_record_t **rec)
 Terminate the image decoding server. More...
 
OPJ_API client_t OPJ_CALLCONV accept_connection (dec_server_record_t *rec)
 Accept client connection. More...
 
OPJ_API OPJ_BOOL OPJ_CALLCONV handle_clientreq (client_t client, dec_server_record_t *rec)
 Handle client request. More...
 
OPJ_API jpip_dec_param_t *OPJ_CALLCONV init_jpipdecoder (OPJ_BOOL jp2)
 Initialize jpip decoder. More...
 
OPJ_API void OPJ_CALLCONV destroy_jpipdecoder (jpip_dec_param_t **dec)
 Destroy jpip decoding parameters. More...
 
OPJ_API OPJ_BOOL OPJ_CALLCONV fread_jpip (const char fname[], jpip_dec_param_t *dec)
 Read jpip codestream from a file. More...
 
OPJ_API void OPJ_CALLCONV decode_jpip (jpip_dec_param_t *dec)
 Decode jpip codestream. More...
 
OPJ_API OPJ_BOOL OPJ_CALLCONV fwrite_jp2k (const char fname[], jpip_dec_param_t *dec)
 Write J2K/JP2 codestream to a file. More...
 
OPJ_API void OPJ_CALLCONV output_log (OPJ_BOOL messages, OPJ_BOOL metadata, OPJ_BOOL ihdrbox, jpip_dec_param_t *dec)
 Option; print out parameter values to stderr. More...
 
OPJ_API index_t *OPJ_CALLCONV get_index_from_JP2file (int fd)
 Parse JP2 file and get index information from cidx box inside. More...
 
OPJ_API void OPJ_CALLCONV destroy_index (index_t **idx)
 Destroy index parameters. More...
 
OPJ_API void OPJ_CALLCONV output_index (index_t *index)
 print index parameters More...
 

Macro Definition Documentation

#define FCGI_stderr   stderr
#define FCGI_stdout   stdout
#define logstream   stderr

Typedef Documentation

typedef SOCKET client_t

Client socket identifier.

Decoding server static records.

Redefinition of index parameters.

JPIP decoding parameters.

Function Documentation

OPJ_API client_t OPJ_CALLCONV accept_connection ( dec_server_record_t rec)

Accept client connection.

Parameters
[in]recdecoding server static record pointer
Returns
client socket ID, -1 if failed

References accept_socket(), and dec_server_record::listening_socket.

OPJ_API void OPJ_CALLCONV decode_jpip ( jpip_dec_param_t dec)
OPJ_API void OPJ_CALLCONV destroy_index ( index_t **  idx)

Destroy index parameters.

Parameters
[in,out]idxaddressof the index pointer

References delete_index().

OPJ_API void OPJ_CALLCONV destroy_jpipdecoder ( jpip_dec_param_t **  dec)

Destroy jpip decoding parameters.

Parameters
[in]decaddress of JPIP decoding parameters pointer

References delete_metadatalist(), delete_msgqueue(), and opj_free.

OPJ_API OPJ_BOOL OPJ_CALLCONV fread_jpip ( const char  fname[],
jpip_dec_param_t dec 
)

Read jpip codestream from a file.

Parameters
[in]fnamefile name
[in]decJPIP decoding parameters pointer
Returns
true if succeed

References get_filesize(), jpip_dec_param::jpiplen, jpip_dec_param::jpipstream, OPJ_FALSE, opj_free, opj_malloc, and OPJ_TRUE.

OPJ_API OPJ_BOOL OPJ_CALLCONV fwrite_jp2k ( const char  fname[],
jpip_dec_param_t dec 
)

Write J2K/JP2 codestream to a file.

Parameters
[in]fnamefile name
[in]decJPIP decoding parameters pointer
Returns
true if succeed

References jpip_dec_param::jp2klen, jpip_dec_param::jp2kstream, OPJ_FALSE, and OPJ_TRUE.

OPJ_API index_t* OPJ_CALLCONV get_index_from_JP2file ( int  fd)

Parse JP2 file and get index information from cidx box inside.

Parameters
[in]fdfile descriptor of the JP2 file
Returns
pointer to the generated structure of index parameters

References opj_free, opj_malloc, and parse_jp2file().

OPJ_API OPJ_BOOL OPJ_CALLCONV handle_clientreq ( client_t  client,
dec_server_record_t rec 
)
OPJ_API dec_server_record_t* OPJ_CALLCONV init_dec_server ( int  port)

Initialize the image decoding server.

Parameters
[in]portopening tcp port (valid No. 49152-65535)
Returns
intialized decoding server record pointer

References dec_server_record::cachelist, gene_cachelist(), gene_msgqueue(), dec_server_record::jpipstream, dec_server_record::jpipstreamlen, dec_server_record::listening_socket, dec_server_record::msgqueue, open_listeningsocket(), opj_malloc, and OPJ_TRUE.

OPJ_API jpip_dec_param_t* OPJ_CALLCONV init_jpipdecoder ( OPJ_BOOL  jp2)

Initialize jpip decoder.

Parameters
[in]jp2true in case of jp2 file encoding, else j2k file encoding
Returns
JPIP decoding parameters pointer

References gene_metadatalist(), gene_msgqueue(), jpip_dec_param::metadatalist, jpip_dec_param::msgqueue, opj_calloc, and OPJ_TRUE.

OPJ_API void OPJ_CALLCONV output_index ( index_t index)

print index parameters

Parameters
[in]indexindex parameters

References print_index().

OPJ_API void OPJ_CALLCONV output_log ( OPJ_BOOL  messages,
OPJ_BOOL  metadata,
OPJ_BOOL  ihdrbox,
jpip_dec_param_t dec 
)

Option; print out parameter values to stderr.

Parameters
[in]messagestrue if queue of messages is to be printed out
[in]metadatatrue if metadata is to be printed out
[in]ihdrboxtrue if image header data is to be printed out
[in]decJPIP decoding parameters pointer

References ihdrbox_param::bpc, ihdrbox_param::height, jpip_dec_param::ihdrbox, jpip_dec_param::metadatalist, jpip_dec_param::msgqueue, ihdrbox_param::nc, print_allmetadata(), print_msgqueue(), and ihdrbox_param::width.

OPJ_API void OPJ_CALLCONV terminate_dec_server ( dec_server_record_t **  rec)

Terminate the image decoding server.

Parameters
[in]recaddress of deleting decoding server static record pointer

References close_socket(), delete_cachelist(), delete_msgqueue(), and opj_free.