lavfi: update some deprecated functions
[ffmpeg.git] / libavfilter / vsrc_life.c
1 /*
2  * Copyright (c) Stefano Sabatini 2010
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  * life video source, based on John Conways' Life Game
24  */
25
26 /* #define DEBUG */
27
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"
34 #include "avfilter.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
46     /**
47      * The two grid state buffers.
48      *
49      * A 0xFF (ALIVE_CELL) value means the cell is alive (or new born), while
50      * the decreasing values from 0xFE to 0 means the cell is dead; the range
51      * of values is used for the slow death effect, or mold (0xFE means dead,
52      * 0xFD means very dead, 0xFC means very very dead... and 0x00 means
53      * definitely dead/mold).
54      */
55     uint8_t *buf[2];
56
57     uint8_t  buf_idx;
58     uint16_t stay_rule;         ///< encode the behavior for filled cells
59     uint16_t born_rule;         ///< encode the behavior for empty cells
60     uint64_t pts;
61     AVRational time_base;
62     char *rate;                 ///< video frame rate
63     double   random_fill_ratio;
64     uint32_t random_seed;
65     int stitch;
66     int mold;
67     char  *life_color_str;
68     char *death_color_str;
69     char  *mold_color_str;
70     uint8_t  life_color[4];
71     uint8_t death_color[4];
72     uint8_t  mold_color[4];
73     AVLFG lfg;
74     void (*draw)(AVFilterContext*, AVFilterBufferRef*);
75 } LifeContext;
76
77 #define ALIVE_CELL 0xFF
78 #define OFFSET(x) offsetof(LifeContext, x)
79
80 static const AVOption life_options[] = {
81     { "filename", "set source file",  OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0 },
82     { "f",        "set source file",  OFFSET(filename), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0 },
83     { "size",     "set video size",   OFFSET(w),        AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, 0, 0 },
84     { "s",        "set video size",   OFFSET(w),        AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL}, 0, 0 },
85     { "rate",     "set video rate",   OFFSET(rate),     AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0 },
86     { "r",        "set video rate",   OFFSET(rate),     AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0 },
87     { "rule",     "set rule",         OFFSET(rule_str), AV_OPT_TYPE_STRING, {.str = "B3/S23"}, CHAR_MIN, CHAR_MAX },
88     { "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 },
89     { "ratio",             "set fill ratio for filling initial grid randomly", OFFSET(random_fill_ratio), AV_OPT_TYPE_DOUBLE, {.dbl=1/M_PHI}, 0, 1 },
90     { "random_seed", "set the seed for filling the initial grid randomly", OFFSET(random_seed), AV_OPT_TYPE_INT, {.dbl=-1}, -1, UINT32_MAX },
91     { "seed",        "set the seed for filling the initial grid randomly", OFFSET(random_seed), AV_OPT_TYPE_INT, {.dbl=-1}, -1, UINT32_MAX },
92     { "stitch",      "stitch boundaries", OFFSET(stitch), AV_OPT_TYPE_INT, {.dbl=1}, 0, 1 },
93     { "mold",        "set mold speed for dead cells", OFFSET(mold), AV_OPT_TYPE_INT, {.dbl=0}, 0, 0xFF },
94     { "life_color",  "set life color",  OFFSET( life_color_str), AV_OPT_TYPE_STRING, {.str="white"}, CHAR_MIN, CHAR_MAX },
95     { "death_color", "set death color", OFFSET(death_color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
96     { "mold_color",  "set mold color",  OFFSET( mold_color_str), AV_OPT_TYPE_STRING, {.str="black"}, CHAR_MIN, CHAR_MAX },
97     { NULL },
98 };
99
100 static const AVClass life_class = {
101     "LifeContext",
102     av_default_item_name,
103     life_options
104 };
105
106 static int parse_rule(uint16_t *born_rule, uint16_t *stay_rule,
107                       const char *rule_str, void *log_ctx)
108 {
109     char *tail;
110     const char *p = rule_str;
111     *born_rule = 0;
112     *stay_rule = 0;
113
114     if (strchr("bBsS", *p)) {
115         /* parse rule as a Born / Stay Alive code, see
116          * http://en.wikipedia.org/wiki/Conway%27s_Game_of_Life */
117         do {
118             uint16_t *rule = (*p == 'b' || *p == 'B') ? born_rule : stay_rule;
119             p++;
120             while (*p >= '0' && *p <= '8') {
121                 *rule += 1<<(*p - '0');
122                 p++;
123             }
124             if (*p != '/')
125                 break;
126             p++;
127         } while (strchr("bBsS", *p));
128
129         if (*p)
130             goto error;
131     } else {
132         /* parse rule as a number, expressed in the form STAY|(BORN<<9),
133          * where STAY and BORN encode the corresponding 9-bits rule */
134         long int rule = strtol(rule_str, &tail, 10);
135         if (*tail)
136             goto error;
137         *born_rule  = ((1<<9)-1) & rule;
138         *stay_rule = rule >> 9;
139     }
140
141     return 0;
142
143 error:
144     av_log(log_ctx, AV_LOG_ERROR, "Invalid rule code '%s' provided\n", rule_str);
145     return AVERROR(EINVAL);
146 }
147
148 #ifdef DEBUG
149 static void show_life_grid(AVFilterContext *ctx)
150 {
151     LifeContext *life = ctx->priv;
152     int i, j;
153
154     char *line = av_malloc(life->w + 1);
155     if (!line)
156         return;
157     for (i = 0; i < life->h; i++) {
158         for (j = 0; j < life->w; j++)
159             line[j] = life->buf[life->buf_idx][i*life->w + j] == ALIVE_CELL ? '@' : ' ';
160         line[j] = 0;
161         av_log(ctx, AV_LOG_DEBUG, "%3d: %s\n", i, line);
162     }
163     av_free(line);
164 }
165 #endif
166
167 static int init_pattern_from_file(AVFilterContext *ctx)
168 {
169     LifeContext *life = ctx->priv;
170     char *p;
171     int ret, i, i0, j, h = 0, w, max_w = 0;
172
173     if ((ret = av_file_map(life->filename, &life->file_buf, &life->file_bufsize,
174                            0, ctx)) < 0)
175         return ret;
176     av_freep(&life->filename);
177
178     /* prescan file to get the number of lines and the maximum width */
179     w = 0;
180     for (i = 0; i < life->file_bufsize; i++) {
181         if (life->file_buf[i] == '\n') {
182             h++; max_w = FFMAX(w, max_w); w = 0;
183         } else {
184             w++;
185         }
186     }
187     av_log(ctx, AV_LOG_DEBUG, "h:%d max_w:%d\n", h, max_w);
188
189     if (life->w) {
190         if (max_w > life->w || h > life->h) {
191             av_log(ctx, AV_LOG_ERROR,
192                    "The specified size is %dx%d which cannot contain the provided file size of %dx%d\n",
193                    life->w, life->h, max_w, h);
194             return AVERROR(EINVAL);
195         }
196     } else {
197         /* size was not specified, set it to size of the grid */
198         life->w = max_w;
199         life->h = h;
200     }
201
202     if (!(life->buf[0] = av_mallocz(sizeof(char) * life->h * life->w)) ||
203         !(life->buf[1] = av_mallocz(sizeof(char) * life->h * life->w))) {
204         av_free(life->buf[0]);
205         av_free(life->buf[1]);
206         return AVERROR(ENOMEM);
207     }
208
209     /* fill buf[0] */
210     p = life->file_buf;
211     for (i0 = 0, i = (life->h - h)/2; i0 < h; i0++, i++) {
212         for (j = (life->w - max_w)/2;; j++) {
213             av_log(ctx, AV_LOG_DEBUG, "%d:%d %c\n", i, j, *p == '\n' ? 'N' : *p);
214             if (*p == '\n') {
215                 p++; break;
216             } else
217                 life->buf[0][i*life->w + j] = isgraph(*(p++)) ? ALIVE_CELL : 0;
218         }
219     }
220     life->buf_idx = 0;
221
222     return 0;
223 }
224
225 static int init(AVFilterContext *ctx, const char *args, void *opaque)
226 {
227     LifeContext *life = ctx->priv;
228     AVRational frame_rate;
229     int ret;
230
231     life->class = &life_class;
232     av_opt_set_defaults(life);
233
234     if ((ret = av_set_options_string(life, args, "=", ":")) < 0) {
235         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
236         return ret;
237     }
238
239     if ((ret = av_parse_video_rate(&frame_rate, life->rate)) < 0) {
240         av_log(ctx, AV_LOG_ERROR, "Invalid frame rate: %s\n", life->rate);
241         return AVERROR(EINVAL);
242     }
243     av_freep(&life->rate);
244
245     if (!life->w && !life->filename)
246         av_opt_set(life, "size", "320x240", 0);
247
248     if ((ret = parse_rule(&life->born_rule, &life->stay_rule, life->rule_str, ctx)) < 0)
249         return ret;
250
251 #define PARSE_COLOR(name) do { \
252     if ((ret = av_parse_color(life->name ## _color, life->name ## _color_str, -1, ctx))) { \
253         av_log(ctx, AV_LOG_ERROR, "Invalid " #name " color '%s'\n", \
254                life->name ## _color_str); \
255         return ret; \
256     } \
257     av_freep(&life->name ## _color_str); \
258 } while (0)
259
260     PARSE_COLOR(life);
261     PARSE_COLOR(death);
262     PARSE_COLOR(mold);
263
264     if (!life->mold && memcmp(life->mold_color, "\x00\x00\x00", 3))
265         av_log(ctx, AV_LOG_WARNING,
266                "Mold color is set while mold isn't, ignoring the color.\n");
267
268     life->time_base.num = frame_rate.den;
269     life->time_base.den = frame_rate.num;
270
271     if (!life->filename) {
272         /* fill the grid randomly */
273         int i;
274
275         if (!(life->buf[0] = av_mallocz(sizeof(char) * life->h * life->w)) ||
276             !(life->buf[1] = av_mallocz(sizeof(char) * life->h * life->w))) {
277             av_free(life->buf[0]);
278             av_free(life->buf[1]);
279             return AVERROR(ENOMEM);
280         }
281         if (life->random_seed == -1)
282             life->random_seed = av_get_random_seed();
283
284         av_lfg_init(&life->lfg, life->random_seed);
285
286         for (i = 0; i < life->w * life->h; i++) {
287             double r = (double)av_lfg_get(&life->lfg) / UINT32_MAX;
288             if (r <= life->random_fill_ratio)
289                 life->buf[0][i] = ALIVE_CELL;
290         }
291         life->buf_idx = 0;
292     } else {
293         if ((ret = init_pattern_from_file(ctx)) < 0)
294             return ret;
295     }
296
297     av_log(ctx, AV_LOG_INFO,
298            "s:%dx%d r:%d/%d rule:%s stay_rule:%d born_rule:%d stitch:%d seed:%u\n",
299            life->w, life->h, frame_rate.num, frame_rate.den,
300            life->rule_str, life->stay_rule, life->born_rule, life->stitch,
301            life->random_seed);
302     return 0;
303 }
304
305 static av_cold void uninit(AVFilterContext *ctx)
306 {
307     LifeContext *life = ctx->priv;
308
309     av_file_unmap(life->file_buf, life->file_bufsize);
310     av_freep(&life->rule_str);
311     av_freep(&life->buf[0]);
312     av_freep(&life->buf[1]);
313 }
314
315 static int config_props(AVFilterLink *outlink)
316 {
317     LifeContext *life = outlink->src->priv;
318
319     outlink->w = life->w;
320     outlink->h = life->h;
321     outlink->time_base = life->time_base;
322
323     return 0;
324 }
325
326 static void evolve(AVFilterContext *ctx)
327 {
328     LifeContext *life = ctx->priv;
329     int i, j;
330     uint8_t *oldbuf = life->buf[ life->buf_idx];
331     uint8_t *newbuf = life->buf[!life->buf_idx];
332
333     enum { NW, N, NE, W, E, SW, S, SE };
334
335     /* evolve the grid */
336     for (i = 0; i < life->h; i++) {
337         for (j = 0; j < life->w; j++) {
338             int pos[8][2], n, alive, cell;
339             if (life->stitch) {
340                 pos[NW][0] = (i-1) < 0 ? life->h-1 : i-1; pos[NW][1] = (j-1) < 0 ? life->w-1 : j-1;
341                 pos[N ][0] = (i-1) < 0 ? life->h-1 : i-1; pos[N ][1] =                         j  ;
342                 pos[NE][0] = (i-1) < 0 ? life->h-1 : i-1; pos[NE][1] = (j+1) == life->w ?  0 : j+1;
343                 pos[W ][0] =                         i  ; pos[W ][1] = (j-1) < 0 ? life->w-1 : j-1;
344                 pos[E ][0] =                         i  ; pos[E ][1] = (j+1) == life->w ? 0  : j+1;
345                 pos[SW][0] = (i+1) == life->h ?  0 : i+1; pos[SW][1] = (j-1) < 0 ? life->w-1 : j-1;
346                 pos[S ][0] = (i+1) == life->h ?  0 : i+1; pos[S ][1] =                         j  ;
347                 pos[SE][0] = (i+1) == life->h ?  0 : i+1; pos[SE][1] = (j+1) == life->w ?  0 : j+1;
348             } else {
349                 pos[NW][0] = (i-1) < 0 ? -1        : i-1; pos[NW][1] = (j-1) < 0 ? -1        : j-1;
350                 pos[N ][0] = (i-1) < 0 ? -1        : i-1; pos[N ][1] =                         j  ;
351                 pos[NE][0] = (i-1) < 0 ? -1        : i-1; pos[NE][1] = (j+1) == life->w ? -1 : j+1;
352                 pos[W ][0] =                         i  ; pos[W ][1] = (j-1) < 0 ? -1        : j-1;
353                 pos[E ][0] =                         i  ; pos[E ][1] = (j+1) == life->w ? -1 : j+1;
354                 pos[SW][0] = (i+1) == life->h ? -1 : i+1; pos[SW][1] = (j-1) < 0 ? -1        : j-1;
355                 pos[S ][0] = (i+1) == life->h ? -1 : i+1; pos[S ][1] =                         j  ;
356                 pos[SE][0] = (i+1) == life->h ? -1 : i+1; pos[SE][1] = (j+1) == life->w ? -1 : j+1;
357             }
358
359             /* compute the number of live neighbor cells */
360             n = (pos[NW][0] == -1 || pos[NW][1] == -1 ? 0 : oldbuf[pos[NW][0]*life->w + pos[NW][1]] == ALIVE_CELL) +
361                 (pos[N ][0] == -1 || pos[N ][1] == -1 ? 0 : oldbuf[pos[N ][0]*life->w + pos[N ][1]] == ALIVE_CELL) +
362                 (pos[NE][0] == -1 || pos[NE][1] == -1 ? 0 : oldbuf[pos[NE][0]*life->w + pos[NE][1]] == ALIVE_CELL) +
363                 (pos[W ][0] == -1 || pos[W ][1] == -1 ? 0 : oldbuf[pos[W ][0]*life->w + pos[W ][1]] == ALIVE_CELL) +
364                 (pos[E ][0] == -1 || pos[E ][1] == -1 ? 0 : oldbuf[pos[E ][0]*life->w + pos[E ][1]] == ALIVE_CELL) +
365                 (pos[SW][0] == -1 || pos[SW][1] == -1 ? 0 : oldbuf[pos[SW][0]*life->w + pos[SW][1]] == ALIVE_CELL) +
366                 (pos[S ][0] == -1 || pos[S ][1] == -1 ? 0 : oldbuf[pos[S ][0]*life->w + pos[S ][1]] == ALIVE_CELL) +
367                 (pos[SE][0] == -1 || pos[SE][1] == -1 ? 0 : oldbuf[pos[SE][0]*life->w + pos[SE][1]] == ALIVE_CELL);
368             cell  = oldbuf[i*life->w + j];
369             alive = 1<<n & (cell == ALIVE_CELL ? life->stay_rule : life->born_rule);
370             if (alive)     *newbuf = ALIVE_CELL; // new cell is alive
371             else if (cell) *newbuf = cell - 1;   // new cell is dead and in the process of mold
372             else           *newbuf = 0;          // new cell is definitely dead
373             av_dlog(ctx, "i:%d j:%d live_neighbors:%d cell:%d -> cell:%d\n", i, j, n, cell, *newbuf);
374             newbuf++;
375         }
376     }
377
378     life->buf_idx = !life->buf_idx;
379 }
380
381 static void fill_picture_monoblack(AVFilterContext *ctx, AVFilterBufferRef *picref)
382 {
383     LifeContext *life = ctx->priv;
384     uint8_t *buf = life->buf[life->buf_idx];
385     int i, j, k;
386
387     /* fill the output picture with the old grid buffer */
388     for (i = 0; i < life->h; i++) {
389         uint8_t byte = 0;
390         uint8_t *p = picref->data[0] + i * picref->linesize[0];
391         for (k = 0, j = 0; j < life->w; j++) {
392             byte |= (buf[i*life->w+j] == ALIVE_CELL)<<(7-k++);
393             if (k==8 || j == life->w-1) {
394                 k = 0;
395                 *p++ = byte;
396                 byte = 0;
397             }
398         }
399     }
400 }
401
402 // divide by 255 and round to nearest
403 // apply a fast variant: (X+127)/255 = ((X+127)*257+257)>>16 = ((X+128)*257)>>16
404 #define FAST_DIV255(x) ((((x) + 128) * 257) >> 16)
405
406 static void fill_picture_rgb(AVFilterContext *ctx, AVFilterBufferRef *picref)
407 {
408     LifeContext *life = ctx->priv;
409     uint8_t *buf = life->buf[life->buf_idx];
410     int i, j;
411
412     /* fill the output picture with the old grid buffer */
413     for (i = 0; i < life->h; i++) {
414         uint8_t *p = picref->data[0] + i * picref->linesize[0];
415         for (j = 0; j < life->w; j++) {
416             uint8_t v = buf[i*life->w + j];
417             if (life->mold && v != ALIVE_CELL) {
418                 const uint8_t *c1 = life-> mold_color;
419                 const uint8_t *c2 = life->death_color;
420                 int death_age = FFMIN((0xff - v) * life->mold, 0xff);
421                 *p++ = FAST_DIV255((c2[0] << 8) + ((int)c1[0] - (int)c2[0]) * death_age);
422                 *p++ = FAST_DIV255((c2[1] << 8) + ((int)c1[1] - (int)c2[1]) * death_age);
423                 *p++ = FAST_DIV255((c2[2] << 8) + ((int)c1[2] - (int)c2[2]) * death_age);
424             } else {
425                 const uint8_t *c = v == ALIVE_CELL ? life->life_color : life->death_color;
426                 AV_WB24(p, c[0]<<16 | c[1]<<8 | c[2]);
427                 p += 3;
428             }
429         }
430     }
431 }
432
433 static int request_frame(AVFilterLink *outlink)
434 {
435     LifeContext *life = outlink->src->priv;
436     AVFilterBufferRef *picref = ff_get_video_buffer(outlink, AV_PERM_WRITE, life->w, life->h);
437     picref->video->sample_aspect_ratio = (AVRational) {1, 1};
438     picref->pts = life->pts++;
439     picref->pos = -1;
440
441     life->draw(outlink->src, picref);
442     evolve(outlink->src);
443 #ifdef DEBUG
444     show_life_grid(outlink->src);
445 #endif
446
447     ff_start_frame(outlink, avfilter_ref_buffer(picref, ~0));
448     ff_draw_slice(outlink, 0, life->h, 1);
449     ff_end_frame(outlink);
450     avfilter_unref_buffer(picref);
451
452     return 0;
453 }
454
455 static int query_formats(AVFilterContext *ctx)
456 {
457     LifeContext *life = ctx->priv;
458     enum PixelFormat pix_fmts[] = { PIX_FMT_NONE, PIX_FMT_NONE };
459     if (life->mold || memcmp(life-> life_color, "\xff\xff\xff", 3)
460                    || memcmp(life->death_color, "\x00\x00\x00", 3)) {
461         pix_fmts[0] = PIX_FMT_RGB24;
462         life->draw = fill_picture_rgb;
463     } else {
464         pix_fmts[0] = PIX_FMT_MONOBLACK;
465         life->draw = fill_picture_monoblack;
466     }
467     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
468     return 0;
469 }
470
471 AVFilter avfilter_vsrc_life = {
472     .name        = "life",
473     .description = NULL_IF_CONFIG_SMALL("Create life."),
474     .priv_size = sizeof(LifeContext),
475     .init      = init,
476     .uninit    = uninit,
477     .query_formats = query_formats,
478
479     .inputs    = (const AVFilterPad[]) {
480         { .name = NULL}
481     },
482     .outputs   = (const AVFilterPad[]) {
483         { .name            = "default",
484           .type            = AVMEDIA_TYPE_VIDEO,
485           .request_frame   = request_frame,
486           .config_props    = config_props },
487         { .name = NULL}
488     },
489 };