@@ -2913,6 +2913,7 @@ mpeg4video_parser_select="h263dsp mpegvideo qpeldsp"
vc1_parser_select="vc1dsp"
# bitstream_filters
+h264_metadata_bsf_select="cbs_h264"
mjpeg2jpeg_bsf_select="jpegtables"
trace_headers_bsf_select="cbs_h264 cbs_h265 cbs_mpeg2"
@@ -92,6 +92,69 @@ When this option is enabled, the long-term headers are removed from the
bitstream after extraction.
@end table
+@section h264_metadata
+
+Modify metadata embedded in an H.264 stream.
+
+@table @option
+@item aud
+Insert or remove AUD NAL units in all access units of the stream.
+
+@table @samp
+@item insert
+@item remove
+@end table
+
+@item sample_aspect_ratio
+Set the sample aspect ratio of the stream in the VUI parameters.
+
+@item video_format
+@item video_full_range_flag
+Set the video format in the stream (see H.264 section E.2.1 and
+table E-2).
+
+@item colour_primaries
+@item transfer_characteristics
+@item matrix_coefficients
+Set the colour description in the stream (see H.264 section E.2.1
+and tables E-3, E-4 and E-5).
+
+@item chroma_sample_loc_type
+Set the chroma sample location in the stream (see H.264 section
+E.2.1 and figure E-1).
+
+@item tick_rate
+Set the tick rate (num_units_in_tick / time_scale) in the VUI
+parameters. This is the smallest time unit representable in the
+stream, and in many cases represents the field rate of the stream
+(double the frame rate).
+@item fixed_frame_rate_flag
+Set whether the stream has fixed framerate - typically this indicates
+that the framerate is exactly half the tick rate, but the exact
+meaning is dependent on interlacing and the picture structure (see
+H.264 section E.2.1 and table E-6).
+
+@item crop_left
+@item crop_right
+@item crop_top
+@item crop_bottom
+Set the frame cropping offsets in the SPS. These values will replace
+the current ones if the stream is already cropped.
+
+These fields are set in pixels. Note that some sizes may not be
+representable if the chroma is subsampled or the stream is interlaced
+(see H.264 section 7.4.2.1.1).
+
+@item sei_user_data
+Insert a string as SEI unregistered user data. The argument must
+be of the form @emph{UUID+string}, where the UUID is as hex digits
+possibly separated by hyphens, and the string can be anything.
+
+For example, @samp{086f3693-b7b3-4f2c-9653-21492feee5b8+hello} will
+insert the string ``hello'' associated with the given UUID.
+
+@end table
+
@section h264_mp4toannexb
Convert an H.264 bitstream from length prefixed mode to start code
@@ -1015,6 +1015,7 @@ OBJS-$(CONFIG_DUMP_EXTRADATA_BSF) += dump_extradata_bsf.o
OBJS-$(CONFIG_DCA_CORE_BSF) += dca_core_bsf.o
OBJS-$(CONFIG_EXTRACT_EXTRADATA_BSF) += extract_extradata_bsf.o \
h2645_parse.o
+OBJS-$(CONFIG_H264_METADATA_BSF) += h264_metadata_bsf.o
OBJS-$(CONFIG_H264_MP4TOANNEXB_BSF) += h264_mp4toannexb_bsf.o
OBJS-$(CONFIG_HEVC_MP4TOANNEXB_BSF) += hevc_mp4toannexb_bsf.o
OBJS-$(CONFIG_IMX_DUMP_HEADER_BSF) += imx_dump_header_bsf.o
@@ -29,6 +29,7 @@ extern const AVBitStreamFilter ff_chomp_bsf;
extern const AVBitStreamFilter ff_dump_extradata_bsf;
extern const AVBitStreamFilter ff_dca_core_bsf;
extern const AVBitStreamFilter ff_extract_extradata_bsf;
+extern const AVBitStreamFilter ff_h264_metadata_bsf;
extern const AVBitStreamFilter ff_h264_mp4toannexb_bsf;
extern const AVBitStreamFilter ff_hevc_mp4toannexb_bsf;
extern const AVBitStreamFilter ff_imx_dump_header_bsf;
new file mode 100644
@@ -0,0 +1,524 @@
+/*
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include "libavutil/avstring.h"
+#include "libavutil/common.h"
+#include "libavutil/opt.h"
+
+#include "bsf.h"
+#include "cbs.h"
+#include "cbs_h264.h"
+#include "h264.h"
+#include "h264_sei.h"
+
+enum {
+ PASS,
+ INSERT,
+ REMOVE,
+};
+
+typedef struct H264MetadataContext {
+ const AVClass *class;
+
+ CodedBitstreamContext *cbc;
+ CodedBitstreamFragment access_unit;
+
+ H264RawAUD aud_nal;
+ H264RawSEI sei_nal;
+
+ int aud;
+
+ AVRational sample_aspect_ratio;
+
+ int video_format;
+ int video_full_range_flag;
+ int colour_primaries;
+ int transfer_characteristics;
+ int matrix_coefficients;
+
+ int chroma_sample_loc_type;
+
+ AVRational tick_rate;
+ int fixed_frame_rate_flag;
+
+ int crop_left;
+ int crop_right;
+ int crop_top;
+ int crop_bottom;
+
+ const char *sei_user_data;
+ int sei_first_au;
+} H264MetadataContext;
+
+
+static int h264_metadata_update_sps(AVBSFContext *bsf,
+ H264RawSPS *sps)
+{
+ H264MetadataContext *ctx = bsf->priv_data;
+ int need_vui = 0;
+ int crop_unit_x, crop_unit_y;
+
+ if (ctx->sample_aspect_ratio.num && ctx->sample_aspect_ratio.den) {
+ // Table E-1.
+ static const AVRational sar_idc[] = {
+ { 0, 0 }, // Unspecified (never written here).
+ { 1, 1 }, { 12, 11 }, { 10, 11 }, { 16, 11 },
+ { 40, 33 }, { 24, 11 }, { 20, 11 }, { 32, 11 },
+ { 80, 33 }, { 18, 11 }, { 15, 11 }, { 64, 33 },
+ { 160, 99 }, { 4, 3 }, { 3, 2 }, { 2, 1 },
+ };
+ int num, den, i;
+
+ av_reduce(&num, &den, ctx->sample_aspect_ratio.num,
+ ctx->sample_aspect_ratio.den, 65535);
+
+ for (i = 1; i < FF_ARRAY_ELEMS(sar_idc); i++) {
+ if (num == sar_idc[i].num &&
+ den == sar_idc[i].den)
+ break;
+ }
+ if (i == FF_ARRAY_ELEMS(sar_idc)) {
+ sps->vui.aspect_ratio_idc = 255;
+ sps->vui.sar_width = num;
+ sps->vui.sar_height = den;
+ } else {
+ sps->vui.aspect_ratio_idc = i;
+ }
+ sps->vui.aspect_ratio_info_present_flag = 1;
+ need_vui = 1;
+ }
+
+#define SET_OR_INFER(field, value, present_flag, infer) do { \
+ if (value >= 0) { \
+ field = value; \
+ need_vui = 1; \
+ } else if (!present_flag) \
+ field = infer; \
+ } while (0)
+
+ if (ctx->video_format >= 0 ||
+ ctx->video_full_range_flag >= 0 ||
+ ctx->colour_primaries >= 0 ||
+ ctx->transfer_characteristics >= 0 ||
+ ctx->matrix_coefficients >= 0) {
+
+ SET_OR_INFER(sps->vui.video_format, ctx->video_format,
+ sps->vui.video_signal_type_present_flag, 5);
+
+ SET_OR_INFER(sps->vui.video_full_range_flag,
+ ctx->video_full_range_flag,
+ sps->vui.video_signal_type_present_flag, 0);
+
+ if (ctx->colour_primaries >= 0 ||
+ ctx->transfer_characteristics >= 0 ||
+ ctx->matrix_coefficients >= 0) {
+
+ SET_OR_INFER(sps->vui.colour_primaries,
+ ctx->colour_primaries,
+ sps->vui.colour_description_present_flag, 2);
+
+ SET_OR_INFER(sps->vui.transfer_characteristics,
+ ctx->transfer_characteristics,
+ sps->vui.colour_description_present_flag, 2);
+
+ SET_OR_INFER(sps->vui.matrix_coefficients,
+ ctx->matrix_coefficients,
+ sps->vui.colour_description_present_flag, 2);
+
+ sps->vui.colour_description_present_flag = 1;
+ }
+ sps->vui.video_signal_type_present_flag = 1;
+ need_vui = 1;
+ }
+
+ if (ctx->chroma_sample_loc_type >= 0) {
+ sps->vui.chroma_sample_loc_type_top_field =
+ ctx->chroma_sample_loc_type;
+ sps->vui.chroma_sample_loc_type_bottom_field =
+ ctx->chroma_sample_loc_type;
+ sps->vui.chroma_loc_info_present_flag = 1;
+ need_vui = 1;
+ }
+
+ if (ctx->tick_rate.num && ctx->tick_rate.den) {
+ int num, den;
+
+ av_reduce(&num, &den, ctx->tick_rate.num, ctx->tick_rate.den,
+ UINT32_MAX > INT_MAX ? UINT32_MAX : INT_MAX);
+
+ sps->vui.time_scale = num;
+ sps->vui.num_units_in_tick = den;
+
+ sps->vui.timing_info_present_flag = 1;
+ need_vui = 1;
+ }
+ SET_OR_INFER(sps->vui.fixed_frame_rate_flag,
+ ctx->fixed_frame_rate_flag,
+ sps->vui.timing_info_present_flag, 0);
+
+ if (sps->separate_colour_plane_flag || sps->chroma_format_idc == 0) {
+ crop_unit_x = 1;
+ crop_unit_y = 2 - sps->frame_mbs_only_flag;
+ } else {
+ crop_unit_x = 1 + (sps->chroma_format_idc < 3);
+ crop_unit_y = (1 + (sps->chroma_format_idc < 2)) *
+ (2 - sps->frame_mbs_only_flag);
+ }
+#define CROP(border, unit) do { \
+ if (ctx->crop_ ## border >= 0) { \
+ if (ctx->crop_ ## border % unit != 0) { \
+ av_log(bsf, AV_LOG_ERROR, "Invalid value for crop_%s: " \
+ "must be a multiple of %d.\n", #border, unit); \
+ return AVERROR(EINVAL); \
+ } \
+ sps->frame_crop_ ## border ## _offset = \
+ ctx->crop_ ## border / unit; \
+ sps->frame_cropping_flag = 1; \
+ } \
+ } while (0)
+ CROP(left, crop_unit_x);
+ CROP(right, crop_unit_x);
+ CROP(top, crop_unit_y);
+ CROP(bottom, crop_unit_y);
+#undef CROP
+
+ if (need_vui)
+ sps->vui_parameters_present_flag = 1;
+
+ return 0;
+}
+
+static int h264_metadata_filter(AVBSFContext *bsf, AVPacket *out)
+{
+ H264MetadataContext *ctx = bsf->priv_data;
+ AVPacket *in = NULL;
+ CodedBitstreamFragment *au = &ctx->access_unit;
+ int err, i, j, has_sps;
+ char *sei_udu_string = NULL;
+
+ err = ff_bsf_get_packet(bsf, &in);
+ if (err < 0)
+ goto fail;
+
+ err = ff_cbs_read_packet(ctx->cbc, au, in);
+ if (err < 0) {
+ av_log(bsf, AV_LOG_ERROR, "Failed to read packet.\n");
+ goto fail;
+ }
+
+ if (au->nb_units == 0) {
+ av_log(bsf, AV_LOG_ERROR, "No NAL units in packet.\n");
+ err = AVERROR_INVALIDDATA;
+ goto fail;
+ }
+
+ // If an AUD is present, it must be the first NAL unit.
+ if (au->units[0].type == H264_NAL_AUD) {
+ if (ctx->aud == REMOVE)
+ ff_cbs_delete_unit(ctx->cbc, au, 0);
+ } else {
+ if (ctx->aud == INSERT) {
+ static const int primary_pic_type_table[] = {
+ 0x084, // 2, 7
+ 0x0a5, // 0, 2, 5, 7
+ 0x0e7, // 0, 1, 2, 5, 6, 7
+ 0x210, // 4, 9
+ 0x318, // 3, 4, 8, 9
+ 0x294, // 2, 4, 7, 9
+ 0x3bd, // 0, 2, 3, 4, 5, 7, 8, 9
+ 0x3ff, // 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
+ };
+ int primary_pic_type_mask = 0xff;
+ H264RawAUD *aud = &ctx->aud_nal;
+
+ for (i = 0; i < au->nb_units; i++) {
+ if (au->units[i].type == H264_NAL_SLICE ||
+ au->units[i].type == H264_NAL_IDR_SLICE) {
+ H264RawSlice *slice = au->units[i].content;
+ for (j = 0; j < FF_ARRAY_ELEMS(primary_pic_type_table); j++) {
+ if (!(primary_pic_type_table[j] &
+ (1 << slice->header.slice_type)))
+ primary_pic_type_mask &= ~(1 << j);
+ }
+ }
+ }
+ for (j = 0; j < FF_ARRAY_ELEMS(primary_pic_type_table); j++)
+ if (primary_pic_type_mask & (1 << j))
+ break;
+ if (j >= FF_ARRAY_ELEMS(primary_pic_type_table)) {
+ av_log(bsf, AV_LOG_ERROR, "No usable primary_pic_type: "
+ "invalid slice types?\n");
+ err = AVERROR_INVALIDDATA;
+ goto fail;
+ }
+
+ aud->nal_unit_header.nal_unit_type = H264_NAL_AUD;
+ aud->primary_pic_type = j;
+
+ err = ff_cbs_insert_unit_content(ctx->cbc, au,
+ 0, H264_NAL_AUD, aud);
+ if (err < 0) {
+ av_log(bsf, AV_LOG_ERROR, "Failed to insert AUD.\n");
+ goto fail;
+ }
+ }
+ }
+
+ has_sps = 0;
+ for (i = 0; i < au->nb_units; i++) {
+ if (au->units[i].type == H264_NAL_SPS) {
+ err = h264_metadata_update_sps(bsf, au->units[i].content);
+ if (err < 0)
+ goto fail;
+ has_sps = 1;
+ }
+ }
+
+ // Insert the SEI in access units containing SPSs, and also
+ // unconditionally in the first access unit we ever see.
+ if (ctx->sei_user_data && (has_sps || !ctx->sei_first_au)) {
+ H264RawSEI *sei;
+ H264RawSEIPayload *payload;
+ H264RawSEIUserDataUnregistered *udu;
+ int sei_pos, sei_new;
+
+ ctx->sei_first_au = 1;
+
+ for (i = 0; i < au->nb_units; i++) {
+ if (au->units[i].type == H264_NAL_SEI ||
+ au->units[i].type == H264_NAL_SLICE ||
+ au->units[i].type == H264_NAL_IDR_SLICE)
+ break;
+ }
+ sei_pos = i;
+
+ if (sei_pos < au->nb_units &&
+ au->units[sei_pos].type == H264_NAL_SEI) {
+ sei_new = 0;
+ sei = au->units[sei_pos].content;
+ } else {
+ sei_new = 1;
+ sei = &ctx->sei_nal;
+ memset(sei, 0, sizeof(*sei));
+
+ sei->nal_unit_header.nal_unit_type = H264_NAL_SEI;
+
+ err = ff_cbs_insert_unit_content(ctx->cbc, au,
+ sei_pos, H264_NAL_SEI, sei);
+ if (err < 0) {
+ av_log(bsf, AV_LOG_ERROR, "Failed to insert SEI.\n");
+ goto fail;
+ }
+ }
+
+ payload = &sei->payload[sei->payload_count];
+
+ payload->payload_type = H264_SEI_TYPE_USER_DATA_UNREGISTERED;
+ udu = &payload->payload.user_data_unregistered;
+
+ for (i = j = 0; j < 32 && ctx->sei_user_data[i]; i++) {
+ int c, v;
+ c = ctx->sei_user_data[i];
+ if (c == '-') {
+ continue;
+ } else if (av_isxdigit(c)) {
+ c = av_tolower(c);
+ v = (c <= '9' ? c - '0' : c - 'a' + 10);
+ } else {
+ goto invalid_user_data;
+ }
+ if (i & 1)
+ udu->uuid_iso_iec_11578[j / 2] |= v;
+ else
+ udu->uuid_iso_iec_11578[j / 2] = v << 4;
+ ++j;
+ }
+ if (j == 32 && ctx->sei_user_data[i] == '+') {
+ sei_udu_string = av_strdup(ctx->sei_user_data + i + 1);
+ if (!sei_udu_string) {
+ err = AVERROR(ENOMEM);
+ goto sei_fail;
+ }
+
+ udu->data = sei_udu_string;
+ udu->data_length = strlen(sei_udu_string);
+
+ payload->payload_size = 16 + udu->data_length;
+
+ if (!sei_new) {
+ // This will be freed by the existing internal
+ // reference in fragment_uninit().
+ sei_udu_string = NULL;
+ }
+
+ } else {
+ invalid_user_data:
+ av_log(bsf, AV_LOG_ERROR, "Invalid user data: "
+ "must be \"UUID+string\".\n");
+ err = AVERROR(EINVAL);
+ sei_fail:
+ memset(payload, 0, sizeof(&payload));
+ goto fail;
+ }
+
+ ++sei->payload_count;
+ }
+
+ err = ff_cbs_write_packet(ctx->cbc, out, au);
+ if (err < 0) {
+ av_log(bsf, AV_LOG_ERROR, "Failed to write packet.\n");
+ goto fail;
+ }
+
+ err = av_packet_copy_props(out, in);
+ if (err < 0)
+ goto fail;
+
+ err = 0;
+fail:
+ ff_cbs_fragment_uninit(ctx->cbc, au);
+ av_freep(&sei_udu_string);
+
+ av_packet_free(&in);
+
+ return err;
+}
+
+static int h264_metadata_init(AVBSFContext *bsf)
+{
+ H264MetadataContext *ctx = bsf->priv_data;
+ CodedBitstreamFragment *au = &ctx->access_unit;
+ int err, i;
+
+ err = ff_cbs_init(&ctx->cbc, AV_CODEC_ID_H264, bsf);
+ if (err < 0)
+ return err;
+
+ if (bsf->par_in->extradata) {
+ err = ff_cbs_read_extradata(ctx->cbc, au, bsf->par_in);
+ if (err < 0) {
+ av_log(bsf, AV_LOG_ERROR, "Failed to read extradata.\n");
+ goto fail;
+ }
+
+ for (i = 0; i < au->nb_units; i++) {
+ if (au->units[i].type == H264_NAL_SPS) {
+ err = h264_metadata_update_sps(bsf, au->units[i].content);
+ if (err < 0)
+ goto fail;
+ }
+ }
+
+ err = ff_cbs_write_extradata(ctx->cbc, bsf->par_out, au);
+ if (err < 0) {
+ av_log(bsf, AV_LOG_ERROR, "Failed to write extradata.\n");
+ goto fail;
+ }
+ }
+
+ err = 0;
+fail:
+ ff_cbs_fragment_uninit(ctx->cbc, au);
+ return err;
+}
+
+static void h264_metadata_close(AVBSFContext *bsf)
+{
+ H264MetadataContext *ctx = bsf->priv_data;
+ ff_cbs_close(&ctx->cbc);
+}
+
+#define OFFSET(x) offsetof(H264MetadataContext, x)
+static const AVOption h264_metadata_options[] = {
+ { "aud", "Access Unit Delimiter NAL units",
+ OFFSET(aud), AV_OPT_TYPE_INT,
+ { .i64 = PASS }, PASS, REMOVE, 0, "aud" },
+ { "pass", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = PASS }, .unit = "aud" },
+ { "insert", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = INSERT }, .unit = "aud" },
+ { "remove", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = REMOVE }, .unit = "aud" },
+
+ { "sample_aspect_ratio", "Set sample aspect ratio (table E-1)",
+ OFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL,
+ { .dbl = 0.0 }, 0, 65535 },
+
+ { "video_format", "Set video format (table E-2)",
+ OFFSET(video_format), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 7 },
+ { "video_full_range_flag", "Set video full range flag",
+ OFFSET(video_full_range_flag), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 1 },
+ { "colour_primaries", "Set colour primaries (table E-3)",
+ OFFSET(colour_primaries), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 255 },
+ { "transfer_characteristics", "Set transfer characteristics (table E-4)",
+ OFFSET(transfer_characteristics), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 255 },
+ { "matrix_coefficients", "Set matrix coefficients (table E-5)",
+ OFFSET(matrix_coefficients), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 255 },
+
+ { "chroma_sample_loc_type", "Set chroma sample location type (figure E-1)",
+ OFFSET(chroma_sample_loc_type), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 6 },
+
+ { "tick_rate", "Set VUI tick rate (num_units_in_tick / time_scale)",
+ OFFSET(tick_rate), AV_OPT_TYPE_RATIONAL,
+ { .dbl = 0.0 }, 0, UINT_MAX },
+ { "fixed_frame_rate_flag", "Set VUI fixed frame rate flag",
+ OFFSET(fixed_frame_rate_flag), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, 1 },
+
+ { "crop_left", "Set left border crop offset",
+ OFFSET(crop_left), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, H264_MAX_WIDTH },
+ { "crop_right", "Set right border crop offset",
+ OFFSET(crop_right), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, H264_MAX_WIDTH },
+ { "crop_top", "Set top border crop offset",
+ OFFSET(crop_top), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, H264_MAX_HEIGHT },
+ { "crop_bottom", "Set bottom border crop offset",
+ OFFSET(crop_bottom), AV_OPT_TYPE_INT,
+ { .i64 = -1 }, -1, H264_MAX_HEIGHT },
+
+ { "sei_user_data", "Insert SEI user data (UUID+string)",
+ OFFSET(sei_user_data), AV_OPT_TYPE_STRING, { .str = NULL } },
+
+ { NULL }
+};
+
+static const AVClass h264_metadata_class = {
+ .class_name = "h264_metadata_bsf",
+ .item_name = av_default_item_name,
+ .option = h264_metadata_options,
+ .version = LIBAVCODEC_VERSION_MAJOR,
+};
+
+static const enum AVCodecID h264_metadata_codec_ids[] = {
+ AV_CODEC_ID_H264, AV_CODEC_ID_NONE,
+};
+
+const AVBitStreamFilter ff_h264_metadata_bsf = {
+ .name = "h264_metadata",
+ .priv_data_size = sizeof(H264MetadataContext),
+ .priv_class = &h264_metadata_class,
+ .init = &h264_metadata_init,
+ .close = &h264_metadata_close,
+ .filter = &h264_metadata_filter,
+ .codec_ids = h264_metadata_codec_ids,
+};