lavfi: add perms and aperms filters.
[ffmpeg.git] / libavfilter / f_perms.c
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #include "libavutil/lfg.h"
20 #include "libavutil/opt.h"
21 #include "libavutil/random_seed.h"
22 #include "audio.h"
23 #include "video.h"
24
25 enum mode {
26     MODE_NONE,
27     MODE_RO,
28     MODE_RW,
29     MODE_TOGGLE,
30     MODE_RANDOM,
31     NB_MODES
32 };
33
34 typedef struct {
35     const AVClass *class;
36     AVLFG lfg;
37     enum mode mode;
38 } PermsContext;
39
40 #define OFFSET(x) offsetof(PermsContext, x)
41 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM
42
43 static const AVOption options[] = {
44     { "mode", "select permissions mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = MODE_NONE}, MODE_NONE, NB_MODES-1, FLAGS, "mode" },
45         { "none",   "do nothing",                       0, AV_OPT_TYPE_CONST, {.i64 = MODE_NONE},       INT_MIN, INT_MAX, FLAGS, "mode" },
46         { "ro",     "set all output frames read-only",  0, AV_OPT_TYPE_CONST, {.i64 = MODE_RO},         INT_MIN, INT_MAX, FLAGS, "mode" },
47         { "rw",     "set all output frames writable",   0, AV_OPT_TYPE_CONST, {.i64 = MODE_RW},         INT_MIN, INT_MAX, FLAGS, "mode" },
48         { "toggle", "switch permissions",               0, AV_OPT_TYPE_CONST, {.i64 = MODE_TOGGLE},     INT_MIN, INT_MAX, FLAGS, "mode" },
49         { "random", "set permissions randomly",         0, AV_OPT_TYPE_CONST, {.i64 = MODE_RANDOM},     INT_MIN, INT_MAX, FLAGS, "mode" },
50     { NULL }
51 };
52
53 static av_cold int init(AVFilterContext *ctx, const char *args, const AVClass *class)
54 {
55     int ret;
56     PermsContext *perms = ctx->priv;
57     static const char *shorthand[] = { "mode", NULL };
58
59     perms->class = class;
60     av_opt_set_defaults(perms);
61
62     if ((ret = av_opt_set_from_string(perms, args, shorthand, "=", ":")) < 0)
63         return ret;
64
65     // TODO: add a seed option
66     if (perms->mode == MODE_RANDOM)
67         av_lfg_init(&perms->lfg, av_get_random_seed());
68
69     av_opt_free(perms);
70     return 0;
71 }
72
73 enum perm                        {  RO,   RW  };
74 static const char *perm_str[2] = { "RO", "RW" };
75
76 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
77 {
78     int ret;
79     AVFilterContext *ctx = inlink->dst;
80     PermsContext *perms = ctx->priv;
81     AVFrame *out = frame;
82     enum perm in_perm = av_frame_is_writable(frame) ? RW : RO;
83     enum perm out_perm;
84
85     switch (perms->mode) {
86     case MODE_TOGGLE:   out_perm = in_perm == RO ? RW : RO;                 break;
87     case MODE_RANDOM:   out_perm = av_lfg_get(&perms->lfg) & 1 ? RW : RO;   break;
88     case MODE_RO:       out_perm = RO;                                      break;
89     case MODE_RW:       out_perm = RW;                                      break;
90     default:            out_perm = in_perm;                                 break;
91     }
92
93     av_log(ctx, AV_LOG_VERBOSE, "%s -> %s%s\n",
94            perm_str[in_perm], perm_str[out_perm],
95            in_perm == out_perm ? " (no-op)" : "");
96
97     if (in_perm == RO && out_perm == RW) {
98         if ((ret = av_frame_make_writable(frame)) < 0)
99             return ret;
100     } else if (in_perm == RW && out_perm == RO) {
101         out = av_frame_clone(frame);
102         if (!out)
103             return AVERROR(ENOMEM);
104     }
105
106     ret = ff_filter_frame(ctx->outputs[0], out);
107
108     if (in_perm == RW && out_perm == RO)
109         av_frame_free(&frame);
110     return ret;
111 }
112
113 #if CONFIG_APERMS_FILTER
114
115 #define aperms_options options
116 AVFILTER_DEFINE_CLASS(aperms);
117
118 static av_cold int aperms_init(AVFilterContext *ctx, const char *args)
119 {
120     return init(ctx, args, &aperms_class);
121 }
122
123 static const AVFilterPad aperms_inputs[] = {
124     {
125         .name         = "default",
126         .type         = AVMEDIA_TYPE_AUDIO,
127         .filter_frame = filter_frame,
128     },
129     { NULL }
130 };
131
132 static const AVFilterPad aperms_outputs[] = {
133     {
134         .name = "default",
135         .type = AVMEDIA_TYPE_AUDIO,
136     },
137     { NULL }
138 };
139
140 AVFilter avfilter_af_aperms = {
141     .name        = "aperms",
142     .description = NULL_IF_CONFIG_SMALL("Set permissions for the output audio frame."),
143     .init        = aperms_init,
144     .priv_size   = sizeof(PermsContext),
145     .inputs      = aperms_inputs,
146     .outputs     = aperms_outputs,
147     .priv_class  = &aperms_class,
148 };
149 #endif /* CONFIG_APERMS_FILTER */
150
151 #if CONFIG_PERMS_FILTER
152
153 #define perms_options options
154 AVFILTER_DEFINE_CLASS(perms);
155
156 static av_cold int perms_init(AVFilterContext *ctx, const char *args)
157 {
158     return init(ctx, args, &perms_class);
159 }
160
161 static const AVFilterPad perms_inputs[] = {
162     {
163         .name         = "default",
164         .type         = AVMEDIA_TYPE_VIDEO,
165         .filter_frame = filter_frame,
166     },
167     { NULL }
168 };
169
170 static const AVFilterPad perms_outputs[] = {
171     {
172         .name = "default",
173         .type = AVMEDIA_TYPE_VIDEO,
174     },
175     { NULL }
176 };
177
178 AVFilter avfilter_vf_perms = {
179     .name        = "perms",
180     .description = NULL_IF_CONFIG_SMALL("Set permissions for the output video frame."),
181     .init        = perms_init,
182     .priv_size   = sizeof(PermsContext),
183     .inputs      = perms_inputs,
184     .outputs     = perms_outputs,
185     .priv_class  = &perms_class,
186 };
187 #endif /* CONFIG_PERMS_FILTER */