v24.11.1 update

Author: drgerg

code/README.txt

@@ -1,10 +1,11 @@
-Minimal MPD Client - v2.1.0
+Minimal MPD Client - v24.11.1
 
-Check out the offline help under the Help menu. (updated for v2.1.0)
-
-v2.1.0 
-  - Provided a kinder solution when trying to run MMC4W against a server that is not running.
-  - Added Config menu option to delete the debug log file.
-  - Corrected bug preventing logo from being displayed when there is no album art.
+Check out the offline help under the Help menu. (updated for v24.11.1)
 
+v24.11.1
+  - Changed versioning scheme. I like the year (24.) month (11.) iteration (1) numbering.
+  - Incorporated a code change based on a recommendation from donburch888. Thanks Don!
+  - Added an option under the Queue menu to save the current queue to a .m3u file 
+    in the folder of your choice.  This helped me get my favorites on my phone.
+  - I also added the 'requirements.txt' file from my Windows 'venv' to the repo.
 

code/mmc4w.py

@@ -9,6 +9,7 @@
 import tkinter as tk
 from tkinter import messagebox
 from tkinter import simpledialog
+from tkinter import filedialog
 from tkinter.font import Font
 import datetime
 from time import sleep
@@ -32,18 +33,10 @@
     ctypes.windll.shcore.SetProcessDpiAwareness(0)
     ctypes.windll.user32.SetProcessDPIAware()
 
-version = "v2.1.0"
+version = "v24.11.1"
+# v24.11.1 - Save playlist to file. Also shift to different version number scheme.
 # v2.1.0 - Gently handle attempting to run with no server. Add 'delete debug log'.
 # v2.0.9 - Finally get scale factors working. Renamed menus. Browse help.html.
-# v2.0.8 - Use buttons in search windows for added flexibility.
-# v2.0.7 - Trade pathlib for os.path. Deal with 'already connected' error.
-# v2.0.6 - Fine tuning lookups and search windows. Completely revamp win size methods.
-# v2.0.5 - Way better Playlist Build Mode.
-# v2.0.4 - Doing things a better way.
-# v2.0.1 - Handling the queue.
-# v2.0.0 - Introduced classes for some windows. Tons more stability tweaks.
-# v1.0.0 - Fixed error in the fiver() function.
-# v0.9.9 - tk.Scrollbars on all windows. Windows are more uniform.
 
 
 client = musicpd.MPDClient()                    # create client object
@@ -414,7 +407,7 @@ def connext():  ## Checks connection, then connects if necessary.
                 else:
                     logger.debug("D1| Second level errvar: {}".format(err2var))
                     cxstat = 0
-                    endWithError('Second level connection error:\n' + str(err2var) + '\nQuitting now.')
+                    endWithError("The server you selected is not responding.\nEdit mmc4w.ini to ensure the 'lastsrvr' IP address is for a running server.")
     return cxstat
 
 
@@ -631,38 +624,6 @@ def volbtncolor(vol_int):  # Provide visual feedback on volume buttons.
             confparse.write(SLcnf)
         logger.info('Saved volume to mmc4w.ini. lastvol is {}.'.format(lastvol))
 #
-##  FIVER() ROUNDS VOLUME NUMBERS TO MULTIPLES OF 5.
-#
-def fiver(invar):  # invar should be a string of numbers: 0 - 100. Returns string.
-    fivevar = ''
-    firDig = ''
-    secDig = ''
-    if len(invar) == 1:
-        secDig = invar
-    elif len(invar) == 2:
-        firDig = invar[:1]
-        secDig = invar[1:2]
-    if invar == '100':
-        fivevar = invar
-    zerovals = ('0','1','2')
-    zeroplusvals = ('8','9')
-    fivevals = ('3','4','5','6','7')
-    if secDig in zerovals:
-        secDig = '0'
-    if secDig in zeroplusvals:
-        secDig = '0'
-        if firDig == '':
-            firDig = '0'
-        firDig = str(int(firDig) + 1)
-    if secDig in fivevals:
-        secDig = '5'
-    if fivevar != '100':
-        if firDig > "":
-            fivevar = firDig + secDig
-        else:
-            fivevar = secDig
-    return fivevar
-
 def toglrandom():
     connext()
     ranstat =  client.status()
