Patch #27397: Improved DPX/Cineon code

Patch by Julien Enche, thanks!

From the patch comment:

It allows Blender to load:
- 1, 8, 10, 12 and 16 bits files. For 10 and 12 bits files, packed or
  filled type A/B are supported.
- RGB, Log, Luma and YCbCr colorspaces.
- Big and little endian storage.
- Multi-elements (planar) storage.

It allows Blender to save :
- 8, 10, 12 and 16 bits file. For 10 and 12 bits files, the most used
  type A padding is used.
- RGB and Log colorspaces (Cineon can only be saved in Log colorspace).
  For Log colorspace, the common default values are used for gamma,
  reference black and reference white (respectively 1.7, 95 and 685 for
  10 bits files).
- Saved DPX/Cineon files now match the viewer.

Some files won't load (mostly because I haven't seen any of them):
- Compressed files
- 32 and 64 bits files
- Image orientation information are not taken in account. Here too,
  I haven't seen any file that was not top-bottom/left-right oriented.

1 files changed, 176 insertions, 82 deletions

diff --git a/source/blender/imbuf/intern/cineon/logImageCore.h b/source/blender/imbuf/intern/cineon/logImageCore.h
index 7d88c10c2d6..c1f4d2eae04 100644
--- a/source/blender/imbuf/intern/cineon/logImageCore.h
+++ b/source/blender/imbuf/intern/cineon/logImageCore.h
@@ -1,123 +1,217 @@
 /*
- *	 Cineon image file format library definitions.
- *	 Cineon and DPX common structures.
+ * Cineon image file format library definitions.
+ * Cineon and DPX common structures.
  *
- *	 This header file contains private details.
- *	 User code should generally use cineonlib.h and dpxlib.h only.
- *	 Hmm. I thought the two formats would have more in common!
+ * This header file contains private details.
+ * User code should generally use cineonlib.h and dpxlib.h only.
+ * Hmm. I thought the two formats would have more in common!
  *
- *	 Copyright 1999,2000,2001 David Hodson <hodsond@acm.org>
+ * Copyright 1999,2000,2001 David Hodson <hodsond@acm.org>
  *
- *	 This program is free software; you can redistribute it and/or modify it
- *	 under the terms of the GNU General Public License as published by the Free
- *	 Software Foundation; either version 2 of the License, or (at your option)
- *	 any later version.
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
  *
- *	 This program is distributed in the hope that it will be useful, but
- *	 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
- *	 or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU General Public License
- *	 for more details.
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * for more details.
  *
- *	 You should have received a copy of the GNU General Public License
- *	 along with this program; if not, write to the Free Software
- *	 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * Contributor(s): Julien Enche.
  *
  */
 
-#ifndef __LOGIMAGECORE_H__
-#define __LOGIMAGECORE_H__
-
 /** \file blender/imbuf/intern/cineon/logImageCore.h
  *  \ingroup imbcineon
  */
 
+
+#ifndef __LOG_IMAGE_CORE_H__
+#define __LOG_IMAGE_CORE_H__
+
 #include <stdio.h>
-#include "logImageLib.h"
+#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#include "BLO_sys_types.h" // for intptr_t support
-
-#ifdef _MSC_VER
-#undef ntohl
-#undef htonl
-#endif
+/*
+ * Image structure
+ */
 
-typedef int (GetRowFn)(LogImageFile* logImage, unsigned short* row, int lineNum);
-typedef int (SetRowFn)(LogImageFile* logImage, const unsigned short* row, int lineNum);
-typedef void (CloseFn)(LogImageFile* logImage);
+/* There are some differences between DPX and Cineon so we need to know from what type of file the datas come from */
+enum format {
+	format_DPX,
+	format_Cineon
+};
 
-struct _Log_Image_File_t_
+typedef struct LogImageElement
+{
+	int		  		depth;
+	int		  		bitsPerSample;
+	int		  		dataOffset;
+	int		  		packing;
+	int		  		transfer;
+	int		  		descriptor;
+	unsigned int 	refLowData;
+	unsigned int 	refHighData;
+	float			refLowQuantity;
+	float			refHighQuantity;
+	float			maxValue; /* = 2^bitsPerSample - 1 (used internally, doesn't come from the file header) */
+} LogImageElement;
+
+typedef struct LogImageFile
 {
 	/* specified in header */
 	int width;
 	int height;
+	int numElements;
 	int depth;
-	int bitsPerPixel;
-	int imageOffset;
-
-	/* file buffer, measured in longwords (4 byte) */
-	int lineBufferLength;
-	unsigned int* lineBuffer;
+	LogImageElement element[8];
 
-	/* pixel buffer, holds 10 bit pixel values */
-	unsigned short* pixelBuffer;
-	int pixelBufferUsed;
+	/* used for log <-> lin conversion */
+	float referenceBlack;
+	float referenceWhite;
+	float gamma;
 
-	/* io stuff */
+  	/* io stuff */
 	FILE* file;
-	int reading;
-	int fileYPos;
+	unsigned char* memBuffer;
+	uintptr_t memBufferSize;
+	unsigned char* memCursor;
+
+	/* is the file LSB or MSB ? */
+	int isMSB;
+
+	/* DPX or Cineon ? */
+	int srcFormat;
+} LogImageFile;
+
+
+/* The SMPTE defines this code:
+	*  0 - User-defined
+	*  1 - Printing density
+	*  2 - Linear
+	*  3 - Logarithmic
+	*  4 - Unspecified video
+	*  5 - SMPTE 240M
+	*  6 - CCIR 709-1
+	*  7 - CCIR 601-2 system B or G
+	*  8 - CCIR 601-2 system M
+	*  9 - NTSC composite video
+	*  10 - PAL composite video
+	*  11 - Z linear
+	*  12 - homogeneous
+	*
+	* Note that transfer_characteristics is U8, don't need
+	* check the byte order.
+	*/
+
+enum transfer {
+	transfer_UserDefined,
+	transfer_PrintingDensity,
+	transfer_Linear,
+	transfer_Logarithmic,
+	transfer_Unspecified,
+	transfer_Smpte240M,
+	transfer_Ccir7091,
+	transfer_Ccir6012BG,
+	transfer_Ccir6012M,
+	transfer_NTSC,
+	transfer_PAL,
+	transfer_ZLinear,
+	transfer_Homogeneous
+};
 
