/usr/lib/python2.7/dist-packages/mutagen/id3/_frames.py is in python-mutagen 1.36-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 | # -*- coding: utf-8 -*-
# Copyright (C) 2005 Michael Urman
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of version 2 of the GNU General Public License as
# published by the Free Software Foundation.
import zlib
from struct import unpack
from ._util import ID3JunkFrameError, ID3EncryptionUnsupportedError, unsynch, \
ID3SaveConfig, error
from ._specs import BinaryDataSpec, StringSpec, Latin1TextSpec, \
EncodedTextSpec, ByteSpec, EncodingSpec, ASPIIndexSpec, SizedIntegerSpec, \
IntegerSpec, Encoding, VolumeAdjustmentsSpec, VolumePeakSpec, \
VolumeAdjustmentSpec, ChannelSpec, MultiSpec, SynchronizedTextSpec, \
KeyEventSpec, TimeStampSpec, EncodedNumericPartTextSpec, \
EncodedNumericTextSpec, SpecError, PictureTypeSpec, ID3FramesSpec, \
Latin1TextListSpec, CTOCFlagsSpec, FrameIDSpec, RVASpec
from .._compat import text_type, string_types, swap_to_string, iteritems, \
izip, itervalues
def _bytes2key(b):
assert isinstance(b, bytes)
return b.decode("latin1")
class Frame(object):
"""Fundamental unit of ID3 data.
ID3 tags are split into frames. Each frame has a potentially
different structure, and so this base class is not very featureful.
"""
FLAG23_ALTERTAG = 0x8000
FLAG23_ALTERFILE = 0x4000
FLAG23_READONLY = 0x2000
FLAG23_COMPRESS = 0x0080
FLAG23_ENCRYPT = 0x0040
FLAG23_GROUP = 0x0020
FLAG24_ALTERTAG = 0x4000
FLAG24_ALTERFILE = 0x2000
FLAG24_READONLY = 0x1000
FLAG24_GROUPID = 0x0040
FLAG24_COMPRESS = 0x0008
FLAG24_ENCRYPT = 0x0004
FLAG24_UNSYNCH = 0x0002
FLAG24_DATALEN = 0x0001
_framespec = []
_optionalspec = []
def __init__(self, *args, **kwargs):
if len(args) == 1 and len(kwargs) == 0 and \
isinstance(args[0], type(self)):
other = args[0]
# ask the sub class to fill in our data
other._to_other(self)
else:
for checker, val in izip(self._framespec, args):
setattr(self, checker.name, val)
for checker in self._framespec[len(args):]:
setattr(self, checker.name,
kwargs.get(checker.name, checker.default))
for spec in self._optionalspec:
if spec.name in kwargs:
setattr(self, spec.name, kwargs[spec.name])
else:
break
def __setattr__(self, name, value):
for checker in self._framespec:
if checker.name == name:
self._setattr(name, checker.validate(self, value))
return
for checker in self._optionalspec:
if checker.name == name:
self._setattr(name, checker.validate(self, value))
return
super(Frame, self).__setattr__(name, value)
def _setattr(self, name, value):
self.__dict__[name] = value
def _to_other(self, other):
# this impl covers subclasses with the same framespec
if other._framespec is not self._framespec:
raise ValueError
for checker in other._framespec:
other._setattr(checker.name, getattr(self, checker.name))
# this impl covers subclasses with the same optionalspec
if other._optionalspec is not self._optionalspec:
raise ValueError
for checker in other._optionalspec:
if hasattr(self, checker.name):
other._setattr(checker.name, getattr(self, checker.name))
def _merge_frame(self, other):
# default impl, use the new tag over the old one
return other
def _upgrade_frame(self):
"""Returns either this instance or a new instance if this is a v2.2
frame and an upgrade to a v2.3/4 equivalent is viable.
If this is a v2.2 instance and there is no upgrade path, returns None.
"""
# turn 2.2 into 2.3/2.4 tags
if len(type(self).__name__) == 3:
base = type(self).__base__
if base is Frame:
return
return base(self)
else:
return self
def _get_v23_frame(self, **kwargs):
"""Returns a frame copy which is suitable for writing into a v2.3 tag.
kwargs get passed to the specs.
"""
new_kwargs = {}
for checker in self._framespec:
name = checker.name
value = getattr(self, name)
new_kwargs[name] = checker._validate23(self, value, **kwargs)
for checker in self._optionalspec:
name = checker.name
if hasattr(self, name):
value = getattr(self, name)
new_kwargs[name] = checker._validate23(self, value, **kwargs)
return type(self)(**new_kwargs)
@property
def HashKey(self):
"""An internal key used to ensure frame uniqueness in a tag"""
return self.FrameID
@property
def FrameID(self):
"""ID3v2 three or four character frame ID"""
return type(self).__name__
def __repr__(self):
"""Python representation of a frame.
The string returned is a valid Python expression to construct
a copy of this frame.
"""
kw = []
for attr in self._framespec:
# so repr works during __init__
if hasattr(self, attr.name):
kw.append('%s=%r' % (attr.name, getattr(self, attr.name)))
for attr in self._optionalspec:
if hasattr(self, attr.name):
kw.append('%s=%r' % (attr.name, getattr(self, attr.name)))
return '%s(%s)' % (type(self).__name__, ', '.join(kw))
def _readData(self, id3, data):
"""Raises ID3JunkFrameError; Returns leftover data"""
for reader in self._framespec:
if len(data) or reader.handle_nodata:
try:
value, data = reader.read(id3, self, data)
except SpecError as e:
raise ID3JunkFrameError(e)
else:
raise ID3JunkFrameError("no data left")
self._setattr(reader.name, value)
for reader in self._optionalspec:
if len(data) or reader.handle_nodata:
try:
value, data = reader.read(id3, self, data)
except SpecError as e:
raise ID3JunkFrameError(e)
else:
break
self._setattr(reader.name, value)
return data
def _writeData(self, config=None):
"""Raises error"""
if config is None:
config = ID3SaveConfig()
if config.v2_version == 3:
frame = self._get_v23_frame(sep=config.v23_separator)
else:
frame = self
data = []
for writer in self._framespec:
try:
data.append(
writer.write(config, frame, getattr(frame, writer.name)))
except SpecError as e:
raise error(e)
for writer in self._optionalspec:
try:
data.append(
writer.write(config, frame, getattr(frame, writer.name)))
except AttributeError:
break
except SpecError as e:
raise error(e)
return b''.join(data)
def pprint(self):
"""Return a human-readable representation of the frame."""
return "%s=%s" % (type(self).__name__, self._pprint())
def _pprint(self):
return "[unrepresentable data]"
@classmethod
def _fromData(cls, header, tflags, data):
"""Construct this ID3 frame from raw string data.
Raises:
ID3JunkFrameError in case parsing failed
NotImplementedError in case parsing isn't implemented
ID3EncryptionUnsupportedError in case the frame is encrypted.
"""
if header.version >= header._V24:
if tflags & (Frame.FLAG24_COMPRESS | Frame.FLAG24_DATALEN):
# The data length int is syncsafe in 2.4 (but not 2.3).
# However, we don't actually need the data length int,
# except to work around a QL 0.12 bug, and in that case
# all we need are the raw bytes.
datalen_bytes = data[:4]
data = data[4:]
if tflags & Frame.FLAG24_UNSYNCH or header.f_unsynch:
try:
data = unsynch.decode(data)
except ValueError:
# Some things write synch-unsafe data with either the frame
# or global unsynch flag set. Try to load them as is.
# https://github.com/quodlibet/mutagen/issues/210
# https://github.com/quodlibet/mutagen/issues/223
pass
if tflags & Frame.FLAG24_ENCRYPT:
raise ID3EncryptionUnsupportedError
if tflags & Frame.FLAG24_COMPRESS:
try:
data = zlib.decompress(data)
except zlib.error as err:
# the initial mutagen that went out with QL 0.12 did not
# write the 4 bytes of uncompressed size. Compensate.
data = datalen_bytes + data
try:
data = zlib.decompress(data)
except zlib.error as err:
raise ID3JunkFrameError(
'zlib: %s: %r' % (err, data))
elif header.version >= header._V23:
if tflags & Frame.FLAG23_COMPRESS:
usize, = unpack('>L', data[:4])
data = data[4:]
if tflags & Frame.FLAG23_ENCRYPT:
raise ID3EncryptionUnsupportedError
if tflags & Frame.FLAG23_COMPRESS:
try:
data = zlib.decompress(data)
except zlib.error as err:
raise ID3JunkFrameError('zlib: %s: %r' % (err, data))
frame = cls()
frame._readData(header, data)
return frame
def __hash__(self):
raise TypeError("Frame objects are unhashable")
class CHAP(Frame):
"""Chapter"""
_framespec = [
Latin1TextSpec("element_id"),
SizedIntegerSpec("start_time", 4, default=0),
SizedIntegerSpec("end_time", 4, default=0),
SizedIntegerSpec("start_offset", 4, default=0xffffffff),
SizedIntegerSpec("end_offset", 4, default=0xffffffff),
ID3FramesSpec("sub_frames"),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.element_id)
def __eq__(self, other):
if not isinstance(other, CHAP):
return False
self_frames = self.sub_frames or {}
other_frames = other.sub_frames or {}
if sorted(self_frames.values()) != sorted(other_frames.values()):
return False
return self.element_id == other.element_id and \
self.start_time == other.start_time and \
self.end_time == other.end_time and \
self.start_offset == other.start_offset and \
self.end_offset == other.end_offset
__hash__ = Frame.__hash__
def _pprint(self):
frame_pprint = u""
for frame in itervalues(self.sub_frames):
for line in frame.pprint().splitlines():
frame_pprint += "\n" + " " * 4 + line
return u"%s time=%d..%d offset=%d..%d%s" % (
self.element_id, self.start_time, self.end_time,
self.start_offset, self.end_offset, frame_pprint)
class CTOC(Frame):
"""Table of contents"""
_framespec = [
Latin1TextSpec("element_id"),
CTOCFlagsSpec("flags", default=0),
Latin1TextListSpec("child_element_ids"),
ID3FramesSpec("sub_frames"),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.element_id)
__hash__ = Frame.__hash__
def __eq__(self, other):
if not isinstance(other, CTOC):
return False
self_frames = self.sub_frames or {}
other_frames = other.sub_frames or {}
if sorted(self_frames.values()) != sorted(other_frames.values()):
return False
return self.element_id == other.element_id and \
self.flags == other.flags and \
self.child_element_ids == other.child_element_ids
def _pprint(self):
frame_pprint = u""
if getattr(self, "sub_frames", None):
frame_pprint += "\n" + "\n".join(
[" " * 4 + f.pprint() for f in self.sub_frames.values()])
return u"%s flags=%d child_element_ids=%s%s" % (
self.element_id, int(self.flags),
u",".join(self.child_element_ids), frame_pprint)
@swap_to_string
class TextFrame(Frame):
"""Text strings.
Text frames support casts to unicode or str objects, as well as
list-like indexing, extend, and append.
Iterating over a TextFrame iterates over its strings, not its
characters.
Text frames have a 'text' attribute which is the list of strings,
and an 'encoding' attribute; 0 for ISO-8859 1, 1 UTF-16, 2 for
UTF-16BE, and 3 for UTF-8. If you don't want to worry about
encodings, just set it to 3.
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
MultiSpec('text', EncodedTextSpec('text'), sep=u'\u0000', default=[]),
]
def __bytes__(self):
return text_type(self).encode('utf-8')
def __str__(self):
return u'\u0000'.join(self.text)
def __eq__(self, other):
if isinstance(other, bytes):
return bytes(self) == other
elif isinstance(other, text_type):
return text_type(self) == other
return self.text == other
__hash__ = Frame.__hash__
def __getitem__(self, item):
return self.text[item]
def __iter__(self):
return iter(self.text)
def append(self, value):
"""Append a string."""
return self.text.append(value)
def extend(self, value):
"""Extend the list by appending all strings from the given list."""
return self.text.extend(value)
def _merge_frame(self, other):
# merge in new values
for val in other[:]:
if val not in self:
self.append(val)
return self
def _pprint(self):
return " / ".join(self.text)
class NumericTextFrame(TextFrame):
"""Numerical text strings.
The numeric value of these frames can be gotten with unary plus, e.g.::
frame = TLEN('12345')
length = +frame
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
MultiSpec('text', EncodedNumericTextSpec('text'), sep=u'\u0000',
default=[]),
]
def __pos__(self):
"""Return the numerical value of the string."""
return int(self.text[0])
class NumericPartTextFrame(TextFrame):
"""Multivalue numerical text strings.
These strings indicate 'part (e.g. track) X of Y', and unary plus
returns the first value::
frame = TRCK('4/15')
track = +frame # track == 4
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
MultiSpec('text', EncodedNumericPartTextSpec('text'), sep=u'\u0000',
default=[]),
]
def __pos__(self):
return int(self.text[0].split("/")[0])
@swap_to_string
class TimeStampTextFrame(TextFrame):
"""A list of time stamps.
The 'text' attribute in this frame is a list of ID3TimeStamp
objects, not a list of strings.
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
MultiSpec('text', TimeStampSpec('stamp'), sep=u',', default=[]),
]
def __bytes__(self):
return text_type(self).encode('utf-8')
def __str__(self):
return u','.join([stamp.text for stamp in self.text])
def _pprint(self):
return u" / ".join([stamp.text for stamp in self.text])
@swap_to_string
class UrlFrame(Frame):
"""A frame containing a URL string.
The ID3 specification is silent about IRIs and normalized URL
forms. Mutagen assumes all URLs in files are encoded as Latin 1,
but string conversion of this frame returns a UTF-8 representation
for compatibility with other string conversions.
The only sane way to handle URLs in MP3s is to restrict them to
ASCII.
"""
_framespec = [
Latin1TextSpec('url'),
]
def __bytes__(self):
return self.url.encode('utf-8')
def __str__(self):
return self.url
def __eq__(self, other):
return self.url == other
__hash__ = Frame.__hash__
def _pprint(self):
return self.url
class UrlFrameU(UrlFrame):
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.url)
class TALB(TextFrame):
"Album"
class TBPM(NumericTextFrame):
"Beats per minute"
class TCOM(TextFrame):
"Composer"
class TCON(TextFrame):
"""Content type (Genre)
ID3 has several ways genres can be represented; for convenience,
use the 'genres' property rather than the 'text' attribute.
"""
from mutagen._constants import GENRES
GENRES = GENRES
def __get_genres(self):
genres = []
import re
genre_re = re.compile(r"((?:\((?P<id>[0-9]+|RX|CR)\))*)(?P<str>.+)?")
for value in self.text:
# 255 possible entries in id3v1
if value.isdigit() and int(value) < 256:
try:
genres.append(self.GENRES[int(value)])
except IndexError:
genres.append(u"Unknown")
elif value == "CR":
genres.append(u"Cover")
elif value == "RX":
genres.append(u"Remix")
elif value:
newgenres = []
genreid, dummy, genrename = genre_re.match(value).groups()
if genreid:
for gid in genreid[1:-1].split(")("):
if gid.isdigit() and int(gid) < len(self.GENRES):
gid = text_type(self.GENRES[int(gid)])
newgenres.append(gid)
elif gid == "CR":
newgenres.append(u"Cover")
elif gid == "RX":
newgenres.append(u"Remix")
else:
newgenres.append(u"Unknown")
if genrename:
# "Unescaping" the first parenthesis
if genrename.startswith("(("):
genrename = genrename[1:]
if genrename not in newgenres:
newgenres.append(genrename)
genres.extend(newgenres)
return genres
def __set_genres(self, genres):
if isinstance(genres, string_types):
genres = [genres]
self.text = [self.__decode(g) for g in genres]
def __decode(self, value):
if isinstance(value, bytes):
enc = EncodedTextSpec._encodings[self.encoding][0]
return value.decode(enc)
else:
return value
genres = property(__get_genres, __set_genres, None,
"A list of genres parsed from the raw text data.")
def _pprint(self):
return " / ".join(self.genres)
class TCOP(TextFrame):
"Copyright (c)"
class TCMP(NumericTextFrame):
"iTunes Compilation Flag"
class TDAT(TextFrame):
"Date of recording (DDMM)"
class TDEN(TimeStampTextFrame):
"Encoding Time"
class TDES(TextFrame):
"iTunes Podcast Description"
class TKWD(TextFrame):
"iTunes Podcast Keywords"
class TCAT(TextFrame):
"iTunes Podcast Category"
class TDOR(TimeStampTextFrame):
"Original Release Time"
class TDLY(NumericTextFrame):
"Audio Delay (ms)"
class TDRC(TimeStampTextFrame):
"Recording Time"
class TDRL(TimeStampTextFrame):
"Release Time"
class TDTG(TimeStampTextFrame):
"Tagging Time"
class TENC(TextFrame):
"Encoder"
class TEXT(TextFrame):
"Lyricist"
class TFLT(TextFrame):
"File type"
class TGID(TextFrame):
"iTunes Podcast Identifier"
class TIME(TextFrame):
"Time of recording (HHMM)"
class TIT1(TextFrame):
"Content group description"
class TIT2(TextFrame):
"Title"
class TIT3(TextFrame):
"Subtitle/Description refinement"
class TKEY(TextFrame):
"Starting Key"
class TLAN(TextFrame):
"Audio Languages"
class TLEN(NumericTextFrame):
"Audio Length (ms)"
class TMED(TextFrame):
"Source Media Type"
class TMOO(TextFrame):
"Mood"
class TOAL(TextFrame):
"Original Album"
class TOFN(TextFrame):
"Original Filename"
class TOLY(TextFrame):
"Original Lyricist"
class TOPE(TextFrame):
"Original Artist/Performer"
class TORY(NumericTextFrame):
"Original Release Year"
class TOWN(TextFrame):
"Owner/Licensee"
class TPE1(TextFrame):
"Lead Artist/Performer/Soloist/Group"
class TPE2(TextFrame):
"Band/Orchestra/Accompaniment"
class TPE3(TextFrame):
"Conductor"
class TPE4(TextFrame):
"Interpreter/Remixer/Modifier"
class TPOS(NumericPartTextFrame):
"Part of set"
class TPRO(TextFrame):
"Produced (P)"
class TPUB(TextFrame):
"Publisher"
class TRCK(NumericPartTextFrame):
"Track Number"
class TRDA(TextFrame):
"Recording Dates"
class TRSN(TextFrame):
"Internet Radio Station Name"
class TRSO(TextFrame):
"Internet Radio Station Owner"
class TSIZ(NumericTextFrame):
"Size of audio data (bytes)"
class TSO2(TextFrame):
"iTunes Album Artist Sort"
class TSOA(TextFrame):
"Album Sort Order key"
class TSOC(TextFrame):
"iTunes Composer Sort"
class TSOP(TextFrame):
"Perfomer Sort Order key"
class TSOT(TextFrame):
"Title Sort Order key"
class TSRC(TextFrame):
"International Standard Recording Code (ISRC)"
class TSSE(TextFrame):
"Encoder settings"
class TSST(TextFrame):
"Set Subtitle"
class TYER(NumericTextFrame):
"Year of recording"
class TXXX(TextFrame):
"""User-defined text data.
TXXX frames have a 'desc' attribute which is set to any Unicode
value (though the encoding of the text and the description must be
the same). Many taggers use this frame to store freeform keys.
"""
_framespec = [
EncodingSpec('encoding'),
EncodedTextSpec('desc'),
MultiSpec('text', EncodedTextSpec('text'), sep=u'\u0000', default=[]),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.desc)
def _pprint(self):
return "%s=%s" % (self.desc, " / ".join(self.text))
class WCOM(UrlFrameU):
"Commercial Information"
class WCOP(UrlFrame):
"Copyright Information"
class WFED(UrlFrame):
"iTunes Podcast Feed"
class WOAF(UrlFrame):
"Official File Information"
class WOAR(UrlFrameU):
"Official Artist/Performer Information"
class WOAS(UrlFrame):
"Official Source Information"
class WORS(UrlFrame):
"Official Internet Radio Information"
class WPAY(UrlFrame):
"Payment Information"
class WPUB(UrlFrame):
"Official Publisher Information"
class WXXX(UrlFrame):
"""User-defined URL data.
Like TXXX, this has a freeform description associated with it.
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
EncodedTextSpec('desc'),
Latin1TextSpec('url'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.desc)
class PairedTextFrame(Frame):
"""Paired text strings.
Some ID3 frames pair text strings, to associate names with a more
specific involvement in the song. The 'people' attribute of these
frames contains a list of pairs::
[['trumpet', 'Miles Davis'], ['bass', 'Paul Chambers']]
Like text frames, these frames also have an encoding attribute.
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
MultiSpec('people',
EncodedTextSpec('involvement'),
EncodedTextSpec('person'), default=[])
]
def __eq__(self, other):
return self.people == other
__hash__ = Frame.__hash__
class TIPL(PairedTextFrame):
"Involved People List"
class TMCL(PairedTextFrame):
"Musicians Credits List"
class IPLS(TIPL):
"Involved People List"
class BinaryFrame(Frame):
"""Binary data
The 'data' attribute contains the raw byte string.
"""
_framespec = [
BinaryDataSpec('data'),
]
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
class MCDI(BinaryFrame):
"Binary dump of CD's TOC"
class ETCO(Frame):
"""Event timing codes."""
_framespec = [
ByteSpec("format", default=1),
KeyEventSpec("events", default=[]),
]
def __eq__(self, other):
return self.events == other
__hash__ = Frame.__hash__
class MLLT(Frame):
"""MPEG location lookup table.
This frame's attributes may be changed in the future based on
feedback from real-world use.
"""
_framespec = [
SizedIntegerSpec('frames', size=2, default=0),
SizedIntegerSpec('bytes', size=3, default=0),
SizedIntegerSpec('milliseconds', size=3, default=0),
ByteSpec('bits_for_bytes', default=0),
ByteSpec('bits_for_milliseconds', default=0),
BinaryDataSpec('data'),
]
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
class SYTC(Frame):
"""Synchronised tempo codes.
This frame's attributes may be changed in the future based on
feedback from real-world use.
"""
_framespec = [
ByteSpec("format", default=1),
BinaryDataSpec("data"),
]
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
@swap_to_string
class USLT(Frame):
"""Unsynchronised lyrics/text transcription.
Lyrics have a three letter ISO language code ('lang'), a
description ('desc'), and a block of plain text ('text').
"""
_framespec = [
EncodingSpec('encoding', default=Encoding.UTF16),
StringSpec('lang', length=3, default=u"XXX"),
EncodedTextSpec('desc'),
EncodedTextSpec('text'),
]
@property
def HashKey(self):
return '%s:%s:%s' % (self.FrameID, self.desc, self.lang)
def __bytes__(self):
return self.text.encode('utf-8')
def __str__(self):
return self.text
def __eq__(self, other):
return self.text == other
__hash__ = Frame.__hash__
@swap_to_string
class SYLT(Frame):
"""Synchronised lyrics/text."""
_framespec = [
EncodingSpec('encoding'),
StringSpec('lang', length=3, default=u"XXX"),
ByteSpec('format', default=1),
ByteSpec('type', default=0),
EncodedTextSpec('desc'),
SynchronizedTextSpec('text'),
]
@property
def HashKey(self):
return '%s:%s:%s' % (self.FrameID, self.desc, self.lang)
def __eq__(self, other):
return str(self) == other
__hash__ = Frame.__hash__
def __str__(self):
return u"".join(text for (text, time) in self.text)
def __bytes__(self):
return text_type(self).encode("utf-8")
class COMM(TextFrame):
"""User comment.
User comment frames have a descrption, like TXXX, and also a three
letter ISO language code in the 'lang' attribute.
"""
_framespec = [
EncodingSpec('encoding'),
StringSpec('lang', length=3, default="XXX"),
EncodedTextSpec('desc'),
MultiSpec('text', EncodedTextSpec('text'), sep=u'\u0000', default=[]),
]
@property
def HashKey(self):
return '%s:%s:%s' % (self.FrameID, self.desc, self.lang)
def _pprint(self):
return "%s=%s=%s" % (self.desc, self.lang, " / ".join(self.text))
class RVA2(Frame):
"""Relative volume adjustment (2).
This frame is used to implemented volume scaling, and in
particular, normalization using ReplayGain.
Attributes:
* desc -- description or context of this adjustment
* channel -- audio channel to adjust (master is 1)
* gain -- a + or - dB gain relative to some reference level
* peak -- peak of the audio as a floating point number, [0, 1]
When storing ReplayGain tags, use descriptions of 'album' and
'track' on channel 1.
"""
_framespec = [
Latin1TextSpec('desc'),
ChannelSpec('channel', default=1),
VolumeAdjustmentSpec('gain', default=1),
VolumePeakSpec('peak', default=1),
]
_channels = ["Other", "Master volume", "Front right", "Front left",
"Back right", "Back left", "Front centre", "Back centre",
"Subwoofer"]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.desc)
def __eq__(self, other):
try:
return ((str(self) == other) or
(self.desc == other.desc and
self.channel == other.channel and
self.gain == other.gain and
self.peak == other.peak))
except AttributeError:
return False
__hash__ = Frame.__hash__
def __str__(self):
return "%s: %+0.4f dB/%0.4f" % (
self._channels[self.channel], self.gain, self.peak)
class EQU2(Frame):
"""Equalisation (2).
Attributes:
method -- interpolation method (0 = band, 1 = linear)
desc -- identifying description
adjustments -- list of (frequency, vol_adjustment) pairs
"""
_framespec = [
ByteSpec("method", default=0),
Latin1TextSpec("desc"),
VolumeAdjustmentsSpec("adjustments", default=[]),
]
def __eq__(self, other):
return self.adjustments == other
__hash__ = Frame.__hash__
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.desc)
class RVAD(Frame):
"""Relative volume adjustment"""
_framespec = [
RVASpec("adjustments", stereo_only=False),
]
__hash__ = Frame.__hash__
def __eq__(self, other):
if not isinstance(other, RVAD):
return False
return self.adjustments == other.adjustments
# class EQUA: unsupported
class RVRB(Frame):
"""Reverb."""
_framespec = [
SizedIntegerSpec('left', size=2, default=0),
SizedIntegerSpec('right', size=2, default=0),
ByteSpec('bounce_left', default=0),
ByteSpec('bounce_right', default=0),
ByteSpec('feedback_ltl', default=0),
ByteSpec('feedback_ltr', default=0),
ByteSpec('feedback_rtr', default=0),
ByteSpec('feedback_rtl', default=0),
ByteSpec('premix_ltr', default=0),
ByteSpec('premix_rtl', default=0),
]
def __eq__(self, other):
return (self.left, self.right) == other
__hash__ = Frame.__hash__
class APIC(Frame):
"""Attached (or linked) Picture.
Attributes:
* encoding -- text encoding for the description
* mime -- a MIME type (e.g. image/jpeg) or '-->' if the data is a URI
* type -- the source of the image (3 is the album front cover)
* desc -- a text description of the image
* data -- raw image data, as a byte string
Mutagen will automatically compress large images when saving tags.
"""
_framespec = [
EncodingSpec('encoding'),
Latin1TextSpec('mime'),
PictureTypeSpec('type'),
EncodedTextSpec('desc'),
BinaryDataSpec('data'),
]
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.desc)
def _merge_frame(self, other):
other.desc += u" "
return other
def _pprint(self):
type_desc = text_type(self.type)
if hasattr(self.type, "_pprint"):
type_desc = self.type._pprint()
return "%s, %s (%s, %d bytes)" % (
type_desc, self.desc, self.mime, len(self.data))
class PCNT(Frame):
"""Play counter.
The 'count' attribute contains the (recorded) number of times this
file has been played.
This frame is basically obsoleted by POPM.
"""
_framespec = [
IntegerSpec('count', default=0),
]
def __eq__(self, other):
return self.count == other
__hash__ = Frame.__hash__
def __pos__(self):
return self.count
def _pprint(self):
return text_type(self.count)
class PCST(Frame):
"""iTunes Podcast Flag"""
_framespec = [
IntegerSpec('value', default=0),
]
def __eq__(self, other):
return self.value == other
__hash__ = Frame.__hash__
def __pos__(self):
return self.value
def _pprint(self):
return text_type(self.value)
class POPM(Frame):
"""Popularimeter.
This frame keys a rating (out of 255) and a play count to an email
address.
Attributes:
* email -- email this POPM frame is for
* rating -- rating from 0 to 255
* count -- number of times the files has been played (optional)
"""
_framespec = [
Latin1TextSpec('email'),
ByteSpec('rating', default=0),
]
_optionalspec = [
IntegerSpec('count', default=0),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.email)
def __eq__(self, other):
return self.rating == other
__hash__ = Frame.__hash__
def __pos__(self):
return self.rating
def _pprint(self):
return "%s=%r %r/255" % (
self.email, getattr(self, 'count', None), self.rating)
class GEOB(Frame):
"""General Encapsulated Object.
A blob of binary data, that is not a picture (those go in APIC).
Attributes:
* encoding -- encoding of the description
* mime -- MIME type of the data or '-->' if the data is a URI
* filename -- suggested filename if extracted
* desc -- text description of the data
* data -- raw data, as a byte string
"""
_framespec = [
EncodingSpec('encoding'),
Latin1TextSpec('mime'),
EncodedTextSpec('filename'),
EncodedTextSpec('desc'),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.desc)
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
class RBUF(Frame):
"""Recommended buffer size.
Attributes:
* size -- recommended buffer size in bytes
* info -- if ID3 tags may be elsewhere in the file (optional)
* offset -- the location of the next ID3 tag, if any
Mutagen will not find the next tag itself.
"""
_framespec = [
SizedIntegerSpec('size', size=3, default=0),
]
_optionalspec = [
ByteSpec('info', default=0),
SizedIntegerSpec('offset', size=4, default=0),
]
def __eq__(self, other):
return self.size == other
__hash__ = Frame.__hash__
def __pos__(self):
return self.size
@swap_to_string
class AENC(Frame):
"""Audio encryption.
Attributes:
* owner -- key identifying this encryption type
* preview_start -- unencrypted data block offset
* preview_length -- number of unencrypted blocks
* data -- data required for decryption (optional)
Mutagen cannot decrypt files.
"""
_framespec = [
Latin1TextSpec('owner'),
SizedIntegerSpec('preview_start', size=2, default=0),
SizedIntegerSpec('preview_length', size=2, default=0),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.owner)
def __bytes__(self):
return self.owner.encode('utf-8')
def __str__(self):
return self.owner
def __eq__(self, other):
return self.owner == other
__hash__ = Frame.__hash__
class LINK(Frame):
"""Linked information.
Attributes:
* frameid -- the ID of the linked frame
* url -- the location of the linked frame
* data -- further ID information for the frame
"""
_framespec = [
FrameIDSpec('frameid', length=4),
Latin1TextSpec('url'),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return "%s:%s:%s:%s" % (
self.FrameID, self.frameid, self.url, _bytes2key(self.data))
def __eq__(self, other):
return (self.frameid, self.url, self.data) == other
__hash__ = Frame.__hash__
class POSS(Frame):
"""Position synchronisation frame
Attribute:
* format -- format of the position attribute (frames or milliseconds)
* position -- current position of the file
"""
_framespec = [
ByteSpec('format', default=1),
IntegerSpec('position', default=0),
]
def __pos__(self):
return self.position
def __eq__(self, other):
return self.position == other
__hash__ = Frame.__hash__
class UFID(Frame):
"""Unique file identifier.
Attributes:
* owner -- format/type of identifier
* data -- identifier
"""
_framespec = [
Latin1TextSpec('owner'),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.owner)
def __eq__(s, o):
if isinstance(o, UFI):
return s.owner == o.owner and s.data == o.data
else:
return s.data == o
__hash__ = Frame.__hash__
def _pprint(self):
return "%s=%r" % (self.owner, self.data)
@swap_to_string
class USER(Frame):
"""Terms of use.
Attributes:
* encoding -- text encoding
* lang -- ISO three letter language code
* text -- licensing terms for the audio
"""
_framespec = [
EncodingSpec('encoding'),
StringSpec('lang', length=3, default=u"XXX"),
EncodedTextSpec('text'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.lang)
def __bytes__(self):
return self.text.encode('utf-8')
def __str__(self):
return self.text
def __eq__(self, other):
return self.text == other
__hash__ = Frame.__hash__
def _pprint(self):
return "%r=%s" % (self.lang, self.text)
@swap_to_string
class OWNE(Frame):
"""Ownership frame."""
_framespec = [
EncodingSpec('encoding'),
Latin1TextSpec('price'),
StringSpec('date', length=8, default=u"19700101"),
EncodedTextSpec('seller'),
]
def __bytes__(self):
return self.seller.encode('utf-8')
def __str__(self):
return self.seller
def __eq__(self, other):
return self.seller == other
__hash__ = Frame.__hash__
class COMR(Frame):
"""Commercial frame."""
_framespec = [
EncodingSpec('encoding'),
Latin1TextSpec('price'),
StringSpec('valid_until', length=8, default=u"19700101"),
Latin1TextSpec('contact'),
ByteSpec('format', default=0),
EncodedTextSpec('seller'),
EncodedTextSpec('desc'),
]
_optionalspec = [
Latin1TextSpec('mime'),
BinaryDataSpec('logo'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, _bytes2key(self._writeData()))
def __eq__(self, other):
return self._writeData() == other._writeData()
__hash__ = Frame.__hash__
@swap_to_string
class ENCR(Frame):
"""Encryption method registration.
The standard does not allow multiple ENCR frames with the same owner
or the same method. Mutagen only verifies that the owner is unique.
"""
_framespec = [
Latin1TextSpec('owner'),
ByteSpec('method', default=0x80),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return "%s:%s" % (self.FrameID, self.owner)
def __bytes__(self):
return self.data
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
@swap_to_string
class GRID(Frame):
"""Group identification registration."""
_framespec = [
Latin1TextSpec('owner'),
ByteSpec('group', default=0x80),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return '%s:%s' % (self.FrameID, self.group)
def __pos__(self):
return self.group
def __bytes__(self):
return self.owner.encode('utf-8')
def __str__(self):
return self.owner
def __eq__(self, other):
return self.owner == other or self.group == other
__hash__ = Frame.__hash__
@swap_to_string
class PRIV(Frame):
"""Private frame."""
_framespec = [
Latin1TextSpec('owner'),
BinaryDataSpec('data'),
]
@property
def HashKey(self):
return '%s:%s:%s' % (
self.FrameID, self.owner, _bytes2key(self.data))
def __bytes__(self):
return self.data
def __eq__(self, other):
return self.data == other
def _pprint(self):
return "%s=%r" % (self.owner, self.data)
__hash__ = Frame.__hash__
@swap_to_string
class SIGN(Frame):
"""Signature frame."""
_framespec = [
ByteSpec('group', default=0x80),
BinaryDataSpec('sig'),
]
@property
def HashKey(self):
return '%s:%s:%s' % (self.FrameID, self.group, _bytes2key(self.sig))
def __bytes__(self):
return self.sig
def __eq__(self, other):
return self.sig == other
__hash__ = Frame.__hash__
class SEEK(Frame):
"""Seek frame.
Mutagen does not find tags at seek offsets.
"""
_framespec = [
IntegerSpec('offset', default=0),
]
def __pos__(self):
return self.offset
def __eq__(self, other):
return self.offset == other
__hash__ = Frame.__hash__
class ASPI(Frame):
"""Audio seek point index.
Attributes: S, L, N, b, and Fi. For the meaning of these, see
the ID3v2.4 specification. Fi is a list of integers.
"""
_framespec = [
SizedIntegerSpec("S", size=4, default=0),
SizedIntegerSpec("L", size=4, default=0),
SizedIntegerSpec("N", size=2, default=0),
ByteSpec("b", default=0),
ASPIIndexSpec("Fi", default=[]),
]
def __eq__(self, other):
return self.Fi == other
__hash__ = Frame.__hash__
# ID3v2.2 frames
class UFI(UFID):
"Unique File Identifier"
class TT1(TIT1):
"Content group description"
class TT2(TIT2):
"Title"
class TT3(TIT3):
"Subtitle/Description refinement"
class TP1(TPE1):
"Lead Artist/Performer/Soloist/Group"
class TP2(TPE2):
"Band/Orchestra/Accompaniment"
class TP3(TPE3):
"Conductor"
class TP4(TPE4):
"Interpreter/Remixer/Modifier"
class TCM(TCOM):
"Composer"
class TXT(TEXT):
"Lyricist"
class TLA(TLAN):
"Audio Language(s)"
class TCO(TCON):
"Content Type (Genre)"
class TAL(TALB):
"Album"
class TPA(TPOS):
"Part of set"
class TRK(TRCK):
"Track Number"
class TRC(TSRC):
"International Standard Recording Code (ISRC)"
class TYE(TYER):
"Year of recording"
class TDA(TDAT):
"Date of recording (DDMM)"
class TIM(TIME):
"Time of recording (HHMM)"
class TRD(TRDA):
"Recording Dates"
class TMT(TMED):
"Source Media Type"
class TFT(TFLT):
"File Type"
class TBP(TBPM):
"Beats per minute"
class TCP(TCMP):
"iTunes Compilation Flag"
class TCR(TCOP):
"Copyright (C)"
class TPB(TPUB):
"Publisher"
class TEN(TENC):
"Encoder"
class TST(TSOT):
"Title Sort Order key"
class TSA(TSOA):
"Album Sort Order key"
class TS2(TSO2):
"iTunes Album Artist Sort"
class TSP(TSOP):
"Perfomer Sort Order key"
class TSC(TSOC):
"iTunes Composer Sort"
class TSS(TSSE):
"Encoder settings"
class TOF(TOFN):
"Original Filename"
class TLE(TLEN):
"Audio Length (ms)"
class TSI(TSIZ):
"Audio Data size (bytes)"
class TDY(TDLY):
"Audio Delay (ms)"
class TKE(TKEY):
"Starting Key"
class TOT(TOAL):
"Original Album"
class TOA(TOPE):
"Original Artist/Perfomer"
class TOL(TOLY):
"Original Lyricist"
class TOR(TORY):
"Original Release Year"
class TXX(TXXX):
"User-defined Text"
class WAF(WOAF):
"Official File Information"
class WAR(WOAR):
"Official Artist/Performer Information"
class WAS(WOAS):
"Official Source Information"
class WCM(WCOM):
"Commercial Information"
class WCP(WCOP):
"Copyright Information"
class WPB(WPUB):
"Official Publisher Information"
class WXX(WXXX):
"User-defined URL"
class IPL(IPLS):
"Involved people list"
class MCI(MCDI):
"Binary dump of CD's TOC"
class ETC(ETCO):
"Event timing codes"
class MLL(MLLT):
"MPEG location lookup table"
class STC(SYTC):
"Synced tempo codes"
class ULT(USLT):
"Unsychronised lyrics/text transcription"
class SLT(SYLT):
"Synchronised lyrics/text"
class COM(COMM):
"Comment"
class RVA(RVAD):
"Relative volume adjustment"
_framespec = [
RVASpec("adjustments", stereo_only=True),
]
def _to_other(self, other):
if not isinstance(other, RVAD):
raise TypeError
other.adjustments = list(self.adjustments)
# class EQU(EQUA)
class REV(RVRB):
"Reverb"
class PIC(APIC):
"""Attached Picture.
The 'mime' attribute of an ID3v2.2 attached picture must be either
'PNG' or 'JPG'.
"""
_framespec = [
EncodingSpec('encoding'),
StringSpec('mime', length=3, default="JPG"),
PictureTypeSpec('type'),
EncodedTextSpec('desc'),
BinaryDataSpec('data'),
]
def _to_other(self, other):
if not isinstance(other, APIC):
raise TypeError
other.encoding = self.encoding
other.mime = self.mime
other.type = self.type
other.desc = self.desc
other.data = self.data
class GEO(GEOB):
"General Encapsulated Object"
class CNT(PCNT):
"Play counter"
class POP(POPM):
"Popularimeter"
class BUF(RBUF):
"Recommended buffer size"
class CRM(Frame):
"""Encrypted meta frame"""
_framespec = [
Latin1TextSpec('owner'),
Latin1TextSpec('desc'),
BinaryDataSpec('data'),
]
def __eq__(self, other):
return self.data == other
__hash__ = Frame.__hash__
class CRA(AENC):
"Audio encryption"
class LNK(LINK):
"""Linked information"""
_framespec = [
FrameIDSpec('frameid', length=3),
Latin1TextSpec('url'),
BinaryDataSpec('data'),
]
def _to_other(self, other):
if not isinstance(other, LINK):
raise TypeError
if isinstance(other, LNK):
new_frameid = self.frameid
else:
try:
new_frameid = Frames_2_2[self.frameid].__bases__[0].__name__
except KeyError:
new_frameid = self.frameid.ljust(4)
# we could end up with invalid IDs here, so bypass the validation
other._setattr("frameid", new_frameid)
other.url = self.url
other.data = self.data
Frames = {}
"""All supported ID3v2.3/4 frames, keyed by frame name."""
Frames_2_2 = {}
"""All supported ID3v2.2 frames, keyed by frame name."""
k, v = None, None
for k, v in iteritems(globals()):
if isinstance(v, type) and issubclass(v, Frame):
v.__module__ = "mutagen.id3"
if len(k) == 3:
Frames_2_2[k] = v
elif len(k) == 4:
Frames[k] = v
try:
del k
del v
except NameError:
pass
|