Files
OpenSceneGraph/src/osgPlugins/dds/ReaderWriterDDS.cpp

339 lines
11 KiB
C++

/**********************************************************************
*
* FILE: ReaderWriterdds.cpp
*
* DESCRIPTION: Class for reading a DDS file into an osg::Image.
*
* Example on reading a DDS file code can be found at:
* http://developer.nvidia.com/docs/IO/1327/ATT/
* ARB_texture_compression.pdf
* Author: Sébastien Dominé, NVIDIA Corporation
*
* CREATED BY: Rune Schmidt Jensen, rune@schmidt-jensen.com
*
* HISTORY: Created 31.03.2003
*
**********************************************************************/
#include <osg/Texture>
#include <osg/Notify>
#include <osgDB/Registry>
#include <osgDB/FileNameUtils>
#include <stdio.h>
// NOTICE ON WIN32:
// typedef DWORD unsigned long;
// sizeof(DWORD) = 4
typedef struct _DDCOLORKEY
{
unsigned long dwColorSpaceLowValue;
unsigned long dwColorSpaceHighValue;
} DDCOLORKEY;
typedef struct _DDPIXELFORMAT
{
unsigned long dwSize;
unsigned long dwFlags;
unsigned long dwFourCC;
union
{
unsigned long dwRGBBitCount;
unsigned long dwYUVBitCount;
unsigned long dwZBufferBitDepth;
unsigned long dwAlphaBitDepth;
};
union
{
unsigned long dwRBitMask;
unsigned long dwYBitMask;
};
union
{
unsigned long dwGBitMask;
unsigned long dwUBitMask;
};
union
{
unsigned long dwBBitMask;
unsigned long dwVBitMask;
};
union
{
unsigned long dwRGBAlphaBitMask;
unsigned long dwYUVAlphaBitMask;
unsigned long dwRGBZBitMask;
unsigned long dwYUVZBitMask;
};
} DDPIXELFORMAT;
typedef struct _DDSCAPS2
{
unsigned long dwCaps;
unsigned long dwCaps2;
unsigned long dwCaps3;
union
{
unsigned long dwCaps4;
unsigned long dwVolumeDepth;
};
} DDSCAPS2;
typedef struct _DDSURFACEDESC2
{
unsigned long dwSize;
unsigned long dwFlags;
unsigned long dwHeight;
unsigned long dwWidth;
union
{
long lPitch;
unsigned long dwLinearSize;
};
unsigned long dwBackBufferCount;
union
{
unsigned long dwMipMapCount;
unsigned long dwRefreshRate;
};
unsigned long dwAlphaBitDepth;
unsigned long dwReserved;
unsigned long* lpSurface;
DDCOLORKEY ddckCKDestOverlay;
DDCOLORKEY ddckCKDestBlt;
DDCOLORKEY ddckCKSrcOverlay;
DDCOLORKEY ddckCKSrcBlt;
DDPIXELFORMAT ddpfPixelFormat;
DDSCAPS2 ddsCaps;
unsigned long dwTextureStage;
} DDSURFACEDESC2;
#define DDPF_ALPHAPIXELS 0x00000001l
#define DDPF_FOURCC 0x00000004l
#define DDPF_RGB 0x00000040l
#ifndef MAKEFOURCC
#define MAKEFOURCC(ch0, ch1, ch2, ch3) \
((unsigned long)(char)(ch0) | ((unsigned long)(char)(ch1) << 8) | \
((unsigned long)(char)(ch2) << 16) | ((unsigned long)(char)(ch3) << 24 ))
#endif //defined(MAKEFOURCC)
/*
* FOURCC codes for DX compressed-texture pixel formats
*/
#define FOURCC_DXT1 (MAKEFOURCC('D','X','T','1'))
#define FOURCC_DXT2 (MAKEFOURCC('D','X','T','2'))
#define FOURCC_DXT3 (MAKEFOURCC('D','X','T','3'))
#define FOURCC_DXT4 (MAKEFOURCC('D','X','T','4'))
#define FOURCC_DXT5 (MAKEFOURCC('D','X','T','5'))
osg::Image* ReadDDSFile(const char *filename)
{
osg::Image* osgImage = new osg::Image();
osgImage->setFileName(filename);
DDSURFACEDESC2 ddsd;
char filecode[4];
FILE *fp;
// Open file.
fp = fopen(filename, "rb");
if (fp == NULL)
return NULL;
// Verify that this is a DDS file.
fread(filecode, 1, 4, fp);
if (strncmp(filecode, "DDS ", 4) != 0) {
fclose(fp);
return NULL;
}
// Get the surface desc.
fread(&ddsd, sizeof(ddsd), 1, fp);
// Read image data.
unsigned int size = ddsd.dwMipMapCount > 1 ? ddsd.dwLinearSize * (ddsd.ddpfPixelFormat.dwFourCC==FOURCC_DXT1 ? 2: 4) : ddsd.dwLinearSize;
//###################unsigned int size = ddsd.dwMipMapCount > 1 ? ddsd.dwLinearSize * 2 : ddsd.dwLinearSize;
if(size <= 0){
osg::notify(osg::WARN)<<"Warning:: dwLinearSize is not defined in dds file, image not loaded."<<std::endl;
return NULL;
}
unsigned char* imageData = new unsigned char [size];
fread(imageData, 1, size, fp);
// Close the file.
fclose(fp);
// Retreive image properties.
int s = ddsd.dwWidth;
int t = ddsd.dwHeight;
int r = 1; // we're not a 3d texture...
unsigned int dataType = GL_UNSIGNED_BYTE;
unsigned int pixelFormat = 0;
unsigned int internalFormat = 0;
// Uncompressed formats will usually use DDPF_RGB to indicate an RGB format,
// while compressed formats will use DDPF_FOURCC with a four-character code.
// Uncompressed formats.
if(ddsd.ddpfPixelFormat.dwFlags & DDPF_RGB)
{
bool usingAlpha = ddsd.ddpfPixelFormat.dwFlags & DDPF_ALPHAPIXELS;
switch(ddsd.ddpfPixelFormat.dwRGBBitCount)
{
case 32:
internalFormat = usingAlpha ? 4 : 3;
pixelFormat = usingAlpha ? GL_RGBA : GL_RGB;
break;
case 24:
case 16:
default:
osg::notify(osg::WARN)<<"Warning:: unhandled pixel format in dds file, image not loaded."<<std::endl;
delete [] imageData;
return NULL;
}
}
// Compressed formats.
else if(ddsd.ddpfPixelFormat.dwFlags & DDPF_FOURCC)
{
bool usingAlpha = ddsd.ddpfPixelFormat.dwFlags & DDPF_ALPHAPIXELS;
switch(ddsd.ddpfPixelFormat.dwFourCC)
{
case FOURCC_DXT1:
if (usingAlpha)
{
internalFormat = GL_COMPRESSED_RGBA_S3TC_DXT1_EXT;
pixelFormat = GL_COMPRESSED_RGBA_S3TC_DXT1_EXT;
}
else
{
internalFormat = GL_COMPRESSED_RGB_S3TC_DXT1_EXT;
//#######################pixelFormat = GL_COMPRESSED_RGB_S3TC_DXT1_EXT;
pixelFormat = GL_COMPRESSED_RGBA_S3TC_DXT1_EXT;
}
break;
case FOURCC_DXT3:
internalFormat = GL_COMPRESSED_RGBA_S3TC_DXT3_EXT;
pixelFormat = GL_COMPRESSED_RGBA_S3TC_DXT3_EXT;
break;
case FOURCC_DXT5:
internalFormat = GL_COMPRESSED_RGBA_S3TC_DXT5_EXT;
pixelFormat = GL_COMPRESSED_RGBA_S3TC_DXT5_EXT;
break;
default:
osg::notify(osg::WARN)<<"Warning:: unhandled pixel format in dds file, image not loaded."<<std::endl;
delete [] imageData;
return NULL;
}
}
else
{
osg::notify(osg::WARN)<<"Warning:: unhandled pixel format in dds file, image not loaded."<<std::endl;
delete [] imageData;
return NULL;
}
// NOTE: We need to set the image data before setting the mipmap data, this
// is because the setImage method clears the _mipmapdata vector in osg::Image.
// Set image data and properties.
osgImage->setImage(s,t,r, internalFormat, pixelFormat, dataType, imageData, osg::Image::USE_NEW_DELETE);
// Take care of mipmaps if any.
if (ddsd.dwMipMapCount>1)
{
// Now set mipmap data (offsets into image raw data).
osg::Image::MipmapDataType mipmaps;
//This is to complete mipmap sequence until level Nx1
//debugging messages
float power2_s = logf((float)s)/logf((float)2);
float power2_t = logf((float)t)/logf((float)2);
osg::notify(osg::INFO) << "ReadDDSFile info : ddsd.dwMipMapCount = "<<ddsd.dwMipMapCount<<std::endl;
osg::notify(osg::INFO) << "ReadDDSFile info : s = "<<s<<std::endl;
osg::notify(osg::INFO) << "ReadDDSFile info : t = "<<t<<std::endl;
osg::notify(osg::INFO) << "ReadDDSFile info : power2_s="<<power2_s<<std::endl;
osg::notify(osg::INFO) << "ReadDDSFile info : power2_t="<<power2_t<<std::endl;
mipmaps.resize((unsigned int)osg::maximum(power2_s,power2_t),0);
// Handle compressed mipmaps.
if(ddsd.ddpfPixelFormat.dwFlags & DDPF_FOURCC)
{
int width = ddsd.dwWidth;
int height = ddsd.dwHeight;
int blockSize = (pixelFormat == GL_COMPRESSED_RGBA_S3TC_DXT1_EXT) ? 8 : 16;
int offset = 0;
for (unsigned int k = 1; k < ddsd.dwMipMapCount && (width || height); ++k)
{
if (width == 0)
width = 1;
if (height == 0)
height = 1;
size = ((width+3)/4)*((height+3)/4)*blockSize;
offset += size;
mipmaps[k-1] = offset;
width >>= 1;
height >>= 1;
}
osgImage->setMipmapData(mipmaps);
}
// Handle uncompressed mipmaps
if(ddsd.ddpfPixelFormat.dwFlags & DDPF_RGB)
{
int offset = 0;
int width = ddsd.dwWidth;
int height = ddsd.dwHeight;
for (unsigned int k = 1; k < ddsd.dwMipMapCount && (width || height); ++k)
{
if (width == 0)
width = 1;
if (height == 0)
height = 1;
size = width*height*(ddsd.ddpfPixelFormat.dwRGBBitCount/8);
offset += size;
mipmaps[k-1] = offset;
width >>= 1;
height >>= 1;
}
osgImage->setMipmapData(mipmaps);
}
}
// Return Image.
return osgImage;
}
class ReaderWriterDDS : public osgDB::ReaderWriter
{
public:
virtual const char* className()
{
return "DDS Image Reader";
}
virtual bool acceptsExtension(const std::string& extension)
{
return osgDB::equalCaseInsensitive(extension,"dds");
}
virtual ReadResult readImage(const std::string& fileName, const osgDB::ReaderWriter::Options*)
{
osg::Image* osgImage = ReadDDSFile(fileName.c_str());
if (osgImage==NULL) return ReadResult::FILE_NOT_HANDLED;
return osgImage;
}
};
// now register with Registry to instantiate the above
// reader/writer.
osgDB::RegisterReaderWriterProxy<ReaderWriterDDS> g_readerWriter_DDS_Proxy;