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