[MPlayer-dev-eng] Lots of stuff for NUT

[Diego Biurrun]

On Sat, Dec 31, 2005 at 04:27:59PM +0200, Oded Shimon wrote:
> 
> Documenters - spelling fixes? grammar fixes? better suggestions for 
> explanations?

Here we go...

> +    real_back_ptr must point to a position so a syncpoint startcode begins
> +    within the next 8 bytes, and such that this syncpoint is the closest
> +    syncpoint so one keyframe for this stream lies between that syncpoint
> +    and the current syncpoint.

As a rule of thumb, try using shorter sentences.  If your sentence spans
more than 3 lines, cut it at least in half.

Here's my not-yet-perfect suggestion, I hope I haven't munged the
intended meaning.

  real_back_ptr must point to a position within 8 bytes of a syncpoint startcode.
  This syncpoint should/must be the closest syncpoint so one stream keyframe lies
  between it and the current syncpoint.

> +    Note back_ptr can be zero, when the frame immdiately following is a

Note that, immEdiately

> +    syncpoints MUST be placed immediately before a keyframe if more
> +    than max_distance passed since previous keyframe of the same stream,
> +    unless the timestamp to be set for this syncpoint is identical to the
> +    last syncpoints's timestamp. In which case, the syncpoint is to be put
> +    immediately BEFORE the timestamp will change. (So it will still have
> +    the same timestamp)

since the previous keyframe, syncpoint's

You can never start a sentence with "in which case" IMO.

See above about sentence length.

> @@ -422,17 +458,26 @@
> +      2  end_of_relavence if set, stream has no relavence on
> +                          presentation until next frame. (EOR)

relEvance

> +    When EOR is set, all back_ptr's for this stream are set to zero.

back_ptrs

> +    A demuxer can detect stream corruption if mts is out order. To detect

out of order

> +    global_timestamp of the syncpoint reffered to in this index entry.

referred

> +    reffered to in this index entry. Relative to position of last

dito

Diego