[FFmpeg-devel] [PATCH] Document sws_scale()

[Stefano Sabatini]

On date Tuesday 2009-02-17 00:49:12 +0100, Michael Niedermayer encoded:
> On Mon, Feb 16, 2009 at 11:12:34PM +0100, Stefano Sabatini wrote:
> > Hi all,
> > as in subject.
> > 
> > Regards.
> > -- 
> > FFmpeg = Fantastic Fierce Magic Puritan Exxagerate Gargoyle
> 
> > Index: libswscale/swscale.h
> > ===================================================================
> > --- libswscale/swscale.h	(revision 28617)
> > +++ libswscale/swscale.h	(working copy)
> > @@ -129,6 +129,32 @@
> >   */
> >  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);
> > +
> > +/**
> > + * Scales the image slice in \p src and puts the resulting scaled
> > + * slice in the image in \p dst. A slice is a sequence of consecutive
> > + * rows in an image.
> > + *
> > + * @param context the scaling context previously created with
> > + *                sws_getContext()
> 
> > + * @param src     the pointer to the array of pointers to the planes
> > + *                of the source slice (just one pointer in case of
> > + *                packed image formats)
> > + * @param srcStride the pointer to the array containing the strides or
> > + *                linesizes of the source image for each plane (just
> > + *                one linesize in case of packed image formats).
> 
> remove "(just one linesize in case of packed image formats)."
> it serves no purpose
> 
> 
> > + * @param srcSliceY the position of the source slice to process, that
> > + *                is the number of the first row of the slice
> > + * @param srcSliceH the height of the slice, that is the number of rows
> > + *                of the slice
> 
> > + * @param dst     the pointer to the array containing the pointers to
> > + *                the planes of the destination image (just one
> > + *                pointer in case of packed image formats).
> > + * @param dstStride the pointer to the array containing the strides or
> > + *                linesizes of the destination image for each plane
> > + *                (just one linesize in case of packed image formats)
> 
> same

Fixed.

I also suggest to rename the "src" var to "srcSlice" to make more
apparent that it references a slice rather than an image.

Regards.
-- 
FFmpeg = Fast & Fantastic Multipurpose Philosophical Elitarian Gospel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: document-sws-scale.patch
Type: text/x-diff
Size: 1839 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20090217/3826c636/attachment.patch>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: move-src-src-slice.patch
Type: text/x-diff
Size: 1116 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20090217/3826c636/attachment-0001.patch>