Merge commit 'ce6d72d10776b03c6780d4aa676414ce002285d4'
authorJames Almer <jamrial@gmail.com>
Wed, 27 Sep 2017 23:35:04 +0000 (20:35 -0300)
committerJames Almer <jamrial@gmail.com>
Wed, 27 Sep 2017 23:35:04 +0000 (20:35 -0300)
* commit 'ce6d72d10776b03c6780d4aa676414ce002285d4':
  imgutils: Document av_image_get_buffer_size()

Merged-by: James Almer <jamrial@gmail.com>
1  2 
libavutil/imgutils.h

diff --combined libavutil/imgutils.h
@@@ -1,18 -1,18 +1,18 @@@
  /*
 - * This file is part of Libav.
 + * This file is part of FFmpeg.
   *
 - * Libav is free software; you can redistribute it and/or
 + * FFmpeg 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; either
   * version 2.1 of the License, or (at your option) any later version.
   *
 - * Libav is distributed in the hope that it will be useful,
 + * FFmpeg 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 Libav; if not, write to the Free Software
 + * License along with FFmpeg; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
   */
  
@@@ -100,9 -100,6 +100,9 @@@ int av_image_alloc(uint8_t *pointers[4]
   * The first byte of each successive line is separated by *_linesize
   * bytes.
   *
 + * bytewidth must be contained by both absolute values of dst_linesize
 + * and src_linesize, otherwise the function behavior is undefined.
 + *
   * @param dst_linesize linesize for the image plane in dst
   * @param src_linesize linesize for the image plane in src
   */
@@@ -172,7 -169,11 +172,11 @@@ int av_image_fill_arrays(uint8_t *dst_d
   * Return the size in bytes of the amount of data required to store an
   * image with the given parameters.
   *
-  * @param[in] align the assumed linesize alignment
+  * @param pix_fmt  the pixel format of the image
+  * @param width    the width of the image in pixels
+  * @param height   the height of the image in pixels
+  * @param align    the assumed linesize alignment
+  * @return the buffer size in bytes, a negative error code in case of failure
   */
  int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align);
  
@@@ -210,21 -211,6 +214,21 @@@ int av_image_copy_to_buffer(uint8_t *ds
  int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
  
  /**
 + * Check if the given dimension of an image is valid, meaning that all
 + * bytes of a plane of an image with the specified pix_fmt can be addressed
 + * with a signed int.
 + *
 + * @param w the width of the picture
 + * @param h the height of the picture
 + * @param max_pixels the maximum number of pixels the user wants to accept
 + * @param pix_fmt the pixel format, can be AV_PIX_FMT_NONE if unknown.
 + * @param log_offset the offset to sum to the log level for logging with log_ctx
 + * @param log_ctx the parent logging context, it may be NULL
 + * @return >= 0 if valid, a negative error code otherwise
 + */
 +int av_image_check_size2(unsigned int w, unsigned int h, int64_t max_pixels, enum AVPixelFormat pix_fmt, int log_offset, void *log_ctx);
 +
 +/**
   * Check if the given sample aspect ratio of an image is valid.
   *
   * It is considered invalid if the denominator is 0 or if applying the ratio
  int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar);
  
  /**
 + * Overwrite the image data with black. This is suitable for filling a
 + * sub-rectangle of an image, meaning the padding between the right most pixel
 + * and the left most pixel on the next line will not be overwritten. For some
 + * formats, the image size might be rounded up due to inherent alignment.
 + *
 + * If the pixel format has alpha, the alpha is cleared to opaque.
 + *
 + * This can return an error if the pixel format is not supported. Normally, all
 + * non-hwaccel pixel formats should be supported.
 + *
 + * Passing NULL for dst_data is allowed. Then the function returns whether the
 + * operation would have succeeded. (It can return an error if the pix_fmt is
 + * not supported.)
 + *
 + * @param dst_data      data pointers to destination image
 + * @param dst_linesize  linesizes for the destination image
 + * @param pix_fmt       the pixel format of the image
 + * @param range         the color range of the image (important for colorspaces such as YUV)
 + * @param width         the width of the image in pixels
 + * @param height        the height of the image in pixels
 + * @return 0 if the image data was cleared, a negative AVERROR code otherwise
 + */
 +int av_image_fill_black(uint8_t *dst_data[4], const ptrdiff_t dst_linesize[4],
 +                        enum AVPixelFormat pix_fmt, enum AVColorRange range,
 +                        int width, int height);
 +
 +/**
   * @}
   */