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

[Stefano Sabatini]

On date Wednesday 2010-10-06 20:47:13 +0200, Stefano Sabatini encoded:
> On date Thursday 2010-09-30 13:12:12 +0200, Michael Niedermayer encoded:
> > On Thu, Sep 30, 2010 at 11:25:13AM +0200, Stefano Sabatini wrote:
> > > On date Saturday 2010-03-27 22:19:56 +0100, Stefano Sabatini encoded:
> > > > On date Sunday 2010-01-24 15:55:44 +0100, Stefano Sabatini encoded:
> > > > > As in subject, docs partially stolen from the GNU libc write() docs.
> > > > > 
> > > > > Regards.
> > > > > -- 
> > > > > FFmpeg = Fantastic and Fiendish Minimal Prodigious Excellent Gargoyle
> > > > 
> > > > > Index: ffmpeg/libavformat/avio.h
> > > > > ===================================================================
> > > > > --- ffmpeg.orig/libavformat/avio.h	2010-01-24 15:33:42.000000000 +0100
> > > > > +++ ffmpeg/libavformat/avio.h	2010-01-24 15:53:28.000000000 +0100
> > > > > @@ -112,7 +112,20 @@
> > > > >   * certain there was either an error or the end of file was reached.
> > > > >   */
> > > > >  int url_read_complete(URLContext *h, unsigned char *buf, int size);
> > > > > +
> > > > > +/**
> > > > > + * Writes up to size bytes from buf to the resource accessed by h.
> > > > > + * The data in buf is not necessarily a character string and a NULL
> > > > > + * character is output like any other character.
> > > > > + *
> > > > > + * @return The number of bytes actually written, or a negative value
> > > > > + * corresponding to an AVERROR code in case of failure. In case of
> > > > > + * success the returned value may be size, but can always be
> > > > > + * smaller. Your program may need to call url_write() in a loop,
> > > > > + * iterating until all the data is written.
> > > > > + */
> > > > >  int url_write(URLContext *h, unsigned char *buf, int size);
> > > > > +
> > > > >  int64_t url_seek(URLContext *h, int64_t pos, int whence);
> > > > >  int url_close(URLContext *h);
> > > > 
> > > > Ping.
> > > 
> > > Updated.
> > > -- 
> > > FFmpeg = Fundamentalist and Fabulous Multimedia Programmable Everlasting God
> > 
> > >  avio.h |   14 +++++++++++++-
> > >  1 file changed, 13 insertions(+), 1 deletion(-)
> > > 2f686c55f9116d5c4a9c693622b31b1b2bf7f0e4  0002-Document-url_write.patch
> > > From c86fb9a05d173efa1e6897c192b36483f49035ea Mon Sep 17 00:00:00 2001
> > > From: Stefano Sabatini <stefano.sabatini-lala at poste.it>
> > > Date: Sun, 28 Feb 2010 00:19:23 +0100
> > > Subject: [PATCH 2/4] Document url_write().
> > > 
> > > ---
> > >  libavformat/avio.h |   14 +++++++++++++-
> > >  1 files changed, 13 insertions(+), 1 deletions(-)
> > > 
> > > diff --git a/libavformat/avio.h b/libavformat/avio.h
> > > index 69368de..1cc7fa0 100644
> > > --- a/libavformat/avio.h
> > > +++ b/libavformat/avio.h
> > > @@ -132,7 +132,19 @@ int url_read(URLContext *h, unsigned char *buf, int size);
> > >   * certain there was either an error or the end of file was reached.
> > >   */
> > >  int url_read_complete(URLContext *h, unsigned char *buf, int size);
> > > -int url_write(URLContext *h, const unsigned char *buf, int size);
> > > +
> > > +/**
> > > + * Write up to size bytes from buf to the resource accessed by h.
> > > + * The data in buf is not necessarily a character string and a NULL
> > > + * character is output like any other character.
> > 
> > this is confusing there is no need to explixitly mention null terminated
> > strings
> 
> Updated.
> -- 
> FFmpeg = Forgiving & Fabulous Mortal Proud Ecumenical Gadget

> From b3c5b9dcef8cf81946b5d03dafc87c80a7834804 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefano.sabatini-lala at poste.it>
> Date: Wed, 6 Oct 2010 20:45:25 +0200
> Subject: [PATCH] Document url_write().
> 
> ---
>  libavformat/avio.h |    7 +++++++
>  1 files changed, 7 insertions(+), 0 deletions(-)
> 
> diff --git a/libavformat/avio.h b/libavformat/avio.h
> index 118b7f2..b680913 100644
> --- a/libavformat/avio.h
> +++ b/libavformat/avio.h
> @@ -132,6 +132,13 @@ int url_read(URLContext *h, unsigned char *buf, int size);
>   * certain there was either an error or the end of file was reached.
>   */
>  int url_read_complete(URLContext *h, unsigned char *buf, int size);
> +
> +/**
> + * Write size bytes from buf to the resource accessed by h.
> + *
> + * @return the number of bytes actually written, or a negative value
> + * corresponding to an AVERROR code in case of failure
> + */
>  int url_write(URLContext *h, const unsigned char *buf, int size);

I'll apply this tomorrow.
-- 
FFmpeg = Fostering and Fast Most Practical Energized Glue