-	/* byte conversion stuff */
-	LogImageByteConversionParameters params;
-#if 0
-	float gamma;
-	int blackPoint;
-	int whitePoint;
-#endif
-	unsigned char lut10[1024];
-	unsigned short lut8[256];
-
-	unsigned short lut10_16[1024];
-	unsigned short lut16_16[65536];
-
-	/* pixel access functions */
-	GetRowFn* getRow;
-	SetRowFn* setRow;
-	CloseFn* close;
-	
-	unsigned char *membuffer;
-	uintptr_t membuffersize;
-	unsigned char *memcursor;
+/* The SMPTE defines this code:
+	* 0 - User-defined
+	* 1 - Red
+	* 2 - Green
+	* 3 - Blue
+	* 4 - Alpha
+	* 6 - Luminance
+	* 7 - Chrominance
+	* 8 - Depth
+	* 9 - Composite video
+	* 50 - RGB
+	* 51 - RGBA
+	* 52 - ABGR
+	* 100 - CbYCrY
+	* 101 - CbYACrYA
+	* 102 - CbYCr
+	* 103 - CbYCrA
+	* 150 - User-defined 2-component element
+	* 151 - User-defined 3-component element
+	* 152 - User-defined 4-component element
+	* 153 - User-defined 5-component element
+	* 154 - User-defined 6-component element
+	* 155 - User-defined 7-component element
+	* 156 - User-defined 8-component element
+	*/
+
+enum descriptor {
+	descriptor_UserDefined,
+	descriptor_Red,
+	descriptor_Green,
+	descriptor_Blue,
+	descriptor_Alpha,
+	descriptor_Luminance		= 6, /* don't ask me why there's no 5 */
+	descriptor_Chrominance,
+	descriptor_Depth,
+	descriptor_Composite,
+	descriptor_RGB				= 50,
+	descriptor_RGBA,
+	descriptor_ABGR,
+	descriptor_CbYCrY			= 100,
+	descriptor_CbYACrYA,
+	descriptor_CbYCr,
+	descriptor_CbYCrA,
+	descriptor_UserDefined2Elt	= 150,
+	descriptor_UserDefined3Elt,
+	descriptor_UserDefined4Elt,
+	descriptor_UserDefined5Elt,
+	descriptor_UserDefined6Elt,
+	descriptor_UserDefined7Elt,
+	descriptor_UserDefined8Elt,
+	/* following descriptors are for internal use only */
+	descriptor_YA
 };
 
-void setupLut(LogImageFile*);
-void setupLut16(LogImageFile*);
+/* int functions return 0 for OK */
 
-int pixelsToLongs(int numPixels);
+void logImageSetVerbose(int verbosity);
+int logImageIsDpx(const void* buffer);
+int logImageIsCineon(const void* buffer);
+LogImageFile* logImageOpenFromMemory(const unsigned char *buffer, unsigned int size);
+LogImageFile* logImageOpenFromFile(const char *filename, int cineon);
+void logImageGetSize(LogImageFile *logImage, int *width, int *height, int *depth);
+LogImageFile* logImageCreate(const char *filename, int cineon, int width, int height, int bitsPerSample, int isLogarithmic, int hasAlpha, int referenceWhite, int referenceBlack, float gamma, const char* creator);
+void logImageClose(LogImageFile* logImage);
 
-/* typedefs used in original docs */
-/* note size assumptions! */
+/* Data handling */
+unsigned int getRowLength(int width, LogImageElement logElement);
+int logImageSetDataRGBA(LogImageFile *logImage,float *data, int dataIsLinearRGB);
+int logImageGetDataRGBA(LogImageFile *logImage, float* data, int dataIsLinearRGB);
 
-typedef unsigned int U32;
-typedef unsigned short U16;
-typedef unsigned char U8;
-typedef signed int S32;
-typedef float R32;
-typedef char ASCII;
+/* Endianness conversion */
+inline unsigned short swap_ushort(unsigned short x, int swap);
+inline unsigned int swap_uint(unsigned int x, int swap);
+inline float swap_float(float x, int swap);
+
+/* Other */
+inline float clamp_float(float x, float low, float high);
+inline unsigned int clamp_uint(unsigned int x, unsigned int low, unsigned int high);
+inline unsigned int float_uint(float value, unsigned int max);
 
-R32 htonf(R32 f);
-R32 ntohf(R32 f);
-R32 undefined(void);
-U16 reverseU16(U16 value);
-U32 reverseU32(U32 value);
-R32 reverseR32(R32 value);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* __LOGIMAGECORE_H__ */
+#endif