options: move most subtitle and OSD rendering options to sub structs

Remove them from the big MPOpts struct and move them to their sub
structs. In the places where their fields are used, create a private
copy of the structs, instead of accessing the semi-deprecated global
option struct instance (mpv_global.opts) directly.

This actually makes accessing these options finally thread-safe. They
weren't even if they should have for years. (Including some potential
for undefined behavior when e.g. the OSD font was changed at runtime.)

This is mostly transparent. All options get moved around, but most users
of the options just need to access a different struct (changing sd.opts
to a different type changes a lot of uses, for example).

One thing which has to be considered and could cause potential
regressions is that the new option copies must be explicitly updated.
sub_update_opts() takes care of this for example.

Another thing is that writing to the option structs manually won't work,
because the changes won't be propagated to other copies. Apparently the
only affected case is the implementation of the sub-step command, which
tries to change sub_delay. Handle this one explicitly (osd_changed()
doesn't need to be called anymore, because changing the option triggers
UPDATE_OSD, and updates the OSD as a consequence). The way the option
value is propagated is rather hacky, but for now this will do.

9 files changed, 40 insertions, 29 deletions

diff --git a/sub/ass_mp.c b/sub/ass_mp.c
index 03cc55780a..34e05a230c 100644
--- a/sub/ass_mp.c
+++ b/sub/ass_mp.c
@@ -134,7 +134,6 @@ ASS_Library *mp_ass_init(struct mpv_global *global, struct mp_log *log)
     ass_set_message_cb(priv, message_callback, log);
     if (path)
         ass_set_fonts_dir(priv, path);
-    ass_set_extract_fonts(priv, global->opts->use_embedded_fonts);
     talloc_free(path);
     return priv;
 }
diff --git a/sub/dec_sub.c b/sub/dec_sub.c
index b9fdc7adb9..99acab33f2 100644
--- a/sub/dec_sub.c
+++ b/sub/dec_sub.c
@@ -26,6 +26,7 @@
 #include "demux/demux.h"
 #include "sd.h"
 #include "dec_sub.h"
+#include "options/m_config.h"
 #include "options/options.h"
 #include "common/global.h"
 #include "common/msg.h"
