imgutils.h 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  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. #ifndef AVUTIL_IMGUTILS_H
  19. #define AVUTIL_IMGUTILS_H
  20. /**
  21. * @file
  22. * misc image utilities
  23. *
  24. * @addtogroup lavu_picture
  25. * @{
  26. */
  27. #include "avutil.h"
  28. #include "pixdesc.h"
  29. #include "rational.h"
  30. /**
  31. * Compute the max pixel step for each plane of an image with a
  32. * format described by pixdesc.
  33. *
  34. * The pixel step is the distance in bytes between the first byte of
  35. * the group of bytes which describe a pixel component and the first
  36. * byte of the successive group in the same plane for the same
  37. * component.
  38. *
  39. * @param max_pixsteps an array which is filled with the max pixel step
  40. * for each plane. Since a plane may contain different pixel
  41. * components, the computed max_pixsteps[plane] is relative to the
  42. * component in the plane with the max pixel step.
  43. * @param max_pixstep_comps an array which is filled with the component
  44. * for each plane which has the max pixel step. May be NULL.
  45. */
  46. void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
  47. const AVPixFmtDescriptor *pixdesc);
  48. /**
  49. * Compute the size of an image line with format pix_fmt and width
  50. * width for the plane plane.
  51. *
  52. * @return the computed size in bytes
  53. */
  54. int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane);
  55. /**
  56. * Fill plane linesizes for an image with pixel format pix_fmt and
  57. * width width.
  58. *
  59. * @param linesizes array to be filled with the linesize for each plane
  60. * @return >= 0 in case of success, a negative error code otherwise
  61. */
  62. int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width);
  63. /**
  64. * Fill plane data pointers for an image with pixel format pix_fmt and
  65. * height height.
  66. *
  67. * @param data pointers array to be filled with the pointer for each image plane
  68. * @param ptr the pointer to a buffer which will contain the image
  69. * @param linesizes the array containing the linesize for each
  70. * plane, should be filled by av_image_fill_linesizes()
  71. * @return the size in bytes required for the image buffer, a negative
  72. * error code in case of failure
  73. */
  74. int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height,
  75. uint8_t *ptr, const int linesizes[4]);
  76. /**
  77. * Allocate an image with size w and h and pixel format pix_fmt, and
  78. * fill pointers and linesizes accordingly.
  79. * The allocated image buffer has to be freed by using
  80. * av_freep(&pointers[0]).
  81. *
  82. * @param align the value to use for buffer size alignment
  83. * @return the size in bytes required for the image buffer, a negative
  84. * error code in case of failure
  85. */
  86. int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
  87. int w, int h, enum AVPixelFormat pix_fmt, int align);
  88. /**
  89. * Copy image plane from src to dst.
  90. * That is, copy "height" number of lines of "bytewidth" bytes each.
  91. * The first byte of each successive line is separated by *_linesize
  92. * bytes.
  93. *
  94. * bytewidth must be contained by both absolute values of dst_linesize
  95. * and src_linesize, otherwise the function behavior is undefined.
  96. *
  97. * @param dst_linesize linesize for the image plane in dst
  98. * @param src_linesize linesize for the image plane in src
  99. */
  100. void av_image_copy_plane(uint8_t *dst, int dst_linesize,
  101. const uint8_t *src, int src_linesize,
  102. int bytewidth, int height);
  103. /**
  104. * Copy image in src_data to dst_data.
  105. *
  106. * @param dst_linesizes linesizes for the image in dst_data
  107. * @param src_linesizes linesizes for the image in src_data
  108. */
  109. void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
  110. const uint8_t *src_data[4], const int src_linesizes[4],
  111. enum AVPixelFormat pix_fmt, int width, int height);
  112. /**
  113. * Setup the data pointers and linesizes based on the specified image
  114. * parameters and the provided array.
  115. *
  116. * The fields of the given image are filled in by using the src
  117. * address which points to the image data buffer. Depending on the
  118. * specified pixel format, one or multiple image data pointers and
  119. * line sizes will be set. If a planar format is specified, several
  120. * pointers will be set pointing to the different picture planes and
  121. * the line sizes of the different planes will be stored in the
  122. * lines_sizes array. Call with src == NULL to get the required
  123. * size for the src buffer.
  124. *
  125. * To allocate the buffer and fill in the dst_data and dst_linesize in
  126. * one call, use av_image_alloc().
  127. *
  128. * @param dst_data data pointers to be filled in
  129. * @param dst_linesizes linesizes for the image in dst_data to be filled in
  130. * @param src buffer which will contain or contains the actual image data, can be NULL
  131. * @param pix_fmt the pixel format of the image
  132. * @param width the width of the image in pixels
  133. * @param height the height of the image in pixels
  134. * @param align the value used in src for linesize alignment
  135. * @return the size in bytes required for src, a negative error code
  136. * in case of failure
  137. */
  138. int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
  139. const uint8_t *src,
  140. enum AVPixelFormat pix_fmt, int width, int height, int align);
  141. /**
  142. * Return the size in bytes of the amount of data required to store an
  143. * image with the given parameters.
  144. *
  145. * @param[in] align the assumed linesize alignment
  146. */
  147. int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align);
  148. /**
  149. * Copy image data from an image into a buffer.
  150. *
  151. * av_image_get_buffer_size() can be used to compute the required size
  152. * for the buffer to fill.
  153. *
  154. * @param dst a buffer into which picture data will be copied
  155. * @param dst_size the size in bytes of dst
  156. * @param src_data pointers containing the source image data
  157. * @param src_linesizes linesizes for the image in src_data
  158. * @param pix_fmt the pixel format of the source image
  159. * @param width the width of the source image in pixels
  160. * @param height the height of the source image in pixels
  161. * @param align the assumed linesize alignment for dst
  162. * @return the number of bytes written to dst, or a negative value
  163. * (error code) on error
  164. */
  165. int av_image_copy_to_buffer(uint8_t *dst, int dst_size,
  166. const uint8_t * const src_data[4], const int src_linesize[4],
  167. enum AVPixelFormat pix_fmt, int width, int height, int align);
  168. /**
  169. * Check if the given dimension of an image is valid, meaning that all
  170. * bytes of the image can be addressed with a signed int.
  171. *
  172. * @param w the width of the picture
  173. * @param h the height of the picture
  174. * @param log_offset the offset to sum to the log level for logging with log_ctx
  175. * @param log_ctx the parent logging context, it may be NULL
  176. * @return >= 0 if valid, a negative error code otherwise
  177. */
  178. int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
  179. /**
  180. * Check if the given dimension of an image is valid, meaning that all
  181. * bytes of the image can be addressed with a signed int.
  182. *
  183. * @param w the width of the picture
  184. * @param h the height of the picture
  185. * @param max_pixels the maximum number of pixels the user wants to accept
  186. * @param pix_fmt the pixel format, can be AV_PIX_FMT_NONE if unknown.
  187. * @param log_offset the offset to sum to the log level for logging with log_ctx
  188. * @param log_ctx the parent logging context, it may be NULL
  189. * @return >= 0 if valid, a negative error code otherwise
  190. */
  191. 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);
  192. /**
  193. * Check if the given sample aspect ratio of an image is valid.
  194. *
  195. * It is considered invalid if the denominator is 0 or if applying the ratio
  196. * to the image size would make the smaller dimension less than 1. If the
  197. * sar numerator is 0, it is considered unknown and will return as valid.
  198. *
  199. * @param w width of the image
  200. * @param h height of the image
  201. * @param sar sample aspect ratio of the image
  202. * @return 0 if valid, a negative AVERROR code otherwise
  203. */
  204. int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar);
  205. /**
  206. * @}
  207. */
  208. #endif /* AVUTIL_IMGUTILS_H */