diff mbox series

[FFmpeg-devel] avformat/avformat: Remove redundant "NOT PART OF PUBLIC API"

Message ID 20200318143103.22384-1-andreas.rheinhardt@gmail.com
State Accepted
Commit 9dd8f7312a7702240c8a7f8d0f6515a3cfc80f19
Headers show
Series [FFmpeg-devel] avformat/avformat: Remove redundant "NOT PART OF PUBLIC API"
Related show

Commit Message

Andreas Rheinhardt March 18, 2020, 2:31 p.m. UTC
AVStream.request_probe as well as AVStream.mux_ts_offset are below the
separator of public and private fields, so that a further "NOT PART OF
PUBLIC API" is redundant.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
---
I initially also wanted to remove the internal note for AVStream's private
fields ("be aware that physically removing these fields will break
ABI"), but then I became aware that ffmpeg.c uses several of them
(pts_wrap_bits, first_dts, cur_dts, codec_info_nb_frames). If I am not
mistaken, this means that one can't even add new public fields in front
of the public/private boundary in AVStream at all.

 libavformat/avformat.h | 2 --
 1 file changed, 2 deletions(-)

Comments

Derek Buitenhuis March 19, 2020, 3:36 p.m. UTC | #1
On 18/03/2020 14:31, Andreas Rheinhardt wrote:
> I initially also wanted to remove the internal note for AVStream's private
> fields ("be aware that physically removing these fields will break
> ABI"), but then I became aware that ffmpeg.c uses several of them
> (pts_wrap_bits, first_dts, cur_dts, codec_info_nb_frames). If I am not
> mistaken, this means that one can't even add new public fields in front
> of the public/private boundary in AVStream at all.

ffmpeg.c should be made to play by the APIs own rules.

- Derek
Andreas Rheinhardt May 21, 2020, 8:09 p.m. UTC | #2
Andreas Rheinhardt:
> AVStream.request_probe as well as AVStream.mux_ts_offset are below the
> separator of public and private fields, so that a further "NOT PART OF
> PUBLIC API" is redundant.
> 
> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
> ---
> I initially also wanted to remove the internal note for AVStream's private
> fields ("be aware that physically removing these fields will break
> ABI"), but then I became aware that ffmpeg.c uses several of them
> (pts_wrap_bits, first_dts, cur_dts, codec_info_nb_frames). If I am not
> mistaken, this means that one can't even add new public fields in front
> of the public/private boundary in AVStream at all.
> 
>  libavformat/avformat.h | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> index 9b9b634ec3..f9291a26ec 100644
> --- a/libavformat/avformat.h
> +++ b/libavformat/avformat.h
> @@ -1124,7 +1124,6 @@ typedef struct AVStream {
>       * -1   -> probing finished
>       *  0   -> no probing requested
>       * rest -> perform probing with request_probe being the minimum score to accept.
> -     * NOT PART OF PUBLIC API
>       */
>      int request_probe;
>      /**
> @@ -1170,7 +1169,6 @@ typedef struct AVStream {
>  
>      /**
>       * Timestamp offset added to timestamps before muxing
> -     * NOT PART OF PUBLIC API
>       */
>      int64_t mux_ts_offset;
>  
Will apply this tomorrow unless there are objections.

- Andreas
Andreas Rheinhardt May 23, 2020, 5:50 a.m. UTC | #3
Andreas Rheinhardt:
> Andreas Rheinhardt:
>> AVStream.request_probe as well as AVStream.mux_ts_offset are below the
>> separator of public and private fields, so that a further "NOT PART OF
>> PUBLIC API" is redundant.
>>
>> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
>> ---
>> I initially also wanted to remove the internal note for AVStream's private
>> fields ("be aware that physically removing these fields will break
>> ABI"), but then I became aware that ffmpeg.c uses several of them
>> (pts_wrap_bits, first_dts, cur_dts, codec_info_nb_frames). If I am not
>> mistaken, this means that one can't even add new public fields in front
>> of the public/private boundary in AVStream at all.
>>
>>  libavformat/avformat.h | 2 --
>>  1 file changed, 2 deletions(-)
>>
>> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
>> index 9b9b634ec3..f9291a26ec 100644
>> --- a/libavformat/avformat.h
>> +++ b/libavformat/avformat.h
>> @@ -1124,7 +1124,6 @@ typedef struct AVStream {
>>       * -1   -> probing finished
>>       *  0   -> no probing requested
>>       * rest -> perform probing with request_probe being the minimum score to accept.
>> -     * NOT PART OF PUBLIC API
>>       */
>>      int request_probe;
>>      /**
>> @@ -1170,7 +1169,6 @@ typedef struct AVStream {
>>  
>>      /**
>>       * Timestamp offset added to timestamps before muxing
>> -     * NOT PART OF PUBLIC API
>>       */
>>      int64_t mux_ts_offset;
>>  
> Will apply this tomorrow unless there are objections.
> 
> - Andreas
> 
Applied.

- Andreas
diff mbox series

Patch

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 9b9b634ec3..f9291a26ec 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -1124,7 +1124,6 @@  typedef struct AVStream {
      * -1   -> probing finished
      *  0   -> no probing requested
      * rest -> perform probing with request_probe being the minimum score to accept.
-     * NOT PART OF PUBLIC API
      */
     int request_probe;
     /**
@@ -1170,7 +1169,6 @@  typedef struct AVStream {
 
     /**
      * Timestamp offset added to timestamps before muxing
-     * NOT PART OF PUBLIC API
      */
     int64_t mux_ts_offset;