From 6b76f75d2c0ebdc462f6bc663289fa4bfde1629a Mon Sep 17 00:00:00 2001 From: DRC Date: Tue, 24 May 2011 16:52:47 +0000 Subject: [PATCH] Add new API functions, tjAlloc() and tjFree(), which allow memory to be allocated and freed using a method of the library's choosing. At the moment, the primary purpose for this is to avoid allocating/freeing memory across the DLL boundary on Windows. git-svn-id: svn+ssh://svn.code.sf.net/p/libjpeg-turbo/code/trunk@634 632fc199-4ca6-4c93-a231-07263d6284db --- doc/html/annotated.html | 2 +- doc/html/classes.html | 2 +- doc/html/functions.html | 2 +- doc/html/functions_vars.html | 2 +- doc/html/group___turbo_j_p_e_g.html | 63 +++++++++++++++++++++++++++-- doc/html/index.html | 2 +- doc/html/modules.html | 2 +- doc/html/structtjregion.html | 2 +- doc/html/structtjscalingfactor.html | 2 +- doc/html/structtjtransform.html | 2 +- jpegut.c | 12 +++--- turbojpeg-mapfile | 2 + turbojpeg-mapfile.jni | 2 + turbojpeg.h | 33 +++++++++++++-- turbojpegl.c | 17 ++++++++ 15 files changed, 125 insertions(+), 22 deletions(-) diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 09db2cb4..7206554f 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -81,7 +81,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/classes.html b/doc/html/classes.html index d9b8c9ab..10afb969 100644 --- a/doc/html/classes.html +++ b/doc/html/classes.html @@ -80,7 +80,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/functions.html b/doc/html/functions.html index edf3963d..ae7d0720 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -107,7 +107,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/functions_vars.html b/doc/html/functions_vars.html index a10da770..8dabf4c5 100644 --- a/doc/html/functions_vars.html +++ b/doc/html/functions_vars.html @@ -107,7 +107,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/group___turbo_j_p_e_g.html b/doc/html/group___turbo_j_p_e_g.html index 2540b94a..3dadaf12 100644 --- a/doc/html/group___turbo_j_p_e_g.html +++ b/doc/html/group___turbo_j_p_e_g.html @@ -176,6 +176,10 @@ Functions  Losslessly transform a JPEG image into another JPEG image.
DLLEXPORT int DLLCALL tjDestroy (tjhandle handle)  Destroy a TurboJPEG compressor, decompressor, or transformer instance.
+DLLEXPORT unsigned char *DLLCALL tjAlloc (int bytes) + Allocate an image buffer for use with TurboJPEG.
+DLLEXPORT void DLLCALL tjFree (unsigned char *buffer) + Free an image buffer previously allocated by TurboJPEG.
DLLEXPORT char *DLLCALL tjGetErrorStr (void)  Returns a descriptive error message explaining why the last command failed.

@@ -612,6 +616,33 @@ Variables

Function Documentation

+ +
+
+ + + + + + + + +
DLLEXPORT unsigned char* DLLCALL tjAlloc (int bytes)
+
+
+ +

Allocate an image buffer for use with TurboJPEG.

+

You should always use this function to allocate the JPEG destination buffer(s) for tjCompress2() and tjTransform() unless you are disabling automatic buffer (re)allocation (by setting TJFLAG_NOREALLOC.)

+
Parameters:
+ + +
bytesthe number of bytes to allocate
+
+
+
Returns:
a pointer to a newly-allocated buffer with the specified number of bytes
+ +
+
@@ -782,7 +813,7 @@ Variables heightheight (in pixels) of the source image pixelFormatpixel format of the source image (see Pixel formats.) jpegBufaddress of a pointer to an image buffer that will receive the JPEG image. TurboJPEG has the ability to reallocate the JPEG buffer to accommodate the size of the JPEG image. Thus, you can choose to:
    -
  1. pre-allocate the JPEG buffer with an arbitrary size and let TurboJPEG grow the buffer as needed,
    2. +
  2. pre-allocate the JPEG buffer with an arbitrary size using tjAlloc() and let TurboJPEG grow the buffer as needed,
  3. set *jpegBuf to NULL to tell TurboJPEG to allocate the buffer for you, or
  4. pre-allocate the buffer to a "worst case" size determined by calling TJBUFSIZE(). This should ensure that the buffer never has to be re-allocated (setting TJFLAG_NOREALLOC guarantees this.)
@@ -1119,6 +1150,32 @@ If you choose option 1, *jpegSize should be set to the size of your
Returns:
0 if successful, or -1 if an error occurred (see tjGetErrorStr().)
+
+
+ +
+
+ + + + + + + + +
DLLEXPORT void DLLCALL tjFree (unsigned char * buffer)
+
+
+ +

Free an image buffer previously allocated by TurboJPEG.

+

You should always use this function to free JPEG destination buffer(s) that were automatically (re)allocated by tjCompress2() or tjTransform() or that were manually allocated using tjAlloc().

