- adding buffering config file parameter

- config.py: buffering_data updated when player changes
  and when saving config (after editing)
- diaplsy a message to manually remove the referer file
  if its deletion has failed
- removing code to rename the referer file

Author: s-n-g

pyradio/config

@@ -143,6 +143,14 @@ connection_timeout = 10
 # Default value: False
 force_http = False
 
+# Buffering 
+# This is the number of seconds the players will buffer data
+# before actually starting producing sound
+#
+# Valid values: 5 - 60 (0 to disable)
+# Default value = 0
+buffering = 0
+
 # Default theme
 # Hard coded themes:
 #   dark (default) (8 colors)

pyradio/config.py

@@ -754,6 +754,12 @@ def read_playlist_file(
                                 referer = row[Station.referer].strip()
                                 this_row_version = Station.referer
 
+                            if buffering:
+                                if '@' not in buffering:
+                                    buffering += '@128'
+                            else:
+                                buffering = '0@128'
+
                             # Append the parsed values to the reading stations list
                             station_info = [
                                 name, url, enc, {'image': icon} if icon else '',
@@ -924,37 +930,25 @@ def save_playlist_file(self, stationFile=''):
                 logger.debug('Cannot rename playlist file...')
             return -2
         self.dirty_playlist = False
-        if self.renamed_stations:
-            for n in self.renamed_stations:
-                chk_referer_file = path.join(self.stations_dir, n[0] + '.referer.txt')
-                if path.exists(chk_referer_file):
-                    new_referer_file = path.join(self.stations_dir, n[1] + '.referer.txt')
-                    try:
-                        rename(chk_referer_file, new_referer_file)
-                        if logger.isEnabledFor(logging.DEBUG):
-                            logger.debug('referer file renamed from "{}" to "{}"'.format(
-                                path.basename(chk_referer_file),
-                                path.basename(new_referer_file)
-                                ))
-                    except:
-                        pass
-                        if logger.isEnabledFor(logging.DEBUG):
-                            logger.debug('failed to rename referer file from "{}" to "{}"'.format(
-                                path.basename(chk_referer_file),
-                                path.basename(new_referer_file)
-                                ))
         return 0
 
     def _format_playlist_row(self, a_row):
         ''' Return a row formatted according to the current playlist version,
             eliminating any empty fields that are not part of the specified version. '''
         this_row = deepcopy(a_row)
-
+        logger.error(f'{this_row}')
+        logger.error(f'{self._playlist_version}')
         # Extract the 'image' from the icon dictionary if present
-        if len(this_row) > 3 and 'image' in this_row[3]:
-            this_row[3] = this_row[3]['image']
+        if len(this_row) > Station.icon and 'image' in this_row[Station.icon]:
+            this_row[Station.icon] = this_row[Station.icon]['image']
+
+        if len(this_row) > Station.buffering:
+            if this_row[Station.buffering].startswith('0'):
+                this_row[Station.buffering] = ''
 
-        return this_row
+        ret = this_row[:self._playlist_version]
+        logger.error(f'{ret = }')
+        return this_row[:self._playlist_version]
 
     def _set_playlist_elements(self, a_playlist, a_title=''):
         self.station_path = path.abspath(a_playlist)
@@ -1390,9 +1384,10 @@ class PyRadioConfig(PyRadioStations):
     opts['confirm_station_deletion'] = ['Confirm station deletion: ', True]
     opts['confirm_playlist_reload'] = ['Confirm playlist reload: ', True]
     opts['auto_save_playlist'] = ['Auto save playlist: ', False]
-    opts['conn_title'] = ['Connection Options: ', '']
+    opts['conn_title'] = ['Connection Options', '']
     opts['connection_timeout'] = ['Connection timeout: ', '10']
     opts['force_http'] = ['Force http connections: ', False]
+    opts['buffering'] = ['Buffering (seconds): ', '20']
     opts['notification'] = ['Notifications', '']
     opts['enable_notifications'] = ['Enable notifications: ', '-1']
     opts['use_station_icon'] = ['    Use station icon: ', True]
@@ -1548,6 +1543,25 @@ def __init__(self, user_config_dir=None, headless=False):
 
         self._read_notification_command()
 
+    @property
+    def buffering(self):
+        return self.opts['buffering'][1]
+
+    @buffering.setter
+    def buffering(self, val):
+        str_val = str(val)
+        old_val = self.opts['buffering'][1]
+        try:
+            if str_val == '0' or \
+                    5 <= int(str_val) <= 60:
+                self.opts['buffering'][1] = str(int(str_val))
+            else:
+                self.opts['buffering'][1] = '0'
+        except ValueError:
+            self.opts['buffering'][1] = '0'
+        if old_val != self.opts['buffering'][1]:
+            self.dirty_config = True
+
     @property
     def log_titles(self):
         return self.opts['log_titles'][1]
@@ -2555,6 +2569,15 @@ def _read_config(self, distro_config=False):
                 except (ValueError, TypeError):
                         tmp = '0'
                 self.opts['time_format'][1] = tmp
+            elif sp[0] == 'buffering':
+                try:
+                    b = int(sp[1].strip())
+                except ValueError:
+                    b = 0
+                if not (b == 0 or 5 <= b <= 60):
+                    b = 0
+                self.opts['buffering'][1] = str(b)
+
             elif sp[0] == 'localized_keys':
                 # logger.error(f'{sp[1] = }')
                 self.localize = None if sp[1].strip().lower() == 'none' else sp[1].strip().lower()

pyradio/config_window.py

@@ -85,6 +85,7 @@ class PyRadioConfigWindow():
     '|', 'Valid values: 5 - 60, 0 disables check', 'Default value: 10'])
     _help_text.append(['Most radio stations use plain old http protocol to broadcast, but some of them use https.', '|', 'If this parameter is enabled, all connections will use http; results depend on the combination of station/player.', '|', 'This value is read at program startup, use "' + to_str('https') +  '" to change its effect while mid-session.',
     '|', 'Default value: False'])
