FFmpeg
vsrc_sierpinski.c
Go to the documentation of this file.
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 /**
22  * @file
23  * Sierpinski carpet fractal renderer
24  */
25 
26 #include "avfilter.h"
27 #include "formats.h"
28 #include "video.h"
29 #include "internal.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/parseutils.h"
34 #include "libavutil/lfg.h"
35 #include "libavutil/random_seed.h"
36 #include <float.h>
37 #include <math.h>
38 
39 typedef struct SierpinskiContext {
40  const AVClass *class;
41  int w, h;
42  int type;
44  uint64_t pts;
45 
46  int64_t seed;
47  int jump;
48 
49  int pos_x, pos_y;
50  int dest_x, dest_y;
51 
53  int (*draw_slice)(AVFilterContext *ctx, void *arg, int job, int nb_jobs);
55 
56 #define OFFSET(x) offsetof(SierpinskiContext, x)
57 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
58 
59 static const AVOption sierpinski_options[] = {
60  {"size", "set frame size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="640x480"}, 0, 0, FLAGS },
61  {"s", "set frame size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str="640x480"}, 0, 0, FLAGS },
62  {"rate", "set frame rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
63  {"r", "set frame rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str="25"}, 0, INT_MAX, FLAGS },
64  {"seed", "set the seed", OFFSET(seed), AV_OPT_TYPE_INT64, {.i64=-1}, -1, UINT32_MAX, FLAGS },
65  {"jump", "set the jump", OFFSET(jump), AV_OPT_TYPE_INT, {.i64=100}, 1, 10000, FLAGS },
66  {"type","set fractal type",OFFSET(type), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, FLAGS, "type" },
67  {"carpet", "sierpinski carpet", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, FLAGS, "type" },
68  {"triangle", "sierpinski triangle", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, FLAGS, "type" },
69  {NULL},
70 };
71 
72 AVFILTER_DEFINE_CLASS(sierpinski);
73 
74 static int fill_sierpinski(SierpinskiContext *s, int x, int y)
75 {
76  int pos_x = x + s->pos_x;
77  int pos_y = y + s->pos_y;
78 
79  while (pos_x != 0 && pos_y != 0) {
80  if (FFABS(pos_x % 3) == 1 && FFABS(pos_y % 3) == 1)
81  return 1;
82 
83  pos_x /= 3;
84  pos_y /= 3;
85  }
86 
87  return 0;
88 }
89 
90 static int draw_triangle_slice(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
91 {
92  SierpinskiContext *s = ctx->priv;
93  AVFrame *frame = arg;
94  const int width = frame->width;
95  const int height = frame->height;
96  const int start = (height * job ) / nb_jobs;
97  const int end = (height * (job+1)) / nb_jobs;
98  uint8_t *dst = frame->data[0] + start * frame->linesize[0];
99 
100  for (int y = start; y < end; y++) {
101  for (int x = 0; x < width; x++) {
102  if ((s->pos_x + x) & (s->pos_y + y)) {
103  AV_WL32(&dst[x*4], 0x00000000);
104  } else {
105  AV_WL32(&dst[x*4], 0xFFFFFFFF);
106  }
107  }
108 
109  dst += frame->linesize[0];
110  }
111 
112  return 0;
113 }
114 
115 static int draw_carpet_slice(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
116 {
117  SierpinskiContext *s = ctx->priv;
118  AVFrame *frame = arg;
119  const int width = frame->width;
120  const int height = frame->height;
121  const int start = (height * job ) / nb_jobs;
122  const int end = (height * (job+1)) / nb_jobs;
123  uint8_t *dst = frame->data[0] + start * frame->linesize[0];
124 
125  for (int y = start; y < end; y++) {
126  for (int x = 0; x < width; x++) {
127  if (fill_sierpinski(s, x, y)) {
128  AV_WL32(&dst[x*4], 0x00000000);
129  } else {
130  AV_WL32(&dst[x*4], 0xFFFFFFFF);
131  }
132  }
133 
134  dst += frame->linesize[0];
135  }
136 
137  return 0;
138 }
139 
140 static int config_output(AVFilterLink *outlink)
141 {
142  AVFilterContext *ctx = outlink->src;
143  SierpinskiContext *s = ctx->priv;
144 
145  if (av_image_check_size(s->w, s->h, 0, ctx) < 0)
146  return AVERROR(EINVAL);
147 
148  outlink->w = s->w;
149  outlink->h = s->h;
150  outlink->time_base = av_inv_q(s->frame_rate);
151  outlink->sample_aspect_ratio = (AVRational) {1, 1};
152  outlink->frame_rate = s->frame_rate;
153  if (s->seed == -1)
154  s->seed = av_get_random_seed();
155  av_lfg_init(&s->lfg, s->seed);
156 
157  s->draw_slice = s->type ? draw_triangle_slice : draw_carpet_slice;
158 
159  return 0;
160 }
161 
163 {
164  SierpinskiContext *s = ctx->priv;
165  AVFilterLink *outlink = ctx->outputs[0];
166 
167  if (s->pos_x == s->dest_x && s->pos_y == s->dest_y) {
168  unsigned int rnd = av_lfg_get(&s->lfg);
169  int mod = 2 * s->jump + 1;
170 
171  s->dest_x += (int)((rnd & 0xffff) % mod) - s->jump;
172  s->dest_y += (int)((rnd >> 16) % mod) - s->jump;
173  } else {
174  if (s->pos_x < s->dest_x)
175  s->pos_x++;
176  else if (s->pos_x > s->dest_x)
177  s->pos_x--;
178 
179  if (s->pos_y < s->dest_y)
180  s->pos_y++;
181  else if (s->pos_y > s->dest_y)
182  s->pos_y--;
183  }
184 
185  ff_filter_execute(ctx, s->draw_slice, frame, NULL,
186  FFMIN(outlink->h, ff_filter_get_nb_threads(ctx)));
187 }
188 
190 {
191  SierpinskiContext *s = link->src->priv;
192  AVFrame *frame = ff_get_video_buffer(link, s->w, s->h);
193 
194  if (!frame)
195  return AVERROR(ENOMEM);
196 
197  frame->sample_aspect_ratio = (AVRational) {1, 1};
198  frame->pts = s->pts++;
199 
200  draw_sierpinski(link->src, frame);
201 
202  return ff_filter_frame(link, frame);
203 }
204 
205 static const AVFilterPad sierpinski_outputs[] = {
206  {
207  .name = "default",
208  .type = AVMEDIA_TYPE_VIDEO,
209  .request_frame = sierpinski_request_frame,
210  .config_props = config_output,
211  },
212 };
213 
215  .name = "sierpinski",
216  .description = NULL_IF_CONFIG_SMALL("Render a Sierpinski fractal."),
217  .priv_size = sizeof(SierpinskiContext),
218  .priv_class = &sierpinski_class,
219  .inputs = NULL,
223 };
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(sierpinski)
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:101
SierpinskiContext::jump
int jump
Definition: vsrc_sierpinski.c:47
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
AV_WL32
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
SierpinskiContext::pts
uint64_t pts
Definition: vsrc_sierpinski.c:44
av_lfg_init
av_cold void av_lfg_init(AVLFG *c, unsigned int seed)
Definition: lfg.c:32
sierpinski_options
static const AVOption sierpinski_options[]
Definition: vsrc_sierpinski.c:59
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:999
AV_OPT_TYPE_VIDEO_RATE
@ AV_OPT_TYPE_VIDEO_RATE
offset must point to AVRational
Definition: opt.h:238
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
w
uint8_t w
Definition: llviddspenc.c:38
AVOption
AVOption.
Definition: opt.h:251
float.h
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:175
video.h
av_get_random_seed
uint32_t av_get_random_seed(void)
Get a seed to use in conjunction with random functions.
Definition: random_seed.c:120
formats.h
config_output
static int config_output(AVFilterLink *outlink)
Definition: vsrc_sierpinski.c:140
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:49
rnd
#define rnd()
Definition: checkasm.h:115
draw_carpet_slice
static int draw_carpet_slice(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
Definition: vsrc_sierpinski.c:115
width
#define width
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:256
av_lfg_get
static unsigned int av_lfg_get(AVLFG *c)
Get the next random unsigned 32-bit number using an ALFG.
Definition: lfg.h:53
AV_PIX_FMT_0BGR32
#define AV_PIX_FMT_0BGR32
Definition: pixfmt.h:389
lfg.h
AV_OPT_TYPE_INT64
@ AV_OPT_TYPE_INT64
Definition: opt.h:226
ctx
AVFormatContext * ctx
Definition: movenc.c:48
FLAGS
#define FLAGS
Definition: vsrc_sierpinski.c:57
link
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a link
Definition: filter_design.txt:23
arg
const char * arg
Definition: jacosubdec.c:67
FFABS
#define FFABS(a)
Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they are not representable ...
Definition: common.h:64
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AV_OPT_TYPE_IMAGE_SIZE
@ AV_OPT_TYPE_IMAGE_SIZE
offset must point to two consecutive integers
Definition: opt.h:235
parseutils.h
SierpinskiContext::pos_y
int pos_y
Definition: vsrc_sierpinski.c:49
ff_vsrc_sierpinski
const AVFilter ff_vsrc_sierpinski
Definition: vsrc_sierpinski.c:214
draw_sierpinski
static void draw_sierpinski(AVFilterContext *ctx, AVFrame *frame)
Definition: vsrc_sierpinski.c:162
inputs
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
Definition: filter_design.txt:243
seed
static unsigned int seed
Definition: videogen.c:78
SierpinskiContext::dest_y
int dest_y
Definition: vsrc_sierpinski.c:50
SierpinskiContext::dest_x
int dest_x
Definition: vsrc_sierpinski.c:50
SierpinskiContext::type
int type
Definition: vsrc_sierpinski.c:42
AVLFG
Context structure for the Lagged Fibonacci PRNG.
Definition: lfg.h:33
SierpinskiContext::h
int h
Definition: vsrc_sierpinski.c:41
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
sierpinski_outputs
static const AVFilterPad sierpinski_outputs[]
Definition: vsrc_sierpinski.c:205
height
#define height
SierpinskiContext::draw_slice
int(* draw_slice)(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
Definition: vsrc_sierpinski.c:53
internal.h
FILTER_SINGLE_PIXFMT
#define FILTER_SINGLE_PIXFMT(pix_fmt_)
Definition: internal.h:180
SierpinskiContext::pos_x
int pos_x
Definition: vsrc_sierpinski.c:49
SierpinskiContext::w
int w
Definition: vsrc_sierpinski.c:41
SierpinskiContext::seed
int64_t seed
Definition: vsrc_sierpinski.c:46
ff_filter_get_nb_threads
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Definition: avfilter.c:783
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
av_inv_q
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:55
mod
static int mod(int a, int b)
Modulo operation with only positive remainders.
Definition: vf_v360.c:750
SierpinskiContext::frame_rate
AVRational frame_rate
Definition: vsrc_sierpinski.c:43
AVFilter
Filter definition.
Definition: avfilter.h:171
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
random_seed.h
draw_triangle_slice
static int draw_triangle_slice(AVFilterContext *ctx, void *arg, int job, int nb_jobs)
Definition: vsrc_sierpinski.c:90
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avfilter.h
fill_sierpinski
static int fill_sierpinski(SierpinskiContext *s, int x, int y)
Definition: vsrc_sierpinski.c:74
AVFilterContext
An instance of a filter.
Definition: avfilter.h:408
AVFILTER_FLAG_SLICE_THREADS
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
Definition: avfilter.h:127
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:191
SierpinskiContext::lfg
AVLFG lfg
Definition: vsrc_sierpinski.c:52
imgutils.h
av_image_check_size
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:318
ff_filter_execute
static av_always_inline int ff_filter_execute(AVFilterContext *ctx, avfilter_action_func *func, void *arg, int *ret, int nb_jobs)
Definition: internal.h:142
int
int
Definition: ffmpeg_filter.c:155
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:234
sierpinski_request_frame
static int sierpinski_request_frame(AVFilterLink *link)
Definition: vsrc_sierpinski.c:189
SierpinskiContext
Definition: vsrc_sierpinski.c:39
OFFSET
#define OFFSET(x)
Definition: vsrc_sierpinski.c:56