struct opj_j2k: remove unused fields, and add some documentation

[openjpeg.git] / src / lib / openjp2 / mct.h

diff --git a/src/lib/openjp2/mct.h b/src/lib/openjp2/mct.h
index 7758f0c38d9f860959b264fb5b1008e05fb815a3..2e37ce7333f85083d683e510e2107b92b73f5d06 100644 (file)
--- a/src/lib/openjp2/mct.h
+++ b/src/lib/openjp2/mct.h
@@ -1,10 +1,18 @@
 /*
- * Copyright (c) 2002-2007, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
- * Copyright (c) 2002-2007, Professor Benoit Macq
+ * The copyright in this software is being made available under the 2-clauses
+ * BSD License, included below. This software may be subject to other third
+ * party and contributor rights, including patent rights, and no such rights
+ * are granted under this license.
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, Professor Benoit Macq
  * Copyright (c) 2001-2003, David Janssens
  * Copyright (c) 2002-2003, Yannick Verschueren
- * Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
+ * Copyright (c) 2003-2007, Francois-Olivier Devaux
+ * Copyright (c) 2003-2014, Antonin Descampe
  * Copyright (c) 2005, Herve Drolon, FreeImage Team
+ * Copyright (c) 2008, 2011-2012, Centre National d'Etudes Spatiales (CNES), FR
+ * Copyright (c) 2012, CS Systemes d'Information, France
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -29,8 +37,8 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MCT_H
-#define __MCT_H
+#ifndef OPJ_MCT_H
+#define OPJ_MCT_H
 /**
 @file mct.h
 @brief Implementation of a multi-component transforms (MCT)
@@ -52,7 +60,8 @@ Apply a reversible multi-component transform to an image
 @param c2 Samples blue component
 @param n Number of samples for each component
 */
-void opj_mct_encode(OPJ_INT32 *c0, OPJ_INT32 *c1, OPJ_INT32 *c2, OPJ_UINT32 n);
+void opj_mct_encode(OPJ_INT32* OPJ_RESTRICT c0, OPJ_INT32* OPJ_RESTRICT c1,
+                    OPJ_INT32* OPJ_RESTRICT c2, OPJ_SIZE_T n);
 /**
 Apply a reversible multi-component inverse transform to an image
 @param c0 Samples for luminance component
@@ -60,11 +69,12 @@ Apply a reversible multi-component inverse transform to an image
 @param c2 Samples for blue chrominance component
 @param n Number of samples for each component
 */
-void opj_mct_decode(OPJ_INT32 *c0, OPJ_INT32 *c1, OPJ_INT32 *c2, OPJ_UINT32 n);
+void opj_mct_decode(OPJ_INT32* OPJ_RESTRICT c0, OPJ_INT32* OPJ_RESTRICT c1,
+                    OPJ_INT32* OPJ_RESTRICT c2, OPJ_SIZE_T n);
 /**
 Get norm of the basis function used for the reversible multi-component transform
 @param compno Number of the component (0->Y, 1->U, 2->V)
-@return 
+@return
 */
 OPJ_FLOAT64 opj_mct_getnorm(OPJ_UINT32 compno);
 
@@ -75,7 +85,8 @@ Apply an irreversible multi-component transform to an image
 @param c2 Samples blue component
 @param n Number of samples for each component
 */
-void opj_mct_encode_real(OPJ_INT32 *c0, OPJ_INT32 *c1, OPJ_INT32 *c2, OPJ_UINT32 n);
+void opj_mct_encode_real(OPJ_INT32* OPJ_RESTRICT c0, OPJ_INT32* OPJ_RESTRICT c1,
+                         OPJ_INT32* OPJ_RESTRICT c2, OPJ_SIZE_T n);
 /**
 Apply an irreversible multi-component inverse transform to an image
 @param c0 Samples for luminance component
@@ -83,11 +94,12 @@ Apply an irreversible multi-component inverse transform to an image
 @param c2 Samples for blue chrominance component
 @param n Number of samples for each component
 */
-void opj_mct_decode_real(OPJ_FLOAT32* c0, OPJ_FLOAT32* c1, OPJ_FLOAT32* c2, OPJ_UINT32 n);
+void opj_mct_decode_real(OPJ_FLOAT32* OPJ_RESTRICT c0,
+                         OPJ_FLOAT32* OPJ_RESTRICT c1, OPJ_FLOAT32* OPJ_RESTRICT c2, OPJ_SIZE_T n);
 /**
 Get norm of the basis function used for the irreversible multi-component transform
 @param compno Number of the component (0->Y, 1->U, 2->V)
-@return 
+@return
 */
 OPJ_FLOAT64 opj_mct_getnorm_real(OPJ_UINT32 compno);
 
@@ -100,48 +112,48 @@ FIXME DOC
 @param is_signed        tells if the data is signed
 @return OPJ_FALSE if function encounter a problem, OPJ_TRUE otherwise
 */
-opj_bool opj_mct_encode_custom(
-                                          OPJ_BYTE * p_coding_data,
-                                          OPJ_UINT32 n,
-                                          OPJ_BYTE ** p_data,
-                                          OPJ_UINT32 p_nb_comp,
-                                          OPJ_UINT32 is_signed);
+OPJ_BOOL opj_mct_encode_custom(
+    OPJ_BYTE * p_coding_data,
+    OPJ_SIZE_T n,
+    OPJ_BYTE ** p_data,
+    OPJ_UINT32 p_nb_comp,
+    OPJ_UINT32 is_signed);
 /**
 FIXME DOC
 @param pDecodingData    MCT data
 @param n                size of components
-@param pDataa           components
+@param pData            components
 @param pNbComp          nb of components (i.e. size of p_data)
-@param isSigneda        tells if the data is signed
+@param isSigned         tells if the data is signed
 @return OPJ_FALSE if function encounter a problem, OPJ_TRUE otherwise
 */
-opj_bool opj_mct_decode_custom(
-                                          OPJ_BYTE * pDecodingData,
-                                          OPJ_UINT32 n,
-                                          OPJ_BYTE ** pData,
-                                          OPJ_UINT32 pNbComp,
-                                          OPJ_UINT32 isSigned);
+OPJ_BOOL opj_mct_decode_custom(
+    OPJ_BYTE * pDecodingData,
+    OPJ_SIZE_T n,
+    OPJ_BYTE ** pData,
+    OPJ_UINT32 pNbComp,
+    OPJ_UINT32 isSigned);
 /**
 FIXME DOC
 @param pNorms           MCT data
 @param p_nb_comps       size of components
 @param pMatrix          components
-@return 
+@return
 */
-void opj_calculate_norms(   OPJ_FLOAT64 * pNorms,
-                            OPJ_UINT32 p_nb_comps,
-                            OPJ_FLOAT32 * pMatrix);
+void opj_calculate_norms(OPJ_FLOAT64 * pNorms,
+                         OPJ_UINT32 p_nb_comps,
+                         OPJ_FLOAT32 * pMatrix);
 /**
-FIXME DOC 
+FIXME DOC
 */
-const OPJ_FLOAT64 * opj_mct_get_mct_norms ();
+const OPJ_FLOAT64 * opj_mct_get_mct_norms(void);
 /**
-FIXME DOC 
+FIXME DOC
 */
-const OPJ_FLOAT64 * opj_mct_get_mct_norms_real ();
+const OPJ_FLOAT64 * opj_mct_get_mct_norms_real(void);
 /* ----------------------------------------------------------------------- */
 /*@}*/
 
 /*@}*/
 
-#endif /* __MCT_H */
+#endif /* OPJ_MCT_H */