mplayer: turn playtree into a list, and change per-file option handling

Summary:
- There is no playtree anymore. It's reduced to a simple list.
- Options are now always global. You can still have per-file options,
  but these are optional and require special syntax.
- The slave command pt_step has been removed, and playlist_next
  and playlist_prev added. (See etc/input.conf changes.)
  This is a user visible incompatible change, and will break slave-mode
  applications.
- The pt_clear slave command is renamed to playlist_clear.
- Playtree entries could have multiple files. This is not the case
  anymore, and playlist entries have always exactly one entry. Whenever
  something adds more than one file (like ASX playlists or dvd:// or
  dvdnav:// on the command line), all files are added as separate
  playlist entries.

Note that some of the changes are quite deep and violent. Expect
regressions.

The playlist parsing code in particular is of low quality. I didn't try
to improve it, and merely spent to least effort necessary to keep it
somehow working. (Especially ASX playlist handling.)

The playtree code was complicated and bloated. It was also barely used.
Most users don't even know that mplayer manages the playlist as tree,
or how to use it. The most obscure features was probably specifying a
tree on command line (with '{' and '}' to create/close tree nodes). It
filled the player code with complexity and confused users with weird
slave commands like pt_up.

Replace the playtree with a simple flat playlist. Playlist parsers that
actually return trees are changed to append all files to the playlist
pre-order.

It used to be the responsibility of the playtree code to change per-file
config options. Now this is done by the player core, and the playlist
code is free of such details.

Options are not per-file by default anymore. This was a very obscure and
complicated feature that confused even experienced users. Consider the
following command line:

    mplayer file1.mkv file2.mkv --no-audio file3.mkv

This will disable the audio for file2.mkv only, because options are
per-file by default. To make the option affect all files, you're
supposed to put it before the first file.

This is bad, because normally you don't need per-file options. They are
very rarely needed, and the only reasonable use cases I can imagine are
use of the encode backend (mplayer encode branch), or for debugging. The
normal use case is made harder, and the feature is perceived as bug.
Even worse, correct usage is hard to explain for users.

Make all options global by default. The position of an option isn't
significant anymore (except for options that compensate each other,
consider --shuffle --no-shuffle).

One other important change is that no options are reset anymore if a
new file is started. If you change settings with slave mode commands,
they will not be changed by playing a new file. (Exceptions include
settings that are too file specific, like audio/subtitle stream
selection.)

There is still some need for per-file options. Debugging and encoding
are use cases that profit from per-file options. Per-file profiles (as
well as per-protocol and per-VO/AO options) need the implementation
related mechanisms to backup and restore options when the playback file
changes.

Simplify the save-slot stuff, which is possible because there is no
hierarchical play tree anymore. Now there's a simple backup field.

Add a way to specify per-file options on command line. Example:

    mplayer f1.mkv -o0 --{ -o1 f2.mkv -o2 f3.mkv --} f4.mkv -o3

will have the following options per file set:

    f1.mkv, f4.mkv: -o0 -o3
    f2.mkv, f3.mkv: -o0 -o3 -o1 -o2

The options --{ and --} start and end per-file options. All files inside
the { } will be affected by the options equally (similar to how global
options and multiple files are handled). When playback of a file starts,
the per-file options are set according to the command line. When
playback ends, the per-file options are restored to the values when
playback started.

1 files changed, 94 insertions, 104 deletions

diff --git a/parser-mpcmd.c b/parser-mpcmd.c
index 058793d09d..33d3deabbf 100644
--- a/parser-mpcmd.c
+++ b/parser-mpcmd.c
@@ -28,7 +28,8 @@
 #include "mp_msg.h"
 #include "m_option.h"
 #include "m_config.h"
-#include "playtree.h"
+#include "playlist.h"
+#include "playlist_parser.h"
 #include "parser-mpcmd.h"
 #include "osdep/macosx_finder_args.h"
 
@@ -38,16 +39,6 @@
 #define dvd_range(a)  (a > 0 && a < 256)
 
 
-static inline void add_entry(play_tree_t **last_parentp,
-                             play_tree_t **last_entryp, play_tree_t *entry)
-{
-    if (*last_entryp == NULL)
-        play_tree_set_child(*last_parentp, entry);
-    else
-        play_tree_append_entry(*last_entryp, entry);
-    *last_entryp = entry;
-}
-
 static bool split_opt(struct bstr *opt, struct bstr *param, bool *old_syntax)
 {
     if (!bstr_startswith0(*opt, "-") || opt->len == 1)
@@ -92,15 +83,18 @@ static int map_to_option(struct m_config *config, bool old_syntax,
     return 0;
 }
 
-// Parse command line to set up config and playtree
-play_tree_t *m_config_parse_mp_command_line(m_config_t *config, int argc,
-                                            char **argv)
+bool m_config_parse_mp_command_line(m_config_t *config, struct playlist *files,
+                                    int argc, char **argv)
 {
     int mode = 0;
     bool no_more_opts = false;
     bool opt_exit = false;   // exit immediately after parsing (help options)
-    play_tree_t *last_parent, *last_entry = NULL, *root;
+    struct playlist_entry *local_start = NULL;
     struct bstr orig_opt;
+    bool shuffle = false;
+
+    int local_params_count = 0;
+    struct playlist_param *local_params = 0;
 
     assert(config != NULL);
     assert(argv != NULL);
@@ -109,13 +103,10 @@ play_tree_t *m_config_parse_mp_command_line(m_config_t *config, int argc,
     config->mode = M_COMMAND_LINE;
     mode = GLOBAL;
 #ifdef CONFIG_MACOSX_FINDER
-    root = macosx_finder_args(config, argc, argv);
-    if (root)
-        return root;
+    if (macosx_finder_args(config, files, argc, argv))
+        return true;
 #endif
 
-    last_parent = root = play_tree_new();
-
     for (int i = 1; i < argc; i++) {
         //next:
         struct bstr opt = bstr0(argv[i]);
@@ -125,103 +116,100 @@ play_tree_t *m_config_parse_mp_command_line(m_config_t *config, int argc,
             no_more_opts = true;
             continue;
         }
-        if (!bstrcmp0(opt, "{")) {
-            play_tree_t *entry = play_tree_new();
-            mode = LOCAL;
-            if (last_parent->flags & PLAY_TREE_RND)
-                entry->flags |= PLAY_TREE_RND;
-            if (last_entry == NULL)
-                play_tree_set_child(last_parent, entry);
-            else {
-                play_tree_append_entry(last_entry, entry);
-                last_entry = NULL;
+        if (!bstrcmp0(opt, "--{")) {
+            if (mode != GLOBAL) {
+                mp_msg(MSGT_CFGPARSER, MSGL_ERR, "'--{' can not be nested\n");
+                goto err_out;
             }
-            last_parent = entry;
+            mode = LOCAL;
+            assert(!local_start);
+            local_start = files->last;
             continue;
         }
 
-        if (!bstrcmp0(opt, "}")) {
-            if (!last_parent || !last_parent->parent) {
-                mp_msg(MSGT_CFGPARSER, MSGL_ERR, "too much }-\n");
+        if (!bstrcmp0(opt, "--}")) {
+            if (mode != LOCAL) {
+                mp_msg(MSGT_CFGPARSER, MSGL_ERR, "too many closing '--}'\n");
                 goto err_out;
             }
-            last_entry = last_parent;
-            last_parent = last_entry->parent;
+            if (local_params_count) {
+                // The files added between '{' and '}' are the entries from the
+                // entry _after_ local_start, until the end of the list. If
+                // local_start is NULL, the list was empty on '{', and we want
+                // all files in the list.
+                struct playlist_entry *cur
+                    = local_start ? local_start->next : files->first;
+                if (!cur)
+                    mp_msg(MSGT_CFGPARSER, MSGL_WARN, "ignored options\n");
+                while (cur) {
+                    playlist_entry_add_params(cur, local_params,
+                                              local_params_count);
+                    cur = cur->next;
+                }
+            }
+            local_params_count = 0;
+            mode = GLOBAL;
+            local_start = NULL;
             continue;
         }
 
         struct bstr param = bstr0(i+1 < argc ? argv[i+1] : NULL);
         bool old_syntax;
         if (!no_more_opts && split_opt(&opt, &param, &old_syntax)) {
-            // Handle some special arguments outside option parser.
-            // --loop when it applies to a group of files (per-file is option)
-            if (bstrcasecmp0(opt, "loop") == 0 &&
-                (!last_entry || last_entry->child)) {
-                struct bstr rest;
-                int l = bstrtoll(param, &rest, 0);
-                if (!param.len || rest.len) {
+            const struct m_option *mp_opt;
+            int ok = map_to_option(config, old_syntax, &mp_opt, &opt, &param);
+            if (ok < 0) {
+                if (ok == -3)
                     mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
-                            "The loop option must be an integer: \"%.*s\"\n",
-                            BSTR_P(param));
-                    goto print_err;
-                } else {
-                    play_tree_t *pt = last_entry ? last_entry : last_parent;
-                    l = l <= 0 ? -1 : l;
-                    pt->loop = l;
-                    i += old_syntax;
-                }
-            } else if (bstrcasecmp0(opt, "shuffle") == 0) {
-                if (last_entry && last_entry->child)
-                    last_entry->flags |= PLAY_TREE_RND;
-                else
-                    last_parent->flags |= PLAY_TREE_RND;
-            } else if (bstrcasecmp0(opt, "noshuffle") == 0 ||
-                       bstrcasecmp0(opt, "no-shuffle") == 0) {
-                if (last_entry && last_entry->child)
-                    last_entry->flags &= ~PLAY_TREE_RND;
+                            "Option --%.*s can't be used with single-dash "
+                            "syntax\n", BSTR_P(opt));
+                else if (ok == -2)
+                    mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
+                            "A --no-* option can't take parameters: "
+                            "--%.*s=%.*s\n", BSTR_P(opt), BSTR_P(param));
                 else
-                    last_parent->flags &= ~PLAY_TREE_RND;
+                    mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
+                            "Unknown option on the command line: --%.*s\n",
+                            BSTR_P(opt));
+                goto print_err;
+            }
+            if (mode == LOCAL && (mp_opt->flags & M_OPT_GLOBAL)) {
+                mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
+                        "Option --%.*s is global and can't be set per-file\n",
+                        BSTR_P(opt));
+                goto print_err;
+            }
+            // Handle some special arguments outside option parser.
+            // --loop when it applies to a group of files (per-file is option)
+            if (bstrcasecmp0(opt, "shuffle") == 0) {
+                shuffle = true;
+            } else if (bstrcasecmp0(opt, "no-shuffle") == 0) {
+                shuffle = false;
             } else if (bstrcasecmp0(opt, "playlist") == 0) {
                 if (param.len <= 0)
                     goto print_err;
-                struct play_tree *entry = parse_playlist_file(config, param);
-                if (!entry)
+                // append the playlist to the local args
+                char *param0 = bstrdup0(NULL, param);
+                struct playlist *pl = playlist_parse_file(param0);
+                talloc_free(param0);
+                if (!pl)
                     goto print_err;
-                add_entry(&last_parent, &last_entry, entry);
-                if ((last_parent->flags & PLAY_TREE_RND) && entry->child)
-                    entry->flags |= PLAY_TREE_RND;
-                mode = LOCAL;
+                playlist_transfer_entries(files, pl);
+                talloc_free(pl);
                 i += old_syntax;
             } else {
                 // "normal" options
-                const struct m_option *mp_opt;
-                int ok = map_to_option(config, old_syntax, &mp_opt, &opt,
-                                       &param);
-                if (ok < 0) {
-                    if (ok == -3)
-                        mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
-                                "Option --%.*s can't be used with single-dash "
-                                "syntax\n", BSTR_P(opt));
-                    else if (ok == -2)
-                        mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
-                                "A --no-* option can't take parameters: "
-                                "--%.*s=%.*s\n", BSTR_P(opt), BSTR_P(param));
-                    else
-                        mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
-                                "Unknown option on the command line: --%.*s\n",
-                                BSTR_P(opt));
-                    goto print_err;
-                }
                 int r;
-                if (mode == GLOBAL || (mp_opt->flags & M_OPT_GLOBAL)) {
+                if (mode == GLOBAL) {
                     r = m_config_set_option(config, opt, param, old_syntax);
                 } else {
                     r = m_config_check_option(config, opt, param, old_syntax);
                     if (r >= 0) {
-                        play_tree_t *pt = last_entry ? last_entry : last_parent;
                         if (r == 0)
                             param = bstr0(NULL);  // for old_syntax case
-                        play_tree_set_param(pt, opt, param);
+                        struct playlist_param p = {opt, param};
+                        MP_TARRAY_APPEND(NULL, local_params,
+                                         local_params_count, p);
                     }
                 }
                 if (r <= M_OPT_EXIT) {
@@ -241,7 +229,6 @@ play_tree_t *m_config_parse_mp_command_line(m_config_t *config, int argc,
             }
         } else {  /* filename */
             int is_dvdnav = strstr(argv[i], "dvdnav://") != NULL;
-            play_tree_t *entry = play_tree_new();
             mp_msg(MSGT_CFGPARSER, MSGL_DBG2, "Adding file %s\n", argv[i]);
             // expand DVD filename entries like dvd://1-3 into component titles
             if (strstr(argv[i], "dvd://") != NULL || is_dvdnav) {
@@ -260,45 +247,48 @@ play_tree_t *m_config_parse_mp_command_line(m_config_t *config, int argc,
                     if (dvd_range(start_title) && dvd_range(end_title)
                             && (start_title < end_title)) {
                         for (int j = start_title; j <= end_title; j++) {
-                            if (j != start_title)
-                                entry = play_tree_new();
                             char entbuf[15];
                             snprintf(entbuf, sizeof(entbuf),
                                     is_dvdnav ? "dvdnav://%d" : "dvd://%d", j);
-                            play_tree_add_file(entry, entbuf);
-                            add_entry(&last_parent, &last_entry, entry);
-                            last_entry = entry;
+                            playlist_add_file(files, entbuf);
                         }
                     } else
                         mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
                                 "Invalid play entry %s\n", argv[i]);
 
                 } else // dvd:// or dvd://x entry
-                    play_tree_add_file(entry, argv[i]);
+                    playlist_add_file(files, argv[i]);
             } else
-                play_tree_add_file(entry, argv[i]);
+                playlist_add_file(files, argv[i]);
 
             // Lock stdin if it will be used as input
             if (strcasecmp(argv[i], "-") == 0)
                 m_config_set_option0(config, "consolecontrols", "no", false);
-            add_entry(&last_parent, &last_entry, entry);
-            mode = LOCAL; // We start entry specific options
         }
     }
 
     if (opt_exit)
         goto err_out;
-    if (last_parent != root)
-        mp_msg(MSGT_CFGPARSER, MSGL_ERR, "Missing }- ?\n");
-    return root;
+
+    if (mode != GLOBAL) {
+        mp_tmsg(MSGT_CFGPARSER, MSGL_ERR,
+                "Missing closing --} on command line.\n");
+        goto err_out;
+    }
+
+    if (shuffle)
+        playlist_shuffle(files);
+
+    talloc_free(local_params);
+    return true;
 
 print_err:
     mp_tmsg(MSGT_CFGPARSER, MSGL_FATAL,
             "Error parsing option on the command line: %.*s\n",
             BSTR_P(orig_opt));
 err_out:
-    play_tree_free(root, 1);
-    return NULL;
+    talloc_free(local_params);
+    return false;
 }
 
 extern int mp_msg_levels[];