[FFmpeg-devel] [PATCH] Some documentation for swscale.h

[Michael Niedermayer]

On Tue, Feb 10, 2009 at 01:41:43AM +0100, Stefano Sabatini wrote:
> On date Tuesday 2009-02-10 01:19:03 +0100, Stefano Sabatini encoded:
> [...]
> > Sorry, I split part of the patch into small patches, hope they are
> > more acceptable now.
> > 
> > Summary:
> [...]
> 
> Some more:
> 
> * sws-move-getgaussianvec.patch
>   Move sws_getGaussianVec() documentation from swscale.c to swscale.h.
> 
> * sws-fix-getgaussianvec.patch
>   Some rework of the already existing documentation for
>   sws_getGaussianVec().
> 
> * sws-document-getcontext.patch
>   Document sws_getContext().
> 
> Regards.
> -- 
> FFmpeg = Faboulous and Funny Merciless Picky Ecumenical Game

> Index: ffmpeg/libswscale/swscale.h
> ===================================================================
> --- ffmpeg.orig/libswscale/swscale.h	2009-02-10 01:28:28.000000000 +0100
> +++ ffmpeg/libswscale/swscale.h	2009-02-10 01:39:19.000000000 +0100
> @@ -129,6 +129,11 @@
>  
>  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);
>  int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation);
> +
> +/**
> + * Returns a normalized Gaussian curve used to filter stuff
> + * quality=3 is high quality, lower is lower quality.
> + */
>  SwsVector *sws_getGaussianVec(double variance, double quality);
>  
>  /**
> Index: ffmpeg/libswscale/swscale.c
> ===================================================================
> --- ffmpeg.orig/libswscale/swscale.c	2009-02-10 01:28:28.000000000 +0100
> +++ ffmpeg/libswscale/swscale.c	2009-02-10 01:29:08.000000000 +0100
> @@ -2885,10 +2885,6 @@
>      return filter;
>  }
>  
> -/**
> - * Returns a normalized Gaussian curve used to filter stuff
> - * quality=3 is high quality, lower is lower quality.
> - */
>  SwsVector *sws_getGaussianVec(double variance, double quality){
>      const int length= (int)(variance*quality + 0.5) | 1;
>      int i;

ok


> Index: ffmpeg/libswscale/swscale.h
> ===================================================================
> --- ffmpeg.orig/libswscale/swscale.h	2009-02-10 01:29:25.000000000 +0100
> +++ ffmpeg/libswscale/swscale.h	2009-02-10 01:38:57.000000000 +0100
> @@ -131,8 +131,10 @@
>  int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation);
>  
>  /**
> - * Returns a normalized Gaussian curve used to filter stuff
> + * Returns a normalized Gaussian curve used to filter.

is it me or did this become worse grammar wise? not that my original is
more than trash


> + *
> - * quality=3 is high quality, lower is lower quality.
> + * @param quality the quality of the Gaussian filter, a value of 3 is
> + * high quality, lower is lower quality.
>   */
>  SwsVector *sws_getGaussianVec(double variance, double quality);
>  

ok


> Index: ffmpeg/libswscale/swscale.h
> ===================================================================
> --- ffmpeg.orig/libswscale/swscale.h	2009-02-10 01:33:52.000000000 +0100
> +++ ffmpeg/libswscale/swscale.h	2009-02-10 01:33:58.000000000 +0100
> @@ -114,6 +114,19 @@
>  
>  void sws_freeContext(struct SwsContext *swsContext);
>  
> +/**
> + * Allocates and returns a scale context. You need it to perform

SwsContext


> + * successive scaling operations using sws_scale().

successive?


> + *
> + * @param srcW the width of the source image
> + * @param srcH the height of the source image
> + * @param srcFormat the source image format
> + * @param dstW the width of the destination image
> + * @param dstH the height of the destination image
> + * @param dstFormat the destination image format
> + * @param flags specify which algorithm and options to use for the rescaling
> + * @return a pointer to an allocated context, or NULL in case of error
> + */

ok

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

It is not what we do, but why we do it that matters.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20090210/466b7500/attachment.pgp>