audio: Move tag helpers to mopidy.audio.tags

Author: jodal

mopidy/audio/actor.py

@@ -12,7 +12,7 @@
 import pykka
 
 from mopidy import exceptions
-from mopidy.audio import utils
+from mopidy.audio import tags as tags_lib, utils
 from mopidy.audio.constants import PlaybackState
 from mopidy.audio.listener import AudioListener
 from mopidy.internal import deprecation, process
@@ -325,7 +325,7 @@ def on_async_done(self):
         gst_logger.debug('Got ASYNC_DONE bus message.')
 
     def on_tag(self, taglist):
-        tags = utils.convert_taglist(taglist)
+        tags = tags_lib.convert_taglist(taglist)
         gst_logger.debug('Got TAG bus message: tags=%r', dict(tags))
         self._audio._tags.update(tags)
         logger.debug('Audio event: tags_changed(tags=%r)', tags.keys())

mopidy/audio/scan.py

@@ -10,7 +10,7 @@
 Gst.is_initialized() or Gst.init()
 
 from mopidy import exceptions
-from mopidy.audio import utils
+from mopidy.audio import tags as tags_lib, utils
 from mopidy.internal import encoding
 
 # GST_ELEMENT_FACTORY_LIST:
@@ -214,7 +214,7 @@ def _process(pipeline, timeout_ms):
         elif message.type == Gst.MessageType.TAG:
             taglist = message.parse_tag()
             # Note that this will only keep the last tag.
-            tags.update(utils.convert_taglist(taglist))
+            tags.update(tags_lib.convert_taglist(taglist))
 
         now = int(time.time() * 1000)
         timeout -= now - previous

mopidy/audio/tags.py

