git.sesse.net Git - ffmpeg/blob - libavcodec/av1_metadata_bsf.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #include "libavutil/common.h"
  20 #include "libavutil/opt.h"
  21
  22 #include "bsf.h"
  23 #include "cbs.h"
  24 #include "cbs_av1.h"
  25
  26 enum {
  27     PASS,
  28     INSERT,
  29     REMOVE,
  30 };
  31
  32 typedef struct AV1MetadataContext {
  33     const AVClass *class;
  34
  35     CodedBitstreamContext *cbc;
  36     CodedBitstreamFragment access_unit;
  37
  38     int td;
  39
  40     int color_primaries;
  41     int transfer_characteristics;
  42     int matrix_coefficients;
  43
  44     int color_range;
  45     int chroma_sample_position;
  46
  47     AVRational tick_rate;
  48     int num_ticks_per_picture;
  49
  50     int delete_padding;
  51 } AV1MetadataContext;
  52
  53
  54 static int av1_metadata_update_sequence_header(AVBSFContext *bsf,
  55                                                AV1RawSequenceHeader *seq)
  56 {
  57     AV1MetadataContext *ctx = bsf->priv_data;
  58     AV1RawColorConfig  *clc = &seq->color_config;
  59     AV1RawTimingInfo   *tim = &seq->timing_info;
  60
  61     if (ctx->color_primaries >= 0          ||
  62         ctx->transfer_characteristics >= 0 ||
  63         ctx->matrix_coefficients >= 0) {
  64         if (!clc->color_description_present_flag) {
  65             clc->color_description_present_flag = 1;
  66             clc->color_primaries          = AVCOL_PRI_UNSPECIFIED;
  67             clc->transfer_characteristics = AVCOL_TRC_UNSPECIFIED;
  68             clc->matrix_coefficients      = AVCOL_SPC_UNSPECIFIED;
  69         }
  70
  71         if (ctx->color_primaries >= 0)
  72             clc->color_primaries = ctx->color_primaries;
  73         if (ctx->transfer_characteristics >= 0)
  74             clc->transfer_characteristics = ctx->transfer_characteristics;
  75         if (ctx->matrix_coefficients >= 0)
  76             clc->matrix_coefficients = ctx->matrix_coefficients;
  77     }
  78
  79     if (ctx->color_range >= 0) {
  80         if (clc->color_primaries          == AVCOL_PRI_BT709        &&
  81             clc->transfer_characteristics == AVCOL_TRC_IEC61966_2_1 &&
  82             clc->matrix_coefficients      == AVCOL_SPC_RGB) {
  83             av_log(bsf, AV_LOG_WARNING, "Warning: color_range cannot be set "
  84                    "on RGB streams encoded in BT.709 sRGB.\n");
  85         } else {
  86             clc->color_range = ctx->color_range;
  87         }
  88     }
  89
  90     if (ctx->chroma_sample_position >= 0) {
  91         if (clc->mono_chrome || !clc->subsampling_x || !clc->subsampling_y) {
  92             av_log(bsf, AV_LOG_WARNING, "Warning: chroma_sample_position "
  93                    "can only be set for 4:2:0 streams.\n");
  94         } else {
  95             clc->chroma_sample_position = ctx->chroma_sample_position;
  96         }
  97     }
  98
  99     if (ctx->tick_rate.num && ctx->tick_rate.den) {
 100         int num, den;
 101
 102         av_reduce(&num, &den, ctx->tick_rate.num, ctx->tick_rate.den,
 103                   UINT32_MAX > INT_MAX ? UINT32_MAX : INT_MAX);
 104
 105         tim->time_scale                = num;
 106         tim->num_units_in_display_tick = den;
 107         seq->timing_info_present_flag  = 1;
 108
 109         if (ctx->num_ticks_per_picture > 0) {
 110             tim->equal_picture_interval = 1;
 111             tim->num_ticks_per_picture_minus_1 =
 112                 ctx->num_ticks_per_picture - 1;
 113         }
 114     }
 115
 116     return 0;
 117 }
 118
 119 static int av1_metadata_filter(AVBSFContext *bsf, AVPacket *pkt)
 120 {
 121     AV1MetadataContext *ctx = bsf->priv_data;
 122     CodedBitstreamFragment *frag = &ctx->access_unit;
 123     AV1RawOBU td, *obu;
 124     int err, i;
 125
 126     err = ff_bsf_get_packet_ref(bsf, pkt);
 127     if (err < 0)
 128         return err;
 129
 130     err = ff_cbs_read_packet(ctx->cbc, frag, pkt);
 131     if (err < 0) {
 132         av_log(bsf, AV_LOG_ERROR, "Failed to read packet.\n");
 133         goto fail;
 134     }
 135
 136     if (frag->nb_units == 0) {
 137         av_log(bsf, AV_LOG_ERROR, "No OBU in packet.\n");
 138         err = AVERROR_INVALIDDATA;
 139         goto fail;
 140     }
 141
 142     for (i = 0; i < frag->nb_units; i++) {
 143         if (frag->units[i].type == AV1_OBU_SEQUENCE_HEADER) {
 144             obu = frag->units[i].content;
 145             err = av1_metadata_update_sequence_header(bsf, &obu->obu.sequence_header);
 146             if (err < 0)
 147                 goto fail;
 148         }
 149     }
 150
 151     // If a Temporal Delimiter is present, it must be the first OBU.
 152     if (frag->units[0].type == AV1_OBU_TEMPORAL_DELIMITER) {
 153         if (ctx->td == REMOVE)
 154             ff_cbs_delete_unit(ctx->cbc, frag, 0);
 155     } else if (ctx->td == INSERT) {
 156         td = (AV1RawOBU) {
 157             .header.obu_type = AV1_OBU_TEMPORAL_DELIMITER,
 158         };
 159
 160         err = ff_cbs_insert_unit_content(ctx->cbc, frag, 0, AV1_OBU_TEMPORAL_DELIMITER,
 161                                          &td, NULL);
 162         if (err < 0) {
 163             av_log(bsf, AV_LOG_ERROR, "Failed to insert Temporal Delimiter.\n");
 164             goto fail;
 165         }
 166     }
 167
 168     if (ctx->delete_padding) {
 169         for (i = frag->nb_units - 1; i >= 0; i--) {
 170             if (frag->units[i].type == AV1_OBU_PADDING) {
 171                 err = ff_cbs_delete_unit(ctx->cbc, frag, i);
 172                 if (err < 0) {
 173                     av_log(bsf, AV_LOG_ERROR, "Failed to delete Padding OBU.\n");
 174                     goto fail;
 175                 }
 176             }
 177         }
 178     }
 179
 180     err = ff_cbs_write_packet(ctx->cbc, pkt, frag);
 181     if (err < 0) {
 182         av_log(bsf, AV_LOG_ERROR, "Failed to write packet.\n");
 183         goto fail;
 184     }
 185
 186     err = 0;
 187 fail:
 188     ff_cbs_fragment_reset(ctx->cbc, frag);
 189
 190     if (err < 0)
 191         av_packet_unref(pkt);
 192
 193     return err;
 194 }
 195
 196 static int av1_metadata_init(AVBSFContext *bsf)
 197 {
 198     AV1MetadataContext *ctx = bsf->priv_data;
 199     CodedBitstreamFragment *frag = &ctx->access_unit;
 200     AV1RawOBU *obu;
 201     int err, i;
 202
 203     err = ff_cbs_init(&ctx->cbc, AV_CODEC_ID_AV1, bsf);
 204     if (err < 0)
 205         return err;
 206
 207     if (bsf->par_in->extradata) {
 208         err = ff_cbs_read_extradata(ctx->cbc, frag, bsf->par_in);
 209         if (err < 0) {
 210             av_log(bsf, AV_LOG_ERROR, "Failed to read extradata.\n");
 211             goto fail;
 212         }
 213
 214         for (i = 0; i < frag->nb_units; i++) {
 215             if (frag->units[i].type == AV1_OBU_SEQUENCE_HEADER) {
 216                 obu = frag->units[i].content;
 217                 err = av1_metadata_update_sequence_header(bsf, &obu->obu.sequence_header);
 218                 if (err < 0)
 219                     goto fail;
 220             }
 221         }
 222
 223         err = ff_cbs_write_extradata(ctx->cbc, bsf->par_out, frag);
 224         if (err < 0) {
 225             av_log(bsf, AV_LOG_ERROR, "Failed to write extradata.\n");
 226             goto fail;
 227         }
 228     }
 229
 230     err = 0;
 231 fail:
 232     ff_cbs_fragment_reset(ctx->cbc, frag);
 233     return err;
 234 }
 235
 236 static void av1_metadata_close(AVBSFContext *bsf)
 237 {
 238     AV1MetadataContext *ctx = bsf->priv_data;
 239
 240     ff_cbs_fragment_free(ctx->cbc, &ctx->access_unit);
 241     ff_cbs_close(&ctx->cbc);
 242 }
 243
 244 #define OFFSET(x) offsetof(AV1MetadataContext, x)
 245 #define FLAGS (AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_BSF_PARAM)
 246 static const AVOption av1_metadata_options[] = {
 247     { "td", "Temporal Delimiter OBU",
 248         OFFSET(td), AV_OPT_TYPE_INT,
 249         { .i64 = PASS }, PASS, REMOVE, FLAGS, "td" },
 250     { "pass",   NULL, 0, AV_OPT_TYPE_CONST,
 251         { .i64 = PASS   }, .flags = FLAGS, .unit = "td" },
 252     { "insert", NULL, 0, AV_OPT_TYPE_CONST,
 253         { .i64 = INSERT }, .flags = FLAGS, .unit = "td" },
 254     { "remove", NULL, 0, AV_OPT_TYPE_CONST,
 255         { .i64 = REMOVE }, .flags = FLAGS, .unit = "td" },
 256
 257     { "color_primaries", "Set color primaries (section 6.4.2)",
 258         OFFSET(color_primaries), AV_OPT_TYPE_INT,
 259         { .i64 = -1 }, -1, 255, FLAGS },
 260     { "transfer_characteristics", "Set transfer characteristics (section 6.4.2)",
 261         OFFSET(transfer_characteristics), AV_OPT_TYPE_INT,
 262         { .i64 = -1 }, -1, 255, FLAGS },
 263     { "matrix_coefficients", "Set matrix coefficients (section 6.4.2)",
 264         OFFSET(matrix_coefficients), AV_OPT_TYPE_INT,
 265         { .i64 = -1 }, -1, 255, FLAGS },
 266
 267     { "color_range", "Set color range flag (section 6.4.2)",
 268         OFFSET(color_range), AV_OPT_TYPE_INT,
 269         { .i64 = -1 }, -1, 1, FLAGS, "cr" },
 270     { "tv", "TV (limited) range", 0, AV_OPT_TYPE_CONST,
 271         { .i64 = 0 }, .flags = FLAGS, .unit = "cr" },
 272     { "pc", "PC (full) range",    0, AV_OPT_TYPE_CONST,
 273         { .i64 = 1 }, .flags = FLAGS, .unit = "cr" },
 274
 275     { "chroma_sample_position", "Set chroma sample position (section 6.4.2)",
 276         OFFSET(chroma_sample_position), AV_OPT_TYPE_INT,
 277         { .i64 = -1 }, -1, 3, FLAGS, "csp" },
 278     { "unknown",   "Unknown chroma sample position",  0, AV_OPT_TYPE_CONST,
 279         { .i64 = AV1_CSP_UNKNOWN },   .flags = FLAGS, .unit = "csp" },
 280     { "vertical",  "Left chroma sample position",     0, AV_OPT_TYPE_CONST,
 281         { .i64 = AV1_CSP_VERTICAL },  .flags = FLAGS, .unit = "csp" },
 282     { "colocated", "Top-left chroma sample position", 0, AV_OPT_TYPE_CONST,
 283         { .i64 = AV1_CSP_COLOCATED }, .flags = FLAGS, .unit = "csp" },
 284
 285     { "tick_rate", "Set display tick rate (num_units_in_display_tick / time_scale)",
 286         OFFSET(tick_rate), AV_OPT_TYPE_RATIONAL,
 287         { .dbl = 0.0 }, 0, UINT_MAX, FLAGS },
 288     { "num_ticks_per_picture", "Set display ticks per picture for CFR streams",
 289         OFFSET(num_ticks_per_picture), AV_OPT_TYPE_INT,
 290         { .i64 = -1 }, -1, INT_MAX, FLAGS },
 291
 292     { "delete_padding", "Delete all Padding OBUs",
 293         OFFSET(delete_padding), AV_OPT_TYPE_BOOL,
 294         { .i64 = 0 }, 0, 1, FLAGS},
 295
 296     { NULL }
 297 };
 298
 299 static const AVClass av1_metadata_class = {
 300     .class_name = "av1_metadata_bsf",
 301     .item_name  = av_default_item_name,
 302     .option     = av1_metadata_options,
 303     .version    = LIBAVUTIL_VERSION_INT,
 304 };
 305
 306 static const enum AVCodecID av1_metadata_codec_ids[] = {
 307     AV_CODEC_ID_AV1, AV_CODEC_ID_NONE,
 308 };
 309
 310 const AVBitStreamFilter ff_av1_metadata_bsf = {
 311     .name           = "av1_metadata",
 312     .priv_data_size = sizeof(AV1MetadataContext),
 313     .priv_class     = &av1_metadata_class,
 314     .init           = &av1_metadata_init,
 315     .close          = &av1_metadata_close,
 316     .filter         = &av1_metadata_filter,
 317     .codec_ids      = av1_metadata_codec_ids,
 318 };