[FFmpeg-devel,08/13] avformat/avformat.h: Correct some comments

Submitted by Andreas Rheinhardt on Aug. 13, 2019, 2:47 a.m.

Details

Message ID 20190813024726.6596-8-andreas.rheinhardt@gmail.com
State New
Headers show

Commit Message

Andreas Rheinhardt Aug. 13, 2019, 2:47 a.m.
1. When set_parameters was removed from AVOutputFormat in 2fb75019, it
was forgotten to remove the comment pertaining to it. Said comment now
appeared to apply to interleave_packet; it is of course nonsense and has
been replaced by an accurate description.
2. The description of av_write_uncoded_frame suggested
av_interleaved_write_frame as a replacement if the input is not
already correctly interleaved; it also referred to said function for
details. Given that said function can't write AVFrames and that the
stuff specific to writing uncoded frames is explained in the description
of av_interleaved_write_uncoded_frame, both references have been fixed.
3. Removed an outdated comment about avformat_seek_file.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
---
 libavformat/avformat.h | 9 ++++-----
 libavformat/version.h  | 2 +-
 2 files changed, 5 insertions(+), 6 deletions(-)

Comments

Carl Eugen Hoyos Aug. 13, 2019, 10:03 a.m.
Am Di., 13. Aug. 2019 um 04:49 Uhr schrieb Andreas Rheinhardt
<andreas.rheinhardt@gmail.com>:
>
> 1. When set_parameters was removed from AVOutputFormat in 2fb75019, it
> was forgotten to remove the comment pertaining to it. Said comment now
> appeared to apply to interleave_packet; it is of course nonsense and has
> been replaced by an accurate description.
> 2. The description of av_write_uncoded_frame suggested
> av_interleaved_write_frame as a replacement if the input is not
> already correctly interleaved; it also referred to said function for
> details. Given that said function can't write AVFrames and that the
> stuff specific to writing uncoded frames is explained in the description
> of av_interleaved_write_uncoded_frame, both references have been fixed.
> 3. Removed an outdated comment about avformat_seek_file.
>
> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
> ---
>  libavformat/avformat.h | 9 ++++-----
>  libavformat/version.h  | 2 +-
>  2 files changed, 5 insertions(+), 6 deletions(-)
>
> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> index 6eb329f13f..92c3a89f4b 100644
> --- a/libavformat/avformat.h
> +++ b/libavformat/avformat.h
> @@ -556,7 +556,8 @@ typedef struct AVOutputFormat {
>      int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
>      int (*write_trailer)(struct AVFormatContext *);
>      /**
> -     * Currently only used to set pixel format if not YUV420P.
> +     * A format-specific function for interleavement.
> +     * If unset, packets will be interleaved by dts.
>       */
>      int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
>                               AVPacket *in, int flush);
> @@ -2449,8 +2450,6 @@ int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
>   * @return >=0 on success, error code otherwise
>   *
>   * @note This is part of the new seek API which is still under construction.
> - *       Thus do not use this yet. It may change at any time, do not expect
> - *       ABI compatibility yet!
>   */
>  int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
>
> @@ -2637,9 +2636,9 @@ int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
>   * Write an uncoded frame to an output media file.
>   *
>   * The frame must be correctly interleaved according to the container
> - * specification; if not, then av_interleaved_write_frame() must be used.
> + * specification; if not, av_interleaved_write_uncoded_frame() must be used.
>   *
> - * See av_interleaved_write_frame() for details.
> + * See av_interleaved_write_uncoded_frame() for details.
>   */
>  int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
>                             AVFrame *frame);
> diff --git a/libavformat/version.h b/libavformat/version.h
> index 45efaff9b9..feceaedc08 100644
> --- a/libavformat/version.h
> +++ b/libavformat/version.h
> @@ -32,7 +32,7 @@
>  // Major bumping may affect Ticket5467, 5421, 5451(compatibility with Chromium)
>  // Also please add any ticket numbers that you believe might be affected here
>  #define LIBAVFORMAT_VERSION_MAJOR  58

> -#define LIBAVFORMAT_VERSION_MINOR  30
> +#define LIBAVFORMAT_VERSION_MINOR  31

Seems unneeded to me.

Carl Eugen
Paul B Mahol Aug. 14, 2019, 4:23 p.m.
On Tue, Aug 13, 2019 at 12:03 PM Carl Eugen Hoyos <ceffmpeg@gmail.com>
wrote:

