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