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/adler32.h"
  28 #include "libavutil/display.h"
  29 #include "libavutil/imgutils.h"
  30 #include "libavutil/internal.h"
  31 #include "libavutil/opt.h"
  32 #include "libavutil/pixdesc.h"
  33 #include "libavutil/spherical.h"
  34 #include "libavutil/stereo3d.h"
  35 #include "libavutil/timestamp.h"
  36 #include "libavutil/timecode.h"
  37
  38 #include "avfilter.h"
  39 #include "internal.h"
  40 #include "video.h"
  41
  42 typedef struct ShowInfoContext {
  43     const AVClass *class;
  44     int calculate_checksums;
  45 } ShowInfoContext;
  46
  47 #define OFFSET(x) offsetof(ShowInfoContext, x)
  48 #define VF AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
  49
  50 static const AVOption showinfo_options[] = {
  51     { "checksum", "calculate checksums", OFFSET(calculate_checksums), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, VF },
  52     { NULL }
  53 };
  54
  55 AVFILTER_DEFINE_CLASS(showinfo);
  56
  57 static void dump_spherical(AVFilterContext *ctx, AVFrame *frame, AVFrameSideData *sd)
  58 {
  59     AVSphericalMapping *spherical = (AVSphericalMapping *)sd->data;
  60     double yaw, pitch, roll;
  61
  62     av_log(ctx, AV_LOG_INFO, "spherical information: ");
  63     if (sd->size < sizeof(*spherical)) {
  64         av_log(ctx, AV_LOG_INFO, "invalid data");
  65         return;
  66     }
  67
  68     if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR)
  69         av_log(ctx, AV_LOG_INFO, "equirectangular ");
  70     else if (spherical->projection == AV_SPHERICAL_CUBEMAP)
  71         av_log(ctx, AV_LOG_INFO, "cubemap ");
  72     else if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR_TILE)
  73         av_log(ctx, AV_LOG_INFO, "tiled equirectangular ");
  74     else {
  75         av_log(ctx, AV_LOG_WARNING, "unknown");
  76         return;
  77     }
  78
  79     yaw = ((double)spherical->yaw) / (1 << 16);
  80     pitch = ((double)spherical->pitch) / (1 << 16);
  81     roll = ((double)spherical->roll) / (1 << 16);
  82     av_log(ctx, AV_LOG_INFO, "(%f/%f/%f) ", yaw, pitch, roll);
  83
  84     if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR_TILE) {
  85         size_t l, t, r, b;
  86         av_spherical_tile_bounds(spherical, frame->width, frame->height,
  87                                  &l, &t, &r, &b);
  88         av_log(ctx, AV_LOG_INFO,
  89                "[%"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER"] ",
  90                l, t, r, b);
  91     } else if (spherical->projection == AV_SPHERICAL_CUBEMAP) {
  92         av_log(ctx, AV_LOG_INFO, "[pad %"PRIu32"] ", spherical->padding);
  93     }
  94 }
  95
  96 static void dump_stereo3d(AVFilterContext *ctx, AVFrameSideData *sd)
  97 {
  98     AVStereo3D *stereo;
  99
 100     av_log(ctx, AV_LOG_INFO, "stereoscopic information: ");
 101     if (sd->size < sizeof(*stereo)) {
 102         av_log(ctx, AV_LOG_INFO, "invalid data");
 103         return;
 104     }
 105
 106     stereo = (AVStereo3D *)sd->data;
 107
 108     av_log(ctx, AV_LOG_INFO, "type - %s", av_stereo3d_type_name(stereo->type));
 109
 110     if (stereo->flags & AV_STEREO3D_FLAG_INVERT)
 111         av_log(ctx, AV_LOG_INFO, " (inverted)");
 112 }
 113
 114 static void dump_roi(AVFilterContext *ctx, AVFrameSideData *sd)
 115 {
 116     int nb_rois;
 117     const AVRegionOfInterest *roi;
 118     uint32_t roi_size;
 119
 120     roi = (const AVRegionOfInterest *)sd->data;
 121     roi_size = roi->self_size;
 122     if (!roi_size || sd->size % roi_size != 0) {
 123         av_log(ctx, AV_LOG_ERROR, "Invalid AVRegionOfInterest.self_size.\n");
 124         return;
 125     }
 126     nb_rois = sd->size / roi_size;
 127
 128     av_log(ctx, AV_LOG_INFO, "Regions Of Interest(RoI) information: ");
 129     for (int i = 0; i < nb_rois; i++) {
 130         roi = (const AVRegionOfInterest *)(sd->data + roi_size * i);
 131         av_log(ctx, AV_LOG_INFO, "index: %d, region: (%d, %d)/(%d, %d), qp offset: %d/%d.\n",
 132                i, roi->left, roi->top, roi->right, roi->bottom, roi->qoffset.num, roi->qoffset.den);
 133     }
 134 }
 135
 136 static void dump_color_property(AVFilterContext *ctx, AVFrame *frame)
 137 {
 138     const char *color_range_str     = av_color_range_name(frame->color_range);
 139     const char *colorspace_str      = av_color_space_name(frame->colorspace);
 140     const char *color_primaries_str = av_color_primaries_name(frame->color_primaries);
 141     const char *color_trc_str       = av_color_transfer_name(frame->color_trc);
 142
 143     if (!color_range_str || frame->color_range == AVCOL_RANGE_UNSPECIFIED) {
 144         av_log(ctx, AV_LOG_INFO, "color_range:unknown");
 145     } else {
 146         av_log(ctx, AV_LOG_INFO, "color_range:%s", color_range_str);
 147     }
 148
 149     if (!colorspace_str || frame->colorspace == AVCOL_SPC_UNSPECIFIED) {
 150         av_log(ctx, AV_LOG_INFO, " color_space:unknown");
 151     } else {
 152         av_log(ctx, AV_LOG_INFO, " color_space:%s", colorspace_str);
 153     }
 154
 155     if (!color_primaries_str || frame->color_primaries == AVCOL_PRI_UNSPECIFIED) {
 156         av_log(ctx, AV_LOG_INFO, " color_primaries:unknown");
 157     } else {
 158         av_log(ctx, AV_LOG_INFO, " color_primaries:%s", color_primaries_str);
 159     }
 160
 161     if (!color_trc_str || frame->color_trc == AVCOL_TRC_UNSPECIFIED) {
 162         av_log(ctx, AV_LOG_INFO, " color_trc:unknown");
 163     } else {
 164         av_log(ctx, AV_LOG_INFO, " color_trc:%s", color_trc_str);
 165     }
 166     av_log(ctx, AV_LOG_INFO, "\n");
 167 }
 168
 169 static void update_sample_stats(const uint8_t *src, int len, int64_t *sum, int64_t *sum2)
 170 {
 171     int i;
 172
 173     for (i = 0; i < len; i++) {
 174         *sum += src[i];
 175         *sum2 += src[i] * src[i];
 176     }
 177 }
 178
 179 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
 180 {
 181     AVFilterContext *ctx = inlink->dst;
 182     ShowInfoContext *s = ctx->priv;
 183     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
 184     uint32_t plane_checksum[4] = {0}, checksum = 0;
 185     int64_t sum[4] = {0}, sum2[4] = {0};
 186     int32_t pixelcount[4] = {0};
 187     int i, plane, vsub = desc->log2_chroma_h;
 188
 189     for (plane = 0; plane < 4 && s->calculate_checksums && frame->data[plane] && frame->linesize[plane]; plane++) {
 190         uint8_t *data = frame->data[plane];
 191         int h = plane == 1 || plane == 2 ? AV_CEIL_RSHIFT(inlink->h, vsub) : inlink->h;
 192         int linesize = av_image_get_linesize(frame->format, frame->width, plane);
 193
 194         if (linesize < 0)
 195             return linesize;
 196
 197         for (i = 0; i < h; i++) {
 198             plane_checksum[plane] = av_adler32_update(plane_checksum[plane], data, linesize);
 199             checksum = av_adler32_update(checksum, data, linesize);
 200
 201             update_sample_stats(data, linesize, sum+plane, sum2+plane);
 202             pixelcount[plane] += linesize;
 203             data += frame->linesize[plane];
 204         }
 205     }
 206
 207     av_log(ctx, AV_LOG_INFO,
 208            "n:%4"PRId64" pts:%7s pts_time:%-7s pos:%9"PRId64" "
 209            "fmt:%s sar:%d/%d s:%dx%d i:%c iskey:%d type:%c ",
 210            inlink->frame_count_out,
 211            av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base), frame->pkt_pos,
 212            desc->name,
 213            frame->sample_aspect_ratio.num, frame->sample_aspect_ratio.den,
 214            frame->width, frame->height,
 215            !frame->interlaced_frame ? 'P' :         /* Progressive  */
 216            frame->top_field_first   ? 'T' : 'B',    /* Top / Bottom */
 217            frame->key_frame,
 218            av_get_picture_type_char(frame->pict_type));
 219
 220     if (s->calculate_checksums) {
 221         av_log(ctx, AV_LOG_INFO,
 222                "checksum:%08"PRIX32" plane_checksum:[%08"PRIX32,
 223                checksum, plane_checksum[0]);
 224
 225         for (plane = 1; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
 226             av_log(ctx, AV_LOG_INFO, " %08"PRIX32, plane_checksum[plane]);
 227         av_log(ctx, AV_LOG_INFO, "] mean:[");
 228         for (plane = 0; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
 229             av_log(ctx, AV_LOG_INFO, "%"PRId64" ", (sum[plane] + pixelcount[plane]/2) / pixelcount[plane]);
 230         av_log(ctx, AV_LOG_INFO, "\b] stdev:[");
 231         for (plane = 0; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
 232             av_log(ctx, AV_LOG_INFO, "%3.1f ",
 233                    sqrt((sum2[plane] - sum[plane]*(double)sum[plane]/pixelcount[plane])/pixelcount[plane]));
 234         av_log(ctx, AV_LOG_INFO, "\b]");
 235     }
 236     av_log(ctx, AV_LOG_INFO, "\n");
 237
 238     for (i = 0; i < frame->nb_side_data; i++) {
 239         AVFrameSideData *sd = frame->side_data[i];
 240
 241         av_log(ctx, AV_LOG_INFO, "  side data - ");
 242         switch (sd->type) {
 243         case AV_FRAME_DATA_PANSCAN:
 244             av_log(ctx, AV_LOG_INFO, "pan/scan");
 245             break;
 246         case AV_FRAME_DATA_A53_CC:
 247             av_log(ctx, AV_LOG_INFO, "A/53 closed captions (%d bytes)", sd->size);
 248             break;
 249         case AV_FRAME_DATA_SPHERICAL:
 250             dump_spherical(ctx, frame, sd);
 251             break;
 252         case AV_FRAME_DATA_STEREO3D:
 253             dump_stereo3d(ctx, sd);
 254             break;
 255         case AV_FRAME_DATA_S12M_TIMECODE: {
 256             uint32_t *tc = (uint32_t*)sd->data;
 257             for (int j = 1; j <= tc[0]; j++) {
 258                 char tcbuf[AV_TIMECODE_STR_SIZE];
 259                 av_timecode_make_smpte_tc_string(tcbuf, tc[j], 0);
 260                 av_log(ctx, AV_LOG_INFO, "timecode - %s%s", tcbuf, j != tc[0] ? ", " : "");
 261             }
 262             break;
 263         }
 264         case AV_FRAME_DATA_DISPLAYMATRIX:
 265             av_log(ctx, AV_LOG_INFO, "displaymatrix: rotation of %.2f degrees",
 266                    av_display_rotation_get((int32_t *)sd->data));
 267             break;
 268         case AV_FRAME_DATA_AFD:
 269             av_log(ctx, AV_LOG_INFO, "afd: value of %"PRIu8, sd->data[0]);
 270             break;
 271         case AV_FRAME_DATA_REGIONS_OF_INTEREST:
 272             dump_roi(ctx, sd);
 273             break;
 274         default:
 275             av_log(ctx, AV_LOG_WARNING, "unknown side data type %d (%d bytes)",
 276                    sd->type, sd->size);
 277             break;
 278         }
 279
 280         av_log(ctx, AV_LOG_INFO, "\n");
 281     }
 282
 283     dump_color_property(ctx, frame);
 284
 285     return ff_filter_frame(inlink->dst->outputs[0], frame);
 286 }
 287
 288 static int config_props(AVFilterContext *ctx, AVFilterLink *link, int is_out)
 289 {
 290
 291     av_log(ctx, AV_LOG_INFO, "config %s time_base: %d/%d, frame_rate: %d/%d\n",
 292            is_out ? "out" : "in",
 293            link->time_base.num, link->time_base.den,
 294            link->frame_rate.num, link->frame_rate.den);
 295
 296     return 0;
 297 }
 298
 299 static int config_props_in(AVFilterLink *link)
 300 {
 301     AVFilterContext *ctx = link->dst;
 302     return config_props(ctx, link, 0);
 303 }
 304
 305 static int config_props_out(AVFilterLink *link)
 306 {
 307     AVFilterContext *ctx = link->src;
 308     return config_props(ctx, link, 1);
 309 }
 310
 311 static const AVFilterPad avfilter_vf_showinfo_inputs[] = {
 312     {
 313         .name             = "default",
 314         .type             = AVMEDIA_TYPE_VIDEO,
 315         .filter_frame     = filter_frame,
 316         .config_props     = config_props_in,
 317     },
 318     { NULL }
 319 };
 320
 321 static const AVFilterPad avfilter_vf_showinfo_outputs[] = {
 322     {
 323         .name = "default",
 324         .type = AVMEDIA_TYPE_VIDEO,
 325         .config_props  = config_props_out,
 326     },
 327     { NULL }
 328 };
 329
 330 AVFilter ff_vf_showinfo = {
 331     .name        = "showinfo",
 332     .description = NULL_IF_CONFIG_SMALL("Show textual information for each video frame."),
 333     .inputs      = avfilter_vf_showinfo_inputs,
 334     .outputs     = avfilter_vf_showinfo_outputs,
 335     .priv_size   = sizeof(ShowInfoContext),
 336     .priv_class  = &showinfo_class,
 337 };