+
Parameters:
+ + +
bufferaddress of the buffer to free
+
+
+
@@ -1297,7 +1354,7 @@ If you choose option 1, *jpegSize should be set to the size of your jpegSizesize of the JPEG image (in bytes) nthe number of transformed JPEG images to generate dstBufspointer to an array of n image buffers. dstBufs[i] will receive a JPEG image that has been transformed using the parameters in transforms[i]. TurboJPEG has the ability to reallocate the JPEG buffer to accommodate the size of the JPEG image. Thus, you can choose to:
    -
  1. pre-allocate the JPEG buffer with an arbitrary size and let TurboJPEG grow the buffer as needed,
    2. +
  2. pre-allocate the JPEG buffer with an arbitrary size using tjAlloc() and let TurboJPEG grow the buffer as needed,
  3. set dstBufs[i] to NULL to tell TurboJPEG to allocate the buffer for you, or
  4. pre-allocate the buffer to a "worst case" size determined by calling TJBUFSIZE() with the cropped width and height. This should ensure that the buffer never has to be re-allocated (setting TJFLAG_NOREALLOC guarantees this.)
@@ -1435,7 +1492,7 @@ If you choose option 1, dstSizes[i] should be set to the size of yo -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/index.html b/doc/html/index.html index 8969bb04..b6f40e80 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -69,7 +69,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/modules.html b/doc/html/modules.html index 9328d404..00855f00 100644 --- a/doc/html/modules.html +++ b/doc/html/modules.html @@ -72,7 +72,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/structtjregion.html b/doc/html/structtjregion.html index 8a23e46b..72186781 100644 --- a/doc/html/structtjregion.html +++ b/doc/html/structtjregion.html @@ -165,7 +165,7 @@ Data Fields -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/structtjscalingfactor.html b/doc/html/structtjscalingfactor.html index ad7858c7..2f8892a8 100644 --- a/doc/html/structtjscalingfactor.html +++ b/doc/html/structtjscalingfactor.html @@ -127,7 +127,7 @@ Data Fields -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/doc/html/structtjtransform.html b/doc/html/structtjtransform.html index 52524b22..86b23f7c 100644 --- a/doc/html/structtjtransform.html +++ b/doc/html/structtjtransform.html @@ -144,7 +144,7 @@ Data Fields -
Generated on Tue May 24 2011 05:15:41 for TurboJPEG by  +
Generated on Tue May 24 2011 11:42:39 for TurboJPEG by  doxygen 1.7.4
diff --git a/jpegut.c b/jpegut.c index d1dbbe84..115d0cb1 100644 --- a/jpegut.c +++ b/jpegut.c @@ -500,7 +500,7 @@ void doTest(int w, int h, const int *formats, int nformats, int subsamp, if(!alloc) { size=(yuv==YUVENCODE? TJBUFSIZEYUV(w, h, subsamp):TJBUFSIZE(w, h)); - if((dstBuf=(unsigned char *)malloc(size))==NULL) + if((dstBuf=(unsigned char *)tjAlloc(size))==NULL) _throw("Memory allocation failure."); } @@ -529,7 +529,7 @@ void doTest(int w, int h, const int *formats, int nformats, int subsamp, if(chandle) tjDestroy(chandle); if(dhandle) tjDestroy(dhandle); - if(dstBuf) free(dstBuf); + if(dstBuf) tjFree(dstBuf); } @@ -553,7 +553,7 @@ void doTest1(void) _throw("Memory allocation failure"); if(!alloc) { - if((jpegBuf=(unsigned char *)malloc(TJBUFSIZE(w, h)))==NULL) + if((jpegBuf=(unsigned char *)tjAlloc(TJBUFSIZE(w, h)))==NULL) _throw("Memory allocation failure"); jpegSize=TJBUFSIZE(w, h); } @@ -564,13 +564,13 @@ void doTest1(void) _tj(tjCompress2(handle, srcBuf, w, 0, h, TJPF_BGRX, &jpegBuf, &jpegSize, TJSAMP_444, 100, alloc? 0:TJFLAG_NOREALLOC)); free(srcBuf); srcBuf=NULL; - free(jpegBuf); jpegBuf=NULL; + tjFree(jpegBuf); jpegBuf=NULL; if((srcBuf=(unsigned char *)malloc(h*w*4))==NULL) _throw("Memory allocation failure"); if(!alloc) { - if((jpegBuf=(unsigned char *)malloc(TJBUFSIZE(h, w)))==NULL) + if((jpegBuf=(unsigned char *)tjAlloc(TJBUFSIZE(h, w)))==NULL) _throw("Memory allocation failure"); jpegSize=TJBUFSIZE(h, w); } @@ -583,7 +583,7 @@ void doTest1(void) _tj(tjCompress2(handle, srcBuf, h, 0, w, TJPF_BGRX, &jpegBuf, &jpegSize, TJSAMP_444, 100, alloc? 0:TJFLAG_NOREALLOC)); free(srcBuf); srcBuf=NULL; - free(jpegBuf); jpegBuf=NULL; + tjFree(jpegBuf); jpegBuf=NULL; } } printf("Done. \n"); diff --git a/turbojpeg-mapfile b/turbojpeg-mapfile index fbe2cc68..0e704ec0 100755 --- a/turbojpeg-mapfile +++ b/turbojpeg-mapfile @@ -25,9 +25,11 @@ TURBOJPEG_1.1 TURBOJPEG_1.2 { global: + tjAlloc; tjCompress2; tjDecompress2; tjEncodeYUV2; + tjFree; tjGetScalingFactors; tjInitTransform; tjTransform; diff --git a/turbojpeg-mapfile.jni b/turbojpeg-mapfile.jni index 5b322cbe..1465ad20 100755 --- a/turbojpeg-mapfile.jni +++ b/turbojpeg-mapfile.jni @@ -25,9 +25,11 @@ TURBOJPEG_1.1 TURBOJPEG_1.2 { global: + tjAlloc; tjCompress2; tjDecompress2; tjEncodeYUV2; + tjFree; tjGetScalingFactors; tjInitTransform; tjTransform; diff --git a/turbojpeg.h b/turbojpeg.h index 17bc306e..f6855479 100644 --- a/turbojpeg.h +++ b/turbojpeg.h @@ -432,8 +432,8 @@ DLLEXPORT tjhandle DLLCALL tjInitCompress(void); * @param jpegBuf address of a pointer to an image buffer that will receive the * JPEG image. TurboJPEG has the ability to reallocate the JPEG buffer * to accommodate the size of the JPEG image. Thus, you can choose to: - * -# pre-allocate the JPEG buffer with an arbitrary size and let - * TurboJPEG grow the buffer as needed, + * -# pre-allocate the JPEG buffer with an arbitrary size using + * #tjAlloc() and let TurboJPEG grow the buffer as needed, * -# set *jpegBuf to NULL to tell TurboJPEG to allocate the * buffer for you, or * -# pre-allocate the buffer to a "worst case" size determined by @@ -683,8 +683,8 @@ DLLEXPORT tjhandle DLLCALL tjInitTransform(void); * parameters in transforms[i]. TurboJPEG has the ability to * reallocate the JPEG buffer to accommodate the size of the JPEG image. * Thus, you can choose to: - * -# pre-allocate the JPEG buffer with an arbitrary size and let - * TurboJPEG grow the buffer as needed, + * -# pre-allocate the JPEG buffer with an arbitrary size using + * #tjAlloc() and let TurboJPEG grow the buffer as needed, * -# set dstBufs[i] to NULL to tell TurboJPEG to allocate the * buffer for you, or * -# pre-allocate the buffer to a "worst case" size determined by @@ -726,6 +726,31 @@ DLLEXPORT int DLLCALL tjTransform(tjhandle handle, unsigned char *jpegBuf, DLLEXPORT int DLLCALL tjDestroy(tjhandle handle); +/** + * Allocate an image buffer for use with TurboJPEG. You should always use + * this function to allocate the JPEG destination buffer(s) for #tjCompress2() + * and #tjTransform() unless you are disabling automatic buffer + * (re)allocation (by setting #TJFLAG_NOREALLOC.) + * + * @param bytes the number of bytes to allocate + * + * @return a pointer to a newly-allocated buffer with the specified number of + * bytes + */ +DLLEXPORT unsigned char* DLLCALL tjAlloc(int bytes); + + +/** + * Free an image buffer previously allocated by TurboJPEG. You should always + * use this function to free JPEG destination buffer(s) that were automatically + * (re)allocated by #tjCompress2() or #tjTransform() or that were manually + * allocated using #tjAlloc(). + * + * @param buffer address of the buffer to free + */ +DLLEXPORT void DLLCALL tjFree(unsigned char *buffer); + + /** * Returns a descriptive error message explaining why the last command failed. * diff --git a/turbojpegl.c b/turbojpegl.c index 37a72c90..ba2967c2 100644 --- a/turbojpegl.c +++ b/turbojpegl.c @@ -236,6 +236,23 @@ DLLEXPORT int DLLCALL tjDestroy(tjhandle handle) } +/* These are exposed mainly because Windows can't malloc() and free() across + DLL boundaries except when the CRT DLL is used, and we don't use the CRT DLL + with turbojpeg.dll for compatibility reasons. However, these functions + can potentially be used for other purposes by different implementations. */ + +DLLEXPORT void DLLCALL tjFree(unsigned char *buf) +{ + if(buf) free(buf); +} + + +DLLEXPORT unsigned char *DLLCALL tjAlloc(int bytes) +{ + return (unsigned char *)malloc(bytes); +} + + /* Compressor */ static tjhandle _tjInitCompress(tjinstance *this)