/usr/lib/python2.7/dist-packages/rosbag/bag.py is in python-rosbag 1.11.16-3.
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 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 | # Software License Agreement (BSD License)
#
# Copyright (c) 2010, Willow Garage, Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided
# with the distribution.
# * Neither the name of Willow Garage, Inc. nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""
The rosbag Python API.
Provides serialization of bag files.
"""
from __future__ import print_function
import bisect
import bz2
import collections
import heapq
import os
import re
import struct
import sys
import threading
import time
import yaml
try:
from cStringIO import StringIO # Python 2.x
except ImportError:
from io import BytesIO as StringIO # Python 3.x
import genmsg
import genpy
import genpy.dynamic
import genpy.message
import roslib.names # still needed for roslib.names.canonicalize_name()
import rospy
try:
import roslz4
found_lz4 = True
except ImportError:
rospy.logwarn(
'Failed to load Python extension for LZ4 support. '
'LZ4 compression will not be available.')
found_lz4 = False
class ROSBagException(Exception):
"""
Base class for exceptions in rosbag.
"""
def __init__(self, value):
self.value = value
def __str__(self):
return self.value
class ROSBagFormatException(ROSBagException):
"""
Exceptions for errors relating to the bag file format.
"""
def __init__(self, value):
ROSBagException.__init__(self, value)
class ROSBagUnindexedException(ROSBagException):
"""
Exception for unindexed bags.
"""
def __init__(self):
ROSBagException.__init__(self, 'Unindexed bag')
class Compression:
"""
Allowable compression types
"""
NONE = 'none'
BZ2 = 'bz2'
LZ4 = 'lz4'
class Bag(object):
"""
Bag serialize messages to and from a single file on disk using the bag format.
"""
def __init__(self, f, mode='r', compression=Compression.NONE, chunk_threshold=768 * 1024, allow_unindexed=False, options=None, skip_index=False):
"""
Open a bag file. The mode can be 'r', 'w', or 'a' for reading (default),
writing or appending. The file will be created if it doesn't exist
when opened for writing or appending; it will be truncated when opened
for writing. Simultaneous reading and writing is allowed when in writing
or appending mode.
@param f: filename of bag to open or a stream to read from
@type f: str or file
@param mode: mode, either 'r', 'w', or 'a'
@type mode: str
@param compression: compression mode, see U{rosbag.Compression} for valid modes
@type compression: str
@param chunk_threshold: minimum number of uncompressed bytes per chunk
@type chunk_threshold: int
@param allow_unindexed: if True, allow opening unindexed bags
@type allow_unindexed: bool
@param options: the bag options (currently: compression and chunk_threshold)
@type options: dict
@param skip_index: if True, don't read the connection index records on open [2.0+]
@type skip_index: bool
@raise ValueError: if any argument is invalid
@raise ROSBagException: if an error occurs opening file
@raise ROSBagFormatException: if bag format is corrupted
"""
if options is not None:
if type(options) is not dict:
raise ValueError('options must be of type dict')
if 'compression' in options:
compression = options['compression']
if 'chunk_threshold' in options:
chunk_threshold = options['chunk_threshold']
self._file = None
self._filename = None
self._version = None
allowed_compressions = [Compression.NONE, Compression.BZ2]
if found_lz4:
allowed_compressions.append(Compression.LZ4)
if compression not in allowed_compressions:
raise ValueError('compression must be one of: %s' % ', '.join(allowed_compressions))
self._compression = compression
if chunk_threshold < 0:
raise ValueError('chunk_threshold must be greater than or equal to zero')
self._chunk_threshold = chunk_threshold
self._skip_index = skip_index
self._reader = None
self._file_header_pos = None
self._index_data_pos = 0 # (1.2+)
self._clear_index()
self._buffer = StringIO()
self._curr_compression = Compression.NONE
self._open(f, mode, allow_unindexed)
self._output_file = self._file
def __iter__(self):
return self.read_messages()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
self.close()
@property
def options(self):
"""Get the options."""
return { 'compression' : self._compression, 'chunk_threshold' : self._chunk_threshold }
@property
def filename(self):
"""Get the filename."""
return self._filename
@property
def version(self):
"""Get the version."""
return self._version
@property
def mode(self):
"""Get the mode."""
return self._mode
@property
def size(self):
"""Get the size in bytes."""
if not self._file:
raise ValueError('I/O operation on closed bag')
pos = self._file.tell()
self._file.seek(0, os.SEEK_END)
size = self._file.tell()
self._file.seek(pos)
return size
# compression
def _get_compression(self):
"""Get the compression method to use for writing."""
return self._compression
def _set_compression(self, compression):
"""Set the compression method to use for writing."""
allowed_compressions = [Compression.NONE, Compression.BZ2]
if found_lz4:
allowed_compressions.append(Compression.LZ4)
if compression not in allowed_compressions:
raise ValueError('compression must be one of: %s' % ', '.join(allowed_compressions))
self.flush()
self._compression = compression
compression = property(_get_compression, _set_compression)
# chunk_threshold
def _get_chunk_threshold(self):
"""Get the chunk threshold to use for writing."""
return self._chunk_threshold
def _set_chunk_threshold(self, chunk_threshold):
"""Set the chunk threshold to use for writing."""
if chunk_threshold < 0:
raise ValueError('chunk_threshold must be greater than or equal to zero')
self.flush()
self._chunk_threshold = chunk_threshold
chunk_threshold = property(_get_chunk_threshold, _set_chunk_threshold)
def read_messages(self, topics=None, start_time=None, end_time=None, connection_filter=None, raw=False):
"""
Read messages from the bag, optionally filtered by topic, timestamp and connection details.
@param topics: list of topics or a single topic. if an empty list is given all topics will be read [optional]
@type topics: list(str) or str
@param start_time: earliest timestamp of message to return [optional]
@type start_time: U{genpy.Time}
@param end_time: latest timestamp of message to return [optional]
@type end_time: U{genpy.Time}
@param connection_filter: function to filter connections to include [optional]
@type connection_filter: function taking (topic, datatype, md5sum, msg_def, header) and returning bool
@param raw: if True, then generate tuples of (datatype, (data, md5sum, position), pytype)
@type raw: bool
@return: generator of (topic, message, timestamp) tuples for each message in the bag file
@rtype: generator of tuples of (str, U{genpy.Message}, U{genpy.Time}) [not raw] or (str, (str, str, str, tuple, class), U{genpy.Time}) [raw]
"""
self.flush()
if topics and type(topics) is str:
topics = [topics]
return self._reader.read_messages(topics, start_time, end_time, connection_filter, raw)
def flush(self):
"""
Write the open chunk to disk so subsequent reads will read all messages.
@raise ValueError: if bag is closed
"""
if not self._file:
raise ValueError('I/O operation on closed bag')
if self._chunk_open:
self._stop_writing_chunk()
def write(self, topic, msg, t=None, raw=False):
"""
Write a message to the bag.
@param topic: name of topic
@type topic: str
@param msg: message to add to bag, or tuple (if raw)
@type msg: Message or tuple of raw message data
@param t: ROS time of message publication, if None specifed, use current time [optional]
@type t: U{genpy.Time}
@param raw: if True, msg is in raw format, i.e. (msg_type, serialized_bytes, md5sum, pytype)
@type raw: bool
@raise ValueError: if arguments are invalid or bag is closed
"""
if not self._file:
raise ValueError('I/O operation on closed bag')
if not topic:
raise ValueError('topic is invalid')
if not msg:
raise ValueError('msg is invalid')
if t is None:
t = genpy.Time.from_sec(time.time())
# Seek to end (in case previous operation was a read)
self._file.seek(0, os.SEEK_END)
# Open a chunk, if needed
if not self._chunk_open:
self._start_writing_chunk(t)
# Unpack raw
if raw:
if len(msg) == 5:
msg_type, serialized_bytes, md5sum, pos, pytype = msg
elif len(msg) == 4:
msg_type, serialized_bytes, md5sum, pytype = msg
else:
raise ValueError('msg must be of length 4 or 5')
# Write connection record, if necessary (currently using a connection per topic; ignoring message connection header)
if topic in self._topic_connections:
connection_info = self._topic_connections[topic]
conn_id = connection_info.id
else:
conn_id = len(self._connections)
if raw:
if pytype is None:
try:
pytype = genpy.message.get_message_class(msg_type)
except Exception:
pytype = None
if pytype is None:
raise ROSBagException('cannot locate message class and no message class provided for [%s]' % msg_type)
if pytype._md5sum != md5sum:
print('WARNING: md5sum of loaded type [%s] does not match that specified' % msg_type, file=sys.stderr)
#raise ROSBagException('md5sum of loaded type does not match that of data being recorded')
header = { 'topic' : topic, 'type' : msg_type, 'md5sum' : md5sum, 'message_definition' : pytype._full_text }
else:
header = { 'topic' : topic, 'type' : msg.__class__._type, 'md5sum' : msg.__class__._md5sum, 'message_definition' : msg._full_text }
connection_info = _ConnectionInfo(conn_id, topic, header)
self._write_connection_record(connection_info)
self._connections[conn_id] = connection_info
self._topic_connections[topic] = connection_info
# Create an index entry
index_entry = _IndexEntry200(t, self._curr_chunk_info.pos, self._get_chunk_offset())
# Update the indexes and current chunk info
if conn_id not in self._curr_chunk_connection_indexes:
# This is the first message on this connection in the chunk
self._curr_chunk_connection_indexes[conn_id] = [index_entry]
self._curr_chunk_info.connection_counts[conn_id] = 1
else:
curr_chunk_connection_index = self._curr_chunk_connection_indexes[conn_id]
if index_entry >= curr_chunk_connection_index[-1]:
# Test if we're writing chronologically. Can skip binary search if so.
curr_chunk_connection_index.append(index_entry)
else:
bisect.insort_right(curr_chunk_connection_index, index_entry)
self._curr_chunk_info.connection_counts[conn_id] += 1
if conn_id not in self._connection_indexes:
self._connection_indexes[conn_id] = [index_entry]
else:
bisect.insort_right(self._connection_indexes[conn_id], index_entry)
# Update the chunk start/end times
if t > self._curr_chunk_info.end_time:
self._curr_chunk_info.end_time = t
elif t < self._curr_chunk_info.start_time:
self._curr_chunk_info.start_time = t
if not raw:
# Serialize the message to the buffer
self._buffer.seek(0)
self._buffer.truncate(0)
msg.serialize(self._buffer)
serialized_bytes = self._buffer.getvalue()
# Write message data record
self._write_message_data_record(conn_id, t, serialized_bytes)
# Check if we want to stop this chunk
chunk_size = self._get_chunk_offset()
if chunk_size > self._chunk_threshold:
self._stop_writing_chunk()
def reindex(self):
"""
Reindexes the bag file. Yields position of each chunk for progress.
"""
self._clear_index()
return self._reader.reindex()
def close(self):
"""
Close the bag file. Closing an already closed bag does nothing.
"""
if self._file:
if self._mode in 'wa':
self._stop_writing()
self._close_file()
def get_compression_info(self):
"""
Returns information about the compression of the bag
@return: generator of CompressionTuple(compression, uncompressed, compressed) describing the
type of compression used, size of the uncompressed data in Bytes, size of the compressed data in Bytes. If
no compression is used then uncompressed and compressed data will be equal.
@rtype: generator of CompressionTuple of (str, int, int)
"""
compression = self.compression
uncompressed = 0
compressed = 0
if self._chunk_headers:
compression_counts = {}
compression_uncompressed = {}
compression_compressed = {}
# the rest of this is determine which compression algorithm is dominant and
# to add up the uncompressed and compressed Bytes
for chunk_header in self._chunk_headers.values():
if chunk_header.compression not in compression_counts:
compression_counts[chunk_header.compression] = 0
if chunk_header.compression not in compression_uncompressed:
compression_uncompressed[chunk_header.compression] = 0
if chunk_header.compression not in compression_compressed:
compression_compressed[chunk_header.compression] = 0
compression_counts[chunk_header.compression] += 1
compression_uncompressed[chunk_header.compression] += chunk_header.uncompressed_size
uncompressed += chunk_header.uncompressed_size
compression_compressed[chunk_header.compression] += chunk_header.compressed_size
compressed += chunk_header.compressed_size
chunk_count = len(self._chunk_headers)
main_compression_count, main_compression = sorted([(v, k) for k, v in compression_counts.items()], reverse=True)[0]
compression = str(main_compression)
return collections.namedtuple("CompressionTuple", ["compression",
"uncompressed", "compressed"])(compression=compression,
uncompressed=uncompressed, compressed=compressed)
def get_message_count(self, topic_filters=None):
"""
Returns the number of messages in the bag. Can be filtered by Topic
@param topic_filters: One or more topics to filter by
@type topic_filters: Could be either a single str or a list of str.
@return: The number of messages in the bag, optionally filtered by topic
@rtype: int
"""
num_messages = 0
if topic_filters is not None:
info = self.get_type_and_topic_info(topic_filters=topic_filters)
for topic in info.topics.values():
num_messages += topic.message_count
else:
if self._chunks:
for c in self._chunks:
for counts in c.connection_counts.values():
num_messages += counts
else:
num_messages = sum([len(index) for index in self._connection_indexes.values()])
return num_messages
def get_start_time(self):
"""
Returns the start time of the bag.
@return: a timestamp of the start of the bag
@rtype: float, timestamp in seconds, includes fractions of a second
"""
if self._chunks:
start_stamp = self._chunks[0].start_time.to_sec()
else:
if not self._connection_indexes:
raise ROSBagException('Bag contains no message')
start_stamp = min([index[0].time.to_sec() for index in self._connection_indexes.values()])
return start_stamp
def get_end_time(self):
"""
Returns the end time of the bag.
@return: a timestamp of the end of the bag
@rtype: float, timestamp in seconds, includes fractions of a second
"""
if self._chunks:
end_stamp = self._chunks[-1].end_time.to_sec()
else:
if not self._connection_indexes:
raise ROSBagException('Bag contains no message')
end_stamp = max([index[-1].time.to_sec() for index in self._connection_indexes.values()])
return end_stamp
def get_type_and_topic_info(self, topic_filters=None):
"""
Coallates info about the type and topics in the bag.
Note, it would be nice to filter by type as well, but there appear to be some limitations in the current architecture
that prevent that from working when more than one message type is written on the same topic.
@param topic_filters: specify one or more topic to filter by.
@type topic_filters: either a single str or a list of str.
@return: generator of TypesAndTopicsTuple(types{key:type name, val: md5hash},
topics{type: msg type (Ex. "std_msgs/String"),
message_count: the number of messages of the particular type,
connections: the number of connections,
frequency: the data frequency,
key: type name,
val: md5hash}) describing the types of messages present
and information about the topics
@rtype: TypesAndTopicsTuple(dict(str, str),
TopicTuple(str, int, int, float, str, str))
"""
datatypes = set()
datatype_infos = []
for connection in self._connections.values():
if connection.datatype in datatypes:
continue
datatype_infos.append((connection.datatype, connection.md5sum, connection.msg_def))
datatypes.add(connection.datatype)
topics = []
# load our list of topics and optionally filter
if topic_filters is not None:
if not isinstance(topic_filters, list):
topic_filters = [topic_filters]
topics = topic_filters
else:
topics = [c.topic for c in self._get_connections()]
topics = sorted(set(topics))
topic_datatypes = {}
topic_conn_counts = {}
topic_msg_counts = {}
topic_freqs_median = {}
for topic in topics:
connections = list(self._get_connections(topic))
if not connections:
continue
topic_datatypes[topic] = connections[0].datatype
topic_conn_counts[topic] = len(connections)
msg_count = 0
for connection in connections:
for chunk in self._chunks:
msg_count += chunk.connection_counts.get(connection.id, 0)
topic_msg_counts[topic] = msg_count
if self._connection_indexes_read:
stamps = [entry.time.to_sec() for entry in self._get_entries(connections)]
if len(stamps) > 1:
periods = [s1 - s0 for s1, s0 in zip(stamps[1:], stamps[:-1])]
med_period = _median(periods)
if med_period > 0.0:
topic_freqs_median[topic] = 1.0 / med_period
# process datatypes
types = {}
for datatype, md5sum, msg_def in sorted(datatype_infos):
types[datatype] = md5sum
# process topics
topics_t = {}
TopicTuple = collections.namedtuple("TopicTuple", ["msg_type", "message_count", "connections", "frequency"])
for topic in sorted(topic_datatypes.keys()):
topic_msg_count = topic_msg_counts[topic]
frequency = topic_freqs_median[topic] if topic in topic_freqs_median else None
topics_t[topic] = TopicTuple(msg_type=topic_datatypes[topic],
message_count=topic_msg_count,
connections=topic_conn_counts[topic],
frequency=frequency)
return collections.namedtuple("TypesAndTopicsTuple", ["msg_types", "topics"])(msg_types=types, topics=topics_t)
def __str__(self):
rows = []
try:
if self._filename:
rows.append(('path', self._filename))
if self._version == 102 and type(self._reader) == _BagReader102_Unindexed:
rows.append(('version', '1.2 (unindexed)'))
else:
rows.append(('version', '%d.%d' % (int(self._version / 100), self._version % 100)))
if not self._connection_indexes and not self._chunks:
rows.append(('size', _human_readable_size(self.size)))
else:
if self._chunks:
start_stamp = self._chunks[ 0].start_time.to_sec()
end_stamp = self._chunks[-1].end_time.to_sec()
else:
start_stamp = min([index[ 0].time.to_sec() for index in self._connection_indexes.values()])
end_stamp = max([index[-1].time.to_sec() for index in self._connection_indexes.values()])
# Show duration
duration = end_stamp - start_stamp
dur_secs = duration % 60
dur_mins = int(duration / 60)
dur_hrs = int(dur_mins / 60)
if dur_hrs > 0:
dur_mins = dur_mins % 60
duration_str = '%dhr %d:%02ds (%ds)' % (dur_hrs, dur_mins, dur_secs, duration)
elif dur_mins > 0:
duration_str = '%d:%02ds (%ds)' % (dur_mins, dur_secs, duration)
else:
duration_str = '%.1fs' % duration
rows.append(('duration', duration_str))
# Show start and end times
rows.append(('start', '%s (%.2f)' % (_time_to_str(start_stamp), start_stamp)))
rows.append(('end', '%s (%.2f)' % (_time_to_str(end_stamp), end_stamp)))
rows.append(('size', _human_readable_size(self.size)))
if self._chunks:
num_messages = 0
for c in self._chunks:
for counts in c.connection_counts.values():
num_messages += counts
else:
num_messages = sum([len(index) for index in self._connection_indexes.values()])
rows.append(('messages', str(num_messages)))
# Show compression information
if len(self._chunk_headers) == 0:
rows.append(('compression', 'none'))
else:
compression_counts = {}
compression_uncompressed = {}
compression_compressed = {}
for chunk_header in self._chunk_headers.values():
if chunk_header.compression not in compression_counts:
compression_counts[chunk_header.compression] = 1
compression_uncompressed[chunk_header.compression] = chunk_header.uncompressed_size
compression_compressed[chunk_header.compression] = chunk_header.compressed_size
else:
compression_counts[chunk_header.compression] += 1
compression_uncompressed[chunk_header.compression] += chunk_header.uncompressed_size
compression_compressed[chunk_header.compression] += chunk_header.compressed_size
chunk_count = len(self._chunk_headers)
compressions = []
for count, compression in reversed(sorted([(v, k) for k, v in compression_counts.items()])):
if compression != Compression.NONE:
fraction = (100.0 * compression_compressed[compression]) / compression_uncompressed[compression]
compressions.append('%s [%d/%d chunks; %.2f%%]' % (compression, count, chunk_count, fraction))
else:
compressions.append('%s [%d/%d chunks]' % (compression, count, chunk_count))
rows.append(('compression', ', '.join(compressions)))
all_uncompressed = (sum([count for c, count in compression_counts.items() if c != Compression.NONE]) == 0)
if not all_uncompressed:
total_uncompressed_size = sum((h.uncompressed_size for h in self._chunk_headers.values()))
total_compressed_size = sum((h.compressed_size for h in self._chunk_headers.values()))
total_uncompressed_size_str = _human_readable_size(total_uncompressed_size)
total_compressed_size_str = _human_readable_size(total_compressed_size)
total_size_str_length = max([len(total_uncompressed_size_str), len(total_compressed_size_str)])
if duration > 0:
uncompressed_rate_str = _human_readable_size(total_uncompressed_size / duration)
compressed_rate_str = _human_readable_size(total_compressed_size / duration)
rate_str_length = max([len(uncompressed_rate_str), len(compressed_rate_str)])
rows.append(('uncompressed', '%*s @ %*s/s' %
(total_size_str_length, total_uncompressed_size_str, rate_str_length, uncompressed_rate_str)))
rows.append(('compressed', '%*s @ %*s/s (%.2f%%)' %
(total_size_str_length, total_compressed_size_str, rate_str_length, compressed_rate_str, (100.0 * total_compressed_size) / total_uncompressed_size)))
else:
rows.append(('uncompressed', '%*s' % (total_size_str_length, total_uncompressed_size_str)))
rows.append(('compressed', '%*s' % (total_size_str_length, total_compressed_size_str)))
datatypes = set()
datatype_infos = []
for connection in self._connections.values():
if connection.datatype in datatypes:
continue
datatype_infos.append((connection.datatype, connection.md5sum, connection.msg_def))
datatypes.add(connection.datatype)
topics = sorted(set([c.topic for c in self._get_connections()]))
topic_datatypes = {}
topic_conn_counts = {}
topic_msg_counts = {}
topic_freqs_median = {}
for topic in topics:
connections = list(self._get_connections(topic))
topic_datatypes[topic] = connections[0].datatype
topic_conn_counts[topic] = len(connections)
msg_count = 0
for connection in connections:
for chunk in self._chunks:
msg_count += chunk.connection_counts.get(connection.id, 0)
topic_msg_counts[topic] = msg_count
if self._connection_indexes_read:
stamps = [entry.time.to_sec() for entry in self._get_entries(connections)]
if len(stamps) > 1:
periods = [s1 - s0 for s1, s0 in zip(stamps[1:], stamps[:-1])]
med_period = _median(periods)
if med_period > 0.0:
topic_freqs_median[topic] = 1.0 / med_period
topics = sorted(topic_datatypes.keys())
max_topic_len = max([len(topic) for topic in topics])
max_datatype_len = max([len(datatype) for datatype in datatypes])
max_msg_count_len = max([len('%d' % msg_count) for msg_count in topic_msg_counts.values()])
max_freq_median_len = max([len(_human_readable_frequency(freq)) for freq in topic_freqs_median.values()]) if len(topic_freqs_median) > 0 else 0
# Show datatypes
for i, (datatype, md5sum, msg_def) in enumerate(sorted(datatype_infos)):
s = '%-*s [%s]' % (max_datatype_len, datatype, md5sum)
if i == 0:
rows.append(('types', s))
else:
rows.append(('', s))
# Show topics
for i, topic in enumerate(topics):
topic_msg_count = topic_msg_counts[topic]
s = '%-*s %*d %s' % (max_topic_len, topic, max_msg_count_len, topic_msg_count, 'msgs' if topic_msg_count > 1 else 'msg ')
if topic in topic_freqs_median:
s += ' @ %*s' % (max_freq_median_len, _human_readable_frequency(topic_freqs_median[topic]))
else:
s += ' %*s' % (max_freq_median_len, '')
s += ' : %-*s' % (max_datatype_len, topic_datatypes[topic])
if topic_conn_counts[topic] > 1:
s += ' (%d connections)' % topic_conn_counts[topic]
if i == 0:
rows.append(('topics', s))
else:
rows.append(('', s))
except Exception as ex:
raise
first_column_width = max([len(field) for field, _ in rows]) + 1
s = ''
for (field, value) in rows:
if field:
s += '%-*s %s\n' % (first_column_width, field + ':', value)
else:
s += '%-*s %s\n' % (first_column_width, '', value)
return s.rstrip()
def _get_yaml_info(self, key=None):
s = ''
try:
if self._filename:
s += 'path: %s\n' % self._filename
if self._version == 102 and type(self._reader) == _BagReader102_Unindexed:
s += 'version: 1.2 (unindexed)\n'
else:
s += 'version: %d.%d\n' % (int(self._version / 100), self._version % 100)
if not self._connection_indexes and not self._chunks:
s += 'size: %d\n' % self.size
s += 'indexed: False\n'
else:
if self._chunks:
start_stamp = self._chunks[ 0].start_time.to_sec()
end_stamp = self._chunks[-1].end_time.to_sec()
else:
start_stamp = min([index[ 0].time.to_sec() for index in self._connection_indexes.values()])
end_stamp = max([index[-1].time.to_sec() for index in self._connection_indexes.values()])
duration = end_stamp - start_stamp
s += 'duration: %.6f\n' % duration
s += 'start: %.6f\n' % start_stamp
s += 'end: %.6f\n' % end_stamp
s += 'size: %d\n' % self.size
if self._chunks:
num_messages = 0
for c in self._chunks:
for counts in c.connection_counts.values():
num_messages += counts
else:
num_messages = sum([len(index) for index in self._connection_indexes.values()])
s += 'messages: %d\n' % num_messages
s += 'indexed: True\n'
# Show compression information
if len(self._chunk_headers) == 0:
s += 'compression: none\n'
else:
compression_counts = {}
compression_uncompressed = {}
compression_compressed = {}
for chunk_header in self._chunk_headers.values():
if chunk_header.compression not in compression_counts:
compression_counts[chunk_header.compression] = 1
compression_uncompressed[chunk_header.compression] = chunk_header.uncompressed_size
compression_compressed[chunk_header.compression] = chunk_header.compressed_size
else:
compression_counts[chunk_header.compression] += 1
compression_uncompressed[chunk_header.compression] += chunk_header.uncompressed_size
compression_compressed[chunk_header.compression] += chunk_header.compressed_size
chunk_count = len(self._chunk_headers)
main_compression_count, main_compression = list(reversed(sorted([(v, k) for k, v in compression_counts.items()])))[0]
s += 'compression: %s\n' % str(main_compression)
all_uncompressed = (sum([count for c, count in compression_counts.items() if c != Compression.NONE]) == 0)
if not all_uncompressed:
s += 'uncompressed: %d\n' % sum((h.uncompressed_size for h in self._chunk_headers.values()))
s += 'compressed: %d\n' % sum((h.compressed_size for h in self._chunk_headers.values()))
datatypes = set()
datatype_infos = []
for connection in self._connections.values():
if connection.datatype in datatypes:
continue
datatype_infos.append((connection.datatype, connection.md5sum, connection.msg_def))
datatypes.add(connection.datatype)
topics = sorted(set([c.topic for c in self._get_connections()]))
topic_datatypes = {}
topic_conn_counts = {}
topic_msg_counts = {}
topic_freqs_median = {}
for topic in topics:
connections = list(self._get_connections(topic))
topic_datatypes[topic] = connections[0].datatype
topic_conn_counts[topic] = len(connections)
msg_count = 0
for connection in connections:
for chunk in self._chunks:
msg_count += chunk.connection_counts.get(connection.id, 0)
topic_msg_counts[topic] = msg_count
if self._connection_indexes_read:
stamps = [entry.time.to_sec() for entry in self._get_entries(connections)]
if len(stamps) > 1:
periods = [s1 - s0 for s1, s0 in zip(stamps[1:], stamps[:-1])]
med_period = _median(periods)
if med_period > 0.0:
topic_freqs_median[topic] = 1.0 / med_period
topics = sorted(topic_datatypes.keys())
max_topic_len = max([len(topic) for topic in topics])
max_datatype_len = max([len(datatype) for datatype in datatypes])
max_msg_count_len = max([len('%d' % msg_count) for msg_count in topic_msg_counts.values()])
max_freq_median_len = max([len(_human_readable_frequency(freq)) for freq in topic_freqs_median.values()]) if len(topic_freqs_median) > 0 else 0
# Show datatypes
s += 'types:\n'
for i, (datatype, md5sum, msg_def) in enumerate(sorted(datatype_infos)):
s += ' - type: %s\n' % datatype
s += ' md5: %s\n' % md5sum
# Show topics
s += 'topics:\n'
for i, topic in enumerate(topics):
topic_msg_count = topic_msg_counts[topic]
s += ' - topic: %s\n' % topic
s += ' type: %s\n' % topic_datatypes[topic]
s += ' messages: %d\n' % topic_msg_count
if topic_conn_counts[topic] > 1:
s += ' connections: %d\n' % topic_conn_counts[topic]
if topic in topic_freqs_median:
s += ' frequency: %.4f\n' % topic_freqs_median[topic]
if not key:
return s
class DictObject(object):
def __init__(self, d):
for a, b in d.items():
if isinstance(b, (list, tuple)):
setattr(self, a, [DictObject(x) if isinstance(x, dict) else x for x in b])
else:
setattr(self, a, DictObject(b) if isinstance(b, dict) else b)
obj = DictObject(yaml.load(s))
try:
val = eval('obj.' + key)
except Exception as ex:
print('Error getting key "%s"' % key, file=sys.stderr)
return None
def print_yaml(val, indent=0):
indent_str = ' ' * indent
if type(val) is list:
s = ''
for item in val:
s += '%s- %s\n' % (indent_str, print_yaml(item, indent + 1))
return s
elif type(val) is DictObject:
s = ''
for i, (k, v) in enumerate(val.__dict__.items()):
if i != 0:
s += indent_str
s += '%s: %s' % (k, str(v))
if i < len(val.__dict__) - 1:
s += '\n'
return s
else:
return indent_str + str(val)
return print_yaml(val)
except Exception as ex:
raise
### Internal API ###
@property
def _has_compressed_chunks(self):
if not self._chunk_headers:
return False
return any((h.compression != Compression.NONE for h in self._chunk_headers.values()))
@property
def _uncompressed_size(self):
if not self._chunk_headers:
return self.size
return sum((h.uncompressed_size for h in self._chunk_headers.values()))
def _read_message(self, position, raw=False):
"""
Read the message from the given position in the file.
"""
self.flush()
return self._reader.seek_and_read_message_data_record(position, raw)
# Index accessing
def _get_connections(self, topics=None, connection_filter=None):
"""
Yield the connections, optionally filtering by topic and/or connection information.
"""
if topics:
if type(topics) is str:
topics = set([roslib.names.canonicalize_name(topics)])
else:
topics = set([roslib.names.canonicalize_name(t) for t in topics])
for c in self._connections.values():
if topics and c.topic not in topics and roslib.names.canonicalize_name(c.topic) not in topics:
continue
if connection_filter and not connection_filter(c.topic, c.datatype, c.md5sum, c.msg_def, c.header):
continue
yield c
def _get_entries(self, connections=None, start_time=None, end_time=None):
"""
Yield index entries on the given connections in the given time range.
"""
for entry, _ in _mergesort(self._get_indexes(connections), key=lambda entry: entry.time):
if start_time and entry.time < start_time:
continue
if end_time and entry.time > end_time:
return
yield entry
def _get_entries_reverse(self, connections=None, start_time=None, end_time=None):
"""
Yield index entries on the given connections in the given time range in reverse order.
"""
for entry, _ in _mergesort((reversed(index) for index in self._get_indexes(connections)), key=lambda entry: -entry.time.to_sec()):
if end_time and entry.time > end_time:
continue
if start_time and entry.time < start_time:
return
yield entry
def _get_entry(self, t, connections=None):
"""
Return the first index entry on/before the given time on the given connections
"""
indexes = self._get_indexes(connections)
entry = _IndexEntry(t)
first_entry = None
for index in indexes:
i = bisect.bisect_right(index, entry) - 1
if i >= 0:
index_entry = index[i]
if first_entry is None or index_entry > first_entry:
first_entry = index_entry
return first_entry
def _get_entry_after(self, t, connections=None):
"""
Return the first index entry after the given time on the given connections
"""
indexes = self._get_indexes(connections)
entry = _IndexEntry(t)
first_entry = None
for index in indexes:
i = bisect.bisect_right(index, entry)
if i <= len(index) - 1:
index_entry = index[i]
if first_entry is None or index_entry < first_entry:
first_entry = index_entry
return first_entry
def _get_indexes(self, connections):
"""
Get the indexes for the given connections.
"""
if not self._connection_indexes_read:
self._reader._read_connection_index_records()
if connections is None:
return self._connection_indexes.values()
else:
return (self._connection_indexes[c.id] for c in connections)
### Implementation ###
def _clear_index(self):
self._connection_indexes_read = False
self._connection_indexes = {} # id -> IndexEntry[] (1.2+)
self._topic_connections = {} # topic -> connection_id
self._connections = {} # id -> ConnectionInfo
self._connection_count = 0 # (2.0)
self._chunk_count = 0 # (2.0)
self._chunks = [] # ChunkInfo[] (2.0)
self._chunk_headers = {} # chunk_pos -> ChunkHeader (2.0)
self._chunk_open = False
self._curr_chunk_info = None
self._curr_chunk_data_pos = None
self._curr_chunk_connection_indexes = {}
def _open(self, f, mode, allow_unindexed):
if not f:
raise ValueError('filename (or stream) is invalid')
try:
if mode == 'r': self._open_read(f, allow_unindexed)
elif mode == 'w': self._open_write(f)
elif mode == 'a': self._open_append(f, allow_unindexed)
else:
raise ValueError('mode "%s" is invalid' % mode)
if 'b' not in self._file.mode and not isinstance('', bytes):
raise ROSBagException('In Python 3 the bag file must be opened in binary mode')
except struct.error:
raise ROSBagFormatException('error with bag')
def _is_file(self, f):
try:
return isinstance(f, file) # Python 2
except NameError:
import io
return isinstance(f, io.IOBase) # Python 3...this will return false in Python 2 always
def _open_read(self, f, allow_unindexed):
if self._is_file(f):
self._file = f
self._filename = None
else:
self._file = open(f, 'rb')
self._filename = f
self._mode = 'r'
try:
self._version = self._read_version()
except:
self._version = None
self._close_file()
raise
try:
self._create_reader()
self._reader.start_reading()
except ROSBagUnindexedException as ex:
if not allow_unindexed:
self._close_file()
raise
except:
self._close_file()
raise
def _open_write(self, f):
if self._is_file(f):
self._file = f
self._filename = None
else:
self._file = open(f, 'w+b')
self._filename = f
self._mode = 'w'
self._version = 200
try:
self._create_reader()
self._start_writing()
except:
self._close_file()
raise
def _open_append(self, f, allow_unindexed):
if self._is_file(f):
self._file = f
self._filename = None
else:
try:
# Test if the file already exists
open(f, 'r').close()
# File exists: open in read with update mode
self._file = open(f, 'r+b')
except IOError:
# File doesn't exist: open in write mode
self._file = open(f, 'w+b')
self._filename = f
self._mode = 'a'
try:
self._version = self._read_version()
except:
self._version = None
self._close_file()
raise
if self._version != 200:
self._file.close()
raise ROSBagException('bag version %d is unsupported for appending' % self._version)
try:
self._start_appending()
except ROSBagUnindexedException:
if not allow_unindexed:
self._close_file()
raise
except:
self._close_file()
raise
def _close_file(self):
self._file.close()
self._file = None
def _create_reader(self):
"""
@raise ROSBagException: if the bag version is unsupported
"""
major_version, minor_version = int(self._version / 100), self._version % 100
if major_version == 2:
self._reader = _BagReader200(self)
elif major_version == 1:
if minor_version == 1:
raise ROSBagException('unsupported bag version %d. Please convert bag to newer format.' % self._version)
else:
# Get the op code of the first record. If it's FILE_HEADER, then we have an indexed 1.2 bag.
first_record_pos = self._file.tell()
header = _read_header(self._file)
op = _read_uint8_field(header, 'op')
self._file.seek(first_record_pos)
if op == _OP_FILE_HEADER:
self._reader = _BagReader102_Indexed(self)
else:
self._reader = _BagReader102_Unindexed(self)
else:
raise ROSBagException('unknown bag version %d' % self._version)
def _read_version(self):
"""
@raise ROSBagException: if the file is empty, or the version line can't be parsed
"""
version_line = self._file.readline().rstrip().decode()
if len(version_line) == 0:
raise ROSBagException('empty file')
matches = re.match("#ROS(.*) V(\d).(\d)", version_line)
if matches is None or len(matches.groups()) != 3:
raise ROSBagException('This does not appear to be a bag file')
version_type, major_version_str, minor_version_str = matches.groups()
version = int(major_version_str) * 100 + int(minor_version_str)
return version
def _start_writing(self):
version = _VERSION + '\n'
version = version.encode()
self._file.write(version)
self._file_header_pos = self._file.tell()
self._write_file_header_record(0, 0, 0)
def _stop_writing(self):
# Write the open chunk (if any) to file
self.flush()
# Remember this location as the start of the index
self._index_data_pos = self._file.tell()
# Write connection infos
for connection_info in self._connections.values():
self._write_connection_record(connection_info)
# Write chunk infos
for chunk_info in self._chunks:
self._write_chunk_info_record(chunk_info)
# Re-write the file header
self._file.seek(self._file_header_pos)
self._write_file_header_record(self._index_data_pos, len(self._connections), len(self._chunks))
def _start_appending(self):
self._file_header_pos = self._file.tell()
self._create_reader()
self._reader.start_reading()
# Truncate the file to chop off the index
self._file.truncate(self._index_data_pos)
self._reader.index_data_pos = 0
# Rewrite the file header, clearing the index position (so we know if the index is invalid)
self._file.seek(self._file_header_pos);
self._write_file_header_record(0, 0, 0)
# Seek to the end of the file
self._file.seek(0, os.SEEK_END)
def _start_writing_chunk(self, t):
self._curr_chunk_info = _ChunkInfo(self._file.tell(), t, t)
self._write_chunk_header(_ChunkHeader(self._compression, 0, 0))
self._curr_chunk_data_pos = self._file.tell()
self._set_compression_mode(self._compression)
self._chunk_open = True
def _get_chunk_offset(self):
if self._compression == Compression.NONE:
return self._file.tell() - self._curr_chunk_data_pos
else:
return self._output_file.compressed_bytes_in
def _stop_writing_chunk(self):
# Add this chunk to the index
self._chunks.append(self._curr_chunk_info)
# Get the uncompressed and compressed sizes
uncompressed_size = self._get_chunk_offset()
self._set_compression_mode(Compression.NONE)
compressed_size = self._file.tell() - self._curr_chunk_data_pos
# Rewrite the chunk header with the size of the chunk (remembering current offset)
end_of_chunk_pos = self._file.tell()
self._file.seek(self._curr_chunk_info.pos)
chunk_header = _ChunkHeader(self._compression, compressed_size, uncompressed_size, self._curr_chunk_data_pos)
self._write_chunk_header(chunk_header)
self._chunk_headers[self._curr_chunk_info.pos] = chunk_header
# Write out the connection indexes and clear them
self._file.seek(end_of_chunk_pos)
for connection_id, entries in self._curr_chunk_connection_indexes.items():
self._write_connection_index_record(connection_id, entries)
self._curr_chunk_connection_indexes.clear()
# Flag that we're starting a new chunk
self._chunk_open = False
def _set_compression_mode(self, compression):
# Flush the compressor, if needed
if self._curr_compression != Compression.NONE:
self._output_file.flush()
# Create the compressor
if compression == Compression.BZ2:
self._output_file = _CompressorFileFacade(self._file, bz2.BZ2Compressor())
elif compression == Compression.LZ4 and found_lz4:
self._output_file = _CompressorFileFacade(self._file, roslz4.LZ4Compressor())
elif compression == Compression.NONE:
self._output_file = self._file
else:
raise ROSBagException('unsupported compression type: %s' % compression)
self._curr_compression = compression
def _write_file_header_record(self, index_pos, connection_count, chunk_count):
header = {
'op': _pack_uint8(_OP_FILE_HEADER),
'index_pos': _pack_uint64(index_pos),
'conn_count': _pack_uint32(connection_count),
'chunk_count': _pack_uint32(chunk_count)
}
_write_record(self._file, header, padded_size=_FILE_HEADER_LENGTH)
def _write_connection_record(self, connection_info):
header = {
'op': _pack_uint8(_OP_CONNECTION),
'topic': connection_info.topic,
'conn': _pack_uint32(connection_info.id)
}
_write_header(self._output_file, header)
_write_header(self._output_file, connection_info.header)
def _write_message_data_record(self, connection_id, t, serialized_bytes):
header = {
'op': _pack_uint8(_OP_MSG_DATA),
'conn': _pack_uint32(connection_id),
'time': _pack_time(t)
}
_write_record(self._output_file, header, serialized_bytes)
def _write_chunk_header(self, chunk_header):
header = {
'op': _pack_uint8(_OP_CHUNK),
'compression': chunk_header.compression,
'size': _pack_uint32(chunk_header.uncompressed_size)
}
_write_header(self._file, header)
self._file.write(_pack_uint32(chunk_header.compressed_size))
def _write_connection_index_record(self, connection_id, entries):
header = {
'op': _pack_uint8(_OP_INDEX_DATA),
'conn': _pack_uint32(connection_id),
'ver': _pack_uint32(_INDEX_VERSION),
'count': _pack_uint32(len(entries))
}
buffer = self._buffer
buffer.seek(0)
buffer.truncate(0)
for entry in entries:
buffer.write(_pack_time (entry.time))
buffer.write(_pack_uint32(entry.offset))
_write_record(self._file, header, buffer.getvalue())
def _write_chunk_info_record(self, chunk_info):
header = {
'op': _pack_uint8 (_OP_CHUNK_INFO),
'ver': _pack_uint32(_CHUNK_INDEX_VERSION),
'chunk_pos': _pack_uint64(chunk_info.pos),
'start_time': _pack_time(chunk_info.start_time),
'end_time': _pack_time(chunk_info.end_time),
'count': _pack_uint32(len(chunk_info.connection_counts))
}
buffer = self._buffer
buffer.seek(0)
buffer.truncate(0)
for connection_id, count in chunk_info.connection_counts.items():
buffer.write(_pack_uint32(connection_id))
buffer.write(_pack_uint32(count))
_write_record(self._file, header, buffer.getvalue())
### Implementation ###
_message_types = {} # md5sum -> type
_OP_MSG_DEF = 0x01
_OP_MSG_DATA = 0x02
_OP_FILE_HEADER = 0x03
_OP_INDEX_DATA = 0x04
_OP_CHUNK = 0x05
_OP_CHUNK_INFO = 0x06
_OP_CONNECTION = 0x07
_OP_CODES = {
_OP_MSG_DEF: 'MSG_DEF',
_OP_MSG_DATA: 'MSG_DATA',
_OP_FILE_HEADER: 'FILE_HEADER',
_OP_INDEX_DATA: 'INDEX_DATA',
_OP_CHUNK: 'CHUNK',
_OP_CHUNK_INFO: 'CHUNK_INFO',
_OP_CONNECTION: 'CONNECTION'
}
_VERSION = '#ROSBAG V2.0'
_FILE_HEADER_LENGTH = 4096
_INDEX_VERSION = 1
_CHUNK_INDEX_VERSION = 1
class _ConnectionInfo(object):
def __init__(self, id, topic, header):
try:
datatype = _read_str_field(header, 'type')
md5sum = _read_str_field(header, 'md5sum')
msg_def = _read_str_field(header, 'message_definition')
except KeyError as ex:
raise ROSBagFormatException('connection header field %s not found' % str(ex))
self.id = id
self.topic = topic
self.datatype = datatype
self.md5sum = md5sum
self.msg_def = msg_def
self.header = header
def __str__(self):
return '%d on %s: %s' % (self.id, self.topic, str(self.header))
class _ChunkInfo(object):
def __init__(self, pos, start_time, end_time):
self.pos = pos
self.start_time = start_time
self.end_time = end_time
self.connection_counts = {}
def __str__(self):
s = 'chunk_pos: %d\n' % self.pos
s += 'start_time: %s\n' % str(self.start_time)
s += 'end_time: %s\n' % str(self.end_time)
s += 'connections: %d\n' % len(self.connection_counts)
s += '\n'.join([' - [%4d] %d' % (connection_id, count) for connection_id, count in self.connection_counts.items()])
return s
class _ChunkHeader(object):
def __init__(self, compression, compressed_size, uncompressed_size, data_pos=0):
self.compression = compression
self.compressed_size = compressed_size
self.uncompressed_size = uncompressed_size
self.data_pos = data_pos
def __str__(self):
if self.uncompressed_size > 0:
ratio = 100 * (float(self.compressed_size) / self.uncompressed_size)
return 'compression: %s, size: %d, uncompressed: %d (%.2f%%)' % (self.compression, self.compressed_size, self.uncompressed_size, ratio)
else:
return 'compression: %s, size: %d, uncompressed: %d' % (self.compression, self.compressed_size, self.uncompressed_size)
class ComparableMixin(object):
__slots__ = []
def _compare(self, other, method):
try:
return method(self._cmpkey(), other._cmpkey())
except (AttributeError, TypeError):
# _cmpkey not implemented or return different type
# so can not compare with other
return NotImplemented
def __lt__(self, other):
return self._compare(other, lambda s, o: s < o)
def __le__(self, other):
return self._compare(other, lambda s, o: s <= o)
def __eq__(self, other):
return self._compare(other, lambda s, o: s == o)
def __ge__(self, other):
return self._compare(other, lambda s, o: s >= o)
def __gt__(self, other):
return self._compare(other, lambda s, o: s > o)
def __ne__(self, other):
return self._compare(other, lambda s, o: s != o)
class _IndexEntry(ComparableMixin):
__slots__ = ['time']
def __init__(self, time):
self.time = time
def _cmpkey(self):
return self.time
class _IndexEntry102(_IndexEntry):
__slots__ = ['offset']
def __init__(self, time, offset):
self.time = time
self.offset = offset
@property
def position(self):
return self.offset
def __str__(self):
return '%d.%d: %d' % (self.time.secs, self.time.nsecs, self.offset)
class _IndexEntry200(_IndexEntry):
__slots__ = ['chunk_pos', 'offset']
def __init__(self, time, chunk_pos, offset):
self.time = time
self.chunk_pos = chunk_pos
self.offset = offset
@property
def position(self):
return (self.chunk_pos, self.offset)
def __str__(self):
return '%d.%d: %d+%d' % (self.time.secs, self.time.nsecs, self.chunk_pos, self.offset)
def _get_message_type(info):
message_type = _message_types.get(info.md5sum)
if message_type is None:
try:
message_type = genpy.dynamic.generate_dynamic(info.datatype, info.msg_def)[info.datatype]
if (message_type._md5sum != info.md5sum):
print('WARNING: For type [%s] stored md5sum [%s] does not match message definition [%s].\n Try: "rosrun rosbag fix_msg_defs.py old_bag new_bag."'%(info.datatype, info.md5sum, message_type._md5sum), file=sys.stderr)
except genmsg.InvalidMsgSpec:
message_type = genpy.dynamic.generate_dynamic(info.datatype, "")[info.datatype]
print('WARNING: For type [%s] stored md5sum [%s] has invalid message definition."'%(info.datatype, info.md5sum), file=sys.stderr)
except genmsg.MsgGenerationException as ex:
raise ROSBagException('Error generating datatype %s: %s' % (info.datatype, str(ex)))
_message_types[info.md5sum] = message_type
return message_type
def _read_uint8 (f): return _unpack_uint8 (f.read(1))
def _read_uint32(f): return _unpack_uint32(f.read(4))
def _read_uint64(f): return _unpack_uint64(f.read(8))
def _read_time (f): return _unpack_time (f.read(8))
def _unpack_uint8(v): return struct.unpack('<B', v)[0]
def _unpack_uint32(v): return struct.unpack('<L', v)[0]
def _unpack_uint64(v): return struct.unpack('<Q', v)[0]
def _unpack_time(v): return rospy.Time(*struct.unpack('<LL', v))
def _pack_uint8(v): return struct.pack('<B', v)
def _pack_uint32(v): return struct.pack('<L', v)
def _pack_uint64(v): return struct.pack('<Q', v)
def _pack_time(v): return _pack_uint32(v.secs) + _pack_uint32(v.nsecs)
def _read(f, size):
data = f.read(size)
if len(data) != size:
raise ROSBagException('expecting %d bytes, read %d' % (size, len(data)))
return data
def _skip_record(f):
_skip_sized(f) # skip header
_skip_sized(f) # skip data
def _skip_sized(f):
size = _read_uint32(f)
f.seek(size, os.SEEK_CUR)
def _read_sized(f):
try:
size = _read_uint32(f)
except struct.error as ex:
raise ROSBagFormatException('error unpacking uint32: %s' % str(ex))
return _read(f, size)
def _write_sized(f, v):
if not isinstance(v, bytes):
v = v.encode()
f.write(_pack_uint32(len(v)))
f.write(v)
def _read_field(header, field, unpack_fn):
if field not in header:
raise ROSBagFormatException('expected "%s" field in record' % field)
try:
value = unpack_fn(header[field])
except Exception as ex:
raise ROSBagFormatException('error reading field "%s": %s' % (field, str(ex)))
return value
def _read_str_field (header, field):
return _read_field(header, field, lambda v: v)
def _read_uint8_field (header, field): return _read_field(header, field, _unpack_uint8)
def _read_uint32_field(header, field): return _read_field(header, field, _unpack_uint32)
def _read_uint64_field(header, field): return _read_field(header, field, _unpack_uint64)
def _read_time_field (header, field): return _read_field(header, field, _unpack_time)
def _write_record(f, header, data='', padded_size=None):
header_str = _write_header(f, header)
if padded_size is not None:
header_len = len(header_str)
if header_len < padded_size:
data = ' ' * (padded_size - header_len)
else:
data = ''
_write_sized(f, data)
def _write_header(f, header):
header_str = b''
equal = b'='
for k, v in header.items():
if not isinstance(k, bytes):
k = k.encode()
if not isinstance(v, bytes):
v = v.encode()
header_str += _pack_uint32(len(k) + 1 + len(v)) + k + equal + v
_write_sized(f, header_str)
return header_str
def _read_header(f, req_op=None):
bag_pos = f.tell()
# Read header
try:
header = _read_sized(f)
except ROSBagException as ex:
raise ROSBagFormatException('Error reading header: %s' % str(ex))
# Parse header into a dict
header_dict = {}
while header != b'':
# Read size
if len(header) < 4:
raise ROSBagFormatException('Error reading header field')
(size,) = struct.unpack('<L', header[:4]) # @todo reindex: catch struct.error
header = header[4:]
# Read bytes
if len(header) < size:
raise ROSBagFormatException('Error reading header field: expected %d bytes, read %d' % (size, len(header)))
(name, sep, value) = header[:size].partition(b'=')
if sep == b'':
raise ROSBagFormatException('Error reading header field')
name = name.decode()
header_dict[name] = value # @todo reindex: raise exception on empty name
header = header[size:]
# Check the op code of the header, if supplied
if req_op is not None:
op = _read_uint8_field(header_dict, 'op')
if req_op != op:
raise ROSBagFormatException('Expected op code: %s, got %s' % (_OP_CODES[req_op], _OP_CODES[op]))
return header_dict
def _peek_next_header_op(f):
pos = f.tell()
header = _read_header(f)
op = _read_uint8_field(header, 'op')
f.seek(pos)
return op
def _read_record_data(f):
try:
record_data = _read_sized(f)
except ROSBagException as ex:
raise ROSBagFormatException('Error reading record data: %s' % str(ex))
return record_data
class _BagReader(object):
def __init__(self, bag):
self.bag = bag
def start_reading(self):
raise NotImplementedError()
def read_messages(self, topics, start_time, end_time, connection_filter, raw):
raise NotImplementedError()
def reindex(self):
raise NotImplementedError()
class _BagReader102_Unindexed(_BagReader):
"""
Support class for reading unindexed v1.2 bag files.
"""
def __init__(self, bag):
_BagReader.__init__(self, bag)
def start_reading(self):
self.bag._file_header_pos = self.bag._file.tell()
def reindex(self):
"""Generates all bag index information by rereading the message records."""
f = self.bag._file
total_bytes = self.bag.size
# Re-read the file header to get to the start of the first message
self.bag._file.seek(self.bag._file_header_pos)
offset = f.tell()
# Read message definition and data records
while offset < total_bytes:
yield offset
op = _peek_next_header_op(f)
if op == _OP_MSG_DEF:
connection_info = self.read_message_definition_record()
if connection_info.topic not in self.bag._topic_connections:
self.bag._topic_connections[connection_info.topic] = connection_info.id
self.bag._connections[connection_info.id] = connection_info
self.bag._connection_indexes[connection_info.id] = []
elif op == _OP_MSG_DATA:
# Read the topic and timestamp from the header
header = _read_header(f)
topic = _read_str_field(header, 'topic')
secs = _read_uint32_field(header, 'sec')
nsecs = _read_uint32_field(header, 'nsec')
t = genpy.Time(secs, nsecs)
if topic not in self.bag._topic_connections:
datatype = _read_str_field(header, 'type')
self._create_connection_info_for_datatype(topic, datatype)
connection_id = self.bag._topic_connections[topic]
info = self.bag._connections[connection_id]
# Skip over the message content
_skip_sized(f)
# Insert the message entry (in order) into the connection index
bisect.insort_right(self.bag._connection_indexes[connection_id], _IndexEntry102(t, offset))
offset = f.tell()
def read_messages(self, topics, start_time, end_time, topic_filter, raw):
f = self.bag._file
f.seek(self.bag._file_header_pos)
while True:
# Read MSG_DEF records
while True:
position = f.tell()
try:
header = _read_header(f)
except Exception:
return
op = _read_uint8_field(header, 'op')
if op != _OP_MSG_DEF:
break
connection_info = self.read_message_definition_record(header)
if connection_info.topic not in self.bag._topic_connections:
self.bag._topic_connections[connection_info.topic] = connection_info.id
self.bag._connections[connection_info.id] = connection_info
# Check that we have a MSG_DATA record
if op != _OP_MSG_DATA:
raise ROSBagFormatException('Expecting OP_MSG_DATA, got %d' % op)
topic = _read_str_field(header, 'topic')
if topic not in self.bag._topic_connections:
datatype = _read_str_field(header, 'type')
self._create_connection_info_for_datatype(topic, datatype)
connection_id = self.bag._topic_connections[topic]
info = self.bag._connections[connection_id]
# Get the message type
try:
msg_type = _get_message_type(info)
except KeyError:
raise ROSBagException('Cannot deserialize messages of type [%s]. Message was not preceeded in bagfile by definition' % info.datatype)
# Get the timestamp
secs = _read_uint32_field(header, 'sec')
nsecs = _read_uint32_field(header, 'nsec')
t = genpy.Time(secs, nsecs)
# Read the message content
data = _read_record_data(f)
if raw:
msg = (info.datatype, data, info.md5sum, position, msg_type)
else:
# Deserialize the message
msg = msg_type()
msg.deserialize(data)
yield (topic, msg, t)
self.bag._connection_indexes_read = True
def _create_connection_info_for_datatype(self, topic, datatype):
for c in self.bag._connections.values():
if c.datatype == datatype:
connection_id = len(self.bag._connections)
connection_header = { 'topic' : topic, 'type' : c.header['type'], 'md5sum' : c.header['md5sum'], 'message_definition' : c.header['message_definition'] }
connection_info = _ConnectionInfo(connection_id, topic, connection_header)
self.bag._topic_connections[topic] = connection_id
self.bag._connections[connection_id] = connection_info
self.bag._connection_indexes[connection_id] = []
return
raise ROSBagFormatException('Topic %s of datatype %s not preceded by message definition' % (topic, datatype))
def read_message_definition_record(self, header=None):
if not header:
header = _read_header(self.bag._file, _OP_MSG_DEF)
topic = _read_str_field(header, 'topic')
datatype = _read_str_field(header, 'type')
md5sum = _read_str_field(header, 'md5')
msg_def = _read_str_field(header, 'def')
_skip_sized(self.bag._file) # skip the record data
connection_header = { 'topic' : topic, 'type' : datatype, 'md5sum' : md5sum, 'message_definition' : msg_def }
id = len(self.bag._connections)
return _ConnectionInfo(id, topic, connection_header)
class _BagReader102_Indexed(_BagReader102_Unindexed):
"""
Support class for reading indexed v1.2 bag files.
"""
def __init__(self, bag):
_BagReader.__init__(self, bag)
def read_messages(self, topics, start_time, end_time, connection_filter, raw):
connections = self.bag._get_connections(topics, connection_filter)
for entry in self.bag._get_entries(connections, start_time, end_time):
yield self.seek_and_read_message_data_record(entry.offset, raw)
def reindex(self):
"""Generates all bag index information by rereading the message records."""
f = self.bag._file
total_bytes = self.bag.size
# Re-read the file header to get to the start of the first message
self.bag._file.seek(self.bag._file_header_pos)
self.read_file_header_record()
offset = f.tell()
# Read message definition and data records
while offset < total_bytes:
yield offset
op = _peek_next_header_op(f)
if op == _OP_MSG_DEF:
connection_info = self.read_message_definition_record()
if connection_info.topic not in self.bag._topic_connections:
self.bag._topic_connections[connection_info.topic] = connection_info.id
self.bag._connections[connection_info.id] = connection_info
self.bag._connection_indexes[connection_info.id] = []
elif op == _OP_MSG_DATA:
# Read the topic and timestamp from the header
header = _read_header(f)
topic = _read_str_field(header, 'topic')
secs = _read_uint32_field(header, 'sec')
nsecs = _read_uint32_field(header, 'nsec')
t = genpy.Time(secs, nsecs)
if topic not in self.bag._topic_connections:
datatype = _read_str_field(header, 'type')
self._create_connection_info_for_datatype(topic, datatype)
connection_id = self.bag._topic_connections[topic]
info = self.bag._connections[connection_id]
# Skip over the message content
_skip_sized(f)
# Insert the message entry (in order) into the connection index
bisect.insort_right(self.bag._connection_indexes[connection_id], _IndexEntry102(t, offset))
elif op == _OP_INDEX_DATA:
_skip_record(f)
offset = f.tell()
def start_reading(self):
try:
# Read the file header
self.read_file_header_record()
total_bytes = self.bag.size
# Check if the index position has been written, i.e. the bag was closed successfully
if self.bag._index_data_pos == 0:
raise ROSBagUnindexedException()
# Seek to the beginning of the topic index records
self.bag._file.seek(self.bag._index_data_pos)
# Read the topic indexes
topic_indexes = {}
while True:
pos = self.bag._file.tell()
if pos >= total_bytes:
break
topic, index = self.read_topic_index_record()
topic_indexes[topic] = index
# Read the message definition records (one for each topic)
for topic, index in topic_indexes.items():
self.bag._file.seek(index[0].offset)
connection_info = self.read_message_definition_record()
if connection_info.topic not in self.bag._topic_connections:
self.bag._topic_connections[connection_info.topic] = connection_info.id
self.bag._connections[connection_info.id] = connection_info
self.bag._connection_indexes[connection_info.id] = index
self.bag._connection_indexes_read = True
except Exception as ex:
raise ROSBagUnindexedException()
def read_file_header_record(self):
self.bag._file_header_pos = self.bag._file.tell()
header = _read_header(self.bag._file, _OP_FILE_HEADER)
self.bag._index_data_pos = _read_uint64_field(header, 'index_pos')
_skip_sized(self.bag._file) # skip the record data, i.e. padding
def read_topic_index_record(self):
f = self.bag._file
header = _read_header(f, _OP_INDEX_DATA)
index_version = _read_uint32_field(header, 'ver')
topic = _read_str_field (header, 'topic')
count = _read_uint32_field(header, 'count')
if index_version != 0:
raise ROSBagFormatException('expecting index version 0, got %d' % index_version)
_read_uint32(f) # skip the record data size
topic_index = []
for i in range(count):
time = _read_time (f)
offset = _read_uint64(f)
topic_index.append(_IndexEntry102(time, offset))
return (topic, topic_index)
def seek_and_read_message_data_record(self, position, raw):
f = self.bag._file
# Seek to the message position
f.seek(position)
# Skip any MSG_DEF records
while True:
header = _read_header(f)
op = _read_uint8_field(header, 'op')
if op != _OP_MSG_DEF:
break
_skip_sized(f)
# Check that we have a MSG_DATA record
if op != _OP_MSG_DATA:
raise ROSBagFormatException('Expecting OP_MSG_DATA, got %d' % op)
topic = _read_str_field(header, 'topic')
connection_id = self.bag._topic_connections[topic]
info = self.bag._connections[connection_id]
# Get the message type
try:
msg_type = _get_message_type(info)
except KeyError:
raise ROSBagException('Cannot deserialize messages of type [%s]. Message was not preceeded in bagfile by definition' % info.datatype)
# Get the timestamp
secs = _read_uint32_field(header, 'sec')
nsecs = _read_uint32_field(header, 'nsec')
t = genpy.Time(secs, nsecs)
# Read the message content
data = _read_record_data(f)
if raw:
msg = info.datatype, data, info.md5sum, position, msg_type
else:
# Deserialize the message
msg = msg_type()
msg.deserialize(data)
return (topic, msg, t)
class _BagReader200(_BagReader):
"""
Support class for reading v2.0 bag files.
"""
def __init__(self, bag):
_BagReader.__init__(self, bag)
self.decompressed_chunk_pos = None
self.decompressed_chunk = None
self.decompressed_chunk_io = None
def reindex(self):
"""
Generates all bag index information by rereading the chunks.
Assumes the file header has been read.
"""
f = self.bag._file
f.seek(0, os.SEEK_END)
total_bytes = f.tell()
# Read any connection records from after the chunk section.
# This is to workaround a bug in rosbag record --split (fixed in r10390)
# where connection records weren't always being written inside the chunk.
self._read_terminal_connection_records()
# Re-read the file header to get to the start of the first chunk
self.bag._file.seek(self.bag._file_header_pos)
self.read_file_header_record()
trunc_pos = None
while True:
chunk_pos = f.tell()
if chunk_pos >= total_bytes:
break
yield chunk_pos
try:
self._reindex_read_chunk(f, chunk_pos, total_bytes)
except Exception as ex:
break
trunc_pos = f.tell()
if trunc_pos and trunc_pos < total_bytes:
f.truncate(trunc_pos)
def _reindex_read_chunk(self, f, chunk_pos, total_bytes):
# Read the chunk header
chunk_header = self.read_chunk_header()
# If the chunk header size is 0, then the chunk wasn't correctly terminated - we're done
if chunk_header.compressed_size == 0:
raise ROSBagException('unterminated chunk at %d' % chunk_pos)
if chunk_header.compression == Compression.NONE:
chunk_file = f
else:
# Read the compressed chunk
compressed_chunk = _read(f, chunk_header.compressed_size)
# Decompress it
if chunk_header.compression == Compression.BZ2:
self.decompressed_chunk = bz2.decompress(compressed_chunk)
elif chunk_header.compression == Compression.LZ4 and found_lz4:
self.decompressed_chunk = roslz4.decompress(compressed_chunk)
else:
raise ROSBagException('unsupported compression type: %s' % chunk_header.compression)
if self.decompressed_chunk_io:
self.decompressed_chunk_io.close()
self.decompressed_chunk_io = StringIO(self.decompressed_chunk)
chunk_file = self.decompressed_chunk_io
# Read chunk connection and message records
self.bag._curr_chunk_info = None
if chunk_header.compression == Compression.NONE:
offset = chunk_file.tell() - chunk_pos
else:
offset = chunk_file.tell()
expected_index_length = 0
while offset < chunk_header.uncompressed_size:
op = _peek_next_header_op(chunk_file)
if op == _OP_CONNECTION:
connection_info = self.read_connection_record(chunk_file)
if connection_info.id not in self.bag._connections:
self.bag._connections[connection_info.id] = connection_info
if connection_info.id not in self.bag._connection_indexes:
self.bag._connection_indexes[connection_info.id] = []
elif op == _OP_MSG_DATA:
# Read the connection id and timestamp from the header
header = _read_header(chunk_file)
connection_id = _read_uint32_field(header, 'conn')
t = _read_time_field (header, 'time')
# Update the chunk info with this timestamp
if not self.bag._curr_chunk_info:
self.bag._curr_chunk_info = _ChunkInfo(chunk_pos, t, t)
else:
if t > self.bag._curr_chunk_info.end_time:
self.bag._curr_chunk_info.end_time = t
elif t < self.bag._curr_chunk_info.start_time:
self.bag._curr_chunk_info.start_time = t
if connection_id in self.bag._curr_chunk_info.connection_counts:
self.bag._curr_chunk_info.connection_counts[connection_id] += 1
else:
self.bag._curr_chunk_info.connection_counts[connection_id] = 1
# Skip over the message content
_skip_sized(chunk_file)
# Insert the message entry (in order) into the connection index
if connection_id not in self.bag._connection_indexes:
raise ROSBagException('connection id (id=%d) in chunk at position %d not preceded by connection record' % (connection_id, chunk_pos))
bisect.insort_right(self.bag._connection_indexes[connection_id], _IndexEntry200(t, chunk_pos, offset))
expected_index_length += 1
else:
# Unknown record type so skip
_skip_record(chunk_file)
if chunk_header.compression == Compression.NONE:
offset = chunk_file.tell() - chunk_pos
else:
offset = chunk_file.tell()
# Skip over index records, connection records and chunk info records
next_op = _peek_next_header_op(f)
total_index_length = 0
while next_op != _OP_CHUNK:
if next_op == _OP_INDEX_DATA:
# Bug workaround: C Turtle bags (pre-1.1.15) were written with an incorrect data length
_, index = self.read_connection_index_record()
total_index_length += len(index)
else:
_skip_record(f)
if f.tell() >= total_bytes:
if total_index_length != expected_index_length:
raise ROSBagException('index shorter than expected (%d vs %d)' % (total_index_length, expected_index_length))
break
next_op = _peek_next_header_op(f)
# Chunk was read correctly - store info
self.bag._chunk_headers[chunk_pos] = chunk_header
self.bag._chunks.append(self.bag._curr_chunk_info)
def _read_terminal_connection_records(self):
b, f, r = self.bag, self.bag._file, self.bag._reader
# Seek to the first record after FILE_HEADER
f.seek(b._file_header_pos)
r.read_file_header_record()
# Advance to the first CONNECTION
if self._advance_to_next_record(_OP_CONNECTION):
# Read the CONNECTION records
while True:
connection_info = r.read_connection_record(f)
b._connections[connection_info.id] = connection_info
b._connection_indexes[connection_info.id] = []
next_op = _peek_next_header_op(f)
if next_op != _OP_CONNECTION:
break
def _advance_to_next_record(self, op):
b, f = self.bag, self.bag._file
try:
while True:
next_op = _peek_next_header_op(f)
if next_op == op:
break
if next_op == _OP_INDEX_DATA:
# Workaround the possible invalid data length in INDEX_DATA records
# read_connection_index_record() requires _curr_chunk_info is set
if b._curr_chunk_info is None:
b._curr_chunk_info = _ChunkInfo(0, rospy.Time(0, 1), rospy.Time(0, 1))
b._reader.read_connection_index_record()
else:
_skip_record(f)
return True
except Exception as ex:
return False
def start_reading(self):
try:
# Read the file header
self.read_file_header_record()
# Check if the index position has been written, i.e. the bag was closed successfully
if self.bag._index_data_pos == 0:
raise ROSBagUnindexedException()
# Seek to the end of the chunks
self.bag._file.seek(self.bag._index_data_pos)
# Read the connection records
self.bag._connection_indexes = {}
for i in range(self.bag._connection_count):
connection_info = self.read_connection_record(self.bag._file)
self.bag._connections[connection_info.id] = connection_info
self.bag._connection_indexes[connection_info.id] = []
# Read the chunk info records
self.bag._chunks = [self.read_chunk_info_record() for i in range(self.bag._chunk_count)]
# Read the chunk headers
self.bag._chunk_headers = {}
for chunk_info in self.bag._chunks:
self.bag._file.seek(chunk_info.pos)
self.bag._chunk_headers[chunk_info.pos] = self.read_chunk_header()
if not self.bag._skip_index:
self._read_connection_index_records()
except Exception as ex:
raise ROSBagUnindexedException()
def _read_connection_index_records(self):
for chunk_info in self.bag._chunks:
self.bag._file.seek(chunk_info.pos)
_skip_record(self.bag._file)
self.bag._curr_chunk_info = chunk_info
for i in range(len(chunk_info.connection_counts)):
connection_id, index = self.read_connection_index_record()
self.bag._connection_indexes[connection_id].extend(index)
# Remove any connections with no entries
# This is a workaround for a bug where connection records were being written for
# connections which had no messages in the bag
orphan_connection_ids = [id for id, index in self.bag._connection_indexes.items() if not index]
for id in orphan_connection_ids:
del self.bag._connections[id]
del self.bag._connection_indexes[id]
self.bag._connection_indexes_read = True
def read_messages(self, topics, start_time, end_time, connection_filter, raw):
connections = self.bag._get_connections(topics, connection_filter)
for entry in self.bag._get_entries(connections, start_time, end_time):
yield self.seek_and_read_message_data_record((entry.chunk_pos, entry.offset), raw)
###
def read_file_header_record(self):
self.bag._file_header_pos = self.bag._file.tell()
header = _read_header(self.bag._file, _OP_FILE_HEADER)
self.bag._index_data_pos = _read_uint64_field(header, 'index_pos')
self.bag._chunk_count = _read_uint32_field(header, 'chunk_count')
self.bag._connection_count = _read_uint32_field(header, 'conn_count')
_skip_sized(self.bag._file) # skip over the record data, i.e. padding
def read_connection_record(self, f):
header = _read_header(f, _OP_CONNECTION)
conn_id = _read_uint32_field(header, 'conn')
topic = _read_str_field (header, 'topic')
connection_header = _read_header(f)
return _ConnectionInfo(conn_id, topic, connection_header)
def read_chunk_info_record(self):
f = self.bag._file
header = _read_header(f, _OP_CHUNK_INFO)
chunk_info_version = _read_uint32_field(header, 'ver')
if chunk_info_version == 1:
chunk_pos = _read_uint64_field(header, 'chunk_pos')
start_time = _read_time_field (header, 'start_time')
end_time = _read_time_field (header, 'end_time')
connection_count = _read_uint32_field(header, 'count')
chunk_info = _ChunkInfo(chunk_pos, start_time, end_time)
_read_uint32(f) # skip the record data size
for i in range(connection_count):
connection_id = _read_uint32(f)
count = _read_uint32(f)
chunk_info.connection_counts[connection_id] = count
return chunk_info
else:
raise ROSBagFormatException('Unknown chunk info record version: %d' % chunk_info_version)
def read_chunk_header(self):
header = _read_header(self.bag._file, _OP_CHUNK)
compression = _read_str_field (header, 'compression')
uncompressed_size = _read_uint32_field(header, 'size')
compressed_size = _read_uint32(self.bag._file) # read the record data size
data_pos = self.bag._file.tell()
return _ChunkHeader(compression, compressed_size, uncompressed_size, data_pos)
def read_connection_index_record(self):
f = self.bag._file
header = _read_header(f, _OP_INDEX_DATA)
index_version = _read_uint32_field(header, 'ver')
connection_id = _read_uint32_field(header, 'conn')
count = _read_uint32_field(header, 'count')
if index_version != 1:
raise ROSBagFormatException('expecting index version 1, got %d' % index_version)
record_size = _read_uint32(f) # skip the record data size
index = []
for i in range(count):
time = _read_time (f)
offset = _read_uint32(f)
index.append(_IndexEntry200(time, self.bag._curr_chunk_info.pos, offset))
return (connection_id, index)
def seek_and_read_message_data_record(self, position, raw):
chunk_pos, offset = position
chunk_header = self.bag._chunk_headers.get(chunk_pos)
if chunk_header is None:
raise ROSBagException('no chunk at position %d' % chunk_pos)
if chunk_header.compression == Compression.NONE:
f = self.bag._file
f.seek(chunk_header.data_pos + offset)
else:
if self.decompressed_chunk_pos != chunk_pos:
# Seek to the chunk data, read and decompress
self.bag._file.seek(chunk_header.data_pos)
compressed_chunk = _read(self.bag._file, chunk_header.compressed_size)
if chunk_header.compression == Compression.BZ2:
self.decompressed_chunk = bz2.decompress(compressed_chunk)
elif chunk_header.compression == Compression.LZ4 and found_lz4:
self.decompressed_chunk = roslz4.decompress(compressed_chunk)
else:
raise ROSBagException('unsupported compression type: %s' % chunk_header.compression)
self.decompressed_chunk_pos = chunk_pos
if self.decompressed_chunk_io:
self.decompressed_chunk_io.close()
self.decompressed_chunk_io = StringIO(self.decompressed_chunk)
f = self.decompressed_chunk_io
f.seek(offset)
# Skip any CONNECTION records
while True:
header = _read_header(f)
op = _read_uint8_field(header, 'op')
if op != _OP_CONNECTION:
break
_skip_sized(f)
# Check that we have a MSG_DATA record
if op != _OP_MSG_DATA:
raise ROSBagFormatException('Expecting OP_MSG_DATA, got %d' % op)
connection_id = _read_uint32_field(header, 'conn')
t = _read_time_field (header, 'time')
# Get the message type
connection_info = self.bag._connections[connection_id]
try:
msg_type = _get_message_type(connection_info)
except KeyError:
raise ROSBagException('Cannot deserialize messages of type [%s]. Message was not preceded in bag by definition' % connection_info.datatype)
# Read the message content
data = _read_record_data(f)
# Deserialize the message
if raw:
msg = connection_info.datatype, data, connection_info.md5sum, (chunk_pos, offset), msg_type
else:
msg = msg_type()
msg.deserialize(data)
return (connection_info.topic, msg, t)
def _time_to_str(secs):
secs_frac = secs - int(secs)
secs_frac_str = ('%.2f' % secs_frac)[1:]
return time.strftime('%b %d %Y %H:%M:%S', time.localtime(secs)) + secs_frac_str
def _human_readable_size(size):
multiple = 1024.0
for suffix in ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']:
size /= multiple
if size < multiple:
return '%.1f %s' % (size, suffix)
return '-'
def _human_readable_frequency(freq):
multiple = 1000.0
for suffix in ['Hz', 'kHz', 'MHz', 'GHz', 'THz', 'PHz', 'EHz', 'ZHz', 'YHz']:
if freq < multiple:
return '%.1f %s' % (freq, suffix)
freq /= multiple
return '-'
## See http://code.activestate.com/recipes/511509
def _mergesort(list_of_lists, key=None):
"""
Perform an N-way merge operation on sorted lists.
@param list_of_lists: (really iterable of iterable) of sorted elements
(either by naturally or by C{key})
@param key: specify sort key function (like C{sort()}, C{sorted()})
@param iterfun: function that returns an iterator.
Yields tuples of the form C{(item, iterator)}, where the iterator is the
built-in list iterator or something you pass in, if you pre-generate the
iterators.
This is a stable merge; complexity O(N lg N)
Examples::
print list(x[0] for x in mergesort([[1,2,3,4],
[2,3.5,3.7,4.5,6,7],
[2.6,3.6,6.6,9]]))
[1, 2, 2, 2.6, 3, 3.5, 3.6, 3.7, 4, 4.5, 6, 6.6, 7, 9]
# note stability
print list(x[0] for x in mergesort([[1,2,3,4],
[2,3.5,3.7,4.5,6,7],
[2.6,3.6,6.6,9]], key=int))
[1, 2, 2, 2.6, 3, 3.5, 3.6, 3.7, 4, 4.5, 6, 6.6, 7, 9]
print list(x[0] for x in mergesort([[4,3,2,1],
[7,6.5,4,3.7,3.3,1.9],
[9,8.6,7.6,6.6,5.5,4.4,3.3]],
key=lambda x: -x))
[9, 8.6, 7.6, 7, 6.6, 6.5, 5.5, 4.4, 4, 4, 3.7, 3.3, 3.3, 3, 2, 1.9, 1]
"""
heap = []
for i, itr in enumerate(iter(pl) for pl in list_of_lists):
try:
item = next(itr)
toadd = (key(item), i, item, itr) if key else (item, i, itr)
heap.append(toadd)
except StopIteration:
pass
heapq.heapify(heap)
if key:
while heap:
_, idx, item, itr = heap[0]
yield item, itr
try:
item = next(itr)
heapq.heapreplace(heap, (key(item), idx, item, itr) )
except StopIteration:
heapq.heappop(heap)
else:
while heap:
item, idx, itr = heap[0]
yield item, itr
try:
heapq.heapreplace(heap, (next(itr), idx, itr))
except StopIteration:
heapq.heappop(heap)
class _CompressorFileFacade(object):
"""
A file facade for sequential compressors (e.g., bz2.BZ2Compressor).
"""
def __init__(self, file, compressor):
self.file = file
self.compressor = compressor
self.compressed_bytes_in = 0
def write(self, data):
compressed = self.compressor.compress(data)
if len(compressed) > 0:
self.file.write(compressed)
self.compressed_bytes_in += len(data)
def flush(self):
compressed = self.compressor.flush()
if len(compressed) > 0:
self.file.write(compressed)
def _median(values):
values_len = len(values)
if values_len == 0:
return float('nan')
sorted_values = sorted(values)
if values_len % 2 == 1:
return sorted_values[int(values_len / 2)]
lower = sorted_values[int(values_len / 2) - 1]
upper = sorted_values[int(values_len / 2)]
return float(lower + upper) / 2
|