sima/lib/player.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2009-2014 Jack Kaliko <jack@azylum.org>
   3 #
   4 #  This file is part of sima
   5 #
   6 #  sima is free software: you can redistribute it and/or modify
   7 #  it under the terms of the GNU General Public License as published by
   8 #  the Free Software Foundation, either version 3 of the License, or
   9 #  (at your option) any later version.
  10 #
  11 #  sima is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #  GNU General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU General Public License
  17 #  along with sima.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19 #
  20
  21 # TODO:
  22 # Add decorator to filter through history?
  23
  24 # standard library import
  25 import logging
  26
  27 # local import
  28 #from sima.lib.track import Track
  29
  30
  31 class Player(object):
  32     """Player interface to inherit from.
  33
  34     When querying player music library for tracks, Player instance *must* return
  35     Track objects (usually a list of them)
  36
  37     Player instance should expose the following immutable attributes:
  38         * artists
  39         * state
  40         * current
  41         * queue
  42         * playlist
  43         *
  44     """
  45
  46     def __init__(self):
  47         super().__init__()
  48         self.log = logging.getLogger('sima')
  49
  50     def monitor(self):
  51         """Monitor player for change
  52         Returns :
  53             * database  player media library has changed
  54             * playlist  playlist modified
  55             * options   player options changed: repeat mode, etc…
  56             * player    player state changed: paused, stopped, skip track…
  57         """
  58         raise NotImplementedError
  59
  60     def remove(self, position=0):
  61         """Removes the oldest element of the playlist (index 0)
  62         """
  63         raise NotImplementedError
  64
  65     def find_track(self, artist, title=None):
  66         """
  67         Find tracks for a specific artist or filtering with a track title
  68             >>> player.find_track('The Beatles')
  69             >>> player.find_track('Nirvana', title='Smells Like Teen Spirit')
  70
  71         Returns a list of Track objects
  72         """
  73         raise NotImplementedError
  74
  75     def find_album(self, artist, album):
  76         """
  77         Find tracks by track's album name
  78             >>> player.find_album('Nirvana', 'Nevermind')
  79
  80         Returns a list of Track objects
  81         """
  82         raise NotImplementedError
  83
  84     def find_albums(self, artist):
  85         """
  86         Find albums by artist's name
  87             >>> player.find_alums('Nirvana')
  88
  89         Returns a list of string objects
  90         """
  91         raise NotImplementedError
  92
  93     def fuzzy_find_artist(self, artist):
  94         """
  95         Find artists based on a fuzzy search in the media library
  96             >>> bea = player.fuzzy_find_artist('beatles')
  97             >>> print(bea)
  98             >>> ['The Beatles']
  99
 100         Returns a list of strings (artist names)
 101         """
 102         raise NotImplementedError
 103
 104     def disconnect(self):
 105         """Closing client connection with the Player
 106         """
 107         raise NotImplementedError
 108
 109     def connect(self):
 110         """Connect client to the Player
 111         """
 112         raise NotImplementedError
 113
 114 # VIM MODLINE
 115 # vim: ai ts=4 sw=4 sts=4 expandtab