vf_vapoursynth: add parameter to pass arbitrary string to script

Currently the vapoursynth video filter does not accept any argument for passing arbitrary user data. This limits what the VS script can do. Ideally, the vapoursynth filter has an user-data parameter that contain string value. mpv passes that value to the VS script just like container_fps and others. Once the VS script gets the data, it can do all sorts of data extraction and transformation. Another benefit is that instead of mpv always have to catch up to user needs for this filter, with this users can just pass whatever needed themselves, thus becomes more future-proof. Fixes #14214

Crend King committed 2 years ago

Commit fe709c91 parent dc998562 files · +12 −1Browse files

Unified · Split

2 files

DOCS/man/vf.rst +9 −1
video/filter/vf_vapoursynth.c +3 −0

DOCS/man/vf.rst+9−1

             subtitle colors and video under the influence of the video equalizer
             settings.
-``vapoursynth=file:buffered-frames:concurrent-frames``
+``vapoursynth=file:buffered-frames:concurrent-frames:user-data``
     Loads a VapourSynth filter script. This is intended for streamed
     processing: mpv actually provides a source filter, instead of using a
     native VapourSynth video source. The mpv source will answer frame
         By default, this uses the special value ``auto``, which sets the option
         to the number of detected logical CPU cores.
+    ``user-data``
+        Optional arbitrary string that is passed to the script. Default to empty
+        string if not set.
     The following ``.vpy`` script variables are defined by mpv:
     ``video_in``
         to the height. These values can be 0. Note that this will not respond to
         monitor changes and may not work on all platforms.
+    ``user_data``
+        User data passed from the filter. This variable always exists, and defaults
+        to empty string.
 ``vavpp``
     VA-API video post processing. Requires the system to support VA-API,
     i.e. Linux/BSD only. Works with ``--vo=vaapi`` and ``--vo=gpu`` only.

video/filter/vf_vapoursynth.c+3−0

     char *file;
     int maxbuffer;
     int maxrequests;
+    char *user_data;
     const struct script_driver *drv;
 };
     p->vsapi->propSetFloat(vars, "container_fps", container_fps, 0);
     p->vsapi->propSetFloat(vars, "display_fps", display_fps, 0);
     p->vsapi->propSetIntArray(vars, "display_res", display_res, 2);
+    p->vsapi->propSetData(vars, "user_data", p->opts->user_data, -1, 0);
     if (p->drv->load(p, vars) < 0)
         goto error;
         OPTDEF_INT(4)},
     {"concurrent-frames", OPT_CHOICE(maxrequests, {"auto", -1}),
         M_RANGE(1, 99), OPTDEF_INT(-1)},
+    {"user-data", OPT_STRING(user_data), OPTDEF_STR("")},
     {0}
 };

vf_vapoursynth: add parameter to pass arbitrary string to script

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code