> Am Di., 13. Aug. 2019 um 04:49 Uhr schrieb Andreas Rheinhardt
> <andreas.rheinhardt@gmail.com>:
> >
> > 1. When set_parameters was removed from AVOutputFormat in 2fb75019, it
> > was forgotten to remove the comment pertaining to it. Said comment now
> > appeared to apply to interleave_packet; it is of course nonsense and has
> > been replaced by an accurate description.
> > 2. The description of av_write_uncoded_frame suggested
> > av_interleaved_write_frame as a replacement if the input is not
> > already correctly interleaved; it also referred to said function for
> > details. Given that said function can't write AVFrames and that the
> > stuff specific to writing uncoded frames is explained in the description
> > of av_interleaved_write_uncoded_frame, both references have been fixed.
> > 3. Removed an outdated comment about avformat_seek_file.
> >
> > Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
> > ---
> >  libavformat/avformat.h | 9 ++++-----
> >  libavformat/version.h  | 2 +-
> >  2 files changed, 5 insertions(+), 6 deletions(-)
> >
> > diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> > index 6eb329f13f..92c3a89f4b 100644
> > --- a/libavformat/avformat.h
> > +++ b/libavformat/avformat.h
> > @@ -556,7 +556,8 @@ typedef struct AVOutputFormat {
> >      int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
> >      int (*write_trailer)(struct AVFormatContext *);
> >      /**
> > -     * Currently only used to set pixel format if not YUV420P.
> > +     * A format-specific function for interleavement.
> > +     * If unset, packets will be interleaved by dts.
> >       */
> >      int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
> >                               AVPacket *in, int flush);
> > @@ -2449,8 +2450,6 @@ int av_seek_frame(AVFormatContext *s, int
> stream_index, int64_t timestamp,
> >   * @return >=0 on success, error code otherwise
> >   *
> >   * @note This is part of the new seek API which is still under
> construction.
> > - *       Thus do not use this yet. It may change at any time, do not
> expect
> > - *       ABI compatibility yet!
> >   */
> >  int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t
> min_ts, int64_t ts, int64_t max_ts, int flags);
> >
> > @@ -2637,9 +2636,9 @@ int av_interleaved_write_frame(AVFormatContext *s,
> AVPacket *pkt);
> >   * Write an uncoded frame to an output media file.
> >   *
> >   * The frame must be correctly interleaved according to the container
> > - * specification; if not, then av_interleaved_write_frame() must be
> used.
> > + * specification; if not, av_interleaved_write_uncoded_frame() must be
> used.
> >   *
> > - * See av_interleaved_write_frame() for details.
> > + * See av_interleaved_write_uncoded_frame() for details.
> >   */
> >  int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
> >                             AVFrame *frame);
> > diff --git a/libavformat/version.h b/libavformat/version.h
> > index 45efaff9b9..feceaedc08 100644
> > --- a/libavformat/version.h
> > +++ b/libavformat/version.h
> > @@ -32,7 +32,7 @@
> >  // Major bumping may affect Ticket5467, 5421, 5451(compatibility with
> Chromium)
> >  // Also please add any ticket numbers that you believe might be
> affected here
> >  #define LIBAVFORMAT_VERSION_MAJOR  58
>
> > -#define LIBAVFORMAT_VERSION_MINOR  30
> > +#define LIBAVFORMAT_VERSION_MINOR  31
>
> Seems unneeded to me.
>

Yes, minor is too much, at most micro, but even that is unneeded.


>
> Carl Eugen
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Patch hide | download patch | download mbox

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 6eb329f13f..92c3a89f4b 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -556,7 +556,8 @@  typedef struct AVOutputFormat {
     int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
     int (*write_trailer)(struct AVFormatContext *);
     /**
-     * Currently only used to set pixel format if not YUV420P.
+     * A format-specific function for interleavement.
+     * If unset, packets will be interleaved by dts.
      */
     int (*interleave_packet)(struct AVFormatContext *, AVPacket *out,
                              AVPacket *in, int flush);
@@ -2449,8 +2450,6 @@  int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp,
  * @return >=0 on success, error code otherwise
  *
  * @note This is part of the new seek API which is still under construction.
- *       Thus do not use this yet. It may change at any time, do not expect
- *       ABI compatibility yet!
  */
 int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
 
@@ -2637,9 +2636,9 @@  int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
  * Write an uncoded frame to an output media file.
  *
  * The frame must be correctly interleaved according to the container
- * specification; if not, then av_interleaved_write_frame() must be used.
+ * specification; if not, av_interleaved_write_uncoded_frame() must be used.
  *
- * See av_interleaved_write_frame() for details.
+ * See av_interleaved_write_uncoded_frame() for details.
  */
 int av_write_uncoded_frame(AVFormatContext *s, int stream_index,
                            AVFrame *frame);
diff --git a/libavformat/version.h b/libavformat/version.h
index 45efaff9b9..feceaedc08 100644
--- a/libavformat/version.h
+++ b/libavformat/version.h
@@ -32,7 +32,7 @@ 
 // Major bumping may affect Ticket5467, 5421, 5451(compatibility with Chromium)
 // Also please add any ticket numbers that you believe might be affected here
 #define LIBAVFORMAT_VERSION_MAJOR  58
-#define LIBAVFORMAT_VERSION_MINOR  30
+#define LIBAVFORMAT_VERSION_MINOR  31
 #define LIBAVFORMAT_VERSION_MICRO 100
 
 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \