lavfi/perms: use standard options parsing.
[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     PermsContext *perms = ctx->priv;
56
57     // TODO: add a seed option
58     if (perms->mode == MODE_RANDOM)
59         av_lfg_init(&perms->lfg, av_get_random_seed());
60
61     return 0;
62 }
63
64 enum perm                        {  RO,   RW  };
65 static const char *perm_str[2] = { "RO", "RW" };
66
67 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
68 {
69     int ret;
70     AVFilterContext *ctx = inlink->dst;
71     PermsContext *perms = ctx->priv;
72     AVFrame *out = frame;
73     enum perm in_perm = av_frame_is_writable(frame) ? RW : RO;
74     enum perm out_perm;
75
76     switch (perms->mode) {
77     case MODE_TOGGLE:   out_perm = in_perm == RO ? RW : RO;                 break;
78     case MODE_RANDOM:   out_perm = av_lfg_get(&perms->lfg) & 1 ? RW : RO;   break;
79     case MODE_RO:       out_perm = RO;                                      break;
80     case MODE_RW:       out_perm = RW;                                      break;
81     default:            out_perm = in_perm;                                 break;
82     }
83
84     av_log(ctx, AV_LOG_VERBOSE, "%s -> %s%s\n",
85            perm_str[in_perm], perm_str[out_perm],
86            in_perm == out_perm ? " (no-op)" : "");
87
88     if (in_perm == RO && out_perm == RW) {
89         if ((ret = av_frame_make_writable(frame)) < 0)
90             return ret;
91     } else if (in_perm == RW && out_perm == RO) {
92         out = av_frame_clone(frame);
93         if (!out)
94             return AVERROR(ENOMEM);
95     }
96
97     ret = ff_filter_frame(ctx->outputs[0], out);
98
99     if (in_perm == RW && out_perm == RO)
100         av_frame_free(&frame);
101     return ret;
102 }
103
104 static const char *const shorthand[] = { "mode", NULL };
105
106 #if CONFIG_APERMS_FILTER
107
108 #define aperms_options options
109 AVFILTER_DEFINE_CLASS(aperms);
110
111 static av_cold int aperms_init(AVFilterContext *ctx, const char *args)
112 {
113     return init(ctx, args, &aperms_class);
114 }
115
116 static const AVFilterPad aperms_inputs[] = {
117     {
118         .name         = "default",
119         .type         = AVMEDIA_TYPE_AUDIO,
120         .filter_frame = filter_frame,
121     },
122     { NULL }
123 };
124
125 static const AVFilterPad aperms_outputs[] = {
126     {
127         .name = "default",
128         .type = AVMEDIA_TYPE_AUDIO,
129     },
130     { NULL }
131 };
132
133 AVFilter avfilter_af_aperms = {
134     .name        = "aperms",
135     .description = NULL_IF_CONFIG_SMALL("Set permissions for the output audio frame."),
136     .init        = aperms_init,
137     .priv_size   = sizeof(PermsContext),
138     .inputs      = aperms_inputs,
139     .outputs     = aperms_outputs,
140     .priv_class  = &aperms_class,
141     .shorthand   = shorthand,
142 };
143 #endif /* CONFIG_APERMS_FILTER */
144
145 #if CONFIG_PERMS_FILTER
146
147 #define perms_options options
148 AVFILTER_DEFINE_CLASS(perms);
149
150 static av_cold int perms_init(AVFilterContext *ctx, const char *args)
151 {
152     return init(ctx, args, &perms_class);
153 }
154
155 static const AVFilterPad perms_inputs[] = {
156     {
157         .name         = "default",
158         .type         = AVMEDIA_TYPE_VIDEO,
159         .filter_frame = filter_frame,
160     },
161     { NULL }
162 };
163
164 static const AVFilterPad perms_outputs[] = {
165     {
166         .name = "default",
167         .type = AVMEDIA_TYPE_VIDEO,
168     },
169     { NULL }
170 };
171
172 AVFilter avfilter_vf_perms = {
173     .name        = "perms",
174     .description = NULL_IF_CONFIG_SMALL("Set permissions for the output video frame."),
175     .init        = perms_init,
176     .priv_size   = sizeof(PermsContext),
177     .inputs      = perms_inputs,
178     .outputs     = perms_outputs,
179     .priv_class  = &perms_class,
180     .shorthand   = shorthand,
181 };
182 #endif /* CONFIG_PERMS_FILTER */