2 * Copyright (c) Stefano Sabatini 2010
4 * This file is part of FFmpeg.
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.
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.
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
23 * life video source, based on John Conways' Life Game
28 #include "libavutil/file.h"
29 #include "libavutil/intreadwrite.h"
30 #include "libavutil/lfg.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/parseutils.h"
33 #include "libavutil/random_seed.h"
45 * The two grid state buffers.
47 * A 0xFF (ALIVE_CELL) value means the cell is alive (or new born), while
48 * the decreasing values from 0xFE to 0 means the cell is dead; the range
49 * of values is used for the slow death effect, or mold (0xFE means dead,
50 * 0xFD means very dead, 0xFC means very very dead... and 0x00 means
51 * definitely dead/mold).
56 uint16_t stay_rule; ///< encode the behavior for filled cells
57 uint16_t born_rule; ///< encode the behavior for empty cells
60 char *size; ///< video frame size
61 char *rate; ///< video frame rate
62 double random_fill_ratio;
67 char *death_color_str;
69 uint8_t life_color[4];
70 uint8_t death_color[4];
71 uint8_t mold_color[4];
73 void (*draw)(AVFilterContext*, AVFilterBufferRef*);
76 #define ALIVE_CELL 0xFF
77 #define OFFSET(x) offsetof(LifeContext, x)
79 static const AVOption life_options[] = {
80 { "filename", "set source file", OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0 },
81 { "f", "set source file", OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0 },
82 { "size", "set video size", OFFSET(size), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0 },
83 { "s", "set video size", OFFSET(size), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0 },
84 { "rate", "set video rate", OFFSET(rate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0 },
85 { "r", "set video rate", OFFSET(rate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0 },
86 { "rule", "set rule", OFFSET(rule_str), AV_OPT_TYPE_STRING, {.str = "B3/S23"}, CHAR_MIN, CHAR_MAX },
87 { "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 },
88 { "ratio", "set fill ratio for filling initial grid randomly", OFFSET(random_fill_ratio), AV_OPT_TYPE_DOUBLE, {.dbl=1/M_PHI}, 0, 1 },
89 { "random_seed", "set the seed for filling the initial grid randomly", OFFSET(random_seed), AV_OPT_TYPE_INT, {.dbl=-1}, -1, UINT32_MAX },
90 { "seed", "set the seed for filling the initial grid randomly", OFFSET(random_seed), AV_OPT_TYPE_INT, {.dbl=-1}, -1, UINT32_MAX },
91 { "stitch", "stitch boundaries", OFFSET(stitch), AV_OPT_TYPE_INT, {.dbl=1}, 0, 1 },
92 { "mold", "set mold speed for dead cells", OFFSET(mold), AV_OPT_TYPE_INT, {.dbl=0}, 0, 0xFF },
93 { "life_color", "set life color", OFFSET( life_color_str), AV_OPT_TYPE_STRING, {.str="white"}, CHAR_MIN, CHAR_MAX },
94 { "death_color", "set death color", OFFSET(death_color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
95 { "mold_color", "set mold color", OFFSET( mold_color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
99 static const char *life_get_name(void *ctx)
104 static const AVClass life_class = {
110 static int parse_rule(uint16_t *born_rule, uint16_t *stay_rule,
111 const char *rule_str, void *log_ctx)
114 const char *p = rule_str;
118 if (strchr("bBsS", *p)) {
119 /* parse rule as a Born / Stay Alive code, see
120 * http://en.wikipedia.org/wiki/Conway%27s_Game_of_Life */
122 uint16_t *rule = (*p == 'b' || *p == 'B') ? born_rule : stay_rule;
124 while (*p >= '0' && *p <= '8') {
125 *rule += 1<<(*p - '0');
131 } while (strchr("bBsS", *p));
136 /* parse rule as a number, expressed in the form STAY|(BORN<<9),
137 * where STAY and BORN encode the corresponding 9-bits rule */
138 long int rule = strtol(rule_str, &tail, 10);
141 *born_rule = ((1<<9)-1) & rule;
142 *stay_rule = rule >> 9;
148 av_log(log_ctx, AV_LOG_ERROR, "Invalid rule code '%s' provided\n", rule_str);
149 return AVERROR(EINVAL);
153 static void show_life_grid(AVFilterContext *ctx)
155 LifeContext *life = ctx->priv;
158 char *line = av_malloc(life->w + 1);
161 for (i = 0; i < life->h; i++) {
162 for (j = 0; j < life->w; j++)
163 line[j] = life->buf[life->buf_idx][i*life->w + j] == ALIVE_CELL ? '@' : ' ';
165 av_log(ctx, AV_LOG_DEBUG, "%3d: %s\n", i, line);
171 static int init_pattern_from_file(AVFilterContext *ctx)
173 LifeContext *life = ctx->priv;
175 int ret, i, i0, j, h = 0, w, max_w = 0;
177 if ((ret = av_file_map(life->filename, &life->file_buf, &life->file_bufsize,
180 av_freep(&life->filename);
182 /* prescan file to get the number of lines and the maximum width */
184 for (i = 0; i < life->file_bufsize; i++) {
185 if (life->file_buf[i] == '\n') {
186 h++; max_w = FFMAX(w, max_w); w = 0;
191 av_log(ctx, AV_LOG_DEBUG, "h:%d max_w:%d\n", h, max_w);
194 if (max_w > life->w || h > life->h) {
195 av_log(ctx, AV_LOG_ERROR,
196 "The specified size is %dx%d which cannot contain the provided file size of %dx%d\n",
197 life->w, life->h, max_w, h);
198 return AVERROR(EINVAL);
201 /* size was not specified, set it to size of the grid */
206 if (!(life->buf[0] = av_mallocz(sizeof(char) * life->h * life->w)) ||
207 !(life->buf[1] = av_mallocz(sizeof(char) * life->h * life->w))) {
208 av_free(life->buf[0]);
209 av_free(life->buf[1]);
210 return AVERROR(ENOMEM);
215 for (i0 = 0, i = (life->h - h)/2; i0 < h; i0++, i++) {
216 for (j = (life->w - max_w)/2;; j++) {
217 av_log(ctx, AV_LOG_DEBUG, "%d:%d %c\n", i, j, *p == '\n' ? 'N' : *p);
221 life->buf[0][i*life->w + j] = isgraph(*(p++)) ? ALIVE_CELL : 0;
229 static int init(AVFilterContext *ctx, const char *args, void *opaque)
231 LifeContext *life = ctx->priv;
232 AVRational frame_rate;
235 life->class = &life_class;
236 av_opt_set_defaults(life);
238 if ((ret = av_set_options_string(life, args, "=", ":")) < 0) {
239 av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
243 if ((ret = av_parse_video_rate(&frame_rate, life->rate)) < 0) {
244 av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: %s\n", life->rate);
245 return AVERROR(EINVAL);
247 av_freep(&life->rate);
249 if (!life->size && !life->filename)
250 av_opt_set(life, "size", "320x240", 0);
253 (ret = av_parse_video_size(&life->w, &life->h, life->size)) < 0) {
254 av_log(ctx, AV_LOG_ERROR, "Invalid frame size: %s\n", life->size);
257 av_freep(&life->size);
259 if ((ret = parse_rule(&life->born_rule, &life->stay_rule, life->rule_str, ctx)) < 0)
262 #define PARSE_COLOR(name) do { \
263 if ((ret = av_parse_color(life->name ## _color, life->name ## _color_str, -1, ctx))) { \
264 av_log(ctx, AV_LOG_ERROR, "Invalid " #name " color '%s'\n", \
265 life->name ## _color_str); \
268 av_freep(&life->name ## _color_str); \
275 if (!life->mold && memcmp(life->mold_color, "\x00\x00\x00", 3))
276 av_log(ctx, AV_LOG_WARNING,
277 "Mold color is set while mold isn't, ignoring the color.\n");
279 life->time_base.num = frame_rate.den;
280 life->time_base.den = frame_rate.num;
282 if (!life->filename) {
283 /* fill the grid randomly */
286 if (!(life->buf[0] = av_mallocz(sizeof(char) * life->h * life->w)) ||
287 !(life->buf[1] = av_mallocz(sizeof(char) * life->h * life->w))) {
288 av_free(life->buf[0]);
289 av_free(life->buf[1]);
290 return AVERROR(ENOMEM);
292 if (life->random_seed == -1)
293 life->random_seed = av_get_random_seed();
295 av_lfg_init(&life->lfg, life->random_seed);
297 for (i = 0; i < life->w * life->h; i++) {
298 double r = (double)av_lfg_get(&life->lfg) / UINT32_MAX;
299 if (r <= life->random_fill_ratio)
300 life->buf[0][i] = ALIVE_CELL;
304 if ((ret = init_pattern_from_file(ctx)) < 0)
308 av_log(ctx, AV_LOG_INFO,
309 "s:%dx%d r:%d/%d rule:%s stay_rule:%d born_rule:%d stitch:%d seed:%u\n",
310 life->w, life->h, frame_rate.num, frame_rate.den,
311 life->rule_str, life->stay_rule, life->born_rule, life->stitch,
316 static av_cold void uninit(AVFilterContext *ctx)
318 LifeContext *life = ctx->priv;
320 av_file_unmap(life->file_buf, life->file_bufsize);
321 av_freep(&life->rule_str);
322 av_freep(&life->buf[0]);
323 av_freep(&life->buf[1]);
326 static int config_props(AVFilterLink *outlink)
328 LifeContext *life = outlink->src->priv;
330 outlink->w = life->w;
331 outlink->h = life->h;
332 outlink->time_base = life->time_base;
337 static void evolve(AVFilterContext *ctx)
339 LifeContext *life = ctx->priv;
341 uint8_t *oldbuf = life->buf[ life->buf_idx];
342 uint8_t *newbuf = life->buf[!life->buf_idx];
344 enum { NW, N, NE, W, E, SW, S, SE };
346 /* evolve the grid */
347 for (i = 0; i < life->h; i++) {
348 for (j = 0; j < life->w; j++) {
349 int pos[8][2], n, alive, cell;
351 pos[NW][0] = (i-1) < 0 ? life->h-1 : i-1; pos[NW][1] = (j-1) < 0 ? life->w-1 : j-1;
352 pos[N ][0] = (i-1) < 0 ? life->h-1 : i-1; pos[N ][1] = j ;
353 pos[NE][0] = (i-1) < 0 ? life->h-1 : i-1; pos[NE][1] = (j+1) == life->w ? 0 : j+1;
354 pos[W ][0] = i ; pos[W ][1] = (j-1) < 0 ? life->w-1 : j-1;
355 pos[E ][0] = i ; pos[E ][1] = (j+1) == life->w ? 0 : j+1;
356 pos[SW][0] = (i+1) == life->h ? 0 : i+1; pos[SW][1] = (j-1) < 0 ? life->w-1 : j-1;
357 pos[S ][0] = (i+1) == life->h ? 0 : i+1; pos[S ][1] = j ;
358 pos[SE][0] = (i+1) == life->h ? 0 : i+1; pos[SE][1] = (j+1) == life->w ? 0 : j+1;
360 pos[NW][0] = (i-1) < 0 ? -1 : i-1; pos[NW][1] = (j-1) < 0 ? -1 : j-1;
361 pos[N ][0] = (i-1) < 0 ? -1 : i-1; pos[N ][1] = j ;
362 pos[NE][0] = (i-1) < 0 ? -1 : i-1; pos[NE][1] = (j+1) == life->w ? -1 : j+1;
363 pos[W ][0] = i ; pos[W ][1] = (j-1) < 0 ? -1 : j-1;
364 pos[E ][0] = i ; pos[E ][1] = (j+1) == life->w ? -1 : j+1;
365 pos[SW][0] = (i+1) == life->h ? -1 : i+1; pos[SW][1] = (j-1) < 0 ? -1 : j-1;
366 pos[S ][0] = (i+1) == life->h ? -1 : i+1; pos[S ][1] = j ;
367 pos[SE][0] = (i+1) == life->h ? -1 : i+1; pos[SE][1] = (j+1) == life->w ? -1 : j+1;
370 /* compute the number of live neighbor cells */
371 n = (pos[NW][0] == -1 || pos[NW][1] == -1 ? 0 : oldbuf[pos[NW][0]*life->w + pos[NW][1]] == ALIVE_CELL) +
372 (pos[N ][0] == -1 || pos[N ][1] == -1 ? 0 : oldbuf[pos[N ][0]*life->w + pos[N ][1]] == ALIVE_CELL) +
373 (pos[NE][0] == -1 || pos[NE][1] == -1 ? 0 : oldbuf[pos[NE][0]*life->w + pos[NE][1]] == ALIVE_CELL) +
374 (pos[W ][0] == -1 || pos[W ][1] == -1 ? 0 : oldbuf[pos[W ][0]*life->w + pos[W ][1]] == ALIVE_CELL) +
375 (pos[E ][0] == -1 || pos[E ][1] == -1 ? 0 : oldbuf[pos[E ][0]*life->w + pos[E ][1]] == ALIVE_CELL) +
376 (pos[SW][0] == -1 || pos[SW][1] == -1 ? 0 : oldbuf[pos[SW][0]*life->w + pos[SW][1]] == ALIVE_CELL) +
377 (pos[S ][0] == -1 || pos[S ][1] == -1 ? 0 : oldbuf[pos[S ][0]*life->w + pos[S ][1]] == ALIVE_CELL) +
378 (pos[SE][0] == -1 || pos[SE][1] == -1 ? 0 : oldbuf[pos[SE][0]*life->w + pos[SE][1]] == ALIVE_CELL);
379 cell = oldbuf[i*life->w + j];
380 alive = 1<<n & (cell == ALIVE_CELL ? life->stay_rule : life->born_rule);
381 if (alive) *newbuf = ALIVE_CELL; // new cell is alive
382 else if (cell) *newbuf = cell - 1; // new cell is dead and in the process of mold
383 else *newbuf = 0; // new cell is definitely dead
384 av_dlog(ctx, "i:%d j:%d live_neighbors:%d cell:%d -> cell:%d\n", i, j, n, cell, *newbuf);
389 life->buf_idx = !life->buf_idx;
392 static void fill_picture_monoblack(AVFilterContext *ctx, AVFilterBufferRef *picref)
394 LifeContext *life = ctx->priv;
395 uint8_t *buf = life->buf[life->buf_idx];
398 /* fill the output picture with the old grid buffer */
399 for (i = 0; i < life->h; i++) {
401 uint8_t *p = picref->data[0] + i * picref->linesize[0];
402 for (k = 0, j = 0; j < life->w; j++) {
403 byte |= (buf[i*life->w+j] == ALIVE_CELL)<<(7-k++);
404 if (k==8 || j == life->w-1) {
413 // divide by 255 and round to nearest
414 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
415 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
417 static void fill_picture_rgb(AVFilterContext *ctx, AVFilterBufferRef *picref)
419 LifeContext *life = ctx->priv;
420 uint8_t *buf = life->buf[life->buf_idx];
423 /* fill the output picture with the old grid buffer */
424 for (i = 0; i < life->h; i++) {
425 uint8_t *p = picref->data[0] + i * picref->linesize[0];
426 for (j = 0; j < life->w; j++) {
427 uint8_t v = buf[i*life->w + j];
428 if (life->mold && v != ALIVE_CELL) {
429 const uint8_t *c1 = life-> mold_color;
430 const uint8_t *c2 = life->death_color;
431 int death_age = FFMIN((0xff - v) * life->mold, 0xff);
432 *p++ = FAST_DIV255((c2[0] << 8) + ((int)c1[0] - (int)c2[0]) * death_age);
433 *p++ = FAST_DIV255((c2[1] << 8) + ((int)c1[1] - (int)c2[1]) * death_age);
434 *p++ = FAST_DIV255((c2[2] << 8) + ((int)c1[2] - (int)c2[2]) * death_age);
436 const uint8_t *c = v == ALIVE_CELL ? life->life_color : life->death_color;
437 AV_WB24(p, c[0]<<16 | c[1]<<8 | c[2]);
444 static int request_frame(AVFilterLink *outlink)
446 LifeContext *life = outlink->src->priv;
447 AVFilterBufferRef *picref = avfilter_get_video_buffer(outlink, AV_PERM_WRITE, life->w, life->h);
448 picref->video->sample_aspect_ratio = (AVRational) {1, 1};
449 picref->pts = life->pts++;
452 life->draw(outlink->src, picref);
453 evolve(outlink->src);
455 show_life_grid(outlink->src);
458 avfilter_start_frame(outlink, avfilter_ref_buffer(picref, ~0));
459 avfilter_draw_slice(outlink, 0, life->h, 1);
460 avfilter_end_frame(outlink);
461 avfilter_unref_buffer(picref);
466 static int query_formats(AVFilterContext *ctx)
468 LifeContext *life = ctx->priv;
469 enum PixelFormat pix_fmts[] = { PIX_FMT_NONE, PIX_FMT_NONE };
470 if (life->mold || memcmp(life-> life_color, "\xff\xff\xff", 3)
471 || memcmp(life->death_color, "\x00\x00\x00", 3)) {
472 pix_fmts[0] = PIX_FMT_RGB24;
473 life->draw = fill_picture_rgb;
475 pix_fmts[0] = PIX_FMT_MONOBLACK;
476 life->draw = fill_picture_monoblack;
478 avfilter_set_common_pixel_formats(ctx, avfilter_make_format_list(pix_fmts));
482 AVFilter avfilter_vsrc_life = {
484 .description = NULL_IF_CONFIG_SMALL("Create life."),
485 .priv_size = sizeof(LifeContext),
488 .query_formats = query_formats,
490 .inputs = (const AVFilterPad[]) {
493 .outputs = (const AVFilterPad[]) {
495 .type = AVMEDIA_TYPE_VIDEO,
496 .request_frame = request_frame,
497 .config_props = config_props },