From: DRC Date: Tue, 14 Nov 2017 22:12:13 +0000 (-0600) Subject: Doc tweak: TJFLAG_ACCURATEDCT is the first flag X-Git-Tag: 1.5.3~8 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5abf2536f6f80a6b826788294669926b82ca870b;p=libjpeg-turbo Doc tweak: TJFLAG_ACCURATEDCT is the first flag --- diff --git a/doc/html/group___turbo_j_p_e_g.html b/doc/html/group___turbo_j_p_e_g.html index 8d7626d..89780d4 100644 --- a/doc/html/group___turbo_j_p_e_g.html +++ b/doc/html/group___turbo_j_p_e_g.html @@ -1014,7 +1014,7 @@ If you choose option 1, *jpegSize should be set to the size of your jpegSizepointer to an unsigned long variable that holds the size of the JPEG image buffer. If *jpegBuf points to a pre-allocated buffer, then *jpegSize should be set to the size of the buffer. Upon return, *jpegSize will contain the size of the JPEG image (in bytes.) If *jpegBuf points to a JPEG image buffer that is being reused from a previous call to one of the JPEG compression functions, then *jpegSize is ignored. jpegSubsampthe level of chrominance subsampling to be used when generating the JPEG image (see Chrominance subsampling options.) jpegQualthe image quality of the generated JPEG image (1 = worst, 100 = best) - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1111,7 +1111,7 @@ If you choose option 1, *jpegSize should be set to the size of your If you choose option 1, *jpegSize should be set to the size of your pre-allocated buffer. In any case, unless you have set TJFLAG_NOREALLOC, you should always check *jpegBuf upon return from this function, as it may have changed. jpegSizepointer to an unsigned long variable that holds the size of the JPEG image buffer. If *jpegBuf points to a pre-allocated buffer, then *jpegSize should be set to the size of the buffer. Upon return, *jpegSize will contain the size of the JPEG image (in bytes.) If *jpegBuf points to a JPEG image buffer that is being reused from a previous call to one of the JPEG compression functions, then *jpegSize is ignored. jpegQualthe image quality of the generated JPEG image (1 = worst, 100 = best) - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1208,7 +1208,7 @@ If you choose option 1, *jpegSize should be set to the size of your If you choose option 1, *jpegSize should be set to the size of your pre-allocated buffer. In any case, unless you have set TJFLAG_NOREALLOC, you should always check *jpegBuf upon return from this function, as it may have changed. jpegSizepointer to an unsigned long variable that holds the size of the JPEG image buffer. If *jpegBuf points to a pre-allocated buffer, then *jpegSize should be set to the size of the buffer. Upon return, *jpegSize will contain the size of the JPEG image (in bytes.) If *jpegBuf points to a JPEG image buffer that is being reused from a previous call to one of the JPEG compression functions, then *jpegSize is ignored. jpegQualthe image quality of the generated JPEG image (1 = worst, 100 = best) - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1301,7 +1301,7 @@ If you choose option 1, *jpegSize should be set to the size of your pitchbytes per line in the destination image. Normally, this should be width * tjPixelSize[pixelFormat] if the destination image is unpadded, or TJPAD(width * tjPixelSize[pixelFormat]) if each line of the destination image should be padded to the nearest 32-bit boundary, as is the case for Windows bitmaps. You can also be clever and use the pitch parameter to skip lines, etc. Setting this parameter to 0 is the equivalent of setting it to width * tjPixelSize[pixelFormat]. heightheight (in pixels) of the source and destination images pixelFormatpixel format of the destination image (see Pixel formats.) - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1394,7 +1394,7 @@ If you choose option 1, *jpegSize should be set to the size of your pitchbytes per line in the destination image. Normally, this should be width * tjPixelSize[pixelFormat] if the destination image is unpadded, or TJPAD(width * tjPixelSize[pixelFormat]) if each line of the destination image should be padded to the nearest 32-bit boundary, as is the case for Windows bitmaps. You can also be clever and use the pitch parameter to skip lines, etc. Setting this parameter to 0 is the equivalent of setting it to width * tjPixelSize[pixelFormat]. heightheight (in pixels) of the source and destination images pixelFormatpixel format of the destination image (see Pixel formats.) - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1479,7 +1479,7 @@ If you choose option 1, *jpegSize should be set to the size of your pitchbytes per line in the destination image. Normally, this is scaledWidth * tjPixelSize[pixelFormat] if the decompressed image is unpadded, else TJPAD(scaledWidth * tjPixelSize[pixelFormat]) if each line of the decompressed image is padded to the nearest 32-bit boundary, as is the case for Windows bitmaps. (NOTE: scaledWidth can be determined by calling TJSCALED() with the JPEG image width and one of the scaling factors returned by tjGetScalingFactors().) You can also be clever and use the pitch parameter to skip lines, etc. Setting this parameter to 0 is the equivalent of setting it to scaledWidth * tjPixelSize[pixelFormat]. heightdesired height (in pixels) of the destination image. If this is different than the height of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired height. If height is set to 0, then only the width will be considered when determining the scaled image size. pixelFormatpixel format of the destination image (see Pixel formats.) - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1629,7 +1629,7 @@ If you choose option 1, *jpegSize should be set to the size of your widthdesired width (in pixels) of the YUV image. If this is different than the width of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired width. If width is set to 0, then only the height will be considered when determining the scaled image size. If the scaled width is not an even multiple of the MCU block width (see tjMCUWidth), then an intermediate buffer copy will be performed within TurboJPEG. padthe width of each line in each plane of the YUV image will be padded to the nearest multiple of this number of bytes (must be a power of 2.) To generate images suitable for X Video, pad should be set to 4. heightdesired height (in pixels) of the YUV image. If this is different than the height of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired height. If height is set to 0, then only the width will be considered when determining the scaled image size. If the scaled height is not an even multiple of the MCU block height (see tjMCUHeight), then an intermediate buffer copy will be performed within TurboJPEG. - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1708,7 +1708,7 @@ If you choose option 1, *jpegSize should be set to the size of your widthdesired width (in pixels) of the YUV image. If this is different than the width of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired width. If width is set to 0, then only the height will be considered when determining the scaled image size. If the scaled width is not an even multiple of the MCU block width (see tjMCUWidth), then an intermediate buffer copy will be performed within TurboJPEG. stridesan array of integers, each specifying the number of bytes per line in the corresponding plane of the output image. Setting the stride for any plane to 0 is the same as setting it to the scaled plane width (see YUV Image Format Notes.) If strides is NULL, then the strides for all planes will be set to their respective scaled plane widths. You can adjust the strides in order to add an arbitrary amount of line padding to each plane or to decompress the JPEG image into a subregion of a larger YUV planar image. heightdesired height (in pixels) of the YUV image. If this is different than the height of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired height. If height is set to 0, then only the width will be considered when determining the scaled image size. If the scaled height is not an even multiple of the MCU block height (see tjMCUHeight), then an intermediate buffer copy will be performed within TurboJPEG. - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1826,7 +1826,7 @@ If you choose option 1, *jpegSize should be set to the size of your dstBufpointer to an image buffer that will receive the YUV image. Use tjBufSizeYUV2() to determine the appropriate size for this buffer based on the image width, height, padding, and level of chrominance subsampling. The Y, U (Cb), and V (Cr) image planes will be stored sequentially in the buffer (refer to YUV Image Format Notes.) padthe width of each line in each plane of the YUV image will be padded to the nearest multiple of this number of bytes (must be a power of 2.) To generate images suitable for X Video, pad should be set to 4. subsampthe level of chrominance subsampling to be used when generating the YUV image (see Chrominance subsampling options.) To generate images suitable for X Video, subsamp should be set to TJSAMP_420. This produces an image compatible with the I420 (AKA "YUV420P") format. - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -1919,7 +1919,7 @@ If you choose option 1, *jpegSize should be set to the size of your dstPlanesan array of pointers to Y, U (Cb), and V (Cr) image planes (or just a Y plane, if generating a grayscale image) that will receive the encoded image. These planes can be contiguous or non-contiguous in memory. Use tjPlaneSizeYUV() to determine the appropriate size for each plane based on the image width, height, strides, and level of chrominance subsampling. Refer to YUV Image Format Notes for more details. stridesan array of integers, each specifying the number of bytes per line in the corresponding plane of the output image. Setting the stride for any plane to 0 is the same as setting it to the plane width (see YUV Image Format Notes.) If strides is NULL, then the strides for all planes will be set to their respective plane widths. You can adjust the strides in order to add an arbitrary amount of line padding to each plane or to encode an RGB or grayscale image into a subregion of a larger YUV planar image. subsampthe level of chrominance subsampling to be used when generating the YUV image (see Chrominance subsampling options.) To generate images suitable for X Video, subsamp should be set to TJSAMP_420. This produces an image compatible with the I420 (AKA "YUV420P") format. - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags @@ -2275,7 +2275,7 @@ If you choose option 1, *jpegSize should be set to the size of your If you choose option 1, dstSizes[i] should be set to the size of your pre-allocated buffer. In any case, unless you have set TJFLAG_NOREALLOC, you should always check dstBufs[i] upon return from this function, as it may have changed. dstSizespointer to an array of n unsigned long variables that will receive the actual sizes (in bytes) of each transformed JPEG image. If dstBufs[i] points to a pre-allocated buffer, then dstSizes[i] should be set to the size of the buffer. Upon return, dstSizes[i] will contain the size of the JPEG image (in bytes.) transformspointer to an array of n tjtransform structures, each of which specifies the transform parameters and/or cropping region for the corresponding transformed output image. - flagsthe bitwise OR of one or more of the flags + flagsthe bitwise OR of one or more of the flags diff --git a/turbojpeg.h b/turbojpeg.h index 410e98a..307dc6f 100644 --- a/turbojpeg.h +++ b/turbojpeg.h @@ -666,7 +666,7 @@ DLLEXPORT tjhandle DLLCALL tjInitCompress(void); * @param jpegQual the image quality of the generated JPEG image (1 = worst, * 100 = best) * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -730,7 +730,7 @@ DLLEXPORT int DLLCALL tjCompress2(tjhandle handle, const unsigned char *srcBuf, * @param jpegQual the image quality of the generated JPEG image (1 = worst, * 100 = best) * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -800,7 +800,7 @@ DLLEXPORT int DLLCALL tjCompressFromYUV(tjhandle handle, * @param jpegQual the image quality of the generated JPEG image (1 = worst, * 100 = best) * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -960,7 +960,7 @@ DLLEXPORT int tjPlaneHeight(int componentID, int height, int subsamp); * Video, subsamp should be set to @ref TJSAMP_420. This produces an * image compatible with the I420 (AKA "YUV420P") format. * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1018,7 +1018,7 @@ DLLEXPORT int DLLCALL tjEncodeYUV3(tjhandle handle, * Video, subsamp should be set to @ref TJSAMP_420. This produces an * image compatible with the I420 (AKA "YUV420P") format. * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1125,7 +1125,7 @@ DLLEXPORT tjscalingfactor* DLLCALL tjGetScalingFactors(int *numscalingfactors); * @param pixelFormat pixel format of the destination image (see @ref * TJPF "Pixel formats".) * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1175,7 +1175,7 @@ DLLEXPORT int DLLCALL tjDecompress2(tjhandle handle, * block height (see #tjMCUHeight), then an intermediate buffer copy will be * performed within TurboJPEG. * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1231,7 +1231,7 @@ DLLEXPORT int DLLCALL tjDecompressToYUV2(tjhandle handle, * block height (see #tjMCUHeight), then an intermediate buffer copy will be * performed within TurboJPEG. * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1283,7 +1283,7 @@ DLLEXPORT int DLLCALL tjDecompressToYUVPlanes(tjhandle handle, * @param pixelFormat pixel format of the destination image (see @ref TJPF * "Pixel formats".) * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1340,7 +1340,7 @@ DLLEXPORT int DLLCALL tjDecodeYUV(tjhandle handle, const unsigned char *srcBuf, * @param pixelFormat pixel format of the destination image (see @ref TJPF * "Pixel formats".) * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().) @@ -1414,7 +1414,7 @@ DLLEXPORT tjhandle DLLCALL tjInitTransform(void); * which specifies the transform parameters and/or cropping region for the * corresponding transformed output image. * - * @param flags the bitwise OR of one or more of the @ref TJFLAG_BOTTOMUP + * @param flags the bitwise OR of one or more of the @ref TJFLAG_ACCURATEDCT * "flags" * * @return 0 if successful, or -1 if an error occurred (see #tjGetErrorStr().)