station history ready (for same playlist only)

Author: s-n-g

README.html

@@ -1497,6 +1497,8 @@ <h2 id="packaging-pyradio">Packaging PyRadio <span style="padding-left: 10px;"><
 <p>If you are a packager and would like to produce a package for your distribution please do follow this mini guide.</p>
 <p>First of all, make sure you declare the pacakges’s requirements to the relevant section of your manifest (or whatever) file. These are:</p>
 <ol type="1">
+<li>setuptools</li>
+<li>wheel</li>
 <li>requests</li>
 <li>dnspython</li>
 <li>psutil</li>

README.md

@@ -1061,9 +1061,11 @@ If you are a packager and would like to produce a package for your distribution
 
 First of all, make sure you declare the pacakges's requirements to the relevant section of your manifest (or whatever) file. These are:
 
-1. requests
-2. dnspython
-3. psutil
+1. setuptools
+2. wheel
+3. requests
+4. dnspython
+5. psutil
 
 After that, you will have to modify some files, because **PyRadio** is able to update and uninstall itself, when installed from source. This is something you do not want to be happening when your package is used; **PyRadio** should be updated and uninstalled using the distro package manager.
 

pyradio/config.py

@@ -104,6 +104,9 @@ class PyRadioStations(object):
     ''' last opened playlist splitted on , '''
     last_playlist_to_open = []
 
+    station_history = None
+    play_from_history = False
+
     def __init__(self, stationFile=''):
         if platform.startswith('win'):
             self._open_string_id = 1
@@ -292,6 +295,18 @@ def can_go_back_in_time(self):
     def can_go_back_in_time(self, value):
         raise ValueError('property is read only')
 
+    def set_station_history(self,
+                            execute_funct,
+                            pass_first_item_funct,
+                            pass_last_item_funct,
+                            no_items_funct):
+        self.stations_history = PyRadioStationsStack(
+            execute_function=execute_funct,
+            pass_first_item_function=pass_first_item_funct,
+            pass_last_item_function=pass_last_item_funct,
+            no_items_function=no_items_funct
+        )
+
     def save_last_playlist(self, sel):
         lp = path.join(self.stations_dir, 'last_playlist')
         llp = self._ps.last_local_playlist
@@ -2411,6 +2426,77 @@ def replace(self, a_search_path, new_item):
         return ret
 
 
+class PyRadioStationsStack(object):
+    pass_first_item_func=None
+    pass_last_item_func=None
+    no_items_func=None
+
+    def __init__(
+        self,
+        execute_function,
+        pass_first_item_function=None,
+        pass_last_item_function=None,
+        no_items_function=None
+    ):
+        self.items = []
+        self.item = -1
+        self.execute_func = execute_function
+        self.pass_first_item_func = pass_first_item_function
+        self.pass_last_item_func = pass_last_item_function
+        self.no_items_func = no_items_function
+
+    def add(self, a_playlist, a_station, a_station_id):
+        if a_playlist and a_station:
+            if self.item == -1:
+                self.items.append((a_playlist, a_station, a_station_id))
+                self.item = 0
+            else:
+                if not self.play_from_history and \
+                        (self.items[-1][0] != a_playlist \
+                        or self.items[-1][1] != a_station) and \
+                        (self.items[self.item][0] != a_playlist \
+                         or self.items[self.item][1] != a_station):
+                    self.items.append((a_playlist, a_station, a_station_id))
+                    logger.error('adding item...')
+                    self.item = len(self.items) - 1
+            self.play_from_history = False
+        if logger.isEnabledFor(logging.DEBUG):
+            logger.debug('>>> Stations history')
+            for n in self.items:
+                logger.debug('   {}'.format(n))
+            logger.debug('   item = {}'.format(self.item))
+
+    def _get(self):
+        if self.item == -1:
+            if self.no_items_func is not None:
+                self.no_items_func()
+        return tuple(self.items[self.item])
+
+    def play_previous(self):
+        if self.item == -1:
+            if self.no_items_func is not None:
+                self.no_items_func()
+        elif self.item == 0:
+            if self.pass_first_item_func is not None:
+                self.pass_first_item_func()
+        else:
+            old_item = self._get()
+            self.item -= 1
+            self.execute_func(old_item, self._get())
+
+    def play_next(self):
+        if self.item == -1:
+            if self.no_items_func is not None:
+                self.no_items_func()
+        elif self.item == len(self.items) - 1:
+            if self.pass_last_item_func is not None:
+                self.pass_last_item_func()
+        else:
+            old_item = self._get()
+            self.item += 1
+            self.execute_func(old_item, self._get())
+
+
 class PyRadioLog(object):
 
     PATTERN = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'

pyradio/player.py

@@ -230,7 +230,7 @@ class Player(object):
     icy_tokens = ()
     icy_audio_tokens = {}
 
-    playback_is_on = False
+    playback_is_on = connecting = False
 
     _station_encoding = 'utf-8'
 
@@ -255,9 +255,11 @@ def __init__(self,
                  outputStream,
                  playback_timeout_counter,
                  playback_timeout_handler,
-                 info_display_handler):
+                 info_display_handler,
+                 history_add_function):
         self.outputStream = outputStream
         self._cnf = config
+        self.stations_history_add_function = history_add_function
         self.config_encoding = self._cnf.default_encoding
         self.config_dir = self._cnf.stations_dir
         try:
@@ -632,7 +634,9 @@ def updateStatus(self, *args):
                             new_input = self.oldUserInput['Title']
                         self.outputStream.write(msg=new_input, counter='')
                         self.playback_is_on = True
+                        self.connecting = False
                         self._stop_delay_thread()
