[FFmpeg-devel] [PATCH] avcodec: Pass the HDR10+ metadata to the packet side data in VP9 encoder

Andreas Rheinhardt andreas.rheinhardt at outlook.com
Tue Jun 15 03:17:23 EEST 2021


Mohammad Izadi:
> On Thu, Jun 10, 2021 at 4:05 PM Andreas Rheinhardt <
> andreas.rheinhardt at outlook.com> wrote:
> 
>> Mohammad Izadi:
>>> HDR10+ metadata is stored in the bit stream for HEVC. The story is
>> different for VP9 and cannot store the metadata in the bit stream. HDR10+
>> should be passed to packet side data an stored in the container (mkv) for
>> VP9.
>>>
>>> This CL is taking HDR10+ from AVFrame side data in libvpxenc and is
>> passing it to the AVPacket side data.
>>> ---
>>>  doc/APIchanges         |  2 +
>>>  libavcodec/avpacket.c  |  1 +
>>>  libavcodec/decode.c    |  1 +
>>>  libavcodec/libvpxenc.c | 99 ++++++++++++++++++++++++++++++++++++++++++
>>>  libavcodec/packet.h    |  8 ++++
>>>  libavcodec/version.h   |  4 +-
>>>  6 files changed, 113 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/doc/APIchanges b/doc/APIchanges
>>> index 55171311ed..bba5b06c6a 100644
>>> --- a/doc/APIchanges
>>> +++ b/doc/APIchanges
>>> @@ -13,6 +13,8 @@ libavutil:     2021-04-27
>>>
>>>
>>>  API changes, most recent first:
>>> +2021-05-25 - 8c88a66d3c - lavc 59.2.100 - packet.h
>>> +  Add AV_PKT_DATA_DYNAMIC_HDR10_PLUS
>>>
>>>  2021-xx-xx - xxxxxxxxxx - lavc 59.1.100 - avcodec.h codec.h
>>>    Move av_get_profile_name() from avcodec.h to codec.h.
>>> diff --git a/libavcodec/avpacket.c b/libavcodec/avpacket.c
>>> index 7383d12d3e..800bee3489 100644
>>> --- a/libavcodec/avpacket.c
>>> +++ b/libavcodec/avpacket.c
>>> @@ -289,6 +289,7 @@ const char *av_packet_side_data_name(enum
>> AVPacketSideDataType type)
>>>      case AV_PKT_DATA_ICC_PROFILE:                return "ICC Profile";
>>>      case AV_PKT_DATA_DOVI_CONF:                  return "DOVI
>> configuration record";
>>>      case AV_PKT_DATA_S12M_TIMECODE:              return "SMPTE ST
>> 12-1:2014 timecode";
>>> +    case AV_PKT_DATA_DYNAMIC_HDR10_PLUS:         return "HDR10+ Dynamic
>> Metadata (SMPTE 2094-40)";
>>>      }
>>>      return NULL;
>>>  }
>>> diff --git a/libavcodec/decode.c b/libavcodec/decode.c
>>> index 75bc7ad98e..40f688e40c 100644
>>> --- a/libavcodec/decode.c
>>> +++ b/libavcodec/decode.c
>>> @@ -1488,6 +1488,7 @@ int ff_decode_frame_props(AVCodecContext *avctx,
>> AVFrame *frame)
>>>          { AV_PKT_DATA_A53_CC,                     AV_FRAME_DATA_A53_CC
>> },
>>>          { AV_PKT_DATA_ICC_PROFILE,
>> AV_FRAME_DATA_ICC_PROFILE },
>>>          { AV_PKT_DATA_S12M_TIMECODE,
>> AV_FRAME_DATA_S12M_TIMECODE },
>>> +        { AV_PKT_DATA_DYNAMIC_HDR10_PLUS,
>>  AV_FRAME_DATA_DYNAMIC_HDR_PLUS },
>>>      };
>>>
>>>      if (IS_EMPTY(pkt) && av_fifo_size(avctx->internal->pkt_props) >=
>> sizeof(*pkt))
>>> diff --git a/libavcodec/libvpxenc.c b/libavcodec/libvpxenc.c
>>> index 66bad444d0..e2e6c60b68 100644
>>> --- a/libavcodec/libvpxenc.c
>>> +++ b/libavcodec/libvpxenc.c
>>> @@ -64,6 +64,11 @@ struct FrameListData {
>>>      struct FrameListData *next;
>>>  };
>>>
>>> +typedef struct FrameHDR10Plus {
>>> +    int64_t pts;
>>> +    AVBufferRef *hdr10_plus;
>>> +} FrameHDR10Plus;
>>> +
>>>  typedef struct VPxEncoderContext {
>>>      AVClass *class;
>>>      struct vpx_codec_ctx encoder;
>>> @@ -121,6 +126,8 @@ typedef struct VPxEncoderContext {
>>>      int tune_content;
>>>      int corpus_complexity;
>>>      int tpl_model;
>>> +    int discard_hdr10_plus;
>>> +    AVFifoBuffer *hdr10_plus_fifo;
>>>      /**
>>>       * If the driver does not support ROI then warn the first time we
>>>       * encounter a frame with ROI side data.
>>> @@ -316,6 +323,55 @@ static av_cold void free_frame_list(struct
>> FrameListData *list)
>>>      }
>>>  }
>>>
>>> +static av_cold int add_hdr10_plus(AVFifoBuffer *fifo, struct
>> FrameHDR10Plus *data)
>>> +{
>>> +    int err = av_fifo_grow(fifo, sizeof(*data));
>>> +    if (err < 0)
>>> +        return err;
>>> +    av_fifo_generic_write(fifo, data, sizeof(*data), NULL);
>>> +    return 0;
>>> +}
>>> +
>>> +static av_cold void free_hdr10_plus(struct FrameHDR10Plus *p)
>>> +{
>>> +    if (!p)
>>> +        return;
>>> +    av_buffer_unref(&p->hdr10_plus);
>>> +    av_free(p);
>>> +}
>>> +
>>> +static av_cold void free_hdr10_plus_fifo(AVFifoBuffer **fifo)
>>> +{
>>> +    FrameHDR10Plus *frame_hdr10_plus = NULL;
>>> +    while (av_fifo_size(*fifo) >= sizeof(FrameHDR10Plus)) {
>>> +        av_fifo_generic_read(*fifo, frame_hdr10_plus,
>> sizeof(FrameHDR10Plus), NULL);
>>> +        free_hdr10_plus(frame_hdr10_plus);
>>
>> You apparently overlooked/ignored my email here:
>> https://ffmpeg.org/pipermail/ffmpeg-devel/2021-June/281220.html
> 
> using variable rather pointer now. What tools are you using to detect
> leaks? Can you please direct me to a link or doc to know how to find the
> leak?

See below for the tools; but these leaks have actually been found by
reading the code (for every allocation in your code there should be a
matching free; but there isn't for the AVBufferRef that you allocate).

> I use ffmpeg_g, but does not show any leak.
> 

Of course not; why should debug symbols alone show a leak?

>>
>>
>>> +    }
>>> +    av_fifo_freep(fifo);
>>> +}
>>> +
>>> +static int copy_hdr10_plus_to_pkt(AVFifoBuffer *fifo, AVPacket *pkt)
>>> +{
>>> +    FrameHDR10Plus frame_hdr10_plus;
>>> +    uint8_t *data;
>>> +    if (!pkt)
>>> +        return 0;
>>> +    if (av_fifo_size(fifo) < sizeof(frame_hdr10_plus))
>>> +        return 0;
>>> +
>>> +    av_fifo_generic_read(fifo, &frame_hdr10_plus,
>> sizeof(frame_hdr10_plus), NULL);
>>> +    if (!frame_hdr10_plus.hdr10_plus || frame_hdr10_plus.pts !=
>> pkt->pts)
>>> +        return 0;
>>> +
>>> +    data = av_packet_new_side_data(pkt, AV_PKT_DATA_DYNAMIC_HDR10_PLUS,
>> frame_hdr10_plus.hdr10_plus->size);
>>> +    if (!data)
>>> +        return AVERROR(ENOMEM);
>>> +
>>> +    memcpy(data, frame_hdr10_plus.hdr10_plus->data,
>> frame_hdr10_plus.hdr10_plus->size);
>>
>> Leak (and it's not a leak on error).
>>
> The  data should be handled by av_packet. Not sure what is leaking. Need
> the tool to find the leak.
> 

Use Valgrind or ASAN (the latter is faster, but you need to build ffmpeg
with it; with the former you can just use an ordinary binary (preferably
with debug symbols)).
The AVBufferRef is leaking (and the underlying AVBuffer and the actual
AVDynamicHDRPlus leaks indirectly, too). You could actually avoid this
AVBufferRef completely by already creating the copy of the buffer before
adding the element to the fifo and storing a pointer to the copy of the
buffer in the fifo (use av_packet_add_side_data() instead of
av_packet_new_side_data()).

>>
>>> +
>>> +    return 0;
>>> +}
>>> +
>>>  static av_cold int codecctl_int(AVCodecContext *avctx,
>>>                                  enum vp8e_enc_control_id id, int val)
>>>  {
>>> @@ -384,6 +440,8 @@ static av_cold int vpx_free(AVCodecContext *avctx)
>>>      av_freep(&ctx->twopass_stats.buf);
>>>      av_freep(&avctx->stats_out);
>>>      free_frame_list(ctx->coded_frame_list);
>>> +    if (ctx->hdr10_plus_fifo)
>>> +        free_hdr10_plus_fifo(&ctx->hdr10_plus_fifo);
>>>      return 0;
>>>  }
>>>
>>> @@ -835,6 +893,7 @@ static av_cold int vpx_init(AVCodecContext *avctx,
>>>  #endif
>>>      AVDictionaryEntry* en = NULL;
>>>
>>> +    ctx->discard_hdr10_plus = 1;
>>>      av_log(avctx, AV_LOG_INFO, "%s\n", vpx_codec_version_str());
>>>      av_log(avctx, AV_LOG_VERBOSE, "%s\n", vpx_codec_build_config());
>>>
>>> @@ -851,6 +910,14 @@ static av_cold int vpx_init(AVCodecContext *avctx,
>>>      if (avctx->codec_id == AV_CODEC_ID_VP9) {
>>>          if (set_pix_fmt(avctx, codec_caps, &enccfg, &flags, &img_fmt))
>>>              return AVERROR(EINVAL);
>>> +        // Keep HDR10+ if it has bit depth higher than 8 and
>>> +        // it has PQ trc (SMPTE2084).
>>> +        if (enccfg.g_bit_depth > 8 && avctx->color_trc ==
>> AVCOL_TRC_SMPTE2084) {
>>> +            ctx->discard_hdr10_plus = 0;
>>> +            ctx->hdr10_plus_fifo =
>> av_fifo_alloc(sizeof(FrameHDR10Plus));
>>> +            if (!ctx->hdr10_plus_fifo)
>>> +                return AVERROR(ENOMEM);
>>> +        }
>>>      }
>>>  #endif
>>>
>>> @@ -1211,6 +1278,15 @@ static int storeframe(AVCodecContext *avctx,
>> struct FrameListData *cx_frame,
>>>          AV_WB64(side_data, 1);
>>>          memcpy(side_data + 8, cx_frame->buf_alpha, cx_frame->sz_alpha);
>>>      }
>>> +    if (cx_frame->frame_number != -1) {
>>> +        VPxContext *ctx = avctx->priv_data;
>>> +        if (!ctx->discard_hdr10_plus) {
>>> +            int err = copy_hdr10_plus_to_pkt(ctx->hdr10_plus_fifo, pkt);
>>> +            if (err < 0)
>>> +                return err;
>>> +        }
>>> +    }
>>> +
>>>      return pkt->size;
>>>  }
>>>
>>> @@ -1618,6 +1694,29 @@ static int vpx_encode(AVCodecContext *avctx,
>> AVPacket *pkt,
>>>                  vp9_encode_set_roi(avctx, frame->width, frame->height,
>> sd);
>>>              }
>>>          }
>>> +
>>> +        if (!ctx->discard_hdr10_plus) {
>>> +            AVFrameSideData *hdr10_plus_metadata;
>>> +            // Add HDR10+ metadata to queue.
>>> +            hdr10_plus_metadata = av_frame_get_side_data(frame,
>> AV_FRAME_DATA_DYNAMIC_HDR_PLUS);
>>> +            if (hdr10_plus_metadata) {
>>> +                int err;
>>> +                struct FrameHDR10Plus *data =  av_malloc(sizeof(*data));
>>> +          if (!data)
>>> +                    return AVERROR(ENOMEM);
>>> +                data->pts = frame->pts;
>>> +                data->hdr10_plus =
>> av_buffer_ref(hdr10_plus_metadata->buf);
>>> +                if (!data->hdr10_plus) {
>>> +                    av_freep(&data);
>>> +                    return AVERROR(ENOMEM);
>>> +                }
>>> +                err = add_hdr10_plus(ctx->hdr10_plus_fifo, data);
>>> +                if (err < 0) {
>>> +                    av_freep(&data);
>>
>> Leak
>>
> using var now.
> 
>>
>>> +                    return err;
>>> +                }
>>
>> Leak
>>
> using var now.
> 
>>
> 
>>
>>> +            }
>>> +        }
>>>      }
>>>
>>>      // this is for encoding with preset temporal layering patterns
>> defined in
>>> diff --git a/libavcodec/packet.h b/libavcodec/packet.h
>>> index fad8341c12..a9d3a9b596 100644
>>> --- a/libavcodec/packet.h
>>> +++ b/libavcodec/packet.h
>>> @@ -290,6 +290,14 @@ enum AVPacketSideDataType {
>>>       */
>>>      AV_PKT_DATA_S12M_TIMECODE,
>>>
>>> +    /**
>>> +     * HDR10+ dynamic metadata associated with a video frame. The
>> metadata is in
>>> +     * the form of the AVDynamicHDRPlus struct and contains
>>> +     * information for color volume transform - application 4 of
>>> +     * SMPTE 2094-40:2016 standard.
>>> +     */
>>> +    AV_PKT_DATA_DYNAMIC_HDR10_PLUS,
>>> +
>>>      /**
>>>       * The number of side data types.
>>>       * This is not part of the public API/ABI in the sense that it may
>>> diff --git a/libavcodec/version.h b/libavcodec/version.h
>>> index 5b1e9e77f3..1288cecebe 100644
>>> --- a/libavcodec/version.h
>>> +++ b/libavcodec/version.h
>>> @@ -28,8 +28,8 @@
>>>  #include "libavutil/version.h"
>>>
>>>  #define LIBAVCODEC_VERSION_MAJOR  59
>>> -#define LIBAVCODEC_VERSION_MINOR   1
>>> -#define LIBAVCODEC_VERSION_MICRO 101
>>> +#define LIBAVCODEC_VERSION_MINOR   2
>>> +#define LIBAVCODEC_VERSION_MICRO 100
>>>
>>>  #define LIBAVCODEC_VERSION_INT
>> AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
>>>
>>  LIBAVCODEC_VERSION_MINOR, \
>>>
>>


More information about the ffmpeg-devel mailing list