Add support for shuffled artist and genre playback

Author: ron.record

.gitignore

@@ -1,6 +1,7 @@
 dist/*
 releases/*
 test/__pycache__/*
+test/*.py
 tmp/*
 # vim files
 .*.sw[a-z]

api/play_artist.py

@@ -16,6 +16,13 @@
 
 parser = argparse.ArgumentParser()
 parser.add_argument("-a", "--artist", help="artist selection")
+parser.add_argument(
+    "-s",
+    "--shuffled",
+    default=False,
+    action="store_true",
+    help="play artist in shuffled order",
+)
 parser.add_argument("-x", "--exartist", help="artist exclude search term")
 parser.add_argument("-z", "--zone", help="zone selection")
 args = parser.parse_args()
@@ -28,6 +35,10 @@
     exartistsearch = args.exartist
 else:
     exartistsearch = None
+if args.shuffled:
+    shuffled = True
+else:
+    shuffled = False
 if args.zone:
     target_zone = args.zone
 else:
@@ -82,8 +93,10 @@
         # Play artist from Library
         artist = artists[0]
         print("Playing artist name", artist)
-        roonapi.play_media(output_id,
-                           ["Library", "Artists", artist], None, False)
+        if shuffled:
+            roonapi.play_media(output_id, ["Library", "Artists", artist], "Shuffle", False)
+        else:
+            roonapi.play_media(output_id, ["Library", "Artists", artist], None, False)
         if len(artists) > 1:
             print("\nArtist names partially matching", artistsearch, ":\n")
             print(*artists, sep="\n")

api/play_genre.py

@@ -16,6 +16,13 @@
 
 parser = argparse.ArgumentParser()
 parser.add_argument("-g", "--genre", help="genre selection")
+parser.add_argument(
+    "-s",
+    "--shuffled",
+    default=False,
+    action="store_true",
+    help="play genre in shuffled order",
+)
 parser.add_argument("-x", "--exgenre", help="genre exclude search term")
 parser.add_argument("-z", "--zone", help="zone selection")
 args = parser.parse_args()
@@ -28,6 +35,10 @@
     exgenresearch = args.exgenre
 else:
     exgenresearch = None
+if args.shuffled:
+    shuffled = True
+else:
+    shuffled = False
 if args.zone:
     target_zone = args.zone
 else:
@@ -80,7 +91,10 @@
         # Play genre from Library
         genre = genres[0]
         print("Playing genre title", genre)
-        roonapi.play_media(output_id, ["Genres", genre], None, False)
+        if shuffled:
+            roonapi.play_media(output_id, ["Genres", genre], "Shuffle", False)
+        else:
+            roonapi.play_media(output_id, ["Genres", genre], None, False)
         if len(genres) > 1:
             print("\nGenre titles partially matching", genresearch, ":\n")
             print(*genres, sep="\n")

bin/play_artist

@@ -16,13 +16,17 @@ cd ${ROONAPI} || exit 1
 
 [ -f $PLAY ] || exit 2
 
+SHUFFLED=
 ZONE=
-# Parse the arguments to get the zone
-while getopts "z:" flag; do
+# Parse the arguments to get the play order and zone
+while getopts "sz:" flag; do
     case $flag in
         z)
             ZONE="$OPTARG"
             ;;
+        s)
+            SHUFFLED="-s"
+            ;;
     esac
 done
 shift $(( OPTIND - 1 ))
@@ -56,8 +60,8 @@ fi
     ARTIST="$(echo -e "${ARTIST}" | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')"
 }
 # Construct the exclusion args if passed
-EXARGS=
-[ "${EXARTIST}" ] && EXARGS="-x ${EXARTIST}"
+EXARGS="${SHUFFLED}"
+[ "${EXARTIST}" ] && EXARGS="-x ${EXARTIST} ${EXARGS}"
 
 have_python3=$(type -p python3)
 if [ "${have_python3}" ]

bin/play_genre

@@ -16,13 +16,17 @@ cd ${ROONAPI} || exit 1
 
 [ -f $PLAY ] || exit 2
 
+SHUFFLED=
 ZONE=
-# Parse the arguments to get the zone
-while getopts "z:" flag; do
+# Parse the arguments to get the play order and zone
+while getopts "sz:" flag; do
     case $flag in
         z)
             ZONE="$OPTARG"
             ;;
+        s)
+            SHUFFLED="-s"
+            ;;
     esac
 done
 shift $(( OPTIND - 1 ))
@@ -57,8 +61,8 @@ fi
 }
 
 # Construct the exclusion args if passed
-EXARGS=
-[ "${EXGENRE}" ] && EXARGS="-x ${EXGENRE}"
+EXARGS="${SHUFFLED}"
+[ "${EXGENRE}" ] && EXARGS="-x ${EXGENRE} ${EXARGS}"
 
 have_python3=$(type -p python3)
 if [ "${have_python3}" ]

bin/roon

@@ -1617,7 +1617,7 @@ done
   esac
 }
 
-# Shuffle action only supported in Playlist playback for now
+# Shuffle action only supported in Artist, Genre, and Playlist playback for now
 shuffled=
 [ "${comm}" == "shuffle" ] && shuffled="-s"
 
@@ -1735,15 +1735,15 @@ shuffled=
   [ "${artist}" == "default" ] && artist=
   if [ "${LOCAL}" = true ]; then
     if [ "$zone" ]; then
-      play_artist -z "$zone" "$artist" "$exartist"
+      play_artist $shuffled -z "$zone" "$artist" "$exartist"
     else
-      play_artist "$artist" "$exartist"
+      play_artist $shuffled "$artist" "$exartist"
     fi
   else
     if [ "$zone" ]; then
-      ssh $user@$server "bash -l -c \"${ROON}/bin/play_artist -z $zone $artist $exartist\""
+      ssh $user@$server "bash -l -c \"${ROON}/bin/play_artist $shuffled -z $zone $artist $exartist\""
     else
-      ssh $user@$server "bash -l -c \"${ROON}/bin/play_artist $artist $exartist\""
+      ssh $user@$server "bash -l -c \"${ROON}/bin/play_artist $shuffled $artist $exartist\""
     fi
   fi
 }
@@ -1767,15 +1767,15 @@ shuffled=
   [ "${genre}" == "default" ] && genre=
   if [ "${LOCAL}" = true ]; then
     if [ "$zone" ]; then
-      play_genre -z "$zone" "$genre" "$exalbum"
+      play_genre $shuffled -z "$zone" "$genre" "$exalbum"
     else
-      play_genre "$genre" "$exalbum"
+      play_genre $shuffled "$genre" "$exalbum"
     fi
   else
     if [ "$zone" ]; then
-      ssh $user@$server "bash -l -c \"${ROON}/bin/play_genre -z $zone $genre $exalbum\""
+      ssh $user@$server "bash -l -c \"${ROON}/bin/play_genre $shuffled -z $zone $genre $exalbum\""
     else
-      ssh $user@$server "bash -l -c \"${ROON}/bin/play_genre $genre $exalbum\""
+      ssh $user@$server "bash -l -c \"${ROON}/bin/play_genre $shuffled $genre $exalbum\""
     fi
   fi
 }