vo_opengl: rename custom shader entrypoint from sample to sample_pixel

"sample" is a reserved identifier at least in GLES ES. Suggestions for a
better name than "sample_pixel" are still welcome.

Fixes #2733.

3 files changed, 26 insertions, 4 deletions

diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index 31abc3d1f4..ee7d2cbe4d 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -25,6 +25,8 @@ Interface changes
     - add --audio-normalize-downmix
     - change the default downmix behavior (--audio-normalize-downmix=yes to get
       the old default)
+    - VO opengl custom shaders must now use "sample_pixel" as function name,
+      instead of "sample"
  --- mpv 0.15.0 ---
     - change "yadif" video filter defaults
  --- mpv 0.14.0 ---
diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst
index bc0dd9fd12..4f2641a11e 100644
--- a/DOCS/man/vo.rst
+++ b/DOCS/man/vo.rst
@@ -657,7 +657,11 @@ Available video output drivers are:
 
         These files must define a function with the following signature::
 
-            vec4 sample(sampler2D tex, vec2 pos, vec2 tex_size)
+            vec4 sample_pixel(sampler2D tex, vec2 pos, vec2 tex_size)
+
+        (If there is no string ``sample_pixel`` in the shader script, it will
+        use ``sample`` instead. This is a compatibility hack for older shader
+        scripts, and is deprecated.)
 
         The meanings of the parameters are as follows:
 
diff --git a/video/out/opengl/video.c b/video/out/opengl/video.c
index 3c61a4e878..69b910e7e5 100644
--- a/video/out/opengl/video.c
+++ b/video/out/opengl/video.c
@@ -220,6 +220,7 @@ struct gl_video {
     bool hwdec_active;
 
     bool dsi_warned;
+    bool custom_shader_fn_warned;
 };
 
 struct fmt_entry {
@@ -943,6 +944,19 @@ static void load_shader(struct gl_video *p, const char *body)
                                                         p->texture_h});
 }
 
+static const char *get_custom_shader_fn(struct gl_video *p, const char *body)
+{
+    if (!p->gl->es && strstr(body, "sample") && !strstr(body, "sample_pixel")) {
+        if (!p->custom_shader_fn_warned) {
+            MP_WARN(p, "sample() is deprecated in custom shaders. "
+                       "Use sample_pixel()\n");
+            p->custom_shader_fn_warned = true;
+        }
+        return "sample";
+    }
+    return "sample_pixel";
+}
+
 // Applies an arbitrary number of shaders in sequence, using the given pair
 // of FBOs as intermediate buffers. Returns whether any shaders were applied.
 static bool apply_shaders(struct gl_video *p, char **shaders,
@@ -958,9 +972,10 @@ static bool apply_shaders(struct gl_video *p, char **shaders,
             continue;
         finish_pass_fbo(p, &textures[tex], w, h, tex_num, 0);
         load_shader(p, body);
+        const char *fn_name = get_custom_shader_fn(p, body);
         GLSLF("// custom shader\n");
-        GLSLF("vec4 color = sample(texture%d, texcoord%d, texture_size%d);\n",
-              tex_num, tex_num, tex_num);
+        GLSLF("vec4 color = %s(texture%d, texcoord%d, texture_size%d);\n",
+              fn_name, tex_num, tex_num, tex_num);
         tex = (tex+1) % 2;
         success = true;
     }
@@ -1153,8 +1168,9 @@ static void pass_sample(struct gl_video *p, int src_tex, struct scaler *scaler,
         const char *body = load_cached_file(p, p->opts.scale_shader);
         if (body) {
             load_shader(p, body);
+            const char *fn_name = get_custom_shader_fn(p, body);
             GLSLF("// custom scale-shader\n");
-            GLSL(vec4 color = sample(tex, pos, size);)
+            GLSLF("vec4 color = %s(tex, pos, size);\n", fn_name);
         } else {
             p->opts.scale_shader = NULL;
         }