@@ -48,7 +49,8 @@ struct dec_sub {
 
     struct mp_log *log;
     struct mpv_global *global;
-    struct MPOpts *opts;
+    struct mp_subtitle_opts *opts;
+    struct m_config_cache *opts_cache;
 
     struct mp_recorder_sink *recorder_sink;
 
@@ -71,7 +73,7 @@ struct dec_sub {
 
 static void update_subtitle_speed(struct dec_sub *sub)
 {
-    struct MPOpts *opts = sub->opts;
+    struct mp_subtitle_opts *opts = sub->opts;
     sub->sub_speed = 1.0;
 
     if (sub->video_fps > 0 && sub->codec->frame_based > 0) {
@@ -89,7 +91,7 @@ static void update_subtitle_speed(struct dec_sub *sub)
 // Return the subtitle PTS used for a given video PTS.
 static double pts_to_subtitle(struct dec_sub *sub, double pts)
 {
-    struct MPOpts *opts = sub->opts;
+    struct mp_subtitle_opts *opts = sub->opts;
 
     if (pts != MP_NOPTS_VALUE)
         pts = (pts - opts->sub_delay) / sub->sub_speed;
@@ -99,7 +101,7 @@ static double pts_to_subtitle(struct dec_sub *sub, double pts)
 
 static double pts_from_subtitle(struct dec_sub *sub, double pts)
 {
-    struct MPOpts *opts = sub->opts;
+    struct mp_subtitle_opts *opts = sub->opts;
 
     if (pts != MP_NOPTS_VALUE)
         pts = pts * sub->sub_speed + opts->sub_delay;
@@ -168,7 +170,7 @@ struct dec_sub *sub_create(struct mpv_global *global, struct sh_stream *sh,
     *sub = (struct dec_sub){
         .log = mp_log_new(sub, global->log, "sub"),
         .global = global,
-        .opts = global->opts,
+        .opts_cache = m_config_cache_alloc(sub, global, &mp_subtitle_sub_opts),
         .sh = sh,
         .codec = sh->codec,
         .attachments = talloc_steal(sub, attachments),
@@ -177,6 +179,7 @@ struct dec_sub *sub_create(struct mpv_global *global, struct sh_stream *sh,
         .start = MP_NOPTS_VALUE,
         .end = MP_NOPTS_VALUE,
     };
+    sub->opts = sub->opts_cache->opts;
     mpthread_mutex_init_recursive(&sub->lock);
 
     sub->sd = init_decoder(sub);
@@ -314,7 +317,7 @@ bool sub_read_packets(struct dec_sub *sub, double video_pts)
 void sub_get_bitmaps(struct dec_sub *sub, struct mp_osd_res dim, int format,
                      double pts, struct sub_bitmaps *res)
 {
-    struct MPOpts *opts = sub->opts;
+    struct mp_subtitle_opts *opts = sub->opts;
 
     pts = pts_to_subtitle(sub, pts);
 
@@ -334,7 +337,7 @@ void sub_get_bitmaps(struct dec_sub *sub, struct mp_osd_res dim, int format,
 char *sub_get_text(struct dec_sub *sub, double pts)
 {
     pthread_mutex_lock(&sub->lock);
-    struct MPOpts *opts = sub->opts;
+    struct mp_subtitle_opts *opts = sub->opts;
     char *text = NULL;
 
     pts = pts_to_subtitle(sub, pts);
@@ -377,9 +380,6 @@ int sub_control(struct dec_sub *sub, enum sd_ctrl cmd, void *arg)
         sub->video_fps = *(double *)arg;
         update_subtitle_speed(sub);
         break;
-    case SD_CTRL_UPDATE_SPEED:
-        update_subtitle_speed(sub);
-        break;
     case SD_CTRL_SUB_STEP: {
         double *a = arg;
         double arg2[2] = {a[0], a[1]};
@@ -398,6 +398,14 @@ int sub_control(struct dec_sub *sub, enum sd_ctrl cmd, void *arg)
     return r;
 }
 
+void sub_update_opts(struct dec_sub *sub)
+{
+    pthread_mutex_lock(&sub->lock);
+    if (m_config_cache_update(sub->opts_cache))
+        update_subtitle_speed(sub);
+    pthread_mutex_unlock(&sub->lock);
+}
+
 void sub_set_recorder_sink(struct dec_sub *sub, struct mp_recorder_sink *sink)
 {
     pthread_mutex_lock(&sub->lock);
diff --git a/sub/dec_sub.h b/sub/dec_sub.h
index 26781fd99f..3303cc9a5c 100644
--- a/sub/dec_sub.h
+++ b/sub/dec_sub.h
@@ -19,7 +19,6 @@ enum sd_ctrl {
     SD_CTRL_SET_VIDEO_PARAMS,
     SD_CTRL_SET_TOP,
     SD_CTRL_SET_VIDEO_DEF_FPS,
-    SD_CTRL_UPDATE_SPEED,
 };
 
 struct attachment_list {
@@ -41,6 +40,7 @@ void sub_get_bitmaps(struct dec_sub *sub, struct mp_osd_res dim, int format,
 char *sub_get_text(struct dec_sub *sub, double pts);
 void sub_reset(struct dec_sub *sub);
 void sub_select(struct dec_sub *sub, bool selected);
+void sub_update_opts(struct dec_sub *sub);
 void sub_set_recorder_sink(struct dec_sub *sub, struct mp_recorder_sink *sink);
 
 int sub_control(struct dec_sub *sub, enum sd_ctrl cmd, void *arg);
diff --git a/sub/osd.c b/sub/osd.c
index d2351b7213..eb924db561 100644
--- a/sub/osd.c
+++ b/sub/osd.c
@@ -28,6 +28,7 @@
 #include "osdep/timer.h"
 
 #include "mpv_talloc.h"
+#include "options/m_config.h"
 #include "options/options.h"
 #include "common/global.h"
 #include "common/msg.h"
@@ -117,12 +118,13 @@ struct osd_state *osd_create(struct mpv_global *global)
 
     struct osd_state *osd = talloc_zero(NULL, struct osd_state);
     *osd = (struct osd_state) {
-        .opts = global->opts,
+        .opts_cache = m_config_cache_alloc(osd, global, &mp_osd_render_sub_opts),
         .global = global,
         .log = mp_log_new(osd, global->log, "osd"),
         .force_video_pts = MP_NOPTS_VALUE,
     };
     pthread_mutex_init(&osd->lock, NULL);
+    osd->opts = osd->opts_cache->opts;
 
     for (int n = 0; n < MAX_OSD_PARTS; n++) {
         struct osd_object *obj = talloc(osd, struct osd_object);
@@ -262,10 +264,8 @@ static void render_object(struct osd_state *osd, struct osd_object *obj,
                           const bool sub_formats[SUBBITMAP_COUNT],
                           struct sub_bitmaps *out_imgs)
 {
-    struct MPOpts *opts = osd->opts;
-
     int format = SUBBITMAP_LIBASS;
-    if (!sub_formats[format] || opts->force_rgba_osd)
+    if (!sub_formats[format] || osd->opts->force_rgba_osd)
         format = SUBBITMAP_RGBA;
 
     *out_imgs = (struct sub_bitmaps) {0};
@@ -406,6 +406,8 @@ void osd_changed(struct osd_state *osd)
     pthread_mutex_lock(&osd->lock);
     osd->objs[OSDTYPE_OSD]->osd_changed = true;
     osd->want_redraw_notification = true;
+    // Done here for a lack of a better place.
+    m_config_cache_update(osd->opts_cache);
     pthread_mutex_unlock(&osd->lock);
 }
 
diff --git a/sub/osd_libass.c b/sub/osd_libass.c
index 28a16d6204..e51b7f4048 100644
--- a/sub/osd_libass.c
+++ b/sub/osd_libass.c
@@ -234,7 +234,7 @@ static ASS_Event *add_osd_ass_event_escaped(ASS_Track *track, const char *style,
 
 static ASS_Style *prepare_osd_ass(struct osd_state *osd, struct osd_object *obj)
 {
-    struct MPOpts *opts = osd->opts;
+    struct mp_osd_render_opts *opts = osd->opts;
 
     create_ass_track(osd, obj, &obj->ass);
 
@@ -349,7 +349,7 @@ static void get_osd_bar_box(struct osd_state *osd, struct osd_object *obj,
                             float *o_x, float *o_y, float *o_w, float *o_h,
                             float *o_border)
 {
-    struct MPOpts *opts = osd->opts;
+    struct mp_osd_render_opts *opts = osd->opts;
 
     create_ass_track(osd, obj, &obj->ass);
     ASS_Track *track = obj->ass.track;
diff --git a/sub/osd_state.h b/sub/osd_state.h
index 5cb0f1e07c..ac8befe3ba 100644
--- a/sub/osd_state.h
+++ b/sub/osd_state.h
@@ -73,7 +73,8 @@ struct osd_state {
     bool want_redraw;
     bool want_redraw_notification;
 
-    struct MPOpts *opts;
+    struct m_config_cache *opts_cache;
+    struct mp_osd_render_opts *opts;
     struct mpv_global *global;
     struct mp_log *log;
 
diff --git a/sub/sd.h b/sub/sd.h
index dd1f26d721..8c975959a8 100644
--- a/sub/sd.h
+++ b/sub/sd.h
@@ -12,7 +12,7 @@
 struct sd {
     struct mpv_global *global;
     struct mp_log *log;
-    struct MPOpts *opts;
+    struct mp_subtitle_opts *opts;
 
     const struct sd_functions *driver;
     void *priv;
diff --git a/sub/sd_ass.c b/sub/sd_ass.c
index 74d500be8d..1cecfe3215 100644
--- a/sub/sd_ass.c
+++ b/sub/sd_ass.c
@@ -59,7 +59,7 @@ static void fill_plaintext(struct sd *sd, double pts);
 
 // Add default styles, if the track does not have any styles yet.
 // Apply style overrides if the user provides any.
-static void mp_ass_add_default_styles(ASS_Track *track, struct MPOpts *opts)
+static void mp_ass_add_default_styles(ASS_Track *track, struct mp_subtitle_opts *opts)
 {
     if (opts->ass_styles_file && opts->ass_style_override)
         ass_read_styles(track, opts->ass_styles_file, NULL);
@@ -120,7 +120,7 @@ static bool attachment_is_font(struct mp_log *log, struct demux_attachment *f)
 static void add_subtitle_fonts(struct sd *sd)
 {
     struct sd_ass_priv *ctx = sd->priv;
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     if (!opts->ass_enabled || !opts->use_embedded_fonts || !sd->attachments)
         return;
     for (int i = 0; i < sd->attachments->num_entries; i++) {
@@ -148,7 +148,7 @@ static void enable_output(struct sd *sd, bool enable)
 
 static int init(struct sd *sd)
 {
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     struct sd_ass_priv *ctx = talloc_zero(sd, struct sd_ass_priv);
     sd->priv = ctx;
 
@@ -169,6 +169,7 @@ static int init(struct sd *sd)
     }
 
     ctx->ass_library = mp_ass_init(sd->global, sd->log);
+    ass_set_extract_fonts(ctx->ass_library, opts->use_embedded_fonts);
 
     add_subtitle_fonts(sd);
 
@@ -279,7 +280,7 @@ static void decode(struct sd *sd, struct demux_packet *packet)
 static void configure_ass(struct sd *sd, struct mp_osd_res *dim,
                           bool converted, ASS_Track *track)
 {
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     struct sd_ass_priv *ctx = sd->priv;
     ASS_Renderer *priv = ctx->ass_renderer;
 
@@ -428,7 +429,7 @@ static void get_bitmaps(struct sd *sd, struct mp_osd_res dim, int format,
                         double pts, struct sub_bitmaps *res)
 {
     struct sd_ass_priv *ctx = sd->priv;
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     bool no_ass = !opts->ass_enabled || ctx->on_top ||
                   opts->ass_style_override == 5;
     bool converted = ctx->is_converted || no_ass;
@@ -689,7 +690,7 @@ const struct sd_functions sd_ass = {
 // Disgusting hack for (xy-)vsfilter color compatibility.
 static void mangle_colors(struct sd *sd, struct sub_bitmaps *parts)
 {
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     struct sd_ass_priv *ctx = sd->priv;
     enum mp_csp csp = 0;
     enum mp_csp_levels levels = 0;
diff --git a/sub/sd_lavc.c b/sub/sd_lavc.c
index 81d8ccfa7d..71df4da36c 100644
--- a/sub/sd_lavc.c
+++ b/sub/sd_lavc.c
@@ -164,7 +164,7 @@ static void convert_pal(uint32_t *colors, size_t count, bool gray)
 // Initialize sub from sub->avsub.
 static void read_sub_bitmaps(struct sd *sd, struct sub *sub)
 {
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     struct sd_lavc_priv *priv = sd->priv;
     AVSubtitle *avsub = &sub->avsub;
 
@@ -288,7 +288,7 @@ static void read_sub_bitmaps(struct sd *sd, struct sub *sub)
 
 static void decode(struct sd *sd, struct demux_packet *packet)
 {
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
     struct sd_lavc_priv *priv = sd->priv;
     AVCodecContext *ctx = priv->avctx;
     double pts = packet->pts;
@@ -387,7 +387,7 @@ static void get_bitmaps(struct sd *sd, struct mp_osd_res d, int format,
                         double pts, struct sub_bitmaps *res)
 {
     struct sd_lavc_priv *priv = sd->priv;
-    struct MPOpts *opts = sd->opts;
+    struct mp_subtitle_opts *opts = sd->opts;
 
     priv->current_pts = pts;