@@ -0,0 +1,132 @@
+from __future__ import absolute_import, unicode_literals
+
+import collections
+import logging
+import numbers
+
+import gi
+gi.require_version('Gst', '1.0')
+from gi.repository import Gst
+Gst.is_initialized() or Gst.init()
+
+from mopidy import compat
+from mopidy.models import Album, Artist, Track
+
+
+logger = logging.getLogger(__name__)
+TRACE = logging.getLevelName('TRACE')
+
+
+def convert_taglist(taglist):
+    """Convert a :class:`Gst.TagList` to plain Python types.
+
+    Knows how to convert:
+
+    - Dates
+    - Buffers
+    - Numbers
+    - Strings
+    - Booleans
+
+    Unknown types will be ignored and trace logged. Tag keys are all strings
+    defined as part GStreamer under GstTagList_.
+
+    .. _GstTagList: https://developer.gnome.org/gstreamer/stable/\
+gstreamer-GstTagList.html
+
+    :param taglist: A GStreamer taglist to be converted.
+    :type taglist: :class:`Gst.TagList`
+    :rtype: dictionary of tag keys with a list of values.
+    """
+    result = collections.defaultdict(list)
+
+    for n in range(taglist.n_tags()):
+        tag = taglist.nth_tag_name(n)
+
+        for i in range(taglist.get_tag_size(tag)):
+            value = taglist.get_value_index(tag, i)
+
+            if isinstance(value, Gst.DateTime):
+                result[tag].append(value.to_iso8601_string())
+            if isinstance(value, (compat.string_types, bool, numbers.Number)):
+                result[tag].append(value)
+            else:
+                logger.log(
+                    TRACE, 'Ignoring unknown tag data: %r = %r', tag, value)
+
+    return result
+
+
+# TODO: split based on "stream" and "track" based conversion? i.e. handle data
+# from radios in it's own helper instead?
+def convert_tags_to_track(tags):
+    """Convert our normalized tags to a track.
+
+    :param  tags: dictionary of tag keys with a list of values
+    :type tags: :class:`dict`
+    :rtype: :class:`mopidy.models.Track`
+    """
+    album_kwargs = {}
+    track_kwargs = {}
+
+    track_kwargs['composers'] = _artists(tags, Gst.TAG_COMPOSER)
+    track_kwargs['performers'] = _artists(tags, Gst.TAG_PERFORMER)
+    track_kwargs['artists'] = _artists(tags, Gst.TAG_ARTIST,
+                                       'musicbrainz-artistid',
+                                       'musicbrainz-sortname')
+    album_kwargs['artists'] = _artists(
+        tags, Gst.TAG_ALBUM_ARTIST, 'musicbrainz-albumartistid')
+
+    track_kwargs['genre'] = '; '.join(tags.get(Gst.TAG_GENRE, []))
+    track_kwargs['name'] = '; '.join(tags.get(Gst.TAG_TITLE, []))
+    if not track_kwargs['name']:
+        track_kwargs['name'] = '; '.join(tags.get(Gst.TAG_ORGANIZATION, []))
+
+    track_kwargs['comment'] = '; '.join(tags.get('comment', []))
+    if not track_kwargs['comment']:
+        track_kwargs['comment'] = '; '.join(tags.get(Gst.TAG_LOCATION, []))
+    if not track_kwargs['comment']:
+        track_kwargs['comment'] = '; '.join(tags.get(Gst.TAG_COPYRIGHT, []))
+
+    track_kwargs['track_no'] = tags.get(Gst.TAG_TRACK_NUMBER, [None])[0]
+    track_kwargs['disc_no'] = tags.get(Gst.TAG_ALBUM_VOLUME_NUMBER, [None])[0]
+    track_kwargs['bitrate'] = tags.get(Gst.TAG_BITRATE, [None])[0]
+    track_kwargs['musicbrainz_id'] = tags.get('musicbrainz-trackid', [None])[0]
+
+    album_kwargs['name'] = tags.get(Gst.TAG_ALBUM, [None])[0]
+    album_kwargs['num_tracks'] = tags.get(Gst.TAG_TRACK_COUNT, [None])[0]
+    album_kwargs['num_discs'] = tags.get(Gst.TAG_ALBUM_VOLUME_COUNT, [None])[0]
+    album_kwargs['musicbrainz_id'] = tags.get('musicbrainz-albumid', [None])[0]
+
+    if tags.get(Gst.TAG_DATE) and tags.get(Gst.TAG_DATE)[0]:
+        track_kwargs['date'] = tags[Gst.TAG_DATE][0].isoformat()
+
+    # Clear out any empty values we found
+    track_kwargs = {k: v for k, v in track_kwargs.items() if v}
+    album_kwargs = {k: v for k, v in album_kwargs.items() if v}
+
+    # Only bother with album if we have a name to show.
+    if album_kwargs.get('name'):
+        track_kwargs['album'] = Album(**album_kwargs)
+
+    return Track(**track_kwargs)
+
+
+def _artists(
+        tags, artist_name, artist_id=None, artist_sortname=None):
+
+    # Name missing, don't set artist
+    if not tags.get(artist_name):
+        return None
+    # One artist name and either id or sortname, include all available fields
+    if len(tags[artist_name]) == 1 and \
+            (artist_id in tags or artist_sortname in tags):
+        attrs = {'name': tags[artist_name][0]}
+        if artist_id in tags:
+            attrs['musicbrainz_id'] = tags[artist_id][0]
+        if artist_sortname in tags:
+            attrs['sortname'] = tags[artist_sortname][0]
+        return [Artist(**attrs)]
+
+    # Multiple artist, provide artists with name only to avoid ambiguity.
+    return [Artist(name=name) for name in tags[artist_name]]

mopidy/audio/utils.py

@@ -1,18 +1,10 @@
 from __future__ import absolute_import, unicode_literals
 
-import collections
-import logging
-import numbers
-
 import gi
 gi.require_version('Gst', '1.0')
 from gi.repository import Gst
 
-from mopidy import compat, httpclient
-from mopidy.models import Album, Artist, Track
-
-logger = logging.getLogger(__name__)
-TRACE = logging.getLevelName('TRACE')
+from mopidy import httpclient
 
 
 def calculate_duration(num_samples, sample_rate):
@@ -68,79 +60,6 @@ def supported_uri_schemes(uri_schemes):
     return supported_schemes
 
 
