2 * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
3 * Copyright (c) 2014 Clément Bœsch <u pkh me>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Codec debug viewer filter.
26 * All the MV drawing code from Michael Niedermayer is extracted from
27 * libavcodec/mpegvideo.c.
32 #include "libavutil/imgutils.h"
33 #include "libavutil/motion_vector.h"
34 #include "libavutil/opt.h"
38 #define MV_P_FOR (1<<0)
39 #define MV_B_FOR (1<<1)
40 #define MV_B_BACK (1<<2)
49 #define OFFSET(x) offsetof(CodecViewContext, x)
50 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
51 static const AVOption codecview_options[] = {
52 { "mv", "set motion vectors to visualize", OFFSET(mv), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, INT_MAX, FLAGS, "mv" },
53 {"pf", "forward predicted MVs of P-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_P_FOR }, INT_MIN, INT_MAX, FLAGS, "mv"},
54 {"bf", "forward predicted MVs of B-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_B_FOR }, INT_MIN, INT_MAX, FLAGS, "mv"},
55 {"bb", "backward predicted MVs of B-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_B_BACK }, INT_MIN, INT_MAX, FLAGS, "mv"},
56 { "qp", NULL, OFFSET(qp), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, .flags = FLAGS },
60 AVFILTER_DEFINE_CLASS(codecview);
62 static int query_formats(AVFilterContext *ctx)
64 // TODO: we can probably add way more pixel formats without any other
65 // changes; anything with 8-bit luma in first plane should be working
66 static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE};
67 AVFilterFormats *fmts_list = ff_make_format_list(pix_fmts);
69 return AVERROR(ENOMEM);
70 return ff_set_common_formats(ctx, fmts_list);
73 static int clip_line(int *sx, int *sy, int *ex, int *ey, int maxx)
76 return clip_line(ex, ey, sx, sy, maxx);
81 *sy = *ey + (*sy - *ey) * (int64_t)*ex / (*ex - *sx);
88 *ey = *sy + (*ey - *sy) * (int64_t)(maxx - *sx) / (*ex - *sx);
95 * Draw a line from (ex, ey) -> (sx, sy).
96 * @param w width of the image
97 * @param h height of the image
98 * @param stride stride/linesize of the image
99 * @param color color of the arrow
101 static void draw_line(uint8_t *buf, int sx, int sy, int ex, int ey,
102 int w, int h, int stride, int color)
106 if (clip_line(&sx, &sy, &ex, &ey, w - 1))
108 if (clip_line(&sy, &sx, &ey, &ex, h - 1))
111 sx = av_clip(sx, 0, w - 1);
112 sy = av_clip(sy, 0, h - 1);
113 ex = av_clip(ex, 0, w - 1);
114 ey = av_clip(ey, 0, h - 1);
116 buf[sy * stride + sx] += color;
118 if (FFABS(ex - sx) > FFABS(ey - sy)) {
123 buf += sx + sy * stride;
125 f = ((ey - sy) << 16) / ex;
126 for (x = 0; x <= ex; x++) {
128 fr = (x * f) & 0xFFFF;
129 buf[ y * stride + x] += (color * (0x10000 - fr)) >> 16;
130 if(fr) buf[(y + 1) * stride + x] += (color * fr ) >> 16;
137 buf += sx + sy * stride;
140 f = ((ex - sx) << 16) / ey;
143 for(y= 0; y <= ey; y++){
146 buf[y * stride + x ] += (color * (0x10000 - fr)) >> 16;
147 if(fr) buf[y * stride + x + 1] += (color * fr ) >> 16;
153 * Draw an arrow from (ex, ey) -> (sx, sy).
154 * @param w width of the image
155 * @param h height of the image
156 * @param stride stride/linesize of the image
157 * @param color color of the arrow
159 static void draw_arrow(uint8_t *buf, int sx, int sy, int ex,
160 int ey, int w, int h, int stride, int color, int tail, int direction)
169 sx = av_clip(sx, -100, w + 100);
170 sy = av_clip(sy, -100, h + 100);
171 ex = av_clip(ex, -100, w + 100);
172 ey = av_clip(ey, -100, h + 100);
177 if (dx * dx + dy * dy > 3 * 3) {
180 int length = sqrt((rx * rx + ry * ry) << 8);
182 // FIXME subpixel accuracy
183 rx = ROUNDED_DIV(rx * 3 << 4, length);
184 ry = ROUNDED_DIV(ry * 3 << 4, length);
191 draw_line(buf, sx, sy, sx + rx, sy + ry, w, h, stride, color);
192 draw_line(buf, sx, sy, sx - ry, sy + rx, w, h, stride, color);
194 draw_line(buf, sx, sy, ex, ey, w, h, stride, color);
197 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
199 AVFilterContext *ctx = inlink->dst;
200 CodecViewContext *s = ctx->priv;
201 AVFilterLink *outlink = ctx->outputs[0];
204 int qstride, qp_type;
205 int8_t *qp_table = av_frame_get_qp_table(frame, &qstride, &qp_type);
209 const int w = AV_CEIL_RSHIFT(frame->width, s->hsub);
210 const int h = AV_CEIL_RSHIFT(frame->height, s->vsub);
211 uint8_t *pu = frame->data[1];
212 uint8_t *pv = frame->data[2];
213 const int lzu = frame->linesize[1];
214 const int lzv = frame->linesize[2];
216 for (y = 0; y < h; y++) {
217 for (x = 0; x < w; x++) {
218 const int qp = ff_norm_qscale(qp_table[(y >> 3) * qstride + (x >> 3)], qp_type) * 128/31;
228 AVFrameSideData *sd = av_frame_get_side_data(frame, AV_FRAME_DATA_MOTION_VECTORS);
231 const AVMotionVector *mvs = (const AVMotionVector *)sd->data;
232 for (i = 0; i < sd->size / sizeof(*mvs); i++) {
233 const AVMotionVector *mv = &mvs[i];
234 const int direction = mv->source > 0;
235 if ((direction == 0 && (s->mv & MV_P_FOR) && frame->pict_type == AV_PICTURE_TYPE_P) ||
236 (direction == 0 && (s->mv & MV_B_FOR) && frame->pict_type == AV_PICTURE_TYPE_B) ||
237 (direction == 1 && (s->mv & MV_B_BACK) && frame->pict_type == AV_PICTURE_TYPE_B))
238 draw_arrow(frame->data[0], mv->dst_x, mv->dst_y, mv->src_x, mv->src_y,
239 frame->width, frame->height, frame->linesize[0],
240 100, 0, mv->source > 0);
245 return ff_filter_frame(outlink, frame);
248 static int config_input(AVFilterLink *inlink)
250 AVFilterContext *ctx = inlink->dst;
251 CodecViewContext *s = ctx->priv;
252 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(inlink->format);
254 s->hsub = desc->log2_chroma_w;
255 s->vsub = desc->log2_chroma_h;
259 static const AVFilterPad codecview_inputs[] = {
262 .type = AVMEDIA_TYPE_VIDEO,
263 .filter_frame = filter_frame,
264 .config_props = config_input,
270 static const AVFilterPad codecview_outputs[] = {
273 .type = AVMEDIA_TYPE_VIDEO,
278 AVFilter ff_vf_codecview = {
280 .description = NULL_IF_CONFIG_SMALL("Visualize information about some codecs."),
281 .priv_size = sizeof(CodecViewContext),
282 .query_formats = query_formats,
283 .inputs = codecview_inputs,
284 .outputs = codecview_outputs,
285 .priv_class = &codecview_class,
286 .flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,