Add musicbrainz id option to importer

beets/autotag/match.py

@@ -370,7 +370,7 @@ def _add_candidate(items, results, info):
 
 
 def tag_album(items, search_artist=None, search_album=None,
-              search_id=None):
+              search_ids=[]):
     """Return a tuple of a artist name, an album name, a list of
     `AlbumMatch` candidates from the metadata backend, and a
     `Recommendation`.
@@ -380,8 +380,11 @@ def tag_album(items, search_artist=None, search_album=None,
 
     The `AlbumMatch` objects are generated by searching the metadata
     backends. By default, the metadata of the items is used for the
-    search. This can be customized by setting the parameters. The
-    `mapping` field of the album has the matched `items` as keys.
+    search. This can be customized by setting the parameters.
+    `search_ids` is a list of metadata backend IDs: if specified,
+    it will restrict the candidates to those IDs, ignoring
+    `search_artist` and `search album`. The `mapping` field of the
+    album has the matched `items` as keys.
 
     The recommendation is calculated from the match quality of the
     candidates.
@@ -397,9 +400,11 @@ def tag_album(items, search_artist=None, search_album=None,
     candidates = {}
 
     # Search by explicit ID.
-    if search_id is not None:
-        log.debug(u'Searching for album ID: {0}', search_id)
-        search_cands = hooks.albums_for_id(search_id)
+    if search_ids:
+        search_cands = []
+        for search_id in search_ids:
+            log.debug(u'Searching for album ID: {0}', search_id)
+            search_cands.extend(hooks.albums_for_id(search_id))
 
     # Use existing metadata or text search.
     else:
@@ -444,35 +449,38 @@ def tag_album(items, search_artist=None, search_album=None,
 
 
 def tag_item(item, search_artist=None, search_title=None,
-             search_id=None):
+             search_ids=[]):
     """Attempts to find metadata for a single track. Returns a
     `(candidates, recommendation)` pair where `candidates` is a list of
     TrackMatch objects. `search_artist` and `search_title` may be used
     to override the current metadata for the purposes of the MusicBrainz
-    title; likewise `search_id`.
+    title. `search_ids` may be used for restricting the search to a list
+    of metadata backend IDs.
     """
     # Holds candidates found so far: keys are MBIDs; values are
     # (distance, TrackInfo) pairs.
     candidates = {}
 
     # First, try matching by MusicBrainz ID.
-    trackid = search_id or item.mb_trackid
-    if trackid:
-        log.debug(u'Searching for track ID: {0}', trackid)
-        for track_info in hooks.tracks_for_id(trackid):
-            dist = track_distance(item, track_info, incl_artist=True)
-            candidates[track_info.track_id] = \
-                hooks.TrackMatch(dist, track_info)
-            # If this is a good match, then don't keep searching.
-            rec = _recommendation(candidates.values())
-            if rec == Recommendation.strong and not config['import']['timid']:
-                log.debug(u'Track ID match.')
-                return candidates.values(), rec
+    trackids = search_ids or filter(None, [item.mb_trackid])
+    if trackids:
+        for trackid in trackids:
+            log.debug(u'Searching for track ID: {0}', trackid)
+            for track_info in hooks.tracks_for_id(trackid):
+                dist = track_distance(item, track_info, incl_artist=True)
+                candidates[track_info.track_id] = \
+                    hooks.TrackMatch(dist, track_info)
+                # If this is a good match, then don't keep searching.
+                rec = _recommendation(sorted(candidates.itervalues()))
+                if rec == Recommendation.strong and \
+                        not config['import']['timid']:
+                    log.debug(u'Track ID match.')
+                    return sorted(candidates.itervalues()), rec
 
     # If we're searching by ID, don't proceed.
-    if search_id is not None:
+    if search_ids:
         if candidates:
-            return candidates.values(), rec
+            return sorted(candidates.itervalues()), rec
         else:
             return [], Recommendation.none
 

beets/config_default.yaml

@@ -22,6 +22,7 @@ import:
     flat: no
     group_albums: no
     pretend: false
+    search_ids: []
 
 clutter: ["Thumbs.DB", ".DS_Store"]
 ignore: [".*", "*~", "System Volume Information"]

beets/importer.py

@@ -434,6 +434,7 @@ def __init__(self, toppath, paths, items):
         self.rec = None
         self.should_remove_duplicates = False
         self.is_album = True
+        self.search_ids = []  # user-supplied candidate IDs.
 
     def set_choice(self, choice):
         """Given an AlbumMatch or TrackMatch object or an action constant,
@@ -579,10 +580,12 @@ def handle_created(self, session):
         return tasks
 
     def lookup_candidates(self):