+    _help_text.append(['This is the number of seconds the players will buffer data before actually staring playback.', '|', 'This is a global setting; it affects all stations.', '|', 'Please keep in mind that stations may have their own buffering value defined. In this case that value will be used instead of this global value.', '|', 'Accepted values:', '    5 - 60 seconds', '    0 disables buffering', '|', 'Default value: 0'])
     _help_text.append(None)
     _help_text.append(['If this options is enabled, a Desktop Notification will be displayed using the notification daemon / service.', '|', 'If enabled but no notification is displayed, please refer to', 'https://github.com/coderholic/pyradio/desktop-notification.md', '|', 'Valid values are:', '   -1: disabled ', '    0: enabled (no repetition) ', '    x: repeat every x seconds ', '|', 'Default value: -1'])
     _help_text.append(['Notice: Not applicable on Windows!', '|',  'Online Radio Directory Services (like RadioBrowser) will usually provide an icon for the stations they advertise.', '|', 'PyRadio can use this icon (provided that one exists and is of JPG or PNG format) while displaying Desktop Notifications.', '|', 'Setting this option to True, will enable the behavior above.', '|', 'If this option is False, the default icon will be used.', '|', 'Default value: True'])
@@ -753,7 +754,7 @@ def keypress(self, char):
         self._max_start =  len(self._config_options) -1 - self.maxY
         # logger.error('mas_start = {}'.format(self._max_start))
         val = list(self._config_options.items())[self.selection]
-        # logger.error(f'{val[0] = }')
+        # logger.error(f'{val = }')
         Y = self.selection - self._start + 1
 
         if char in self._local_functions:
@@ -763,6 +764,7 @@ def keypress(self, char):
                 'connection_timeout',
                 'calculated_color_factor',
                 'time_format',
+                'buffering',
             ) and char in (
                 curses.KEY_LEFT,
                 curses.KEY_RIGHT,
@@ -815,6 +817,37 @@ def keypress(self, char):
                         ]
             return Window_Stack_Constants.INSERT_RECORDINGS_DIR_MODE, []
 
+        elif val[0] == 'buffering':
+            if char in (curses.KEY_RIGHT, kbkey['l']) or \
+                    check_localized(char, (kbkey['l'], )):
+                t = int(val[1][1])
+                if t == 0:
+                    t = 4
+                if t < 60:
+                    t += 1
+                    self._config_options[val[0]][1] = str(t)
+                    self._win.addstr(
+                        Y, 3 + len(val[1][0]),
+                        str(t) + ' ', curses.color_pair(6))
+                    self._print_title()
+                    self._win.refresh()
+                return -1, []
+
+            elif char in (curses.KEY_LEFT, kbkey['h']) or \
+                    check_localized(char, (kbkey['h'], )):
+                t = int(val[1][1])
+                if t > 5:
+                    t -= 1
+                else:
+                    t = 0
+                self._config_options[val[0]][1] = str(t)
+                self._win.addstr(
+                    Y, 3 + len(val[1][0]),
+                    str(t) + ' ', curses.color_pair(6))
+                self._print_title()
+                self._win.refresh()
+                return -1, []
+
         elif val[0] == 'radiobrowser':
             if char in (curses.KEY_RIGHT, kbkey['l'], kbkey['pause'],
                         curses.KEY_ENTER, ord('\r'), ord('\n')) or \