X-Git-Url: http://git.tremily.us/?p=hooke.git;a=blobdiff_plain;f=hooke%2Fplugin%2Fplaylist.py;h=80c22d2ffa3628ebba2115ece97123d7f52dec78;hp=78ad4eb76148951756ad72745c35df98ddba0967;hb=7c52f54a7fc8654bc6783ff815c93166b917faf5;hpb=991979f61a625a669bbbde4c9168475ad83062e8 diff --git a/hooke/plugin/playlist.py b/hooke/plugin/playlist.py index 78ad4eb..80c22d2 100644 --- a/hooke/plugin/playlist.py +++ b/hooke/plugin/playlist.py @@ -1,105 +1,234 @@ -"""Defines :class:`PlaylistPlugin` several associated -:class:`hooke.plugin.Command`\s for handling :mod:`hooke.playlist` -classes. +# Copyright (C) 2010 W. Trevor King +# +# This file is part of Hooke. +# +# Hooke is free software: you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# Hooke is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General +# Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with Hooke. If not, see +# . + +"""The ``playlist`` module provides :class:`PlaylistPlugin` and +several associated :class:`hooke.command.Command`\s for handling +:mod:`hooke.playlist` classes. """ import glob +import os.path -from ..command import Command, Argument +from ..command import Command, Argument, Failure from ..playlist import FilePlaylist -from ..plugin import Builtin +from . import Builtin class PlaylistPlugin (Builtin): def __init__(self): super(PlaylistPlugin, self).__init__(name='playlist') + self._commands = [ + NextCommand(self), PreviousCommand(self), JumpCommand(self), + GetCommand(self), IndexCommand(self), CurveListCommand(self), + SaveCommand(self), LoadCommand(self), + AddCommand(self), AddGlobCommand(self), + RemoveCommand(self), ApplyCommandStack(self), + FilterCommand(self), NoteFilterCommand(self), + ] + + +# Define common or complicated arguments + +def current_playlist_callback(hooke, command, argument, value): + if value != None: + return value + playlist = hooke.playlists.current() + if playlist == None: + raise Failure('No playlists loaded') + return playlist + +PlaylistArgument = Argument( + name='playlist', type='playlist', callback=current_playlist_callback, + help=""" +:class:`hooke.playlist.Playlist` to act on. Defaults to the current +playlist. +""".strip()) - def commands(self): - return [NextCommand(), PreviousCommand(), JumpCommand(), - SaveCommand(), LoadCommand(), - AddCommand(), AddGlobCommand(), - RemoveCommand(), FilterCommand()] +def playlist_name_callback(hooke, command, argument, value): + if value != None: + return value + i = 0 + names = [p.name for p in hooke.playlists] + while True: + name = 'playlist-%d' % i + if name not in names: + return name + i += 1 + +PlaylistNameArgument = Argument( + name='output playlist', type='string', optional=True, + callback=playlist_name_callback, + help=""" +Name of the new playlist (defaults to an auto-generated name). +""".strip()) + +def all_drivers_callback(hooke, command, argument, value): + return hooke.drivers + + +# Define useful command subclasses + +class PlaylistCommand (Command): + """A :class:`~hooke.command.Command` operating on a + :class:`~hooke.playlist.Playlist`. + """ + def __init__(self, **kwargs): + if 'arguments' in kwargs: + kwargs['arguments'].insert(0, PlaylistArgument) + else: + kwargs['arguments'] = [PlaylistArgument] + super(PlaylistCommand, self).__init__(**kwargs) -class NextCommand (Command): + def _playlist(self, hooke, params): + """Get the selected playlist. + + Notes + ----- + `hooke` is intended to attach the selected playlist to the + local hooke instance; the returned playlist should not be + effected by the state of `hooke`. + """ + # HACK? rely on params['playlist'] being bound to the local + # hooke (i.e. not a copy, as you would get by passing a + # playlist through the queue). Ugh. Stupid queues. As an + # alternative, we could pass lookup information through the + # queue... + return params['playlist'] + + +class PlaylistAddingCommand (Command): + """A :class:`~hooke.command.Command` adding a + :class:`~hooke.playlist.Playlist`. + """ + def __init__(self, **kwargs): + if 'arguments' in kwargs: + kwargs['arguments'].insert(0, PlaylistNameArgument) + else: + kwargs['arguments'] = [PlaylistNameArgument] + super(PlaylistAddingCommand, self).__init__(**kwargs) + + def _set_playlist(self, hooke, params, playlist): + """Attach a new playlist. + """ + playlist.name = params['output playlist'] + hooke.playlists.append(playlist) + + +# Define commands + +class NextCommand (PlaylistCommand): """Move playlist to the next curve. """ - def __init__(self): + def __init__(self, plugin): super(NextCommand, self).__init__( - name='next curve', - arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), - ], - help=self.__doc__) + name='next curve', help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + self._playlist(hooke, params).next() - def _run(inqueue, outqueue, params): - params['playlist'].next() -class PreviousCommand (Command): +class PreviousCommand (PlaylistCommand): """Move playlist to the previous curve. """ - def __init__(self): + def __init__(self, plugin): super(PreviousCommand, self).__init__( - name='previous curve', - arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), - ], - help=self.__doc__) + name='previous curve', help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + self._playlist(hooke, params).previous() - def _run(inqueue, outqueue, params): - params['playlist'].previous() -class JumpCommand (Command): +class JumpCommand (PlaylistCommand): """Move playlist to a given curve. """ - def __init__(self): + def __init__(self, plugin): super(JumpCommand, self).__init__( name='jump to curve', arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), Argument(name='index', type='int', optional=False, help=""" Index of target curve. """.strip()), ], - help=self.__doc__) + help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + self._playlist(hooke, params).jump(params['index']) + + +class IndexCommand (PlaylistCommand): + """Print the index of the current curve. + + The first curve has index 0. + """ + def __init__(self, plugin): + super(IndexCommand, self).__init__( + name='curve index', help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + outqueue.put(self._playlist(hooke, params).index()) + + +class GetCommand (PlaylistCommand): + """Return a :class:`hooke.playlist.Playlist`. + """ + def __init__(self, plugin): + super(GetCommand, self).__init__( + name='get playlist', help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + outqueue.put(self._playlist(hooke, params)) - def _run(inqueue, outqueue, params): - params['playlist'].jump(params['index']) -class SaveCommand (Command): +class CurveListCommand (PlaylistCommand): + """Get the curves in a playlist. + """ + def __init__(self, plugin): + super(CurveListCommand, self).__init__( + name='playlist curves', help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + outqueue.put(list(self._playlist(hooke, params))) + + +class SaveCommand (PlaylistCommand): """Save a playlist. """ - def __init__(self): + def __init__(self, plugin): super(SaveCommand, self).__init__( name='save playlist', arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), Argument(name='output', type='file', help=""" -File name for the output playlist. Defaults to overwring the input -playlist. +File name for the output playlist. Defaults to overwriting the input +playlist. If the playlist does not have an input file (e.g. it was +created from scratch with 'new playlist'), this option is required. """.strip()), ], - help=self.__doc__) + help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + self._playlist(hooke, params).save(params['output']) - def _run(inqueue, outqueue, params): - params['playlist'].save(params['output']) -class LoadCommand (Command): +class LoadCommand (PlaylistAddingCommand): """Load a playlist. """ - def __init__(self): + def __init__(self, plugin): super(LoadCommand, self).__init__( name='load playlist', arguments=[ @@ -107,30 +236,31 @@ class LoadCommand (Command): help=""" File name for the input playlist. """.strip()), - Argument(name='digests', type='digest', optional=False, - count=-1, + Argument(name='drivers', type='driver', optional=True, + count=-1, callback=all_drivers_callback, help=""" -Digests for loading curves. +Drivers for loading curves. """.strip()), ], - help=self.__doc__) + help=self.__doc__, plugin=plugin) - def _run(inqueue, outqueue, params): + def _run(self, hooke, inqueue, outqueue, params): p = FilePlaylist(drivers=params['drivers'], path=params['input']) - p.load() + p.load(hooke=hooke) + playlist_names = [playlist.name for playlist in hooke.playlists] + if p.name in playlist_names or p.name == None: + p.name = params['output playlist'] # HACK: override input name. How to tell if it is callback-generated? + self._set_playlist(hooke, params, p) outqueue.put(p) -class AddCommand (Command): + +class AddCommand (PlaylistCommand): """Add a curve to a playlist. """ - def __init__(self): + def __init__(self, plugin): super(AddCommand, self).__init__( name='add curve to playlist', arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), Argument(name='input', type='file', optional=False, help=""" File name for the input :class:`hooke.curve.Curve`. @@ -140,28 +270,25 @@ File name for the input :class:`hooke.curve.Curve`. Additional information for the input :class:`hooke.curve.Curve`. """.strip()), ], - help=self.__doc__) + help=self.__doc__, plugin=plugin) - def _run(inqueue, outqueue, params): - params['playlist'].append_curve_by_path(params['input'], - params['info']) + def _run(self, hooke, inqueue, outqueue, params): + self._playlist(hooke, params).append_curve_by_path( + params['input'], params['info'], hooke=hooke) -class AddGlobCommand (Command): + +class AddGlobCommand (PlaylistCommand): """Add curves to a playlist with file globbing. Adding lots of files one at a time can be tedious. With this command you can use globs (`data/curves/*.dat`) to add curves for all matching files at once. """ - def __init__(self): + def __init__(self, plugin): super(AddGlobCommand, self).__init__( name='glob curves to playlist', arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), - Argument(name='input', type='glob', optional=False, + Argument(name='input', type='string', optional=False, help=""" File name glob for the input :class:`hooke.curve.Curve`. """.strip()), @@ -170,55 +297,116 @@ File name glob for the input :class:`hooke.curve.Curve`. Additional information for the input :class:`hooke.curve.Curve`. """.strip()), ], - help=self.__doc__) + help=self.__doc__, plugin=plugin) - def _run(inqueue, outqueue, params): + def _run(self, hooke, inqueue, outqueue, params): + p = self._playlist(hooke, params) for path in sorted(glob.glob(params['input'])): - params['playlist'].append_curve_by_path(path, params['info']) + p.append_curve_by_path(path, params['info'], hooke=hooke) + outqueue.put(p[-1]) -class RemoveCommand (Command): +class RemoveCommand (PlaylistCommand): """Remove a curve from a playlist. """ - def __init__(self): + def __init__(self, plugin): super(RemoveCommand, self).__init__( name='remove curve from playlist', arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), Argument(name='index', type='int', optional=False, help=""" Index of target curve. """.strip()), ], - help=self.__doc__) + help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + self._playlist(hooke, params).pop(params['index']) + self._playlist(hooke, params).jump(params.index()) + + +class ApplyCommandStack (PlaylistCommand): + """Apply a :class:`~hooke.command_stack.CommandStack` to each + curve in a playlist. + + TODO: discuss `evaluate`. + """ + def __init__(self, plugin): + super(ApplyCommandStack, self).__init__( + name='apply command stack', + arguments=[ + Argument(name='commands', type='command stack', optional=False, + help=""" +Command stack to apply to each curve. +""".strip()), + Argument(name='evaluate', type='bool', default=False, + help=""" +Evaluate the applied command stack immediately. +""".strip()), + ], + help=self.__doc__, plugin=plugin) + + def _run(self, hooke, inqueue, outqueue, params): + if len(params['commands']) == 0: + return + p = self._playlist(hooke, params) + if params['evaluate'] == True: + for curve in p.items(): + for command in params['commands']: + curve.command_stack.execute_command(hooke, command) + curve.command_stack.append(command) + else: + for curve in p: + curve.command_stack.extend(params['commands']) + curve.unload() # force command stack execution on next access. - def _run(inqueue, outqueue, params): - params['playlist'].pop(params['index']) - params['playlist'].jump(params._index) -class FilterCommand (Command): +class FilterCommand (PlaylistAddingCommand, PlaylistCommand): """Create a subset playlist via a selection function. Removing lots of curves one at a time can be tedious. With this command you can use a function `filter` to select the curves you wish to keep. + + Notes + ----- + There are issues with pickling functions bound to class + attributes, because the pickle module doesn't know where those + functions were originally defined (where it should point the + loader). Because of this, subclasses with hard-coded filter + functions are encouraged to define their filter function as a + method of their subclass. See, for example, + :meth:`NoteFilterCommand.filter`. """ - def __init__(self): + def __init__(self, plugin, name='filter playlist'): super(FilterCommand, self).__init__( - name='filter playlist', - arguments=[ - Argument(name='playlist', type='playlist', optional=False, - help=""" -:class:``hooke.plugin.playlist.Playlist`` to act on. -""".strip()), + name=name, help=self.__doc__, plugin=plugin) + if not hasattr(self, 'filter'): + self.arguments.append( Argument(name='filter', type='function', optional=False, help=""" -Function returning `True` for "good" curves. `filter(curve) -> True/False`. -""".strip()), - ], - help=self.__doc__) +Function returning `True` for "good" curves. +`filter(curve, hooke, inqueue, outqueue, params) -> True/False`. +""".strip())) - def _run(inqueue, outqueue, params): - p = params['playlist'].filter(params['filter']) + def _run(self, hooke, inqueue, outqueue, params): + if not hasattr(self, 'filter'): + filter_fn = params['filter'] + else: + filter_fn = self.filter + p = self._playlist(hooke, params).filter(filter_fn, + hooke=hooke, inqueue=inqueue, outqueue=outqueue, params=params) + p.name = params['name'] + if hasattr(p, 'path') and p.path != None: + p.set_path(os.path.join(os.path.dirname(p.path), p.name)) + self._set_playlist(hooke, params, p) outqueue.put(p) + + +class NoteFilterCommand (FilterCommand): + """Create a subset playlist of curves with `.info['note'] != None`. + """ + def __init__(self, plugin): + super(NoteFilterCommand, self).__init__( + plugin, name='note filter playlist') + + def filter(self, curve, hooke, inqueue, outqueue, params): + return 'note' in curve.info and curve.info['note'] != None