git.sesse.net Git - ffmpeg/blob - 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 "libavutil/avstring.h"
  34 #include "avfilter.h"
  35 #include "internal.h"
  36 #include "formats.h"
  37 #include "video.h"
  38
  39 typedef struct {
  40     const AVClass *class;
  41     int w, h;
  42     char *filename;
  43     char *rule_str;
  44     uint8_t *file_buf;
  45     size_t file_bufsize;
  46     uint8_t *buf;
  47     int buf_prev_row_idx, buf_row_idx;
  48     uint8_t rule;
  49     uint64_t pts;
  50     AVRational 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(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.str = "25"}, 0, 0, FLAGS },
  68     { "r",        "set video rate", OFFSET(frame_rate), AV_OPT_TYPE_VIDEO_RATE, {.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] = !!av_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     int ret;
 166
 167     cellauto->class = &cellauto_class;
 168     av_opt_set_defaults(cellauto);
 169
 170     if ((ret = av_set_options_string(cellauto, args, "=", ":")) < 0)
 171         return ret;
 172
 173     if (!cellauto->w && !cellauto->filename && !cellauto->pattern)
 174         av_opt_set(cellauto, "size", "320x518", 0);
 175
 176     if (cellauto->filename && cellauto->pattern) {
 177         av_log(ctx, AV_LOG_ERROR, "Only one of the filename or pattern options can be used\n");
 178         return AVERROR(EINVAL);
 179     }
 180
 181     if (cellauto->filename) {
 182         if ((ret = init_pattern_from_file(ctx)) < 0)
 183             return ret;
 184     } else if (cellauto->pattern) {
 185         if ((ret = init_pattern_from_string(ctx)) < 0)
 186             return ret;
 187     } else {
 188         /* fill the first row randomly */
 189         int i;
 190
 191         cellauto->buf = av_mallocz(sizeof(uint8_t) * cellauto->w * cellauto->h);
 192         if (!cellauto->buf)
 193             return AVERROR(ENOMEM);
 194         if (cellauto->random_seed == -1)
 195             cellauto->random_seed = av_get_random_seed();
 196
 197         av_lfg_init(&cellauto->lfg, cellauto->random_seed);
 198
 199         for (i = 0; i < cellauto->w; i++) {
 200             double r = (double)av_lfg_get(&cellauto->lfg) / UINT32_MAX;
 201             if (r <= cellauto->random_fill_ratio)
 202                 cellauto->buf[i] = 1;
 203         }
 204     }
 205
 206     av_log(ctx, AV_LOG_VERBOSE,
 207            "s:%dx%d r:%d/%d rule:%d stitch:%d scroll:%d full:%d seed:%u\n",
 208            cellauto->w, cellauto->h, cellauto->frame_rate.num, cellauto->frame_rate.den,
 209            cellauto->rule, cellauto->stitch, cellauto->scroll, cellauto->start_full,
 210            cellauto->random_seed);
 211     return 0;
 212 }
 213
 214 static av_cold void uninit(AVFilterContext *ctx)
 215 {
 216     CellAutoContext *cellauto = ctx->priv;
 217
 218     av_file_unmap(cellauto->file_buf, cellauto->file_bufsize);
 219     av_freep(&cellauto->buf);
 220     av_freep(&cellauto->pattern);
 221 }
 222
 223 static int config_props(AVFilterLink *outlink)
 224 {
 225     CellAutoContext *cellauto = outlink->src->priv;
 226
 227     outlink->w = cellauto->w;
 228     outlink->h = cellauto->h;
 229     outlink->time_base = av_inv_q(cellauto->frame_rate);
 230
 231     return 0;
 232 }
 233
 234 static void evolve(AVFilterContext *ctx)
 235 {
 236     CellAutoContext *cellauto = ctx->priv;
 237     int i, v, pos[3];
 238     uint8_t *row, *prev_row = cellauto->buf + cellauto->buf_row_idx * cellauto->w;
 239     enum { NW, N, NE };
 240
 241     cellauto->buf_prev_row_idx = cellauto->buf_row_idx;
 242     cellauto->buf_row_idx      = cellauto->buf_row_idx == cellauto->h-1 ? 0 : cellauto->buf_row_idx+1;
 243     row = cellauto->buf + cellauto->w * cellauto->buf_row_idx;
 244
 245     for (i = 0; i < cellauto->w; i++) {
 246         if (cellauto->stitch) {
 247             pos[NW] = i-1 < 0 ? cellauto->w-1 : i-1;
 248             pos[N]  = i;
 249             pos[NE] = i+1 == cellauto->w ? 0  : i+1;
 250             v = prev_row[pos[NW]]<<2 | prev_row[pos[N]]<<1 | prev_row[pos[NE]];
 251         } else {
 252             v = 0;
 253             v|= i-1 >= 0          ? prev_row[i-1]<<2 : 0;
 254             v|=                     prev_row[i  ]<<1    ;
 255             v|= i+1 < cellauto->w ? prev_row[i+1]    : 0;
 256         }
 257         row[i] = !!(cellauto->rule & (1<<v));
 258         av_dlog(ctx, "i:%d context:%c%c%c -> cell:%d\n", i,
 259                 v&4?'@':' ', v&2?'@':' ', v&1?'@':' ', row[i]);
 260     }
 261
 262     cellauto->generation++;
 263 }
 264
 265 static void fill_picture(AVFilterContext *ctx, AVFrame *picref)
 266 {
 267     CellAutoContext *cellauto = ctx->priv;
 268     int i, j, k, row_idx = 0;
 269     uint8_t *p0 = picref->data[0];
 270
 271     if (cellauto->scroll && cellauto->generation >= cellauto->h)
 272         /* show on top the oldest row */
 273         row_idx = (cellauto->buf_row_idx + 1) % cellauto->h;
 274
 275     /* fill the output picture with the whole buffer */
 276     for (i = 0; i < cellauto->h; i++) {
 277         uint8_t byte = 0;
 278         uint8_t *row = cellauto->buf + row_idx*cellauto->w;
 279         uint8_t *p = p0;
 280         for (k = 0, j = 0; j < cellauto->w; j++) {
 281             byte |= row[j]<<(7-k++);
 282             if (k==8 || j == cellauto->w-1) {
 283                 k = 0;
 284                 *p++ = byte;
 285                 byte = 0;
 286             }
 287         }
 288         row_idx = (row_idx + 1) % cellauto->h;
 289         p0 += picref->linesize[0];
 290     }
 291 }
 292
 293 static int request_frame(AVFilterLink *outlink)
 294 {
 295     CellAutoContext *cellauto = outlink->src->priv;
 296     AVFrame *picref = ff_get_video_buffer(outlink, cellauto->w, cellauto->h);
 297     if (!picref)
 298         return AVERROR(ENOMEM);
 299     picref->sample_aspect_ratio = (AVRational) {1, 1};
 300     if (cellauto->generation == 0 && cellauto->start_full) {
 301         int i;
 302         for (i = 0; i < cellauto->h-1; i++)
 303             evolve(outlink->src);
 304     }
 305     fill_picture(outlink->src, picref);
 306     evolve(outlink->src);
 307
 308     picref->pts = cellauto->pts++;
 309
 310 #ifdef DEBUG
 311     show_cellauto_row(outlink->src);
 312 #endif
 313     return ff_filter_frame(outlink, picref);
 314 }
 315
 316 static int query_formats(AVFilterContext *ctx)
 317 {
 318     static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_NONE };
 319     ff_set_common_formats(ctx, ff_make_format_list(pix_fmts));
 320     return 0;
 321 }
 322
 323 static const AVFilterPad cellauto_outputs[] = {
 324     {
 325         .name            = "default",
 326         .type            = AVMEDIA_TYPE_VIDEO,
 327         .request_frame   = request_frame,
 328         .config_props    = config_props,
 329     },
 330     { NULL }
 331 };
 332
 333 AVFilter avfilter_vsrc_cellauto = {
 334     .name        = "cellauto",
 335     .description = NULL_IF_CONFIG_SMALL("Create pattern generated by an elementary cellular automaton."),
 336     .priv_size = sizeof(CellAutoContext),
 337     .init      = init,
 338     .uninit    = uninit,
 339     .query_formats = query_formats,
 340     .inputs        = NULL,
 341     .outputs       = cellauto_outputs,
 342     .priv_class    = &cellauto_class,
 343 };