OpenJPEG version 1.1

[openjpeg.git] / libopenjpeg / jpt.h

diff --git a/libopenjpeg/jpt.h b/libopenjpeg/jpt.h
index 0e96fb1ca665029185eb883258335069800d56ad..0350e653b993637f32f8d35b039c9520b4312150 100644 (file)
--- a/libopenjpeg/jpt.h
+++ b/libopenjpeg/jpt.h
@@ -1,6 +1,7 @@
 /*
  * Copyright (c) 2004, Yannick Verschueren
- * Copyright (c) 2004,  Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
+ * Copyright (c) 2005, Herv� Drolon, FreeImage Team
+ * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -25,32 +26,49 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-/*
- * Message Header JPT_stream Structure 
- *
- */
-typedef struct {
-    unsigned int Id;           /* In-class Identifier    */
-    unsigned int last_byte;    /* Last byte information  */
-    unsigned int Class_Id;     /* Class Identifier       */
-    unsigned int CSn_Id;       /* CSn : index identifier */
-    unsigned int Msg_offset;   /* Message offset         */
-    unsigned int Msg_length;   /* Message length         */
-    unsigned int Layer_nb;     /* Auxiliary for JPP case */
-} jpt_msg_header_struct_t;
+#ifndef __JPT_H
+#define __JPT_H
+/**
+@file jpt.h
+@brief JPT-stream reader (JPEG 2000, JPIP)
 
-/*
- * Initialize the value of the message header structure 
- *
- * header : Message header structure
- *
- */
-void jpt_init_Msg_Header(jpt_msg_header_struct_t * header);
+JPT-stream functions are implemented in J2K.C. 
+*/
 
-/*
- * Read the message header for a JPP/JPT - stream
- *
- * header : Message header structure
- *
- */
-void jpt_read_Msg_Header(jpt_msg_header_struct_t * header);
+/**
+Message Header JPT stream structure
+*/
+typedef struct opj_jpt_msg_header {
+       /** In-class Identifier */
+       unsigned int Id;
+       /** Last byte information */
+       unsigned int last_byte; 
+       /** Class Identifier */
+       unsigned int Class_Id;  
+       /** CSn : index identifier */
+       unsigned int CSn_Id;
+       /** Message offset */
+       unsigned int Msg_offset;
+       /** Message length */
+       unsigned int Msg_length;
+       /** Auxiliary for JPP case */
+       unsigned int Layer_nb;
+} opj_jpt_msg_header_t;
+
+/* ----------------------------------------------------------------------- */
+
+/**
+Initialize the value of the message header structure 
+@param header Message header structure
+*/
+void jpt_init_msg_header(opj_jpt_msg_header_t * header);
+
+/**
+Read the message header for a JPP/JPT - stream
+@param cinfo Codec context info
+@param cio CIO handle
+@param header Message header structure
+*/
+void jpt_read_msg_header(opj_common_ptr cinfo, opj_cio_t *cio, opj_jpt_msg_header_t *header);
+
+#endif