beets / beetsplug /

# This file is part of beets.
# Copyright 2012, Jakob Schnitzer.
# 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.

"""Converts tracks or albums to external directory
import logging
import os
import shutil
import threading
from subprocess import Popen, PIPE

from beets.plugins import BeetsPlugin
from beets import ui, util
from beetsplug.embedart import _embed

log = logging.getLogger('beets')
DEVNULL = open(os.devnull, 'wb')
conf = {}
_fs_lock = threading.Lock()

def encode(source, dest):'Started encoding {0}'.format(util.displayable_path(source)))

    encode = Popen([conf['ffmpeg']] + ['-i', source] + conf['opts'] +
                   [dest], close_fds=True, stderr=DEVNULL)
    if encode.returncode != 0:
        # Something went wrong (probably Ctrl+C), remove temporary files'Encoding {0} failed. Cleaning up...'.format(source))
        return'Finished encoding {0}'.format(util.displayable_path(source)))

def convert_item(lib, dest_dir):
    while True:
        item = yield

        dest = os.path.join(dest_dir, lib.destination(item, fragment=True))
        dest = os.path.splitext(dest)[0] + '.mp3'

        if os.path.exists(dest):
  'Skipping {0} (target file exists)'.format(

        # Ensure that only one thread tries to create directories at a
        # time. (The existence check is not atomic with the directory
        # creation inside this function.)
        with _fs_lock:

        if item.format == 'MP3' and item.bitrate < 1000 * conf['max_bitrate']:
  'Copying {0}'.format(util.displayable_path(item.path)))
            util.copy(item.path, dest)
            encode(item.path, dest)

        item.path = dest

        if conf['embed']:
            album = lib.get_album(item)
            if album:
                artpath = album.artpath
                if artpath:
                    _embed(artpath, [item])

def convert_func(lib, config, opts, args):
    dest = opts.dest if opts.dest is not None else conf['dest']
    if not dest:
        raise ui.UserError('no convert destination set')
    threads = opts.threads if opts.threads is not None else conf['threads']

    ui.commands.list_items(lib, ui.decargs(args), opts.album, None, config)

    if not ui.input_yn("Convert? (Y/n)"):

    if opts.album:
        items = (i for a in lib.albums(ui.decargs(args)) for i in a.items())
        items = lib.items(ui.decargs(args))
    convert = [convert_item(lib, dest) for i in range(threads)]
    pipe = util.pipeline.Pipeline([items, convert])

class ConvertPlugin(BeetsPlugin):
    def configure(self, config):
        conf['dest'] = ui.config_val(config, 'convert', 'dest', None)
        conf['threads'] = int(ui.config_val(config, 'convert', 'threads',
        conf['ffmpeg'] = ui.config_val(config, 'convert', 'ffmpeg', 'ffmpeg')
        conf['opts'] = ui.config_val(config, 'convert',
                                     'opts', '-aq 2').split(' ')
        conf['max_bitrate'] = int(ui.config_val(config, 'convert',
                                                'max_bitrate', '500'))
        conf['embed'] = ui.config_val(config, 'convert', 'embed', True,

    def commands(self):
        cmd = ui.Subcommand('convert', help='convert to external location')
        cmd.parser.add_option('-a', '--album', action='store_true',
                              help='choose albums instead of tracks')
        cmd.parser.add_option('-t', '--threads', action='store', type='int',
                              help='change the number of threads, \
                              defaults to maximum availble processors ')
        cmd.parser.add_option('-d', '--dest', action='store',
                              help='set the destination directory')
        cmd.func = convert_func
        return [cmd]