/usr/share/perl5/Audio/RPLD.pm is in libaudio-rpld-perl 0.006-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 | # Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2009-2012
#
# This file is part of Audio::RPLD,
# a library to access the RoarAudio PlayList Daemon from Perl.
# See README for details.
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3
# as published by the Free Software Foundation.
#
# Audio::RPLD is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this software; see the file COPYING.gplv3.
# If not, write to the Free Software Foundation, 51 Franklin Street,
# Fifth Floor, Boston, MA 02110-1301, USA.
#
package Audio::RPLD;
use strict;
use vars qw($VERSION @ISA);
$VERSION = 0.006;
@ISA = qw();
#use IO::Socket::UNIX;
=pod
=head1 NAME
Audio::RPLD - Module to communicate with RoarAudio PlayList Daemon
=head1 SYNOPSIS
use Audio::RPLD;
# Open new connection
my $rpld = Audio::RPLD->new([$addr[, $type[, $port]]]);
# Work with the connection
$rpld->play();
$rpld->stop();
#...
# close the connection
$rpld->disconnect();
# reconnect:
$rpld->connect($addr[, $type[, $port]]);
=head1 DESCRIPTION
This module is used to communicate with a RoarAudio PlayList Daemon (rpld).
It includes support for nearly all of the protocol.
=cut
=pod
=head1 METHODS
=head2 Common Arguments
Here is a list of all the arguments used in this documentation so I do not need to explain later for each method again.
=over
=item $addr
The Address of the server. This can be a filename or host or nodename.
If the type is known to you, you should set the $type argument.
Do not limit the user to hostname or filenames or something. The user should be abled to enter any server location in a freeform text input.
=item $type
This is the type of the address of the server. Currently defined types are:
=over 8
=item UNIX
Use a UNIX socket to connect to the server.
=item DECnet
Use a DECnet socket to connect to the server (currently not supported because there is no IO::Socket::DECnet yet).
=item INET
Use a INET (IPv4) socket to connect to the server.
=item #SOCKET
Use a already connected socket as connection to the server. This can for example be a object opened
with a SSL/TLS or proxy module or any other bidirectional IO object. Object is passed
as $addr parameter.
=item a value of undef
Use Autodetection.
=back
=item $port
If using a INET socket this is the port number to connect to.
Use undef (not include in arguments list) to use defaults.
=item $playlist, $playlist_from, $playlist_to, $history
A Playlist to use. This can be a integer to use the playlist ID (which is preferred), a string to use the playlist name or $any (return value of $rpld->any()) to search thru all playlists and use the first hint. $any is not supported by all commands as it does not make sense for all commands.
=item $vol
A volume. If this is an integer the volume is in range 0 to 65535 (recommended). If it's a string and suffixed by a '%' it is in range 0 to 100. A value of zero always means total silence.
=item $size
A history size. This is an integer or undef. If undef the server's default is used.
=item $backend
The address of a RoarAudio server as used as backend for a queue. If undef the default server will be used.
=item $mixer
The mixer ID of the mixer core which should be used by a queue. If undef the server's default mixer core will be used.
This should normally be undef.
=item $role
The stream role as used by a queue. This is the name or undef to use rpld's or RoarAudio server's default.
This is the name of the role not the ID. Common values include "music" and "background_music".
=item $likeness
A floating point describing how much the user likes a song.
=item $name
A string of a name of some object.
=item $ple
A Playlist entry (item) identifier. This is a string of one of the several types. Here is a quick overview:
=over 8
=item Long Global Track Number
The long GTN is a hex string (with leading 0x) prefixed by 'long:' with a length of 64 bit (16 raw digits).
It is used to identify a playlist entry within the runtime of the server process. This one is the one you normally use for all operations like queuing a track for playback.
=item Short Global Track Number
The short GTN is a shorter (only 32 bit) version of the GTN prefixed with 'short:'. It's use is exactly the same as for the long GTN. It exists to get the GTN passed thru things which do not support more than 32 bit. As this is normally not the case for Perl (you pass them around as strings anyway) you should not need to use it at all. It's not recommended to use this one.
=item UUID
The UUID is a string prefixed with 'uuid:' followed by the normal hex-dash notation (example: uuid:54ab0c5f-b058-4c9b-ab3b-dea11b608482). It is used to identify a song. In contrast to the GTN this is not changed by commands such like copy or move operations. The normal use for this is if you want to store something over multiple runtimes of the server process like favorites or something.
If a song does not include a UUID in it's meta data the server will generate a random one so each song has one.
Those UUIDs can also be used together with the Tantalos protocol.
=item Pointer
A pointer is a string (the pointer name) prefixed by 'pointer:' (example: pointer:default). Those are used to have symbolic pointers a playlist entry. The following pointers are currently known by rpld:
=over 8
=item default
If the Main Queue runs out of songs and the current pointer reached the end of the current playlist the current pointer is set to this value and song lookup is done again. For details about the current pointer see below.
=item current
If the Main Queue run out of queued songs the song this pointer points to is automatically queued and this pointer is set to the next entry the the playlist. This is used for 'start here and just play the playlist' behavior. If this pointer reaches the end of the playlist it becomes undefined and if the default pointer is set redefined with it's value. See above for more information about the default pointer.
=item startup
If the startup pointer is set the song it points to is added once at startup of the daemon. This can for example be used to implement boot sounds.
=item temp
The temp pointer is a pointer for user defined jobs. It is the only pointer which is not global (shared with all clients) but a client local pointer. The application can use it for whatever it wants to use it for.
=back
As of rpld 0.1rc7 multi queue support was added. To support this pointers can have a queue and client ID suffix. The suffix has the syntax: pointer[queue:client]. Both queue and client can be omitted. If the client ID is omitted the colon (':') can be omitted, too. If both are omitted the brackets ('[]') can also be omitted. Queue defaults to the current client's default queue and client defaults to the current client.
=item Numerical Index
This is a numerical index of the entry. It's format is num:N where N is the index starting with zero. For example num:0 is the first entry in playlist, num:15 is the 16th entry.
=item Likeness Index
This is like the normal numerical index just uses the likeness values of the entries. This is hardly of use to the user and mainly for internal use. Syntax is likeness:F with F the floating point index.
=item Random Entry
A Random entry can be selected by using random:[PLI]. PLI is a optional parameter. It must be the ID of the playlist to select entry from. If no playlist is given the current one is used.
=item Random liked Entry
This is like normal random entry but prioritized by the value set with LIKE and DISLIKE commands. Syntax is: randomlike:[PLI].
=back
=item $pointer
A Pointer. This is a string of the pointer name. It is not prefixed with 'pointer:' as when used as PLE.
=back
=head2 Common return values
The following return types are used by methods in this module:
=over
=item $rpld
The instance of this module as returned by new().
=item $res
A general return value. This is undef in case of failure or a defined value in case of no error.
The value may be a string, hash- or arrayref depending on the method. See description of the method for details.
=item $any
The return value of any(). This can be used as wildcard for playlist names in some cases.
=back
=cut
#-------------
# Elementary communication functions
=pod
=head2 Basic functions
=cut
sub new {
# 0: Socket, 1: State
my $r = [undef, 0];
# States: 0 command mode, 1 data recv mode, 2 data transmit mode
bless($r);
if ( defined($_[1]) ) {
return undef unless $r->connect(@_[1..$#_]);
}
return $r;
}
=pod
=head3 $rpld = Audio::RPLD-E<gt>new([$addr[, $type[, $port]]])
This method creates a new Audio::RPLD object. If arguments are passed they are directly passed to a call to the connect method (see below) in order to connect to the server. If this fails undef is returned. If no arguments are given you need to connect the object to the server via the connect method later on your own.
=cut
sub connect {
my ($e, $addr, $type, $port) = @_;
my $sock;
if ( (!defined($addr) || $addr eq '') && (!defined($type) || $type eq '') && (!defined($port) || $port eq '') ) {
return $e->connect_default();
}
unless ( $type ) {
if ( ref($addr) ne '' ) {
$type = '#SOCKET';
} elsif ( $addr =~ m#/# ) {
$type = 'UNIX';
} elsif ( $addr =~ m#::# ) {
$type = 'DECnet';
} else {
$type = 'INET';
}
}
$type = uc($type);
if ( $type eq '#SOCKET' ) {
$sock = $addr;
} elsif ( $type eq 'UNIX' ) {
require IO::Socket::UNIX;
import IO::Socket::UNIX;
$sock = IO::Socket::UNIX->new($addr);
} elsif ( $type eq 'INET' ) {
require IO::Socket::INET;
import IO::Socket::INET;
$sock = IO::Socket::INET->new('PeerAddr' => $addr, 'PeerPort' => ($port || 'rpld(24148)'));
} else {
return undef;
}
return undef unless $sock;
$e->[0] = $sock;
# do a minimal identify.
$e->identify();
return $e;
}
=pod
=head3 $res = $rpld-E<gt>connect($addr[, $type[, $port]])
Connect to a server. You must not call this on a already connected object.
=cut
sub connect_default {
my ($e) = @_;
my $home = $ENV{'HOME'} || $ENV{'HOMEDRIVE'}.$ENV{'HOMEPATH'} || '/NXHOMEDIR';
my @locations = ($home.'/.rpld', qw(/tmp/.rpld /tmp/rpld /var/run/rpld.sock .rpld localhost ::rpld));
my $server;
if ( defined($e->[0]) ) {
return undef;
}
$server = $ENV{'RPLD_SERVER'};
if ( defined($server) && length($server) ) {
return $e->connect($server);
}
while (!defined($e->[0]) && scalar(@locations)) {
$e->connect(shift(@locations));
}
return defined($e->[0]) ? $e : undef;
}
=pod
=head3 $res = $rpld-E<gt>connect_default()
Connect to a server by trying default locations. You must not call this on a already connected object.
=cut
sub disconnect {
my ($e) = @_;
close($e->[0]);
$e->[0] = undef;
}
=pod
=head3 $res = $rpld-E<gt>disconnect()
Disconnect from the server. You may use $rpld->connect() again to connect to a (new/different) server.
=cut
sub is_connected {
my ($e) = @_;
return defined($e->[0]) ? $e : undef;
}
=pod
=head3 $res = $rpld-E<gt>is_connected()
Returns true value if the object is currently connected to a server or undef if not.
=cut
sub identify {
my ($e, %opts) = @_;
my @q = ('IDENTIFY');
my %paratypes = (
'name' => 'string',
'nodename' => 'string',
'pid' => 'int',
'hostid' => 'int',
);
my $type;
my $val;
my $r;
local $_;
if (!defined($opts{'name'})) {
$opts{'name'} = $0;
$opts{'name'} =~ s#^.*/([^/]+)$#$1#;
}
$opts{'pid'} ||= $$;
foreach (keys %opts) {
return undef if ! exists $paratypes{lc($_)};
$type = $paratypes{lc($_)};
if ( $type eq 'string' ) {
$val = $e->q_str($opts{$_});
} elsif ( $type eq 'int' ) {
$val = int($opts{$_});
} else { # this can never happen.
die 'Memory or CPU error';
}
push(@q, 'WITH', uc($_), $val);
}
$r = $e->cmd(@q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>identify([%options])
This identifies the process at the server. An optional list of options is taken.
Each key-value pair is send to the server as it is.
Currently supported keys are: name, pid, nodename and hostid.
This command is send automatically at connect. You only need to call this manually if
want to set one of those options. It is recommended to do this at least for the
application name.
=cut
sub read {
my ($e) = @_;
my $r;
return undef unless $e->[1] == 1;
$r = readline($e->[0]);
die 'EOF from server' unless defined $r;
$r =~ s/\r?\n$//;
if ( $r eq '.' ) {
$e->[1] = 0;
return undef;
}
$r =~ s/^\.(\.+)$/$1/;
return $r;
}
sub write {
my ($e, $d) = @_;
return undef unless $e->[1] == 2;
if ( $d !~ /\n/ ) {
$d .= '\n';
}
$d =~ s/^(\.+)$/.$1/;
return (print {$e->[0]} $d);
}
sub send_eof {
my ($e) = @_;
return undef unless $e->[1] == 2;
return (print {$e->[0]} ".\r\n");
}
sub request {
my ($e, $req) = @_;
return undef unless $e->[1] == 0;
return (print {$e->[0]} $req, "\r\n");
}
sub response {
my ($e) = @_;
my $r;
my $ar;
return undef unless $e->[1] == 0;
$r = readline($e->[0]);
die 'EOF from server' unless defined $r;
$r =~ s/\r?\n//;
$r =~ /^>\s+(\d+)\s+(.+)$/ or return undef;
$ar = [int($1), $2];
if ( wantarray() ) {
return @{$ar};
} else {
return $ar->[0];
}
}
sub cmd {
my ($e, $cmd, @args) = @_;
return undef unless $e->[1] == 0;
if ( scalar(@args) == 1 && !defined($args[0]) ) {
@args = ();
}
if ( scalar(@args) ) {
$cmd .= ' ';
$cmd .= join(' ', @args);
}
$e->request($cmd);
$e->[1] = 1;
$e->read($e) while $e->[1];
return $e->response();
}
sub cmd_data {
my ($e, $cmd, @args) = @_;
my $t;
my @r = (undef);
my $ret;
return undef unless $e->[1] == 0;
if ( scalar(@args) == 1 && !defined($args[0]) ) {
@args = ();
}
if ( scalar(@args) ) {
$cmd .= ' ';
$cmd .= join(' ', @args);
}
$e->request($cmd);
$e->[1] = 1;
while ($e->[1]) {
$ret = $e->read($e);
push(@r, $ret) if defined $ret;
}
$r[0] = $e->response();
return \@r;
}
#-------------
# Return values
sub is_ok {
return 0 unless defined($_[1]);
return 1 if $_[1] == 0;
return 0;
}
sub is_error {
return 1 unless defined($_[1]);
return 1 if $_[1] == 1;
return 0;
}
sub is_yes {
return 3 unless defined($_[1]);
return 1 if $_[1] == 3;
return 0;
}
sub is_no {
return 4 unless defined($_[1]);
return 1 if $_[1] == 4;
return 0;
}
#-------------
# consts
=pod
=head2 Special values
=cut
sub any {
return \'ANY';
}
=pod
=head3 $any = $rpld-E<gt>any()
This function returns a value that can be used as playlist wildcard.
=cut
#-------------
# quotes
sub q_str {
my ($e, $s) = @_;
my %q = ('\\' => '\\\\', '"' => '\"');
my $g = join('|', map{quotemeta}(keys(%q)));
$s =~ s/($g)/$q{$1}/g;
return '"'.$s.'"';
}
sub q_pli {
my ($e, $pl) = @_;
return undef unless defined $pl;
if ( $pl =~ /^\d+$/ ) {
return int($pl);
} elsif ( ref($pl) eq 'SCALAR' ) {
return ${$pl};
}
return $e->q_str($pl);
}
sub q_ple {
my ($e, $ple) = @_;
return $ple;
}
sub q_iot {
my ($e, $io) = @_;
return $io;
}
sub q_plt {
my ($e, $plt) = @_;
return uc($plt);
}
#-------------
# parsers:
sub p_ple {
my ($e, $ple) = @_;
my $r = {};
my @p = split(/=/, $ple);
my @t;
local $_;
#0 1 2 3 4 5 6 7 8 9 10
#unknown=00:00:00=ALBUM=TITLE=ARTIST=PERFORMER=VERSION=FILE=long:0xBED9000000000373/short:0xBE0003AA/uuid:0c26ea9c-5f37-48e3-b338-8895b1a84dfe=0xDISCID/TN=GENRE(GID)=LIKENESS
# $r->{'raw'} = {'data' => $ple, 'splited' => \@p};
foreach (@p) {
if ( $_ eq '*' ) {
$_ = undef;
next;
}
if ( $_ eq '' ) {
$_ = undef;
}
}
if ( $p[0] eq 'unknown' ) {
$r->{'codec'} = undef;
} else {
$r->{'codec'} = $p[0];
}
@t = split(/:/, $p[1]);
$r->{'length'} = $t[-1] + $t[-2] * 60 + $t[-3] * 3600;
$r->{'length'} = undef unless $r->{'length'};
$r->{'file'} = $p[7];
$r->{'meta'} = {'album' => $p[2], 'title' => $p[3], 'artist' => $p[4], 'performer' => $p[5], 'version' => $p[6]};
if ( $p[8] =~ m#^(long:0x[0-9a-fA-F]{16})/(short:0x[0-9a-fA-F]{8})(?:/(uuid:[0-9a-fA-F-]{36}))?$# ) {
$r->{'longid'} = $1;
$r->{'shortid'} = $2;
$r->{'uuid'} = $3 if $3;
}
if ( $p[9] =~ m#^(0x[0-9a-fA-F]{8})/(\d+)$# ) {
$r->{'meta'}->{'discid'} = hex($1) if $1;
$r->{'meta'}->{'tracknumber'} = int($2) if $2;
$r->{'meta'}->{'discid'} = undef unless $r->{'meta'}->{'discid'};
if ( $r->{'meta'}->{'discid'} ) {
$r->{'meta'}->{'totaltracks'} = $r->{'meta'}->{'discid'} & 0xFF;
}
}
if ( $p[10] =~ m#^(.+)\((0x[0-9a-fA-F]+)\)$# ) {
if ( $2 !~ /^0xf+$/i ) {
$r->{'meta'}->{'genre'} = $1 if $1;
$r->{'meta'}->{'genreid'} = hex($2) if $2;
}
}
if ( defined($p[11]) ) {
$r->{'likeness'} = $p[11]+0;
}
return $r;
}
sub p_playlist {
my ($e, $playlist) = @_;
my $c;
my ($k, $v);
local $_;
$c = {'id' => int($1), 'parent' => int($2), 'name' => $3, 'children' => []};
$playlist =~ /^\s*(\d+):\s*\[([^\]]+)\]\s*"(.+?)"$/ or return undef;
$c = {'id' => int($1), 'name' => $3, 'children' => []};
foreach (split(/, /, $2)) {
($k, $v) = /^([^:]+):\s(.+)$/;
$k =~ tr/ /_/;
if ( $k eq 'backend' ) {
$v =~ s/^"(.+)"$/$1/;
} elsif ( $k eq 'volume' ) {
$v =~ s/^(\d+)\/65535$/$1/;
$v = int($v);
} elsif ( $k eq 'history' ) {
$v = int($v);
} elsif ( $k eq 'history_size' ) {
$v = int($v);
} elsif ( $k eq 'mixer' ) {
$v = int($v);
$v = undef if $v == -1;
}
$c->{lc($k)} = $v;
}
return $c;
}
# This is very similar to p_playlist(). Maybe they should be merged.
sub p_client {
my ($e, $client) = @_;
my $c;
my ($k, $v);
local $_;
$client =~ /^\s*(\d+):\s*\[([^\]]+)\]\s*"(.+?)"$/ or return undef;
$c = {'id' => int($1), 'name' => $3};
foreach (split(/, /, $2)) {
($k, $v) = /^([^:]+):\s(.+)$/;
$k =~ tr/ /_/;
$k = lc($k);
if ( $k eq 'protocol' || $k eq 'nodename' ) {
$v =~ s/^"(.+)"$/$1/;
} elsif ( $k eq 'pid' || $k eq 'hostid' ) {
$v = int($v);
}
$c->{$k} = $v;
}
return $c;
}
#-------------
# define hi-level functions
# -- Basic:
=pod
=head2 Basic communication functions
=cut
sub noop {
return $_[0]->cmd('NOOP');
}
=pod
=head3 $res = $rpld-E<gt>noop()
Send a NOOP command to the server.
This can be used to ping the server or for keep-alive.
=cut
# -- server info:
=pod
=head2 Server information functions
=cut
sub serverinfo {
my ($e) = @_;
my $res = {'x' => {}};
my $q = $e->cmd_data('SERVERINFO');
local $_;
my $cur;
return undef unless $e->is_ok($q->[0]);
foreach (@{$q}[1..$#{$q}]) {
$cur = $res;
$cur = $cur->{'x'} if s/^X-//i;
if ( /^([A-Z]+)\s+"(.+)"$/ ) {
$cur->{lc $1} = $2;
} elsif ( /^([A-Z]+)\s+([A-Z]+)\s+"(.+)"$/ ) {
$cur->{lc $1} ||= {};
$cur->{lc $1}->{lc $2} = $3;
} elsif ( /^([A-Z]+)\s+([0-9]+)$/ ) {
$cur->{lc $1} = int($2);
} elsif ( /^([A-Z]+)\s+(0x[0-9a-fA-F]+)$/ ) {
$cur->{lc $1} = hex($2);
}
}
return $res;
}
=pod
=head3 $res = $rpld-E<gt>serverinfo()
Send a SERVERINFO command to the server.
This tells basic information about the server like it's version and location.
The return value is a hashref which contains the following keys (all keys may or may not be set depending on what info the server provides):
=over
=item version
This is the product name, version and vendor information for the server.
=item location
This is the location of the server in a lion readable way e.g. "kitchen".
=item description
This is a description for the server e.g. "Central Media Server"
=item contact
Those are information on the server administrator. Normally contains nick or real name
as well as an e-mail address.
=item serial
This is a string with the serial number of the device.
=item address
This contains address data of the device.
=item uiurl
This is an URL to a user interface used to control the server.
This can be a web interface such as Romie or some other kind of interface.
All protocols are allowed. This includes telnet:// and ssh://.
=item hostid
This is the UNIX HostID of the server.
=item license
This is the license of the server software or device.
=item build
This is a build stamp. It contains information on the build.
This is mostly useful when reporting problems to upstream or the distributor.
=item system
This contains a sub-hash with information about the server's OS.
Those information are normally read via the uname() system call
by the server software. This means all limits of uname() also apply
to those data.
The following keys are know as of this writing:
=over
=item sysname
The operating system's name e.g. "NetBSD".
=item release
The operating system's release.
=item nodename
The node name of as known by the operating system.
=item machine
The host architecture as known by the operating system.
=back
=item x
This is a sub-hash with vendor specific information.
The name is based on the "X-"-prefix those keys have.
The content and format is fully up to the server software.
However the following keys have been seen in the wild:
=over
=item application
This key is used by the RoarAudio PlayList Daemon (rpld) and contains it's name.
=back
=back
=cut
# -- Store/Restore
=pod
=head2 Storing and restoring
=cut
sub store {
my $r = $_[0]->cmd('STORE');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>store()
Ask the server to store (dump) all data on permanent storage (disk). This is normally used at exit to save all the playlists on disk so they can be restored at next startup.
=cut
sub restore {
my $r = $_[0]->cmd('RESTORE');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>restore()
Restore from disk. This is normally done at startup time (by rpld itself).
You should not call this again if the server already restored it's state because this may result in undefined behavior.
Current behavior of rpld is that it forgets the complete current state and loads the new state.
This was changed in version 0.1rc7. Before version 0.1rc7 it added everything to the current state resulting in duplicates.
This may change in future.
=cut
# -- Queue:
=pod
=head2 Playback control
=cut
sub play {
my $r = $_[0]->cmd('PLAY');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>play()
Start playback.
=cut
sub stop {
my $r = $_[0]->cmd('STOP');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>stop()
Stop playback.
=cut
sub next {
my $r = $_[0]->cmd('NEXT');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>next()
Skip to next song.
=cut
sub prev {
my $r = $_[0]->cmd('PREV');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>prev()
Skip to previous song.
=cut
sub isplaying {
my $r = $_[0]->cmd('ISPLAYING');
return undef unless defined($r);
return $_[0]->is_yes($r);
}
=pod
=head3 $res = $rpld-E<gt>isplaying()
Return a true value if we are currently playing.
=cut
sub showidentifier {
my ($e) = @_;
my $q = $e->cmd_data('SHOWIDENTIFIER');
return undef unless $e->is_ok($q->[0]);
return $q->[1];
}
=pod
=head3 $res = $rpld-E<gt>showidentifier()
Return a identifier for the currently running stream at the server.
The format of this identifier is undefined.
This should not be used.
Using this value can result in race conditions.
=cut
=pod
=head2 Queue control
=cut
sub flushq {
my $r = $_[0]->cmd('FLUSHQ');
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>flushq()
Flush the Main Queue. Playback is stopped (because no songs are left in the queue).
=cut
sub showcur {
my ($e) = @_;
my $q = $e->cmd_data('SHOWCUR');
return undef unless $e->is_ok($q->[0]);
return $e->p_ple($q->[1]);
}
=pod
=head3 $res = $rpld-E<gt>showcur()
Return the Playlist entry for the current song (if playback is running this is the currently played song).
This contains information about this song from the playlist. If you want to read the current meta data or other live data use $rpld->showplaying().
The return value is in the same format as that of $rpld->showple(). See $rpld->showple() for more information on it.
=cut
sub showplaying {
my ($e) = @_;
my $q = $e->cmd_data('SHOWPLAYING');
my $r = {'meta' => {}};
my ($k, $v);
local $_;
return undef unless $e->is_ok(shift(@{$q}));
foreach (@{$q}) {
/^(\S+)\s+(\S.*)$/ or return undef;
($k, $v) = (lc($1), $2);
if ( $k eq 'state' ) {
$r->{$k} = uc($v);
} elsif ( $k eq 'uuid' || $k eq 'longgtn' || $k eq 'shortgtn' ) {
$r->{$k} = lc($v);
} elsif ( $k eq 'time' ) {
$v =~ /^(\d+) S(?: \(([0-9\.]+)s\))?$/;
$r->{'time'} = {'samples' => $1, ($2 ? ('s' => $2+0) : ())};
} elsif ( $k eq 'meta' ) {
/^META (\S+)\s+"(.*)"$/i or return undef;
$r->{'meta'}->{lc($1)} = $2;
} else {
$r->{$k} = int($v);
}
}
if ( exists($r->{'meta'}->{'discid'}) ) {
$r->{'meta'}->{'totaltracks'} = $r->{'meta'}->{'discid'} & 0xFF;
}
return $r;
}
=pod
=head3 $res = $rpld-E<gt>showplaying()
Returns live information on what is currently played.
The return value is a hashref which contains the following keys (all keys may or may not be set depending on what info the server provides):
=over
=item state
A string of the current playback state in uppercase. Possible values include: STOPPED, PAUSE, RUNNING.
=item longgtn
The long GTN of the current ple.
=item shortgtn
The short GTN of the current ple.
=item uuid
The UUID of the current ple.
=item time
A hash containing keys for the current playback time in different units. The unit name is the key name. Units may include: samples, s.
=item meta
A hash containing keys for each meta data type provided by the server. Types may include: title, album, artist, performer, version.
=item mduc
The meta data update counter (MDUC) for current playback.
=item rate
The sample rate of the current playback.
=item channels
The number of channels of the current playback.
=item bits
The number of bits of the current playback.
=back
=cut
sub listq {
return $_[0]->listple($_[1] || 0); # Main Queue = 0
}
=pod
=head3 $res = $rpld-E<gt>listq([$playlist])
List playlist entries of the Main Queue or the given playlist.
This is the same as $rpld->listple() expect that the default playlist is the Main Queue not the currently selected playlist.
=cut
sub showqueue {
my ($e, $pl) = @_;
my $q = $e->cmd_data('SHOWQUEUE', defined($pl) ? ($e->q_pli($pl)) : ());
return undef unless $e->is_ok($q->[0]);
return p_playlist($e, $q->[1]);
}
=pod
=head3 $res = $rpld-E<gt>showqueue([$playlist])
Returns a hashref with information about the given list or the current queue if no list is given.
The structure of the hashref is the same as for listplaylist().
This function is the same as showlist() but returns the current queue as default of no list is given.
=cut
=pod
=head2 Volume control
=cut
sub setvolume {
my ($e, $vol) = @_;
my $r;
# SETVOLUME {NUM|PC%}
if ( $vol =~ /^\d+\%$/ ) {
$r = $e->cmd('SETVOLUME', $vol);
} else {
$r = $e->cmd('SETVOLUME', int($vol));
}
return $e->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>setvolume($vol)
Set volume to $vol.
=cut
sub showvolume {
my ($e) = @_;
my $q = $e->cmd_data('SHOWVOLUME');
my $r = {};
return undef unless $e->is_ok($q->[0]);
$q->[1] =~ /^VOLUME (\d+)\/(\d+) (\d+)%$/ or return undef;
%{$r} = ('value' => $1, 'scale' => $2, 'pc' => $3);
return $r;
}
=pod
=head3 $res = $rpld-E<gt>showvolume()
Return a hashref to a hash containing volume information.
The hash contains the following keys:
=over
=item value
The current playback volume in units of scale.
=item scale
The unit of value.
=item pc
The volume in percent.
=back
The current volume (as float) is value/scale.
=cut
=pod
=head2 Controlling pause state
=cut
sub pause {
my ($e) = @_;
return $e->is_ok($e->cmd('PAUSE', 'TRUE'));
}
=pod
=head3 $res = $rpld-E<gt>pause()
Set the playback in pause mode.
You should not use this function but $rpld->togglepause() if possible.
=cut
sub unpause {
my ($e) = @_;
return $e->is_ok($e->cmd('PAUSE', 'FALSE'));
}
=pod
=head3 $res = $rpld-E<gt>unpause()
Unpause the playback.
You should not use this function but $rpld->togglepause() if possible.
=cut
sub togglepause {
my ($e) = @_;
return $e->is_ok($e->cmd('PAUSE', 'TOGGLE'));
}
=pod
=head3 $res = $rpld-E<gt>togglepause()
Toggle the pause state. This is the recommended function to change the pause state of playback.
This is because it interacts best with other applications changing the current pause state.
=cut
# --- Playlists:
=pod
=head2 Playlist management
=cut
sub setplaylist {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('SETPLAYLIST', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>setplaylist($playlist)
Select the given playlist. After selecting a playlist it becomes the default playlist for most operations which take a optional playlist argument. (Operations for which this does not set the default are marked in the corresponding description).
=cut
sub addplaylist {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('ADDPLAYLIST', $e->q_str($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>addplaylist($name)
Add a playlist.
=cut
sub delplaylist {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('DELPLAYLIST', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>delplaylist($playlist)
Delete a playlist. All entries are deleted, too.
=cut
sub flushplaylist {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('FLUSHPLAYLIST', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>flushplaylist($playlist)
Flush a playlist. If this is used on the Main Queue the playback is stopped as no songs are left to play.
=cut
sub listplaylists {
my ($e) = @_;
my $q = $e->cmd_data('LISTPLAYLISTS');
my @r;
my $c;
my %idcache;
local $_;
return undef unless defined($q);
return undef unless $e->is_ok(shift(@{$q}));
while (($_ = shift(@{$q}))) {
$c = p_playlist($e, $_);
$idcache{$c->{'id'}} = $c;
push(@r, $c);
}
foreach (keys(%idcache)) {
$c = $idcache{$_};
next if $c->{'id'} == $c->{'parent'};
next if $c->{'parent'} == 0;
push(@{$idcache{$c->{'parent'}}->{'children'}}, $c);
}
return \@r;
}
=pod
=head3 $res = $rpld-E<gt>listplaylist()
Get a list of playlists known by the server.
This returns a arrayref to a array containing a hashref for each list. This hash contains the following keys:
=over
=item id
The ID of the playlist.
=item parent
The ID of the parent playlist.
=item name
The name of the playlist.
=item children
A arrayref with the IDs of the children playlists.
=item history_size (optional)
The size of the history if this is a history.
This is the number of PLEs this playlist will store before old entries
becomes deleted automatically.
=item history (optional)
The PLI of the playlist used as history if this is a queue.
=item volume (optional)
The playback volume if this is a queue.
=item backend (optional)
The backend used by this queue (if this is a queue).
The backend is the name (server address) of the RoarAudio server.
=item mixer (optional)
The ID of the Mixer used on the RoarAudio server. -1 for default.
Only set if this is a queue.
=item role (optional)
The Stream role used by this queue. Often "music" or "background_music".
Only if this is a queue.
=back
Parent/child information should be used to display a tree to the user.
=cut
sub showlist {
my ($e, $pl) = @_;
my $q = $e->cmd_data('SHOWLIST', $e->q_pli($pl));
return undef unless $e->is_ok($q->[0]);
return p_playlist($e, $q->[1]);
}
=pod
=head3 $res = $rpld-E<gt>showlist($playlist)
Returns a hashref with information about the given playlist.
The structure of the hashref is the same as for listplaylist().
=cut
sub setparentlist {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('SETPARENTLIST', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>setparentlist($playlist)
Set the parent playlist of the current playlist.
Setting parent playlist of a list the current one is currently not supported.
=cut
# --- Queues:
=pod
=head2 Queue management
=cut
sub setqueue {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('SETQUEUE', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>setqueue($playlist)
Select the given playlist as queue. After selecting a queue it becomes the default queue for the current connection.
=cut
sub delqueue {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('DELQUEUE', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>delqueue($playlist)
Delete a queue from a playlist. The playlist will not be removed just the queue.
=cut
sub addqueue {
my ($e, $pl, $history, $backend, $mixer, $role) = @_;
my @q = ('ADDQUEUE', $e->q_pli($pl), 'WITH HISTORY', $e->q_pli($history));
my $r;
push(@q, ('WITH BACKEND', $e->q_str($backend))) if defined $backend;
push(@q, ('MIXER', int($mixer))) if defined($mixer) && $mixer > 0;
push(@q, ('WITH ROLE', $e->q_str($role))) if defined $role;
$r = $e->cmd(@q);
return undef unless defined($r);
return $e->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>addqueue($playlist, $history[, $backend[, $mixer[, $role]]])
Add a queue to playlist $pl with the playlist $history as history.
Optionally the server to connect to can be given as $backend and the mixer to connect to as $mixer.
In addition the stream role can be set using $role.
=cut
# --- Historys:
=pod
=head2 History management
=cut
sub addhistory {
my ($e, $pl, $size) = @_;
my $r = $_[0]->cmd('ADDHISTORY', $e->q_pli($pl), defined($size) ? ('SIZE', int($size)) : ());
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>addhistory($playlist, [$size])
Add a history to the playlist. The history size can be set using the optional argument $size.
If not given the server's default will be used.
=cut
sub delhistory {
my ($e, $pl) = @_;
my $r = $_[0]->cmd('DELHISTORY', $e->q_pli($pl));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>delhistory($playlist)
Delete a history from a playlist. The playlist will not be removed just the history.
=cut
# -- PLE:
=pod
=head2 Playlist Entry management
=cut
sub delple {
my ($e, $ple, $pl) = @_;
my @q = ($e->q_ple($ple));
my $r;
if ( defined($pl) ) {
push(@q, 'FROM');
push(@q, $e->q_pli($pl));
}
$r = $_[0]->cmd('DELPLE', @q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>delple($ple[, $playlist])
Delete the given playlist entry.
=cut
sub queueple {
my ($e, $ple, $pl, $pos) = @_;
my @q = ($e->q_ple($ple));
my $r;
if ( defined($pl) ) {
push(@q, 'FROM');
push(@q, $e->q_pli($pl));
}
if ( defined($pos) ) {
push(@q, 'AT');
push(@q, int($pos));
}
$r = $_[0]->cmd('QUEUEPLE', @q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>queueple($ple[, $playlist[, $pos]])
Queue the given playlist entry. This means it is copied over to the Main Queue. This function is recommended over $rpld->copyple() to queue songs.
The optional position is used to give the place in the playlist where to queue the song.
It is counted as 'n entries after the first one'. This means if you pass a value of zero the song is placed as next song. If you pass a value of one it is placed as the song after the next song and so on. A value of -1 means that it is added before the first one. If you place a song before the first one in the Main Queue playback is stopped and restarted so this song becomes the currently played song.
If you omit the position or pass undef the default behavior is to add at the end of the playlist which should be the default in your applications, too.
=cut
sub copyple {
my ($e, $ple, $fpl, $tpl, $pos) = @_;
my @q = ($e->q_ple($ple));
my $r;
if ( !defined($tpl) ) {
$tpl = $fpl;
$fpl = undef;
}
if ( defined($fpl) ) {
push(@q, 'FROM');
push(@q, $e->q_pli($fpl));
}
push(@q, 'TO');
push(@q, $e->q_pli($tpl));
if ( defined($pos) ) {
push(@q, 'AT');
push(@q, int($pos));
}
$r = $_[0]->cmd('COPYPLE', @q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>copyple($ple, $playlist_from, $playlist_to[, $pos])
The given playlist entry is copied from the playlist $playlist_from to the playlist $playlist_to.
If $playlist_from is undef the currently selected playlist is used as source.
For the meaning of the position parameter ($pos) see $rpld->queueple() above.
=cut
sub moveple {
my ($e, $ple, $fpl, $tpl, $pos) = @_;
my @q = ($e->q_ple($ple));
my $r;
if ( !defined($tpl) ) {
$tpl = $fpl;
$fpl = undef;
}
if ( defined($fpl) ) {
push(@q, 'FROM');
push(@q, $e->q_pli($fpl));
}
push(@q, 'TO');
push(@q, $e->q_pli($tpl));
if ( defined($pos) ) {
push(@q, 'AT');
push(@q, int($pos));
}
$r = $_[0]->cmd('MOVEPLE', @q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>moveple($ple, $playlist_from, $playlist_to[, $pos])
The given playlist entry is moved from the playlist $playlist_from to the playlist $playlist_to.
If $playlist_from is undef the currently selected playlist is used as source.
For the meaning of the position parameter ($pos) see $rpld->queueple() above.
=cut
sub listple {
my ($e, $pl) = @_;
my $q = $e->cmd_data('LISTPLE', $e->q_pli($pl));
my @r;
local $_;
return undef unless $e->is_ok(shift(@{$q}));
foreach (@{$q}) {
push(@r, $e->p_ple($_));
}
return \@r;
}
=pod
=head3 $res = $rpld-E<gt>listple($playlist)
List all playlist entries from the given playlist.
The return value is an arrayref with elements as if they are returned by $rpld->showple().
See $rpld->showple() for more info about the return format.
Note:
You should avoid calling this too often as it returns a large amount of data. You also should not store data for
currently not used playlists (for example only store data for the playlist currently shown to the user).
=cut
# SEARCHPLE {"search string"|discid:0xdiscid|uuid:UUID|genre:genre|tracknum[ber]:num} [CASE[[ ]SENSITIVE]] [NOT] {{IS|AS}|IN|AT {BEGIN|END} OF} [NOT] {ANY|ALBUM|TITLE|ARTIST|PERFORMER|VERSION|FILENAME|DISCID|UUID|GENRE|TRACKNUM[BER]|TAG:"Tagname"} [FROM {"Name"|ID|ANY [BUT {QUEUES|HISTORIES}]...}]
sub searchple {
my ($e, $needle, $op, $src, $pli, $opts) = @_;
my $q;
my @r;
my @req = ('SEARCHPLE');
my $neg = 0;
local $_;
$opts ||= {};
$neg = int($opts->{'neg'}) if exists $opts->{'neg'};
if ( ref($needle) eq 'ARRAY' ) {
unshift(@{$needle}, undef) if scalar(@{$needle}) == 1;
} else {
if ( $needle =~ /^uuid:([0-9a-fA-F-]{36})$/i ) {
$needle = ['uuid', $1];
} elsif ( $needle =~ /^discid:(0x[0-9a-fA-F]+)$/i ) {
$needle = ['discid', $1];
} elsif ( $needle =~ /^genre:(\d+)$/i ) {
$needle = ['genre', $1];
} elsif ( $needle =~ /^tracknum(?:ber)?:(\d+)$/i ) {
$needle = ['tracknum', $1];
} else {
$needle = [undef, $needle];
}
}
if ( $op eq 'eq' ) {
$op = 'IS';
} elsif ( $op eq 'ne' ) {
$op = 'IS';
$neg ^= 1;
} elsif ( $op eq 'in' ) {
$op = 'IN';
} elsif ( $op eq 'begin' ) {
$op = 'AT BEGIN OF';
} elsif ( $op eq 'end' ) {
$op = 'AT END OF';
} else {
return undef;
}
if ( !defined($src) ) {
$src = $needle->[0];
$src ||= $e->any();
}
if ( ref($src) eq 'SCALAR' ) {
$src = ${$src}; # support $any.
} elsif ( ref($src) eq 'ARRAY' ) {
if ( scalar(@{$src}) == 1 ) {
$src = $src->[0];
} else {
$src = $src->[0].':'.$e->q_str($src->[1]);
}
} else {
if ( defined($needle->[0]) ) {
$src = $needle->[0];
} else {
$src = 'TAG:'.$e->q_str($src);
}
}
if ( defined $needle->[0] ) {
$needle = $needle->[0].':'.$needle->[1];
} else {
$needle = $e->q_str($needle->[1]);
}
push(@req, $needle);
push(@req, 'CASESENSITIVE') if defined($opts->{'casesensitive'}) && $opts->{'casesensitive'};
push(@req, 'NOT') if $neg;
push(@req, $op);
push(@req, $src);
push(@req, 'FROM', $e->q_pli($pli)) if defined $pli;
push(@req, 'BUT', 'QUEUES') if defined($opts->{'queues'}) && !$opts->{'queues'};
push(@req, 'BUT', 'HISTORIES') if defined($opts->{'histories'}) && !$opts->{'histories'};
$q = $e->cmd_data(@req);
return undef unless $e->is_ok(shift(@{$q}));
foreach (@{$q}) {
push(@r, $e->p_ple($_));
}
return \@r;
}
=pod
=head3 $res = $rpld-E<gt>searchple($needle, $op, $src, [$pli, [$opts]])
List playlist entries matching a given rule.
The return value is the same as for $rpld->listple().
This function accepts the following arguments:
=over
=item $needle
The needle is the search term the server will search for.
It may be a scalar value or a arrayref.
If an arrayref the array must have one or two elements.
If the array has two elements the first one is the type of needle
and the second is the value to search for.
The supported types depend on the server.
As of version 0.1.5 RoarAudio PlayList Daemon supports:
String types, DISCID, UUID, GENRE, TRACKNUM[BER].
String types are defined with a type of undef.
If it has only one element the type defaults to undef (string type).
If a scalar value is given the type is automatically selected
based on the prefix. If a prefix is found matching one of the known types
that type is selected. If no such prefix is found the string is used as string
type. This is handy for user interfaces with only a single "intelligent" search box.
For non-user input the array form is strongly recommended.
=item $op
This is the operator used to compare needle to the source.
Currently the following options are defined. For negative versions see $opts.
=over
=item eq
The needle must to match the source.
=item ne
The needle must not match the source.
=item in
The needle is found anywhere within the source.
=item begin
The needle is found at the begin of the source.
=item end
The needle is found at the end of the source.
=back
=item $src
This is the source to compare the needle with.
This can be undef, a scalar value, $any or a arrayref.
$any matches any information within the PLE.
If an arrayref is used the array must consist of one or two elements.
The first element is the source. The second is the sub-source.
Valid values depend on the server software.
As of version 0.1.5 RoarAudio PlayList Daemon supports:
ALBUM, TITLE, ARTIST, PERFORMER, VERSION, FILENAME, DISCID, UUID, GENRE, TRACKNUM[BER]
and TAG:"Tagname". Not all of them can be used with all kinds of needles.
If $src is a scalar value it is interpreted as ['TAG', $src] or [$src]
depending on the needle.
If this is undef the source is selected by the type of needle
with string needles defaulting to $any.
=item $pli (optional)
This is the playlist to search in or $any.
=item $opts (optional)
This is an hashref with options. All options are optional. The following keys are currently defined:
=over
=item neg
If set to a true value the search is inverted.
=item casesensitive
If set to a true value the search is done case sensetive.
=item queues
If set to true value searching in queues is allowed.
If set to a false but not undef value such searches are disallowed.
If set to undef the default is used.
=item histories
Does the same as "queues" just for histories.
=back
=back
=cut
sub showple {
my ($e, $ple, $pli) = @_;
my @args = ($e->q_ple($ple));
my $q;
if ( $pli ) {
push(@args, 'FROM');
push(@args, $e->q_pli($pli));
}
$q = $e->cmd_data('SHOWPLE', @args);
return undef unless $e->is_ok($q->[0]);
return $e->p_ple($q->[1]);
}
=pod
=head3 $res = $rpld-E<gt>showple($ple[, $playlist])
Return data of the given playlist entry. If no playlist is given the currently selected one is used.
The return value is a hashref with the following keys:
=over
=item codec (optional)
The name of the used codec.
=item length (optional)
The playback length in seconds.
=item file
The filename. This may be anything supported by RoarAudio's DSTR. Including local files, web radio streams and other types.
=item meta
The value for the meta key is a hashref of it's own to a list of provided meta data.
The following keys may be included. All are optional. Other keys may also be included.
=over 8
=item album
Name of the album.
=item title
Title of the song.
=item artist
Name of the Artist.
=item performer
Name of the performer for this record.
=item version
Version of this record.
=item discid
CDDB DiscID for this song.
=item tracknumber
Tracknumber of this song in the album.
=item totaltracks
Total number of tracks in this album.
=item genre
Genre of this song.
=item genreid
Genre ID of this song.
=back
=item longid
The long GTN for the entry.
=item shortid
The short GTN for the entry.
=item uuid (optional)
The UUID for the entry.
=item likeness (optional)
The likeness value stored by the server.
This is a float in rage from zero to infinity.
The bigger the value is the more the song is liked.
=back
=cut
sub like {
my ($e, $ple, $likeness) = @_;
my @q = ('LIKE', $e->q_ple($ple), ($likeness+0 || 1));
my $r = $e->cmd(@q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>like($ple[, $likeness])
Tells the server that the user likes this entry.
Optionally tells the server how much. A value of +1.0 is the default if no value is given.
This is added to the likeness value stored by the server.
A value of zero has no effect. A negative value indicates dislikeness.
See dislike() for more information about dislikeness.
=cut
sub dislike {
my ($e, $ple, $likeness) = @_;
my @q = ('DISLIKE', $e->q_ple($ple), $likeness+0 || 1);
my $r = $e->cmd(@q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>dislike($ple[, $likeness])
This is the same as like() just marks a the given entry as disliked.
Optionally tells the server how much. A value of +1.0 is the default if no value is given.
The value is subtracted from server's value.
A value of zero has no effect. A negative value indicates likeness.
See like() for more information about likeness.
=cut
# -- POINTER:
=pod
=head2 Pointers
=cut
sub setpointer {
my ($e, $pointer, $ple, $pli) = @_;
my @q = (uc($pointer), $e->q_ple($ple));
my $r;
if ( $pli ) {
push(@q, 'FROM');
push(@q, $e->q_pli($pli));
}
$r = $_[0]->cmd('SETPOINTER', @q);
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>setpointer($pointer, $ple[, $playlist])
Set the given pointer to the given playlist entry. If no playlist is given the currently selected one is used.
=cut
sub unsetpointer {
my ($e, $pointer) = @_;
my $r;
$r = $_[0]->cmd('UNSETPOINTER', uc($pointer));
return undef unless defined($r);
return $_[0]->is_ok($r);
}
=pod
=head3 $res = $rpld-E<gt>unsetpointer($pointer)
Unset the given pointer.
=cut
sub showpointer {
my ($e, $pointer) = @_;
my $q;
my $r = {};
my $plent;
local $_;
$q = $e->cmd_data('SHOWPOINTER', $pointer ? (uc($pointer)) : ());
return undef unless $e->is_ok(shift(@{$q}));
foreach (@{$q}) {
if ( /^POINTER (.+) NOT SET$/ ) {
$r->{$1} = {};
} elsif ( /^POINTER (.+?) IS AT (.+)/ ) {
$r->{$1} = {'plent' => $plent = {'raw' => $2}};
if ( $plent->{'raw'} =~ /^long:/ ) {
$plent->{'longid'} = $plent->{'raw'};
} elsif ( $plent->{'raw'} =~ /^short:/ ) {
$plent->{'shortid'} = $plent->{'raw'};
} elsif ( $plent->{'raw'} =~ /^uuid:/ ) {
$plent->{'uuid'} = $plent->{'raw'};
} elsif ( $plent->{'raw'} =~ /^random:(\d+)$/ ) {
$plent->{'playlist'} = int($1);
$plent->{'random'} = $plent->{'raw'};
} elsif ( $plent->{'raw'} =~ /^randomlike:(\d+)$/ ) {
$plent->{'playlist'} = int($1);
$plent->{'randomlike'} = $plent->{'raw'};
}
}
}
return $r;
}
=pod
=head3 $res = $rpld-E<gt>showpointer([$pointer])
Returns information about the given or all pointers.
The return value is a hashref with keys of the pointer names.
The values for those keys are a hashref containing information on the corresponding pointer.
If the hashref for the pointer points to a empty hash (no keys defined) then the pointer is not defined.
If the pointer is defined the following keys are contained:
=over
=item raw
The playlist entry the pointer points to in a raw format.
=item longid (optional)
If the pointer contains an information about the playlist entries long GTN this GTN.
=item shortid (optional)
If the pointer contains an information about the playlist entries short GTN this GTN.
=item uuid (optional)
If the pointer contains an information about the playlist entries UUID this UUID.
=item random (optional)
If the pointer points to a random song within a playlist this contains the corresponding search string.
=item randomlike (optional)
If the pointer points to a random song (respecting likeness) within a playlist this
contains the corresponding search string.
=item playlist (optional)
If the pointer contains a playlist hint this contains the playlist ID.
=back
=cut
# -- CLIENTS:
=pod
=head2 Clients
=cut
sub listclients {
my ($e) = @_;
my $q = $e->cmd_data('LISTCLIENTS');
my @r;
local $_;
return undef unless defined($q);
return undef unless $e->is_ok(shift(@{$q}));
while (($_ = shift(@{$q}))) {
push(@r, p_client($e, $_));
}
return \@r;
}
=pod
=head3 $res = $rpld-E<gt>listclients()
Get a list of clients connected to the server.
This returns a arrayref to a array containing a hashref for each client. This hash contains the following keys:
=over
=item id
The ID of the client.
=item name
The name of the client.
=item protocol
The name of the protocol the client is using.
=item pid (optional)
The process ID of the client.
=item nodename (optional)
The name of the node the client is being conneected from.
=item hostid (optional)
The unix hostid of the node the client is being connected from.
=back
=cut
1;
=pod
=head1 SEE ALSO
=head1 AUTHOR
Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>
=head1 LICENSE
Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2009-2012
This file is part of Audio::RPLD,
a library to access the RoarAudio PlayList Daemon from Perl.
See README for details.
This file is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3
as published by the Free Software Foundation.
Audio::RPLD is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this software; see the file COPYING.gplv3.
If not, write to the Free Software Foundation, 51 Franklin Street,
Fifth Floor, Boston, MA 02110-1301, USA.
=cut
__DATA__
HELP
SERVERINFO
QUIT
IMPORT [{"Name"|ID}] {TO|FROM} {STDIN|STDOUT|"Filename"} [AS {RPLD|PLS|M3U|VCLT|XSPF|PLAIN|URAS}]
EXPORT [{"Name"|ID}] {TO|FROM} {STDIN|STDOUT|"Filename"} [AS {RPLD|PLS|M3U|VCLT|XSPF|PLAIN|URAS}]
UNAUTH [ACCLEV] {BY n|TO {n|"name"}}
|