@@ -762,6 +723,9 @@ def getcurrsong():
     buttonvar = newstate
     logger.debug('D2| Retrieving "cs" in getcurrsong().')
     cs = client.currentsong()
+    # if 'duration' not in cs:
+        # msg = "The server cannot provide the required song duration value. Exiting."
+        # endWithError(msg)
     logger.debug('D2| Got cs (client.currentsong()) with a length of {}.'.format(len(cs)))
     if cs == {}:
         client.stop()
@@ -783,8 +747,10 @@ def getcurrsong():
             artw.aartLabel.configure(image=aart)
         if 'volume' in stat:
             lastvol = stat['volume']
-            vol_fives = fiver(lastvol)
-            vol_int = int(vol_fives)
+            # next two lines courtesy of Donburch888. Replaces entire fiver() function.
+            vol_fives = int( (float(lastvol)+3) /5 )         # map 0-100 to range of 0-20
+            vol_int = int(vol_fives * 5)                    # and back to 0-100
+            # 
             volbtncolor(vol_int)
             logger.info('3) Volume is {}, Random is {}, Repeat is {}.'.format(lastvol,stat['random'],stat['repeat']))
         gpstate = stat['state']
@@ -1158,16 +1124,16 @@ def exit():
 globsongtitle = ""
 aatgl = '0'
 
-def makeeverything():
+def makeeverything(): 
     connext()
-    client.clear()
+    client.clear() # clears the queue
     pllist = client.listplaylists()
     if 'Everything' in str(pllist):
         client.rm('Everything')
-    client.add('/')
-    client.save('Everything')
+    client.add('/') # adds all songs in library to the queue.
+    client.save('Everything') # Saves a new 'Everything.m3u' file to disk.
     logger.info('The playlist named "Everything" was just updated.')
-    PLSelWindow()
+    PLSelWindow() # opens the playlist selection dialog.
 #
 ## A CLASS TO CREATE ERROR MESSAGEBOXES (USED VERBATIM FROM STACKOVERFLOW)
 ## https://stackoverflow.com/questions/6666882/tkinter-python-catching-exceptions
@@ -1738,6 +1704,19 @@ def createnewpl():
         PLSelWindow()
         logger.info("NPL) A new saved Playlist named '{}' was created.".format(newpl))
 #
+def writeqtofile():
+    file_path = filedialog.askdirectory(parent=window,initialdir="~",title='Please select a directory')
+    print(file_path)
+    if file_path != ():
+        songlist=[]
+        songlistq = client.playlistinfo()
+        for s in songlistq:
+            songlist.append(s['file'])
+        with open(Path(file_path,"mmc4w_playlist.m3u"), 'w') as plout:
+            plout.write('\n'.join(songlist))
+    window.update()
+    artw.update()
+#
 def browserplayer():
     global buttonvar
     outputsraw = getoutputs()[0]
@@ -1803,6 +1782,7 @@ def browserplayer():
 queueMenu.add_command(label='Find and Play in Queue',command=lambda: queuewin('title'))
 queueMenu.add_command(label="Toggle PL Build Mode", command=buildpl)
 queueMenu.add_command(label="Launch Browser Player", command=browserplayer)
+queueMenu.add_command(label='Write Queue to .m3u File', command=writeqtofile)
 menu.add_cascade(label="Queue", menu=queueMenu)
 
 helpMenu = tk.Menu(menu, tearoff=False)

code/mmc4w_help.md

@@ -1,11 +1,8 @@
-<!doctype html>
-<html markdown="1">
-<body markdown="1">
 # MMC4W - Minimal MPD Client for Windows
 
-This help file was updated for the v2.1.0 release.  As of v2.0.8 the same Python code runs in Linux without needing any tweaks.
+This help file was updated for the v24.11.1 release.  As of v2.0.8 the same Python code runs in Linux without needing any tweaks.
 
-I recommend reading the **First Run Process** section below before installing.
+I recommend reading the **First Run Process** section below before installing.  Of course, that assumes you're reading this on Github before you downloaded and installed MMC4W.
 
 # Putting the Music First
 