-        """Retrieve and store candidates for this album.
+        """Retrieve and store candidates for this album. User-specified
+        candidate IDs are stored in self.search_ids: if present, the
+        initial lookup is restricted to only those IDs.
         """
         artist, album, candidates, recommendation = \
-            autotag.tag_album(self.items)
+            autotag.tag_album(self.items, search_ids=self.search_ids)
         self.cur_artist = artist
         self.cur_album = album
         self.candidates = candidates
@@ -821,7 +824,8 @@ def _emit_imported(self, lib):
             plugins.send('item_imported', lib=lib, item=item)
 
     def lookup_candidates(self):
-        candidates, recommendation = autotag.tag_item(self.item)
+        candidates, recommendation = autotag.tag_item(
+            self.item, search_ids=self.search_ids)
         self.candidates = candidates
         self.rec = recommendation
 
@@ -1246,6 +1250,11 @@ def lookup_candidates(session, task):
 
     plugins.send('import_task_start', session=session, task=task)
     log.debug(u'Looking up: {0}', displayable_path(task.paths))
+
+    # Restrict the initial lookup to IDs specified by the user via the -m
+    # option. Currently all the IDs are passed onto the tasks directly.
+    task.search_ids = session.config['search_ids'].as_str_seq()
+
     task.lookup_candidates()
 
 

beets/ui/commands.py

@@ -734,7 +734,7 @@ def choose_match(self, task):
                 search_id = manual_id(False)
                 if search_id:
                     _, _, candidates, rec = autotag.tag_album(
-                        task.items, search_id=search_id
+                        task.items, search_ids=search_id.split()
                     )
             elif choice in extra_ops.keys():
                 # Allow extra ops to automatically set the post-choice.
@@ -786,8 +786,8 @@ def choose_item(self, task):
                 # Ask for a track ID.
                 search_id = manual_id(True)
                 if search_id:
-                    candidates, rec = autotag.tag_item(task.item,
-                                                       search_id=search_id)
+                    candidates, rec = autotag.tag_item(
+                        task.item, search_ids=search_id.split())
             elif choice in extra_ops.keys():
                 # Allow extra ops to automatically set the post-choice.
                 post_choice = extra_ops[choice](self, task)
@@ -1022,6 +1022,11 @@ def import_func(lib, opts, args):
     '--pretend', dest='pretend', action='store_true',
     help='just print the files to import'
 )
+import_cmd.parser.add_option(
+    '-S', '--search-id', dest='search_ids', action='append',
+    metavar='BACKEND_ID',
+    help='restrict matching to a specific metadata backend ID'
+)
 import_cmd.func = import_func
 default_commands.append(import_cmd)
 

beetsplug/bench.py

@@ -75,7 +75,7 @@ def match_benchmark(lib, prof, query=None, album_id=None):
 
     # Run the match.
     def _run_match():
-        match.tag_album(items, search_id=album_id)
+        match.tag_album(items, search_ids=[album_id])
     if prof:
         cProfile.runctx('_run_match()', {}, {'_run_match': _run_match},
                         'match.prof')

docs/changelog.rst

@@ -20,6 +20,10 @@ New:
   session. :bug:`1779`
 * :doc:`/plugins/info`: A new option will print only fields' names and not
   their values. Thanks to :user:`GuilhermeHideki`. :bug:`1812`
+* A new ``--search-id`` importer option lets you specify one or several
+  matching MusicBrainz/Discogs IDs directly, bypassing the default initial
+  candidate search. Also, the ``enter Id`` prompt choice now accepts several
+  IDs, separated by spaces. :bug:`1808`
 
 .. _AcousticBrainz: http://acousticbrainz.org/
 

docs/guides/tagger.rst

@@ -60,8 +60,8 @@ all of these limitations.
   because beets by default infers tags based on existing metadata. But this is
   not a hard and fast rule---there are a few ways to tag metadata-poor music:
 
-    * You can use the *E* option described below to search in MusicBrainz for
-      a specific album or song.
+    * You can use the *E* or *I* options described below to search in
+      MusicBrainz for a specific album or song.
     * The :doc:`Acoustid plugin </plugins/chroma>` extends the autotagger to
       use acoustic fingerprinting to find information for arbitrary audio.
       Install that plugin if you're willing to spend a little more CPU power
@@ -160,10 +160,10 @@ When beets needs your input about a match, it says something like this::
         Beirut - Lon Gisland
     (Similarity: 94.4%)
     * Scenic World (Second Version) -> Scenic World
-    [A]pply, More candidates, Skip, Use as-is, as Tracks, Enter search, or aBort?
+    [A]pply, More candidates, Skip, Use as-is, as Tracks, Enter search, enter Id, or aBort?
 
 When beets asks you this question, it wants you to enter one of the capital
-letters: A, M, S, U, T, G, E, or B. That is, you can choose one of the
+letters: A, M, S, U, T, G, E, I or B. That is, you can choose one of the
 following:
 
 * *A*: Apply the suggested changes shown and move on.
@@ -190,6 +190,11 @@ following:
   option if beets hasn't found any good options because the album is mistagged
   or untagged.
 
+* *I*: Enter a metadata backend ID to use as search in the database. Use this
+  option to specify a backend entity (for example, a MusicBrainz release or
+  recording) directly, by pasting its ID or the full URL. You can also specify
+  several IDs by separating them by a space.
+
 * *B*: Cancel this import task altogether. No further albums will be tagged;
   beets shuts down immediately. The next time you attempt to import the same
   directory, though, beets will ask you if you want to resume tagging where you

docs/reference/cli.rst

@@ -132,6 +132,11 @@ Optional command flags:
   option. If set, beets will just print a list of files that it would
   otherwise import.
 
+* If you already have a metadata backend ID that matches the items to be
+  imported, you can instruct beets to restrict the search to that ID instead of
+  searching for other candidates by using the ``--search-id SEARCH_ID`` option.
+  Multiple IDs can be specified by simply repeating the option several times.
+
 .. _rarfile: https://pypi.python.org/pypi/rarfile/2.2
 
 .. only:: html