Merge pull request #708 from davidhampgonsalves/master

Play Plugin

beetsplug/play.py

@@ -0,0 +1,116 @@
+# This file is a plugin on beets.
+# Copyright (c) <2013> David Hamp-Gonsalves
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+"""Sends the results of a query to the configured music player as a playlist.
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand
+from beets import config
+from beets import ui
+import platform
+import subprocess
+import os
+from tempfile import NamedTemporaryFile
+
+
+def play_music(lib, opts, args):
+    """Execute query, create temporary playlist and execute player
+    command passing that playlist.
+    """
+
+    command = config['play']['command'].get()
+    is_debug = config['play']['debug'].get()
+
+    # If a command isn't set then let the OS decide how to open the playlist.
+    if not command:
+        sys_name = platform.system()
+        if sys_name == 'Darwin':
+            command = 'open'
+        elif sys_name == 'Windows':
+            command = 'start'
+        else:
+            # If not Mac or Win then assume Linux(or posix based).
+            command = 'xdg-open'
+
+    # Preform search by album and add folders rather then tracks to playlist.
+    if opts.album:
+        albums = lib.albums(ui.decargs(args))
+        paths = []
+
+        for album in albums:
+            paths.append(album.item_dir())
+        itemType = 'album'
+
+    # Preform item query and add tracks to playlist.
+    else:
+        paths = [item.path for item in lib.items(ui.decargs(args))]
+        itemType = 'track'
+
+    itemType += 's' if len(paths) > 1 else ''
+
+    if not paths:
+        ui.print_(ui.colorize('yellow', 'No {0} to play.'.format(itemType)))
+        return
+
+    # Warn user before playing any huge playlists.
+    if len(paths) > 100:
+        ui.print_(ui.colorize(
+            'yellow',
+            'You are about to queue {0} {1}.'.format(len(paths), itemType)))
+
+        if ui.input_options(('Continue', 'Abort')) == 'a':
+            return
+
+    # Create temporary m3u file to hold our playlist.
+    m3u = NamedTemporaryFile('w', suffix='.m3u', delete=False)
+    for item in paths:
+        m3u.write(item + '\n')
+    m3u.close()
+
+    # Prevent player output from poluting our console(unless debug is on).
+    if not is_debug:
+        FNULL = open(os.devnull, 'w')
+
+        subprocess.Popen([command, m3u.name],
+                         stdout=FNULL, stderr=subprocess.STDOUT)
+
+        FNULL.close()
+    else:
+        subprocess.Popen([command, m3u.name])
+
+    ui.print_('Playing {0} {1}.'.format(len(paths), itemType))
+
+
+class PlayPlugin(BeetsPlugin):
+
+    def __init__(self):
+        super(PlayPlugin, self).__init__()
+
+        config['play'].add({
+            'command': None,
+            'debug': False
+        })
+
+    def commands(self):
+        play_command = Subcommand(
+            'play',
+            help='Send query results to music player as playlist.')
+        play_command.parser.add_option(
+            '-a', '--album',
+            action='store_true', default=False,
+            help='Query and load albums(as folders) rather then tracks.')
+        play_command.func = play_music
+        return [play_command]

docs/plugins/index.rst

@@ -48,6 +48,7 @@ by typing ``beet version``.
    ihate
    convert
    info
+   play
    smartplaylist
    mbsync
    missing
@@ -109,6 +110,7 @@ Interoperability
   changes.
 * :doc:`importfeeds`: Keep track of imported files via ``.m3u`` playlist file(s) or symlinks.
 * :doc:`smartplaylist`: Generate smart playlists based on beets queries.
+* :doc:`play`: Play beets queries in your music player.
 
 Miscellaneous
 -------------

docs/plugins/play.rst

@@ -0,0 +1,19 @@
+Play Plugin
+============
+
+The ``play`` plugin allows you to pass the results of a query to a music player in the form of a m3u playlist.
+
+To use the plugin, first enable it in your configuration (see
+:ref:`using-plugins`). Then, add an ``play:`` section to your configuration
+file::
+
+    play:
+        # Command(optional) override the system default for m3u files.
+        # You can define a command to be executed by the shell which the m3u path will be appended to.
+        command: command: /Applications/VLC.app/Contents/MacOS/VLC
+        # Debug(optional) displays output from player for aiding in setting up command correctly.
+        debug: True
+
+How it works
+============
+The plugin works by turning your query results into a temporary m3u file. Then the command you have configured it executed by the shell and the playlist is passed as the last parameter.