git.sesse.net Git - ffmpeg/blob - libavcore/imgutils.h

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef AVCORE_IMGUTILS_H
  20 #define AVCORE_IMGUTILS_H
  21
  22 /**
  23  * @file
  24  * misc image utilities
  25  */
  26
  27 #include "libavutil/pixfmt.h"
  28 #include "avcore.h"
  29
  30 /**
  31  * Fill plane linesizes for an image with pixel format pix_fmt and
  32  * width width.
  33  *
  34  * @param linesizes array to be filled with the linesize for each plane
  35  * @return >= 0 in case of success, a negative error code otherwise
  36  */
  37 int av_fill_image_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
  38
  39 /**
  40  * Fill plane data pointers for an image with pixel format pix_fmt and
  41  * height height.
  42  *
  43  * @param data pointers array to be filled with the pointer for each image plane
  44  * @param ptr the pointer to a buffer which will contain the image
  45  * @param linesizes[4] the array containing the linesize for each
  46  * plane, should be filled by av_fill_image_linesizes()
  47  * @return the size in bytes required for the image buffer, a negative
  48  * error code in case of failure
  49  */
  50 int av_fill_image_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
  51                            uint8_t *ptr, const int linesizes[4]);
  52
  53 /**
  54  * Check if the given dimension of an image is valid, meaning that all
  55  * bytes of the image can be addressed with a signed int.
  56  *
  57  * @param w the width of the picture
  58  * @param h the height of the picture
  59  * @param log_offset the offset to sum to the log level for logging with log_ctx
  60  * @param log_ctx the parent logging context, it may be NULL
  61  * @return >= 0 if valid, a negative error code otherwise
  62  */
  63 int av_check_image_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
  64
  65 #endif /* AVCORE_IMGUTILS_H */