[deb_ffmpeg.git] / ffmpeg / libavfilter / vf_codecview.c

/*
 * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
 * Copyright (c) 2014 Clément Bœsch <u pkh me>
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * @file
 * Codec debug viewer filter.
 *
 * All the MV drawing code from Michael Niedermayer is extracted from
 * libavcodec/mpegvideo.c.
 *
 * TODO: segmentation
 * TODO: quantization
 */

#include "libavutil/imgutils.h"
#include "libavutil/motion_vector.h"
#include "libavutil/opt.h"
#include "avfilter.h"
#include "internal.h"

#define MV_P_FOR  (1<<0)
#define MV_B_FOR  (1<<1)
#define MV_B_BACK (1<<2)

typedef struct {
    const AVClass *class;
    unsigned mv;
} CodecViewContext;

#define OFFSET(x) offsetof(CodecViewContext, x)
#define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
static const AVOption codecview_options[] = {
    { "mv", "set motion vectors to visualize", OFFSET(mv), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, INT_MAX, FLAGS, "mv" },
        {"pf", "forward predicted MVs of P-frames",  0, AV_OPT_TYPE_CONST, {.i64 = MV_P_FOR },  INT_MIN, INT_MAX, FLAGS, "mv"},
        {"bf", "forward predicted MVs of B-frames",  0, AV_OPT_TYPE_CONST, {.i64 = MV_B_FOR },  INT_MIN, INT_MAX, FLAGS, "mv"},
        {"bb", "backward predicted MVs of B-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_B_BACK }, INT_MIN, INT_MAX, FLAGS, "mv"},
    { NULL }
};

AVFILTER_DEFINE_CLASS(codecview);

static int query_formats(AVFilterContext *ctx)
{
    // TODO: we can probably add way more pixel formats without any other
    // changes; anything with 8-bit luma in first plane should be working
    static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE};
    ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
    return 0;
}

static int clip_line(int *sx, int *sy, int *ex, int *ey, int maxx)
{
    if(*sx > *ex)
        return clip_line(ex, ey, sx, sy, maxx);

    if (*sx < 0) {
        if (*ex < 0)
            return 1;
        *sy = *ey + (*sy - *ey) * (int64_t)*ex / (*ex - *sx);
        *sx = 0;
    }

    if (*ex > maxx) {
        if (*sx > maxx)
            return 1;
        *ey = *sy + (*ey - *sy) * (int64_t)(maxx - *sx) / (*ex - *sx);
        *ex = maxx;
    }
    return 0;
}

/**
 * Draw a line from (ex, ey) -> (sx, sy).
 * @param w width of the image
 * @param h height of the image
 * @param stride stride/linesize of the image
 * @param color color of the arrow
 */
static void draw_line(uint8_t *buf, int sx, int sy, int ex, int ey,
                      int w, int h, int stride, int color)
{
    int x, y, fr, f;

    if (clip_line(&sx, &sy, &ex, &ey, w - 1))
        return;
    if (clip_line(&sy, &sx, &ey, &ex, h - 1))
        return;

    sx = av_clip(sx, 0, w - 1);
    sy = av_clip(sy, 0, h - 1);
    ex = av_clip(ex, 0, w - 1);
    ey = av_clip(ey, 0, h - 1);

    buf[sy * stride + sx] += color;

    if (FFABS(ex - sx) > FFABS(ey - sy)) {
        if (sx > ex) {
            FFSWAP(int, sx, ex);
            FFSWAP(int, sy, ey);
        }
        buf += sx + sy * stride;
        ex  -= sx;
        f    = ((ey - sy) << 16) / ex;
        for (x = 0; x <= ex; x++) {
            y  = (x * f) >> 16;
            fr = (x * f) & 0xFFFF;
                   buf[ y      * stride + x] += (color * (0x10000 - fr)) >> 16;
            if(fr) buf[(y + 1) * stride + x] += (color *            fr ) >> 16;
        }
    } else {
        if (sy > ey) {
            FFSWAP(int, sx, ex);
            FFSWAP(int, sy, ey);
        }
        buf += sx + sy * stride;
        ey  -= sy;
        if (ey)
            f = ((ex - sx) << 16) / ey;
        else
            f = 0;
        for(y= 0; y <= ey; y++){
            x  = (y*f) >> 16;
            fr = (y*f) & 0xFFFF;
                   buf[y * stride + x    ] += (color * (0x10000 - fr)) >> 16;
            if(fr) buf[y * stride + x + 1] += (color *            fr ) >> 16;
        }
    }
}

