[FFmpeg-devel] [PATCH] doxy: Clarify what avpriv_set_pts_info does

Stefano Sabatini stefasab at gmail.com
Sun Dec 16 22:41:08 CET 2012


On date Sunday 2012-12-16 16:13:42 -0500, Derek Buitenhuis encoded:
> On 16/12/2012 4:03 PM, Stefano Sabatini wrote:
> >> + * Set the time base for a given stream. If the new time base is invalid
> > 
> > This is a bit incomplete, since as the name suggests the function
> > "sets information to interpret timestamp information correctly", for
> > example it also sets the number of bits.
> > 
> > So I believe something like:
> > 
> > Set the information to interpret timestamps in the stream. In
> > particular, set the time base for the given stream.
> > 
> > which sounds a bit awkward and maybe can be improved.
> 
> "Set the time base a wrap info for the given stream. This will be

*and* wrap info.

>  used to interpret the stream's timestamps."
> 
> Maybe something like this?

Yes.
 
> >> + * (numerator or denominator are, or are less than zero), it leaves the stream
> > 
> > "are, or are" sounds weird/wrong
> 
> Perfectly valid in English, though there should be a comma after 'than'.
> 
> > "are non-positive" could be a more compact alternative to "are equal
> > or less than zero".
> 
> Non-positive sounds fine to me.
> 
> > 
> >> + * unchanged.
> >>   *
> >>   * @param s stream
> >>   * @param pts_wrap_bits number of bits effectively used by the pts
> >>   *        (used for wrap control, 33 is the value for MPEG)
> >> - * @param pts_num numerator to convert to seconds (MPEG: 1)
> >> - * @param pts_den denominator to convert to seconds (MPEG: 90000)
> > 
> >> + * @param pts_num time base numerator (MPEG: 1)
> >> + * @param pts_den time base denominator (MPEG: 90000)
> > 
> > while at it:
> > @param pts_num time base numerator (e.g. it is 1 for MPEG)
> 

> I was thinking of just dropping that entirely. It doesn't seem so useful,
> in a general context.

No objection to that.
-- 
FFmpeg = Faithful and Fundamentalist Marvellous Portentous Elaborated Goblin


More information about the ffmpeg-devel mailing list