From: DRC Date: Tue, 12 Aug 2014 15:52:51 +0000 (+0000) Subject: Oops. Parameter name is "strides", not "stride" X-Git-Tag: 1.3.90~33 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f7c11051de9b68846cc58efc7583b4bdf7062299;p=libjpeg-turbo Oops. Parameter name is "strides", not "stride" git-svn-id: svn+ssh://svn.code.sf.net/p/libjpeg-turbo/code/trunk@1345 632fc199-4ca6-4c93-a231-07263d6284db --- diff --git a/doc/html/group___turbo_j_p_e_g.html b/doc/html/group___turbo_j_p_e_g.html index 72a3656..e40189e 100644 --- a/doc/html/group___turbo_j_p_e_g.html +++ b/doc/html/group___turbo_j_p_e_g.html @@ -1188,7 +1188,7 @@ If you choose option 1, *jpegSize should be set to the size of your handlea handle to a TurboJPEG compressor or transformer instance srcPlanesan array of pointers to Y, U (Cb), and V (Cr) image planes (or just a Y plane, if compressing a grayscale image) that contain a YUV image to be compressed. These planes can be contiguous or non-contiguous in memory. Each plane should be at least {component stride} * {component height} bytes in size. (See below for a description of stride, and refer to YUV Image Format Notes for a description of component height.) widthwidth (in pixels) of the source image. If the 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 YUV source image. Setting the stride for any plane to 0 is the same as setting it to the component width for the plane. If stride is NULL, then the strides for all planes will be set to their respective component widths. You can adjust the strides in order to specify an arbitrary amount of line padding in each plane or to create a JPEG image from a subregion of a larger YUV planar image. + stridesan array of integers, each specifying the number of bytes per line in the corresponding plane of the YUV source image. Setting the stride for any plane to 0 is the same as setting it to the component width for the plane. If strides is NULL, then the strides for all planes will be set to their respective component widths. You can adjust the strides in order to specify an arbitrary amount of line padding in each plane or to create a JPEG image from a subregion of a larger YUV planar image. heightheight (in pixels) of the source image. If the height is not an even multiple of the MCU block height (see tjMCUHeight), then an intermediate buffer copy will be performed within TurboJPEG. subsampthe level of chrominance subsampling used in the source image (see Chrominance subsampling options.) 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:
    @@ -1378,7 +1378,7 @@ If you choose option 1, *jpegSize should be set to the size of your - + @@ -1697,7 +1697,7 @@ If you choose option 1, *jpegSize should be set to the size of your - +
    handlea handle to a TurboJPEG decompressor or transformer instance
    srcPlanesan array of pointers to Y, U (Cb), and V (Cr) image planes (or just a Y plane, if decoding a grayscale image) that contain a YUV image to be decoded. These planes can be contiguous or non-contiguous in memory. Each plane should be at least {component stride} * {component height} bytes in size. (See below for a description of stride, and refer to YUV Image Format Notes for a description of component height.)
    stridesan array of integers, each specifying the number of bytes per line in the corresponding plane of the YUV source image. Setting the stride for any plane to 0 is the same as setting it to the component width for the plane. If stride is NULL, then the strides for all planes will be set to their respective component widths. You can adjust the strides in order to specify an arbitrary amount of line padding in each plane or to decode a subregion of a larger YUV planar image.
    stridesan array of integers, each specifying the number of bytes per line in the corresponding plane of the YUV source image. Setting the stride for any plane to 0 is the same as setting it to the component width for the plane. If strides is NULL, then the strides for all planes will be set to their respective component widths. You can adjust the strides in order to specify an arbitrary amount of line padding in each plane or to decode a subregion of a larger YUV planar image.
    subsampthe level of chrominance subsampling used in the YUV source image (see Chrominance subsampling options.)
    dstBufpointer to an image buffer that will receive the decoded image. This buffer should normally be pitch * height bytes in size, but the dstBuf pointer can also be used to decode into a specific region of a larger buffer.
    widthwidth (in pixels) of the source and destination images
    jpegSizesize of the JPEG image (in bytes)
    dstPlanesan array of pointers to Y, U (Cb), and V (Cr) image planes (or just a Y plane, if decompressing a grayscale image) that will receive the YUV image. These planes can be contiguous or non-contiguous in memory. Each plane should be at least {component stride} * {scaled component height} bytes in size. (See below for a description of stride, and refer to YUV Image Format Notes for a description of component height.)
    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 component width for the plane. If stride is NULL, then the strides for all planes will be set to their respective scaled component 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.
    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 component width for the plane. If strides is NULL, then the strides for all planes will be set to their respective scaled component 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.
    @@ -1908,7 +1908,7 @@ If you choose option 1, *jpegSize should be set to the size of your heightheight (in pixels) of the source image pixelFormatpixel format of the source image (see Pixel formats.) 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. Each plane should be at least {component stride} * {component height} bytes in size. (See below for a description of stride, and refer to YUV Image Format Notes for a description of component height.) - 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 component width for the plane. If stride is NULL, then the strides for all planes will be set to their respective component 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. + 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 component width for the plane. If strides is NULL, then the strides for all planes will be set to their respective component 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. diff --git a/turbojpeg.h b/turbojpeg.h index 90985b3..0ba7070 100644 --- a/turbojpeg.h +++ b/turbojpeg.h @@ -759,7 +759,7 @@ DLLEXPORT int DLLCALL tjCompressFromYUV(tjhandle handle, unsigned char *srcBuf, * @param strides an array of integers, each specifying the number of bytes per * line in the corresponding plane of the YUV source image. Setting the stride * for any plane to 0 is the same as setting it to the component width for the - * plane. If stride is NULL, then the strides for all planes will be + * plane. If strides is NULL, then the strides for all planes will be * set to their respective component widths. You can adjust the strides in * order to specify an arbitrary amount of line padding in each plane or to * create a JPEG image from a subregion of a larger YUV planar image. @@ -943,7 +943,7 @@ DLLEXPORT int DLLCALL tjEncodeYUV3(tjhandle handle, * @param strides an 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 component width for the - * plane. If stride is NULL, then the strides for all planes will be + * plane. If strides is NULL, then the strides for all planes will be * set to their respective component 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. @@ -1151,8 +1151,8 @@ DLLEXPORT int DLLCALL tjDecompressToYUV2(tjhandle handle, * @param strides an 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 component width for - * the plane. If stride is NULL, then the strides for all planes will - * be set to their respective scaled component widths. You can adjust the + * the plane. If strides is NULL, then the strides for all planes + * will be set to their respective scaled component 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. * @@ -1246,7 +1246,7 @@ DLLEXPORT int DLLCALL tjDecodeYUV(tjhandle handle, unsigned char *srcBuf, * @param strides an array of integers, each specifying the number of bytes per * line in the corresponding plane of the YUV source image. Setting the stride * for any plane to 0 is the same as setting it to the component width for the - * plane. If stride is NULL, then the strides for all planes will be + * plane. If strides is NULL, then the strides for all planes will be * set to their respective component widths. You can adjust the strides in * order to specify an arbitrary amount of line padding in each plane or to * decode a subregion of a larger YUV planar image.