+                        self.stations_history_add_function()
                         if 'AO: [' in subsystemOut:
                             with self.status_update_lock:
                                 if version_info > (3, 0):
@@ -665,6 +669,8 @@ def updateStatus(self, *args):
                                 if logger.isEnabledFor(logging.INFO):
                                     logger.info('*** updateStatus(): Start of playback detected (Icy-Title received) ***')
                             self.playback_is_on = True
+                            self.connecting = False
+                            self.stations_history_add_function()
                             ''' detect empty Icy-Title '''
                             title_without_prefix = title[len(self.icy_title_prefix):].strip()
                             # logger.error('DE title_without_prefix = "{}"'.format(title_without_prefix))
@@ -707,6 +713,8 @@ def updateStatus(self, *args):
                                     if logger.isEnabledFor(logging.INFO):
                                         logger.info('*** updateStatus(): Start of playback detected (Icy audio token received) ***')
                                 self.playback_is_on = True
+                                self.connecting = False
+                                self.stations_history_add_function()
                                 if enable_crash_detection_function:
                                     enable_crash_detection_function()
                                 # logger.error('DE token = "{}"'.format(a_token))
@@ -968,7 +976,9 @@ def do_crash_detection(detect_if_player_exited, stop):
                             new_input = self.oldUserInput['Title']
                         self.outputStream.write(msg=new_input, counter='')
                         self.playback_is_on = True
+                        self.connecting = False
                         self._stop_delay_thread()
+                        self.stations_history_add_function()
                         if 'AO: [' in subsystemOut:
                             with self.status_update_lock:
                                 if version_info > (3, 0):
@@ -989,7 +999,9 @@ def do_crash_detection(detect_if_player_exited, stop):
                         except:
                             pass
                         self.playback_is_on = True
+                        self.connecting = False
                         self._stop_delay_thread()
+                        self.stations_history_add_function()
                         if enable_crash_detection_function:
                             enable_crash_detection_function()
 
@@ -1033,7 +1045,9 @@ def do_crash_detection(detect_if_player_exited, stop):
                                 except:
                                     pass
                                 self.playback_is_on = True
+                                self.connecting = False
                                 self._stop_delay_thread()
+                                self.stations_history_add_function()
                                 if enable_crash_detection_function:
                                     enable_crash_detection_function()
                                 # logger.error('DE token = "{}"'.format(a_token))
@@ -1233,12 +1247,14 @@ def _set_mpv_playback_is_on(self, stop, enable_crash_detection_function):
         self.detect_if_player_exited = True
         if (not self.playback_is_on) and (logger.isEnabledFor(logging.INFO)):
                     logger.info('*** _set_mpv_playback_is_on(): Start of playback detected ***')
+        self.stations_history_add_function()
         new_input = 'Playing: ' + self.name
         self.outputStream.write(msg=new_input, counter='')
         if self.oldUserInput['Title'] == '':
             self.oldUserInput['Input'] = new_input
         self.oldUserInput['Title'] = new_input
         self.playback_is_on = True
+        self.connecting = False
         if stop():
             return False
         enable_crash_detection_function()
@@ -1381,6 +1397,10 @@ def play(self,
         # start playback check timer thread
         self.stop_timeout_counter_thread = False
         if self.playback_timeout > 0:
+            ''' set connecting here insead of Player.play()
+                so that we do not use it when timeout = 0
+            '''
+            self.connecting = True
             try:
                 self.connection_timeout_thread = threading.Thread(
                     target=self.playback_timeout_counter,
@@ -1392,10 +1412,12 @@ def play(self,
                 if (logger.isEnabledFor(logging.DEBUG)):
                     logger.debug('playback detection thread started')
             except:
+                self.connecting = False
                 self.connection_timeout_thread = None
                 if (logger.isEnabledFor(logging.ERROR)):
                     logger.error('playback detection thread failed to start')
         else:
+            self.connecting = False
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('playback detection thread not starting (timeout is 0)')
         if logger.isEnabledFor(logging.INFO):
@@ -1614,14 +1636,16 @@ def __init__(self,
                  outputStream,
                  playback_timeout_counter,
                  playback_timeout_handler,
-                 info_display_handler):
+                 info_display_handler,
+                 history_add_function):
         config.PLAYER_NAME = 'mpv'
         super(MpvPlayer, self).__init__(
             config,
             outputStream,
             playback_timeout_counter,
             playback_timeout_handler,
-            info_display_handler
+            info_display_handler,
+            history_add_function
         )
         self.config_files = self.all_config_files['mpv']
 
@@ -2039,14 +2063,16 @@ def __init__(self,
                  outputStream,
                  playback_timeout_counter,
                  playback_timeout_handler,
-                 info_display_handler):
+                 info_display_handler,
+                 history_add_function):
         config.PLAYER_NAME = 'mplayer'
         super(MpPlayer, self).__init__(
             config,
             outputStream,
             playback_timeout_counter,
             playback_timeout_handler,
-            info_display_handler
+            info_display_handler,
+            history_add_function
         )
         self.config_files = self.all_config_files['mplayer']
 
@@ -2247,14 +2273,16 @@ def __init__(self,
                  outputStream,
                  playback_timeout_counter,
                  playback_timeout_handler,
-                 info_display_handler):
+                 info_display_handler,
+                 history_add_function):
         config.PLAYER_NAME = 'vlc'
         super(VlcPlayer, self).__init__(
             config,
             outputStream,
             playback_timeout_counter,
             playback_timeout_handler,
-            info_display_handler
+            info_display_handler,
+            history_add_function
         )
         # self.config_files = self.all_config_files['vlc']