[FFmpeg-devel] [PATCH] doc: document aresample:first_pts

[Michael Niedermayer]

On Mon, Jan 21, 2013 at 07:40:38PM +0100, Stefano Sabatini wrote:
> On date Monday 2013-01-21 16:47:34 +0100, Michael Niedermayer encoded:
> > Documentation copied from asyncts, the options are supposed to do
> > the same thing. If not please submit a testcase where they differ
> > so we can fix it.
> > 
> > Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
> > ---
> >  doc/ffmpeg-resampler.texi |    8 ++++++++
> >  1 file changed, 8 insertions(+)
> > 
> > diff --git a/doc/ffmpeg-resampler.texi b/doc/ffmpeg-resampler.texi
> > index d45126f..cd3c02e 100644
> > --- a/doc/ffmpeg-resampler.texi
> > +++ b/doc/ffmpeg-resampler.texi
> > @@ -168,6 +168,14 @@ may be stretched or squeezed for each second.
> >  Default value is 0, thus no compensation is applied to make the samples match
> >  the audio timestamps.
> >  
> > + at item first_pts
> > +For swr only, Assume the first pts should be this value.
> 
> Assume -> assume
> 
> And this documentation doesn't really explain what the option really
> does ("it assumes something" is not a very useful explanation about

the text is from libav
the puprose of this option is to implement what first_pts of asyncts
does.
If asyncts had a clear documentation i could copy it but as it has
just this text i can only copy that text.
To clarify an ambigous text i first need to know how it should be
interpreted. I dont know that, i asked yesterday for a testcase on IRC
i had no luck people where too busy.
I could document the implementation we have but if it turns out
to differ fron asyncts than the docs and implementation would be wrong
as its intended to be compatible.

Thus i suggest we apply this patch with typo fixes and otherwise
dont mess with it

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

it is not once nor twice but times without number that the same ideas make
their appearance in the world. -- Aristotle
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130121/92bbd4da/attachment.asc>