[FFmpeg-devel] [rfc] Applehttp proto documentation Was: [FFmpeg-commits] Add Apple HTTP Live Streaming protocol handler

[Stefano Sabatini]

On date Tuesday 2011-03-08 02:03:28 +0100, Luca Barbato encoded:
> On 03/07/2011 02:58 AM, Luca Barbato wrote:
> > On 03/07/2011 12:02 AM, Stefano Sabatini wrote:
> >> Please add some docs in protocols.texi, so that people know how to use
> >> it.
> > 
> > Something like that would be enough?
> 
> Yet another update, I'm not that happy about it yet.
> 
> lu
> 
> -- 
> 
> Luca Barbato
> Gentoo/linux
> http://dev.gentoo.org/~lu_zero
> 

> diff --git a/doc/protocols.texi b/doc/protocols.texi
> index 29f5c90..9657f5c 100644
> --- a/doc/protocols.texi
> +++ b/doc/protocols.texi
> @@ -19,6 +19,22 @@ supported protocols.
>  
>  A description of the currently available protocols follows.
>  
> + at section applehttp
> +
> +Read Apple HTTP Live Streaming compliant segmented stream as
> +a uniform one. The m3u8 playlists describing the segments can be

Nit: M3U8

> +remote, accessed as HTTP resources, or local files, accessed using
> +the standard file protocol.

... can be remote HTTP resources, or local files accessed using the
standard file protocol.

(so they don't sound like different items in the list)

> +HTTP is the defaut, specific protocol can be declared using the "+"

default

> +specifier.

specific protocol can be declared by specifying "+ at var{proto}" after
the applehttp URI scheme name, where @var{proto} is either "file" or
"http".

Follow some example of valid applehttp URIs:

> + at example
> +applehttp://host/path/to/remote/resource.m3u8
> +applehttp+http://host/path/to/remote/resource.m3u8
> +applehttp+file://path/to/local/resource.m3u8
> + at end example

> +
> +

Nit++: one empty line is enough.

I'll fail to note how senseless is the design of a scheme which looks
like applehttp+file.
-- 
FFmpeg = Frenzy Furious Mortal Programmable Elected Guide