-def _artists(tags, artist_name, artist_id=None, artist_sortname=None):
-    # Name missing, don't set artist
-    if not tags.get(artist_name):
-        return None
-    # One artist name and either id or sortname, include all available fields
-    if len(tags[artist_name]) == 1 and \
-            (artist_id in tags or artist_sortname in tags):
-        attrs = {'name': tags[artist_name][0]}
-        if artist_id in tags:
-            attrs['musicbrainz_id'] = tags[artist_id][0]
-        if artist_sortname in tags:
-            attrs['sortname'] = tags[artist_sortname][0]
-        return [Artist(**attrs)]
-
-    # Multiple artist, provide artists with name only to avoid ambiguity.
-    return [Artist(name=name) for name in tags[artist_name]]
-
-
-# TODO: split based on "stream" and "track" based conversion? i.e. handle data
-# from radios in it's own helper instead?
-def convert_tags_to_track(tags):
-    """Convert our normalized tags to a track.
-
-    :param  tags: dictionary of tag keys with a list of values
-    :type tags: :class:`dict`
-    :rtype: :class:`mopidy.models.Track`
-    """
-    album_kwargs = {}
-    track_kwargs = {}
-
-    track_kwargs['composers'] = _artists(tags, Gst.TAG_COMPOSER)
-    track_kwargs['performers'] = _artists(tags, Gst.TAG_PERFORMER)
-    track_kwargs['artists'] = _artists(tags, Gst.TAG_ARTIST,
-                                       'musicbrainz-artistid',
-                                       'musicbrainz-sortname')
-    album_kwargs['artists'] = _artists(
-        tags, Gst.TAG_ALBUM_ARTIST, 'musicbrainz-albumartistid')
-
-    track_kwargs['genre'] = '; '.join(tags.get(Gst.TAG_GENRE, []))
-    track_kwargs['name'] = '; '.join(tags.get(Gst.TAG_TITLE, []))
-    if not track_kwargs['name']:
-        track_kwargs['name'] = '; '.join(tags.get(Gst.TAG_ORGANIZATION, []))
-
-    track_kwargs['comment'] = '; '.join(tags.get('comment', []))
-    if not track_kwargs['comment']:
-        track_kwargs['comment'] = '; '.join(tags.get(Gst.TAG_LOCATION, []))
-    if not track_kwargs['comment']:
-        track_kwargs['comment'] = '; '.join(tags.get(Gst.TAG_COPYRIGHT, []))
-
-    track_kwargs['track_no'] = tags.get(Gst.TAG_TRACK_NUMBER, [None])[0]
-    track_kwargs['disc_no'] = tags.get(Gst.TAG_ALBUM_VOLUME_NUMBER, [None])[0]
-    track_kwargs['bitrate'] = tags.get(Gst.TAG_BITRATE, [None])[0]
-    track_kwargs['musicbrainz_id'] = tags.get('musicbrainz-trackid', [None])[0]
-
-    album_kwargs['name'] = tags.get(Gst.TAG_ALBUM, [None])[0]
-    album_kwargs['num_tracks'] = tags.get(Gst.TAG_TRACK_COUNT, [None])[0]
-    album_kwargs['num_discs'] = tags.get(Gst.TAG_ALBUM_VOLUME_COUNT, [None])[0]
-    album_kwargs['musicbrainz_id'] = tags.get('musicbrainz-albumid', [None])[0]
-
-    if tags.get(Gst.TAG_DATE) and tags.get(Gst.TAG_DATE)[0]:
-        track_kwargs['date'] = tags[Gst.TAG_DATE][0].isoformat()
-
-    # Clear out any empty values we found
-    track_kwargs = {k: v for k, v in track_kwargs.items() if v}
-    album_kwargs = {k: v for k, v in album_kwargs.items() if v}
-
-    # Only bother with album if we have a name to show.
-    if album_kwargs.get('name'):
-        track_kwargs['album'] = Album(**album_kwargs)
-
-    return Track(**track_kwargs)
-
-
 def setup_proxy(element, config):
     """Configure a GStreamer element with proxy settings.
 
@@ -157,46 +76,6 @@ def setup_proxy(element, config):
     element.set_property('proxy-pw', config.get('password'))
 
 
-def convert_taglist(taglist):
-    """Convert a :class:`Gst.TagList` to plain Python types.
-
-    Knows how to convert:
-
-    - Dates
-    - Buffers
-    - Numbers
-    - Strings
-    - Booleans
-
-    Unknown types will be ignored and debug logged. Tag keys are all strings
-    defined as part GStreamer under GstTagList_.
-
-    .. _GstTagList: https://developer.gnome.org/gstreamer/stable/\
-gstreamer-GstTagList.html
-
-    :param taglist: A GStreamer taglist to be converted.
-    :type taglist: :class:`Gst.TagList`
-    :rtype: dictionary of tag keys with a list of values.
-    """
-    result = collections.defaultdict(list)
-
-    for n in range(taglist.n_tags()):
-        tag = taglist.nth_tag_name(n)
-
-        for i in range(taglist.get_tag_size(tag)):
-            value = taglist.get_value_index(tag, i)
-
-            if isinstance(value, Gst.DateTime):
-                result[tag].append(value.to_iso8601_string())
-            if isinstance(value, (compat.string_types, bool, numbers.Number)):
-                result[tag].append(value)
-            else:
-                logger.log(
-                    TRACE, 'Ignoring unknown tag data: %r = %r', tag, value)
-
-    return result
-
-
 class Signals(object):
 
     """Helper for tracking gobject signal registrations"""

mopidy/file/library.py

@@ -7,7 +7,7 @@
 import urllib2
 
 from mopidy import backend, exceptions, models
-from mopidy.audio import scan, utils
+from mopidy.audio import scan, tags
 from mopidy.internal import path
 
 
@@ -83,7 +83,7 @@ def lookup(self, uri):
 
         try:
             result = self._scanner.scan(uri)
-            track = utils.convert_tags_to_track(result.tags).copy(
+            track = tags.convert_tags_to_track(result.tags).copy(
                 uri=uri, length=result.duration)
         except exceptions.ScannerError as e:
             logger.warning('Failed looking up %s: %s', uri, e)

mopidy/local/commands.py

@@ -6,7 +6,7 @@
 import time
 
 from mopidy import commands, compat, exceptions
-from mopidy.audio import scan, utils
+from mopidy.audio import scan, tags
 from mopidy.internal import path
 from mopidy.local import translator
 
@@ -140,18 +140,18 @@ def run(self, args, config):
                 relpath = translator.local_track_uri_to_path(uri, media_dir)
                 file_uri = path.path_to_uri(os.path.join(media_dir, relpath))
                 result = scanner.scan(file_uri)
-                tags, duration = result.tags, result.duration
                 if not result.playable:
                     logger.warning('Failed %s: No audio found in file.', uri)
-                elif duration < MIN_DURATION_MS:
+                elif result.duration < MIN_DURATION_MS:
                     logger.warning('Failed %s: Track shorter than %dms',
                                    uri, MIN_DURATION_MS)
                 else:
                     mtime = file_mtimes.get(os.path.join(media_dir, relpath))
-                    track = utils.convert_tags_to_track(tags).replace(
-                        uri=uri, length=duration, last_modified=mtime)
+                    track = tags.convert_tags_to_track(result.tags).replace(
+                        uri=uri, length=result.duration, last_modified=mtime)
                     if library.add_supports_tags_and_duration:
-                        library.add(track, tags=tags, duration=duration)
+                        library.add(
+                            track, tags=result.tags, duration=result.duration)
                     else:
                         library.add(track)
                     logger.debug('Added %s', track.uri)

mopidy/stream/actor.py

@@ -8,7 +8,7 @@
 import pykka
 
 from mopidy import audio as audio_lib, backend, exceptions, stream
-from mopidy.audio import scan, utils
+from mopidy.audio import scan, tags
 from mopidy.compat import urllib
 from mopidy.internal import http, playlists
 from mopidy.models import Track
@@ -60,7 +60,7 @@ def lookup(self, uri):
 
         try:
             result = self._scanner.scan(uri)
-            track = utils.convert_tags_to_track(result.tags).replace(
+            track = tags.convert_tags_to_track(result.tags).replace(
                 uri=uri, length=result.duration)
         except exceptions.ScannerError as e:
             logger.warning('Problem looking up %s: %s', uri, e)