]> git.sesse.net Git - ffmpeg/blobdiff - libswscale/swscale.h
dump metadata for AVStreams & AVPrograms too.
[ffmpeg] / libswscale / swscale.h
index 522824831b516f8361e4735571650c49bad8fdcb..d940e8227134748c48a2941726e73a276aadecff 100644 (file)
@@ -31,7 +31,7 @@
 
 #define LIBSWSCALE_VERSION_MAJOR 0
 #define LIBSWSCALE_VERSION_MINOR 7
-#define LIBSWSCALE_VERSION_MICRO 1
+#define LIBSWSCALE_VERSION_MICRO 2
 
 #define LIBSWSCALE_VERSION_INT  AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \
                                                LIBSWSCALE_VERSION_MINOR, \
  */
 unsigned swscale_version(void);
 
+/**
+ * Returns the libswscale build-time configuration.
+ */
+const char * swscale_configuration(void);
+
+/**
+ * Returns the libswscale license.
+ */
+const char * swscale_license(void);
+
 /* values for the flags, the stuff on the command line is different */
 #define SWS_FAST_BILINEAR     1
 #define SWS_BILINEAR          2
@@ -112,6 +122,10 @@ typedef struct {
 
 struct SwsContext;
 
+/**
+ * Frees the swscaler context swsContext.
+ * If swsContext is NULL, then does nothing.
+ */
 void sws_freeContext(struct SwsContext *swsContext);
 
 /**
@@ -130,13 +144,17 @@ void sws_freeContext(struct SwsContext *swsContext);
 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
                                   int dstW, int dstH, enum PixelFormat dstFormat,
                                   int flags, SwsFilter *srcFilter,
-                                  SwsFilter *dstFilter, double *param);
+                                  SwsFilter *dstFilter, const double *param);
 
 /**
- * Scales the image slice in \p srcSlice and puts the resulting scaled
- * slice in the image in \p dst. A slice is a sequence of consecutive
+ * Scales the image slice in srcSlice and puts the resulting scaled
+ * slice in the image in dst. A slice is a sequence of consecutive
  * rows in an image.
  *
+ * Slices have to be provided in sequential order, either in
+ * top-bottom or bottom-top order. If slices are provided in
+ * non-sequential order the behavior of the function is undefined.
+ *
  * @param context   the scaling context previously created with
  *                  sws_getContext()
  * @param srcSlice  the array containing the pointers to the planes of
@@ -165,14 +183,27 @@ int sws_scale_ordered(struct SwsContext *context, uint8_t* src[],
                       uint8_t* dst[], int dstStride[]) attribute_deprecated;
 #endif
 
-
+/**
+ * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
+ * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
+ * @return -1 if not supported
+ */
 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
                              int srcRange, const int table[4], int dstRange,
                              int brightness, int contrast, int saturation);
+
+/**
+ * @return -1 if not supported
+ */
 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
                              int *srcRange, int **table, int *dstRange,
                              int *brightness, int *contrast, int *saturation);
 
+/**
+ * Allocates and returns an uninitialized vector with length coefficients.
+ */
+SwsVector *sws_allocVec(int length);
+
 /**
  * Returns a normalized Gaussian curve used to filter stuff
  * quality=3 is high quality, lower is lower quality.
@@ -180,8 +211,8 @@ int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
 SwsVector *sws_getGaussianVec(double variance, double quality);
 
 /**
- * Allocates and returns a vector with \p length coefficients, all
- * with the same value \p c.
+ * Allocates and returns a vector with length coefficients, all
+ * with the same value c.
  */
 SwsVector *sws_getConstVec(double c, int length);
 
@@ -192,13 +223,12 @@ SwsVector *sws_getConstVec(double c, int length);
 SwsVector *sws_getIdentityVec(void);
 
 /**
- * Scales all the coefficients of \p a by the \p scalar value.
+ * Scales all the coefficients of a by the scalar value.
  */
 void sws_scaleVec(SwsVector *a, double scalar);
 
 /**
- * Scales all the coefficients of \p a so that their sum equals \p
- * height."
+ * Scales all the coefficients of a so that their sum equals height.
  */
 void sws_normalizeVec(SwsVector *a, double height);
 void sws_convVec(SwsVector *a, SwsVector *b);
@@ -207,8 +237,8 @@ void sws_subVec(SwsVector *a, SwsVector *b);
 void sws_shiftVec(SwsVector *a, int shift);
 
 /**
- * Allocates and returns a clone of the vector \p a, that is a vector
- * with the same coefficients as \p a.
+ * Allocates and returns a clone of the vector a, that is a vector
+ * with the same coefficients as a.
  */
 SwsVector *sws_cloneVec(SwsVector *a);
 
@@ -220,8 +250,8 @@ attribute_deprecated void sws_printVec(SwsVector *a);
 #endif
 
 /**
- * Prints with av_log() a textual representation of the vector \p a
- * if \p log_level <= av_log_level.
+ * Prints with av_log() a textual representation of the vector a
+ * if log_level <= av_log_level.
  */
 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
 
@@ -234,22 +264,22 @@ SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
 void sws_freeFilter(SwsFilter *filter);
 
 /**
- * Checks if \p context can be reused, otherwise reallocates a new
+ * Checks if context can be reused, otherwise reallocates a new
  * one.
  *
- * If \p context is NULL, just calls sws_getContext() to get a new
+ * If context is NULL, just calls sws_getContext() to get a new
  * context. Otherwise, checks if the parameters are the ones already
- * saved in \p context. If that is the case, returns the current
- * context. Otherwise, frees \p context and gets a new context with
+ * saved in context. If that is the case, returns the current
+ * context. Otherwise, frees context and gets a new context with
  * the new parameters.
  *
- * Be warned that \p srcFilter and \p dstFilter are not checked, they
+ * Be warned that srcFilter and dstFilter are not checked, they
  * are assumed to remain the same.
  */
 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
                                         int srcW, int srcH, enum PixelFormat srcFormat,
                                         int dstW, int dstH, enum PixelFormat dstFormat,
                                         int flags, SwsFilter *srcFilter,
-                                        SwsFilter *dstFilter, double *param);
+                                        SwsFilter *dstFilter, const double *param);
 
 #endif /* SWSCALE_SWSCALE_H */