phoenix-firestorm/indra/llimagej2coj/llimagej2coj2.cpp

652 lines
17 KiB
C++

/**
* @file llimagej2coj.cpp
* @brief This is an implementation of JPEG2000 encode/decode using OpenJPEG.
*
* $LicenseInfo:firstyear=2006&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
#include "linden_common.h"
#include "llimagej2coj.h"
// this is defined so that we get static linking.
#include "openjpeg-2.1-fs/openjpeg.h"
#include "lltimer.h"
//#include "llmemory.h"
struct ndUserdata
{
ndUserdata( bool aInput )
{
mInputStream = aInput;
mOffset = mLength = 0;
mInput = 0;
}
bool mInputStream;
size_t mOffset;
size_t mLength;
std::vector< U8 > mOutput;
LLImageJ2C *mInput;
};
void freeUserdata( void *aData )
{
if( aData )
delete (ndUserdata*)aData;
}
OPJ_SIZE_T nd_opj_stream_read_fn (void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data)
{
ndUserdata *pUserdata = reinterpret_cast< ndUserdata* >( p_user_data );
llassert_always( pUserdata->mInputStream );
U8* pData = pUserdata->mInput->getData();
size_t nImgsize = pUserdata->mInput->getDataSize();
size_t nByteLeft = (nImgsize - pUserdata->mOffset);
size_t nRead = p_nb_bytes;
if( nRead > nByteLeft )
nRead = nByteLeft;
if( !pData || !p_buffer || !nRead || !nByteLeft )
return (OPJ_SIZE_T)-1;
memcpy( p_buffer, pData+pUserdata->mOffset, nRead );
pUserdata->mOffset += nRead;
return nRead;
}
OPJ_SIZE_T nd_opj_stream_write_fn(void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data)
{
ndUserdata *pUserdata = reinterpret_cast< ndUserdata* >( p_user_data );
llassert_always( !pUserdata->mInputStream );
pUserdata->mOutput.reserve( pUserdata->mOutput.size() + p_nb_bytes );
memcpy( &pUserdata->mOutput[ pUserdata->mOutput.size() ], p_buffer, p_nb_bytes );
return p_nb_bytes;
}
OPJ_OFF_T nd_opj_stream_skip_fn(OPJ_OFF_T p_nb_bytes, void * p_user_data)
{
ndUserdata *pUserdata = reinterpret_cast< ndUserdata* >( p_user_data );
llassert_always( pUserdata->mInputStream );
size_t nImgsize = pUserdata->mInput->getDataSize();
size_t nByteLeft = (nImgsize - pUserdata->mOffset);
size_t nSkip = p_nb_bytes;
if( nSkip > nByteLeft )
nSkip = nByteLeft;
pUserdata->mOffset += nSkip;
return pUserdata->mOffset;
}
OPJ_BOOL nd_opj_stream_seek_fn(OPJ_OFF_T p_nb_bytes, void * p_user_data)
{
ndUserdata *pUserdata = reinterpret_cast< ndUserdata* >( p_user_data );
llassert_always( pUserdata->mInputStream );
size_t nImgsize = pUserdata->mInput->getDataSize();
size_t nSeek = p_nb_bytes;
if( nSeek > nImgsize )
return OPJ_FALSE;
pUserdata->mOffset = nSeek;
return OPJ_TRUE;
}
const char* fallbackEngineInfoLLImageJ2CImpl()
{
static std::string version_string =
std::string("OpenJPEG: 2.1, Runtime: ")
+ opj_version();
return version_string.c_str();
}
LLImageJ2CImpl* fallbackCreateLLImageJ2CImpl()
{
return new LLImageJ2COJ();
}
void fallbackDestroyLLImageJ2CImpl(LLImageJ2CImpl* impl)
{
delete impl;
impl = NULL;
}
// Return string from message, eliminating final \n if present
static std::string chomp(const char* msg)
{
// stomp trailing \n
std::string message = msg;
if (!message.empty())
{
size_t last = message.size() - 1;
if (message[last] == '\n')
{
message.resize( last );
}
}
return message;
}
/**
sample error callback expecting a LLFILE* client object
*/
void error_callback(const char* msg, void*)
{
LL_DEBUGS() << "LLImageJ2COJ: " << chomp(msg) << LL_ENDL;
}
/**
sample warning callback expecting a LLFILE* client object
*/
void warning_callback(const char* msg, void*)
{
LL_DEBUGS() << "LLImageJ2COJ: " << chomp(msg) << LL_ENDL;
}
/**
sample debug callback expecting no client object
*/
void info_callback(const char* msg, void*)
{
LL_DEBUGS() << "LLImageJ2COJ: " << chomp(msg) << LL_ENDL;
}
// Divide a by 2 to the power of b and round upwards
int ceildivpow2(int a, int b)
{
return (a + (1 << b) - 1) >> b;
}
LLImageJ2COJ::LLImageJ2COJ()
: LLImageJ2CImpl()
{
}
LLImageJ2COJ::~LLImageJ2COJ()
{
}
BOOL LLImageJ2COJ::initDecode(LLImageJ2C &base, LLImageRaw &raw_image, int discard_level, int* region)
{
// No specific implementation for this method in the OpenJpeg case
return FALSE;
}
BOOL LLImageJ2COJ::initEncode(LLImageJ2C &base, LLImageRaw &raw_image, int blocks_size, int precincts_size, int levels)
{
// No specific implementation for this method in the OpenJpeg case
return FALSE;
}
BOOL LLImageJ2COJ::decodeImpl(LLImageJ2C &base, LLImageRaw &raw_image, F32 decode_time, S32 first_channel, S32 max_channel_count)
{
// <FS:Techwolf Lupindo> texture comment metadata reader
U8* c_data = base.getData();
S32 c_size = base.getDataSize();
S32 position = 0;
while (position < 1024 && position < (c_size - 7)) // the comment field should be in the first 1024 bytes.
{
if (c_data[position] == 0xff && c_data[position + 1] == 0x64)
{
U8 high_byte = c_data[position + 2];
U8 low_byte = c_data[position + 3];
S32 c_length = (high_byte * 256) + low_byte; // This size also counts the markers, 00 01 and itself
if (c_length > 200) // sanity check
{
// While comments can be very long, anything longer then 200 is suspect.
break;
}
if (position + 2 + c_length > c_size)
{
// comment extends past end of data, corruption, or all data not retrived yet.
break;
}
// if the comment block does not end at the end of data, check to see if the next
// block starts with 0xFF
if (position + 2 + c_length < c_size && c_data[position + 2 + c_length] != 0xff)
{
// invalied comment block
break;
}
// extract the comment minus the markers, 00 01
raw_image.mComment.assign((char*)(c_data + position + 6), c_length - 4);
break;
}
position++;
}
// </FS:Techwolf Lupindo>
LLTimer decode_timer;
opj_dparameters_t parameters; /* decompression parameters */
/* set decoding parameters to default values */
opj_set_default_decoder_parameters(&parameters);
parameters.cp_reduce = base.getRawDiscardLevel();
opj_codec_t *pDecoder = opj_create_decompress( OPJ_CODEC_J2K );
opj_set_error_handler( pDecoder, error_callback, 0 );
opj_set_warning_handler( pDecoder, warning_callback, 0 );
opj_set_info_handler( pDecoder, info_callback, 0 );
opj_stream_t *pStream = opj_stream_default_create( OPJ_TRUE );
opj_stream_set_read_function( pStream, nd_opj_stream_read_fn );
opj_stream_set_write_function( pStream, nd_opj_stream_write_fn );
opj_stream_set_skip_function( pStream, nd_opj_stream_skip_fn );
opj_stream_set_seek_function( pStream, nd_opj_stream_seek_fn );
opj_stream_set_user_data_length( pStream, base.getDataSize() );
ndUserdata *pStreamdata( new ndUserdata( true ) );
pStreamdata->mInput = &base;
opj_stream_set_user_data (pStream, pStreamdata, freeUserdata );
opj_setup_decoder( pDecoder, &parameters );
opj_image_t *image(0);
opj_read_header( pStream, pDecoder, &image );
opj_decode( pDecoder, pStream, image);
opj_stream_destroy( pStream );
if( pDecoder )
opj_destroy_codec( pDecoder );
// The image decode failed if the return was NULL or the component
// count was zero. The latter is just a sanity check before we
// dereference the array.
if(!image || !image->numcomps)
{
LL_DEBUGS("Texture") << "ERROR -> decodeImpl: failed to decode image!" << LL_ENDL;
if (image)
{
opj_image_destroy(image);
}
return TRUE; // done
}
// sometimes we get bad data out of the cache - check to see if the decode succeeded
for (S32 i = 0; i < image->numcomps; i++)
{
if (image->comps[i].factor != base.getRawDiscardLevel())
{
// if we didn't get the discard level we're expecting, fail
opj_image_destroy(image);
base.mDecoding = FALSE;
return TRUE;
}
}
if(image->numcomps <= first_channel)
{
LL_WARNS() << "trying to decode more channels than are present in image: numcomps: " << image->numcomps << " first_channel: " << first_channel << LL_ENDL;
if (image)
{
opj_image_destroy(image);
}
return TRUE;
}
// Copy image data into our raw image format (instead of the separate channel format
S32 img_components = image->numcomps;
S32 channels = img_components - first_channel;
if( channels > max_channel_count )
channels = max_channel_count;
// Component buffers are allocated in an image width by height buffer.
// The image placed in that buffer is ceil(width/2^factor) by
// ceil(height/2^factor) and if the factor isn't zero it will be at the
// top left of the buffer with black filled in the rest of the pixels.
// It is integer math so the formula is written in ceildivpo2.
// (Assuming all the components have the same width, height and
// factor.)
S32 comp_width = image->comps[0].w;
S32 f=image->comps[0].factor;
S32 width = ceildivpow2(image->x1 - image->x0, f);
S32 height = ceildivpow2(image->y1 - image->y0, f);
raw_image.resize(width, height, channels);
U8 *rawp = raw_image.getData();
// first_channel is what channel to start copying from
// dest is what channel to copy to. first_channel comes from the
// argument, dest always starts writing at channel zero.
for (S32 comp = first_channel, dest=0; comp < first_channel + channels;
comp++, dest++)
{
if (image->comps[comp].data)
{
S32 offset = dest;
for (S32 y = (height - 1); y >= 0; y--)
{
for (S32 x = 0; x < width; x++)
{
rawp[offset] = image->comps[comp].data[y*comp_width + x];
offset += channels;
}
}
}
else // Some rare OpenJPEG versions have this bug.
{
LL_DEBUGS("Texture") << "ERROR -> decodeImpl: failed to decode image! (NULL comp data - OpenJPEG bug)" << LL_ENDL;
opj_image_destroy(image);
return TRUE; // done
}
}
/* free image data structure */
opj_image_destroy(image);
return TRUE; // done
}
BOOL LLImageJ2COJ::encodeImpl(LLImageJ2C &base, const LLImageRaw &raw_image, const char* comment_text, F32 encode_time, BOOL reversible)
{
const S32 MAX_COMPS = 5;
opj_cparameters_t parameters; /* compression parameters */
/* set encoding parameters to default values */
opj_set_default_encoder_parameters(&parameters);
parameters.cod_format = 0;
parameters.cp_disto_alloc = 1;
if (reversible)
{
parameters.tcp_numlayers = 1;
parameters.tcp_rates[0] = 0.0f;
}
else
{
parameters.tcp_numlayers = 5;
parameters.tcp_rates[0] = 1920.0f;
parameters.tcp_rates[1] = 480.0f;
parameters.tcp_rates[2] = 120.0f;
parameters.tcp_rates[3] = 30.0f;
parameters.tcp_rates[4] = 10.0f;
parameters.irreversible = 1;
if (raw_image.getComponents() >= 3)
{
parameters.tcp_mct = 1;
}
}
if (!comment_text)
{
parameters.cp_comment = (char *) "";
}
else
{
// Awful hacky cast, too lazy to copy right now.
parameters.cp_comment = (char *) comment_text;
}
//
// Fill in the source image from our raw image
//
OPJ_COLOR_SPACE color_space = OPJ_CLRSPC_SRGB;
opj_image_cmptparm_t cmptparm[MAX_COMPS];
opj_image_t * image = NULL;
S32 numcomps = raw_image.getComponents();
S32 width = raw_image.getWidth();
S32 height = raw_image.getHeight();
memset(&cmptparm[0], 0, MAX_COMPS * sizeof(opj_image_cmptparm_t));
for(S32 c = 0; c < numcomps; c++) {
cmptparm[c].prec = 8;
cmptparm[c].bpp = 8;
cmptparm[c].sgnd = 0;
cmptparm[c].dx = parameters.subsampling_dx;
cmptparm[c].dy = parameters.subsampling_dy;
cmptparm[c].w = width;
cmptparm[c].h = height;
}
/* create the image */
image = opj_image_create(numcomps, &cmptparm[0], color_space);
image->x1 = width;
image->y1 = height;
S32 i = 0;
const U8 *src_datap = raw_image.getData();
for (S32 y = height - 1; y >= 0; y--)
{
for (S32 x = 0; x < width; x++)
{
const U8 *pixel = src_datap + (y*width + x) * numcomps;
for (S32 c = 0; c < numcomps; c++)
{
image->comps[c].data[i] = *pixel;
pixel++;
}
i++;
}
}
int codestream_length;
/* get a J2K compressor handle */
opj_codec_t * pEncoder = opj_create_compress( OPJ_CODEC_J2K );
opj_set_error_handler( pEncoder, error_callback, 0 );
opj_set_warning_handler( pEncoder, warning_callback, 0 );
opj_set_info_handler( pEncoder, info_callback, 0 );
opj_setup_encoder(pEncoder, &parameters, image);
opj_stream_t *pStream = opj_stream_default_create( OPJ_FALSE );
opj_stream_set_read_function(pStream, nd_opj_stream_read_fn );
opj_stream_set_write_function(pStream, nd_opj_stream_write_fn );
opj_stream_set_skip_function(pStream, nd_opj_stream_skip_fn );
opj_stream_set_seek_function(pStream, nd_opj_stream_seek_fn );
opj_stream_set_user_data_length( pStream, raw_image.getDataSize() );
ndUserdata *pStreamdata( new ndUserdata( false ) );
opj_stream_set_user_data (pStream, pStreamdata, freeUserdata );
bool bSuccess = opj_encode( pEncoder, pStream );
if (!bSuccess)
{
LL_DEBUGS("Texture") << "Failed to encode image." << LL_ENDL;
return FALSE;
}
codestream_length = pStreamdata->mOutput.size();
base.copyData( (U8*)&pStreamdata->mOutput[0], codestream_length);
base.updateData(); // set width, height
opj_stream_destroy( pStream );
opj_destroy_codec( pEncoder );
/* free user parameters structure */
if(parameters.cp_matrice) free(parameters.cp_matrice);
/* free image data */
opj_image_destroy(image);
return TRUE;
}
inline S32 extractLong4( U8 const *aBuffer, int nOffset )
{
S32 ret = aBuffer[ nOffset ] << 24;
ret += aBuffer[ nOffset + 1 ] << 16;
ret += aBuffer[ nOffset + 2 ] << 8;
ret += aBuffer[ nOffset + 3 ];
return ret;
}
inline S32 extractShort2( U8 const *aBuffer, int nOffset )
{
S32 ret = aBuffer[ nOffset ] << 8;
ret += aBuffer[ nOffset + 1 ];
return ret;
}
inline bool isSOC( U8 const *aBuffer )
{
return aBuffer[ 0 ] == 0xFF && aBuffer[ 1 ] == 0x4F;
}
inline bool isSIZ( U8 const *aBuffer )
{
return aBuffer[ 0 ] == 0xFF && aBuffer[ 1 ] == 0x51;
}
bool getMetadataFast( LLImageJ2C &aImage, S32 &aW, S32 &aH, S32 &aComps )
{
const int J2K_HDR_LEN( 42 );
const int J2K_HDR_X1( 8 );
const int J2K_HDR_Y1( 12 );
const int J2K_HDR_X0( 16 );
const int J2K_HDR_Y0( 20 );
const int J2K_HDR_NUMCOMPS( 40 );
if( aImage.getDataSize() < J2K_HDR_LEN )
return false;
U8 const* pBuffer = aImage.getData();
if( !isSOC( pBuffer ) || !isSIZ( pBuffer+2 ) )
return false;
S32 x1 = extractLong4( pBuffer, J2K_HDR_X1 );
S32 y1 = extractLong4( pBuffer, J2K_HDR_Y1 );
S32 x0 = extractLong4( pBuffer, J2K_HDR_X0 );
S32 y0 = extractLong4( pBuffer, J2K_HDR_Y0 );
S32 numComps = extractShort2( pBuffer, J2K_HDR_NUMCOMPS );
aComps = numComps;
aW = x1 - x0;
aH = y1 - y0;
return true;
}
BOOL LLImageJ2COJ::getMetadata(LLImageJ2C &base)
{
//
// FIXME: We get metadata by decoding the ENTIRE image.
//
// Update the raw discard level
base.updateRawDiscardLevel();
S32 width(0);
S32 height(0);
S32 img_components(0);
if ( getMetadataFast( base, width, height, img_components ) )
{
base.setSize(width, height, img_components);
return TRUE;
}
// Do it the old and slow way, decode the image with openjpeg
opj_dparameters_t parameters; /* decompression parameters */
/* set decoding parameters to default values */
opj_set_default_decoder_parameters(&parameters);
parameters.cp_reduce = base.getRawDiscardLevel();
opj_codec_t *pDecoder = opj_create_decompress( OPJ_CODEC_J2K );
opj_set_error_handler( pDecoder, error_callback, 0 );
opj_set_warning_handler( pDecoder, warning_callback, 0 );
opj_set_info_handler( pDecoder, info_callback, 0 );
opj_stream_t *pStream = opj_stream_default_create( OPJ_TRUE );
opj_stream_set_read_function(pStream, nd_opj_stream_read_fn );
opj_stream_set_write_function(pStream, nd_opj_stream_write_fn );
opj_stream_set_skip_function(pStream, nd_opj_stream_skip_fn );
opj_stream_set_seek_function(pStream, nd_opj_stream_seek_fn );
ndUserdata *pStreamdata( new ndUserdata( true ) );
pStreamdata->mInput = &base;
opj_stream_set_user_data (pStream, pStreamdata, freeUserdata );
opj_stream_set_user_data_length( pStream, base.getDataSize() );
opj_setup_decoder( pDecoder, &parameters );
opj_image_t *image(0);
opj_read_header( pStream, pDecoder, &image );
opj_decode( pDecoder, pStream, image);
opj_stream_destroy( pStream );
if( pDecoder )
opj_destroy_codec( pDecoder );
if(!image)
{
LL_WARNS() << "ERROR -> getMetadata: failed to decode image!" << LL_ENDL;
return FALSE;
}
// Copy image data into our raw image format (instead of the separate channel format
img_components = image->numcomps;
width = image->x1 - image->x0;
height = image->y1 - image->y0;
base.setSize(width, height, img_components);
/* free image data structure */
opj_image_destroy(image);
return TRUE;
}