xxan: check ybuf index before use.
[ffmpeg.git] / libavfilter / vsrc_cellauto.c
1 /*
2  * Copyright (c) Stefano Sabatini 2011
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  * cellular automaton video source, based on Stephen Wolfram "experimentus crucis"
24  */
25
26 /* #define DEBUG */
27
28 #include "libavutil/file.h"
29 #include "libavutil/lfg.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/parseutils.h"
32 #include "libavutil/random_seed.h"
33 #include "avfilter.h"
34 #include "internal.h"
35 #include "formats.h"
36 #include "video.h"
37
38 typedef struct {
39     const AVClass *class;
40     int w, h;
41     char *filename;
42     char *rule_str;
43     uint8_t *file_buf;
44     size_t file_bufsize;
45     uint8_t *buf;
46     int buf_prev_row_idx, buf_row_idx;
47     uint8_t rule;
48     uint64_t pts;
49     AVRational time_base;
50     char *rate;                 ///< video frame rate
51     double   random_fill_ratio;
52     uint32_t random_seed;
53     int stitch, scroll, start_full;
54     int64_t generation;         ///< the generation number, starting from 0
55     AVLFG lfg;
56     char *pattern;
57 } CellAutoContext;
58
59 #define OFFSET(x) offsetof(CellAutoContext, x)
60 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
61
62 static const AVOption cellauto_options[] = {
63     { "filename", "read initial pattern from file", OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
64     { "f",        "read initial pattern from file", OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
65     { "pattern",  "set initial pattern", OFFSET(pattern), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
66     { "p",        "set initial pattern", OFFSET(pattern), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, FLAGS },
67     { "rate",     "set video rate", OFFSET(rate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0, FLAGS },
68     { "r",        "set video rate", OFFSET(rate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0, FLAGS },
69     { "size",     "set video size", OFFSET(w),    AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, 0, 0, FLAGS },
70     { "s",        "set video size", OFFSET(w),    AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, 0, 0, FLAGS },
71     { "rule",     "set rule",       OFFSET(rule), AV_OPT_TYPE_INT,    {.i64 = 110},  0, 255, FLAGS },
72     { "random_fill_ratio", "set fill ratio for filling initial grid randomly", OFFSET(random_fill_ratio), AV_OPT_TYPE_DOUBLE, {.dbl = 1/M_PHI}, 0, 1, FLAGS },
73     { "ratio",             "set fill ratio for filling initial grid randomly", OFFSET(random_fill_ratio), AV_OPT_TYPE_DOUBLE, {.dbl = 1/M_PHI}, 0, 1, FLAGS },
74     { "random_seed", "set the seed for filling the initial grid randomly", OFFSET(random_seed), AV_OPT_TYPE_INT, {.i64 = -1}, -1, UINT32_MAX, FLAGS },
75     { "seed",        "set the seed for filling the initial grid randomly", OFFSET(random_seed), AV_OPT_TYPE_INT, {.i64 = -1}, -1, UINT32_MAX, FLAGS },
76     { "scroll",      "scroll pattern downward", OFFSET(scroll), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, FLAGS },
77     { "start_full",  "start filling the whole video", OFFSET(start_full), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, FLAGS },
78     { "full",        "start filling the whole video", OFFSET(start_full), AV_OPT_TYPE_INT, {.i64 = 1}, 0, 1, FLAGS },
79     { "stitch",      "stitch boundaries", OFFSET(stitch), AV_OPT_TYPE_INT,    {.i64 = 1},   0, 1, FLAGS },
80     { NULL },
81 };
82
83 AVFILTER_DEFINE_CLASS(cellauto);
84
85 #ifdef DEBUG
86 static void show_cellauto_row(AVFilterContext *ctx)
87 {
88     CellAutoContext *cellauto = ctx->priv;
89     int i;
90     uint8_t *row = cellauto->buf + cellauto->w * cellauto->buf_row_idx;
91     char *line = av_malloc(cellauto->w + 1);
92     if (!line)
93         return;
94
95     for (i = 0; i < cellauto->w; i++)
96         line[i] = row[i] ? '@' : ' ';
97     line[i] = 0;
98     av_log(ctx, AV_LOG_DEBUG, "generation:%"PRId64" row:%s|\n", cellauto->generation, line);
99     av_free(line);
100 }
101 #endif
102
103 static int init_pattern_from_string(AVFilterContext *ctx)
104 {
105     CellAutoContext *cellauto = ctx->priv;
106     char *p;
107     int i, w = 0;
108
109     w = strlen(cellauto->pattern);
110     av_log(ctx, AV_LOG_DEBUG, "w:%d\n", w);
111
112     if (cellauto->w) {
113         if (w > cellauto->w) {
114             av_log(ctx, AV_LOG_ERROR,
115                    "The specified width is %d which cannot contain the provided string width of %d\n",
116                    cellauto->w, w);
117             return AVERROR(EINVAL);
118         }
119     } else {
120         /* width was not specified, set it to width of the provided row */
121         cellauto->w = w;
122         cellauto->h = (double)cellauto->w * M_PHI;
123     }
124
125     cellauto->buf = av_mallocz(sizeof(uint8_t) * cellauto->w * cellauto->h);
126     if (!cellauto->buf)
127         return AVERROR(ENOMEM);
128
129     /* fill buf */
130     p = cellauto->pattern;
131     for (i = (cellauto->w - w)/2;; i++) {
132         av_log(ctx, AV_LOG_DEBUG, "%d %c\n", i, *p == '\n' ? 'N' : *p);
133         if (*p == '\n' || !*p)
134             break;
135         else
136             cellauto->buf[i] = !!isgraph(*(p++));
137     }
138
139     return 0;
140 }
141
142 static int init_pattern_from_file(AVFilterContext *ctx)
143 {
144     CellAutoContext *cellauto = ctx->priv;
145     int ret;
146
147     ret = av_file_map(cellauto->filename,
148                       &cellauto->file_buf, &cellauto->file_bufsize, 0, ctx);
149     if (ret < 0)
150         return ret;
151
152     /* create a string based on the read file */
153     cellauto->pattern = av_malloc(cellauto->file_bufsize + 1);
154     if (!cellauto->pattern)
155         return AVERROR(ENOMEM);
156     memcpy(cellauto->pattern, cellauto->file_buf, cellauto->file_bufsize);
157     cellauto->pattern[cellauto->file_bufsize] = 0;
158
159     return init_pattern_from_string(ctx);
160 }
161
162 static int init(AVFilterContext *ctx, const char *args)
163 {
164     CellAutoContext *cellauto = ctx->priv;
165     AVRational frame_rate;
166     int ret;
167
168     cellauto->class = &cellauto_class;
169     av_opt_set_defaults(cellauto);
170
171     if ((ret = av_set_options_string(cellauto, args, "=", ":")) < 0)
172         return ret;
173
174     if ((ret = av_parse_video_rate(&frame_rate, cellauto->rate)) < 0) {
175         av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: %s\n", cellauto->rate);
176         return AVERROR(EINVAL);
177     }
178
179     if (!cellauto->w && !cellauto->filename && !cellauto->pattern)
180         av_opt_set(cellauto, "size", "320x518", 0);
181
182     cellauto->time_base.num = frame_rate.den;
183     cellauto->time_base.den = frame_rate.num;
184
185     if (cellauto->filename && cellauto->pattern) {
186         av_log(ctx, AV_LOG_ERROR, "Only one of the filename or pattern options can be used\n");
187         return AVERROR(EINVAL);
188     }
189
190     if (cellauto->filename) {
191         if ((ret = init_pattern_from_file(ctx)) < 0)
192             return ret;
193     } else if (cellauto->pattern) {
194         if ((ret = init_pattern_from_string(ctx)) < 0)
195             return ret;
196     } else {
197         /* fill the first row randomly */
198         int i;
199
200         cellauto->buf = av_mallocz(sizeof(uint8_t) * cellauto->w * cellauto->h);
201         if (!cellauto->buf)
202             return AVERROR(ENOMEM);
203         if (cellauto->random_seed == -1)
204             cellauto->random_seed = av_get_random_seed();
205
206         av_lfg_init(&cellauto->lfg, cellauto->random_seed);
207
208         for (i = 0; i < cellauto->w; i++) {
209             double r = (double)av_lfg_get(&cellauto->lfg) / UINT32_MAX;
210             if (r <= cellauto->random_fill_ratio)
211                 cellauto->buf[i] = 1;
212         }
213     }
214
215     av_log(ctx, AV_LOG_VERBOSE,
216            "s:%dx%d r:%d/%d rule:%d stitch:%d scroll:%d full:%d seed:%u\n",
217            cellauto->w, cellauto->h, frame_rate.num, frame_rate.den,
218            cellauto->rule, cellauto->stitch, cellauto->scroll, cellauto->start_full,
219            cellauto->random_seed);
220     return 0;
221 }
222
223 static av_cold void uninit(AVFilterContext *ctx)
224 {
225     CellAutoContext *cellauto = ctx->priv;
226
227     av_file_unmap(cellauto->file_buf, cellauto->file_bufsize);
228     av_freep(&cellauto->buf);
229     av_freep(&cellauto->pattern);
230 }
231
232 static int config_props(AVFilterLink *outlink)
233 {
234     CellAutoContext *cellauto = outlink->src->priv;
235
236     outlink->w = cellauto->w;
237     outlink->h = cellauto->h;
238     outlink->time_base = cellauto->time_base;
239
240     return 0;
241 }
242
243 static void evolve(AVFilterContext *ctx)
244 {
245     CellAutoContext *cellauto = ctx->priv;
246     int i, v, pos[3];
247     uint8_t *row, *prev_row = cellauto->buf + cellauto->buf_row_idx * cellauto->w;
248     enum { NW, N, NE };
249
250     cellauto->buf_prev_row_idx = cellauto->buf_row_idx;
251     cellauto->buf_row_idx      = cellauto->buf_row_idx == cellauto->h-1 ? 0 : cellauto->buf_row_idx+1;
252     row = cellauto->buf + cellauto->w * cellauto->buf_row_idx;
253
254     for (i = 0; i < cellauto->w; i++) {
255         if (cellauto->stitch) {
256             pos[NW] = i-1 < 0 ? cellauto->w-1 : i-1;
257             pos[N]  = i;
258             pos[NE] = i+1 == cellauto->w ? 0  : i+1;
259             v = prev_row[pos[NW]]<<2 | prev_row[pos[N]]<<1 | prev_row[pos[NE]];
260         } else {
261             v = 0;
262             v|= i-1 >= 0          ? prev_row[i-1]<<2 : 0;
263             v|=                     prev_row[i  ]<<1    ;
264             v|= i+1 < cellauto->w ? prev_row[i+1]    : 0;
265         }
266         row[i] = !!(cellauto->rule & (1<<v));
267         av_dlog(ctx, "i:%d context:%c%c%c -> cell:%d\n", i,
268                 v&4?'@':' ', v&2?'@':' ', v&1?'@':' ', row[i]);
269     }
270
271     cellauto->generation++;
272 }
273
274 static void fill_picture(AVFilterContext *ctx, AVFilterBufferRef *picref)
275 {
276     CellAutoContext *cellauto = ctx->priv;
277     int i, j, k, row_idx = 0;
278     uint8_t *p0 = picref->data[0];
279
280     if (cellauto->scroll && cellauto->generation >= cellauto->h)
281         /* show on top the oldest row */
282         row_idx = (cellauto->buf_row_idx + 1) % cellauto->h;
283
284     /* fill the output picture with the whole buffer */
285     for (i = 0; i < cellauto->h; i++) {
286         uint8_t byte = 0;
287         uint8_t *row = cellauto->buf + row_idx*cellauto->w;
288         uint8_t *p = p0;
289         for (k = 0, j = 0; j < cellauto->w; j++) {
290             byte |= row[j]<<(7-k++);
291             if (k==8 || j == cellauto->w-1) {
292                 k = 0;
293                 *p++ = byte;
294                 byte = 0;
295             }
296         }
297         row_idx = (row_idx + 1) % cellauto->h;
298         p0 += picref->linesize[0];
299     }
300 }
301
302 static int request_frame(AVFilterLink *outlink)
303 {
304     CellAutoContext *cellauto = outlink->src->priv;
305     AVFilterBufferRef *picref =
306         ff_get_video_buffer(outlink, AV_PERM_WRITE, cellauto->w, cellauto->h);
307     picref->video->sample_aspect_ratio = (AVRational) {1, 1};
308     if (cellauto->generation == 0 && cellauto->start_full) {
309         int i;
310         for (i = 0; i < cellauto->h-1; i++)
311             evolve(outlink->src);
312     }
313     fill_picture(outlink->src, picref);
314     evolve(outlink->src);
315
316     picref->pts = cellauto->pts++;
317     picref->pos = -1;
318
319 #ifdef DEBUG
320     show_cellauto_row(outlink->src);
321 #endif
322
323     ff_start_frame(outlink, avfilter_ref_buffer(picref, ~0));
324     ff_draw_slice(outlink, 0, cellauto->h, 1);
325     ff_end_frame(outlink);
326     avfilter_unref_buffer(picref);
327
328     return 0;
329 }
330
331 static int query_formats(AVFilterContext *ctx)
332 {
333     static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_NONE };
334     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
335     return 0;
336 }
337
338 AVFilter avfilter_vsrc_cellauto = {
339     .name        = "cellauto",
340     .description = NULL_IF_CONFIG_SMALL("Create pattern generated by an elementary cellular automaton."),
341     .priv_size = sizeof(CellAutoContext),
342     .init      = init,
343     .uninit    = uninit,
344     .query_formats = query_formats,
345
346     .inputs    = (const AVFilterPad[]) {
347         { .name = NULL}
348     },
349     .outputs   = (const AVFilterPad[]) {
350         { .name            = "default",
351           .type            = AVMEDIA_TYPE_VIDEO,
352           .request_frame   = request_frame,
353           .config_props    = config_props },
354         { .name = NULL}
355     },
356     .priv_class = &cellauto_class,
357 };