2 * Copyright (c) 2011 Stefano Sabatini
3 * This file is part of FFmpeg.
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.
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.
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
22 * filter for showing textual video frame information
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"
42 typedef struct ShowInfoContext {
44 int calculate_checksums;
47 #define OFFSET(x) offsetof(ShowInfoContext, x)
48 #define VF AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
50 static const AVOption showinfo_options[] = {
51 { "checksum", "calculate checksums", OFFSET(calculate_checksums), AV_OPT_TYPE_BOOL, {.i64=1}, 0, 1, VF },
55 AVFILTER_DEFINE_CLASS(showinfo);
57 static void dump_spherical(AVFilterContext *ctx, AVFrame *frame, AVFrameSideData *sd)
59 AVSphericalMapping *spherical = (AVSphericalMapping *)sd->data;
60 double yaw, pitch, roll;
62 av_log(ctx, AV_LOG_INFO, "spherical information: ");
63 if (sd->size < sizeof(*spherical)) {
64 av_log(ctx, AV_LOG_INFO, "invalid data");
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 ");
75 av_log(ctx, AV_LOG_WARNING, "unknown");
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);
84 if (spherical->projection == AV_SPHERICAL_EQUIRECTANGULAR_TILE) {
86 av_spherical_tile_bounds(spherical, frame->width, frame->height,
88 av_log(ctx, AV_LOG_INFO,
89 "[%"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER", %"SIZE_SPECIFIER"] ",
91 } else if (spherical->projection == AV_SPHERICAL_CUBEMAP) {
92 av_log(ctx, AV_LOG_INFO, "[pad %"PRIu32"] ", spherical->padding);
96 static void dump_stereo3d(AVFilterContext *ctx, AVFrameSideData *sd)
100 av_log(ctx, AV_LOG_INFO, "stereoscopic information: ");
101 if (sd->size < sizeof(*stereo)) {
102 av_log(ctx, AV_LOG_INFO, "invalid data");
106 stereo = (AVStereo3D *)sd->data;
108 av_log(ctx, AV_LOG_INFO, "type - %s", av_stereo3d_type_name(stereo->type));
110 if (stereo->flags & AV_STEREO3D_FLAG_INVERT)
111 av_log(ctx, AV_LOG_INFO, " (inverted)");
114 static void dump_color_property(AVFilterContext *ctx, AVFrame *frame)
116 const char *color_range_str = av_color_range_name(frame->color_range);
117 const char *colorspace_str = av_color_space_name(frame->colorspace);
118 const char *color_primaries_str = av_color_primaries_name(frame->color_primaries);
119 const char *color_trc_str = av_color_transfer_name(frame->color_trc);
121 if (!color_range_str || frame->color_range == AVCOL_RANGE_UNSPECIFIED) {
122 av_log(ctx, AV_LOG_INFO, "color_range:unknown");
124 av_log(ctx, AV_LOG_INFO, "color_range:%s", color_range_str);
127 if (!colorspace_str || frame->colorspace == AVCOL_SPC_UNSPECIFIED) {
128 av_log(ctx, AV_LOG_INFO, " color_space:unknown");
130 av_log(ctx, AV_LOG_INFO, " color_space:%s", colorspace_str);
133 if (!color_primaries_str || frame->color_primaries == AVCOL_PRI_UNSPECIFIED) {
134 av_log(ctx, AV_LOG_INFO, " color_primaries:unknown");
136 av_log(ctx, AV_LOG_INFO, " color_primaries:%s", color_primaries_str);
139 if (!color_trc_str || frame->color_trc == AVCOL_TRC_UNSPECIFIED) {
140 av_log(ctx, AV_LOG_INFO, " color_trc:unknown");
142 av_log(ctx, AV_LOG_INFO, " color_trc:%s", color_trc_str);
144 av_log(ctx, AV_LOG_INFO, "\n");
147 static void update_sample_stats(const uint8_t *src, int len, int64_t *sum, int64_t *sum2)
151 for (i = 0; i < len; i++) {
153 *sum2 += src[i] * src[i];
157 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
159 AVFilterContext *ctx = inlink->dst;
160 ShowInfoContext *s = ctx->priv;
161 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
162 uint32_t plane_checksum[4] = {0}, checksum = 0;
163 int64_t sum[4] = {0}, sum2[4] = {0};
164 int32_t pixelcount[4] = {0};
165 int i, plane, vsub = desc->log2_chroma_h;
167 for (plane = 0; plane < 4 && s->calculate_checksums && frame->data[plane] && frame->linesize[plane]; plane++) {
168 uint8_t *data = frame->data[plane];
169 int h = plane == 1 || plane == 2 ? AV_CEIL_RSHIFT(inlink->h, vsub) : inlink->h;
170 int linesize = av_image_get_linesize(frame->format, frame->width, plane);
175 for (i = 0; i < h; i++) {
176 plane_checksum[plane] = av_adler32_update(plane_checksum[plane], data, linesize);
177 checksum = av_adler32_update(checksum, data, linesize);
179 update_sample_stats(data, linesize, sum+plane, sum2+plane);
180 pixelcount[plane] += linesize;
181 data += frame->linesize[plane];
185 av_log(ctx, AV_LOG_INFO,
186 "n:%4"PRId64" pts:%7s pts_time:%-7s pos:%9"PRId64" "
187 "fmt:%s sar:%d/%d s:%dx%d i:%c iskey:%d type:%c ",
188 inlink->frame_count_out,
189 av_ts2str(frame->pts), av_ts2timestr(frame->pts, &inlink->time_base), frame->pkt_pos,
191 frame->sample_aspect_ratio.num, frame->sample_aspect_ratio.den,
192 frame->width, frame->height,
193 !frame->interlaced_frame ? 'P' : /* Progressive */
194 frame->top_field_first ? 'T' : 'B', /* Top / Bottom */
196 av_get_picture_type_char(frame->pict_type));
198 if (s->calculate_checksums) {
199 av_log(ctx, AV_LOG_INFO,
200 "checksum:%08"PRIX32" plane_checksum:[%08"PRIX32,
201 checksum, plane_checksum[0]);
203 for (plane = 1; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
204 av_log(ctx, AV_LOG_INFO, " %08"PRIX32, plane_checksum[plane]);
205 av_log(ctx, AV_LOG_INFO, "] mean:[");
206 for (plane = 0; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
207 av_log(ctx, AV_LOG_INFO, "%"PRId64" ", (sum[plane] + pixelcount[plane]/2) / pixelcount[plane]);
208 av_log(ctx, AV_LOG_INFO, "\b] stdev:[");
209 for (plane = 0; plane < 4 && frame->data[plane] && frame->linesize[plane]; plane++)
210 av_log(ctx, AV_LOG_INFO, "%3.1f ",
211 sqrt((sum2[plane] - sum[plane]*(double)sum[plane]/pixelcount[plane])/pixelcount[plane]));
212 av_log(ctx, AV_LOG_INFO, "\b]");
214 av_log(ctx, AV_LOG_INFO, "\n");
216 for (i = 0; i < frame->nb_side_data; i++) {
217 AVFrameSideData *sd = frame->side_data[i];
219 av_log(ctx, AV_LOG_INFO, " side data - ");
221 case AV_FRAME_DATA_PANSCAN:
222 av_log(ctx, AV_LOG_INFO, "pan/scan");
224 case AV_FRAME_DATA_A53_CC:
225 av_log(ctx, AV_LOG_INFO, "A/53 closed captions (%d bytes)", sd->size);
227 case AV_FRAME_DATA_SPHERICAL:
228 dump_spherical(ctx, frame, sd);
230 case AV_FRAME_DATA_STEREO3D:
231 dump_stereo3d(ctx, sd);
233 case AV_FRAME_DATA_S12M_TIMECODE: {
234 uint32_t *tc = (uint32_t*)sd->data;
235 for (int j = 1; j <= tc[0]; j++) {
236 char tcbuf[AV_TIMECODE_STR_SIZE];
237 av_timecode_make_smpte_tc_string(tcbuf, tc[j], 0);
238 av_log(ctx, AV_LOG_INFO, "timecode - %s%s", tcbuf, j != tc[0] ? ", " : "");
242 case AV_FRAME_DATA_DISPLAYMATRIX:
243 av_log(ctx, AV_LOG_INFO, "displaymatrix: rotation of %.2f degrees",
244 av_display_rotation_get((int32_t *)sd->data));
246 case AV_FRAME_DATA_AFD:
247 av_log(ctx, AV_LOG_INFO, "afd: value of %"PRIu8, sd->data[0]);
250 av_log(ctx, AV_LOG_WARNING, "unknown side data type %d (%d bytes)",
255 av_log(ctx, AV_LOG_INFO, "\n");
258 dump_color_property(ctx, frame);
260 return ff_filter_frame(inlink->dst->outputs[0], frame);
263 static int config_props(AVFilterContext *ctx, AVFilterLink *link, int is_out)
266 av_log(ctx, AV_LOG_INFO, "config %s time_base: %d/%d, frame_rate: %d/%d\n",
267 is_out ? "out" : "in",
268 link->time_base.num, link->time_base.den,
269 link->frame_rate.num, link->frame_rate.den);
274 static int config_props_in(AVFilterLink *link)
276 AVFilterContext *ctx = link->dst;
277 return config_props(ctx, link, 0);
280 static int config_props_out(AVFilterLink *link)
282 AVFilterContext *ctx = link->src;
283 return config_props(ctx, link, 1);
286 static const AVFilterPad avfilter_vf_showinfo_inputs[] = {
289 .type = AVMEDIA_TYPE_VIDEO,
290 .filter_frame = filter_frame,
291 .config_props = config_props_in,
296 static const AVFilterPad avfilter_vf_showinfo_outputs[] = {
299 .type = AVMEDIA_TYPE_VIDEO,
300 .config_props = config_props_out,
305 AVFilter ff_vf_showinfo = {
307 .description = NULL_IF_CONFIG_SMALL("Show textual information for each video frame."),
308 .inputs = avfilter_vf_showinfo_inputs,
309 .outputs = avfilter_vf_showinfo_outputs,
310 .priv_size = sizeof(ShowInfoContext),
311 .priv_class = &showinfo_class,