git.sesse.net Git - ffmpeg/blob - libavfilter/vf_showinfo.c

   1 /*
   2  * Copyright (c) 2011 Stefano Sabatini
   3  * This file is part of FFmpeg.
   4  *
   5  * FFmpeg is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * FFmpeg is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with FFmpeg; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 /**
  21  * @file
  22  * filter for showing textual video frame information
  23  */
  24
  25 #include <inttypes.h>
  26
  27 #include "libavutil/bswap.h"
  28 #include "libavutil/adler32.h"
  29 #include "libavutil/display.h"
  30 #include "libavutil/imgutils.h"
  31 #include "libavutil/internal.h"
  32 #include "libavutil/opt.h"
  33 #include "libavutil/pixdesc.h"
  34 #include "libavutil/spherical.h"
  35 #include "libavutil/stereo3d.h"
  36 #include "libavutil/timestamp.h"
  37 #include "libavutil/timecode.h"
  38 #include "libavutil/mastering_display_metadata.h"
  39 #include "libavutil/video_enc_params.h"
  40
  41 #include "avfilter.h"
  42 #include "internal.h"
  43 #include "video.h"
  44
  45 typedef struct ShowInfoContext {
  46     const AVClass *class;
  47     int calculate_checksums;
  48 } ShowInfoContext;
  49
  50 #define OFFSET(x) offsetof(ShowInfoContext, x)
  51 #define VF AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  52
  53 static const AVOption showinfo_options[] = {
  54     { "checksum", "calculate checksums", OFFSET(calculate_checksums), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, VF },
  55     { NULL }
  56 };
  57
  58 AVFILTER_DEFINE_CLASS(showinfo);
  59
  60 static void dump_spherical(AVFilterContext *ctx, AVFrame *frame, AVFrameSideData *sd)
  61 {
  62     AVSphericalMapping *spherical = (AVSphericalMapping *)sd->data;
  63     double yaw, pitch, roll;
  64
  65     av_log(ctx, AV_LOG_INFO, "spherical information: ");
  66     if (sd->size < sizeof(*spherical)) {
  67         av_log(ctx, AV_LOG_ERROR, "invalid data");
  68         return;
  69     }
  70
  71     if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR)
  72         av_log(ctx, AV_LOG_INFO, "equirectangular ");
  73     else if (spherical->projection == AV_SPHERICAL_CUBEMAP)
  74         av_log(ctx, AV_LOG_INFO, "cubemap ");
  75     else if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR_TILE)
  76         av_log(ctx, AV_LOG_INFO, "tiled equirectangular ");
  77     else {
  78         av_log(ctx, AV_LOG_WARNING, "unknown");
  79         return;
  80     }
  81
  82     yaw = ((double)spherical->yaw) / (1 << 16);
  83     pitch = ((double)spherical->pitch) / (1 << 16);
  84     roll = ((double)spherical->roll) / (1 << 16);
  85     av_log(ctx, AV_LOG_INFO, "(%f/%f/%f) ", yaw, pitch, roll);
  86
  87     if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR_TILE) {
  88         size_t l, t, r, b;
  89         av_spherical_tile_bounds(spherical, frame->width, frame->height,
  90                                  &l, &t, &r, &b);
  91         av_log(ctx, AV_LOG_INFO,
  92                "[%"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER"] ",
  93                l, t, r, b);
  94     } else if (spherical->projection == AV_SPHERICAL_CUBEMAP) {
  95         av_log(ctx, AV_LOG_INFO, "[pad %"PRIu32"] ", spherical->padding);
  96     }
  97 }
  98
  99 static void dump_stereo3d(AVFilterContext *ctx, AVFrameSideData *sd)
 100 {
 101     AVStereo3D *stereo;
 102
 103     av_log(ctx, AV_LOG_INFO, "stereoscopic information: ");
 104     if (sd->size < sizeof(*stereo)) {
 105         av_log(ctx, AV_LOG_ERROR, "invalid data");
 106         return;
 107     }
 108
 109     stereo = (AVStereo3D *)sd->data;
 110
 111     av_log(ctx, AV_LOG_INFO, "type - %s", av_stereo3d_type_name(stereo->type));
 112
 113     if (stereo->flags & AV_STEREO3D_FLAG_INVERT)
 114         av_log(ctx, AV_LOG_INFO, " (inverted)");
 115 }
 116
 117 static void dump_roi(AVFilterContext *ctx, AVFrameSideData *sd)
 118 {
 119     int nb_rois;
 120     const AVRegionOfInterest *roi;
 121     uint32_t roi_size;
 122
 123     roi = (const AVRegionOfInterest *)sd->data;
 124     roi_size = roi->self_size;
 125     if (!roi_size || sd->size % roi_size != 0) {
 126         av_log(ctx, AV_LOG_ERROR, "Invalid AVRegionOfInterest.self_size.");
 127         return;
 128     }
 129     nb_rois = sd->size / roi_size;
 130
 131     av_log(ctx, AV_LOG_INFO, "Regions Of Interest(RoI) information: ");
 132     for (int i = 0; i < nb_rois; i++) {
 133         roi = (const AVRegionOfInterest *)(sd->data + roi_size * i);
 134         av_log(ctx, AV_LOG_INFO, "index: %d, region: (%d, %d)/(%d, %d), qp offset: %d/%d.\n",
 135                i, roi->left, roi->top, roi->right, roi->bottom, roi->qoffset.num, roi->qoffset.den);
 136     }
 137 }
 138
 139 static void dump_mastering_display(AVFilterContext *ctx, AVFrameSideData *sd)
 140 {
 141     AVMasteringDisplayMetadata *mastering_display;
 142
 143     av_log(ctx, AV_LOG_INFO, "mastering display: ");
 144     if (sd->size < sizeof(*mastering_display)) {
 145         av_log(ctx, AV_LOG_ERROR, "invalid data");
 146         return;
 147     }
 148
 149     mastering_display = (AVMasteringDisplayMetadata *)sd->data;
 150
 151     av_log(ctx, AV_LOG_INFO, "has_primaries:%d has_luminance:%d "
 152            "r(%5.4f,%5.4f) g(%5.4f,%5.4f) b(%5.4f %5.4f) wp(%5.4f, %5.4f) "
 153            "min_luminance=%f, max_luminance=%f",
 154            mastering_display->has_primaries, mastering_display->has_luminance,
 155            av_q2d(mastering_display->display_primaries[0][0]),
 156            av_q2d(mastering_display->display_primaries[0][1]),
 157            av_q2d(mastering_display->display_primaries[1][0]),
 158            av_q2d(mastering_display->display_primaries[1][1]),
 159            av_q2d(mastering_display->display_primaries[2][0]),
 160            av_q2d(mastering_display->display_primaries[2][1]),
 161            av_q2d(mastering_display->white_point[0]), av_q2d(mastering_display->white_point[1]),
 162            av_q2d(mastering_display->min_luminance), av_q2d(mastering_display->max_luminance));
 163 }
 164
 165 static void dump_content_light_metadata(AVFilterContext *ctx, AVFrameSideData *sd)
 166 {
 167     AVContentLightMetadata* metadata = (AVContentLightMetadata*)sd->data;
 168
 169     av_log(ctx, AV_LOG_INFO, "Content Light Level information: "
 170            "MaxCLL=%d, MaxFALL=%d",
 171            metadata->MaxCLL, metadata->MaxFALL);
 172 }
 173
 174 static void dump_video_enc_params(AVFilterContext *ctx, AVFrameSideData *sd)
 175 {
 176     AVVideoEncParams *par = (AVVideoEncParams*)sd->data;
 177     int plane, acdc;
 178
 179     av_log(ctx, AV_LOG_INFO, "video encoding parameters: type %d; ", par->type);
 180     if (par->qp)
 181         av_log(ctx, AV_LOG_INFO, "qp=%d; ", par->qp);
 182     for (plane = 0; plane < FF_ARRAY_ELEMS(par->delta_qp); plane++)
 183         for (acdc = 0; acdc < FF_ARRAY_ELEMS(par->delta_qp[plane]); acdc++) {
 184             int delta_qp = par->delta_qp[plane][acdc];
 185             if (delta_qp)
 186                 av_log(ctx, AV_LOG_INFO, "delta_qp[%d][%d]=%d; ",
 187                        plane, acdc, delta_qp);
 188         }
 189     if (par->nb_blocks)
 190         av_log(ctx, AV_LOG_INFO, "%u blocks; ", par->nb_blocks);
 191 }
 192
 193 static void dump_color_property(AVFilterContext *ctx, AVFrame *frame)
 194 {
 195     const char *color_range_str     = av_color_range_name(frame->color_range);
 196     const char *colorspace_str      = av_color_space_name(frame->colorspace);
 197     const char *color_primaries_str = av_color_primaries_name(frame->color_primaries);
 198     const char *color_trc_str       = av_color_transfer_name(frame->color_trc);
 199
 200     if (!color_range_str || frame->color_range == AVCOL_RANGE_UNSPECIFIED) {
 201         av_log(ctx, AV_LOG_INFO, "color_range:unknown");
 202     } else {
 203         av_log(ctx, AV_LOG_INFO, "color_range:%s", color_range_str);
 204     }
 205
 206     if (!colorspace_str || frame->colorspace == AVCOL_SPC_UNSPECIFIED) {
 207         av_log(ctx, AV_LOG_INFO, " color_space:unknown");
 208     } else {
 209         av_log(ctx, AV_LOG_INFO, " color_space:%s", colorspace_str);
 210     }
 211
 212     if (!color_primaries_str || frame->color_primaries == AVCOL_PRI_UNSPECIFIED) {
 213         av_log(ctx, AV_LOG_INFO, " color_primaries:unknown");
 214     } else {
 215         av_log(ctx, AV_LOG_INFO, " color_primaries:%s", color_primaries_str);
 216     }
 217
 218     if (!color_trc_str || frame->color_trc == AVCOL_TRC_UNSPECIFIED) {
 219         av_log(ctx, AV_LOG_INFO, " color_trc:unknown");
 220     } else {
 221         av_log(ctx, AV_LOG_INFO, " color_trc:%s", color_trc_str);
 222     }
 223     av_log(ctx, AV_LOG_INFO, "\n");
 224 }
 225
 226 static void update_sample_stats_8(const uint8_t *src, int len, int64_t *sum, int64_t *sum2)
 227 {
 228     int i;
 229
 230     for (i = 0; i < len; i++) {
 231         *sum += src[i];
 232         *sum2 += src[i] * src[i];
 233     }
 234 }
 235
 236 static void update_sample_stats_16(int be, const uint8_t *src, int len, int64_t *sum, int64_t *sum2)
 237 {
 238     const uint16_t *src1 = (const uint16_t *)src;
 239     int i;
 240
 241     for (i = 0; i < len / 2; i++) {
 242         if ((HAVE_BIGENDIAN && !be) || (!HAVE_BIGENDIAN && be)) {
 243             *sum += av_bswap16(src1[i]);
 244             *sum2 += (uint32_t)av_bswap16(src1[i]) * (uint32_t)av_bswap16(src1[i]);
 245         } else {
 246             *sum += src1[i];
 247             *sum2 += (uint32_t)src1[i] * (uint32_t)src1[i];
 248         }
 249     }
 250 }
 251
 252 static void update_sample_stats(int depth, int be, const uint8_t *src, int len, int64_t *sum, int64_t *sum2)
 253 {
 254     if (depth <= 8)
 255         update_sample_stats_8(src, len, sum, sum2);
 256     else
 257         update_sample_stats_16(be, src, len, sum, sum2);
 258 }
 259
 260 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 261 {
 262     AVFilterContext *ctx = inlink->dst;
 263     ShowInfoContext *s = ctx->priv;
 264     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 265     uint32_t plane_checksum[4] = {0}, checksum = 0;
 266     int64_t sum[4] = {0}, sum2[4] = {0};
 267     int32_t pixelcount[4] = {0};
 268     int bitdepth = desc->comp[0].depth;
 269     int be = desc->flags & AV_PIX_FMT_FLAG_BE;
 270     int i, plane, vsub = desc->log2_chroma_h;
 271
 272     for (plane = 0; plane < 4 && s->calculate_checksums && frame->data[plane] && frame->linesize[plane]; plane++) {
 273         uint8_t *data = frame->data[plane];
 274         int h = plane == 1 || plane == 2 ? AV_CEIL_RSHIFT(inlink->h, vsub) : inlink->h;
 275         int linesize = av_image_get_linesize(frame->format, frame->width, plane);
 276         int width = linesize >> (bitdepth > 8);
 277
 278         if (linesize < 0)
 279             return linesize;
 280
 281         for (i = 0; i < h; i++) {
 282             plane_checksum[plane] = av_adler32_update(plane_checksum[plane], data, linesize);
 283             checksum = av_adler32_update(checksum, data, linesize);
 284
 285             update_sample_stats(bitdepth, be, data, linesize, sum+plane, sum2+plane);
 286             pixelcount[plane] += width;
 287             data += frame->linesize[plane];
 288         }
 289     }
 290
 291     av_log(ctx, AV_LOG_INFO,
 292            "n:%4"PRId64" pts:%7s pts_time:%-7s pos:%9"PRId64" "
 293            "fmt:%s sar:%d/%d s:%dx%d i:%c iskey:%d type:%c ",
 294            inlink->frame_count_out,
 295            av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base), frame->pkt_pos,
 296            desc->name,
 297            frame->sample_aspect_ratio.num, frame->sample_aspect_ratio.den,
 298            frame->width, frame->height,
 299            !frame->interlaced_frame ? 'P' :         /* Progressive  */
 300            frame->top_field_first   ? 'T' : 'B',    /* Top / Bottom */
 301            frame->key_frame,
 302            av_get_picture_type_char(frame->pict_type));
 303
 304     if (s->calculate_checksums) {
 305         av_log(ctx, AV_LOG_INFO,
 306                "checksum:%08"PRIX32" plane_checksum:[%08"PRIX32,
 307                checksum, plane_checksum[0]);
 308
 309         for (plane = 1; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
 310             av_log(ctx, AV_LOG_INFO, " %08"PRIX32, plane_checksum[plane]);
 311         av_log(ctx, AV_LOG_INFO, "] mean:[");
 312         for (plane = 0; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
 313             av_log(ctx, AV_LOG_INFO, "%"PRId64" ", (sum[plane] + pixelcount[plane]/2) / pixelcount[plane]);
 314         av_log(ctx, AV_LOG_INFO, "\b] stdev:[");
 315         for (plane = 0; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
 316             av_log(ctx, AV_LOG_INFO, "%3.1f ",
 317                    sqrt((sum2[plane] - sum[plane]*(double)sum[plane]/pixelcount[plane])/pixelcount[plane]));
 318         av_log(ctx, AV_LOG_INFO, "\b]");
 319     }
 320     av_log(ctx, AV_LOG_INFO, "\n");
 321
 322     for (i = 0; i < frame->nb_side_data; i++) {
 323         AVFrameSideData *sd = frame->side_data[i];
 324
 325         av_log(ctx, AV_LOG_INFO, "  side data - ");
 326         switch (sd->type) {
 327         case AV_FRAME_DATA_PANSCAN:
 328             av_log(ctx, AV_LOG_INFO, "pan/scan");
 329             break;
 330         case AV_FRAME_DATA_A53_CC:
 331             av_log(ctx, AV_LOG_INFO, "A/53 closed captions (%d bytes)", sd->size);
 332             break;
 333         case AV_FRAME_DATA_SPHERICAL:
 334             dump_spherical(ctx, frame, sd);
 335             break;
 336         case AV_FRAME_DATA_STEREO3D:
 337             dump_stereo3d(ctx, sd);
 338             break;
 339         case AV_FRAME_DATA_S12M_TIMECODE: {
 340             uint32_t *tc = (uint32_t*)sd->data;
 341             int m = FFMIN(tc[0],3);
 342             if (sd->size != 16) {
 343                 av_log(ctx, AV_LOG_ERROR, "invalid data");
 344                 break;
 345             }
 346             for (int j = 1; j <= m; j++) {
 347                 char tcbuf[AV_TIMECODE_STR_SIZE];
 348                 av_timecode_make_smpte_tc_string(tcbuf, tc[j], 0);
 349                 av_log(ctx, AV_LOG_INFO, "timecode - %s%s", tcbuf, j != m ? ", " : "");
 350             }
 351             break;
 352         }
 353         case AV_FRAME_DATA_DISPLAYMATRIX:
 354             av_log(ctx, AV_LOG_INFO, "displaymatrix: rotation of %.2f degrees",
 355                    av_display_rotation_get((int32_t *)sd->data));
 356             break;
 357         case AV_FRAME_DATA_AFD:
 358             av_log(ctx, AV_LOG_INFO, "afd: value of %"PRIu8, sd->data[0]);
 359             break;
 360         case AV_FRAME_DATA_REGIONS_OF_INTEREST:
 361             dump_roi(ctx, sd);
 362             break;
 363         case AV_FRAME_DATA_MASTERING_DISPLAY_METADATA:
 364             dump_mastering_display(ctx, sd);
 365             break;
 366         case AV_FRAME_DATA_CONTENT_LIGHT_LEVEL:
 367             dump_content_light_metadata(ctx, sd);
 368             break;
 369         case AV_FRAME_DATA_GOP_TIMECODE: {
 370             char tcbuf[AV_TIMECODE_STR_SIZE];
 371             av_timecode_make_mpeg_tc_string(tcbuf, *(int64_t *)(sd->data));
 372             av_log(ctx, AV_LOG_INFO, "GOP timecode - %s", tcbuf);
 373             break;
 374         }
 375         case AV_FRAME_DATA_VIDEO_ENC_PARAMS:
 376             dump_video_enc_params(ctx, sd);
 377             break;
 378         default:
 379             av_log(ctx, AV_LOG_WARNING, "unknown side data type %d (%d bytes)",
 380                    sd->type, sd->size);
 381             break;
 382         }
 383
 384         av_log(ctx, AV_LOG_INFO, "\n");
 385     }
 386
 387     dump_color_property(ctx, frame);
 388
 389     return ff_filter_frame(inlink->dst->outputs[0], frame);
 390 }
 391
 392 static int config_props(AVFilterContext *ctx, AVFilterLink *link, int is_out)
 393 {
 394
 395     av_log(ctx, AV_LOG_INFO, "config %s time_base: %d/%d, frame_rate: %d/%d\n",
 396            is_out ? "out" : "in",
 397            link->time_base.num, link->time_base.den,
 398            link->frame_rate.num, link->frame_rate.den);
 399
 400     return 0;
 401 }
 402
 403 static int config_props_in(AVFilterLink *link)
 404 {
 405     AVFilterContext *ctx = link->dst;
 406     return config_props(ctx, link, 0);
 407 }
 408
 409 static int config_props_out(AVFilterLink *link)
 410 {
 411     AVFilterContext *ctx = link->src;
 412     return config_props(ctx, link, 1);
 413 }
 414
 415 static const AVFilterPad avfilter_vf_showinfo_inputs[] = {
 416     {
 417         .name             = "default",
 418         .type             = AVMEDIA_TYPE_VIDEO,
 419         .filter_frame     = filter_frame,
 420         .config_props     = config_props_in,
 421     },
 422     { NULL }
 423 };
 424
 425 static const AVFilterPad avfilter_vf_showinfo_outputs[] = {
 426     {
 427         .name = "default",
 428         .type = AVMEDIA_TYPE_VIDEO,
 429         .config_props  = config_props_out,
 430     },
 431     { NULL }
 432 };
 433
 434 AVFilter ff_vf_showinfo = {
 435     .name        = "showinfo",
 436     .description = NULL_IF_CONFIG_SMALL("Show textual information for each video frame."),
 437     .inputs      = avfilter_vf_showinfo_inputs,
 438     .outputs     = avfilter_vf_showinfo_outputs,
 439     .priv_size   = sizeof(ShowInfoContext),
 440     .priv_class  = &showinfo_class,
 441 };