You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

335 lines
12KB

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