imgutils.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  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. /**
  30. * Compute the max pixel step for each plane of an image with a
  31. * format described by pixdesc.
  32. *
  33. * The pixel step is the distance in bytes between the first byte of
  34. * the group of bytes which describe a pixel component and the first
  35. * byte of the successive group in the same plane for the same
  36. * component.
  37. *
  38. * @param max_pixsteps an array which is filled with the max pixel step
  39. * for each plane. Since a plane may contain different pixel
  40. * components, the computed max_pixsteps[plane] is relative to the
  41. * component in the plane with the max pixel step.
  42. * @param max_pixstep_comps an array which is filled with the component
  43. * for each plane which has the max pixel step. May be NULL.
  44. */
  45. void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4],
  46. const AVPixFmtDescriptor *pixdesc);
  47. /**
  48. * Compute the size of an image line with format pix_fmt and width
  49. * width for the plane plane.
  50. *
  51. * @return the computed size in bytes
  52. */
  53. int av_image_get_linesize(enum PixelFormat pix_fmt, int width, int plane);
  54. /**
  55. * Fill plane linesizes for an image with pixel format pix_fmt and
  56. * width width.
  57. *
  58. * @param linesizes array to be filled with the linesize for each plane
  59. * @return >= 0 in case of success, a negative error code otherwise
  60. */
  61. int av_image_fill_linesizes(int linesizes[4], enum PixelFormat pix_fmt, int width);
  62. /**
  63. * Fill plane data pointers for an image with pixel format pix_fmt and
  64. * height height.
  65. *
  66. * @param data pointers array to be filled with the pointer for each image plane
  67. * @param ptr the pointer to a buffer which will contain the image
  68. * @param linesizes the array containing the linesize for each
  69. * plane, should be filled by av_image_fill_linesizes()
  70. * @return the size in bytes required for the image buffer, a negative
  71. * error code in case of failure
  72. */
  73. int av_image_fill_pointers(uint8_t *data[4], enum PixelFormat pix_fmt, int height,
  74. uint8_t *ptr, const int linesizes[4]);
  75. /**
  76. * Allocate an image with size w and h and pixel format pix_fmt, and
  77. * fill pointers and linesizes accordingly.
  78. * The allocated image buffer has to be freed by using
  79. * av_freep(&pointers[0]).
  80. *
  81. * @param align the value to use for buffer size alignment
  82. * @return the size in bytes required for the image buffer, a negative
  83. * error code in case of failure
  84. */
  85. int av_image_alloc(uint8_t *pointers[4], int linesizes[4],
  86. int w, int h, enum PixelFormat pix_fmt, int align);
  87. /**
  88. * Copy image plane from src to dst.
  89. * That is, copy "height" number of lines of "bytewidth" bytes each.
  90. * The first byte of each successive line is separated by *_linesize
  91. * bytes.
  92. *
  93. * @param dst_linesize linesize for the image plane in dst
  94. * @param src_linesize linesize for the image plane in src
  95. */
  96. void av_image_copy_plane(uint8_t *dst, int dst_linesize,
  97. const uint8_t *src, int src_linesize,
  98. int bytewidth, int height);
  99. /**
  100. * Copy image in src_data to dst_data.
  101. *
  102. * @param dst_linesizes linesizes for the image in dst_data
  103. * @param src_linesizes linesizes for the image in src_data
  104. */
  105. void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4],
  106. const uint8_t *src_data[4], const int src_linesizes[4],
  107. enum PixelFormat pix_fmt, int width, int height);
  108. /**
  109. * Setup the data pointers and linesizes based on the specified image
  110. * parameters and the provided array.
  111. *
  112. * The fields of the given image are filled in by using the src
  113. * address which points to the image data buffer. Depending on the
  114. * specified pixel format, one or multiple image data pointers and
  115. * line sizes will be set. If a planar format is specified, several
  116. * pointers will be set pointing to the different picture planes and
  117. * the line sizes of the different planes will be stored in the
  118. * lines_sizes array. Call with src == NULL to get the required
  119. * size for the src buffer.
  120. *
  121. * To allocate the buffer and fill in the dst_data and dst_linesize in
  122. * one call, use av_image_alloc().
  123. *
  124. * @param dst_data data pointers to be filled in
  125. * @param dst_linesizes linesizes for the image in dst_data to be filled in
  126. * @param src buffer which will contain or contains the actual image data, can be NULL
  127. * @param pix_fmt the pixel format of the image
  128. * @param width the width of the image in pixels
  129. * @param height the height of the image in pixels
  130. * @param align the value used in src for linesize alignment
  131. * @return the size in bytes required for src, a negative error code
  132. * in case of failure
  133. */
  134. int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4],
  135. const uint8_t *src,
  136. enum PixelFormat pix_fmt, int width, int height, int align);
  137. /**
  138. * Return the size in bytes of the amount of data required to store an
  139. * image with the given parameters.
  140. *
  141. * @param[in] align the assumed linesize alignment
  142. */
  143. int av_image_get_buffer_size(enum PixelFormat pix_fmt, int width, int height, int align);
  144. /**
  145. * Copy image data from an image into a buffer.
  146. *
  147. * av_image_get_buffer_size() can be used to compute the required size
  148. * for the buffer to fill.
  149. *
  150. * @param dst a buffer into which picture data will be copied
  151. * @param dst_size the size in bytes of dst
  152. * @param src_data pointers containing the source image data
  153. * @param src_linesizes linesizes for the image in src_data
  154. * @param pix_fmt the pixel format of the source image
  155. * @param width the width of the source image in pixels
  156. * @param height the height of the source image in pixels
  157. * @param align the assumed linesize alignment for dst
  158. * @return the number of bytes written to dst, or a negative value
  159. * (error code) on error
  160. */
  161. int av_image_copy_to_buffer(uint8_t *dst, int dst_size,
  162. const uint8_t * const src_data[4], const int src_linesize[4],
  163. enum PixelFormat pix_fmt, int width, int height, int align);
  164. /**
  165. * Check if the given dimension of an image is valid, meaning that all
  166. * bytes of the image can be addressed with a signed int.
  167. *
  168. * @param w the width of the picture
  169. * @param h the height of the picture
  170. * @param log_offset the offset to sum to the log level for logging with log_ctx
  171. * @param log_ctx the parent logging context, it may be NULL
  172. * @return >= 0 if valid, a negative error code otherwise
  173. */
  174. int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx);
  175. int ff_set_systematic_pal2(uint32_t pal[256], enum PixelFormat pix_fmt);
  176. /**
  177. * @}
  178. */
  179. #endif /* AVUTIL_IMGUTILS_H */