swscale.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. /*
  2. * Copyright (C) 2001-2011 Michael Niedermayer <michaelni@gmx.at>
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef SWSCALE_SWSCALE_H
  21. #define SWSCALE_SWSCALE_H
  22. /**
  23. * @file
  24. * @ingroup libsws
  25. * external API header
  26. */
  27. #include <stdint.h>
  28. #include "libavutil/avutil.h"
  29. #include "libavutil/log.h"
  30. #include "libavutil/pixfmt.h"
  31. #include "version.h"
  32. /**
  33. * @defgroup libsws libswscale
  34. * Color conversion and scaling library.
  35. *
  36. * @{
  37. *
  38. * Return the LIBSWSCALE_VERSION_INT constant.
  39. */
  40. unsigned swscale_version(void);
  41. /**
  42. * Return the libswscale build-time configuration.
  43. */
  44. const char *swscale_configuration(void);
  45. /**
  46. * Return the libswscale license.
  47. */
  48. const char *swscale_license(void);
  49. /* values for the flags, the stuff on the command line is different */
  50. #define SWS_FAST_BILINEAR 1
  51. #define SWS_BILINEAR 2
  52. #define SWS_BICUBIC 4
  53. #define SWS_X 8
  54. #define SWS_POINT 0x10
  55. #define SWS_AREA 0x20
  56. #define SWS_BICUBLIN 0x40
  57. #define SWS_GAUSS 0x80
  58. #define SWS_SINC 0x100
  59. #define SWS_LANCZOS 0x200
  60. #define SWS_SPLINE 0x400
  61. #define SWS_SRC_V_CHR_DROP_MASK 0x30000
  62. #define SWS_SRC_V_CHR_DROP_SHIFT 16
  63. #define SWS_PARAM_DEFAULT 123456
  64. #define SWS_PRINT_INFO 0x1000
  65. //the following 3 flags are not completely implemented
  66. //internal chrominance subsampling info
  67. #define SWS_FULL_CHR_H_INT 0x2000
  68. //input subsampling info
  69. #define SWS_FULL_CHR_H_INP 0x4000
  70. #define SWS_DIRECT_BGR 0x8000
  71. #define SWS_ACCURATE_RND 0x40000
  72. #define SWS_BITEXACT 0x80000
  73. #define SWS_ERROR_DIFFUSION 0x800000
  74. #define SWS_MAX_REDUCE_CUTOFF 0.002
  75. #define SWS_CS_ITU709 1
  76. #define SWS_CS_FCC 4
  77. #define SWS_CS_ITU601 5
  78. #define SWS_CS_ITU624 5
  79. #define SWS_CS_SMPTE170M 5
  80. #define SWS_CS_SMPTE240M 7
  81. #define SWS_CS_DEFAULT 5
  82. #define SWS_CS_BT2020 9
  83. /**
  84. * Return a pointer to yuv<->rgb coefficients for the given colorspace
  85. * suitable for sws_setColorspaceDetails().
  86. *
  87. * @param colorspace One of the SWS_CS_* macros. If invalid,
  88. * SWS_CS_DEFAULT is used.
  89. */
  90. const int *sws_getCoefficients(int colorspace);
  91. // when used for filters they must have an odd number of elements
  92. // coeffs cannot be shared between vectors
  93. typedef struct SwsVector {
  94. double *coeff; ///< pointer to the list of coefficients
  95. int length; ///< number of coefficients in the vector
  96. } SwsVector;
  97. // vectors can be shared
  98. typedef struct SwsFilter {
  99. SwsVector *lumH;
  100. SwsVector *lumV;
  101. SwsVector *chrH;
  102. SwsVector *chrV;
  103. } SwsFilter;
  104. struct SwsContext;
  105. /**
  106. * Return a positive value if pix_fmt is a supported input format, 0
  107. * otherwise.
  108. */
  109. int sws_isSupportedInput(enum AVPixelFormat pix_fmt);
  110. /**
  111. * Return a positive value if pix_fmt is a supported output format, 0
  112. * otherwise.
  113. */
  114. int sws_isSupportedOutput(enum AVPixelFormat pix_fmt);
  115. /**
  116. * @param[in] pix_fmt the pixel format
  117. * @return a positive value if an endianness conversion for pix_fmt is
  118. * supported, 0 otherwise.
  119. */
  120. int sws_isSupportedEndiannessConversion(enum AVPixelFormat pix_fmt);
  121. /**
  122. * Allocate an empty SwsContext. This must be filled and passed to
  123. * sws_init_context(). For filling see AVOptions, options.c and
  124. * sws_setColorspaceDetails().
  125. */
  126. struct SwsContext *sws_alloc_context(void);
  127. /**
  128. * Initialize the swscaler context sws_context.
  129. *
  130. * @return zero or positive value on success, a negative value on
  131. * error
  132. */
  133. av_warn_unused_result
  134. int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
  135. /**
  136. * Free the swscaler context swsContext.
  137. * If swsContext is NULL, then does nothing.
  138. */
  139. void sws_freeContext(struct SwsContext *swsContext);
  140. /**
  141. * Allocate and return an SwsContext. You need it to perform
  142. * scaling/conversion operations using sws_scale().
  143. *
  144. * @param srcW the width of the source image
  145. * @param srcH the height of the source image
  146. * @param srcFormat the source image format
  147. * @param dstW the width of the destination image
  148. * @param dstH the height of the destination image
  149. * @param dstFormat the destination image format
  150. * @param flags specify which algorithm and options to use for rescaling
  151. * @param param extra parameters to tune the used scaler
  152. * For SWS_BICUBIC param[0] and [1] tune the shape of the basis
  153. * function, param[0] tunes f(1) and param[1] f´(1)
  154. * For SWS_GAUSS param[0] tunes the exponent and thus cutoff
  155. * frequency
  156. * For SWS_LANCZOS param[0] tunes the width of the window function
  157. * @return a pointer to an allocated context, or NULL in case of error
  158. * @note this function is to be removed after a saner alternative is
  159. * written
  160. */
  161. struct SwsContext *sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat,
  162. int dstW, int dstH, enum AVPixelFormat dstFormat,
  163. int flags, SwsFilter *srcFilter,
  164. SwsFilter *dstFilter, const double *param);
  165. /**
  166. * Scale the image slice in srcSlice and put the resulting scaled
  167. * slice in the image in dst. A slice is a sequence of consecutive
  168. * rows in an image.
  169. *
  170. * Slices have to be provided in sequential order, either in
  171. * top-bottom or bottom-top order. If slices are provided in
  172. * non-sequential order the behavior of the function is undefined.
  173. *
  174. * @param c the scaling context previously created with
  175. * sws_getContext()
  176. * @param srcSlice the array containing the pointers to the planes of
  177. * the source slice
  178. * @param srcStride the array containing the strides for each plane of
  179. * the source image
  180. * @param srcSliceY the position in the source image of the slice to
  181. * process, that is the number (counted starting from
  182. * zero) in the image of the first row of the slice
  183. * @param srcSliceH the height of the source slice, that is the number
  184. * of rows in the slice
  185. * @param dst the array containing the pointers to the planes of
  186. * the destination image
  187. * @param dstStride the array containing the strides for each plane of
  188. * the destination image
  189. * @return the height of the output slice
  190. */
  191. int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[],
  192. const int srcStride[], int srcSliceY, int srcSliceH,
  193. uint8_t *const dst[], const int dstStride[]);
  194. /**
  195. * @param dstRange flag indicating the while-black range of the output (1=jpeg / 0=mpeg)
  196. * @param srcRange flag indicating the while-black range of the input (1=jpeg / 0=mpeg)
  197. * @param table the yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x]
  198. * @param inv_table the yuv2rgb coefficients describing the input yuv space, normally ff_yuv2rgb_coeffs[x]
  199. * @param brightness 16.16 fixed point brightness correction
  200. * @param contrast 16.16 fixed point contrast correction
  201. * @param saturation 16.16 fixed point saturation correction
  202. * @return -1 if not supported
  203. */
  204. int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
  205. int srcRange, const int table[4], int dstRange,
  206. int brightness, int contrast, int saturation);
  207. /**
  208. * @return -1 if not supported
  209. */
  210. int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
  211. int *srcRange, int **table, int *dstRange,
  212. int *brightness, int *contrast, int *saturation);
  213. /**
  214. * Allocate and return an uninitialized vector with length coefficients.
  215. */
  216. SwsVector *sws_allocVec(int length);
  217. /**
  218. * Return a normalized Gaussian curve used to filter stuff
  219. * quality = 3 is high quality, lower is lower quality.
  220. */
  221. SwsVector *sws_getGaussianVec(double variance, double quality);
  222. /**
  223. * Scale all the coefficients of a by the scalar value.
  224. */
  225. void sws_scaleVec(SwsVector *a, double scalar);
  226. /**
  227. * Scale all the coefficients of a so that their sum equals height.
  228. */
  229. void sws_normalizeVec(SwsVector *a, double height);
  230. #if FF_API_SWS_VECTOR
  231. attribute_deprecated SwsVector *sws_getConstVec(double c, int length);
  232. attribute_deprecated SwsVector *sws_getIdentityVec(void);
  233. attribute_deprecated void sws_convVec(SwsVector *a, SwsVector *b);
  234. attribute_deprecated void sws_addVec(SwsVector *a, SwsVector *b);
  235. attribute_deprecated void sws_subVec(SwsVector *a, SwsVector *b);
  236. attribute_deprecated void sws_shiftVec(SwsVector *a, int shift);
  237. attribute_deprecated SwsVector *sws_cloneVec(SwsVector *a);
  238. attribute_deprecated void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
  239. #endif
  240. void sws_freeVec(SwsVector *a);
  241. SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
  242. float lumaSharpen, float chromaSharpen,
  243. float chromaHShift, float chromaVShift,
  244. int verbose);
  245. void sws_freeFilter(SwsFilter *filter);
  246. /**
  247. * Check if context can be reused, otherwise reallocate a new one.
  248. *
  249. * If context is NULL, just calls sws_getContext() to get a new
  250. * context. Otherwise, checks if the parameters are the ones already
  251. * saved in context. If that is the case, returns the current
  252. * context. Otherwise, frees context and gets a new context with
  253. * the new parameters.
  254. *
  255. * Be warned that srcFilter and dstFilter are not checked, they
  256. * are assumed to remain the same.
  257. */
  258. struct SwsContext *sws_getCachedContext(struct SwsContext *context,
  259. int srcW, int srcH, enum AVPixelFormat srcFormat,
  260. int dstW, int dstH, enum AVPixelFormat dstFormat,
  261. int flags, SwsFilter *srcFilter,
  262. SwsFilter *dstFilter, const double *param);
  263. /**
  264. * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.
  265. *
  266. * The output frame will have the same packed format as the palette.
  267. *
  268. * @param src source frame buffer
  269. * @param dst destination frame buffer
  270. * @param num_pixels number of pixels to convert
  271. * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
  272. */
  273. void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
  274. /**
  275. * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.
  276. *
  277. * With the palette format "ABCD", the destination frame ends up with the format "ABC".
  278. *
  279. * @param src source frame buffer
  280. * @param dst destination frame buffer
  281. * @param num_pixels number of pixels to convert
  282. * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
  283. */
  284. void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
  285. /**
  286. * Get the AVClass for swsContext. It can be used in combination with
  287. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  288. *
  289. * @see av_opt_find().
  290. */
  291. const AVClass *sws_get_class(void);
  292. /**
  293. * @}
  294. */
  295. #endif /* SWSCALE_SWSCALE_H */