/**
 * Draw an arrow from (ex, ey) -> (sx, sy).
 * @param w width of the image
 * @param h height of the image
 * @param stride stride/linesize of the image
 * @param color color of the arrow
 */
static void draw_arrow(uint8_t *buf, int sx, int sy, int ex,
                       int ey, int w, int h, int stride, int color, int tail, int direction)
{
    int dx,dy;

    if (direction) {
        FFSWAP(int, sx, ex);
        FFSWAP(int, sy, ey);
    }

    sx = av_clip(sx, -100, w + 100);
    sy = av_clip(sy, -100, h + 100);
    ex = av_clip(ex, -100, w + 100);
    ey = av_clip(ey, -100, h + 100);

    dx = ex - sx;
    dy = ey - sy;

    if (dx * dx + dy * dy > 3 * 3) {
        int rx =  dx + dy;
        int ry = -dx + dy;
        int length = sqrt((rx * rx + ry * ry) << 8);

        // FIXME subpixel accuracy
        rx = ROUNDED_DIV(rx * 3 << 4, length);
        ry = ROUNDED_DIV(ry * 3 << 4, length);

        if (tail) {
            rx = -rx;
            ry = -ry;
        }

        draw_line(buf, sx, sy, sx + rx, sy + ry, w, h, stride, color);
        draw_line(buf, sx, sy, sx - ry, sy + rx, w, h, stride, color);
    }
    draw_line(buf, sx, sy, ex, ey, w, h, stride, color);
}

static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
{
    AVFilterContext *ctx = inlink->dst;
    CodecViewContext *s = ctx->priv;
    AVFilterLink *outlink = ctx->outputs[0];

    AVFrameSideData *sd = av_frame_get_side_data(frame, AV_FRAME_DATA_MOTION_VECTORS);
    if (sd) {
        int i;
        const AVMotionVector *mvs = (const AVMotionVector *)sd->data;
        for (i = 0; i < sd->size / sizeof(*mvs); i++) {
            const AVMotionVector *mv = &mvs[i];
            const int direction = mv->source > 0;
            if ((direction == 0 && (s->mv & MV_P_FOR)  && frame->pict_type == AV_PICTURE_TYPE_P) ||
                (direction == 0 && (s->mv & MV_B_FOR)  && frame->pict_type == AV_PICTURE_TYPE_B) ||
                (direction == 1 && (s->mv & MV_B_BACK) && frame->pict_type == AV_PICTURE_TYPE_B))
                draw_arrow(frame->data[0], mv->dst_x, mv->dst_y, mv->src_x, mv->src_y,
                           frame->width, frame->height, frame->linesize[0],
                           100, 0, mv->source > 0);
        }
    }
    return ff_filter_frame(outlink, frame);
}

static const AVFilterPad codecview_inputs[] = {
    {
        .name           = "default",
        .type           = AVMEDIA_TYPE_VIDEO,
        .filter_frame   = filter_frame,
        .needs_writable = 1,
     },
     { NULL }
};

static const AVFilterPad codecview_outputs[] = {
     {
         .name = "default",
         .type = AVMEDIA_TYPE_VIDEO,
     },
     { NULL }
};