@@ -64,6 +61,7 @@ The interface contains the basic required buttons to control a MPD server:
 - **Find and Play** : Opens a window displaying the songs in the queue. See below for more detail.
 - **Toggle PL Build Mode** : Sets PL Build Mode. Easily add or delete songs from saved playlists.
 - **Launch Browser Player** : If a streaming HTTP output is enabled on the server, opens your browser there.
+- **Write Queue to .m3u File** : Write current queue to a local .m3u file. Artist/Album/Track is the basic format.
 
 
 ### The 'Help' menu contains:
@@ -228,6 +226,8 @@ You load playlists into the queue and then MPD plays that queue using the settin
 
 **MMC4W** will create a special playlist called "Everything" that contains all the songs in your library.  That option is found in the **'Lists'** Menu.
 
+If you want to get a playlist out of the MPD server and onto your local computer, look in the Queue menu for the option to save the queue to a .m3u file.  The saved file will have an Artist/Album/Track format. Note that this has only been tested with a curated library of songs with complete metadata. If the library on the server is missing some metadata, it's a good bet it will have a unwanted effect.
+
 ### You can manipulate playlists in these ways:
 
  - Load a playlist into the queue.  **Lists Menu** - Select a Playlist.
@@ -236,6 +236,7 @@ You load playlists into the queue and then MPD plays that queue using the settin
  - Create a new empty playlist. **Lists Menu** - Create New Saved Playlist.
  - Delete a playlist. **Lists Menu** - Remove Saved Playlist.
  - Add or remove the currently playing song to any saved playlist. **Queue Menu** - Toggle PL Build Mode.
+ - **NEW** Save the current queue to a local .m3u playlist file.
 
 ## Adding and Removing Songs in a Saved Playlist:
 
@@ -256,7 +257,7 @@ You can move and resize that window to suit your tastes.  When you exit PLBuild
 
 **NOTE:** If you press **Quit** while in PLBuild Mode, **MMC4W** first turns PLBuild Mode off, then exits.
 
-**That's it.**
+**It's just that easy.**
 
 #### Deleting a song from the current saved playlist is just as easy:
 
@@ -400,7 +401,7 @@ With the exception of the serverlist, all of these entries are filled in by the
 
 ### Minutia
 
-MMC4W was developed and tested in Windows 10.  As of v2.0.6, the same Python code will run on Linux. So far it's only tested on Ubuntu.  **MPD** is running on three different Debian-type computers here, one i7 Ubuntu, one i3 Ubuntu and one Raspberry Pi.  My music library is made up exclusively of FLAC files.  I rip my CD's (remember those?) using [Music Bee](https://getmusicbee.com/).  I create a 'folder.jpg' file (I'll probably switch to 'cover.png') for each album and embed the art in the songs using **[MP3TAG](https://www.mp3tag.de/en/)** or **Music Bee** depending on the circumstances.
+MMC4W was developed and tested in Windows 10 and 11.  As of v2.0.6, the same Python code will run on Linux. So far it's only tested on Ubuntu.  **MPD** is running on three different Debian-type computers here, one i7 Ubuntu, one i3 Ubuntu and one Raspberry Pi.  My music library is made up exclusively of FLAC files.  I rip my CD's (remember those?) using [Music Bee](https://getmusicbee.com/).  I create a 'folder.jpg' file (I'll probably switch to 'cover.png') for each album and embed the art in the songs using **[MP3TAG](https://www.mp3tag.de/en/)** or **Music Bee** depending on the circumstances.
 
 I hope you enjoy using this as much as I do.<br><br>
 
@@ -409,5 +410,4 @@ I hope you enjoy using this as much as I do.<br><br>
 **Thanks** to [kaliko](https://gitlab.com/kaliko) for the [python-musicpd](https://gitlab.com/kaliko/python-musicpd) library!  
 And of course none of this would be possible without the excellent contribution of [MPD](https://github.com/MusicPlayerDaemon) by Max Kellermann.  **Thanks!!**  
 &copy;2023-2024 - Gregory A. Sanders (dr.gerg@drgerg.com)
-</body>
-</html>
+