FFmpeg coverage

Directory:	../../../ffmpeg/
File:	src/libavfilter/vf_scroll.c
Date:	2025-10-27 14:11:36

	Total	Coverage
Lines:	65	0.0%
Functions:	4	0.0%
Branches:	16	0.0%

  
      Line
      Branch
      Exec
      Source
    
      /*
    
       * Copyright (c) 2019 Paul B Mahol
    
       *
    
       * 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
    
       */
    
      #include "libavutil/common.h"
    
      #include "libavutil/opt.h"
    
      #include "libavutil/pixdesc.h"
    
      #include "avfilter.h"
    
      #include "filters.h"
    
      #include "video.h"
    
      typedef struct ScrollContext {
    
          const AVClass *class;
    
          float h_speed, v_speed;
    
          float h_pos, v_pos;
    
          float h_ipos, v_ipos;
    
          int pos_h[4], pos_v[4];
    
          const AVPixFmtDescriptor *desc;
    
          int nb_planes;
    
          int bytes;
    
          int planewidth[4];
    
          int planeheight[4];
    
      } ScrollContext;
    
      static const enum AVPixelFormat pix_fmts[] = {
    
          AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
    
          AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
    
          AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
    
          AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
    
          AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
    
          AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
    
          AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
    
          AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
    
          AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
    
          AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
    
          AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
    
          AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
    
          AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
    
          AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
    
          AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
    
          AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
    
          AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
    
          AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
    
          AV_PIX_FMT_NONE
    
      };
    
      typedef struct ThreadData {
    
          AVFrame *in, *out;
    
      } ThreadData;
    
      ✗
      static int scroll_slice(AVFilterContext *ctx, void *arg, int jobnr,
    
                              int nb_jobs)
    
      {
    
      ✗
          ScrollContext *s = ctx->priv;
    
      ✗
          ThreadData *td = arg;
    
      ✗
          AVFrame *in = td->in;
    
      ✗
          AVFrame *out = td->out;
    
      ✗
          for (int p = 0; p < s->nb_planes; p++) {
    
      ✗
              const uint8_t *src = in->data[p];
    
      ✗
              const int h = s->planeheight[p];
    
      ✗
              const int w = s->planewidth[p] * s->bytes;
    
      ✗
              const int slice_start = (h * jobnr) / nb_jobs;
    
      ✗
              const int slice_end = (h * (jobnr+1)) / nb_jobs;
    
      ✗
              uint8_t *dst = out->data[p] + slice_start * out->linesize[p];
    
      ✗
              for (int y = slice_start; y < slice_end; y++) {
    
      ✗
                  int yy = (y + s->pos_v[p]) % h;
    
      ✗
                  const uint8_t *ssrc = src + yy * in->linesize[p];
    
      ✗
                  if (s->pos_h[p] < w)
    
      ✗
                      memcpy(dst, ssrc + s->pos_h[p], w - s->pos_h[p]);
    
      ✗
                  if (s->pos_h[p] > 0)
    
      ✗
                      memcpy(dst + w - s->pos_h[p], ssrc, s->pos_h[p]);
    
      ✗
                  dst += out->linesize[p];
    
              }
    
          }
    
      ✗
          return 0;
    
      }
    
      ✗
      static void scroll(AVFilterContext *ctx, AVFrame *in, AVFrame *out)
    
      {
    
      ✗
          ScrollContext *s = ctx->priv;
    
          ThreadData td;
    
          int h_pos, v_pos;
    
      ✗
          s->h_pos = fmodf(s->h_pos, in->width);
    
      ✗
          s->v_pos = fmodf(s->v_pos, in->height);
    
      ✗
          h_pos = s->h_pos;
    
      ✗
          v_pos = s->v_pos;
    
      ✗
          if (h_pos < 0)
    
      ✗
              h_pos += in->width;
    
      ✗
          if (v_pos < 0)
    
      ✗
              v_pos += in->height;
    
      ✗
          s->pos_v[1] = s->pos_v[2] = AV_CEIL_RSHIFT(v_pos, s->desc->log2_chroma_h);
    
      ✗
          s->pos_v[0] = s->pos_v[3] = v_pos;
    
      ✗
          s->pos_h[1] = s->pos_h[2] = AV_CEIL_RSHIFT(h_pos, s->desc->log2_chroma_w) * s->bytes;
    
      ✗
          s->pos_h[0] = s->pos_h[3] = h_pos * s->bytes;
    
      ✗
          td.in = in; td.out = out;
    
      ✗
          ff_filter_execute(ctx, scroll_slice, &td, NULL,
    
      ✗
                            FFMIN(out->height, ff_filter_get_nb_threads(ctx)));
    
      ✗
          s->h_pos += s->h_speed * in->width;
    
      ✗
          s->v_pos += s->v_speed * in->height;
    
      ✗
      }
    
      ✗
      static int filter_frame(AVFilterLink *inlink, AVFrame *in)
    
      {
    
      ✗
          AVFilterContext *ctx = inlink->dst;
    
      ✗
          AVFilterLink *outlink = ctx->outputs[0];
    
          AVFrame *out;
    
      ✗
          out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
    
      ✗
          if (!out) {
    
      ✗
              av_frame_free(&in);
    
      ✗
              return AVERROR(ENOMEM);
    
          }
    
      ✗
          av_frame_copy_props(out, in);
    
      ✗
          scroll(ctx, in, out);
    
      ✗
          av_frame_free(&in);
    
      ✗
          return ff_filter_frame(outlink, out);
    
      }
    
      ✗
      static int config_input(AVFilterLink *inlink)
    
      {
    
      ✗
          AVFilterContext *ctx = inlink->dst;
    
      ✗
          ScrollContext *s = ctx->priv;
    
      ✗
          s->desc = av_pix_fmt_desc_get(inlink->format);
    
      ✗
          s->nb_planes = s->desc->nb_components;
    
      ✗
          s->bytes = (s->desc->comp[0].depth + 7) >> 3;
    
      ✗
          s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, s->desc->log2_chroma_h);
    
      ✗
          s->planeheight[0] = s->planeheight[3] = inlink->h;
    
      ✗
          s->planewidth[1]  = s->planewidth[2]  = AV_CEIL_RSHIFT(inlink->w, s->desc->log2_chroma_w);
    
      ✗
          s->planewidth[0]  = s->planewidth[3]  = inlink->w;
    
      ✗
          s->h_pos = (1.f - s->h_ipos) * inlink->w;
    
      ✗
          s->v_pos = (1.f - s->v_ipos) * inlink->h;
    
      ✗
          return 0;
    
      }
    
      #define OFFSET(x) offsetof(ScrollContext, x)
    
      #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
    
      #define VFT AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
    
      static const AVOption scroll_options[] = {
    
          { "horizontal", "set the horizontal scrolling speed", OFFSET(h_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
    
          { "h",          "set the horizontal scrolling speed", OFFSET(h_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
    
          { "vertical",   "set the vertical scrolling speed",   OFFSET(v_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
    
          { "v",          "set the vertical scrolling speed",   OFFSET(v_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
    
          { "hpos",       "set initial horizontal position",    OFFSET(h_ipos),  AV_OPT_TYPE_FLOAT, {.dbl=0.},   0, 1., FLAGS },
    
          { "vpos",       "set initial vertical position",      OFFSET(v_ipos),  AV_OPT_TYPE_FLOAT, {.dbl=0.},   0, 1., FLAGS },
    
          { NULL }
    
      };
    
      AVFILTER_DEFINE_CLASS(scroll);
    
      static const AVFilterPad scroll_inputs[] = {
    
          {
    
              .name           = "default",
    
              .type           = AVMEDIA_TYPE_VIDEO,
    
              .config_props   = config_input,
    
              .filter_frame   = filter_frame,
    
          },
    
      };
    
      const FFFilter ff_vf_scroll = {
    
          .p.name        = "scroll",
    
          .p.description = NULL_IF_CONFIG_SMALL("Scroll input video."),
    
          .p.priv_class  = &scroll_class,
    
          .p.flags       = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SLICE_THREADS,
    
          .priv_size     = sizeof(ScrollContext),
    
          FILTER_INPUTS(scroll_inputs),
    
          FILTER_OUTPUTS(ff_video_default_filterpad),
    
          FILTER_PIXFMTS_ARRAY(pix_fmts),
    
          .process_command = ff_filter_process_command,
    
      };

Line	Exec	Source
1		/*
2		* Copyright (c) 2019 Paul B Mahol
3		*
4		* This file is part of FFmpeg.
5		*
6		* FFmpeg is free software; you can redistribute it and/or
7		* modify it under the terms of the GNU Lesser General Public
8		* License as published by the Free Software Foundation; either
9		* version 2.1 of the License, or (at your option) any later version.
10		*
11		* FFmpeg is distributed in the hope that it will be useful,
12		* but WITHOUT ANY WARRANTY; without even the implied warranty of
13		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14		* Lesser General Public License for more details.
15		*
16		* You should have received a copy of the GNU Lesser General Public
17		* License along with FFmpeg; if not, write to the Free Software
18		* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19		*/
20
21		#include "libavutil/common.h"
22		#include "libavutil/opt.h"
23		#include "libavutil/pixdesc.h"
24		#include "avfilter.h"
25		#include "filters.h"
26		#include "video.h"
27
28		typedef struct ScrollContext {
29		const AVClass *class;
30
31		float h_speed, v_speed;
32		float h_pos, v_pos;
33		float h_ipos, v_ipos;
34
35		int pos_h[4], pos_v[4];
36
37		const AVPixFmtDescriptor *desc;
38		int nb_planes;
39		int bytes;
40
41		int planewidth[4];
42		int planeheight[4];
43		} ScrollContext;
44
45		static const enum AVPixelFormat pix_fmts[] = {
46		AV_PIX_FMT_YUVA444P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUV440P,
47		AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_YUVJ440P,
48		AV_PIX_FMT_YUVA422P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA420P, AV_PIX_FMT_YUV420P,
49		AV_PIX_FMT_YUVJ422P, AV_PIX_FMT_YUVJ420P,
50		AV_PIX_FMT_YUVJ411P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUV410P,
51		AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9,
52		AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10,
53		AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, AV_PIX_FMT_YUV440P12,
54		AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14,
55		AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16,
56		AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9,
57		AV_PIX_FMT_YUVA422P12, AV_PIX_FMT_YUVA444P12,
58		AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10,
59		AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16,
60		AV_PIX_FMT_GBRP, AV_PIX_FMT_GBRP9, AV_PIX_FMT_GBRP10,
61		AV_PIX_FMT_GBRP12, AV_PIX_FMT_GBRP14, AV_PIX_FMT_GBRP16,
62		AV_PIX_FMT_GBRAP, AV_PIX_FMT_GBRAP10, AV_PIX_FMT_GBRAP12, AV_PIX_FMT_GBRAP16,
63		AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY9, AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, AV_PIX_FMT_GRAY16,
64		AV_PIX_FMT_NONE
65		};
66
67		typedef struct ThreadData {
68		AVFrame in, out;
69		} ThreadData;
70
71	✗	static int scroll_slice(AVFilterContext ctx, void arg, int jobnr,
72		int nb_jobs)
73		{
74	✗	ScrollContext *s = ctx->priv;
75	✗	ThreadData *td = arg;
76	✗	AVFrame *in = td->in;
77	✗	AVFrame *out = td->out;
78
79	✗	for (int p = 0; p < s->nb_planes; p++) {
80	✗	const uint8_t *src = in->data[p];
81	✗	const int h = s->planeheight[p];
82	✗	const int w = s->planewidth[p] * s->bytes;
83	✗	const int slice_start = (h * jobnr) / nb_jobs;
84	✗	const int slice_end = (h * (jobnr+1)) / nb_jobs;
85	✗	uint8_t dst = out->data[p] + slice_start out->linesize[p];
86
87	✗	for (int y = slice_start; y < slice_end; y++) {
88	✗	int yy = (y + s->pos_v[p]) % h;
89	✗	const uint8_t ssrc = src + yy in->linesize[p];
90
91	✗	if (s->pos_h[p] < w)
92	✗	memcpy(dst, ssrc + s->pos_h[p], w - s->pos_h[p]);
93	✗	if (s->pos_h[p] > 0)
94	✗	memcpy(dst + w - s->pos_h[p], ssrc, s->pos_h[p]);
95
96	✗	dst += out->linesize[p];
97		}
98		}
99
100	✗	return 0;
101		}
102
103	✗	static void scroll(AVFilterContext ctx, AVFrame in, AVFrame *out)
104		{
105	✗	ScrollContext *s = ctx->priv;
106		ThreadData td;
107		int h_pos, v_pos;
108
109	✗	s->h_pos = fmodf(s->h_pos, in->width);
110	✗	s->v_pos = fmodf(s->v_pos, in->height);
111
112	✗	h_pos = s->h_pos;
113	✗	v_pos = s->v_pos;
114
115	✗	if (h_pos < 0)
116	✗	h_pos += in->width;
117	✗	if (v_pos < 0)
118	✗	v_pos += in->height;
119
120	✗	s->pos_v[1] = s->pos_v[2] = AV_CEIL_RSHIFT(v_pos, s->desc->log2_chroma_h);
121	✗	s->pos_v[0] = s->pos_v[3] = v_pos;
122	✗	s->pos_h[1] = s->pos_h[2] = AV_CEIL_RSHIFT(h_pos, s->desc->log2_chroma_w) * s->bytes;
123	✗	s->pos_h[0] = s->pos_h[3] = h_pos * s->bytes;
124
125	✗	td.in = in; td.out = out;
126	✗	ff_filter_execute(ctx, scroll_slice, &td, NULL,
127	✗	FFMIN(out->height, ff_filter_get_nb_threads(ctx)));
128
129	✗	s->h_pos += s->h_speed * in->width;
130	✗	s->v_pos += s->v_speed * in->height;
131	✗	}
132
133	✗	static int filter_frame(AVFilterLink inlink, AVFrame in)
134		{
135	✗	AVFilterContext *ctx = inlink->dst;
136	✗	AVFilterLink *outlink = ctx->outputs[0];
137		AVFrame *out;
138
139	✗	out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
140	✗	if (!out) {
141	✗	av_frame_free(&in);
142	✗	return AVERROR(ENOMEM);
143		}
144	✗	av_frame_copy_props(out, in);
145
146	✗	scroll(ctx, in, out);
147
148	✗	av_frame_free(&in);
149	✗	return ff_filter_frame(outlink, out);
150		}
151
152	✗	static int config_input(AVFilterLink *inlink)
153		{
154	✗	AVFilterContext *ctx = inlink->dst;
155	✗	ScrollContext *s = ctx->priv;
156
157	✗	s->desc = av_pix_fmt_desc_get(inlink->format);
158	✗	s->nb_planes = s->desc->nb_components;
159	✗	s->bytes = (s->desc->comp[0].depth + 7) >> 3;
160
161	✗	s->planeheight[1] = s->planeheight[2] = AV_CEIL_RSHIFT(inlink->h, s->desc->log2_chroma_h);
162	✗	s->planeheight[0] = s->planeheight[3] = inlink->h;
163	✗	s->planewidth[1] = s->planewidth[2] = AV_CEIL_RSHIFT(inlink->w, s->desc->log2_chroma_w);
164	✗	s->planewidth[0] = s->planewidth[3] = inlink->w;
165
166	✗	s->h_pos = (1.f - s->h_ipos) * inlink->w;
167	✗	s->v_pos = (1.f - s->v_ipos) * inlink->h;
168
169	✗	return 0;
170		}
171
172		#define OFFSET(x) offsetof(ScrollContext, x)
173		#define FLAGS AV_OPT_FLAG_VIDEO_PARAM\|AV_OPT_FLAG_FILTERING_PARAM
174		#define VFT AV_OPT_FLAG_VIDEO_PARAM\|AV_OPT_FLAG_FILTERING_PARAM\|AV_OPT_FLAG_RUNTIME_PARAM
175
176		static const AVOption scroll_options[] = {
177		{ "horizontal", "set the horizontal scrolling speed", OFFSET(h_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
178		{ "h", "set the horizontal scrolling speed", OFFSET(h_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
179		{ "vertical", "set the vertical scrolling speed", OFFSET(v_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
180		{ "v", "set the vertical scrolling speed", OFFSET(v_speed), AV_OPT_TYPE_FLOAT, {.dbl=0.}, -1., 1., VFT },
181		{ "hpos", "set initial horizontal position", OFFSET(h_ipos), AV_OPT_TYPE_FLOAT, {.dbl=0.}, 0, 1., FLAGS },
182		{ "vpos", "set initial vertical position", OFFSET(v_ipos), AV_OPT_TYPE_FLOAT, {.dbl=0.}, 0, 1., FLAGS },
183		{ NULL }
184		};
185
186		AVFILTER_DEFINE_CLASS(scroll);
187
188		static const AVFilterPad scroll_inputs[] = {
189		{
190		.name = "default",
191		.type = AVMEDIA_TYPE_VIDEO,
192		.config_props = config_input,
193		.filter_frame = filter_frame,
194		},
195		};
196
197		const FFFilter ff_vf_scroll = {
198		.p.name = "scroll",
199		.p.description = NULL_IF_CONFIG_SMALL("Scroll input video."),
200		.p.priv_class = &scroll_class,
201		.p.flags = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC \| AVFILTER_FLAG_SLICE_THREADS,
202		.priv_size = sizeof(ScrollContext),
203		FILTER_INPUTS(scroll_inputs),
204		FILTER_OUTPUTS(ff_video_default_filterpad),
205		FILTER_PIXFMTS_ARRAY(pix_fmts),
206		.process_command = ff_filter_process_command,
207		};
208

Function (Line)	Call count	Block coverage
config_input (line 152)	not called	0.0%
filter_frame (line 133)	not called	0.0%
scroll (line 103)	not called	0.0%
scroll_slice (line 71)	not called	0.0%