AVFilter ff_vf_codecview = {
    .name          = "codecview",
    .description   = NULL_IF_CONFIG_SMALL("Visualize information about some codecs"),
    .priv_size     = sizeof(CodecViewContext),
    .query_formats = query_formats,
    .inputs        = codecview_inputs,
    .outputs       = codecview_outputs,
    .priv_class    = &codecview_class,
    .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
};
Commit	Line	Data
2ba45a60 DM	1	/*
	2	* Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
	3	* Copyright (c) 2014 Clément Bœsch <u pkh me>
	4	*
	5	* This file is part of FFmpeg.
	6	*
	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.
	11	*
	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.
	16	*
	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
	20	*/
	21
	22	/**
	23	* @file
	24	* Codec debug viewer filter.
	25	*
	26	* All the MV drawing code from Michael Niedermayer is extracted from
	27	* libavcodec/mpegvideo.c.
	28	*
	29	* TODO: segmentation
	30	* TODO: quantization
	31	*/
	32
	33	#include "libavutil/imgutils.h"
	34	#include "libavutil/motion_vector.h"
	35	#include "libavutil/opt.h"
	36	#include "avfilter.h"
	37	#include "internal.h"
	38
	39	#define MV_P_FOR (1<<0)
	40	#define MV_B_FOR (1<<1)
	41	#define MV_B_BACK (1<<2)
	42
	43	typedef struct {
	44	const AVClass *class;
	45	unsigned mv;
	46	} CodecViewContext;
	47
	48	#define OFFSET(x) offsetof(CodecViewContext, x)
	49	#define FLAGS AV_OPT_FLAG_FILTERING_PARAM\|AV_OPT_FLAG_VIDEO_PARAM
	50	static const AVOption codecview_options[] = {
	51	{ "mv", "set motion vectors to visualize", OFFSET(mv), AV_OPT_TYPE_FLAGS, {.i64=0}, 0, INT_MAX, FLAGS, "mv" },
	52	{"pf", "forward predicted MVs of P-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_P_FOR }, INT_MIN, INT_MAX, FLAGS, "mv"},
	53	{"bf", "forward predicted MVs of B-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_B_FOR }, INT_MIN, INT_MAX, FLAGS, "mv"},
	54	{"bb", "backward predicted MVs of B-frames", 0, AV_OPT_TYPE_CONST, {.i64 = MV_B_BACK }, INT_MIN, INT_MAX, FLAGS, "mv"},
	55	{ NULL }
	56	};
	57
	58	AVFILTER_DEFINE_CLASS(codecview);
	59
	60	static int query_formats(AVFilterContext *ctx)
	61	{
	62	// TODO: we can probably add way more pixel formats without any other
	63	// changes; anything with 8-bit luma in first plane should be working
	64	static const enum AVPixelFormat pix_fmts[] = {AV_PIX_FMT_YUV420P, AV_PIX_FMT_NONE};
65	ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
66	return 0;
67	}
68
69	static int clip_line(int sx, int sy, int ex, int ey, int maxx)
70	{
71	if(sx > ex)
72	return clip_line(ex, ey, sx, sy, maxx);
73
74	if (*sx < 0) {
75	if (*ex < 0)
76	return 1;
77	sy = ey + (sy - ey) * (int64_t)ex / (ex - *sx);
78	*sx = 0;
79	}
80
81	if (*ex > maxx) {
82	if (*sx > maxx)
83	return 1;
84	ey = sy + (ey - sy) * (int64_t)(maxx - sx) / (ex - *sx);
85	*ex = maxx;
86	}
87	return 0;
88	}
89
90	/**
91	* Draw a line from (ex, ey) -> (sx, sy).
92	* @param w width of the image
93	* @param h height of the image
94	* @param stride stride/linesize of the image
95	* @param color color of the arrow
96	*/
97	static void draw_line(uint8_t *buf, int sx, int sy, int ex, int ey,
98	int w, int h, int stride, int color)
99	{
100	int x, y, fr, f;
101
102	if (clip_line(&sx, &sy, &ex, &ey, w - 1))
103	return;
104	if (clip_line(&sy, &sx, &ey, &ex, h - 1))
105	return;
106
107	sx = av_clip(sx, 0, w - 1);
108	sy = av_clip(sy, 0, h - 1);
109	ex = av_clip(ex, 0, w - 1);
110	ey = av_clip(ey, 0, h - 1);
111
112	buf[sy * stride + sx] += color;
113
114	if (FFABS(ex - sx) > FFABS(ey - sy)) {
115	if (sx > ex) {
116	FFSWAP(int, sx, ex);
117	FFSWAP(int, sy, ey);
118	}
119	buf += sx + sy * stride;
120	ex -= sx;
121	f = ((ey - sy) << 16) / ex;
122	for (x = 0; x <= ex; x++) {
123	y = (x * f) >> 16;
124	fr = (x * f) & 0xFFFF;
125	buf[ y * stride + x] += (color * (0x10000 - fr)) >> 16;
126	if(fr) buf[(y + 1) * stride + x] += (color * fr ) >> 16;
127	}
128	} else {
129	if (sy > ey) {
130	FFSWAP(int, sx, ex);
131	FFSWAP(int, sy, ey);
132	}
133	buf += sx + sy * stride;
134	ey -= sy;
135	if (ey)
136	f = ((ex - sx) << 16) / ey;
137	else
138	f = 0;
139	for(y= 0; y <= ey; y++){
140	x = (y*f) >> 16;
141	fr = (y*f) & 0xFFFF;
142	buf[y * stride + x ] += (color * (0x10000 - fr)) >> 16;
143	if(fr) buf[y * stride + x + 1] += (color * fr ) >> 16;
144	}
145	}
146	}
147
148	/**
149	* Draw an arrow from (ex, ey) -> (sx, sy).
150	* @param w width of the image
151	* @param h height of the image
152	* @param stride stride/linesize of the image
153	* @param color color of the arrow
154	*/
155	static void draw_arrow(uint8_t *buf, int sx, int sy, int ex,
156	int ey, int w, int h, int stride, int color, int tail, int direction)
157	{
158	int dx,dy;
159
160	if (direction) {
161	FFSWAP(int, sx, ex);
162	FFSWAP(int, sy, ey);
163	}
164
165	sx = av_clip(sx, -100, w + 100);
166	sy = av_clip(sy, -100, h + 100);
167	ex = av_clip(ex, -100, w + 100);
168	ey = av_clip(ey, -100, h + 100);
169
170	dx = ex - sx;
171	dy = ey - sy;
172
173	if (dx * dx + dy * dy > 3 * 3) {
174	int rx = dx + dy;
175	int ry = -dx + dy;
176	int length = sqrt((rx * rx + ry * ry) << 8);
177
178	// FIXME subpixel accuracy
179	rx = ROUNDED_DIV(rx * 3 << 4, length);
180	ry = ROUNDED_DIV(ry * 3 << 4, length);
181
182	if (tail) {
183	rx = -rx;
184	ry = -ry;
185	}
186
187	draw_line(buf, sx, sy, sx + rx, sy + ry, w, h, stride, color);
188	draw_line(buf, sx, sy, sx - ry, sy + rx, w, h, stride, color);
189	}
190	draw_line(buf, sx, sy, ex, ey, w, h, stride, color);
191	}
192
193	static int filter_frame(AVFilterLink inlink, AVFrame frame)
194	{
195	AVFilterContext *ctx = inlink->dst;
196	CodecViewContext *s = ctx->priv;
197	AVFilterLink *outlink = ctx->outputs[0];
198
199	AVFrameSideData *sd = av_frame_get_side_data(frame, AV_FRAME_DATA_MOTION_VECTORS);
200	if (sd) {
201	int i;
202	const AVMotionVector mvs = (const AVMotionVector )sd->data;
203	for (i = 0; i < sd->size / sizeof(*mvs); i++) {
204	const AVMotionVector *mv = &mvs[i];
205	const int direction = mv->source > 0;
206	if ((direction == 0 && (s->mv & MV_P_FOR) && frame->pict_type == AV_PICTURE_TYPE_P) \|\|
207	(direction == 0 && (s->mv & MV_B_FOR) && frame->pict_type == AV_PICTURE_TYPE_B) \|\|
208	(direction == 1 && (s->mv & MV_B_BACK) && frame->pict_type == AV_PICTURE_TYPE_B))
209	draw_arrow(frame->data[0], mv->dst_x, mv->dst_y, mv->src_x, mv->src_y,
210	frame->width, frame->height, frame->linesize[0],
211	100, 0, mv->source > 0);
212	}
213	}
214	return ff_filter_frame(outlink, frame);
215	}
216
217	static const AVFilterPad codecview_inputs[] = {
218	{
219	.name = "default",
220	.type = AVMEDIA_TYPE_VIDEO,
221	.filter_frame = filter_frame,
222	.needs_writable = 1,
223	},
224	{ NULL }
225	};
226
227	static const AVFilterPad codecview_outputs[] = {
228	{
229	.name = "default",
230	.type = AVMEDIA_TYPE_VIDEO,
231	},
232	{ NULL }
233	};
234
235	AVFilter ff_vf_codecview = {
236	.name = "codecview",
237	.description = NULL_IF_CONFIG_SMALL("Visualize information about some codecs"),
238	.priv_size = sizeof(CodecViewContext),
239	.query_formats = query_formats,
240	.inputs = codecview_inputs,
241	.outputs = codecview_outputs,
242	.priv_class = &codecview_class,
243	.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC,
244	};