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
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
|
/**
* \file libmtp.c
*
* Copyright (C) 2005-2011 Linus Walleij <triad@df.lth.se>
* Copyright (C) 2005-2008 Richard A. Low <richard@wentnet.com>
* Copyright (C) 2007 Ted Bullock <tbullock@canada.com>
* Copyright (C) 2007 Tero Saarni <tero.saarni@gmail.com>
* Copyright (C) 2008 Florent Mertens <flomertens@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* This file provides an interface "glue" to the underlying
* PTP implementation from libgphoto2. It uses some local
* code to convert from/to UTF-8 (stored in unicode.c/.h)
* and some small utility functions, mainly for debugging
* (stored in util.c/.h).
*
* The three PTP files (ptp.c, ptp.h and ptp-pack.c) are
* plain copied from the libhphoto2 codebase.
*
* The files libusb-glue.c/.h are just what they say: an
* interface to libusb for the actual, physical USB traffic.
*/
#include "config.h"
#include "libmtp.h"
#include "unicode.h"
#include "ptp.h"
#include "libusb-glue.h"
#include "device-flags.h"
#include "playlist-spl.h"
#include "util.h"
#include "mtpz.h"
int use_mtpz;
#include <stdarg.h>
#include <stdlib.h>
#include <limits.h>
#include <unistd.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <time.h>
#include <errno.h>
#ifdef _MSC_VER // For MSVC++
#define USE_WINDOWS_IO_H
#include <io.h>
#endif
/**
* Global debug level
* We use a flag system to enable a part of logs.
*
* The LIBMTP_DEBUG environment variable sets the debug flags for any binary
* that uses libmtp and calls LIBMTP_Init. The value can be given in decimal
* (must not start with "0" or it will be interpreted in octal), or in
* hexadecimal (must start with "0x").
*
* The value "-1" enables all debug flags.
*
* Some of the utilities in examples/ also take a command-line flag "-d" that
* enables LIBMTP_DEBUG_PTP and LIBMTP_DEBUG_DATA (same as setting
* LIBMTP_DEBUG=9).
*
* Flags (combine by adding the hex values):
* 0x00 [0000 0000] : LIBMTP_DEBUG_NONE : no debug (default)
* 0x01 [0000 0001] : LIBMTP_DEBUG_PTP : PTP debug
* 0x02 [0000 0010] : LIBMTP_DEBUG_PLST : Playlist debug
* 0x04 [0000 0100] : LIBMTP_DEBUG_USB : USB debug
* 0x08 [0000 1000] : LIBMTP_DEBUG_DATA : USB data debug
*
* (Please keep this list in sync with libmtp.h.)
*/
int LIBMTP_debug = LIBMTP_DEBUG_NONE;
/*
* This is a mapping between libmtp internal MTP filetypes and
* the libgphoto2/PTP equivalent defines. We need this because
* otherwise the libmtp.h device has to be dependent on ptp.h
* to be installed too, and we don't want that.
*/
//typedef struct filemap_struct filemap_t;
typedef struct filemap_struct {
char *description; /**< Text description for the file type */
LIBMTP_filetype_t id; /**< LIBMTP internal type for the file type */
uint16_t ptp_id; /**< PTP ID for the filetype */
struct filemap_struct *next;
} filemap_t;
/*
* This is a mapping between libmtp internal MTP properties and
* the libgphoto2/PTP equivalent defines. We need this because
* otherwise the libmtp.h device has to be dependent on ptp.h
* to be installed too, and we don't want that.
*/
typedef struct propertymap_struct {
char *description; /**< Text description for the property */
LIBMTP_property_t id; /**< LIBMTP internal type for the property */
uint16_t ptp_id; /**< PTP ID for the property */
struct propertymap_struct *next;
} propertymap_t;
/*
* This is a simple container for holding our callback and user_data
* for parsing onwards to the usb_event_async function.
*/
typedef struct event_cb_data_struct {
LIBMTP_event_cb_fn cb;
void *user_data;
} event_cb_data_t;
// Global variables
// This holds the global filetype mapping table
static filemap_t *g_filemap = NULL;
// This holds the global property mapping table
static propertymap_t *g_propertymap = NULL;
/*
* Forward declarations of local (static) functions.
*/
static int register_filetype(char const * const description, LIBMTP_filetype_t const id,
uint16_t const ptp_id);
static void init_filemap();
static int register_property(char const * const description, LIBMTP_property_t const id,
uint16_t const ptp_id);
static void init_propertymap();
static void add_error_to_errorstack(LIBMTP_mtpdevice_t *device,
LIBMTP_error_number_t errornumber,
char const * const error_text);
static void add_ptp_error_to_errorstack(LIBMTP_mtpdevice_t *device,
uint16_t ptp_error,
char const * const error_text);
static void flush_handles(LIBMTP_mtpdevice_t *device);
static uint16_t get_handles_recursively(LIBMTP_mtpdevice_t *device,
PTPParams *params,
uint32_t storageid,
uint32_t parent);
static void free_storage_list(LIBMTP_mtpdevice_t *device);
static int sort_storage_by(LIBMTP_mtpdevice_t *device, int const sortby);
static uint32_t get_writeable_storageid(LIBMTP_mtpdevice_t *device,
uint64_t fitsize);
static int get_storage_freespace(LIBMTP_mtpdevice_t *device,
LIBMTP_devicestorage_t *storage,
uint64_t *freespace);
static int check_if_file_fits(LIBMTP_mtpdevice_t *device,
LIBMTP_devicestorage_t *storage,
uint64_t const filesize);
static uint16_t map_libmtp_type_to_ptp_type(LIBMTP_filetype_t intype);
static LIBMTP_filetype_t map_ptp_type_to_libmtp_type(uint16_t intype);
static uint16_t map_libmtp_property_to_ptp_property(LIBMTP_property_t inproperty);
static LIBMTP_property_t map_ptp_property_to_libmtp_property(uint16_t intype);
static int get_device_unicode_property(LIBMTP_mtpdevice_t *device,
char **unicstring, uint16_t property);
static uint16_t adjust_u16(uint16_t val, PTPObjectPropDesc *opd);
static uint32_t adjust_u32(uint32_t val, PTPObjectPropDesc *opd);
static char *get_iso8601_stamp(void);
static char *get_string_from_object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id);
static uint64_t get_u64_from_object(LIBMTP_mtpdevice_t *device,uint32_t const object_id,
uint16_t const attribute_id, uint64_t const value_default);
static uint32_t get_u32_from_object(LIBMTP_mtpdevice_t *device,uint32_t const object_id,
uint16_t const attribute_id, uint32_t const value_default);
static uint16_t get_u16_from_object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint16_t const value_default);
static uint8_t get_u8_from_object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint8_t const value_default);
static int set_object_string(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, char const * const string);
static int set_object_u32(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint32_t const value);
static int set_object_u16(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint16_t const value);
static int set_object_u8(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint8_t const value);
static void get_track_metadata(LIBMTP_mtpdevice_t *device, uint16_t objectformat,
LIBMTP_track_t *track);
static LIBMTP_folder_t *get_subfolders_for_folder(LIBMTP_folder_t *list, uint32_t parent);
static int create_new_abstract_list(LIBMTP_mtpdevice_t *device,
char const * const name,
char const * const artist,
char const * const composer,
char const * const genre,
uint32_t const parenthandle,
uint32_t const storageid,
uint16_t const objectformat,
char const * const suffix,
uint32_t * const newid,
uint32_t const * const tracks,
uint32_t const no_tracks);
static int update_abstract_list(LIBMTP_mtpdevice_t *device,
char const * const name,
char const * const artist,
char const * const composer,
char const * const genre,
uint32_t const objecthandle,
uint16_t const objectformat,
uint32_t const * const tracks,
uint32_t const no_tracks);
static int send_file_object_info(LIBMTP_mtpdevice_t *device, LIBMTP_file_t *filedata);
static void add_object_to_cache(LIBMTP_mtpdevice_t *device, uint32_t object_id);
static void update_metadata_cache(LIBMTP_mtpdevice_t *device, uint32_t object_id);
static int set_object_filename(LIBMTP_mtpdevice_t *device,
uint32_t object_id,
uint16_t ptp_type,
const char **newname);
static char *generate_unique_filename(PTPParams* params, char const * const filename);
static int check_filename_exists(PTPParams* params, char const * const filename);
static void LIBMTP_Handle_Event(PTPContainer *ptp_event,
LIBMTP_event_t *event, uint32_t *out1);
/**
* These are to wrap the get/put handlers to convert from the MTP types to PTP types
* in a reliable way
*/
typedef struct _MTPDataHandler {
MTPDataGetFunc getfunc;
MTPDataPutFunc putfunc;
void *priv;
} MTPDataHandler;
static uint16_t get_func_wrapper(PTPParams* params, void* priv, unsigned long wantlen, unsigned char *data, unsigned long *gotlen);
static uint16_t put_func_wrapper(PTPParams* params, void* priv, unsigned long sendlen, unsigned char *data);
/**
* Checks if a filename ends with ".ogg". Used in various
* situations when the device has no idea that it support
* OGG but still does.
*
* @param name string to be checked.
* @return 0 if this does not end with ogg, any other
* value means it does.
*/
static int has_ogg_extension(char *name) {
char *ptype;
if (name == NULL)
return 0;
ptype = strrchr(name,'.');
if (ptype == NULL)
return 0;
if (!strcasecmp (ptype, ".ogg"))
return 1;
return 0;
}
/**
* Checks if a filename ends with ".flac". Used in various
* situations when the device has no idea that it support
* FLAC but still does.
*
* @param name string to be checked.
* @return 0 if this does not end with flac, any other
* value means it does.
*/
static int has_flac_extension(char *name) {
char *ptype;
if (name == NULL)
return 0;
ptype = strrchr(name,'.');
if (ptype == NULL)
return 0;
if (!strcasecmp (ptype, ".flac"))
return 1;
return 0;
}
/**
* Create a new file mapping entry
* @return a newly allocated filemapping entry.
*/
static filemap_t *new_filemap_entry()
{
filemap_t *filemap;
filemap = (filemap_t *)malloc(sizeof(filemap_t));
if( filemap != NULL ) {
filemap->description = NULL;
filemap->id = LIBMTP_FILETYPE_UNKNOWN;
filemap->ptp_id = PTP_OFC_Undefined;
filemap->next = NULL;
}
return filemap;
}
/**
* Register an MTP or PTP filetype for data retrieval
*
* @param description Text description of filetype
* @param id libmtp internal filetype id
* @param ptp_id PTP filetype id
* @return 0 for success any other value means error.
*/
static int register_filetype(char const * const description, LIBMTP_filetype_t const id,
uint16_t const ptp_id)
{
filemap_t *new = NULL, *current;
// Has this LIBMTP filetype been registered before ?
current = g_filemap;
while (current != NULL) {
if(current->id == id) {
break;
}
current = current->next;
}
// Create the entry
if(current == NULL) {
new = new_filemap_entry();
if(new == NULL) {
return 1;
}
new->id = id;
if(description != NULL) {
new->description = strdup(description);
}
new->ptp_id = ptp_id;
// Add the entry to the list
if(g_filemap == NULL) {
g_filemap = new;
} else {
current = g_filemap;
while (current->next != NULL ) current=current->next;
current->next = new;
}
// Update the existing entry
} else {
if (current->description != NULL) {
free(current->description);
}
current->description = NULL;
if(description != NULL) {
current->description = strdup(description);
}
current->ptp_id = ptp_id;
}
return 0;
}
static void init_filemap()
{
register_filetype("Folder", LIBMTP_FILETYPE_FOLDER, PTP_OFC_Association);
register_filetype("MediaCard", LIBMTP_FILETYPE_MEDIACARD, PTP_OFC_MTP_MediaCard);
register_filetype("RIFF WAVE file", LIBMTP_FILETYPE_WAV, PTP_OFC_WAV);
register_filetype("ISO MPEG-1 Audio Layer 3", LIBMTP_FILETYPE_MP3, PTP_OFC_MP3);
register_filetype("ISO MPEG-1 Audio Layer 2", LIBMTP_FILETYPE_MP2, PTP_OFC_MTP_MP2);
register_filetype("Microsoft Windows Media Audio", LIBMTP_FILETYPE_WMA, PTP_OFC_MTP_WMA);
register_filetype("Ogg container format", LIBMTP_FILETYPE_OGG, PTP_OFC_MTP_OGG);
register_filetype("Free Lossless Audio Codec (FLAC)", LIBMTP_FILETYPE_FLAC, PTP_OFC_MTP_FLAC);
register_filetype("Advanced Audio Coding (AAC)/MPEG-2 Part 7/MPEG-4 Part 3", LIBMTP_FILETYPE_AAC, PTP_OFC_MTP_AAC);
register_filetype("MPEG-4 Part 14 Container Format (Audio Emphasis)", LIBMTP_FILETYPE_M4A, PTP_OFC_MTP_M4A);
register_filetype("MPEG-4 Part 14 Container Format (Audio+Video Emphasis)", LIBMTP_FILETYPE_MP4, PTP_OFC_MTP_MP4);
register_filetype("Audible.com Audio Codec", LIBMTP_FILETYPE_AUDIBLE, PTP_OFC_MTP_AudibleCodec);
register_filetype("Undefined audio file", LIBMTP_FILETYPE_UNDEF_AUDIO, PTP_OFC_MTP_UndefinedAudio);
register_filetype("Microsoft Windows Media Video", LIBMTP_FILETYPE_WMV, PTP_OFC_MTP_WMV);
register_filetype("Audio Video Interleave", LIBMTP_FILETYPE_AVI, PTP_OFC_AVI);
register_filetype("MPEG video stream", LIBMTP_FILETYPE_MPEG, PTP_OFC_MPEG);
register_filetype("Microsoft Advanced Systems Format", LIBMTP_FILETYPE_ASF, PTP_OFC_ASF);
register_filetype("Apple Quicktime container format", LIBMTP_FILETYPE_QT, PTP_OFC_QT);
register_filetype("Undefined video file", LIBMTP_FILETYPE_UNDEF_VIDEO, PTP_OFC_MTP_UndefinedVideo);
register_filetype("JPEG file", LIBMTP_FILETYPE_JPEG, PTP_OFC_EXIF_JPEG);
register_filetype("JP2 file", LIBMTP_FILETYPE_JP2, PTP_OFC_JP2);
register_filetype("JPX file", LIBMTP_FILETYPE_JPX, PTP_OFC_JPX);
register_filetype("JFIF file", LIBMTP_FILETYPE_JFIF, PTP_OFC_JFIF);
register_filetype("TIFF bitmap file", LIBMTP_FILETYPE_TIFF, PTP_OFC_TIFF);
register_filetype("BMP bitmap file", LIBMTP_FILETYPE_BMP, PTP_OFC_BMP);
register_filetype("GIF bitmap file", LIBMTP_FILETYPE_GIF, PTP_OFC_GIF);
register_filetype("PICT bitmap file", LIBMTP_FILETYPE_PICT, PTP_OFC_PICT);
register_filetype("Portable Network Graphics", LIBMTP_FILETYPE_PNG, PTP_OFC_PNG);
register_filetype("Microsoft Windows Image Format", LIBMTP_FILETYPE_WINDOWSIMAGEFORMAT, PTP_OFC_MTP_WindowsImageFormat);
register_filetype("VCalendar version 1", LIBMTP_FILETYPE_VCALENDAR1, PTP_OFC_MTP_vCalendar1);
register_filetype("VCalendar version 2", LIBMTP_FILETYPE_VCALENDAR2, PTP_OFC_MTP_vCalendar2);
register_filetype("VCard version 2", LIBMTP_FILETYPE_VCARD2, PTP_OFC_MTP_vCard2);
register_filetype("VCard version 3", LIBMTP_FILETYPE_VCARD3, PTP_OFC_MTP_vCard3);
register_filetype("Undefined Windows executable file", LIBMTP_FILETYPE_WINEXEC, PTP_OFC_MTP_UndefinedWindowsExecutable);
register_filetype("Text file", LIBMTP_FILETYPE_TEXT, PTP_OFC_Text);
register_filetype("HTML file", LIBMTP_FILETYPE_HTML, PTP_OFC_HTML);
register_filetype("XML file", LIBMTP_FILETYPE_XML, PTP_OFC_MTP_XMLDocument);
register_filetype("DOC file", LIBMTP_FILETYPE_DOC, PTP_OFC_MTP_MSWordDocument);
register_filetype("XLS file", LIBMTP_FILETYPE_XLS, PTP_OFC_MTP_MSExcelSpreadsheetXLS);
register_filetype("PPT file", LIBMTP_FILETYPE_PPT, PTP_OFC_MTP_MSPowerpointPresentationPPT);
register_filetype("MHT file", LIBMTP_FILETYPE_MHT, PTP_OFC_MTP_MHTCompiledHTMLDocument);
register_filetype("Firmware file", LIBMTP_FILETYPE_FIRMWARE, PTP_OFC_MTP_Firmware);
register_filetype("Abstract Album file", LIBMTP_FILETYPE_ALBUM, PTP_OFC_MTP_AbstractAudioAlbum);
register_filetype("Abstract Playlist file", LIBMTP_FILETYPE_PLAYLIST, PTP_OFC_MTP_AbstractAudioVideoPlaylist);
register_filetype("Undefined filetype", LIBMTP_FILETYPE_UNKNOWN, PTP_OFC_Undefined);
}
/**
* Returns the PTP filetype that maps to a certain libmtp internal file type.
* @param intype the MTP library interface type
* @return the PTP (libgphoto2) interface type
*/
static uint16_t map_libmtp_type_to_ptp_type(LIBMTP_filetype_t intype)
{
filemap_t *current;
current = g_filemap;
while (current != NULL) {
if(current->id == intype) {
return current->ptp_id;
}
current = current->next;
}
// printf("map_libmtp_type_to_ptp_type: unknown filetype.\n");
return PTP_OFC_Undefined;
}
/**
* Returns the MTP internal interface type that maps to a certain ptp
* interface type.
* @param intype the PTP (libgphoto2) interface type
* @return the MTP library interface type
*/
static LIBMTP_filetype_t map_ptp_type_to_libmtp_type(uint16_t intype)
{
filemap_t *current;
current = g_filemap;
while (current != NULL) {
if(current->ptp_id == intype) {
return current->id;
}
current = current->next;
}
// printf("map_ptp_type_to_libmtp_type: unknown filetype.\n");
return LIBMTP_FILETYPE_UNKNOWN;
}
/**
* Create a new property mapping entry
* @return a newly allocated propertymapping entry.
*/
static propertymap_t *new_propertymap_entry()
{
propertymap_t *propertymap;
propertymap = (propertymap_t *)malloc(sizeof(propertymap_t));
if( propertymap != NULL ) {
propertymap->description = NULL;
propertymap->id = LIBMTP_PROPERTY_UNKNOWN;
propertymap->ptp_id = 0;
propertymap->next = NULL;
}
return propertymap;
}
/**
* Register an MTP or PTP property for data retrieval
*
* @param description Text description of property
* @param id libmtp internal property id
* @param ptp_id PTP property id
* @return 0 for success any other value means error.
*/
static int register_property(char const * const description, LIBMTP_property_t const id,
uint16_t const ptp_id)
{
propertymap_t *new = NULL, *current;
// Has this LIBMTP propety been registered before ?
current = g_propertymap;
while (current != NULL) {
if(current->id == id) {
break;
}
current = current->next;
}
// Create the entry
if(current == NULL) {
new = new_propertymap_entry();
if(new == NULL) {
return 1;
}
new->id = id;
if(description != NULL) {
new->description = strdup(description);
}
new->ptp_id = ptp_id;
// Add the entry to the list
if(g_propertymap == NULL) {
g_propertymap = new;
} else {
current = g_propertymap;
while (current->next != NULL ) current=current->next;
current->next = new;
}
// Update the existing entry
} else {
if (current->description != NULL) {
free(current->description);
}
current->description = NULL;
if(description != NULL) {
current->description = strdup(description);
}
current->ptp_id = ptp_id;
}
return 0;
}
static void init_propertymap()
{
register_property("Storage ID", LIBMTP_PROPERTY_StorageID, PTP_OPC_StorageID);
register_property("Object Format", LIBMTP_PROPERTY_ObjectFormat, PTP_OPC_ObjectFormat);
register_property("Protection Status", LIBMTP_PROPERTY_ProtectionStatus, PTP_OPC_ProtectionStatus);
register_property("Object Size", LIBMTP_PROPERTY_ObjectSize, PTP_OPC_ObjectSize);
register_property("Association Type", LIBMTP_PROPERTY_AssociationType, PTP_OPC_AssociationType);
register_property("Association Desc", LIBMTP_PROPERTY_AssociationDesc, PTP_OPC_AssociationDesc);
register_property("Object File Name", LIBMTP_PROPERTY_ObjectFileName, PTP_OPC_ObjectFileName);
register_property("Date Created", LIBMTP_PROPERTY_DateCreated, PTP_OPC_DateCreated);
register_property("Date Modified", LIBMTP_PROPERTY_DateModified, PTP_OPC_DateModified);
register_property("Keywords", LIBMTP_PROPERTY_Keywords, PTP_OPC_Keywords);
register_property("Parent Object", LIBMTP_PROPERTY_ParentObject, PTP_OPC_ParentObject);
register_property("Allowed Folder Contents", LIBMTP_PROPERTY_AllowedFolderContents, PTP_OPC_AllowedFolderContents);
register_property("Hidden", LIBMTP_PROPERTY_Hidden, PTP_OPC_Hidden);
register_property("System Object", LIBMTP_PROPERTY_SystemObject, PTP_OPC_SystemObject);
register_property("Persistant Unique Object Identifier", LIBMTP_PROPERTY_PersistantUniqueObjectIdentifier, PTP_OPC_PersistantUniqueObjectIdentifier);
register_property("Sync ID", LIBMTP_PROPERTY_SyncID, PTP_OPC_SyncID);
register_property("Property Bag", LIBMTP_PROPERTY_PropertyBag, PTP_OPC_PropertyBag);
register_property("Name", LIBMTP_PROPERTY_Name, PTP_OPC_Name);
register_property("Created By", LIBMTP_PROPERTY_CreatedBy, PTP_OPC_CreatedBy);
register_property("Artist", LIBMTP_PROPERTY_Artist, PTP_OPC_Artist);
register_property("Date Authored", LIBMTP_PROPERTY_DateAuthored, PTP_OPC_DateAuthored);
register_property("Description", LIBMTP_PROPERTY_Description, PTP_OPC_Description);
register_property("URL Reference", LIBMTP_PROPERTY_URLReference, PTP_OPC_URLReference);
register_property("Language Locale", LIBMTP_PROPERTY_LanguageLocale, PTP_OPC_LanguageLocale);
register_property("Copyright Information", LIBMTP_PROPERTY_CopyrightInformation, PTP_OPC_CopyrightInformation);
register_property("Source", LIBMTP_PROPERTY_Source, PTP_OPC_Source);
register_property("Origin Location", LIBMTP_PROPERTY_OriginLocation, PTP_OPC_OriginLocation);
register_property("Date Added", LIBMTP_PROPERTY_DateAdded, PTP_OPC_DateAdded);
register_property("Non Consumable", LIBMTP_PROPERTY_NonConsumable, PTP_OPC_NonConsumable);
register_property("Corrupt Or Unplayable", LIBMTP_PROPERTY_CorruptOrUnplayable, PTP_OPC_CorruptOrUnplayable);
register_property("Producer Serial Number", LIBMTP_PROPERTY_ProducerSerialNumber, PTP_OPC_ProducerSerialNumber);
register_property("Representative Sample Format", LIBMTP_PROPERTY_RepresentativeSampleFormat, PTP_OPC_RepresentativeSampleFormat);
register_property("Representative Sample Sise", LIBMTP_PROPERTY_RepresentativeSampleSize, PTP_OPC_RepresentativeSampleSize);
register_property("Representative Sample Height", LIBMTP_PROPERTY_RepresentativeSampleHeight, PTP_OPC_RepresentativeSampleHeight);
register_property("Representative Sample Width", LIBMTP_PROPERTY_RepresentativeSampleWidth, PTP_OPC_RepresentativeSampleWidth);
register_property("Representative Sample Duration", LIBMTP_PROPERTY_RepresentativeSampleDuration, PTP_OPC_RepresentativeSampleDuration);
register_property("Representative Sample Data", LIBMTP_PROPERTY_RepresentativeSampleData, PTP_OPC_RepresentativeSampleData);
register_property("Width", LIBMTP_PROPERTY_Width, PTP_OPC_Width);
register_property("Height", LIBMTP_PROPERTY_Height, PTP_OPC_Height);
register_property("Duration", LIBMTP_PROPERTY_Duration, PTP_OPC_Duration);
register_property("Rating", LIBMTP_PROPERTY_Rating, PTP_OPC_Rating);
register_property("Track", LIBMTP_PROPERTY_Track, PTP_OPC_Track);
register_property("Genre", LIBMTP_PROPERTY_Genre, PTP_OPC_Genre);
register_property("Credits", LIBMTP_PROPERTY_Credits, PTP_OPC_Credits);
register_property("Lyrics", LIBMTP_PROPERTY_Lyrics, PTP_OPC_Lyrics);
register_property("Subscription Content ID", LIBMTP_PROPERTY_SubscriptionContentID, PTP_OPC_SubscriptionContentID);
register_property("Produced By", LIBMTP_PROPERTY_ProducedBy, PTP_OPC_ProducedBy);
register_property("Use Count", LIBMTP_PROPERTY_UseCount, PTP_OPC_UseCount);
register_property("Skip Count", LIBMTP_PROPERTY_SkipCount, PTP_OPC_SkipCount);
register_property("Last Accessed", LIBMTP_PROPERTY_LastAccessed, PTP_OPC_LastAccessed);
register_property("Parental Rating", LIBMTP_PROPERTY_ParentalRating, PTP_OPC_ParentalRating);
register_property("Meta Genre", LIBMTP_PROPERTY_MetaGenre, PTP_OPC_MetaGenre);
register_property("Composer", LIBMTP_PROPERTY_Composer, PTP_OPC_Composer);
register_property("Effective Rating", LIBMTP_PROPERTY_EffectiveRating, PTP_OPC_EffectiveRating);
register_property("Subtitle", LIBMTP_PROPERTY_Subtitle, PTP_OPC_Subtitle);
register_property("Original Release Date", LIBMTP_PROPERTY_OriginalReleaseDate, PTP_OPC_OriginalReleaseDate);
register_property("Album Name", LIBMTP_PROPERTY_AlbumName, PTP_OPC_AlbumName);
register_property("Album Artist", LIBMTP_PROPERTY_AlbumArtist, PTP_OPC_AlbumArtist);
register_property("Mood", LIBMTP_PROPERTY_Mood, PTP_OPC_Mood);
register_property("DRM Status", LIBMTP_PROPERTY_DRMStatus, PTP_OPC_DRMStatus);
register_property("Sub Description", LIBMTP_PROPERTY_SubDescription, PTP_OPC_SubDescription);
register_property("Is Cropped", LIBMTP_PROPERTY_IsCropped, PTP_OPC_IsCropped);
register_property("Is Color Corrected", LIBMTP_PROPERTY_IsColorCorrected, PTP_OPC_IsColorCorrected);
register_property("Image Bit Depth", LIBMTP_PROPERTY_ImageBitDepth, PTP_OPC_ImageBitDepth);
register_property("f Number", LIBMTP_PROPERTY_Fnumber, PTP_OPC_Fnumber);
register_property("Exposure Time", LIBMTP_PROPERTY_ExposureTime, PTP_OPC_ExposureTime);
register_property("Exposure Index", LIBMTP_PROPERTY_ExposureIndex, PTP_OPC_ExposureIndex);
register_property("Display Name", LIBMTP_PROPERTY_DisplayName, PTP_OPC_DisplayName);
register_property("Body Text", LIBMTP_PROPERTY_BodyText, PTP_OPC_BodyText);
register_property("Subject", LIBMTP_PROPERTY_Subject, PTP_OPC_Subject);
register_property("Priority", LIBMTP_PROPERTY_Priority, PTP_OPC_Priority);
register_property("Given Name", LIBMTP_PROPERTY_GivenName, PTP_OPC_GivenName);
register_property("Middle Names", LIBMTP_PROPERTY_MiddleNames, PTP_OPC_MiddleNames);
register_property("Family Name", LIBMTP_PROPERTY_FamilyName, PTP_OPC_FamilyName);
register_property("Prefix", LIBMTP_PROPERTY_Prefix, PTP_OPC_Prefix);
register_property("Suffix", LIBMTP_PROPERTY_Suffix, PTP_OPC_Suffix);
register_property("Phonetic Given Name", LIBMTP_PROPERTY_PhoneticGivenName, PTP_OPC_PhoneticGivenName);
register_property("Phonetic Family Name", LIBMTP_PROPERTY_PhoneticFamilyName, PTP_OPC_PhoneticFamilyName);
register_property("Email: Primary", LIBMTP_PROPERTY_EmailPrimary, PTP_OPC_EmailPrimary);
register_property("Email: Personal 1", LIBMTP_PROPERTY_EmailPersonal1, PTP_OPC_EmailPersonal1);
register_property("Email: Personal 2", LIBMTP_PROPERTY_EmailPersonal2, PTP_OPC_EmailPersonal2);
register_property("Email: Business 1", LIBMTP_PROPERTY_EmailBusiness1, PTP_OPC_EmailBusiness1);
register_property("Email: Business 2", LIBMTP_PROPERTY_EmailBusiness2, PTP_OPC_EmailBusiness2);
register_property("Email: Others", LIBMTP_PROPERTY_EmailOthers, PTP_OPC_EmailOthers);
register_property("Phone Number: Primary", LIBMTP_PROPERTY_PhoneNumberPrimary, PTP_OPC_PhoneNumberPrimary);
register_property("Phone Number: Personal", LIBMTP_PROPERTY_PhoneNumberPersonal, PTP_OPC_PhoneNumberPersonal);
register_property("Phone Number: Personal 2", LIBMTP_PROPERTY_PhoneNumberPersonal2, PTP_OPC_PhoneNumberPersonal2);
register_property("Phone Number: Business", LIBMTP_PROPERTY_PhoneNumberBusiness, PTP_OPC_PhoneNumberBusiness);
register_property("Phone Number: Business 2", LIBMTP_PROPERTY_PhoneNumberBusiness2, PTP_OPC_PhoneNumberBusiness2);
register_property("Phone Number: Mobile", LIBMTP_PROPERTY_PhoneNumberMobile, PTP_OPC_PhoneNumberMobile);
register_property("Phone Number: Mobile 2", LIBMTP_PROPERTY_PhoneNumberMobile2, PTP_OPC_PhoneNumberMobile2);
register_property("Fax Number: Primary", LIBMTP_PROPERTY_FaxNumberPrimary, PTP_OPC_FaxNumberPrimary);
register_property("Fax Number: Personal", LIBMTP_PROPERTY_FaxNumberPersonal, PTP_OPC_FaxNumberPersonal);
register_property("Fax Number: Business", LIBMTP_PROPERTY_FaxNumberBusiness, PTP_OPC_FaxNumberBusiness);
register_property("Pager Number", LIBMTP_PROPERTY_PagerNumber, PTP_OPC_PagerNumber);
register_property("Phone Number: Others", LIBMTP_PROPERTY_PhoneNumberOthers, PTP_OPC_PhoneNumberOthers);
register_property("Primary Web Address", LIBMTP_PROPERTY_PrimaryWebAddress, PTP_OPC_PrimaryWebAddress);
register_property("Personal Web Address", LIBMTP_PROPERTY_PersonalWebAddress, PTP_OPC_PersonalWebAddress);
register_property("Business Web Address", LIBMTP_PROPERTY_BusinessWebAddress, PTP_OPC_BusinessWebAddress);
register_property("Instant Messenger Address 1", LIBMTP_PROPERTY_InstantMessengerAddress, PTP_OPC_InstantMessengerAddress);
register_property("Instant Messenger Address 2", LIBMTP_PROPERTY_InstantMessengerAddress2, PTP_OPC_InstantMessengerAddress2);
register_property("Instant Messenger Address 3", LIBMTP_PROPERTY_InstantMessengerAddress3, PTP_OPC_InstantMessengerAddress3);
register_property("Postal Address: Personal: Full", LIBMTP_PROPERTY_PostalAddressPersonalFull, PTP_OPC_PostalAddressPersonalFull);
register_property("Postal Address: Personal: Line 1", LIBMTP_PROPERTY_PostalAddressPersonalFullLine1, PTP_OPC_PostalAddressPersonalFullLine1);
register_property("Postal Address: Personal: Line 2", LIBMTP_PROPERTY_PostalAddressPersonalFullLine2, PTP_OPC_PostalAddressPersonalFullLine2);
register_property("Postal Address: Personal: City", LIBMTP_PROPERTY_PostalAddressPersonalFullCity, PTP_OPC_PostalAddressPersonalFullCity);
register_property("Postal Address: Personal: Region", LIBMTP_PROPERTY_PostalAddressPersonalFullRegion, PTP_OPC_PostalAddressPersonalFullRegion);
register_property("Postal Address: Personal: Postal Code", LIBMTP_PROPERTY_PostalAddressPersonalFullPostalCode, PTP_OPC_PostalAddressPersonalFullPostalCode);
register_property("Postal Address: Personal: Country", LIBMTP_PROPERTY_PostalAddressPersonalFullCountry, PTP_OPC_PostalAddressPersonalFullCountry);
register_property("Postal Address: Business: Full", LIBMTP_PROPERTY_PostalAddressBusinessFull, PTP_OPC_PostalAddressBusinessFull);
register_property("Postal Address: Business: Line 1", LIBMTP_PROPERTY_PostalAddressBusinessLine1, PTP_OPC_PostalAddressBusinessLine1);
register_property("Postal Address: Business: Line 2", LIBMTP_PROPERTY_PostalAddressBusinessLine2, PTP_OPC_PostalAddressBusinessLine2);
register_property("Postal Address: Business: City", LIBMTP_PROPERTY_PostalAddressBusinessCity, PTP_OPC_PostalAddressBusinessCity);
register_property("Postal Address: Business: Region", LIBMTP_PROPERTY_PostalAddressBusinessRegion, PTP_OPC_PostalAddressBusinessRegion);
register_property("Postal Address: Business: Postal Code", LIBMTP_PROPERTY_PostalAddressBusinessPostalCode, PTP_OPC_PostalAddressBusinessPostalCode);
register_property("Postal Address: Business: Country", LIBMTP_PROPERTY_PostalAddressBusinessCountry, PTP_OPC_PostalAddressBusinessCountry);
register_property("Postal Address: Other: Full", LIBMTP_PROPERTY_PostalAddressOtherFull, PTP_OPC_PostalAddressOtherFull);
register_property("Postal Address: Other: Line 1", LIBMTP_PROPERTY_PostalAddressOtherLine1, PTP_OPC_PostalAddressOtherLine1);
register_property("Postal Address: Other: Line 2", LIBMTP_PROPERTY_PostalAddressOtherLine2, PTP_OPC_PostalAddressOtherLine2);
register_property("Postal Address: Other: City", LIBMTP_PROPERTY_PostalAddressOtherCity, PTP_OPC_PostalAddressOtherCity);
register_property("Postal Address: Other: Region", LIBMTP_PROPERTY_PostalAddressOtherRegion, PTP_OPC_PostalAddressOtherRegion);
register_property("Postal Address: Other: Postal Code", LIBMTP_PROPERTY_PostalAddressOtherPostalCode, PTP_OPC_PostalAddressOtherPostalCode);
register_property("Postal Address: Other: Counrtry", LIBMTP_PROPERTY_PostalAddressOtherCountry, PTP_OPC_PostalAddressOtherCountry);
register_property("Organization Name", LIBMTP_PROPERTY_OrganizationName, PTP_OPC_OrganizationName);
register_property("Phonetic Organization Name", LIBMTP_PROPERTY_PhoneticOrganizationName, PTP_OPC_PhoneticOrganizationName);
register_property("Role", LIBMTP_PROPERTY_Role, PTP_OPC_Role);
register_property("Birthdate", LIBMTP_PROPERTY_Birthdate, PTP_OPC_Birthdate);
register_property("Message To", LIBMTP_PROPERTY_MessageTo, PTP_OPC_MessageTo);
register_property("Message CC", LIBMTP_PROPERTY_MessageCC, PTP_OPC_MessageCC);
register_property("Message BCC", LIBMTP_PROPERTY_MessageBCC, PTP_OPC_MessageBCC);
register_property("Message Read", LIBMTP_PROPERTY_MessageRead, PTP_OPC_MessageRead);
register_property("Message Received Time", LIBMTP_PROPERTY_MessageReceivedTime, PTP_OPC_MessageReceivedTime);
register_property("Message Sender", LIBMTP_PROPERTY_MessageSender, PTP_OPC_MessageSender);
register_property("Activity Begin Time", LIBMTP_PROPERTY_ActivityBeginTime, PTP_OPC_ActivityBeginTime);
register_property("Activity End Time", LIBMTP_PROPERTY_ActivityEndTime, PTP_OPC_ActivityEndTime);
register_property("Activity Location", LIBMTP_PROPERTY_ActivityLocation, PTP_OPC_ActivityLocation);
register_property("Activity Required Attendees", LIBMTP_PROPERTY_ActivityRequiredAttendees, PTP_OPC_ActivityRequiredAttendees);
register_property("Optional Attendees", LIBMTP_PROPERTY_ActivityOptionalAttendees, PTP_OPC_ActivityOptionalAttendees);
register_property("Activity Resources", LIBMTP_PROPERTY_ActivityResources, PTP_OPC_ActivityResources);
register_property("Activity Accepted", LIBMTP_PROPERTY_ActivityAccepted, PTP_OPC_ActivityAccepted);
register_property("Owner", LIBMTP_PROPERTY_Owner, PTP_OPC_Owner);
register_property("Editor", LIBMTP_PROPERTY_Editor, PTP_OPC_Editor);
register_property("Webmaster", LIBMTP_PROPERTY_Webmaster, PTP_OPC_Webmaster);
register_property("URL Source", LIBMTP_PROPERTY_URLSource, PTP_OPC_URLSource);
register_property("URL Destination", LIBMTP_PROPERTY_URLDestination, PTP_OPC_URLDestination);
register_property("Time Bookmark", LIBMTP_PROPERTY_TimeBookmark, PTP_OPC_TimeBookmark);
register_property("Object Bookmark", LIBMTP_PROPERTY_ObjectBookmark, PTP_OPC_ObjectBookmark);
register_property("Byte Bookmark", LIBMTP_PROPERTY_ByteBookmark, PTP_OPC_ByteBookmark);
register_property("Last Build Date", LIBMTP_PROPERTY_LastBuildDate, PTP_OPC_LastBuildDate);
register_property("Time To Live", LIBMTP_PROPERTY_TimetoLive, PTP_OPC_TimetoLive);
register_property("Media GUID", LIBMTP_PROPERTY_MediaGUID, PTP_OPC_MediaGUID);
register_property("Total Bit Rate", LIBMTP_PROPERTY_TotalBitRate, PTP_OPC_TotalBitRate);
register_property("Bit Rate Type", LIBMTP_PROPERTY_BitRateType, PTP_OPC_BitRateType);
register_property("Sample Rate", LIBMTP_PROPERTY_SampleRate, PTP_OPC_SampleRate);
register_property("Number Of Channels", LIBMTP_PROPERTY_NumberOfChannels, PTP_OPC_NumberOfChannels);
register_property("Audio Bit Depth", LIBMTP_PROPERTY_AudioBitDepth, PTP_OPC_AudioBitDepth);
register_property("Scan Depth", LIBMTP_PROPERTY_ScanDepth, PTP_OPC_ScanDepth);
register_property("Audio WAVE Codec", LIBMTP_PROPERTY_AudioWAVECodec, PTP_OPC_AudioWAVECodec);
register_property("Audio Bit Rate", LIBMTP_PROPERTY_AudioBitRate, PTP_OPC_AudioBitRate);
register_property("Video Four CC Codec", LIBMTP_PROPERTY_VideoFourCCCodec, PTP_OPC_VideoFourCCCodec);
register_property("Video Bit Rate", LIBMTP_PROPERTY_VideoBitRate, PTP_OPC_VideoBitRate);
register_property("Frames Per Thousand Seconds", LIBMTP_PROPERTY_FramesPerThousandSeconds, PTP_OPC_FramesPerThousandSeconds);
register_property("Key Frame Distance", LIBMTP_PROPERTY_KeyFrameDistance, PTP_OPC_KeyFrameDistance);
register_property("Buffer Size", LIBMTP_PROPERTY_BufferSize, PTP_OPC_BufferSize);
register_property("Encoding Quality", LIBMTP_PROPERTY_EncodingQuality, PTP_OPC_EncodingQuality);
register_property("Encoding Profile", LIBMTP_PROPERTY_EncodingProfile, PTP_OPC_EncodingProfile);
register_property("Buy flag", LIBMTP_PROPERTY_BuyFlag, PTP_OPC_BuyFlag);
register_property("Unknown property", LIBMTP_PROPERTY_UNKNOWN, 0);
}
/**
* Returns the PTP property that maps to a certain libmtp internal property type.
* @param inproperty the MTP library interface property
* @return the PTP (libgphoto2) property type
*/
static uint16_t map_libmtp_property_to_ptp_property(LIBMTP_property_t inproperty)
{
propertymap_t *current;
current = g_propertymap;
while (current != NULL) {
if(current->id == inproperty) {
return current->ptp_id;
}
current = current->next;
}
return 0;
}
/**
* Returns the MTP internal interface property that maps to a certain ptp
* interface property.
* @param inproperty the PTP (libgphoto2) interface property
* @return the MTP library interface property
*/
static LIBMTP_property_t map_ptp_property_to_libmtp_property(uint16_t inproperty)
{
propertymap_t *current;
current = g_propertymap;
while (current != NULL) {
if(current->ptp_id == inproperty) {
return current->id;
}
current = current->next;
}
// printf("map_ptp_type_to_libmtp_type: unknown filetype.\n");
return LIBMTP_PROPERTY_UNKNOWN;
}
/**
* Set the debug level.
*
* By default, the debug level is set to '0' (disable).
*/
void LIBMTP_Set_Debug(int level)
{
if (LIBMTP_debug || level)
LIBMTP_ERROR("LIBMTP_Set_Debug: Setting debugging level to %d (0x%02x) "
"(%s)\n", level, level, level ? "on" : "off");
LIBMTP_debug = level;
}
/**
* Initialize the library. You are only supposed to call this
* one, before using the library for the first time in a program.
* Never re-initialize libmtp!
*
* The only thing this does at the moment is to initialise the
* filetype mapping table, as well as load MTPZ data if necessary.
*/
void LIBMTP_Init(void)
{
const char *env_debug = getenv("LIBMTP_DEBUG");
if (env_debug) {
const long debug_flags = strtol(env_debug, NULL, 0);
if (debug_flags != LONG_MIN && debug_flags != LONG_MAX &&
INT_MIN <= debug_flags && debug_flags <= INT_MAX) {
LIBMTP_Set_Debug(debug_flags);
} else {
fprintf(stderr, "LIBMTP_Init: error setting debug flags from environment "
"value \"%s\"\n", env_debug);
}
}
init_filemap();
init_propertymap();
if (mtpz_loaddata() == -1)
use_mtpz = 0;
else
use_mtpz = 1;
return;
}
/**
* This helper function returns a textual description for a libmtp
* file type to be used in dialog boxes etc.
* @param intype the libmtp internal filetype to get a description for.
* @return a string representing the filetype, this must <b>NOT</b>
* be free():ed by the caller!
*/
char const * LIBMTP_Get_Filetype_Description(LIBMTP_filetype_t intype)
{
filemap_t *current;
current = g_filemap;
while (current != NULL) {
if(current->id == intype) {
return current->description;
}
current = current->next;
}
return "Unknown filetype";
}
/**
* This helper function returns a textual description for a libmtp
* property to be used in dialog boxes etc.
* @param inproperty the libmtp internal property to get a description for.
* @return a string representing the filetype, this must <b>NOT</b>
* be free():ed by the caller!
*/
char const * LIBMTP_Get_Property_Description(LIBMTP_property_t inproperty)
{
propertymap_t *current;
current = g_propertymap;
while (current != NULL) {
if(current->id == inproperty) {
return current->description;
}
current = current->next;
}
return "Unknown property";
}
/**
* This function will do its best to fit a 16bit
* value into a PTP object property if the property
* is limited in range or step sizes.
*/
static uint16_t adjust_u16(uint16_t val, PTPObjectPropDesc *opd)
{
switch (opd->FormFlag) {
case PTP_DPFF_Range:
if (val < opd->FORM.Range.MinimumValue.u16) {
return opd->FORM.Range.MinimumValue.u16;
}
if (val > opd->FORM.Range.MaximumValue.u16) {
return opd->FORM.Range.MaximumValue.u16;
}
// Round down to last step.
if (val % opd->FORM.Range.StepSize.u16 != 0) {
return val - (val % opd->FORM.Range.StepSize.u16);
}
return val;
break;
case PTP_DPFF_Enumeration:
{
int i;
uint16_t bestfit = opd->FORM.Enum.SupportedValue[0].u16;
for (i=0; i<opd->FORM.Enum.NumberOfValues; i++) {
if (val == opd->FORM.Enum.SupportedValue[i].u16) {
return val;
}
// Rough guess of best fit
if (opd->FORM.Enum.SupportedValue[i].u16 < val) {
bestfit = opd->FORM.Enum.SupportedValue[i].u16;
}
}
// Just some default that'll work.
return bestfit;
}
default:
// Will accept any value
break;
}
return val;
}
/**
* This function will do its best to fit a 32bit
* value into a PTP object property if the property
* is limited in range or step sizes.
*/
static uint32_t adjust_u32(uint32_t val, PTPObjectPropDesc *opd)
{
switch (opd->FormFlag) {
case PTP_DPFF_Range:
if (val < opd->FORM.Range.MinimumValue.u32) {
return opd->FORM.Range.MinimumValue.u32;
}
if (val > opd->FORM.Range.MaximumValue.u32) {
return opd->FORM.Range.MaximumValue.u32;
}
// Round down to last step.
if (val % opd->FORM.Range.StepSize.u32 != 0) {
return val - (val % opd->FORM.Range.StepSize.u32);
}
return val;
break;
case PTP_DPFF_Enumeration:
{
int i;
uint32_t bestfit = opd->FORM.Enum.SupportedValue[0].u32;
for (i=0; i<opd->FORM.Enum.NumberOfValues; i++) {
if (val == opd->FORM.Enum.SupportedValue[i].u32) {
return val;
}
// Rough guess of best fit
if (opd->FORM.Enum.SupportedValue[i].u32 < val) {
bestfit = opd->FORM.Enum.SupportedValue[i].u32;
}
}
// Just some default that'll work.
return bestfit;
}
default:
// Will accept any value
break;
}
return val;
}
/**
* This function returns a newly created ISO 8601 timestamp with the
* current time in as high precision as possible. It even adds
* the time zone if it can.
*/
static char *get_iso8601_stamp(void)
{
time_t curtime;
struct tm *loctime;
char tmp[64];
curtime = time(NULL);
loctime = localtime(&curtime);
strftime (tmp, sizeof(tmp), "%Y%m%dT%H%M%S.0%z", loctime);
return strdup(tmp);
}
/**
* Gets the allowed values (range or enum) for a property
* @param device a pointer to an MTP device
* @param property the property to query
* @param filetype the filetype of the object you want to set values for
* @param allowed_vals pointer to a LIBMTP_allowed_values_t struct to
* receive the allowed values. Call LIBMTP_destroy_allowed_values_t
* on this on successful completion.
* @return 0 on success, any other value means failure
*/
int LIBMTP_Get_Allowed_Property_Values(LIBMTP_mtpdevice_t *device, LIBMTP_property_t const property,
LIBMTP_filetype_t const filetype, LIBMTP_allowed_values_t *allowed_vals)
{
PTPObjectPropDesc opd;
uint16_t ret = 0;
ret = ptp_mtp_getobjectpropdesc(device->params, map_libmtp_property_to_ptp_property(property), map_libmtp_type_to_ptp_type(filetype), &opd);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Allowed_Property_Values(): could not get property description.");
return -1;
}
if (opd.FormFlag == PTP_OPFF_Enumeration) {
int i = 0;
allowed_vals->is_range = 0;
allowed_vals->num_entries = opd.FORM.Enum.NumberOfValues;
switch (opd.DataType)
{
case PTP_DTC_INT8:
allowed_vals->i8vals = malloc(sizeof(int8_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_INT8;
break;
case PTP_DTC_UINT8:
allowed_vals->u8vals = malloc(sizeof(uint8_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_UINT8;
break;
case PTP_DTC_INT16:
allowed_vals->i16vals = malloc(sizeof(int16_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_INT16;
break;
case PTP_DTC_UINT16:
allowed_vals->u16vals = malloc(sizeof(uint16_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_UINT16;
break;
case PTP_DTC_INT32:
allowed_vals->i32vals = malloc(sizeof(int32_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_INT32;
break;
case PTP_DTC_UINT32:
allowed_vals->u32vals = malloc(sizeof(uint32_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_UINT32;
break;
case PTP_DTC_INT64:
allowed_vals->i64vals = malloc(sizeof(int64_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_INT64;
break;
case PTP_DTC_UINT64:
allowed_vals->u64vals = malloc(sizeof(uint64_t) * opd.FORM.Enum.NumberOfValues);
allowed_vals->datatype = LIBMTP_DATATYPE_UINT64;
break;
}
for (i = 0; i < opd.FORM.Enum.NumberOfValues; i++) {
switch (opd.DataType)
{
case PTP_DTC_INT8:
allowed_vals->i8vals[i] = opd.FORM.Enum.SupportedValue[i].i8;
break;
case PTP_DTC_UINT8:
allowed_vals->u8vals[i] = opd.FORM.Enum.SupportedValue[i].u8;
break;
case PTP_DTC_INT16:
allowed_vals->i16vals[i] = opd.FORM.Enum.SupportedValue[i].i16;
break;
case PTP_DTC_UINT16:
allowed_vals->u16vals[i] = opd.FORM.Enum.SupportedValue[i].u16;
break;
case PTP_DTC_INT32:
allowed_vals->i32vals[i] = opd.FORM.Enum.SupportedValue[i].i32;
break;
case PTP_DTC_UINT32:
allowed_vals->u32vals[i] = opd.FORM.Enum.SupportedValue[i].u32;
break;
case PTP_DTC_INT64:
allowed_vals->i64vals[i] = opd.FORM.Enum.SupportedValue[i].i64;
break;
case PTP_DTC_UINT64:
allowed_vals->u64vals[i] = opd.FORM.Enum.SupportedValue[i].u64;
break;
}
}
ptp_free_objectpropdesc(&opd);
return 0;
} else if (opd.FormFlag == PTP_OPFF_Range) {
allowed_vals->is_range = 1;
switch (opd.DataType)
{
case PTP_DTC_INT8:
allowed_vals->i8min = opd.FORM.Range.MinimumValue.i8;
allowed_vals->i8max = opd.FORM.Range.MaximumValue.i8;
allowed_vals->i8step = opd.FORM.Range.StepSize.i8;
allowed_vals->datatype = LIBMTP_DATATYPE_INT8;
break;
case PTP_DTC_UINT8:
allowed_vals->u8min = opd.FORM.Range.MinimumValue.u8;
allowed_vals->u8max = opd.FORM.Range.MaximumValue.u8;
allowed_vals->u8step = opd.FORM.Range.StepSize.u8;
allowed_vals->datatype = LIBMTP_DATATYPE_UINT8;
break;
case PTP_DTC_INT16:
allowed_vals->i16min = opd.FORM.Range.MinimumValue.i16;
allowed_vals->i16max = opd.FORM.Range.MaximumValue.i16;
allowed_vals->i16step = opd.FORM.Range.StepSize.i16;
allowed_vals->datatype = LIBMTP_DATATYPE_INT16;
break;
case PTP_DTC_UINT16:
allowed_vals->u16min = opd.FORM.Range.MinimumValue.u16;
allowed_vals->u16max = opd.FORM.Range.MaximumValue.u16;
allowed_vals->u16step = opd.FORM.Range.StepSize.u16;
allowed_vals->datatype = LIBMTP_DATATYPE_UINT16;
break;
case PTP_DTC_INT32:
allowed_vals->i32min = opd.FORM.Range.MinimumValue.i32;
allowed_vals->i32max = opd.FORM.Range.MaximumValue.i32;
allowed_vals->i32step = opd.FORM.Range.StepSize.i32;
allowed_vals->datatype = LIBMTP_DATATYPE_INT32;
break;
case PTP_DTC_UINT32:
allowed_vals->u32min = opd.FORM.Range.MinimumValue.u32;
allowed_vals->u32max = opd.FORM.Range.MaximumValue.u32;
allowed_vals->u32step = opd.FORM.Range.StepSize.u32;
allowed_vals->datatype = LIBMTP_DATATYPE_UINT32;
break;
case PTP_DTC_INT64:
allowed_vals->i64min = opd.FORM.Range.MinimumValue.i64;
allowed_vals->i64max = opd.FORM.Range.MaximumValue.i64;
allowed_vals->i64step = opd.FORM.Range.StepSize.i64;
allowed_vals->datatype = LIBMTP_DATATYPE_INT64;
break;
case PTP_DTC_UINT64:
allowed_vals->u64min = opd.FORM.Range.MinimumValue.u64;
allowed_vals->u64max = opd.FORM.Range.MaximumValue.u64;
allowed_vals->u64step = opd.FORM.Range.StepSize.u64;
allowed_vals->datatype = LIBMTP_DATATYPE_UINT64;
break;
}
return 0;
} else
return -1;
}
/**
* Destroys a LIBMTP_allowed_values_t struct
* @param allowed_vals the struct to destroy
*/
void LIBMTP_destroy_allowed_values_t(LIBMTP_allowed_values_t *allowed_vals)
{
if (!allowed_vals->is_range)
{
switch (allowed_vals->datatype)
{
case LIBMTP_DATATYPE_INT8:
if (allowed_vals->i8vals)
free(allowed_vals->i8vals);
break;
case LIBMTP_DATATYPE_UINT8:
if (allowed_vals->u8vals)
free(allowed_vals->u8vals);
break;
case LIBMTP_DATATYPE_INT16:
if (allowed_vals->i16vals)
free(allowed_vals->i16vals);
break;
case LIBMTP_DATATYPE_UINT16:
if (allowed_vals->u16vals)
free(allowed_vals->u16vals);
break;
case LIBMTP_DATATYPE_INT32:
if (allowed_vals->i32vals)
free(allowed_vals->i32vals);
break;
case LIBMTP_DATATYPE_UINT32:
if (allowed_vals->u32vals)
free(allowed_vals->u32vals);
break;
case LIBMTP_DATATYPE_INT64:
if (allowed_vals->i64vals)
free(allowed_vals->i64vals);
break;
case LIBMTP_DATATYPE_UINT64:
if (allowed_vals->u64vals)
free(allowed_vals->u64vals);
break;
}
}
}
/**
* Determine if a property is supported for a given file type
* @param device a pointer to an MTP device
* @param property the property to query
* @param filetype the filetype of the object you want to set values for
* @return 0 if not supported, positive if supported, negative on error
*/
int LIBMTP_Is_Property_Supported(LIBMTP_mtpdevice_t *device, LIBMTP_property_t const property,
LIBMTP_filetype_t const filetype)
{
uint16_t *props = NULL;
uint32_t propcnt = 0;
uint16_t ret = 0;
unsigned int i = 0;
int supported = 0;
uint16_t ptp_prop = map_libmtp_property_to_ptp_property(property);
if (!ptp_operation_issupported(device->params, PTP_OC_MTP_GetObjectPropsSupported))
return 0;
ret = ptp_mtp_getobjectpropssupported(device->params, map_libmtp_type_to_ptp_type(filetype), &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Is_Property_Supported(): could not get properties supported.");
return -1;
}
for (i = 0; i < propcnt; i++) {
if (props[i] == ptp_prop) {
supported = 1;
break;
}
}
free(props);
return supported;
}
/**
* Retrieves a string from an object
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @return valid string or NULL on failure. The returned string
* must bee <code>free()</code>:ed by the caller after
* use.
*/
char *LIBMTP_Get_String_From_Object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id)
{
return get_string_from_object(device, object_id, attribute_id);
}
/**
* Retrieves an unsigned 64-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value_default Default value to return on failure
* @return the value
*/
uint64_t LIBMTP_Get_u64_From_Object(LIBMTP_mtpdevice_t *device,uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint64_t const value_default)
{
return get_u64_from_object(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value_default);
}
/**
* Retrieves an unsigned 32-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value_default Default value to return on failure
* @return the value
*/
uint32_t LIBMTP_Get_u32_From_Object(LIBMTP_mtpdevice_t *device,uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint32_t const value_default)
{
return get_u32_from_object(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value_default);
}
/**
* Retrieves an unsigned 16-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value_default Default value to return on failure
* @return a value
*/
uint16_t LIBMTP_Get_u16_From_Object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint16_t const value_default)
{
return get_u16_from_object(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value_default);
}
/**
* Retrieves an unsigned 8-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value_default Default value to return on failure
* @return a value
*/
uint8_t LIBMTP_Get_u8_From_Object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint8_t const value_default)
{
return get_u8_from_object(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value_default);
}
/**
* Sets an object attribute from a string
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param string string value to set
* @return 0 on success, any other value means failure
*/
int LIBMTP_Set_Object_String(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id, char const * const string)
{
return set_object_string(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), string);
}
/**
* Sets an object attribute from an unsigned 32-bit integer
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value 32-bit unsigned integer to set
* @return 0 on success, any other value means failure
*/
int LIBMTP_Set_Object_u32(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint32_t const value)
{
return set_object_u32(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value);
}
/**
* Sets an object attribute from an unsigned 16-bit integer
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value 16-bit unsigned integer to set
* @return 0 on success, any other value means failure
*/
int LIBMTP_Set_Object_u16(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint16_t const value)
{
return set_object_u16(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value);
}
/**
* Sets an object attribute from an unsigned 8-bit integer
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id MTP attribute ID
* @param value 8-bit unsigned integer to set
* @return 0 on success, any other value means failure
*/
int LIBMTP_Set_Object_u8(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
LIBMTP_property_t const attribute_id, uint8_t const value)
{
return set_object_u8(device, object_id, map_libmtp_property_to_ptp_property(attribute_id), value);
}
/**
* Retrieves a string from an object
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @return valid string or NULL on failure. The returned string
* must bee <code>free()</code>:ed by the caller after
* use.
*/
static char *get_string_from_object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id)
{
PTPPropertyValue propval;
char *retstring = NULL;
PTPParams *params;
uint16_t ret;
MTPProperties *prop;
if (!device || !object_id)
return NULL;
params = (PTPParams *) device->params;
prop = ptp_find_object_prop_in_cache(params, object_id, attribute_id);
if (prop) {
if (prop->propval.str != NULL)
return strdup(prop->propval.str);
else
return NULL;
}
ret = ptp_mtp_getobjectpropvalue(params, object_id, attribute_id, &propval, PTP_DTC_STR);
if (ret == PTP_RC_OK) {
if (propval.str != NULL) {
retstring = (char *) strdup(propval.str);
free(propval.str);
}
} else {
add_ptp_error_to_errorstack(device, ret, "get_string_from_object(): could not get object string.");
}
return retstring;
}
/**
* Retrieves an unsigned 64-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value_default Default value to return on failure
* @return the value
*/
static uint64_t get_u64_from_object(LIBMTP_mtpdevice_t *device,uint32_t const object_id,
uint16_t const attribute_id, uint64_t const value_default)
{
PTPPropertyValue propval;
uint64_t retval = value_default;
PTPParams *params;
uint16_t ret;
MTPProperties *prop;
if (!device)
return value_default;
params = (PTPParams *) device->params;
prop = ptp_find_object_prop_in_cache(params, object_id, attribute_id);
if (prop)
return prop->propval.u64;
ret = ptp_mtp_getobjectpropvalue(params, object_id,
attribute_id,
&propval,
PTP_DTC_UINT64);
if (ret == PTP_RC_OK) {
retval = propval.u64;
} else {
add_ptp_error_to_errorstack(device, ret, "get_u64_from_object(): could not get unsigned 64bit integer from object.");
}
return retval;
}
/**
* Retrieves an unsigned 32-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value_default Default value to return on failure
* @return the value
*/
static uint32_t get_u32_from_object(LIBMTP_mtpdevice_t *device,uint32_t const object_id,
uint16_t const attribute_id, uint32_t const value_default)
{
PTPPropertyValue propval;
uint32_t retval = value_default;
PTPParams *params;
uint16_t ret;
MTPProperties *prop;
if (!device)
return value_default;
params = (PTPParams *) device->params;
prop = ptp_find_object_prop_in_cache(params, object_id, attribute_id);
if (prop)
return prop->propval.u32;
ret = ptp_mtp_getobjectpropvalue(params, object_id,
attribute_id,
&propval,
PTP_DTC_UINT32);
if (ret == PTP_RC_OK) {
retval = propval.u32;
} else {
add_ptp_error_to_errorstack(device, ret, "get_u32_from_object(): could not get unsigned 32bit integer from object.");
}
return retval;
}
/**
* Retrieves an unsigned 16-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value_default Default value to return on failure
* @return a value
*/
static uint16_t get_u16_from_object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint16_t const value_default)
{
PTPPropertyValue propval;
uint16_t retval = value_default;
PTPParams *params;
uint16_t ret;
MTPProperties *prop;
if (!device)
return value_default;
params = (PTPParams *) device->params;
// This O(n) search should not be used so often, since code
// using the cached properties don't usually call this function.
prop = ptp_find_object_prop_in_cache(params, object_id, attribute_id);
if (prop)
return prop->propval.u16;
ret = ptp_mtp_getobjectpropvalue(params, object_id,
attribute_id,
&propval,
PTP_DTC_UINT16);
if (ret == PTP_RC_OK) {
retval = propval.u16;
} else {
add_ptp_error_to_errorstack(device, ret, "get_u16_from_object(): could not get unsigned 16bit integer from object.");
}
return retval;
}
/**
* Retrieves an unsigned 8-bit integer from an object attribute
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value_default Default value to return on failure
* @return a value
*/
static uint8_t get_u8_from_object(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint8_t const value_default)
{
PTPPropertyValue propval;
uint8_t retval = value_default;
PTPParams *params;
uint16_t ret;
MTPProperties *prop;
if (!device)
return value_default;
params = (PTPParams *) device->params;
// This O(n) search should not be used so often, since code
// using the cached properties don't usually call this function.
prop = ptp_find_object_prop_in_cache(params, object_id, attribute_id);
if (prop)
return prop->propval.u8;
ret = ptp_mtp_getobjectpropvalue(params, object_id,
attribute_id,
&propval,
PTP_DTC_UINT8);
if (ret == PTP_RC_OK) {
retval = propval.u8;
} else {
add_ptp_error_to_errorstack(device, ret, "get_u8_from_object(): could not get unsigned 8bit integer from object.");
}
return retval;
}
/**
* Sets an object attribute from a string
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param string string value to set
* @return 0 on success, any other value means failure
*/
static int set_object_string(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, char const * const string)
{
PTPPropertyValue propval;
PTPParams *params;
uint16_t ret;
if (!device || !string)
return -1;
params = (PTPParams *) device->params;
if (!ptp_operation_issupported(params,PTP_OC_MTP_SetObjectPropValue)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_string(): could not set object string: "
"PTP_OC_MTP_SetObjectPropValue not supported.");
return -1;
}
propval.str = (char *) string;
ret = ptp_mtp_setobjectpropvalue(params, object_id, attribute_id, &propval, PTP_DTC_STR);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "set_object_string(): could not set object string.");
return -1;
}
return 0;
}
/**
* Sets an object attribute from an unsigned 32-bit integer
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value 32-bit unsigned integer to set
* @return 0 on success, any other value means failure
*/
static int set_object_u32(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint32_t const value)
{
PTPPropertyValue propval;
PTPParams *params;
uint16_t ret;
if (!device)
return -1;
params = (PTPParams *) device->params;
if (!ptp_operation_issupported(params,PTP_OC_MTP_SetObjectPropValue)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_u32(): could not set unsigned 32bit integer property: "
"PTP_OC_MTP_SetObjectPropValue not supported.");
return -1;
}
propval.u32 = value;
ret = ptp_mtp_setobjectpropvalue(params, object_id, attribute_id, &propval, PTP_DTC_UINT32);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "set_object_u32(): could not set unsigned 32bit integer property.");
return -1;
}
return 0;
}
/**
* Sets an object attribute from an unsigned 16-bit integer
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value 16-bit unsigned integer to set
* @return 0 on success, any other value means failure
*/
static int set_object_u16(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint16_t const value)
{
PTPPropertyValue propval;
PTPParams *params;
uint16_t ret;
if (!device)
return 1;
params = (PTPParams *) device->params;
if (!ptp_operation_issupported(params,PTP_OC_MTP_SetObjectPropValue)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_u16(): could not set unsigned 16bit integer property: "
"PTP_OC_MTP_SetObjectPropValue not supported.");
return -1;
}
propval.u16 = value;
ret = ptp_mtp_setobjectpropvalue(params, object_id, attribute_id, &propval, PTP_DTC_UINT16);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "set_object_u16(): could not set unsigned 16bit integer property.");
return 1;
}
return 0;
}
/**
* Sets an object attribute from an unsigned 8-bit integer
*
* @param device a pointer to an MTP device.
* @param object_id Object reference
* @param attribute_id PTP attribute ID
* @param value 8-bit unsigned integer to set
* @return 0 on success, any other value means failure
*/
static int set_object_u8(LIBMTP_mtpdevice_t *device, uint32_t const object_id,
uint16_t const attribute_id, uint8_t const value)
{
PTPPropertyValue propval;
PTPParams *params;
uint16_t ret;
if (!device)
return 1;
params = (PTPParams *) device->params;
if (!ptp_operation_issupported(params,PTP_OC_MTP_SetObjectPropValue)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_u8(): could not set unsigned 8bit integer property: "
"PTP_OC_MTP_SetObjectPropValue not supported.");
return -1;
}
propval.u8 = value;
ret = ptp_mtp_setobjectpropvalue(params, object_id, attribute_id, &propval, PTP_DTC_UINT8);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "set_object_u8(): could not set unsigned 8bit integer property.");
return 1;
}
return 0;
}
/**
* Get connected MTP device by list position.
* @return a device pointer.
* @see LIBMTP_Get_Connected_Devices()
*/
LIBMTP_mtpdevice_t *LIBMTP_Get_Device(int device_nr)
{
LIBMTP_mtpdevice_t *device = NULL;
LIBMTP_raw_device_t *devices;
int numdevs;
LIBMTP_error_number_t ret;
ret = LIBMTP_Detect_Raw_Devices(&devices, &numdevs);
if (ret != LIBMTP_ERROR_NONE) {
return NULL;
}
if (devices == NULL || numdevs == 0) {
free(devices);
return NULL;
}
if (device_nr < 0 || device_nr >= numdevs) {
free(devices);
return NULL;
}
device = LIBMTP_Open_Raw_Device(&devices[device_nr]);
free(devices);
return device;
}
/**
* Get the first (as in "first in the list of") connected MTP device.
* @return a device pointer.
* @see LIBMTP_Get_Connected_Devices()
*/
LIBMTP_mtpdevice_t *LIBMTP_Get_First_Device(void)
{
return LIBMTP_Get_Device(0);
}
/**
* Overriding debug function.
* This way we can disable debug prints.
*/
static void
#ifdef __GNUC__
__attribute__((__format__(printf,2,0)))
#endif
LIBMTP_ptp_debug(void *data, const char *format, va_list args)
{
if ((LIBMTP_debug & LIBMTP_DEBUG_PTP) != 0) {
vfprintf (stderr, format, args);
fprintf (stderr, "\n");
fflush (stderr);
}
}
/**
* Overriding error function.
* This way we can capture all error etc to our errorstack.
*/
static void
#ifdef __GNUC__
__attribute__((__format__(printf,2,0)))
#endif
LIBMTP_ptp_error(void *data, const char *format, va_list args)
{
// if (data == NULL) {
vfprintf (stderr, format, args);
fflush (stderr);
/*
FIXME: find out how we shall get the device here.
} else {
PTP_USB *ptp_usb = data;
LIBMTP_mtpdevice_t *device = ...;
char buf[2048];
vsnprintf (buf, sizeof (buf), format, args);
add_error_to_errorstack(device,
LIBMTP_ERROR_PTP_LAYER,
buf);
}
*/
}
/**
* Parses the extension descriptor, there may be stuff in
* this that we want to know about.
*/
static void parse_extension_descriptor(LIBMTP_mtpdevice_t *mtpdevice,
char *desc)
{
unsigned int start = 0;
unsigned int end = 0;
/* NULL on Canon A70 */
if (!desc)
return;
/* descriptors are divided by semicolons */
while (end < strlen(desc)) {
/* Skip past initial whitespace */
while ((end < strlen(desc)) && (desc[start] == ' ' )) {
start++;
end++;
}
/* Detect extension */
while ((end < strlen(desc)) && (desc[end] != ';'))
end++;
if (end < strlen(desc)) {
char *element = strndup(desc + start, end-start);
if (element) {
unsigned int i = 0;
// printf(" Element: \"%s\"\n", element);
/* Parse for an extension */
while ((i < strlen(element)) && (element[i] != ':'))
i++;
if (i < strlen(element)) {
char *name = strndup(element, i);
int major = 0, minor = 0;
/* extension versions have to be MAJOR.MINOR, but Samsung has one
* with just 0, so just cope with those cases too */
if ( (2 == sscanf(element+i+1,"%d.%d",&major,&minor)) ||
(1 == sscanf(element+i+1,"%d",&major))
) {
LIBMTP_device_extension_t *extension;
extension = malloc(sizeof(LIBMTP_device_extension_t));
extension->name = name;
extension->major = major;
extension->minor = minor;
extension->next = NULL;
if (mtpdevice->extensions == NULL) {
mtpdevice->extensions = extension;
} else {
LIBMTP_device_extension_t *tmp = mtpdevice->extensions;
while (tmp->next != NULL)
tmp = tmp->next;
tmp->next = extension;
}
} else {
LIBMTP_ERROR("LIBMTP ERROR: couldnt parse extension %s\n",
element);
}
}
free(element);
}
}
end++;
start = end;
}
}
/**
* This function opens a device from a raw device. It is the
* preferred way to access devices in the new interface where
* several devices can come and go as the library is working
* on a certain device.
* @param rawdevice the raw device to open a "real" device for.
* @return an open device.
*/
LIBMTP_mtpdevice_t *LIBMTP_Open_Raw_Device_Uncached(LIBMTP_raw_device_t *rawdevice)
{
LIBMTP_mtpdevice_t *mtp_device;
uint8_t bs = 0;
PTPParams *current_params;
PTP_USB *ptp_usb;
LIBMTP_error_number_t err;
unsigned int i;
/* Allocate dynamic space for our device */
mtp_device = (LIBMTP_mtpdevice_t *) malloc(sizeof(LIBMTP_mtpdevice_t));
/* Check if there was a memory allocation error */
if(mtp_device == NULL) {
/* There has been an memory allocation error. We are going to ignore this
device and attempt to continue */
/* TODO: This error statement could probably be a bit more robust */
LIBMTP_ERROR("LIBMTP PANIC: connect_usb_devices encountered a memory "
"allocation error with device %d on bus %d, trying to continue",
rawdevice->devnum, rawdevice->bus_location);
return NULL;
}
memset(mtp_device, 0, sizeof(LIBMTP_mtpdevice_t));
// Non-cached by default
mtp_device->cached = 0;
/* Create PTP params */
current_params = (PTPParams *) malloc(sizeof(PTPParams));
if (current_params == NULL) {
free(mtp_device);
return NULL;
}
memset(current_params, 0, sizeof(PTPParams));
current_params->device_flags = rawdevice->device_entry.device_flags;
current_params->nrofobjects = 0;
current_params->cachetime = 2;
current_params->objects = NULL;
current_params->response_packet_size = 0;
current_params->response_packet = NULL;
/* This will be a pointer to PTP_USB later */
current_params->data = NULL;
/* Set upp local debug and error functions */
current_params->debug_func = LIBMTP_ptp_debug;
current_params->error_func = LIBMTP_ptp_error;
/* TODO: Will this always be little endian? */
current_params->byteorder = PTP_DL_LE;
#if defined(HAVE_ICONV) && defined(HAVE_LANGINFO_H)
current_params->cd_locale_to_ucs2 = iconv_open("UTF-16LE", "UTF-8");
current_params->cd_ucs2_to_locale = iconv_open("UTF-8", "UTF-16LE");
if(current_params->cd_locale_to_ucs2 == (iconv_t) -1 ||
current_params->cd_ucs2_to_locale == (iconv_t) -1) {
LIBMTP_ERROR("LIBMTP PANIC: Cannot open iconv() converters to/from UCS-2!\n"
"Too old stdlibc, glibc and libiconv?\n");
free(current_params);
free(mtp_device);
return NULL;
}
#endif
mtp_device->params = current_params;
/* Create usbinfo, this also opens the session */
err = configure_usb_device(rawdevice,
current_params,
&mtp_device->usbinfo);
if (err != LIBMTP_ERROR_NONE) {
free(current_params);
free(mtp_device);
return NULL;
}
ptp_usb = (PTP_USB*) mtp_device->usbinfo;
/* Set pointer back to params */
ptp_usb->params = current_params;
/* Cache the device information for later use */
if (ptp_getdeviceinfo(current_params,
¤t_params->deviceinfo) != PTP_RC_OK) {
LIBMTP_ERROR("LIBMTP PANIC: Unable to read device information on device "
"%d on bus %d, trying to continue",
rawdevice->devnum, rawdevice->bus_location);
/* Prevent memory leaks for this device */
free(mtp_device->usbinfo);
free(mtp_device->params);
current_params = NULL;
free(mtp_device);
return NULL;
}
/* Check: if this is a PTP device, is it really tagged as MTP? */
if (current_params->deviceinfo.VendorExtensionID != 0x00000006) {
LIBMTP_ERROR("LIBMTP WARNING: no MTP vendor extension on device "
"%d on bus %d",
rawdevice->devnum, rawdevice->bus_location);
LIBMTP_ERROR("LIBMTP WARNING: VendorExtensionID: %08x",
current_params->deviceinfo.VendorExtensionID);
LIBMTP_ERROR("LIBMTP WARNING: VendorExtensionDesc: %s",
current_params->deviceinfo.VendorExtensionDesc);
LIBMTP_ERROR("LIBMTP WARNING: this typically means the device is PTP "
"(i.e. a camera) but not an MTP device at all. "
"Trying to continue anyway.");
}
parse_extension_descriptor(mtp_device,
current_params->deviceinfo.VendorExtensionDesc);
/*
* Android has a number of bugs, force-assign these bug flags
* if Android is encountered. Same thing for devices we detect
* as SONY NWZ Walkmen. I have no clue what "sony.net/WMFU" means
* I just know only NWZs have it.
*/
{
LIBMTP_device_extension_t *tmpext = mtp_device->extensions;
int is_microsoft_com_wpdna = 0;
int is_android = 0;
int is_sony_net_wmfu = 0;
int is_sonyericsson_com_se = 0;
/* Loop over extensions and set flags */
while (tmpext != NULL) {
if (!strcmp(tmpext->name, "microsoft.com/WPDNA"))
is_microsoft_com_wpdna = 1;
if (!strcmp(tmpext->name, "android.com"))
is_android = 1;
if (!strcmp(tmpext->name, "sony.net/WMFU"))
is_sony_net_wmfu = 1;
if (!strcmp(tmpext->name, "sonyericsson.com/SE"))
is_sonyericsson_com_se = 1;
tmpext = tmpext->next;
}
/* Check for specific stacks */
if (is_microsoft_com_wpdna && is_sonyericsson_com_se && !is_android) {
/*
* The Aricent stack seems to be detected by providing WPDNA, the SonyEricsson
* extension and NO Android extension.
*/
ptp_usb->rawdevice.device_entry.device_flags |= DEVICE_FLAGS_ARICENT_BUGS;
LIBMTP_INFO("Aricent MTP stack device detected, assigning default bug flags\n");
}
else if (is_android) {
/*
* If bugs are fixed in later versions, test on tmpext->major, tmpext->minor
*/
ptp_usb->rawdevice.device_entry.device_flags |= DEVICE_FLAGS_ANDROID_BUGS;
LIBMTP_INFO("Android device detected, assigning default bug flags\n");
}
else if (is_sony_net_wmfu) {
ptp_usb->rawdevice.device_entry.device_flags |= DEVICE_FLAGS_SONY_NWZ_BUGS;
LIBMTP_INFO("SONY NWZ device detected, assigning default bug flags\n");
}
}
/*
* If the OGG or FLAC filetypes are flagged as "unknown", check
* if the firmware has been updated to actually support it.
*/
if (FLAG_OGG_IS_UNKNOWN(ptp_usb)) {
for (i=0;i<current_params->deviceinfo.ImageFormats_len;i++) {
if (current_params->deviceinfo.ImageFormats[i] == PTP_OFC_MTP_OGG) {
/* This is not unknown anymore, unflag it */
ptp_usb->rawdevice.device_entry.device_flags &=
~DEVICE_FLAG_OGG_IS_UNKNOWN;
break;
}
}
}
if (FLAG_FLAC_IS_UNKNOWN(ptp_usb)) {
for (i=0;i<current_params->deviceinfo.ImageFormats_len;i++) {
if (current_params->deviceinfo.ImageFormats[i] == PTP_OFC_MTP_FLAC) {
/* This is not unknown anymore, unflag it */
ptp_usb->rawdevice.device_entry.device_flags &=
~DEVICE_FLAG_FLAC_IS_UNKNOWN;
break;
}
}
}
/* Determine if the object size supported is 32 or 64 bit wide */
if (ptp_operation_issupported(current_params,PTP_OC_MTP_GetObjectPropsSupported)) {
for (i=0;i<current_params->deviceinfo.ImageFormats_len;i++) {
PTPObjectPropDesc opd;
if (ptp_mtp_getobjectpropdesc(current_params,
PTP_OPC_ObjectSize,
current_params->deviceinfo.ImageFormats[i],
&opd) != PTP_RC_OK) {
LIBMTP_ERROR("LIBMTP PANIC: "
"could not inspect object property description 0x%04x!\n", current_params->deviceinfo.ImageFormats[i]);
} else {
if (opd.DataType == PTP_DTC_UINT32) {
if (bs == 0) {
bs = 32;
} else if (bs != 32) {
LIBMTP_ERROR("LIBMTP PANIC: "
"different objects support different object sizes!\n");
bs = 0;
break;
}
} else if (opd.DataType == PTP_DTC_UINT64) {
if (bs == 0) {
bs = 64;
} else if (bs != 64) {
LIBMTP_ERROR("LIBMTP PANIC: "
"different objects support different object sizes!\n");
bs = 0;
break;
}
} else {
// Ignore if other size.
LIBMTP_ERROR("LIBMTP PANIC: "
"awkward object size data type: %04x\n", opd.DataType);
bs = 0;
break;
}
}
}
}
if (bs == 0) {
// Could not detect object bitsize, assume 32 bits
bs = 32;
}
mtp_device->object_bitsize = bs;
/* No Errors yet for this device */
mtp_device->errorstack = NULL;
/* Default Max Battery Level, we will adjust this if possible */
mtp_device->maximum_battery_level = 100;
/* Check if device supports reading maximum battery level */
if(!FLAG_BROKEN_BATTERY_LEVEL(ptp_usb) &&
ptp_property_issupported( current_params, PTP_DPC_BatteryLevel)) {
PTPDevicePropDesc dpd;
/* Try to read maximum battery level */
if(ptp_getdevicepropdesc(current_params,
PTP_DPC_BatteryLevel,
&dpd) != PTP_RC_OK) {
add_error_to_errorstack(mtp_device,
LIBMTP_ERROR_CONNECTING,
"Unable to read Maximum Battery Level for this "
"device even though the device supposedly "
"supports this functionality");
}
/* TODO: is this appropriate? */
/* If max battery level is 0 then leave the default, otherwise assign */
if (dpd.FORM.Range.MaximumValue.u8 != 0) {
mtp_device->maximum_battery_level = dpd.FORM.Range.MaximumValue.u8;
}
ptp_free_devicepropdesc(&dpd);
}
/* Set all default folders to 0xffffffffU (root directory) */
mtp_device->default_music_folder = 0xffffffffU;
mtp_device->default_playlist_folder = 0xffffffffU;
mtp_device->default_picture_folder = 0xffffffffU;
mtp_device->default_video_folder = 0xffffffffU;
mtp_device->default_organizer_folder = 0xffffffffU;
mtp_device->default_zencast_folder = 0xffffffffU;
mtp_device->default_album_folder = 0xffffffffU;
mtp_device->default_text_folder = 0xffffffffU;
/* Set initial storage information */
mtp_device->storage = NULL;
if (LIBMTP_Get_Storage(mtp_device, LIBMTP_STORAGE_SORTBY_NOTSORTED) == -1) {
add_error_to_errorstack(mtp_device,
LIBMTP_ERROR_GENERAL,
"Get Storage information failed.");
mtp_device->storage = NULL;
}
return mtp_device;
}
LIBMTP_mtpdevice_t *LIBMTP_Open_Raw_Device(LIBMTP_raw_device_t *rawdevice)
{
LIBMTP_mtpdevice_t *mtp_device = LIBMTP_Open_Raw_Device_Uncached(rawdevice);
if (mtp_device == NULL)
return NULL;
/* Check for MTPZ devices. */
if (use_mtpz) {
LIBMTP_device_extension_t *tmpext = mtp_device->extensions;
while (tmpext != NULL) {
if (!strcmp(tmpext->name, "microsoft.com/MTPZ")) {
LIBMTP_INFO("MTPZ device detected. Authenticating...\n");
if (PTP_RC_OK == ptp_mtpz_handshake(mtp_device->params)) {
LIBMTP_INFO ("(MTPZ) Successfully authenticated with device.\n");
} else {
LIBMTP_INFO ("(MTPZ) Failure - could not authenticate with device.\n");
}
break;
}
tmpext = tmpext->next;
}
}
// Set up this device as cached
mtp_device->cached = 1;
/*
* Then get the handles and try to locate the default folders.
* This has the desired side effect of caching all handles from
* the device which speeds up later operations.
*/
flush_handles(mtp_device);
return mtp_device;
}
/**
* To read events sent by the device, repeatedly call this function from a secondary
* thread until the return value is < 0.
*
* @param device a pointer to the MTP device to poll for events.
* @param event contains a pointer to be filled in with the event retrieved if the call
* is successful.
* @param out1 contains the param1 value from the raw event.
* @return 0 on success, any other value means the polling loop shall be
* terminated immediately for this session.
*/
int LIBMTP_Read_Event(LIBMTP_mtpdevice_t *device, LIBMTP_event_t *event, uint32_t *out1)
{
/*
* FIXME: Potential race-condition here, if client deallocs device
* while we're *not* waiting for input. As we'll be waiting for
* input most of the time, it's unlikely but still worth considering
* for improvement. Also we cannot affect the state of the cache etc
* unless we know we are the sole user on the device. A spinlock or
* mutex in the LIBMTP_mtpdevice_t is needed for this to work.
*/
PTPParams *params = (PTPParams *) device->params;
PTPContainer ptp_event;
uint16_t ret = ptp_usb_event_wait(params, &ptp_event);
if (ret != PTP_RC_OK) {
/* Device is closing down or other fatal stuff, exit thread */
return -1;
}
LIBMTP_Handle_Event(&ptp_event, event, out1);
return 0;
}
void LIBMTP_Handle_Event(PTPContainer *ptp_event,
LIBMTP_event_t *event, uint32_t *out1) {
uint16_t code;
uint32_t session_id;
uint32_t param1;
*event = LIBMTP_EVENT_NONE;
/* Process the event */
code = ptp_event->Code;
session_id = ptp_event->SessionID;
param1 = ptp_event->Param1;
switch(code) {
case PTP_EC_Undefined:
LIBMTP_INFO("Received event PTP_EC_Undefined in session %u\n", session_id);
break;
case PTP_EC_CancelTransaction:
LIBMTP_INFO("Received event PTP_EC_CancelTransaction in session %u\n", session_id);
break;
case PTP_EC_ObjectAdded:
LIBMTP_INFO("Received event PTP_EC_ObjectAdded in session %u\n", session_id);
*event = LIBMTP_EVENT_OBJECT_ADDED;
*out1 = param1;
break;
case PTP_EC_ObjectRemoved:
LIBMTP_INFO("Received event PTP_EC_ObjectRemoved in session %u\n", session_id);
*event = LIBMTP_EVENT_OBJECT_REMOVED;
*out1 = param1;
break;
case PTP_EC_StoreAdded:
LIBMTP_INFO("Received event PTP_EC_StoreAdded in session %u\n", session_id);
/* TODO: rescan storages */
*event = LIBMTP_EVENT_STORE_ADDED;
*out1 = param1;
break;
case PTP_EC_StoreRemoved:
LIBMTP_INFO("Received event PTP_EC_StoreRemoved in session %u\n", session_id);
/* TODO: rescan storages */
*event = LIBMTP_EVENT_STORE_REMOVED;
*out1 = param1;
break;
case PTP_EC_DevicePropChanged:
LIBMTP_INFO("Received event PTP_EC_DevicePropChanged in session %u\n", session_id);
/* TODO: update device properties */
*event = LIBMTP_EVENT_DEVICE_PROPERTY_CHANGED;
*out1 = param1;
break;
case PTP_EC_ObjectInfoChanged:
LIBMTP_INFO("Received event PTP_EC_ObjectInfoChanged in session %u\n", session_id);
/* TODO: rescan object cache or just for this one object */
break;
case PTP_EC_DeviceInfoChanged:
LIBMTP_INFO("Received event PTP_EC_DeviceInfoChanged in session %u\n", session_id);
/* TODO: update device info */
break;
case PTP_EC_RequestObjectTransfer:
LIBMTP_INFO("Received event PTP_EC_RequestObjectTransfer in session %u\n", session_id);
break;
case PTP_EC_StoreFull:
LIBMTP_INFO("Received event PTP_EC_StoreFull in session %u\n", session_id);
break;
case PTP_EC_DeviceReset:
LIBMTP_INFO("Received event PTP_EC_DeviceReset in session %u\n", session_id);
break;
case PTP_EC_StorageInfoChanged :
LIBMTP_INFO( "Received event PTP_EC_StorageInfoChanged in session %u\n", session_id);
/* TODO: update storage info */
break;
case PTP_EC_CaptureComplete :
LIBMTP_INFO( "Received event PTP_EC_CaptureComplete in session %u\n", session_id);
break;
case PTP_EC_UnreportedStatus :
LIBMTP_INFO( "Received event PTP_EC_UnreportedStatus in session %u\n", session_id);
break;
default :
LIBMTP_INFO( "Received unknown event in session %u\n", session_id);
break;
}
}
static void LIBMTP_Read_Event_Cb(PTPParams *params, uint16_t ret_code,
PTPContainer *ptp_event, void *user_data) {
event_cb_data_t *data = user_data;
LIBMTP_event_t event = LIBMTP_EVENT_NONE;
uint32_t param1 = 0;
int handler_ret;
switch (ret_code) {
case PTP_RC_OK:
handler_ret = LIBMTP_HANDLER_RETURN_OK;
LIBMTP_Handle_Event(ptp_event, &event, ¶m1);
break;
case PTP_ERROR_CANCEL:
handler_ret = LIBMTP_HANDLER_RETURN_CANCEL;
break;
default:
handler_ret = LIBMTP_HANDLER_RETURN_ERROR;
break;
}
data->cb(handler_ret, event, param1, data->user_data);
free(data);
}
/**
* This function reads events sent by the device, in a non-blocking manner.
* The callback function will be called when an event is received, but for the function
* to make progress, polling must take place, using LIBMTP_Handle_Events_Timeout_Completed.
*
* After an event is received, this function should be called again to listen for the next
* event.
*
* For now, this non-blocking mechanism only works with libusb-1.0, and not any of the
* other usb library backends. Attempting to call this method with another backend will
* always return an error.
*
* @param device a pointer to the MTP device to poll for events.
* @param cb a callback to be invoked when an event is received.
* @param user_data arbitrary user data passed to the callback.
* @return 0 on success, any other value means that the callback was not registered and
* no event notification will take place.
*/
int LIBMTP_Read_Event_Async(LIBMTP_mtpdevice_t *device, LIBMTP_event_cb_fn cb, void *user_data) {
PTPParams *params = (PTPParams *) device->params;
event_cb_data_t *data = malloc(sizeof(event_cb_data_t));
uint16_t ret;
data->cb = cb;
data->user_data = user_data;
ret = ptp_usb_event_async(params, LIBMTP_Read_Event_Cb, data);
return ret == PTP_RC_OK ? 0 : -1;
}
/**
* Recursive function that adds MTP devices to a linked list
* @param devices a list of raw devices to have real devices created for.
* @return a device pointer to a newly created mtpdevice (used in linked
* list creation).
*/
static LIBMTP_mtpdevice_t * create_usb_mtp_devices(LIBMTP_raw_device_t *devices, unsigned int numdevs)
{
unsigned int i;
LIBMTP_mtpdevice_t *mtp_device_list = NULL;
LIBMTP_mtpdevice_t *current_device = NULL;
for (i=0; i < numdevs; i++) {
LIBMTP_mtpdevice_t *mtp_device;
mtp_device = LIBMTP_Open_Raw_Device(&devices[i]);
/* On error, try next device */
if (mtp_device == NULL)
continue;
/* Add the device to the list */
mtp_device->next = NULL;
if (mtp_device_list == NULL) {
mtp_device_list = current_device = mtp_device;
} else {
current_device->next = mtp_device;
current_device = mtp_device;
}
}
return mtp_device_list;
}
/**
* Get the number of devices that are available in the listed device list
* @param device_list Pointer to a linked list of devices
* @return Number of devices in the device list device_list
* @see LIBMTP_Get_Connected_Devices()
*/
uint32_t LIBMTP_Number_Devices_In_List(LIBMTP_mtpdevice_t *device_list)
{
uint32_t numdevices = 0;
LIBMTP_mtpdevice_t *iter;
for(iter = device_list; iter != NULL; iter = iter->next)
numdevices++;
return numdevices;
}
/**
* Get the first connected MTP device node in the linked list of devices.
* Currently this only provides access to USB devices
* @param device_list A list of devices ready to be used by the caller. You
* need to know how many there are.
* @return Any error information gathered from device connections
* @see LIBMTP_Number_Devices_In_List()
*/
LIBMTP_error_number_t LIBMTP_Get_Connected_Devices(LIBMTP_mtpdevice_t **device_list)
{
LIBMTP_raw_device_t *devices;
int numdevs;
LIBMTP_error_number_t ret;
ret = LIBMTP_Detect_Raw_Devices(&devices, &numdevs);
if (ret != LIBMTP_ERROR_NONE) {
*device_list = NULL;
return ret;
}
/* Assign linked list of devices */
if (devices == NULL || numdevs == 0) {
*device_list = NULL;
free(devices);
return LIBMTP_ERROR_NO_DEVICE_ATTACHED;
}
*device_list = create_usb_mtp_devices(devices, numdevs);
free(devices);
/* TODO: Add wifi device access here */
/* We have found some devices but create failed */
if (*device_list == NULL)
return LIBMTP_ERROR_CONNECTING;
return LIBMTP_ERROR_NONE;
}
/**
* This closes and releases an allocated MTP device.
* @param device a pointer to the MTP device to release.
*/
void LIBMTP_Release_Device_List(LIBMTP_mtpdevice_t *device)
{
if(device != NULL)
{
if(device->next != NULL)
{
LIBMTP_Release_Device_List(device->next);
}
LIBMTP_Release_Device(device);
}
}
/**
* This closes and releases an allocated MTP device.
* @param device a pointer to the MTP device to release.
*/
void LIBMTP_Release_Device(LIBMTP_mtpdevice_t *device)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
close_device(ptp_usb, params);
// Clear error stack
LIBMTP_Clear_Errorstack(device);
#if defined(HAVE_ICONV) && defined(HAVE_LANGINFO_H)
iconv_close(params->cd_locale_to_ucs2);
iconv_close(params->cd_ucs2_to_locale);
#endif
free(ptp_usb);
ptp_free_params(params);
free(params);
free_storage_list(device);
// Free extension list...
if (device->extensions != NULL) {
LIBMTP_device_extension_t *tmp = device->extensions;
while (tmp != NULL) {
LIBMTP_device_extension_t *next = tmp->next;
if (tmp->name)
free(tmp->name);
free(tmp);
tmp = next;
}
}
free(device);
}
/**
* This can be used by any libmtp-intrinsic code that
* need to stack up an error on the stack. You are only
* supposed to add errors to the error stack using this
* function, do not create and reference error entries
* directly.
*/
static void add_error_to_errorstack(LIBMTP_mtpdevice_t *device,
LIBMTP_error_number_t errornumber,
char const * const error_text)
{
LIBMTP_error_t *newerror;
if (device == NULL) {
LIBMTP_ERROR("LIBMTP PANIC: Trying to add error to a NULL device!\n");
return;
}
newerror = (LIBMTP_error_t *) malloc(sizeof(LIBMTP_error_t));
newerror->errornumber = errornumber;
newerror->error_text = strdup(error_text);
newerror->next = NULL;
if (device->errorstack == NULL) {
device->errorstack = newerror;
} else {
LIBMTP_error_t *tmp = device->errorstack;
while (tmp->next != NULL) {
tmp = tmp->next;
}
tmp->next = newerror;
}
}
/**
* Adds an error from the PTP layer to the error stack.
*/
static void add_ptp_error_to_errorstack(LIBMTP_mtpdevice_t *device,
uint16_t ptp_error,
char const * const error_text)
{
PTPParams *params = (PTPParams *) device->params;
if (device == NULL) {
LIBMTP_ERROR("LIBMTP PANIC: Trying to add PTP error to a NULL device!\n");
return;
} else {
char outstr[256];
snprintf(outstr, sizeof(outstr), "PTP Layer error %04x: %s", ptp_error, error_text);
outstr[sizeof(outstr)-1] = '\0';
add_error_to_errorstack(device, LIBMTP_ERROR_PTP_LAYER, outstr);
snprintf(outstr, sizeof(outstr), "Error %04x: %s", ptp_error, ptp_strerror(ptp_error, params->deviceinfo.VendorExtensionID));
outstr[sizeof(outstr)-1] = '\0';
add_error_to_errorstack(device, LIBMTP_ERROR_PTP_LAYER, outstr);
}
}
/**
* This returns the error stack for a device in case you
* need to either reference the error numbers (e.g. when
* creating multilingual apps with multiple-language text
* representations for each error number) or when you need
* to build a multi-line error text widget or something like
* that. You need to call the <code>LIBMTP_Clear_Errorstack</code>
* to clear it when you're finished with it.
* @param device a pointer to the MTP device to get the error
* stack for.
* @return the error stack or NULL if there are no errors
* on the stack.
* @see LIBMTP_Clear_Errorstack()
* @see LIBMTP_Dump_Errorstack()
*/
LIBMTP_error_t *LIBMTP_Get_Errorstack(LIBMTP_mtpdevice_t *device)
{
if (device == NULL) {
LIBMTP_ERROR("LIBMTP PANIC: Trying to get the error stack of a NULL device!\n");
return NULL;
}
return device->errorstack;
}
/**
* This function clears the error stack of a device and frees
* any memory used by it. Call this when you're finished with
* using the errors.
* @param device a pointer to the MTP device to clear the error
* stack for.
*/
void LIBMTP_Clear_Errorstack(LIBMTP_mtpdevice_t *device)
{
if (device == NULL) {
LIBMTP_ERROR("LIBMTP PANIC: Trying to clear the error stack of a NULL device!\n");
} else {
LIBMTP_error_t *tmp = device->errorstack;
while (tmp != NULL) {
LIBMTP_error_t *tmp2;
if (tmp->error_text != NULL) {
free(tmp->error_text);
}
tmp2 = tmp;
tmp = tmp->next;
free(tmp2);
}
device->errorstack = NULL;
}
}
/**
* This function dumps the error stack to <code>stderr</code>.
* (You still have to clear the stack though.)
* @param device a pointer to the MTP device to dump the error
* stack for.
*/
void LIBMTP_Dump_Errorstack(LIBMTP_mtpdevice_t *device)
{
if (device == NULL) {
LIBMTP_ERROR("LIBMTP PANIC: Trying to dump the error stack of a NULL device!\n");
} else {
LIBMTP_error_t *tmp = device->errorstack;
while (tmp != NULL) {
if (tmp->error_text != NULL) {
LIBMTP_ERROR("Error %d: %s\n", tmp->errornumber, tmp->error_text);
} else {
LIBMTP_ERROR("Error %d: (unknown)\n", tmp->errornumber);
}
tmp = tmp->next;
}
}
}
/**
* This command gets all handles and stuff by FAST directory retrieveal
* which is available by getting all metadata for object
* <code>0xffffffff</code> which simply means "all metadata for all objects".
* This works on the vast majority of MTP devices (there ARE exceptions!)
* and is quite quick. Check the error stack to see if there were
* problems getting the metadata.
* @return 0 if all was OK, -1 on failure.
*/
static int get_all_metadata_fast(LIBMTP_mtpdevice_t *device)
{
PTPParams *params = (PTPParams *) device->params;
int cnt = 0;
int i, j, nrofprops;
uint32_t lasthandle = 0xffffffff;
MTPProperties *props = NULL;
MTPProperties *prop;
uint16_t ret;
int oldtimeout;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
/*
* The follow request causes the device to generate
* a list of every file on the device and return it
* in a single response.
*
* Some slow devices as well as devices with very
* large file systems can easily take longer then
* the standard timeout value before it is able
* to return a response.
*
* Temporarly set timeout to allow working with
* widest range of devices.
*/
get_usb_device_timeout(ptp_usb, &oldtimeout);
set_usb_device_timeout(ptp_usb, 60000);
ret = ptp_mtp_getobjectproplist(params, 0xffffffff, &props, &nrofprops);
set_usb_device_timeout(ptp_usb, oldtimeout);
if (ret == PTP_RC_MTP_Specification_By_Group_Unsupported) {
// What's the point in the device implementing this command if
// you cannot use it to get all props for AT LEAST one object?
// Well, whatever...
add_ptp_error_to_errorstack(device, ret, "get_all_metadata_fast(): "
"cannot retrieve all metadata for an object on this device.");
return -1;
}
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "get_all_metadata_fast(): "
"could not get proplist of all objects.");
return -1;
}
if (props == NULL && nrofprops != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"get_all_metadata_fast(): "
"call to ptp_mtp_getobjectproplist() returned "
"inconsistent results.");
return -1;
}
/*
* We count the number of objects by counting the ObjectHandle
* references, whenever it changes we get a new object, when it's
* the same, it is just different properties of the same object.
*/
prop = props;
for (i=0;i<nrofprops;i++) {
if (lasthandle != prop->ObjectHandle) {
cnt++;
lasthandle = prop->ObjectHandle;
}
prop++;
}
lasthandle = 0xffffffff;
params->objects = calloc (cnt, sizeof(PTPObject));
prop = props;
i = -1;
for (j=0;j<nrofprops;j++) {
if (lasthandle != prop->ObjectHandle) {
if (i >= 0) {
params->objects[i].flags |= PTPOBJECT_OBJECTINFO_LOADED;
if (!params->objects[i].oi.Filename) {
/* I have one such file on my Creative (Marcus) */
params->objects[i].oi.Filename = strdup("<null>");
}
}
i++;
lasthandle = prop->ObjectHandle;
params->objects[i].oid = prop->ObjectHandle;
}
switch (prop->property) {
case PTP_OPC_ParentObject:
params->objects[i].oi.ParentObject = prop->propval.u32;
params->objects[i].flags |= PTPOBJECT_PARENTOBJECT_LOADED;
break;
case PTP_OPC_ObjectFormat:
params->objects[i].oi.ObjectFormat = prop->propval.u16;
break;
case PTP_OPC_ObjectSize:
// We loose precision here, up to 32 bits! However the commands that
// retrieve metadata for files and tracks will make sure that the
// PTP_OPC_ObjectSize is read in and duplicated again.
if (device->object_bitsize == 64) {
params->objects[i].oi.ObjectCompressedSize = (uint32_t) prop->propval.u64;
} else {
params->objects[i].oi.ObjectCompressedSize = prop->propval.u32;
}
break;
case PTP_OPC_StorageID:
params->objects[i].oi.StorageID = prop->propval.u32;
params->objects[i].flags |= PTPOBJECT_STORAGEID_LOADED;
break;
case PTP_OPC_ObjectFileName:
if (prop->propval.str != NULL)
params->objects[i].oi.Filename = strdup(prop->propval.str);
break;
default: {
MTPProperties *newprops;
/* Copy all of the other MTP oprierties into the per-object proplist */
if (params->objects[i].nrofmtpprops) {
newprops = realloc(params->objects[i].mtpprops,
(params->objects[i].nrofmtpprops+1)*sizeof(MTPProperties));
} else {
newprops = calloc(1,sizeof(MTPProperties));
}
if (!newprops) return 0; /* FIXME: error handling? */
params->objects[i].mtpprops = newprops;
memcpy(¶ms->objects[i].mtpprops[params->objects[i].nrofmtpprops],
&props[j],sizeof(props[j]));
params->objects[i].nrofmtpprops++;
params->objects[i].flags |= PTPOBJECT_MTPPROPLIST_LOADED;
break;
}
}
prop++;
}
/* mark last entry also */
if (i >= 0) {
params->objects[i].flags |= PTPOBJECT_OBJECTINFO_LOADED;
params->nrofobjects = i+1;
} else {
params->nrofobjects = 0;
}
free (props);
/* The device might not give the list in linear ascending order */
ptp_objects_sort (params);
return 0;
}
/**
* This function will recurse through all the directories on the device,
* starting at the root directory, gathering metadata as it moves along.
* It works better on some devices that will only return data for a
* certain directory and does not respect the option to get all metadata
* for all objects.
*/
static uint16_t get_handles_recursively(LIBMTP_mtpdevice_t *device,
PTPParams *params,
uint32_t storageid,
uint32_t parent)
{
PTPObjectHandles currentHandles;
unsigned int i = 0;
uint16_t ret = ptp_getobjecthandles(params,
storageid,
PTP_GOH_ALL_FORMATS,
parent,
¤tHandles);
if (ret != PTP_RC_OK) {
char buf[80];
sprintf(buf,"get_handles_recursively(): could not get object handles of %08x", parent);
add_ptp_error_to_errorstack(device, ret, buf);
return ret;
}
if (currentHandles.Handler == NULL || currentHandles.n == 0)
return PTP_RC_OK;
// Now descend into any subdirectories found
for (i = 0; i < currentHandles.n; i++) {
PTPObject *ob;
ret = ptp_object_want(params,currentHandles.Handler[i],
PTPOBJECT_OBJECTINFO_LOADED, &ob);
if (ret == PTP_RC_OK) {
if (ob->oi.ObjectFormat == PTP_OFC_Association)
get_handles_recursively(device, params,
storageid, currentHandles.Handler[i]);
} else {
add_error_to_errorstack(device,
LIBMTP_ERROR_CONNECTING,
"Found a bad handle, trying to ignore it.");
return ret;
}
}
free(currentHandles.Handler);
return PTP_RC_OK;
}
/**
* This function refresh the internal handle list whenever
* the items stored inside the device is altered. On operations
* that do not add or remove objects, this is typically not
* called.
* @param device a pointer to the MTP device to flush handles for.
*/
static void flush_handles(LIBMTP_mtpdevice_t *device)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
int ret;
uint32_t i;
if (!device->cached) {
return;
}
if (params->objects != NULL) {
for (i=0;i<params->nrofobjects;i++)
ptp_free_object (¶ms->objects[i]);
free(params->objects);
params->objects = NULL;
params->nrofobjects = 0;
}
if (ptp_operation_issupported(params,PTP_OC_MTP_GetObjPropList)
&& !FLAG_BROKEN_MTPGETOBJPROPLIST(ptp_usb)
&& !FLAG_BROKEN_MTPGETOBJPROPLIST_ALL(ptp_usb)) {
// Use the fast method. Ignore return value for now.
ret = get_all_metadata_fast(device);
}
// If the previous failed or returned no objects, use classic
// methods instead.
if (params->nrofobjects == 0) {
// Get all the handles using just standard commands.
if (device->storage == NULL) {
get_handles_recursively(device, params,
PTP_GOH_ALL_STORAGE,
PTP_GOH_ROOT_PARENT);
} else {
// Get handles for each storage in turn.
LIBMTP_devicestorage_t *storage = device->storage;
while(storage != NULL) {
get_handles_recursively(device, params,
storage->id,
PTP_GOH_ROOT_PARENT);
storage = storage->next;
}
}
}
/*
* Loop over the handles, fix up any NULL filenames or
* keywords, then attempt to locate some default folders
* in the root directory of the primary storage.
*/
for(i = 0; i < params->nrofobjects; i++) {
PTPObject *ob, *xob;
ob = ¶ms->objects[i];
ret = ptp_object_want(params,params->objects[i].oid,
PTPOBJECT_OBJECTINFO_LOADED, &xob);
if (ret != PTP_RC_OK) {
LIBMTP_ERROR("broken! %x not found\n", params->objects[i].oid);
}
if (ob->oi.Filename == NULL)
ob->oi.Filename = strdup("<null>");
if (ob->oi.Keywords == NULL)
ob->oi.Keywords = strdup("<null>");
/* Ignore handles that point to non-folders */
if(ob->oi.ObjectFormat != PTP_OFC_Association)
continue;
/* Only look in the root folder */
if (ob->oi.ParentObject == 0xffffffffU) {
LIBMTP_ERROR("object %x has parent 0xffffffff (-1) continuing anyway\n",
ob->oid);
} else if (ob->oi.ParentObject != 0x00000000U)
continue;
/* Only look in the primary storage */
if (device->storage != NULL && ob->oi.StorageID != device->storage->id)
continue;
/* Is this the Music Folder */
if (!strcasecmp(ob->oi.Filename, "My Music") ||
!strcasecmp(ob->oi.Filename, "My_Music") ||
!strcasecmp(ob->oi.Filename, "Music")) {
device->default_music_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "My Playlists") ||
!strcasecmp(ob->oi.Filename, "My_Playlists") ||
!strcasecmp(ob->oi.Filename, "Playlists")) {
device->default_playlist_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "My Pictures") ||
!strcasecmp(ob->oi.Filename, "My_Pictures") ||
!strcasecmp(ob->oi.Filename, "Pictures")) {
device->default_picture_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "My Video") ||
!strcasecmp(ob->oi.Filename, "My_Video") ||
!strcasecmp(ob->oi.Filename, "Video")) {
device->default_video_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "My Organizer") ||
!strcasecmp(ob->oi.Filename, "My_Organizer")) {
device->default_organizer_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "ZENcast") ||
!strcasecmp(ob->oi.Filename, "Datacasts")) {
device->default_zencast_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "My Albums") ||
!strcasecmp(ob->oi.Filename, "My_Albums") ||
!strcasecmp(ob->oi.Filename, "Albums")) {
device->default_album_folder = ob->oid;
}
else if (!strcasecmp(ob->oi.Filename, "Text") ||
!strcasecmp(ob->oi.Filename, "Texts")) {
device->default_text_folder = ob->oid;
}
}
}
/**
* This function traverses a devices storage list freeing up the
* strings and the structs.
* @param device a pointer to the MTP device to free the storage
* list for.
*/
static void free_storage_list(LIBMTP_mtpdevice_t *device)
{
LIBMTP_devicestorage_t *storage;
LIBMTP_devicestorage_t *tmp;
storage = device->storage;
while(storage != NULL) {
if (storage->StorageDescription != NULL) {
free(storage->StorageDescription);
}
if (storage->VolumeIdentifier != NULL) {
free(storage->VolumeIdentifier);
}
tmp = storage;
storage = storage->next;
free(tmp);
}
device->storage = NULL;
return;
}
/**
* This function traverses a devices storage list freeing up the
* strings and the structs.
* @param device a pointer to the MTP device to free the storage
* list for.
*/
static int sort_storage_by(LIBMTP_mtpdevice_t *device,int const sortby)
{
LIBMTP_devicestorage_t *oldhead, *ptr1, *ptr2, *newlist;
if (device->storage == NULL)
return -1;
if (sortby == LIBMTP_STORAGE_SORTBY_NOTSORTED)
return 0;
oldhead = ptr1 = ptr2 = device->storage;
newlist = NULL;
while(oldhead != NULL) {
ptr1 = ptr2 = oldhead;
while(ptr1 != NULL) {
if (sortby == LIBMTP_STORAGE_SORTBY_FREESPACE && ptr1->FreeSpaceInBytes > ptr2->FreeSpaceInBytes)
ptr2 = ptr1;
if (sortby == LIBMTP_STORAGE_SORTBY_MAXSPACE && ptr1->FreeSpaceInBytes > ptr2->FreeSpaceInBytes)
ptr2 = ptr1;
ptr1 = ptr1->next;
}
// Make our previous entries next point to our next
if(ptr2->prev != NULL) {
ptr1 = ptr2->prev;
ptr1->next = ptr2->next;
} else {
oldhead = ptr2->next;
if(oldhead != NULL)
oldhead->prev = NULL;
}
// Make our next entries previous point to our previous
ptr1 = ptr2->next;
if(ptr1 != NULL) {
ptr1->prev = ptr2->prev;
} else {
ptr1 = ptr2->prev;
if(ptr1 != NULL)
ptr1->next = NULL;
}
if(newlist == NULL) {
newlist = ptr2;
newlist->prev = NULL;
} else {
ptr2->prev = newlist;
newlist->next = ptr2;
newlist = newlist->next;
}
}
if (newlist != NULL) {
newlist->next = NULL;
while(newlist->prev != NULL)
newlist = newlist->prev;
device->storage = newlist;
}
return 0;
}
/**
* This function grabs the first writeable storageid from the
* device storage list.
* @param device a pointer to the MTP device to locate writeable
* storage for.
* @param fitsize a file of this file must fit on the device.
*/
static uint32_t get_writeable_storageid(LIBMTP_mtpdevice_t *device,
uint64_t fitsize)
{
LIBMTP_devicestorage_t *storage;
uint32_t store = 0x00000000; //Should this be 0xffffffffu instead?
int subcall_ret;
// See if there is some storage we can fit this file on.
storage = device->storage;
if (storage == NULL) {
// Sometimes the storage just cannot be detected.
store = 0x00000000U;
} else {
while(storage != NULL) {
// These storages cannot be used.
if (storage->StorageType == PTP_ST_FixedROM ||
storage->StorageType == PTP_ST_RemovableROM) {
storage = storage->next;
continue;
}
// Storage IDs with the lower 16 bits 0x0000 are not supposed
// to be writeable.
if ((storage->id & 0x0000FFFFU) == 0x00000000U) {
storage = storage->next;
continue;
}
// Also check the access capability to avoid e.g. deletable only storages
if (storage->AccessCapability == PTP_AC_ReadOnly ||
storage->AccessCapability == PTP_AC_ReadOnly_with_Object_Deletion) {
storage = storage->next;
continue;
}
// Then see if we can fit the file.
subcall_ret = check_if_file_fits(device, storage, fitsize);
if (subcall_ret != 0) {
storage = storage->next;
} else {
// We found a storage that is writable and can fit the file!
break;
}
}
if (storage == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_STORAGE_FULL,
"get_writeable_storageid(): "
"all device storage is full or corrupt.");
return -1;
}
store = storage->id;
}
return store;
}
/**
* Tries to suggest a storage_id of a given ID when we have a parent
* @param device a pointer to the device where to search for the storage ID
* @param fitsize a file of this file must fit on the device.
* @param parent_id look for this ID
* @ret storageID
*/
static int get_suggested_storage_id(LIBMTP_mtpdevice_t *device,
uint64_t fitsize,
uint32_t parent_id)
{
PTPParams *params = (PTPParams *) device->params;
PTPObject *ob;
uint16_t ret;
ret = ptp_object_want(params, parent_id, PTPOBJECT_MTPPROPLIST_LOADED, &ob);
if ((ret != PTP_RC_OK) || (ob->oi.StorageID == 0)) {
add_ptp_error_to_errorstack(device, ret, "get_suggested_storage_id(): "
"could not get storage id from parent id.");
return get_writeable_storageid(device, fitsize);
} else {
/* OK we know the parent storage, then use that */
return ob->oi.StorageID;
}
}
/**
* This function grabs the freespace from a certain storage in
* device storage list.
* @param device a pointer to the MTP device to free the storage
* list for.
* @param storageid the storage ID for the storage to flush and
* get free space for.
* @param freespace the free space on this storage will be returned
* in this variable.
*/
static int get_storage_freespace(LIBMTP_mtpdevice_t *device,
LIBMTP_devicestorage_t *storage,
uint64_t *freespace)
{
PTPParams *params = (PTPParams *) device->params;
// Always query the device about this, since some models explicitly
// needs that. We flush all data on queries storage here.
if (ptp_operation_issupported(params,PTP_OC_GetStorageInfo)) {
PTPStorageInfo storageInfo;
uint16_t ret;
ret = ptp_getstorageinfo(params, storage->id, &storageInfo);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret,
"get_storage_freespace(): could not get storage info.");
return -1;
}
if (storage->StorageDescription != NULL) {
free(storage->StorageDescription);
}
if (storage->VolumeIdentifier != NULL) {
free(storage->VolumeIdentifier);
}
storage->StorageType = storageInfo.StorageType;
storage->FilesystemType = storageInfo.FilesystemType;
storage->AccessCapability = storageInfo.AccessCapability;
storage->MaxCapacity = storageInfo.MaxCapability;
storage->FreeSpaceInBytes = storageInfo.FreeSpaceInBytes;
storage->FreeSpaceInObjects = storageInfo.FreeSpaceInImages;
storage->StorageDescription = storageInfo.StorageDescription;
storage->VolumeIdentifier = storageInfo.VolumeLabel;
}
if(storage->FreeSpaceInBytes == (uint64_t) -1)
return -1;
*freespace = storage->FreeSpaceInBytes;
return 0;
}
/**
* This function dumps out a large chunk of textual information
* provided from the PTP protocol and additionally some extra
* MTP-specific information where applicable.
* @param device a pointer to the MTP device to report info from.
*/
void LIBMTP_Dump_Device_Info(LIBMTP_mtpdevice_t *device)
{
unsigned int i;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
LIBMTP_devicestorage_t *storage = device->storage;
LIBMTP_device_extension_t *tmpext = device->extensions;
printf("USB low-level info:\n");
dump_usbinfo(ptp_usb);
/* Print out some verbose information */
printf("Device info:\n");
printf(" Manufacturer: %s\n", params->deviceinfo.Manufacturer);
printf(" Model: %s\n", params->deviceinfo.Model);
printf(" Device version: %s\n", params->deviceinfo.DeviceVersion);
printf(" Serial number: %s\n", params->deviceinfo.SerialNumber);
printf(" Vendor extension ID: 0x%08x\n",
params->deviceinfo.VendorExtensionID);
printf(" Vendor extension description: %s\n",
params->deviceinfo.VendorExtensionDesc);
printf(" Detected object size: %d bits\n",
device->object_bitsize);
printf(" Extensions:\n");
while (tmpext != NULL) {
printf(" %s: %d.%d\n",
tmpext->name,
tmpext->major,
tmpext->minor);
tmpext = tmpext->next;
}
printf("Supported operations:\n");
for (i=0;i<params->deviceinfo.OperationsSupported_len;i++)
printf(" %04x: %s\n", params->deviceinfo.OperationsSupported[i], ptp_get_opcode_name(params, params->deviceinfo.OperationsSupported[i]));
printf("Events supported:\n");
if (params->deviceinfo.EventsSupported_len == 0) {
printf(" None.\n");
} else {
for (i=0;i<params->deviceinfo.EventsSupported_len;i++) {
printf(" 0x%04x: %s\n", params->deviceinfo.EventsSupported[i], ptp_get_event_code_name(params, params->deviceinfo.EventsSupported[i]));
}
}
printf("Device Properties Supported:\n");
for (i=0;i<params->deviceinfo.DevicePropertiesSupported_len;i++) {
char const *propdesc = ptp_get_property_description(params,
params->deviceinfo.DevicePropertiesSupported[i]);
if (propdesc != NULL) {
printf(" 0x%04x: %s\n",
params->deviceinfo.DevicePropertiesSupported[i], propdesc);
} else {
uint16_t prop = params->deviceinfo.DevicePropertiesSupported[i];
printf(" 0x%04x: Unknown property\n", prop);
}
}
if (ptp_operation_issupported(params,PTP_OC_MTP_GetObjectPropsSupported)) {
printf("Playable File (Object) Types and Object Properties Supported:\n");
for (i=0;i<params->deviceinfo.ImageFormats_len;i++) {
char txt[256];
uint16_t ret;
uint16_t *props = NULL;
uint32_t propcnt = 0;
unsigned int j;
(void) ptp_render_ofc (params, params->deviceinfo.ImageFormats[i],
sizeof(txt), txt);
printf(" %04x: %s\n", params->deviceinfo.ImageFormats[i], txt);
ret = ptp_mtp_getobjectpropssupported (params,
params->deviceinfo.ImageFormats[i], &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Dump_Device_Info(): "
"error on query for object properties.");
} else {
for (j=0;j<propcnt;j++) {
PTPObjectPropDesc opd;
int k;
printf(" %04x: %s", props[j],
LIBMTP_Get_Property_Description(map_ptp_property_to_libmtp_property(props[j])));
// Get a more verbose description
ret = ptp_mtp_getobjectpropdesc(params, props[j],
params->deviceinfo.ImageFormats[i],
&opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Dump_Device_Info(): "
"could not get property description.");
break;
}
if (opd.DataType == PTP_DTC_STR) {
printf(" STRING data type");
switch (opd.FormFlag) {
case PTP_OPFF_DateTime:
printf(" DATETIME FORM (%s)", opd.FORM.DateTime.String);
break;
case PTP_OPFF_RegularExpression:
printf(" REGULAR EXPRESSION FORM (%s)", opd.FORM.RegularExpression.String);
break;
case PTP_OPFF_LongString:
printf(" LONG STRING FORM");
break;
default:
break;
}
} else {
if (opd.DataType & PTP_DTC_ARRAY_MASK) {
printf(" array of");
}
switch (opd.DataType & (~PTP_DTC_ARRAY_MASK)) {
case PTP_DTC_UNDEF:
printf(" UNDEFINED data type");
break;
case PTP_DTC_INT8:
printf(" INT8 data type");
switch (opd.FormFlag) {
case PTP_OPFF_Range:
printf(" range: MIN %d, MAX %d, STEP %d",
opd.FORM.Range.MinimumValue.i8,
opd.FORM.Range.MaximumValue.i8,
opd.FORM.Range.StepSize.i8);
break;
case PTP_OPFF_Enumeration:
printf(" enumeration: ");
for(k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
printf("%d, ", opd.FORM.Enum.SupportedValue[k].i8);
}
break;
case PTP_OPFF_ByteArray:
printf(" byte array: ");
break;
default:
printf(" ANY 8BIT VALUE form");
break;
}
break;
case PTP_DTC_UINT8:
printf(" UINT8 data type");
switch (opd.FormFlag) {
case PTP_OPFF_Range:
printf(" range: MIN %d, MAX %d, STEP %d",
opd.FORM.Range.MinimumValue.u8,
opd.FORM.Range.MaximumValue.u8,
opd.FORM.Range.StepSize.u8);
break;
case PTP_OPFF_Enumeration:
printf(" enumeration: ");
for(k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
printf("%d, ", opd.FORM.Enum.SupportedValue[k].u8);
}
break;
case PTP_OPFF_ByteArray:
printf(" byte array: ");
break;
default:
printf(" ANY 8BIT VALUE form");
break;
}
break;
case PTP_DTC_INT16:
printf(" INT16 data type");
switch (opd.FormFlag) {
case PTP_OPFF_Range:
printf(" range: MIN %d, MAX %d, STEP %d",
opd.FORM.Range.MinimumValue.i16,
opd.FORM.Range.MaximumValue.i16,
opd.FORM.Range.StepSize.i16);
break;
case PTP_OPFF_Enumeration:
printf(" enumeration: ");
for(k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
printf("%d, ", opd.FORM.Enum.SupportedValue[k].i16);
}
break;
default:
printf(" ANY 16BIT VALUE form");
break;
}
break;
case PTP_DTC_UINT16:
printf(" UINT16 data type");
switch (opd.FormFlag) {
case PTP_OPFF_Range:
printf(" range: MIN %d, MAX %d, STEP %d",
opd.FORM.Range.MinimumValue.u16,
opd.FORM.Range.MaximumValue.u16,
opd.FORM.Range.StepSize.u16);
break;
case PTP_OPFF_Enumeration:
printf(" enumeration: ");
for(k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
printf("%d, ", opd.FORM.Enum.SupportedValue[k].u16);
}
break;
default:
printf(" ANY 16BIT VALUE form");
break;
}
break;
case PTP_DTC_INT32:
printf(" INT32 data type");
switch (opd.FormFlag) {
case PTP_OPFF_Range:
printf(" range: MIN %d, MAX %d, STEP %d",
opd.FORM.Range.MinimumValue.i32,
opd.FORM.Range.MaximumValue.i32,
opd.FORM.Range.StepSize.i32);
break;
case PTP_OPFF_Enumeration:
printf(" enumeration: ");
for(k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
printf("%d, ", opd.FORM.Enum.SupportedValue[k].i32);
}
break;
default:
printf(" ANY 32BIT VALUE form");
break;
}
break;
case PTP_DTC_UINT32:
printf(" UINT32 data type");
switch (opd.FormFlag) {
case PTP_OPFF_Range:
printf(" range: MIN %u, MAX %u, STEP %u",
opd.FORM.Range.MinimumValue.u32,
opd.FORM.Range.MaximumValue.u32,
opd.FORM.Range.StepSize.u32);
break;
case PTP_OPFF_Enumeration:
// Special pretty-print for FOURCC codes
if (params->deviceinfo.ImageFormats[i] == PTP_OPC_VideoFourCCCodec) {
printf(" enumeration of u32 casted FOURCC: ");
for (k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
if (opd.FORM.Enum.SupportedValue[k].u32 == 0) {
printf("ANY, ");
} else {
char fourcc[6];
fourcc[0] = (opd.FORM.Enum.SupportedValue[k].u32 >> 24) & 0xFFU;
fourcc[1] = (opd.FORM.Enum.SupportedValue[k].u32 >> 16) & 0xFFU;
fourcc[2] = (opd.FORM.Enum.SupportedValue[k].u32 >> 8) & 0xFFU;
fourcc[3] = opd.FORM.Enum.SupportedValue[k].u32 & 0xFFU;
fourcc[4] = '\n';
fourcc[5] = '\0';
printf("\"%s\", ", fourcc);
}
}
} else {
printf(" enumeration: ");
for(k=0;k<opd.FORM.Enum.NumberOfValues;k++) {
printf("%u, ", opd.FORM.Enum.SupportedValue[k].u32);
}
}
break;
default:
printf(" ANY 32BIT VALUE form");
break;
}
break;
case PTP_DTC_INT64:
printf(" INT64 data type");
break;
case PTP_DTC_UINT64:
printf(" UINT64 data type");
break;
case PTP_DTC_INT128:
printf(" INT128 data type");
break;
case PTP_DTC_UINT128:
printf(" UINT128 data type");
break;
default:
printf(" UNKNOWN data type");
break;
}
}
if (opd.GetSet) {
printf(" GET/SET");
} else {
printf(" READ ONLY");
}
printf(" GROUP 0x%x", opd.GroupCode);
printf("\n");
ptp_free_objectpropdesc(&opd);
}
free(props);
}
}
}
if(storage != NULL &&
ptp_operation_issupported(params,PTP_OC_GetStorageInfo)) {
printf("Storage Devices:\n");
while(storage != NULL) {
printf(" StorageID: 0x%08x\n",storage->id);
printf(" StorageType: 0x%04x ",storage->StorageType);
switch (storage->StorageType) {
case PTP_ST_Undefined:
printf("(undefined)\n");
break;
case PTP_ST_FixedROM:
printf("fixed ROM storage\n");
break;
case PTP_ST_RemovableROM:
printf("removable ROM storage\n");
break;
case PTP_ST_FixedRAM:
printf("fixed RAM storage\n");
break;
case PTP_ST_RemovableRAM:
printf("removable RAM storage\n");
break;
default:
printf("UNKNOWN storage\n");
break;
}
printf(" FilesystemType: 0x%04x ",storage->FilesystemType);
switch(storage->FilesystemType) {
case PTP_FST_Undefined:
printf("(undefined)\n");
break;
case PTP_FST_GenericFlat:
printf("generic flat filesystem\n");
break;
case PTP_FST_GenericHierarchical:
printf("generic hierarchical\n");
break;
case PTP_FST_DCF:
printf("DCF\n");
break;
default:
printf("UNKNONWN filesystem type\n");
break;
}
printf(" AccessCapability: 0x%04x ",storage->AccessCapability);
switch(storage->AccessCapability) {
case PTP_AC_ReadWrite:
printf("read/write\n");
break;
case PTP_AC_ReadOnly:
printf("read only\n");
break;
case PTP_AC_ReadOnly_with_Object_Deletion:
printf("read only + object deletion\n");
break;
default:
printf("UNKNOWN access capability\n");
break;
}
printf(" MaxCapacity: %llu\n",
(long long unsigned int) storage->MaxCapacity);
printf(" FreeSpaceInBytes: %llu\n",
(long long unsigned int) storage->FreeSpaceInBytes);
printf(" FreeSpaceInObjects: %llu\n",
(long long unsigned int) storage->FreeSpaceInObjects);
printf(" StorageDescription: %s\n",storage->StorageDescription);
printf(" VolumeIdentifier: %s\n",storage->VolumeIdentifier);
storage = storage->next;
}
}
printf("Special directories:\n");
printf(" Default music folder: 0x%08x\n",
device->default_music_folder);
printf(" Default playlist folder: 0x%08x\n",
device->default_playlist_folder);
printf(" Default picture folder: 0x%08x\n",
device->default_picture_folder);
printf(" Default video folder: 0x%08x\n",
device->default_video_folder);
printf(" Default organizer folder: 0x%08x\n",
device->default_organizer_folder);
printf(" Default zencast folder: 0x%08x\n",
device->default_zencast_folder);
printf(" Default album folder: 0x%08x\n",
device->default_album_folder);
printf(" Default text folder: 0x%08x\n",
device->default_text_folder);
}
/**
* This resets a device in case it supports the <code>PTP_OC_ResetDevice</code>
* operation code (0x1010).
* @param device a pointer to the device to reset.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Reset_Device(LIBMTP_mtpdevice_t *device)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_operation_issupported(params,PTP_OC_ResetDevice)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Reset_Device(): "
"device does not support resetting.");
return -1;
}
ret = ptp_resetdevice(params);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "Error resetting.");
return -1;
}
return 0;
}
/**
* This retrieves the manufacturer name of an MTP device.
* @param device a pointer to the device to get the manufacturer name for.
* @return a newly allocated UTF-8 string representing the manufacturer name.
* The string must be freed by the caller after use. If the call
* was unsuccessful this will contain NULL.
*/
char *LIBMTP_Get_Manufacturername(LIBMTP_mtpdevice_t *device)
{
char *retmanuf = NULL;
PTPParams *params = (PTPParams *) device->params;
if (params->deviceinfo.Manufacturer != NULL) {
retmanuf = strdup(params->deviceinfo.Manufacturer);
}
return retmanuf;
}
/**
* This retrieves the model name (often equal to product name)
* of an MTP device.
* @param device a pointer to the device to get the model name for.
* @return a newly allocated UTF-8 string representing the model name.
* The string must be freed by the caller after use. If the call
* was unsuccessful this will contain NULL.
*/
char *LIBMTP_Get_Modelname(LIBMTP_mtpdevice_t *device)
{
char *retmodel = NULL;
PTPParams *params = (PTPParams *) device->params;
if (params->deviceinfo.Model != NULL) {
retmodel = strdup(params->deviceinfo.Model);
}
return retmodel;
}
/**
* This retrieves the serial number of an MTP device.
* @param device a pointer to the device to get the serial number for.
* @return a newly allocated UTF-8 string representing the serial number.
* The string must be freed by the caller after use. If the call
* was unsuccessful this will contain NULL.
*/
char *LIBMTP_Get_Serialnumber(LIBMTP_mtpdevice_t *device)
{
char *retnumber = NULL;
PTPParams *params = (PTPParams *) device->params;
if (params->deviceinfo.SerialNumber != NULL) {
retnumber = strdup(params->deviceinfo.SerialNumber);
}
return retnumber;
}
/**
* This retrieves the device version (hardware and firmware version) of an
* MTP device.
* @param device a pointer to the device to get the device version for.
* @return a newly allocated UTF-8 string representing the device version.
* The string must be freed by the caller after use. If the call
* was unsuccessful this will contain NULL.
*/
char *LIBMTP_Get_Deviceversion(LIBMTP_mtpdevice_t *device)
{
char *retversion = NULL;
PTPParams *params = (PTPParams *) device->params;
if (params->deviceinfo.DeviceVersion != NULL) {
retversion = strdup(params->deviceinfo.DeviceVersion);
}
return retversion;
}
/**
* This retrieves the "friendly name" of an MTP device. Usually
* this is simply the name of the owner or something like
* "John Doe's Digital Audio Player". This property should be supported
* by all MTP devices.
* @param device a pointer to the device to get the friendly name for.
* @return a newly allocated UTF-8 string representing the friendly name.
* The string must be freed by the caller after use.
* @see LIBMTP_Set_Friendlyname()
*/
char *LIBMTP_Get_Friendlyname(LIBMTP_mtpdevice_t *device)
{
PTPPropertyValue propval;
char *retstring = NULL;
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_property_issupported(params, PTP_DPC_MTP_DeviceFriendlyName)) {
return NULL;
}
ret = ptp_getdevicepropvalue(params,
PTP_DPC_MTP_DeviceFriendlyName,
&propval,
PTP_DTC_STR);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "Error getting friendlyname.");
return NULL;
}
if (propval.str != NULL) {
retstring = strdup(propval.str);
free(propval.str);
}
return retstring;
}
/**
* Sets the "friendly name" of an MTP device.
* @param device a pointer to the device to set the friendly name for.
* @param friendlyname the new friendly name for the device.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Get_Friendlyname()
*/
int LIBMTP_Set_Friendlyname(LIBMTP_mtpdevice_t *device,
char const * const friendlyname)
{
PTPPropertyValue propval;
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_property_issupported(params, PTP_DPC_MTP_DeviceFriendlyName)) {
return -1;
}
propval.str = (char *) friendlyname;
ret = ptp_setdevicepropvalue(params,
PTP_DPC_MTP_DeviceFriendlyName,
&propval,
PTP_DTC_STR);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "Error setting friendlyname.");
return -1;
}
return 0;
}
/**
* This retrieves the synchronization partner of an MTP device. This
* property should be supported by all MTP devices.
* @param device a pointer to the device to get the sync partner for.
* @return a newly allocated UTF-8 string representing the synchronization
* partner. The string must be freed by the caller after use.
* @see LIBMTP_Set_Syncpartner()
*/
char *LIBMTP_Get_Syncpartner(LIBMTP_mtpdevice_t *device)
{
PTPPropertyValue propval;
char *retstring = NULL;
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_property_issupported(params, PTP_DPC_MTP_SynchronizationPartner)) {
return NULL;
}
ret = ptp_getdevicepropvalue(params,
PTP_DPC_MTP_SynchronizationPartner,
&propval,
PTP_DTC_STR);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "Error getting syncpartner.");
return NULL;
}
if (propval.str != NULL) {
retstring = strdup(propval.str);
free(propval.str);
}
return retstring;
}
/**
* Sets the synchronization partner of an MTP device. Note that
* we have no idea what the effect of setting this to "foobar"
* may be. But the general idea seems to be to tell which program
* shall synchronize with this device and tell others to leave
* it alone.
* @param device a pointer to the device to set the sync partner for.
* @param syncpartner the new synchronization partner for the device.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Get_Syncpartner()
*/
int LIBMTP_Set_Syncpartner(LIBMTP_mtpdevice_t *device,
char const * const syncpartner)
{
PTPPropertyValue propval;
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_property_issupported(params, PTP_DPC_MTP_SynchronizationPartner)) {
return -1;
}
propval.str = (char *) syncpartner;
ret = ptp_setdevicepropvalue(params,
PTP_DPC_MTP_SynchronizationPartner,
&propval,
PTP_DTC_STR);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "Error setting syncpartner.");
return -1;
}
return 0;
}
/**
* Checks if the device can stora a file of this size or
* if it's too big.
* @param device a pointer to the device.
* @param filesize the size of the file to check whether it will fit.
* @param storageid the ID of the storage to try to fit the file on.
* @return 0 if the file fits, any other value means failure.
*/
static int check_if_file_fits(LIBMTP_mtpdevice_t *device,
LIBMTP_devicestorage_t *storage,
uint64_t const filesize) {
PTPParams *params = (PTPParams *) device->params;
uint64_t freebytes;
int ret;
// If we cannot check the storage, no big deal.
if (!ptp_operation_issupported(params,PTP_OC_GetStorageInfo)) {
return 0;
}
ret = get_storage_freespace(device, storage, &freebytes);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"check_if_file_fits(): error checking free storage.");
return -1;
} else {
// See if it fits.
if (filesize > freebytes) {
return -1;
}
}
return 0;
}
/**
* This function retrieves the current battery level on the device.
* @param device a pointer to the device to get the battery level for.
* @param maximum_level a pointer to a variable that will hold the
* maximum level of the battery if the call was successful.
* @param current_level a pointer to a variable that will hold the
* current level of the battery if the call was successful.
* A value of 0 means that the device is on external power.
* @return 0 if the storage info was successfully retrieved, any other
* means failure. A typical cause of failure is that
* the device does not support the battery level property.
*/
int LIBMTP_Get_Batterylevel(LIBMTP_mtpdevice_t *device,
uint8_t * const maximum_level,
uint8_t * const current_level)
{
PTPPropertyValue propval;
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
*maximum_level = 0;
*current_level = 0;
if (FLAG_BROKEN_BATTERY_LEVEL(ptp_usb) ||
!ptp_property_issupported(params, PTP_DPC_BatteryLevel)) {
return -1;
}
ret = ptp_getdevicepropvalue(params, PTP_DPC_BatteryLevel,
&propval, PTP_DTC_UINT8);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret,
"LIBMTP_Get_Batterylevel(): "
"could not get device property value.");
return -1;
}
*maximum_level = device->maximum_battery_level;
*current_level = propval.u8;
return 0;
}
/**
* Formats device storage (if the device supports the operation).
* WARNING: This WILL delete all data from the device. Make sure you've
* got confirmation from the user BEFORE you call this function.
*
* @param device a pointer to the device containing the storage to format.
* @param storage the actual storage to format.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Format_Storage(LIBMTP_mtpdevice_t *device,
LIBMTP_devicestorage_t *storage)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
if (!ptp_operation_issupported(params,PTP_OC_FormatStore)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Format_Storage(): "
"device does not support formatting storage.");
return -1;
}
ret = ptp_formatstore(params, storage->id);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Format_Storage(): "
"failed to format storage.");
return -1;
}
return 0;
}
/**
* Helper function to extract a unicode property off a device.
* This is the standard way of retrieveing unicode device
* properties as described by the PTP spec.
* @param device a pointer to the device to get the property from.
* @param unicstring a pointer to a pointer that will hold the
* property after this call is completed.
* @param property the property to retrieve.
* @return 0 on success, any other value means failure.
*/
static int get_device_unicode_property(LIBMTP_mtpdevice_t *device,
char **unicstring, uint16_t property)
{
PTPPropertyValue propval;
PTPParams *params = (PTPParams *) device->params;
uint16_t *tmp;
uint16_t ret;
unsigned int i;
if (!ptp_property_issupported(params, property)) {
return -1;
}
// Unicode strings are 16bit unsigned integer arrays.
ret = ptp_getdevicepropvalue(params,
property,
&propval,
PTP_DTC_AUINT16);
if (ret != PTP_RC_OK) {
// TODO: add a note on WHICH property that we failed to get.
*unicstring = NULL;
add_ptp_error_to_errorstack(device, ret,
"get_device_unicode_property(): "
"failed to get unicode property.");
return -1;
}
// Extract the actual array.
// printf("Array of %d elements\n", propval.a.count);
tmp = malloc((propval.a.count + 1)*sizeof(uint16_t));
for (i = 0; i < propval.a.count; i++) {
tmp[i] = propval.a.v[i].u16;
// printf("%04x ", tmp[i]);
}
tmp[propval.a.count] = 0x0000U;
free(propval.a.v);
*unicstring = utf16_to_utf8(device, tmp);
free(tmp);
return 0;
}
/**
* This function returns the secure time as an XML document string from
* the device.
* @param device a pointer to the device to get the secure time for.
* @param sectime the secure time string as an XML document or NULL if the call
* failed or the secure time property is not supported. This string
* must be <code>free()</code>:ed by the caller after use.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Get_Secure_Time(LIBMTP_mtpdevice_t *device, char ** const sectime)
{
return get_device_unicode_property(device, sectime, PTP_DPC_MTP_SecureTime);
}
/**
* This function returns the device (public key) certificate as an
* XML document string from the device.
* @param device a pointer to the device to get the device certificate for.
* @param devcert the device certificate as an XML string or NULL if the call
* failed or the device certificate property is not supported. This
* string must be <code>free()</code>:ed by the caller after use.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Get_Device_Certificate(LIBMTP_mtpdevice_t *device, char ** const devcert)
{
return get_device_unicode_property(device, devcert,
PTP_DPC_MTP_DeviceCertificate);
}
/**
* This function retrieves a list of supported file types, i.e. the file
* types that this device claims it supports, e.g. audio file types that
* the device can play etc. This list is mitigated to
* include the file types that libmtp can handle, i.e. it will not list
* filetypes that libmtp will handle internally like playlists and folders.
* @param device a pointer to the device to get the filetype capabilities for.
* @param filetypes a pointer to a pointer that will hold the list of
* supported filetypes if the call was successful. This list must
* be <code>free()</code>:ed by the caller after use.
* @param length a pointer to a variable that will hold the length of the
* list of supported filetypes if the call was successful.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Get_Filetype_Description()
*/
int LIBMTP_Get_Supported_Filetypes(LIBMTP_mtpdevice_t *device, uint16_t ** const filetypes,
uint16_t * const length)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
uint16_t *localtypes;
uint16_t localtypelen;
uint32_t i;
// This is more memory than needed if there are unknown types, but what the heck.
localtypes = (uint16_t *) malloc(params->deviceinfo.ImageFormats_len * sizeof(uint16_t));
localtypelen = 0;
for (i=0;i<params->deviceinfo.ImageFormats_len;i++) {
uint16_t localtype = map_ptp_type_to_libmtp_type(params->deviceinfo.ImageFormats[i]);
if (localtype != LIBMTP_FILETYPE_UNKNOWN) {
localtypes[localtypelen] = localtype;
localtypelen++;
}
}
// The forgotten Ogg support on YP-10 and others...
if (FLAG_OGG_IS_UNKNOWN(ptp_usb)) {
uint16_t *tmp = (uint16_t *) realloc(
localtypes, (params->deviceinfo.ImageFormats_len+1) * sizeof(uint16_t));
if (tmp == NULL)
return -ENOMEM;
localtypes = tmp;
localtypes[localtypelen] = LIBMTP_FILETYPE_OGG;
localtypelen++;
}
// The forgotten FLAC support on Cowon iAudio S9 and others...
if (FLAG_FLAC_IS_UNKNOWN(ptp_usb)) {
uint16_t *tmp = (uint16_t *) realloc(
localtypes, (params->deviceinfo.ImageFormats_len+1) * sizeof(uint16_t));
if (tmp == NULL)
return -ENOMEM;
localtypes = tmp;
localtypes[localtypelen] = LIBMTP_FILETYPE_FLAC;
localtypelen++;
}
*filetypes = localtypes;
*length = localtypelen;
return 0;
}
/**
* This function checks if the device has some specific capabilities, in
* order to avoid calling APIs that may disturb the device.
*
* @param device a pointer to the device to check the capability on.
* @param cap the capability to check.
* @return 0 if not supported, any other value means the device has the
* requested capability.
*/
int LIBMTP_Check_Capability(LIBMTP_mtpdevice_t *device, LIBMTP_devicecap_t cap)
{
switch (cap) {
case LIBMTP_DEVICECAP_GetPartialObject:
return (ptp_operation_issupported(device->params,
PTP_OC_GetPartialObject) ||
ptp_operation_issupported(device->params,
PTP_OC_ANDROID_GetPartialObject64));
case LIBMTP_DEVICECAP_SendPartialObject:
return ptp_operation_issupported(device->params,
PTP_OC_ANDROID_SendPartialObject);
case LIBMTP_DEVICECAP_EditObjects:
return (ptp_operation_issupported(device->params,
PTP_OC_ANDROID_TruncateObject) &&
ptp_operation_issupported(device->params,
PTP_OC_ANDROID_BeginEditObject) &&
ptp_operation_issupported(device->params,
PTP_OC_ANDROID_EndEditObject));
case LIBMTP_DEVICECAP_MoveObject:
return ptp_operation_issupported(device->params,
PTP_OC_MoveObject);
case LIBMTP_DEVICECAP_CopyObject:
return ptp_operation_issupported(device->params,
PTP_OC_CopyObject);
/*
* Handle other capabilities here, this is also a good place to
* blacklist some advanced operations on specific devices if need
* be.
*/
default:
break;
}
return 0;
}
/**
* This function updates all the storage id's of a device and their
* properties, then creates a linked list and puts the list head into
* the device struct. It also optionally sorts this list. If you want
* to display storage information in your application you should call
* this function, then dereference the device struct
* (<code>device->storage</code>) to get out information on the storage.
*
* You need to call this every time you want to update the
* <code>device->storage</code> list, for example anytime you need
* to check available storage somewhere.
*
* <b>WARNING:</b> since this list is dynamically updated, do not
* reference its fields in external applications by pointer! E.g
* do not put a reference to any <code>char *</code> field. instead
* <code>strncpy()</code> it!
*
* @param device a pointer to the device to get the storage for.
* @param sortby an integer that determines the sorting of the storage list.
* Valid sort methods are defined in libmtp.h with beginning with
* LIBMTP_STORAGE_SORTBY_. 0 or LIBMTP_STORAGE_SORTBY_NOTSORTED to not
* sort.
* @return 0 on success, 1 success but only with storage id's, storage
* properities could not be retrieved and -1 means failure.
*/
int LIBMTP_Get_Storage(LIBMTP_mtpdevice_t *device, int const sortby)
{
uint32_t i = 0;
PTPStorageInfo storageInfo;
PTPParams *params = (PTPParams *) device->params;
PTPStorageIDs storageIDs;
LIBMTP_devicestorage_t *storage = NULL;
LIBMTP_devicestorage_t *storageprev = NULL;
if (device->storage != NULL)
free_storage_list(device);
// if (!ptp_operation_issupported(params,PTP_OC_GetStorageIDs))
// return -1;
if (ptp_getstorageids (params, &storageIDs) != PTP_RC_OK)
return -1;
if (storageIDs.n < 1)
return -1;
if (!ptp_operation_issupported(params,PTP_OC_GetStorageInfo)) {
for (i = 0; i < storageIDs.n; i++) {
storage = (LIBMTP_devicestorage_t *)
malloc(sizeof(LIBMTP_devicestorage_t));
storage->prev = storageprev;
if (storageprev != NULL)
storageprev->next = storage;
if (device->storage == NULL)
device->storage = storage;
storage->id = storageIDs.Storage[i];
storage->StorageType = PTP_ST_Undefined;
storage->FilesystemType = PTP_FST_Undefined;
storage->AccessCapability = PTP_AC_ReadWrite;
storage->MaxCapacity = (uint64_t) -1;
storage->FreeSpaceInBytes = (uint64_t) -1;
storage->FreeSpaceInObjects = (uint64_t) -1;
storage->StorageDescription = strdup("Unknown storage");
storage->VolumeIdentifier = strdup("Unknown volume");
storage->next = NULL;
storageprev = storage;
}
free(storageIDs.Storage);
return 1;
} else {
for (i = 0; i < storageIDs.n; i++) {
uint16_t ret;
ret = ptp_getstorageinfo(params, storageIDs.Storage[i], &storageInfo);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Storage(): "
"Could not get storage info.");
if (device->storage != NULL) {
free_storage_list(device);
}
return -1;
}
storage = (LIBMTP_devicestorage_t *)
malloc(sizeof(LIBMTP_devicestorage_t));
storage->prev = storageprev;
if (storageprev != NULL)
storageprev->next = storage;
if (device->storage == NULL)
device->storage = storage;
storage->id = storageIDs.Storage[i];
storage->StorageType = storageInfo.StorageType;
storage->FilesystemType = storageInfo.FilesystemType;
storage->AccessCapability = storageInfo.AccessCapability;
storage->MaxCapacity = storageInfo.MaxCapability;
storage->FreeSpaceInBytes = storageInfo.FreeSpaceInBytes;
storage->FreeSpaceInObjects = storageInfo.FreeSpaceInImages;
storage->StorageDescription = storageInfo.StorageDescription;
storage->VolumeIdentifier = storageInfo.VolumeLabel;
storage->next = NULL;
storageprev = storage;
}
if (storage != NULL)
storage->next = NULL;
sort_storage_by(device,sortby);
free(storageIDs.Storage);
return 0;
}
}
/**
* This creates a new file metadata structure and allocates memory
* for it. Notice that if you add strings to this structure they
* will be freed by the corresponding <code>LIBMTP_destroy_file_t</code>
* operation later, so be careful of using strdup() when assigning
* strings, e.g.:
*
* <pre>
* LIBMTP_file_t *file = LIBMTP_new_file_t();
* file->filename = strdup(namestr);
* ....
* LIBMTP_destroy_file_t(file);
* </pre>
*
* @return a pointer to the newly allocated metadata structure.
* @see LIBMTP_destroy_file_t()
*/
LIBMTP_file_t *LIBMTP_new_file_t(void)
{
LIBMTP_file_t *new = (LIBMTP_file_t *) malloc(sizeof(LIBMTP_file_t));
if (new == NULL) {
return NULL;
}
new->filename = NULL;
new->item_id = 0;
new->parent_id = 0;
new->storage_id = 0;
new->filesize = 0;
new->modificationdate = 0;
new->filetype = LIBMTP_FILETYPE_UNKNOWN;
new->next = NULL;
return new;
}
/**
* This destroys a file metadata structure and deallocates the memory
* used by it, including any strings. Never use a file metadata
* structure again after calling this function on it.
* @param file the file metadata to destroy.
* @see LIBMTP_new_file_t()
*/
void LIBMTP_destroy_file_t(LIBMTP_file_t *file)
{
if (file == NULL) {
return;
}
if (file->filename != NULL)
free(file->filename);
free(file);
return;
}
/**
* Helper function that takes one PTP object and creates a
* LIBMTP_file_t metadata entry.
*/
static LIBMTP_file_t *obj2file(LIBMTP_mtpdevice_t *device, PTPObject *ob)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
LIBMTP_file_t *file;
unsigned int i;
// Allocate a new file type
file = LIBMTP_new_file_t();
file->parent_id = ob->oi.ParentObject;
file->storage_id = ob->oi.StorageID;
if (ob->oi.Filename != NULL) {
file->filename = strdup(ob->oi.Filename);
}
// Set the filetype
file->filetype = map_ptp_type_to_libmtp_type(ob->oi.ObjectFormat);
/*
* A special quirk for devices that doesn't quite
* remember that some files marked as "unknown" type are
* actually OGG or FLAC files. We look at the filename extension
* and see if it happens that this was atleast named "ogg" or "flac"
* and fall back on this heuristic approach in that case,
* for these bugged devices only.
*/
if (file->filetype == LIBMTP_FILETYPE_UNKNOWN) {
if ((FLAG_IRIVER_OGG_ALZHEIMER(ptp_usb) ||
FLAG_OGG_IS_UNKNOWN(ptp_usb)) &&
has_ogg_extension(file->filename)) {
file->filetype = LIBMTP_FILETYPE_OGG;
}
if (FLAG_FLAC_IS_UNKNOWN(ptp_usb) && has_flac_extension(file->filename)) {
file->filetype = LIBMTP_FILETYPE_FLAC;
}
}
// Set the modification date
file->modificationdate = ob->oi.ModificationDate;
// We only have 32-bit file size here; later we use the PTP_OPC_ObjectSize property
file->filesize = ob->oi.ObjectCompressedSize;
// This is a unique ID so we can keep track of the file.
file->item_id = ob->oid;
/*
* If we have a cached, large set of metadata, then use it!
*/
if (ob->mtpprops) {
MTPProperties *prop = ob->mtpprops;
for (i=0; i < ob->nrofmtpprops; i++, prop++) {
// Pick ObjectSize here...
if (prop->property == PTP_OPC_ObjectSize) {
// This may already be set, but this 64bit precision value
// is better than the PTP 32bit value, so let it override.
if (device->object_bitsize == 64) {
file->filesize = prop->propval.u64;
} else {
file->filesize = prop->propval.u32;
}
break;
}
}
} else if (ptp_operation_issupported(params,PTP_OC_MTP_GetObjectPropsSupported)) {
uint16_t *props = NULL;
uint32_t propcnt = 0;
int ret;
// First see which properties can be retrieved for this object format
ret = ptp_mtp_getobjectpropssupported(params, map_libmtp_type_to_ptp_type(file->filetype), &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "obj2file: call to ptp_mtp_getobjectpropssupported() failed.");
// Silently fall through.
} else {
for (i = 0; i < propcnt; i++) {
switch (props[i]) {
case PTP_OPC_ObjectSize:
if (device->object_bitsize == 64) {
file->filesize = get_u64_from_object(device, file->item_id, PTP_OPC_ObjectSize, 0);
} else {
file->filesize = get_u32_from_object(device, file->item_id, PTP_OPC_ObjectSize, 0);
}
break;
default:
break;
}
}
free(props);
}
}
return file;
}
/**
* This function retrieves the metadata for a single file off
* the device.
*
* Do not call this function repeatedly! The file handles are linearly
* searched O(n) and the call may involve (slow) USB traffic, so use
* <code>LIBMTP_Get_Filelisting()</code> and cache the file, preferably
* as an efficient data structure such as a hash list.
*
* Incidentally this function will return metadata for
* a folder (association) as well, but this is not a proper use
* of it, it is intended for file manipulation, not folder manipulation.
*
* @param device a pointer to the device to get the file metadata from.
* @param fileid the object ID of the file that you want the metadata for.
* @return a metadata entry on success or NULL on failure.
* @see LIBMTP_Get_Filelisting()
*/
LIBMTP_file_t *LIBMTP_Get_Filemetadata(LIBMTP_mtpdevice_t *device, uint32_t const fileid)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
PTPObject *ob;
// Get all the handles if we haven't already done that
// (Only on cached devices.)
if (device->cached && params->nrofobjects == 0) {
flush_handles(device);
}
ret = ptp_object_want(params, fileid, PTPOBJECT_OBJECTINFO_LOADED|PTPOBJECT_MTPPROPLIST_LOADED, &ob);
if (ret != PTP_RC_OK)
return NULL;
return obj2file(device, ob);
}
/**
* THIS FUNCTION IS DEPRECATED. PLEASE UPDATE YOUR CODE IN ORDER
* NOT TO USE IT.
* @see LIBMTP_Get_Filelisting_With_Callback()
*/
LIBMTP_file_t *LIBMTP_Get_Filelisting(LIBMTP_mtpdevice_t *device)
{
LIBMTP_INFO("WARNING: LIBMTP_Get_Filelisting() is deprecated.\n");
LIBMTP_INFO("WARNING: please update your code to use LIBMTP_Get_Filelisting_With_Callback()\n");
return LIBMTP_Get_Filelisting_With_Callback(device, NULL, NULL);
}
/**
* This returns a long list of all files available
* on the current MTP device. Folders will not be returned, but abstract
* entities like playlists and albums will show up as "files". Typical usage:
*
* <pre>
* LIBMTP_file_t *filelist;
*
* filelist = LIBMTP_Get_Filelisting_With_Callback(device, callback, data);
* while (filelist != NULL) {
* LIBMTP_file_t *tmp;
*
* // Do something on each element in the list here...
* tmp = filelist;
* filelist = filelist->next;
* LIBMTP_destroy_file_t(tmp);
* }
* </pre>
*
* If you want to group your file listing by storage (per storage unit) or
* arrange files into folders, you must dereference the <code>storage_id</code>
* and/or <code>parent_id</code> field of the returned <code>LIBMTP_file_t</code>
* struct. To arrange by folders or files you typically have to create the proper
* trees by calls to <code>LIBMTP_Get_Storage()</code> and/or
* <code>LIBMTP_Get_Folder_List()</code> first.
*
* @param device a pointer to the device to get the file listing for.
* @param callback a function to be called during the tracklisting retrieveal
* for displaying progress bars etc, or NULL if you don't want
* any callbacks.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return a list of files that can be followed using the <code>next</code>
* field of the <code>LIBMTP_file_t</code> data structure.
* Each of the metadata tags must be freed after use, and may
* contain only partial metadata information, i.e. one or several
* fields may be NULL or 0.
* @see LIBMTP_Get_Filemetadata()
*/
LIBMTP_file_t *LIBMTP_Get_Filelisting_With_Callback(LIBMTP_mtpdevice_t *device,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
uint32_t i = 0;
LIBMTP_file_t *retfiles = NULL;
LIBMTP_file_t *curfile = NULL;
PTPParams *params = (PTPParams *) device->params;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0) {
flush_handles(device);
}
for (i = 0; i < params->nrofobjects; i++) {
LIBMTP_file_t *file;
PTPObject *ob;
if (callback != NULL)
callback(i, params->nrofobjects, data);
ob = ¶ms->objects[i];
if (ob->oi.ObjectFormat == PTP_OFC_Association) {
// MTP use this object format for folders which means
// these "files" will turn up on a folder listing instead.
continue;
}
// Look up metadata
file = obj2file(device, ob);
if (file == NULL) {
continue;
}
// Add track to a list that will be returned afterwards.
if (retfiles == NULL) {
retfiles = file;
curfile = file;
} else {
curfile->next = file;
curfile = file;
}
// Call listing callback
// double progressPercent = (double)i*(double)100.0 / (double)params->handles.n;
} // Handle counting loop
return retfiles;
}
/**
* This function retrieves the contents of a certain folder
* with id parent on a certain storage on a certain device.
* The result contains both files and folders.
* The device used with this operations must have been opened with
* LIBMTP_Open_Raw_Device_Uncached() or it will fail.
*
* NOTE: the request will always perform I/O with the device.
* @param device a pointer to the MTP device to report info from.
* @param storage a storage on the device to report info from. If
* 0 is passed in, the files for the given parent will be
* searched across all available storages.
* @param parent the parent folder id.
*/
LIBMTP_file_t * LIBMTP_Get_Files_And_Folders(LIBMTP_mtpdevice_t *device,
uint32_t const storage,
uint32_t const parent)
{
PTPParams *params = (PTPParams *) device->params;
LIBMTP_file_t *retfiles = NULL;
LIBMTP_file_t *curfile = NULL;
PTPObjectHandles currentHandles;
uint32_t storageid;
uint16_t ret;
unsigned int i = 0;
if (device->cached) {
// This function is only supposed to be used by devices
// opened as uncached!
LIBMTP_ERROR("tried to use %s on a cached device!\n",
__func__);
return NULL;
}
if (storage == 0)
storageid = PTP_GOH_ALL_STORAGE;
else
storageid = storage;
ret = ptp_getobjecthandles(params,
storageid,
PTP_GOH_ALL_FORMATS,
parent,
¤tHandles);
if (ret != PTP_RC_OK) {
char buf[80];
sprintf(buf,"LIBMTP_Get_Files_And_Folders(): could not get object handles of %08x.", parent);
add_ptp_error_to_errorstack(device, ret, buf);
return NULL;
}
if (currentHandles.Handler == NULL || currentHandles.n == 0)
return NULL;
for (i = 0; i < currentHandles.n; i++) {
LIBMTP_file_t *file;
// Get metadata for one file, if it fails, try next file
file = LIBMTP_Get_Filemetadata(device, currentHandles.Handler[i]);
if (file == NULL)
continue;
// Add track to a list that will be returned afterwards.
if (curfile == NULL) {
curfile = file;
retfiles = file;
} else {
curfile->next = file;
curfile = file;
}
}
free(currentHandles.Handler);
// Return a pointer to the original first file
// in the big list.
return retfiles;
}
/**
* This creates a new track metadata structure and allocates memory
* for it. Notice that if you add strings to this structure they
* will be freed by the corresponding <code>LIBMTP_destroy_track_t</code>
* operation later, so be careful of using strdup() when assigning
* strings, e.g.:
*
* <pre>
* LIBMTP_track_t *track = LIBMTP_new_track_t();
* track->title = strdup(titlestr);
* ....
* LIBMTP_destroy_track_t(track);
* </pre>
*
* @return a pointer to the newly allocated metadata structure.
* @see LIBMTP_destroy_track_t()
*/
LIBMTP_track_t *LIBMTP_new_track_t(void)
{
LIBMTP_track_t *new = (LIBMTP_track_t *) malloc(sizeof(LIBMTP_track_t));
if (new == NULL) {
return NULL;
}
new->item_id = 0;
new->parent_id = 0;
new->storage_id = 0;
new->title = NULL;
new->artist = NULL;
new->composer = NULL;
new->album = NULL;
new->genre = NULL;
new->date = NULL;
new->filename = NULL;
new->duration = 0;
new->tracknumber = 0;
new->filesize = 0;
new->filetype = LIBMTP_FILETYPE_UNKNOWN;
new->samplerate = 0;
new->nochannels = 0;
new->wavecodec = 0;
new->bitrate = 0;
new->bitratetype = 0;
new->rating = 0;
new->usecount = 0;
new->modificationdate = 0;
new->next = NULL;
return new;
}
/**
* This destroys a track metadata structure and deallocates the memory
* used by it, including any strings. Never use a track metadata
* structure again after calling this function on it.
* @param track the track metadata to destroy.
* @see LIBMTP_new_track_t()
*/
void LIBMTP_destroy_track_t(LIBMTP_track_t *track)
{
if (track == NULL) {
return;
}
if (track->title != NULL)
free(track->title);
if (track->artist != NULL)
free(track->artist);
if (track->composer != NULL)
free(track->composer);
if (track->album != NULL)
free(track->album);
if (track->genre != NULL)
free(track->genre);
if (track->date != NULL)
free(track->date);
if (track->filename != NULL)
free(track->filename);
free(track);
return;
}
/**
* This function maps and copies a property onto the track metadata if applicable.
*/
static void pick_property_to_track_metadata(LIBMTP_mtpdevice_t *device, MTPProperties *prop, LIBMTP_track_t *track)
{
switch (prop->property) {
case PTP_OPC_Name:
if (prop->propval.str != NULL)
track->title = strdup(prop->propval.str);
else
track->title = NULL;
break;
case PTP_OPC_Artist:
if (prop->propval.str != NULL)
track->artist = strdup(prop->propval.str);
else
track->artist = NULL;
break;
case PTP_OPC_Composer:
if (prop->propval.str != NULL)
track->composer = strdup(prop->propval.str);
else
track->composer = NULL;
break;
case PTP_OPC_Duration:
track->duration = prop->propval.u32;
break;
case PTP_OPC_Track:
track->tracknumber = prop->propval.u16;
break;
case PTP_OPC_Genre:
if (prop->propval.str != NULL)
track->genre = strdup(prop->propval.str);
else
track->genre = NULL;
break;
case PTP_OPC_AlbumName:
if (prop->propval.str != NULL)
track->album = strdup(prop->propval.str);
else
track->album = NULL;
break;
case PTP_OPC_OriginalReleaseDate:
if (prop->propval.str != NULL)
track->date = strdup(prop->propval.str);
else
track->date = NULL;
break;
// These are, well not so important.
case PTP_OPC_SampleRate:
track->samplerate = prop->propval.u32;
break;
case PTP_OPC_NumberOfChannels:
track->nochannels = prop->propval.u16;
break;
case PTP_OPC_AudioWAVECodec:
track->wavecodec = prop->propval.u32;
break;
case PTP_OPC_AudioBitRate:
track->bitrate = prop->propval.u32;
break;
case PTP_OPC_BitRateType:
track->bitratetype = prop->propval.u16;
break;
case PTP_OPC_Rating:
track->rating = prop->propval.u16;
break;
case PTP_OPC_UseCount:
track->usecount = prop->propval.u32;
break;
case PTP_OPC_ObjectSize:
if (device->object_bitsize == 64) {
track->filesize = prop->propval.u64;
} else {
track->filesize = prop->propval.u32;
}
break;
default:
break;
}
}
/**
* This function retrieves the track metadata for a track
* given by a unique ID.
* @param device a pointer to the device to get the track metadata off.
* @param trackid the unique ID of the track.
* @param objectformat the object format of this track, so we know what it supports.
* @param track a metadata set to fill in.
*/
static void get_track_metadata(LIBMTP_mtpdevice_t *device, uint16_t objectformat,
LIBMTP_track_t *track)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
uint32_t i;
MTPProperties *prop;
PTPObject *ob;
/*
* If we have a cached, large set of metadata, then use it!
*/
ret = ptp_object_want(params, track->item_id, PTPOBJECT_MTPPROPLIST_LOADED, &ob);
if (ob->mtpprops) {
prop = ob->mtpprops;
for (i=0;i<ob->nrofmtpprops;i++,prop++)
pick_property_to_track_metadata(device, prop, track);
} else {
uint16_t *props = NULL;
uint32_t propcnt = 0;
// First see which properties can be retrieved for this object format
ret = ptp_mtp_getobjectpropssupported(params, map_libmtp_type_to_ptp_type(track->filetype), &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "get_track_metadata(): call to ptp_mtp_getobjectpropssupported() failed.");
// Just bail out for now, nothing is ever set.
return;
} else {
for (i=0;i<propcnt;i++) {
switch (props[i]) {
case PTP_OPC_Name:
track->title = get_string_from_object(device, track->item_id, PTP_OPC_Name);
break;
case PTP_OPC_Artist:
track->artist = get_string_from_object(device, track->item_id, PTP_OPC_Artist);
break;
case PTP_OPC_Composer:
track->composer = get_string_from_object(device, track->item_id, PTP_OPC_Composer);
break;
case PTP_OPC_Duration:
track->duration = get_u32_from_object(device, track->item_id, PTP_OPC_Duration, 0);
break;
case PTP_OPC_Track:
track->tracknumber = get_u16_from_object(device, track->item_id, PTP_OPC_Track, 0);
break;
case PTP_OPC_Genre:
track->genre = get_string_from_object(device, track->item_id, PTP_OPC_Genre);
break;
case PTP_OPC_AlbumName:
track->album = get_string_from_object(device, track->item_id, PTP_OPC_AlbumName);
break;
case PTP_OPC_OriginalReleaseDate:
track->date = get_string_from_object(device, track->item_id, PTP_OPC_OriginalReleaseDate);
break;
// These are, well not so important.
case PTP_OPC_SampleRate:
track->samplerate = get_u32_from_object(device, track->item_id, PTP_OPC_SampleRate, 0);
break;
case PTP_OPC_NumberOfChannels:
track->nochannels = get_u16_from_object(device, track->item_id, PTP_OPC_NumberOfChannels, 0);
break;
case PTP_OPC_AudioWAVECodec:
track->wavecodec = get_u32_from_object(device, track->item_id, PTP_OPC_AudioWAVECodec, 0);
break;
case PTP_OPC_AudioBitRate:
track->bitrate = get_u32_from_object(device, track->item_id, PTP_OPC_AudioBitRate, 0);
break;
case PTP_OPC_BitRateType:
track->bitratetype = get_u16_from_object(device, track->item_id, PTP_OPC_BitRateType, 0);
break;
case PTP_OPC_Rating:
track->rating = get_u16_from_object(device, track->item_id, PTP_OPC_Rating, 0);
break;
case PTP_OPC_UseCount:
track->usecount = get_u32_from_object(device, track->item_id, PTP_OPC_UseCount, 0);
break;
case PTP_OPC_ObjectSize:
if (device->object_bitsize == 64) {
track->filesize = get_u64_from_object(device, track->item_id, PTP_OPC_ObjectSize, 0);
} else {
track->filesize = (uint64_t) get_u32_from_object(device, track->item_id, PTP_OPC_ObjectSize, 0);
}
break;
}
}
free(props);
}
}
}
/**
* THIS FUNCTION IS DEPRECATED. PLEASE UPDATE YOUR CODE IN ORDER
* NOT TO USE IT.
* @see LIBMTP_Get_Tracklisting_With_Callback()
*/
LIBMTP_track_t *LIBMTP_Get_Tracklisting(LIBMTP_mtpdevice_t *device)
{
LIBMTP_INFO("WARNING: LIBMTP_Get_Tracklisting() is deprecated.\n");
LIBMTP_INFO("WARNING: please update your code to use LIBMTP_Get_Tracklisting_With_Callback()\n");
return LIBMTP_Get_Tracklisting_With_Callback(device, NULL, NULL);
}
/**
* This returns a long list of all tracks available on the current MTP device.
* Tracks include multimedia objects, both music tracks and video tracks.
* Typical usage:
*
* <pre>
* LIBMTP_track_t *tracklist;
*
* tracklist = LIBMTP_Get_Tracklisting_With_Callback(device, callback, data);
* while (tracklist != NULL) {
* LIBMTP_track_t *tmp;
*
* // Do something on each element in the list here...
* tmp = tracklist;
* tracklist = tracklist->next;
* LIBMTP_destroy_track_t(tmp);
* }
* </pre>
*
* If you want to group your track listing by storage (per storage unit) or
* arrange tracks into folders, you must dereference the <code>storage_id</code>
* and/or <code>parent_id</code> field of the returned <code>LIBMTP_track_t</code>
* struct. To arrange by folders or files you typically have to create the proper
* trees by calls to <code>LIBMTP_Get_Storage()</code> and/or
* <code>LIBMTP_Get_Folder_List()</code> first.
*
* @param device a pointer to the device to get the track listing for.
* @param callback a function to be called during the tracklisting retrieveal
* for displaying progress bars etc, or NULL if you don't want
* any callbacks.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return a list of tracks that can be followed using the <code>next</code>
* field of the <code>LIBMTP_track_t</code> data structure.
* Each of the metadata tags must be freed after use, and may
* contain only partial metadata information, i.e. one or several
* fields may be NULL or 0.
* @see LIBMTP_Get_Trackmetadata()
*/
LIBMTP_track_t *LIBMTP_Get_Tracklisting_With_Callback(LIBMTP_mtpdevice_t *device,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
return LIBMTP_Get_Tracklisting_With_Callback_For_Storage(device, 0, callback, data);
}
/**
* This returns a long list of all tracks available on the current MTP device.
* Tracks include multimedia objects, both music tracks and video tracks.
* Typical usage:
*
* <pre>
* LIBMTP_track_t *tracklist;
*
* tracklist = LIBMTP_Get_Tracklisting_With_Callback_For_Storage(device, storage_id, callback, data);
* while (tracklist != NULL) {
* LIBMTP_track_t *tmp;
*
* // Do something on each element in the list here...
* tmp = tracklist;
* tracklist = tracklist->next;
* LIBMTP_destroy_track_t(tmp);
* }
* </pre>
*
* If you want to group your track listing by storage (per storage unit) or
* arrange tracks into folders, you must dereference the <code>storage_id</code>
* and/or <code>parent_id</code> field of the returned <code>LIBMTP_track_t</code>
* struct. To arrange by folders or files you typically have to create the proper
* trees by calls to <code>LIBMTP_Get_Storage()</code> and/or
* <code>LIBMTP_Get_Folder_List()</code> first.
*
* @param device a pointer to the device to get the track listing for.
* @param storage_id ID of device storage (if null, no filter)
* @param callback a function to be called during the tracklisting retrieveal
* for displaying progress bars etc, or NULL if you don't want
* any callbacks.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return a list of tracks that can be followed using the <code>next</code>
* field of the <code>LIBMTP_track_t</code> data structure.
* Each of the metadata tags must be freed after use, and may
* contain only partial metadata information, i.e. one or several
* fields may be NULL or 0.
* @see LIBMTP_Get_Trackmetadata()
*/
LIBMTP_track_t *LIBMTP_Get_Tracklisting_With_Callback_For_Storage(LIBMTP_mtpdevice_t *device, uint32_t const storage_id,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
uint32_t i = 0;
LIBMTP_track_t *retracks = NULL;
LIBMTP_track_t *curtrack = NULL;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0) {
flush_handles(device);
}
for (i = 0; i < params->nrofobjects; i++) {
LIBMTP_track_t *track;
PTPObject *ob;
LIBMTP_filetype_t mtptype;
if (callback != NULL)
callback(i, params->nrofobjects, data);
ob = ¶ms->objects[i];
mtptype = map_ptp_type_to_libmtp_type(ob->oi.ObjectFormat);
// Ignore stuff we don't know how to handle...
// TODO: get this list as an intersection of the sets
// supported by the device and the from the device and
// all known track files?
if (!LIBMTP_FILETYPE_IS_TRACK(mtptype) &&
// This row lets through undefined files for examination since they may be forgotten OGG files.
(ob->oi.ObjectFormat != PTP_OFC_Undefined ||
(!FLAG_IRIVER_OGG_ALZHEIMER(ptp_usb) &&
!FLAG_OGG_IS_UNKNOWN(ptp_usb) &&
!FLAG_FLAC_IS_UNKNOWN(ptp_usb)))
) {
//printf("Not a music track (name: %s format: %d), skipping...\n", oi->Filename, oi->ObjectFormat);
continue;
}
// Ignore stuff that isn't into the storage device
if ((storage_id != 0) && (ob->oi.StorageID != storage_id ))
continue;
// Allocate a new track type
track = LIBMTP_new_track_t();
// This is some sort of unique ID so we can keep track of the track.
track->item_id = ob->oid;
track->parent_id = ob->oi.ParentObject;
track->storage_id = ob->oi.StorageID;
track->modificationdate = ob->oi.ModificationDate;
track->filetype = mtptype;
// Original file-specific properties
track->filesize = ob->oi.ObjectCompressedSize;
if (ob->oi.Filename != NULL) {
track->filename = strdup(ob->oi.Filename);
}
get_track_metadata(device, ob->oi.ObjectFormat, track);
/*
* A special quirk for iriver devices that doesn't quite
* remember that some files marked as "unknown" type are
* actually OGG or FLAC files. We look at the filename extension
* and see if it happens that this was atleast named "ogg" or "flac"
* and fall back on this heuristic approach in that case,
* for these bugged devices only.
*/
if (track->filetype == LIBMTP_FILETYPE_UNKNOWN &&
track->filename != NULL) {
if ((FLAG_IRIVER_OGG_ALZHEIMER(ptp_usb) ||
FLAG_OGG_IS_UNKNOWN(ptp_usb)) &&
has_ogg_extension(track->filename))
track->filetype = LIBMTP_FILETYPE_OGG;
else if (FLAG_FLAC_IS_UNKNOWN(ptp_usb) &&
has_flac_extension(track->filename))
track->filetype = LIBMTP_FILETYPE_FLAC;
else {
// This was not an OGG/FLAC file so discard it and continue
LIBMTP_destroy_track_t(track);
continue;
}
}
// Add track to a list that will be returned afterwards.
if (retracks == NULL) {
retracks = track;
curtrack = track;
} else {
curtrack->next = track;
curtrack = track;
}
// Call listing callback
// double progressPercent = (double)i*(double)100.0 / (double)params->handles.n;
} // Handle counting loop
return retracks;
}
/**
* This function retrieves the metadata for a single track off
* the device.
*
* Do not call this function repeatedly! The track handles are linearly
* searched O(n) and the call may involve (slow) USB traffic, so use
* <code>LIBMTP_Get_Tracklisting()</code> and cache the tracks, preferably
* as an efficient data structure such as a hash list.
*
* @param device a pointer to the device to get the track metadata from.
* @param trackid the object ID of the track that you want the metadata for.
* @return a track metadata entry on success or NULL on failure.
* @see LIBMTP_Get_Tracklisting()
*/
LIBMTP_track_t *LIBMTP_Get_Trackmetadata(LIBMTP_mtpdevice_t *device, uint32_t const trackid)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
PTPObject *ob;
LIBMTP_track_t *track;
LIBMTP_filetype_t mtptype;
uint16_t ret;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0)
flush_handles(device);
ret = ptp_object_want (params, trackid, PTPOBJECT_OBJECTINFO_LOADED, &ob);
if (ret != PTP_RC_OK)
return NULL;
mtptype = map_ptp_type_to_libmtp_type(ob->oi.ObjectFormat);
// Ignore stuff we don't know how to handle...
if (!LIBMTP_FILETYPE_IS_TRACK(mtptype) &&
/*
* This row lets through undefined files for examination
* since they may be forgotten OGG or FLAC files.
*/
(ob->oi.ObjectFormat != PTP_OFC_Undefined ||
(!FLAG_IRIVER_OGG_ALZHEIMER(ptp_usb) &&
!FLAG_OGG_IS_UNKNOWN(ptp_usb) &&
!FLAG_FLAC_IS_UNKNOWN(ptp_usb)))
) {
//printf("Not a music track (name: %s format: %d), skipping...\n", oi->Filename, oi->ObjectFormat);
return NULL;
}
// Allocate a new track type
track = LIBMTP_new_track_t();
// This is some sort of unique ID so we can keep track of the track.
track->item_id = ob->oid;
track->parent_id = ob->oi.ParentObject;
track->storage_id = ob->oi.StorageID;
track->modificationdate = ob->oi.ModificationDate;
track->filetype = mtptype;
// Original file-specific properties
track->filesize = ob->oi.ObjectCompressedSize;
if (ob->oi.Filename != NULL) {
track->filename = strdup(ob->oi.Filename);
}
/*
* A special quirk for devices that doesn't quite
* remember that some files marked as "unknown" type are
* actually OGG or FLAC files. We look at the filename extension
* and see if it happens that this was atleast named "ogg"
* and fall back on this heuristic approach in that case,
* for these bugged devices only.
*/
if (track->filetype == LIBMTP_FILETYPE_UNKNOWN &&
track->filename != NULL) {
if ((FLAG_IRIVER_OGG_ALZHEIMER(ptp_usb) ||
FLAG_OGG_IS_UNKNOWN(ptp_usb)) &&
has_ogg_extension(track->filename))
track->filetype = LIBMTP_FILETYPE_OGG;
else if (FLAG_FLAC_IS_UNKNOWN(ptp_usb) &&
has_flac_extension(track->filename))
track->filetype = LIBMTP_FILETYPE_FLAC;
else {
// This was not an OGG/FLAC file so discard it
LIBMTP_destroy_track_t(track);
return NULL;
}
}
get_track_metadata(device, ob->oi.ObjectFormat, track);
return track;
}
/**
* This is a manual conversion from MTPDataGetFunc to PTPDataGetFunc
* to isolate the internal type.
*/
static uint16_t get_func_wrapper(PTPParams* params, void* priv, unsigned long wantlen, unsigned char *data, unsigned long *gotlen)
{
MTPDataHandler *handler = (MTPDataHandler *)priv;
uint16_t ret;
uint32_t local_gotlen = 0;
ret = handler->getfunc(params, handler->priv, wantlen, data, &local_gotlen);
*gotlen = local_gotlen;
switch (ret)
{
case LIBMTP_HANDLER_RETURN_OK:
return PTP_RC_OK;
case LIBMTP_HANDLER_RETURN_ERROR:
return PTP_ERROR_IO;
case LIBMTP_HANDLER_RETURN_CANCEL:
return PTP_ERROR_CANCEL;
default:
return PTP_ERROR_IO;
}
}
/**
* This is a manual conversion from MTPDataPutFunc to PTPDataPutFunc
* to isolate the internal type.
*/
static uint16_t put_func_wrapper(PTPParams* params, void* priv, unsigned long sendlen, unsigned char *data)
{
MTPDataHandler *handler = (MTPDataHandler *)priv;
uint16_t ret;
uint32_t local_putlen = 0;
ret = handler->putfunc(params, handler->priv, sendlen, data, &local_putlen);
switch (ret)
{
case LIBMTP_HANDLER_RETURN_OK:
if (local_putlen != sendlen)
return PTP_ERROR_IO;
return PTP_RC_OK;
case LIBMTP_HANDLER_RETURN_ERROR:
return PTP_ERROR_IO;
case LIBMTP_HANDLER_RETURN_CANCEL:
return PTP_ERROR_CANCEL;
default:
return PTP_ERROR_IO;
}
}
/**
* This gets a file off the device to a local file identified
* by a filename.
* @param device a pointer to the device to get the track from.
* @param id the file ID of the file to retrieve.
* @param path a filename to use for the retrieved file.
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Get_File_To_File_Descriptor()
*/
int LIBMTP_Get_File_To_File(LIBMTP_mtpdevice_t *device, uint32_t const id,
char const * const path, LIBMTP_progressfunc_t const callback,
void const * const data)
{
int fd = -1;
int ret;
// Sanity check
if (path == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_File_To_File(): Bad arguments, path was NULL.");
return -1;
}
// Open file
#ifdef __WIN32__
#ifdef USE_WINDOWS_IO_H
if ( (fd = _open(path, O_RDWR|O_CREAT|O_TRUNC|O_BINARY,_S_IREAD)) == -1 ) {
#else
if ( (fd = open(path, O_RDWR|O_CREAT|O_TRUNC|O_BINARY,S_IRWXU)) == -1 ) {
#endif
#else
if ( (fd = open(path, O_RDWR|O_CREAT|O_TRUNC,S_IRWXU|S_IRGRP)) == -1) {
#endif
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_File_To_File(): Could not create file.");
return -1;
}
ret = LIBMTP_Get_File_To_File_Descriptor(device, id, fd, callback, data);
// Close file
close(fd);
// Delete partial file.
if (ret == -1) {
unlink(path);
}
return ret;
}
/**
* This gets a file off the device to a file identified
* by a file descriptor.
*
* This function can potentially be used for streaming
* files off the device for playback or broadcast for example,
* by downloading the file into a stream sink e.g. a socket.
*
* @param device a pointer to the device to get the file from.
* @param id the file ID of the file to retrieve.
* @param fd a local file descriptor to write the file to.
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Get_File_To_File()
*/
int LIBMTP_Get_File_To_File_Descriptor(LIBMTP_mtpdevice_t *device,
uint32_t const id,
int const fd,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
LIBMTP_file_t *mtpfile = LIBMTP_Get_Filemetadata(device, id);
if (mtpfile == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_File_To_File_Descriptor(): Could not get object info.");
return -1;
}
if (mtpfile->filetype == LIBMTP_FILETYPE_FOLDER) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_File_To_File_Descriptor(): Bad object format.");
LIBMTP_destroy_file_t (mtpfile);
return -1;
}
// Callbacks
ptp_usb->callback_active = 1;
ptp_usb->current_transfer_total = mtpfile->filesize +
PTP_USB_BULK_HDR_LEN+sizeof(uint32_t); // Request length, one parameter
ptp_usb->current_transfer_complete = 0;
ptp_usb->current_transfer_callback = callback;
ptp_usb->current_transfer_callback_data = data;
// Don't need mtpfile anymore
LIBMTP_destroy_file_t(mtpfile);
ret = ptp_getobject_tofd(params, id, fd);
ptp_usb->callback_active = 0;
ptp_usb->current_transfer_callback = NULL;
ptp_usb->current_transfer_callback_data = NULL;
if (ret == PTP_ERROR_CANCEL) {
add_error_to_errorstack(device, LIBMTP_ERROR_CANCELLED, "LIBMTP_Get_File_From_File_Descriptor(): Cancelled transfer.");
return -1;
}
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_File_To_File_Descriptor(): Could not get file from device.");
return -1;
}
return 0;
}
/**
* This gets a file off the device and calls put_func
* with chunks of data
*
* @param device a pointer to the device to get the file from.
* @param id the file ID of the file to retrieve.
* @param put_func the function to call when we have data.
* @param priv the user-defined pointer that is passed to
* <code>put_func</code>.
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
*/
int LIBMTP_Get_File_To_Handler(LIBMTP_mtpdevice_t *device,
uint32_t const id,
MTPDataPutFunc put_func,
void * priv,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
LIBMTP_file_t *mtpfile = LIBMTP_Get_Filemetadata(device, id);
if (mtpfile == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_File_To_File_Descriptor(): Could not get object info.");
return -1;
}
if (mtpfile->filetype == LIBMTP_FILETYPE_FOLDER) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_File_To_File_Descriptor(): Bad object format.");
LIBMTP_destroy_file_t (mtpfile);
return -1;
}
// Callbacks
ptp_usb->callback_active = 1;
ptp_usb->current_transfer_total = mtpfile->filesize +
PTP_USB_BULK_HDR_LEN+sizeof(uint32_t); // Request length, one parameter
ptp_usb->current_transfer_complete = 0;
ptp_usb->current_transfer_callback = callback;
ptp_usb->current_transfer_callback_data = data;
// Don't need mtpfile anymore
LIBMTP_destroy_file_t(mtpfile);
MTPDataHandler mtp_handler;
mtp_handler.getfunc = NULL;
mtp_handler.putfunc = put_func;
mtp_handler.priv = priv;
PTPDataHandler handler;
handler.getfunc = NULL;
handler.putfunc = put_func_wrapper;
handler.priv = &mtp_handler;
ret = ptp_getobject_to_handler(params, id, &handler);
ptp_usb->callback_active = 0;
ptp_usb->current_transfer_callback = NULL;
ptp_usb->current_transfer_callback_data = NULL;
if (ret == PTP_ERROR_CANCEL) {
add_error_to_errorstack(device, LIBMTP_ERROR_CANCELLED, "LIBMTP_Get_File_From_File_Descriptor(): Cancelled transfer.");
return -1;
}
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_File_To_File_Descriptor(): Could not get file from device.");
return -1;
}
return 0;
}
/**
* This gets a track off the device to a file identified
* by a filename. This is actually just a wrapper for the
* \c LIBMTP_Get_Track_To_File() function.
* @param device a pointer to the device to get the track from.
* @param id the track ID of the track to retrieve.
* @param path a filename to use for the retrieved track.
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Get_Track_To_File_Descriptor()
*/
int LIBMTP_Get_Track_To_File(LIBMTP_mtpdevice_t *device, uint32_t const id,
char const * const path, LIBMTP_progressfunc_t const callback,
void const * const data)
{
// This is just a wrapper
return LIBMTP_Get_File_To_File(device, id, path, callback, data);
}
/**
* This gets a track off the device to a file identified
* by a file descriptor. This is actually just a wrapper for
* the \c LIBMTP_Get_File_To_File_Descriptor() function.
* @param device a pointer to the device to get the track from.
* @param id the track ID of the track to retrieve.
* @param fd a file descriptor to write the track to.
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Get_Track_To_File()
*/
int LIBMTP_Get_Track_To_File_Descriptor(LIBMTP_mtpdevice_t *device,
uint32_t const id,
int const fd,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
// This is just a wrapper
return LIBMTP_Get_File_To_File_Descriptor(device, id, fd, callback, data);
}
/**
* This gets a track off the device to a handler function.
* This is actually just a wrapper for
* the \c LIBMTP_Get_File_To_Handler() function.
* @param device a pointer to the device to get the track from.
* @param id the track ID of the track to retrieve.
* @param put_func the function to call when we have data.
* @param priv the user-defined pointer that is passed to
* <code>put_func</code>.
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
*/
int LIBMTP_Get_Track_To_Handler(LIBMTP_mtpdevice_t *device,
uint32_t const id,
MTPDataPutFunc put_func,
void * priv,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
// This is just a wrapper
return LIBMTP_Get_File_To_Handler(device, id, put_func, priv, callback, data);
}
/**
* This function sends a track from a local file to an
* MTP device. A filename and a set of metadata must be
* given as input.
* @param device a pointer to the device to send the track to.
* @param path the filename of a local file which will be sent.
* @param metadata a track metadata set to be written along with the file.
* After this call the field <code>metadata->item_id</code>
* will contain the new track ID. Other fields such
* as the <code>metadata->filename</code>, <code>metadata->parent_id</code>
* or <code>metadata->storage_id</code> may also change during this
* operation due to device restrictions, so do not rely on the
* contents of this struct to be preserved in any way.
* <ul>
* <li><code>metadata->parent_id</code> should be set to the parent
* (e.g. folder) to store this track in. Since some
* devices are a bit picky about where files
* are placed, a default folder will be chosen if libmtp
* has detected one for the current filetype and this
* parameter is set to 0. If this is 0 and no default folder
* can be found, the file will be stored in the root folder.
* <li><code>metadata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this track in. Setting this to 0 will store
* the track on the primary storage.
* </ul>
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Send_Track_From_File_Descriptor()
* @see LIBMTP_Send_File_From_File()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Send_Track_From_File(LIBMTP_mtpdevice_t *device,
char const * const path, LIBMTP_track_t * const metadata,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
int fd;
int ret;
// Sanity check
if (path == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Send_Track_From_File(): Bad arguments, path was NULL.");
return -1;
}
// Open file
#ifdef __WIN32__
#ifdef USE_WINDOWS_IO_H
if ( (fd = _open(path, O_RDONLY|O_BINARY)) == -1 ) {
#else
if ( (fd = open(path, O_RDONLY|O_BINARY)) == -1 ) {
#endif
#else
if ( (fd = open(path, O_RDONLY)) == -1) {
#endif
LIBMTP_ERROR("LIBMTP_Send_Track_From_File(): Could not open source file \"%s\"\n", path);
return -1;
}
ret = LIBMTP_Send_Track_From_File_Descriptor(device, fd, metadata, callback, data);
// Close file.
#ifdef USE_WINDOWS_IO_H
_close(fd);
#else
close(fd);
#endif
return ret;
}
/**
* This helper function checks if a filename already exists on the device
* @param PTPParams*
* @param string representing the filename
* @return 0 if the filename doesn't exist, -1 if it does
*/
static int check_filename_exists(PTPParams* params, char const * const filename)
{
unsigned int i;
for (i = 0; i < params->nrofobjects; i++) {
char *fname = params->objects[i].oi.Filename;
if ((fname != NULL) && (strcmp(filename, fname) == 0))
{
return -1;
}
}
return 0;
}
/**
* This helper function returns a unique filename, with a random string before the extension
* @param string representing the original filename
* @return a string representing the unique filename
*/
static char *generate_unique_filename(PTPParams* params, char const * const filename)
{
int suffix;
char * extension_position;
if (check_filename_exists(params, filename))
{
extension_position = strrchr(filename,'.');
char basename[extension_position - filename + 1];
strncpy(basename, filename, extension_position - filename);
basename[extension_position - filename] = '\0';
suffix = 1;
char newname[ strlen(basename) + 6 + strlen(extension_position)];
sprintf(newname, "%s_%d%s", basename, suffix, extension_position);
while ((check_filename_exists(params, newname)) && (suffix < 1000000)) {
suffix++;
sprintf(newname, "%s_%d%s", basename, suffix, extension_position);
}
return strdup(newname);
}
else
{
return strdup(filename);
}
}
/**
* This function sends a track from a file descriptor to an
* MTP device. A filename and a set of metadata must be
* given as input.
* @param device a pointer to the device to send the track to.
* @param fd the filedescriptor for a local file which will be sent.
* @param metadata a track metadata set to be written along with the file.
* After this call the field <code>metadata->item_id</code>
* will contain the new track ID. Other fields such
* as the <code>metadata->filename</code>, <code>metadata->parent_id</code>
* or <code>metadata->storage_id</code> may also change during this
* operation due to device restrictions, so do not rely on the
* contents of this struct to be preserved in any way.
* <ul>
* <li><code>metadata->parent_id</code> should be set to the parent
* (e.g. folder) to store this track in. Since some
* devices are a bit picky about where files
* are placed, a default folder will be chosen if libmtp
* has detected one for the current filetype and this
* parameter is set to 0. If this is 0 and no default folder
* can be found, the file will be stored in the root folder.
* <li><code>metadata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this track in. Setting this to 0 will store
* the track on the primary storage.
* </ul>
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Send_Track_From_File()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Send_Track_From_File_Descriptor(LIBMTP_mtpdevice_t *device,
int const fd, LIBMTP_track_t * const metadata,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
int subcall_ret;
LIBMTP_file_t filedata;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
PTPParams *params = (PTPParams *) device->params;
// Sanity check, is this really a track?
if (!LIBMTP_FILETYPE_IS_TRACK(metadata->filetype)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Send_Track_From_File_Descriptor(): "
"I don't think this is actually a track, strange filetype...");
}
// Wrap around the file transfer function
filedata.item_id = metadata->item_id;
filedata.parent_id = metadata->parent_id;
filedata.storage_id = metadata->storage_id;
if FLAG_UNIQUE_FILENAMES(ptp_usb) {
filedata.filename = generate_unique_filename(params, metadata->filename);
}
else {
filedata.filename = metadata->filename;
}
filedata.filesize = metadata->filesize;
filedata.filetype = metadata->filetype;
filedata.next = NULL;
subcall_ret = LIBMTP_Send_File_From_File_Descriptor(device,
fd,
&filedata,
callback,
data);
if (subcall_ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Send_Track_From_File_Descriptor(): "
"subcall to LIBMTP_Send_File_From_File_Descriptor failed.");
// We used to delete the file here, but don't... It might be OK after all.
// (void) LIBMTP_Delete_Object(device, metadata->item_id);
return -1;
}
// Pick up new item (and parent, storage) ID
metadata->item_id = filedata.item_id;
metadata->parent_id = filedata.parent_id;
metadata->storage_id = filedata.storage_id;
// Set track metadata for the new fine track
subcall_ret = LIBMTP_Update_Track_Metadata(device, metadata);
if (subcall_ret != 0) {
// Subcall will add error to errorstack
// We used to delete the file here, but don't... It might be OK after all.
// (void) LIBMTP_Delete_Object(device, metadata->item_id);
return -1;
}
// note we don't need to update the cache here because LIBMTP_Send_File_From_File_Descriptor
// has added the object handle and LIBMTP_Update_Track_Metadata has added the metadata.
return 0;
}
/**
* This function sends a track from a handler function to an
* MTP device. A filename and a set of metadata must be
* given as input.
* @param device a pointer to the device to send the track to.
* @param get_func the function to call when we have data.
* @param priv the user-defined pointer that is passed to
* <code>get_func</code>.
* @param metadata a track metadata set to be written along with the file.
* After this call the field <code>metadata->item_id</code>
* will contain the new track ID. Other fields such
* as the <code>metadata->filename</code>, <code>metadata->parent_id</code>
* or <code>metadata->storage_id</code> may also change during this
* operation due to device restrictions, so do not rely on the
* contents of this struct to be preserved in any way.
* <ul>
* <li><code>metadata->parent_id</code> should be set to the parent
* (e.g. folder) to store this track in. Since some
* devices are a bit picky about where files
* are placed, a default folder will be chosen if libmtp
* has detected one for the current filetype and this
* parameter is set to 0. If this is 0 and no default folder
* can be found, the file will be stored in the root folder.
* <li><code>metadata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this track in. Setting this to 0 will store
* the track on the primary storage.
* </ul>
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Send_Track_From_File()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Send_Track_From_Handler(LIBMTP_mtpdevice_t *device,
MTPDataGetFunc get_func, void * priv, LIBMTP_track_t * const metadata,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
int subcall_ret;
LIBMTP_file_t filedata;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
PTPParams *params = (PTPParams *) device->params;
// Sanity check, is this really a track?
if (!LIBMTP_FILETYPE_IS_TRACK(metadata->filetype)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Send_Track_From_Handler(): "
"I don't think this is actually a track, strange filetype...");
}
// Wrap around the file transfer function
filedata.item_id = metadata->item_id;
filedata.parent_id = metadata->parent_id;
filedata.storage_id = metadata->storage_id;
if FLAG_UNIQUE_FILENAMES(ptp_usb) {
filedata.filename = generate_unique_filename(params, metadata->filename);
}
else {
filedata.filename = metadata->filename;
}
filedata.filesize = metadata->filesize;
filedata.filetype = metadata->filetype;
filedata.next = NULL;
subcall_ret = LIBMTP_Send_File_From_Handler(device,
get_func,
priv,
&filedata,
callback,
data);
if (subcall_ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Send_Track_From_Handler(): "
"subcall to LIBMTP_Send_File_From_Handler failed.");
// We used to delete the file here, but don't... It might be OK after all.
// (void) LIBMTP_Delete_Object(device, metadata->item_id);
return -1;
}
// Pick up new item (and parent, storage) ID
metadata->item_id = filedata.item_id;
metadata->parent_id = filedata.parent_id;
metadata->storage_id = filedata.storage_id;
// Set track metadata for the new fine track
subcall_ret = LIBMTP_Update_Track_Metadata(device, metadata);
if (subcall_ret != 0) {
// Subcall will add error to errorstack
// We used to delete the file here, but don't... It might be OK after all.
// (void) LIBMTP_Delete_Object(device, metadata->item_id);
return -1;
}
// note we don't need to update the cache here because LIBMTP_Send_File_From_File_Descriptor
// has added the object handle and LIBMTP_Update_Track_Metadata has added the metadata.
return 0;
}
/**
* This function sends a local file to an MTP device.
* A filename and a set of metadata must be
* given as input.
* @param device a pointer to the device to send the track to.
* @param path the filename of a local file which will be sent.
* @param filedata a file metadata set to be written along with the file.
* After this call the field <code>filedata->item_id</code>
* will contain the new file ID. Other fields such
* as the <code>filedata->filename</code>, <code>filedata->parent_id</code>
* or <code>filedata->storage_id</code> may also change during this
* operation due to device restrictions, so do not rely on the
* contents of this struct to be preserved in any way.
* <ul>
* <li><code>filedata->parent_id</code> should be set to the parent
* (e.g. folder) to store this file in. If this is 0,
* the file will be stored in the root folder.
* <li><code>filedata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this file in. Setting this to 0 will store
* the file on the primary storage.
* </ul>
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Send_File_From_File_Descriptor()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Send_File_From_File(LIBMTP_mtpdevice_t *device,
char const * const path, LIBMTP_file_t * const filedata,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
int fd;
int ret;
// Sanity check
if (path == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Send_File_From_File(): Bad arguments, path was NULL.");
return -1;
}
// Open file
#ifdef __WIN32__
#ifdef USE_WINDOWS_IO_H
if ( (fd = _open(path, O_RDONLY|O_BINARY)) == -1 ) {
#else
if ( (fd = open(path, O_RDONLY|O_BINARY)) == -1 ) {
#endif
#else
if ( (fd = open(path, O_RDONLY)) == -1) {
#endif
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Send_File_From_File(): Could not open source file.");
return -1;
}
ret = LIBMTP_Send_File_From_File_Descriptor(device, fd, filedata, callback, data);
// Close file.
#ifdef USE_WINDOWS_IO_H
_close(fd);
#else
close(fd);
#endif
return ret;
}
/**
* This function sends a generic file from a file descriptor to an
* MTP device. A filename and a set of metadata must be
* given as input.
*
* This can potentially be used for sending in a stream of unknown
* length. Send music files with
* <code>LIBMTP_Send_Track_From_File_Descriptor()</code>
*
* @param device a pointer to the device to send the file to.
* @param fd the filedescriptor for a local file which will be sent.
* @param filedata a file metadata set to be written along with the file.
* After this call the field <code>filedata->item_id</code>
* will contain the new file ID. Other fields such
* as the <code>filedata->filename</code>, <code>filedata->parent_id</code>
* or <code>filedata->storage_id</code> may also change during this
* operation due to device restrictions, so do not rely on the
* contents of this struct to be preserved in any way.
* <ul>
* <li><code>filedata->parent_id</code> should be set to the parent
* (e.g. folder) to store this file in. If this is 0,
* the file will be stored in the root folder.
* <li><code>filedata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this file in. Setting this to 0 will store
* the file on the primary storage.
* </ul>
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Send_File_From_File()
* @see LIBMTP_Send_Track_From_File_Descriptor()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Send_File_From_File_Descriptor(LIBMTP_mtpdevice_t *device,
int const fd, LIBMTP_file_t * const filedata,
LIBMTP_progressfunc_t const callback,
void const * const data)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
LIBMTP_file_t *newfilemeta;
int oldtimeout;
int timeout;
if (send_file_object_info(device, filedata))
{
// no need to output an error since send_file_object_info will already have done so
return -1;
}
// Callbacks
ptp_usb->callback_active = 1;
// The callback will deactivate itself after this amount of data has been sent
// One BULK header for the request, one for the data phase. No parameters to the request.
ptp_usb->current_transfer_total = filedata->filesize+PTP_USB_BULK_HDR_LEN*2;
ptp_usb->current_transfer_complete = 0;
ptp_usb->current_transfer_callback = callback;
ptp_usb->current_transfer_callback_data = data;
/*
* We might need to increase the timeout here, files can be pretty
* large. Take the default timeout and add the calculated time for
* this transfer
*/
get_usb_device_timeout(ptp_usb, &oldtimeout);
timeout = oldtimeout +
(ptp_usb->current_transfer_total / guess_usb_speed(ptp_usb)) * 1000;
set_usb_device_timeout(ptp_usb, timeout);
ret = ptp_sendobject_fromfd(params, fd, filedata->filesize);
ptp_usb->callback_active = 0;
ptp_usb->current_transfer_callback = NULL;
ptp_usb->current_transfer_callback_data = NULL;
set_usb_device_timeout(ptp_usb, oldtimeout);
if (ret == PTP_ERROR_CANCEL) {
add_error_to_errorstack(device, LIBMTP_ERROR_CANCELLED, "LIBMTP_Send_File_From_File_Descriptor(): Cancelled transfer.");
return -1;
}
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Send_File_From_File_Descriptor(): "
"Could not send object.");
return -1;
}
add_object_to_cache(device, filedata->item_id);
/*
* Get the device-assigned parent_id from the cache.
* The operation that adds it to the cache will
* look it up from the device, so we get the new
* parent_id from the cache.
*/
newfilemeta = LIBMTP_Get_Filemetadata(device, filedata->item_id);
if (newfilemeta != NULL) {
filedata->parent_id = newfilemeta->parent_id;
filedata->storage_id = newfilemeta->storage_id;
LIBMTP_destroy_file_t(newfilemeta);
} else {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Send_File_From_File_Descriptor(): "
"Could not retrieve updated metadata.");
return -1;
}
return 0;
}
/**
* This function sends a generic file from a handler function to an
* MTP device. A filename and a set of metadata must be
* given as input.
*
* This can potentially be used for sending in a stream of unknown
* length. Send music files with
* <code>LIBMTP_Send_Track_From_Handler()</code>
*
* @param device a pointer to the device to send the file to.
* @param get_func the function to call to get data to write
* @param priv a user-defined pointer that is passed along to
* <code>get_func</code>. If not used, this is set to NULL.
* @param filedata a file metadata set to be written along with the file.
* After this call the field <code>filedata->item_id</code>
* will contain the new file ID. Other fields such
* as the <code>filedata->filename</code>, <code>filedata->parent_id</code>
* or <code>filedata->storage_id</code> may also change during this
* operation due to device restrictions, so do not rely on the
* contents of this struct to be preserved in any way.
* <ul>
* <li><code>filedata->parent_id</code> should be set to the parent
* (e.g. folder) to store this file in. If this is 0,
* the file will be stored in the root folder.
* <li><code>filedata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this file in. Setting this to 0 will store
* the file on the primary storage.
* </ul>
* @param callback a progress indicator function or NULL to ignore.
* @param data a user-defined pointer that is passed along to
* the <code>progress</code> function in order to
* pass along some user defined data to the progress
* updates. If not used, set this to NULL.
* @return 0 if the transfer was successful, any other value means
* failure.
* @see LIBMTP_Send_File_From_File()
* @see LIBMTP_Send_Track_From_File_Descriptor()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Send_File_From_Handler(LIBMTP_mtpdevice_t *device,
MTPDataGetFunc get_func, void * priv, LIBMTP_file_t * const filedata,
LIBMTP_progressfunc_t const callback, void const * const data)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
LIBMTP_file_t *newfilemeta;
if (send_file_object_info(device, filedata))
{
// no need to output an error since send_file_object_info will already have done so
return -1;
}
// Callbacks
ptp_usb->callback_active = 1;
// The callback will deactivate itself after this amount of data has been sent
// One BULK header for the request, one for the data phase. No parameters to the request.
ptp_usb->current_transfer_total = filedata->filesize+PTP_USB_BULK_HDR_LEN*2;
ptp_usb->current_transfer_complete = 0;
ptp_usb->current_transfer_callback = callback;
ptp_usb->current_transfer_callback_data = data;
MTPDataHandler mtp_handler;
mtp_handler.getfunc = get_func;
mtp_handler.putfunc = NULL;
mtp_handler.priv = priv;
PTPDataHandler handler;
handler.getfunc = get_func_wrapper;
handler.putfunc = NULL;
handler.priv = &mtp_handler;
ret = ptp_sendobject_from_handler(params, &handler, filedata->filesize);
ptp_usb->callback_active = 0;
ptp_usb->current_transfer_callback = NULL;
ptp_usb->current_transfer_callback_data = NULL;
if (ret == PTP_ERROR_CANCEL) {
add_error_to_errorstack(device, LIBMTP_ERROR_CANCELLED, "LIBMTP_Send_File_From_Handler(): Cancelled transfer.");
return -1;
}
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Send_File_From_Handler(): "
"Could not send object.");
return -1;
}
add_object_to_cache(device, filedata->item_id);
/*
* Get the device-assined parent_id from the cache.
* The operation that adds it to the cache will
* look it up from the device, so we get the new
* parent_id from the cache.
*/
newfilemeta = LIBMTP_Get_Filemetadata(device, filedata->item_id);
if (newfilemeta != NULL) {
filedata->parent_id = newfilemeta->parent_id;
filedata->storage_id = newfilemeta->storage_id;
LIBMTP_destroy_file_t(newfilemeta);
} else {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_Send_File_From_Handler(): "
"Could not retrieve updated metadata.");
return -1;
}
return 0;
}
/**
* This function sends the file object info, ready for sendobject
* @param device a pointer to the device to send the file to.
* @param filedata a file metadata set to be written along with the file.
* @return 0 if the transfer was successful, any other value means
* failure.
*/
static int send_file_object_info(LIBMTP_mtpdevice_t *device, LIBMTP_file_t *filedata)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
uint32_t store;
int use_primary_storage = 1;
uint16_t of = map_libmtp_type_to_ptp_type(filedata->filetype);
LIBMTP_devicestorage_t *storage;
uint32_t localph = filedata->parent_id;
uint16_t ret;
unsigned int i;
#if 0
// Sanity check: no zerolength files on some devices?
// If the zerolength files cause problems on some devices,
// then add a bug flag for this.
if (filedata->filesize == 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "send_file_object_info(): "
"File of zero size.");
return -1;
}
#endif
if (filedata->storage_id != 0) {
store = filedata->storage_id;
} else {
store = get_suggested_storage_id(device, filedata->filesize, localph);
}
// Detect if something non-primary is in use.
storage = device->storage;
if (storage != NULL && store != storage->id) {
use_primary_storage = 0;
}
/*
* If no destination folder was given, look up a default
* folder if possible. Perhaps there is some way of retrieveing
* the default folder for different forms of content, what
* do I know, we use a fixed list in lack of any better method.
* Some devices obviously need to have their files in certain
* folders in order to find/display them at all (hello Creative),
* so we have to have a method for this. We only do this if the
* primary storage is in use.
*/
if (localph == 0 && use_primary_storage) {
if (LIBMTP_FILETYPE_IS_AUDIO(filedata->filetype)) {
localph = device->default_music_folder;
} else if (LIBMTP_FILETYPE_IS_VIDEO(filedata->filetype)) {
localph = device->default_video_folder;
} else if (of == PTP_OFC_EXIF_JPEG ||
of == PTP_OFC_JP2 ||
of == PTP_OFC_JPX ||
of == PTP_OFC_JFIF ||
of == PTP_OFC_TIFF ||
of == PTP_OFC_TIFF_IT ||
of == PTP_OFC_BMP ||
of == PTP_OFC_GIF ||
of == PTP_OFC_PICT ||
of == PTP_OFC_PNG ||
of == PTP_OFC_MTP_WindowsImageFormat) {
localph = device->default_picture_folder;
} else if (of == PTP_OFC_MTP_vCalendar1 ||
of == PTP_OFC_MTP_vCalendar2 ||
of == PTP_OFC_MTP_UndefinedContact ||
of == PTP_OFC_MTP_vCard2 ||
of == PTP_OFC_MTP_vCard3 ||
of == PTP_OFC_MTP_UndefinedCalendarItem) {
localph = device->default_organizer_folder;
} else if (of == PTP_OFC_Text) {
localph = device->default_text_folder;
}
}
// Here we wire the type to unknown on bugged, but
// Ogg or FLAC-supportive devices.
if (FLAG_OGG_IS_UNKNOWN(ptp_usb) && of == PTP_OFC_MTP_OGG) {
of = PTP_OFC_Undefined;
}
if (FLAG_FLAC_IS_UNKNOWN(ptp_usb) && of == PTP_OFC_MTP_FLAC) {
of = PTP_OFC_Undefined;
}
if (ptp_operation_issupported(params, PTP_OC_MTP_SendObjectPropList) &&
!FLAG_BROKEN_SEND_OBJECT_PROPLIST(ptp_usb)) {
/*
* MTP enhanched does it this way (from a sniff):
* -> PTP_OC_MTP_SendObjectPropList (0x9808):
* 20 00 00 00 01 00 08 98 1B 00 00 00 01 00 01 00
* FF FF FF FF 00 30 00 00 00 00 00 00 12 5E 00 00
* Length: 0x00000020
* Type: 0x0001 PTP_USB_CONTAINER_COMMAND
* Code: 0x9808
* Transaction ID: 0x0000001B
* Param1: 0x00010001 <- store
* Param2: 0xffffffff <- parent handle (-1 ?)
* Param3: 0x00003000 <- file type PTP_OFC_Undefined - we don't know about PDF files
* Param4: 0x00000000 <- file length MSB (-0x0c header len)
* Param5: 0x00005e12 <- file length LSB (-0x0c header len)
*
* -> PTP_OC_MTP_SendObjectPropList (0x9808):
* 46 00 00 00 02 00 08 98 1B 00 00 00 03 00 00 00
* 00 00 00 00 07 DC FF FF 0D 4B 00 53 00 30 00 36 - dc07 = file name
* 00 30 00 33 00 30 00 36 00 2E 00 70 00 64 00 66
* 00 00 00 00 00 00 00 03 DC 04 00 00 00 00 00 00 - dc03 = protection status
* 00 4F DC 02 00 01 - dc4f = non consumable
* Length: 0x00000046
* Type: 0x0002 PTP_USB_CONTAINER_DATA
* Code: 0x9808
* Transaction ID: 0x0000001B
* Metadata....
* 0x00000003 <- Number of metadata items
* 0x00000000 <- Object handle, set to 0x00000000 since it is unknown!
* 0xdc07 <- metadata type: file name
* 0xffff <- metadata type: string
* 0x0d <- number of (uint16_t) characters
* 4b 53 30 36 30 33 30 36 2e 50 64 66 00 "KS060306.pdf", null terminated
* 0x00000000 <- Object handle, set to 0x00000000 since it is unknown!
* 0xdc03 <- metadata type: protection status
* 0x0004 <- metadata type: uint16_t
* 0x0000 <- not protected
* 0x00000000 <- Object handle, set to 0x00000000 since it is unknown!
* 0xdc4f <- non consumable
* 0x0002 <- metadata type: uint8_t
* 0x01 <- non-consumable (this device cannot display PDF)
*
* <- Read 0x18 bytes back
* 18 00 00 00 03 00 01 20 1B 00 00 00 01 00 01 00
* 00 00 00 00 01 40 00 00
* Length: 0x000000018
* Type: 0x0003 PTP_USB_CONTAINER_RESPONSE
* Code: 0x2001 PTP_OK
* Transaction ID: 0x0000001B
* Param1: 0x00010001 <- store
* Param2: 0x00000000 <- parent handle
* Param3: 0x00004001 <- new file/object ID
*
* -> PTP_OC_SendObject (0x100d)
* 0C 00 00 00 01 00 0D 10 1C 00 00 00
* -> ... all the bytes ...
* <- Read 0x0c bytes back
* 0C 00 00 00 03 00 01 20 1C 00 00 00
* ... Then update metadata one-by one, actually (instead of sending it first!) ...
*/
MTPProperties *props = NULL;
int nrofprops = 0;
MTPProperties *prop = NULL;
uint16_t *properties = NULL;
uint32_t propcnt = 0;
// default parent handle
if (localph == 0)
localph = 0xFFFFFFFFU; // Set to -1
// Must be 0x00000000U for new objects
filedata->item_id = 0x00000000U;
ret = ptp_mtp_getobjectpropssupported(params, of, &propcnt, &properties);
for (i=0;i<propcnt;i++) {
PTPObjectPropDesc opd;
ret = ptp_mtp_getobjectpropdesc(params, properties[i], of, &opd);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "send_file_object_info(): "
"could not get property description.");
} else if (opd.GetSet) {
switch (properties[i]) {
case PTP_OPC_ObjectFileName:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = filedata->item_id;
prop->property = PTP_OPC_ObjectFileName;
prop->datatype = PTP_DTC_STR;
if (filedata->filename != NULL) {
prop->propval.str = strdup(filedata->filename);
if (FLAG_ONLY_7BIT_FILENAMES(ptp_usb)) {
strip_7bit_from_utf8(prop->propval.str);
}
}
break;
case PTP_OPC_ProtectionStatus:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = filedata->item_id;
prop->property = PTP_OPC_ProtectionStatus;
prop->datatype = PTP_DTC_UINT16;
prop->propval.u16 = 0x0000U; /* Not protected */
break;
case PTP_OPC_NonConsumable:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = filedata->item_id;
prop->property = PTP_OPC_NonConsumable;
prop->datatype = PTP_DTC_UINT8;
prop->propval.u8 = 0x00; /* It is supported, then it is consumable */
break;
case PTP_OPC_Name:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = filedata->item_id;
prop->property = PTP_OPC_Name;
prop->datatype = PTP_DTC_STR;
if (filedata->filename != NULL)
prop->propval.str = strdup(filedata->filename);
break;
case PTP_OPC_DateModified:
// Tag with current time if that is supported
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = filedata->item_id;
prop->property = PTP_OPC_DateModified;
prop->datatype = PTP_DTC_STR;
prop->propval.str = get_iso8601_stamp();
filedata->modificationdate = time(NULL);
}
break;
}
}
ptp_free_objectpropdesc(&opd);
}
free(properties);
ret = ptp_mtp_sendobjectproplist(params, &store, &localph, &filedata->item_id,
of, filedata->filesize, props, nrofprops);
/* Free property list */
ptp_destroy_object_prop_list(props, nrofprops);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "send_file_object_info():"
"Could not send object property list.");
if (ret == PTP_RC_AccessDenied) {
add_ptp_error_to_errorstack(device, ret, "ACCESS DENIED.");
}
return -1;
}
} else if (ptp_operation_issupported(params,PTP_OC_SendObjectInfo)) {
PTPObjectInfo new_file;
memset(&new_file, 0, sizeof(PTPObjectInfo));
new_file.Filename = filedata->filename;
if (FLAG_ONLY_7BIT_FILENAMES(ptp_usb)) {
strip_7bit_from_utf8(new_file.Filename);
}
if (filedata->filesize > 0xFFFFFFFFL) {
// This is a kludge in the MTP standard for large files.
new_file.ObjectCompressedSize = (uint32_t) 0xFFFFFFFF;
} else {
new_file.ObjectCompressedSize = (uint32_t) filedata->filesize;
}
new_file.ObjectFormat = of;
new_file.StorageID = store;
new_file.ParentObject = localph;
new_file.ModificationDate = time(NULL);
// Create the object
ret = ptp_sendobjectinfo(params, &store, &localph, &filedata->item_id, &new_file);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "send_file_object_info(): "
"Could not send object info.");
if (ret == PTP_RC_AccessDenied) {
add_ptp_error_to_errorstack(device, ret, "ACCESS DENIED.");
}
return -1;
}
// NOTE: the char* pointers inside new_file are not copies so don't
// try to destroy this objectinfo!
}
// Now there IS an object with this parent handle.
filedata->parent_id = localph;
return 0;
}
/**
* This function updates the MTP track object metadata on a
* single file identified by an object ID.
* @param device a pointer to the device to update the track
* metadata on.
* @param metadata a track metadata set to be written to the file.
* notice that the <code>track_id</code> field of the
* metadata structure must be correct so that the
* function can update the right file. If some properties
* of this metadata are set to NULL (strings) or 0
* (numerical values) they will be discarded and the
* track will not be tagged with these blank values.
* @return 0 on success, any other value means failure. If some
* or all of the properties fail to update we will still
* return success. On some devices (notably iRiver T30)
* properties that exist cannot be updated.
*/
int LIBMTP_Update_Track_Metadata(LIBMTP_mtpdevice_t *device,
LIBMTP_track_t const * const metadata)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
uint32_t i;
uint16_t *properties = NULL;
uint32_t propcnt = 0;
// First see which properties can be set on this file format and apply accordingly
// i.e only try to update this metadata for object tags that exist on the current player.
ret = ptp_mtp_getobjectpropssupported(params, map_libmtp_type_to_ptp_type(metadata->filetype), &propcnt, &properties);
if (ret != PTP_RC_OK) {
// Just bail out for now, nothing is ever set.
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not retrieve supported object properties.");
return -1;
}
if (ptp_operation_issupported(params, PTP_OC_MTP_SetObjPropList) &&
!FLAG_BROKEN_SET_OBJECT_PROPLIST(ptp_usb)) {
MTPProperties *props = NULL;
MTPProperties *prop = NULL;
int nrofprops = 0;
for (i=0;i<propcnt;i++) {
PTPObjectPropDesc opd;
ret = ptp_mtp_getobjectpropdesc(params, properties[i], map_libmtp_type_to_ptp_type(metadata->filetype), &opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not get property description.");
} else if (opd.GetSet) {
switch (properties[i]) {
case PTP_OPC_Name:
if (metadata->title == NULL)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Name;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(metadata->title);
break;
case PTP_OPC_AlbumName:
if (metadata->album == NULL)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_AlbumName;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(metadata->album);
break;
case PTP_OPC_Artist:
if (metadata->artist == NULL)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Artist;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(metadata->artist);
break;
case PTP_OPC_Composer:
if (metadata->composer == NULL)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Composer;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(metadata->composer);
break;
case PTP_OPC_Genre:
if (metadata->genre == NULL)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Genre;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(metadata->genre);
break;
case PTP_OPC_Duration:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Duration;
prop->datatype = PTP_DTC_UINT32;
prop->propval.u32 = adjust_u32(metadata->duration, &opd);
break;
case PTP_OPC_Track:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Track;
prop->datatype = PTP_DTC_UINT16;
prop->propval.u16 = adjust_u16(metadata->tracknumber, &opd);
break;
case PTP_OPC_OriginalReleaseDate:
if (metadata->date == NULL)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_OriginalReleaseDate;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(metadata->date);
break;
case PTP_OPC_SampleRate:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_SampleRate;
prop->datatype = PTP_DTC_UINT32;
prop->propval.u32 = adjust_u32(metadata->samplerate, &opd);
break;
case PTP_OPC_NumberOfChannels:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_NumberOfChannels;
prop->datatype = PTP_DTC_UINT16;
prop->propval.u16 = adjust_u16(metadata->nochannels, &opd);
break;
case PTP_OPC_AudioWAVECodec:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_AudioWAVECodec;
prop->datatype = PTP_DTC_UINT32;
prop->propval.u32 = adjust_u32(metadata->wavecodec, &opd);
break;
case PTP_OPC_AudioBitRate:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_AudioBitRate;
prop->datatype = PTP_DTC_UINT32;
prop->propval.u32 = adjust_u32(metadata->bitrate, &opd);
break;
case PTP_OPC_BitRateType:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_BitRateType;
prop->datatype = PTP_DTC_UINT16;
prop->propval.u16 = adjust_u16(metadata->bitratetype, &opd);
break;
case PTP_OPC_Rating:
// TODO: shall this be set for rating 0?
if (metadata->rating == 0)
break;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_Rating;
prop->datatype = PTP_DTC_UINT16;
prop->propval.u16 = adjust_u16(metadata->rating, &opd);
break;
case PTP_OPC_UseCount:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_UseCount;
prop->datatype = PTP_DTC_UINT32;
prop->propval.u32 = adjust_u32(metadata->usecount, &opd);
break;
case PTP_OPC_DateModified:
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
// Tag with current time if that is supported
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = metadata->item_id;
prop->property = PTP_OPC_DateModified;
prop->datatype = PTP_DTC_STR;
prop->propval.str = get_iso8601_stamp();
}
break;
default:
break;
}
}
ptp_free_objectpropdesc(&opd);
}
// NOTE: File size is not updated, this should not change anyway.
// neither will we change the filename.
ret = ptp_mtp_setobjectproplist(params, props, nrofprops);
ptp_destroy_object_prop_list(props, nrofprops);
if (ret != PTP_RC_OK) {
// TODO: return error of which property we couldn't set
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set object property list.");
free(properties);
return -1;
}
} else if (ptp_operation_issupported(params,PTP_OC_MTP_SetObjectPropValue)) {
for (i=0;i<propcnt;i++) {
PTPObjectPropDesc opd;
ret = ptp_mtp_getobjectpropdesc(params, properties[i], map_libmtp_type_to_ptp_type(metadata->filetype), &opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not get property description.");
} else if (opd.GetSet) {
switch (properties[i]) {
case PTP_OPC_Name:
// Update title
ret = set_object_string(device, metadata->item_id, PTP_OPC_Name, metadata->title);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track title.");
}
break;
case PTP_OPC_AlbumName:
// Update album
ret = set_object_string(device, metadata->item_id, PTP_OPC_AlbumName, metadata->album);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track album name.");
}
break;
case PTP_OPC_Artist:
// Update artist
ret = set_object_string(device, metadata->item_id, PTP_OPC_Artist, metadata->artist);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track artist name.");
}
break;
case PTP_OPC_Composer:
// Update composer
ret = set_object_string(device, metadata->item_id, PTP_OPC_Composer, metadata->composer);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track composer name.");
}
break;
case PTP_OPC_Genre:
// Update genre (but only if valid)
if (metadata->genre) {
ret = set_object_string(device, metadata->item_id, PTP_OPC_Genre, metadata->genre);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set genre.");
}
}
break;
case PTP_OPC_Duration:
// Update duration
if (metadata->duration != 0) {
ret = set_object_u32(device, metadata->item_id, PTP_OPC_Duration, adjust_u32(metadata->duration, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track duration.");
}
}
break;
case PTP_OPC_Track:
// Update track number.
if (metadata->tracknumber != 0) {
ret = set_object_u16(device, metadata->item_id, PTP_OPC_Track, adjust_u16(metadata->tracknumber, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track tracknumber.");
}
}
break;
case PTP_OPC_OriginalReleaseDate:
// Update creation datetime
// The date can be zero, but some devices do not support setting zero
// dates (and it seems that a zero date should never be set anyway)
if (metadata->date) {
ret = set_object_string(device, metadata->item_id, PTP_OPC_OriginalReleaseDate, metadata->date);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set track release date.");
}
}
break;
// These are, well not so important.
case PTP_OPC_SampleRate:
// Update sample rate
if (metadata->samplerate != 0) {
ret = set_object_u32(device, metadata->item_id, PTP_OPC_SampleRate, adjust_u32(metadata->samplerate, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set samplerate.");
}
}
break;
case PTP_OPC_NumberOfChannels:
// Update number of channels
if (metadata->nochannels != 0) {
ret = set_object_u16(device, metadata->item_id, PTP_OPC_NumberOfChannels, adjust_u16(metadata->nochannels, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set number of channels.");
}
}
break;
case PTP_OPC_AudioWAVECodec:
// Update WAVE codec
if (metadata->wavecodec != 0) {
ret = set_object_u32(device, metadata->item_id, PTP_OPC_AudioWAVECodec, adjust_u32(metadata->wavecodec, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set WAVE codec.");
}
}
break;
case PTP_OPC_AudioBitRate:
// Update bitrate
if (metadata->bitrate != 0) {
ret = set_object_u32(device, metadata->item_id, PTP_OPC_AudioBitRate, adjust_u32(metadata->bitrate, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set bitrate.");
}
}
break;
case PTP_OPC_BitRateType:
// Update bitrate type
if (metadata->bitratetype != 0) {
ret = set_object_u16(device, metadata->item_id, PTP_OPC_BitRateType, adjust_u16(metadata->bitratetype, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set bitratetype.");
}
}
break;
case PTP_OPC_Rating:
// Update user rating
// TODO: shall this be set for rating 0?
if (metadata->rating != 0) {
ret = set_object_u16(device, metadata->item_id, PTP_OPC_Rating, adjust_u16(metadata->rating, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set user rating.");
}
}
break;
case PTP_OPC_UseCount:
// Update use count, set even to zero if desired.
ret = set_object_u32(device, metadata->item_id, PTP_OPC_UseCount, adjust_u32(metadata->usecount, &opd));
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set use count.");
}
break;
case PTP_OPC_DateModified:
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
// Update modification time if supported
char *tmpstamp = get_iso8601_stamp();
ret = set_object_string(device, metadata->item_id, PTP_OPC_DateModified, tmpstamp);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"could not set modification date.");
}
free(tmpstamp);
}
break;
// NOTE: File size is not updated, this should not change anyway.
// neither will we change the filename.
default:
break;
}
}
ptp_free_objectpropdesc(&opd);
}
} else {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Update_Track_Metadata(): "
"Your device doesn't seem to support any known way of setting metadata.");
free(properties);
return -1;
}
// update cached object properties if metadata cache exists
update_metadata_cache(device, metadata->item_id);
free(properties);
return 0;
}
/**
* This function deletes a single file, track, playlist, folder or
* any other object off the MTP device, identified by the object ID.
*
* If you delete a folder, there is no guarantee that the device will
* really delete all the files that were in that folder, rather it is
* expected that they will not be deleted, and will turn up in object
* listings with parent set to a non-existant object ID. The safe way
* to do this is to recursively delete all files (and folders) contained
* in the folder, then the folder itself.
*
* @param device a pointer to the device to delete the object from.
* @param object_id the object to delete.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Delete_Object(LIBMTP_mtpdevice_t *device,
uint32_t object_id)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
ret = ptp_deleteobject(params, object_id, 0);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Delete_Object(): could not delete object.");
return -1;
}
return 0;
}
/**
* The function moves an object from one location on a device to another
* location.
*
* The semantics of moving a folder are not defined in the spec, but it
* appears to do the right thing when tested (but devices that implement
* this operation are rare).
*
* Note that moving an object may take a significant amount of time,
* particularly if being moved between storages. MTP does not provide
* any kind of progress mechanism, so the operation will simply block
* for the duration.
*
* @param device a pointer to the device where the object exists.
* @param object_id the object to move.
* @param storage_id the id of the destination storage.
* @param parent_id the id of the destination parent object (folder).
* If the destination is the root of the storage, pass '0'.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Move_Object(LIBMTP_mtpdevice_t *device,
uint32_t object_id,
uint32_t storage_id,
uint32_t parent_id)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
ret = ptp_moveobject(params, object_id, storage_id, parent_id);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Move_Object(): could not move object.");
return -1;
}
return 0;
}
/**
* The function copies an object from one location on a device to another
* location.
*
* The semantics of copying a folder are not defined in the spec, but it
* appears to do the right thing when tested (but devices that implement
* this operation are rare).
*
* Note that copying an object may take a significant amount of time.
* MTP does not provide any kind of progress mechanism, so the operation
* will simply block for the duration.
*
* @param device a pointer to the device where the object exists.
* @param object_id the object to copy.
* @param storage_id the id of the destination storage.
* @param parent_id the id of the destination parent object (folder).
* If the destination is the root of the storage, pass '0'.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Copy_Object(LIBMTP_mtpdevice_t *device,
uint32_t object_id,
uint32_t storage_id,
uint32_t parent_id)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
ret = ptp_copyobject(params, object_id, storage_id, parent_id);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Copy_Object(): could not copy object.");
return -1;
}
return 0;
}
/**
* Internal function to update an object filename property.
*/
static int set_object_filename(LIBMTP_mtpdevice_t *device,
uint32_t object_id, uint16_t ptp_type,
const char **newname_ptr)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
PTPObjectPropDesc opd;
uint16_t ret;
char *newname;
// See if we can modify the filename on this kind of files.
ret = ptp_mtp_getobjectpropdesc(params, PTP_OPC_ObjectFileName, ptp_type, &opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_filename(): "
"could not get property description.");
return -1;
}
if (!opd.GetSet) {
ptp_free_objectpropdesc(&opd);
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_filename(): "
" property is not settable.");
// TODO: we COULD actually upload/download the object here, if we feel
// like wasting time for the user.
return -1;
}
newname = strdup(*newname_ptr);
if (FLAG_ONLY_7BIT_FILENAMES(ptp_usb)) {
strip_7bit_from_utf8(newname);
}
if (ptp_operation_issupported(params, PTP_OC_MTP_SetObjPropList) &&
!FLAG_BROKEN_SET_OBJECT_PROPLIST(ptp_usb)) {
MTPProperties *props = NULL;
MTPProperties *prop = NULL;
int nrofprops = 0;
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = object_id;
prop->property = PTP_OPC_ObjectFileName;
prop->datatype = PTP_DTC_STR;
prop->propval.str = newname;
ret = ptp_mtp_setobjectproplist(params, props, nrofprops);
ptp_destroy_object_prop_list(props, nrofprops);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_filename(): "
" could not set object property list.");
ptp_free_objectpropdesc(&opd);
return -1;
}
} else if (ptp_operation_issupported(params, PTP_OC_MTP_SetObjectPropValue)) {
ret = set_object_string(device, object_id, PTP_OPC_ObjectFileName, newname);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_filename(): "
" could not set object filename.");
ptp_free_objectpropdesc(&opd);
return -1;
}
} else {
free(newname);
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "set_object_filename(): "
" your device doesn't seem to support any known way of setting metadata.");
ptp_free_objectpropdesc(&opd);
return -1;
}
ptp_free_objectpropdesc(&opd);
// update cached object properties if metadata cache exists
update_metadata_cache(device, object_id);
return 0;
}
/**
* This function renames a single file.
* This simply means that the PTP_OPC_ObjectFileName property
* is updated, if this is supported by the device.
*
* @param device a pointer to the device that contains the file.
* @param file the file metadata of the file to rename.
* On success, the filename member is updated. Be aware, that
* this name can be different than newname depending of device restrictions.
* @param newname the new filename for this object.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Set_File_Name(LIBMTP_mtpdevice_t *device,
LIBMTP_file_t *file, const char *newname)
{
int ret;
ret = set_object_filename(device, file->item_id,
map_libmtp_type_to_ptp_type(file->filetype),
&newname);
if (ret != 0) {
return ret;
}
free(file->filename);
file->filename = strdup(newname);
return ret;
}
/**
* This function renames a single folder.
* This simply means that the PTP_OPC_ObjectFileName property
* is updated, if this is supported by the device.
*
* @param device a pointer to the device that contains the file.
* @param folder the folder metadata of the folder to rename.
* On success, the name member is updated. Be aware, that
* this name can be different than newname depending of device restrictions.
* @param newname the new name for this object.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Set_Folder_Name(LIBMTP_mtpdevice_t *device,
LIBMTP_folder_t *folder, const char* newname)
{
int ret;
ret = set_object_filename(device, folder->folder_id,
PTP_OFC_Association,
&newname);
if (ret != 0) {
return ret;
}
free(folder->name);
folder->name = strdup(newname);
return ret;
}
/**
* This function renames a single track.
* This simply means that the PTP_OPC_ObjectFileName property
* is updated, if this is supported by the device.
*
* @param device a pointer to the device that contains the file.
* @param track the track metadata of the track to rename.
* On success, the filename member is updated. Be aware, that
* this name can be different than newname depending of device restrictions.
* @param newname the new filename for this object.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Set_Track_Name(LIBMTP_mtpdevice_t *device,
LIBMTP_track_t *track, const char* newname)
{
int ret;
ret = set_object_filename(device, track->item_id,
map_libmtp_type_to_ptp_type(track->filetype),
&newname);
if (ret != 0) {
return ret;
}
free(track->filename);
track->filename = strdup(newname);
return ret;
}
/**
* This function renames a single playlist object file holder.
* This simply means that the <code>PTP_OPC_ObjectFileName</code>
* property is updated, if this is supported by the device.
* The playlist filename should nominally end with an extension
* like ".pla".
*
* NOTE: if you want to change the metadata the device display
* about a playlist you must <i>not</i> use this function,
* use <code>LIBMTP_Update_Playlist()</code> instead!
*
* @param device a pointer to the device that contains the file.
* @param playlist the playlist metadata of the playlist to rename.
* On success, the name member is updated. Be aware, that
* this name can be different than newname depending of device restrictions.
* @param newname the new name for this object.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Update_Playlist()
*/
int LIBMTP_Set_Playlist_Name(LIBMTP_mtpdevice_t *device,
LIBMTP_playlist_t *playlist, const char* newname)
{
int ret;
ret = set_object_filename(device, playlist->playlist_id,
PTP_OFC_MTP_AbstractAudioVideoPlaylist,
&newname);
if (ret != 0) {
return ret;
}
free(playlist->name);
playlist->name = strdup(newname);
return ret;
}
/**
* This function renames a single album.
* This simply means that the <code>PTP_OPC_ObjectFileName</code>
* property is updated, if this is supported by the device.
* The album filename should nominally end with an extension
* like ".alb".
*
* NOTE: if you want to change the metadata the device display
* about a playlist you must <i>not</i> use this function,
* use <code>LIBMTP_Update_Album()</code> instead!
*
* @param device a pointer to the device that contains the file.
* @param album the album metadata of the album to rename.
* On success, the name member is updated. Be aware, that
* this name can be different than newname depending of device restrictions.
* @param newname the new name for this object.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Update_Album()
*/
int LIBMTP_Set_Album_Name(LIBMTP_mtpdevice_t *device,
LIBMTP_album_t *album, const char* newname)
{
int ret;
ret = set_object_filename(device, album->album_id,
PTP_OFC_MTP_AbstractAudioAlbum,
&newname);
if (ret != 0) {
return ret;
}
free(album->name);
album->name = strdup(newname);
return ret;
}
/**
* THIS FUNCTION IS DEPRECATED. PLEASE UPDATE YOUR CODE IN ORDER
* NOT TO USE IT.
*
* @see LIBMTP_Set_File_Name()
* @see LIBMTP_Set_Track_Name()
* @see LIBMTP_Set_Folder_Name()
* @see LIBMTP_Set_Playlist_Name()
* @see LIBMTP_Set_Album_Name()
*/
int LIBMTP_Set_Object_Filename(LIBMTP_mtpdevice_t *device,
uint32_t object_id, char* newname)
{
int ret;
LIBMTP_file_t *file;
file = LIBMTP_Get_Filemetadata(device, object_id);
if (file == NULL) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Set_Object_Filename(): "
"could not get file metadata for target object.");
return -1;
}
ret = set_object_filename(device, object_id, map_libmtp_type_to_ptp_type(file->filetype), (const char **) &newname);
free(file);
return ret;
}
/**
* Helper function. This indicates if a track exists on the device
* @param device a pointer to the device to get the track from.
* @param id the track ID of the track to retrieve.
* @return TRUE (!=0) if the track exists, FALSE (0) if not
*/
int LIBMTP_Track_Exists(LIBMTP_mtpdevice_t *device,
uint32_t const id)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
PTPObject *ob;
ret = ptp_object_want (params, id, 0, &ob);
if (ret == PTP_RC_OK)
return -1;
return 0;
}
/**
* This creates a new folder structure and allocates memory
* for it. Notice that if you add strings to this structure they
* will be freed by the corresponding <code>LIBMTP_folder_track_t</code>
* operation later, so be careful of using strdup() when assigning
* strings, e.g.:
*
* @return a pointer to the newly allocated folder structure.
* @see LIBMTP_destroy_folder_t()
*/
LIBMTP_folder_t *LIBMTP_new_folder_t(void)
{
LIBMTP_folder_t *new = (LIBMTP_folder_t *) malloc(sizeof(LIBMTP_folder_t));
if (new == NULL) {
return NULL;
}
new->folder_id = 0;
new->parent_id = 0;
new->storage_id = 0;
new->name = NULL;
new->sibling = NULL;
new->child = NULL;
return new;
}
/**
* This recursively deletes the memory for a folder structure.
* This shall typically be called on a top-level folder list to
* detsroy the entire folder tree.
*
* @param folder folder structure to destroy
* @see LIBMTP_new_folder_t()
*/
void LIBMTP_destroy_folder_t(LIBMTP_folder_t *folder)
{
if(folder == NULL) {
return;
}
//Destroy from the bottom up
if(folder->child != NULL) {
LIBMTP_destroy_folder_t(folder->child);
}
if(folder->sibling != NULL) {
LIBMTP_destroy_folder_t(folder->sibling);
}
if(folder->name != NULL) {
free(folder->name);
}
free(folder);
}
/**
* Helper function. Returns a folder structure for a
* specified id.
*
* @param folderlist list of folders to search
* @id id of folder to look for
* @return a folder or NULL if not found
*/
LIBMTP_folder_t *LIBMTP_Find_Folder(LIBMTP_folder_t *folderlist, uint32_t id)
{
LIBMTP_folder_t *ret = NULL;
if(folderlist == NULL) {
return NULL;
}
if(folderlist->folder_id == id) {
return folderlist;
}
if(folderlist->sibling) {
ret = LIBMTP_Find_Folder(folderlist->sibling, id);
}
if(folderlist->child && ret == NULL) {
ret = LIBMTP_Find_Folder(folderlist->child, id);
}
return ret;
}
/**
* Function used to recursively get subfolders from params.
*/
static LIBMTP_folder_t *get_subfolders_for_folder(LIBMTP_folder_t *list, uint32_t parent)
{
LIBMTP_folder_t *retfolders = NULL;
LIBMTP_folder_t *children, *iter, *curr;
iter = list->sibling;
while(iter != list) {
if (iter->parent_id != parent) {
iter = iter->sibling;
continue;
}
/* We know that iter is a child of 'parent', therefore we can safely
* hold on to 'iter' locally since no one else will steal it
* from the 'list' as we recurse. */
children = get_subfolders_for_folder(list, iter->folder_id);
curr = iter;
iter = iter->sibling;
// Remove curr from the list.
curr->child->sibling = curr->sibling;
curr->sibling->child = curr->child;
// Attach the children to curr.
curr->child = children;
// Put this folder into the list of siblings.
curr->sibling = retfolders;
retfolders = curr;
}
return retfolders;
}
/**
* This returns a list of all folders available
* on the current MTP device.
*
* @param device a pointer to the device to get the folder listing for.
* @param storage a storage ID to get the folder list from
* @return a list of folders
*/
LIBMTP_folder_t *LIBMTP_Get_Folder_List_For_Storage(LIBMTP_mtpdevice_t *device,
uint32_t const storage)
{
PTPParams *params = (PTPParams *) device->params;
LIBMTP_folder_t head, *rv;
unsigned int i;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0) {
flush_handles(device);
}
/*
* This creates a temporary list of the folders, this is in a
* reverse order and uses the Folder pointers that are already
* in the Folder structure. From this we can then build up the
* folder hierarchy with only looking at this temporary list,
* and removing the folders from this temporary list as we go.
* This significantly reduces the number of operations that we
* have to do in building the folder hierarchy. Also since the
* temp list is in reverse order, when we prepend to the sibling
* list things are in the same order as they were originally
* in the handle list.
*/
head.sibling = &head;
head.child = &head;
for (i = 0; i < params->nrofobjects; i++) {
LIBMTP_folder_t *folder;
PTPObject *ob;
ob = ¶ms->objects[i];
if (ob->oi.ObjectFormat != PTP_OFC_Association) {
continue;
}
if (storage != PTP_GOH_ALL_STORAGE && storage != ob->oi.StorageID) {
continue;
}
/*
* Do we know how to handle these? They are part
* of the MTP 1.0 specification paragraph 3.6.4.
* For AssociationDesc 0x00000001U ptp_mtp_getobjectreferences()
* should be called on these to get the contained objects, but
* we basically don't care. Hopefully parent_id is maintained for all
* children, because we rely on that instead.
*/
if (ob->oi.AssociationDesc != 0x00000000U) {
LIBMTP_INFO("MTP extended association type 0x%08x encountered\n", ob->oi.AssociationDesc);
}
// Create a folder struct...
folder = LIBMTP_new_folder_t();
if (folder == NULL) {
// malloc failure or so.
return NULL;
}
folder->folder_id = ob->oid;
folder->parent_id = ob->oi.ParentObject;
folder->storage_id = ob->oi.StorageID;
folder->name = (ob->oi.Filename) ? (char *)strdup(ob->oi.Filename) : NULL;
// pretend sibling says next, and child says prev.
folder->sibling = head.sibling;
folder->child = &head;
head.sibling->child = folder;
head.sibling = folder;
}
// We begin at the given root folder and get them all recursively
rv = get_subfolders_for_folder(&head, 0x00000000U);
// Some buggy devices may have some files in the "root folder"
// 0xffffffff so if 0x00000000 didn't return any folders,
// look for children of the root 0xffffffffU
if (rv == NULL) {
rv = get_subfolders_for_folder(&head, 0xffffffffU);
if (rv != NULL)
LIBMTP_ERROR("Device have files in \"root folder\" 0xffffffffU - "
"this is a firmware bug (but continuing)\n");
}
// The temp list should be empty. Clean up any orphans just in case.
while(head.sibling != &head) {
LIBMTP_folder_t *curr = head.sibling;
LIBMTP_INFO("Orphan folder with ID: 0x%08x name: \"%s\" encountered.\n",
curr->folder_id,
curr->name);
curr->sibling->child = curr->child;
curr->child->sibling = curr->sibling;
curr->child = NULL;
curr->sibling = NULL;
LIBMTP_destroy_folder_t(curr);
}
return rv;
}
/**
* This returns a list of all folders available
* on the current MTP device.
*
* @param device a pointer to the device to get the folder listing for.
* @return a list of folders
*/
LIBMTP_folder_t *LIBMTP_Get_Folder_List(LIBMTP_mtpdevice_t *device)
{
return LIBMTP_Get_Folder_List_For_Storage(device, PTP_GOH_ALL_STORAGE);
}
/**
* This create a folder on the current MTP device. The PTP name
* for a folder is "association". The PTP/MTP devices does not
* have an internal "folder" concept really, it contains a flat
* list of all files and some file are "associations" that other
* files and folders may refer to as its "parent".
*
* @param device a pointer to the device to create the folder on.
* @param name the name of the new folder. Note this can be modified
* if the device does not support all the characters in the
* name.
* @param parent_id id of parent folder to add the new folder to,
* or 0xFFFFFFFF to put it in the root directory.
* @param storage_id id of the storage to add this new folder to.
* notice that you cannot mismatch storage id and parent id:
* they must both be on the same storage! Pass in 0 if you
* want to create this folder on the default storage.
* @return id to new folder or 0 if an error occurred
*/
uint32_t LIBMTP_Create_Folder(LIBMTP_mtpdevice_t *device, char *name,
uint32_t parent_id, uint32_t storage_id)
{
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
uint32_t parenthandle = 0;
uint32_t store;
PTPObjectInfo new_folder;
uint16_t ret;
uint32_t new_id = 0;
if (storage_id == 0) {
// I'm just guessing that a folder may require 512 bytes
store = get_suggested_storage_id(device, 512, parent_id);
} else {
store = storage_id;
}
parenthandle = parent_id;
memset(&new_folder, 0, sizeof(new_folder));
new_folder.Filename = name;
if (FLAG_ONLY_7BIT_FILENAMES(ptp_usb)) {
strip_7bit_from_utf8(new_folder.Filename);
}
new_folder.ObjectCompressedSize = 0;
new_folder.ObjectFormat = PTP_OFC_Association;
new_folder.ProtectionStatus = PTP_PS_NoProtection;
new_folder.AssociationType = PTP_AT_GenericFolder;
new_folder.ParentObject = parent_id;
new_folder.StorageID = store;
// Create the object
if (!(params->device_flags & DEVICE_FLAG_BROKEN_SEND_OBJECT_PROPLIST) &&
ptp_operation_issupported(params,PTP_OC_MTP_SendObjectPropList)) {
MTPProperties *props = (MTPProperties*)calloc(2,sizeof(MTPProperties));
props[0].property = PTP_OPC_ObjectFileName;
props[0].datatype = PTP_DTC_STR;
props[0].propval.str = name;
props[1].property = PTP_OPC_Name;
props[1].datatype = PTP_DTC_STR;
props[1].propval.str = name;
ret = ptp_mtp_sendobjectproplist(params, &store, &parenthandle, &new_id, PTP_OFC_Association,
0, props, 1);
free(props);
} else {
ret = ptp_sendobjectinfo(params, &store, &parenthandle, &new_id, &new_folder);
}
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Create_Folder: Could not send object info.");
if (ret == PTP_RC_AccessDenied) {
add_ptp_error_to_errorstack(device, ret, "ACCESS DENIED.");
}
return 0;
}
// NOTE: don't destroy the new_folder objectinfo, because it is statically referencing
// several strings.
add_object_to_cache(device, new_id);
return new_id;
}
/**
* This creates a new playlist metadata structure and allocates memory
* for it. Notice that if you add strings to this structure they
* will be freed by the corresponding <code>LIBMTP_destroy_playlist_t</code>
* operation later, so be careful of using strdup() when assigning
* strings, e.g.:
*
* <pre>
* LIBMTP_playlist_t *pl = LIBMTP_new_playlist_t();
* pl->name = strdup(str);
* ....
* LIBMTP_destroy_playlist_t(pl);
* </pre>
*
* @return a pointer to the newly allocated metadata structure.
* @see LIBMTP_destroy_playlist_t()
*/
LIBMTP_playlist_t *LIBMTP_new_playlist_t(void)
{
LIBMTP_playlist_t *new = (LIBMTP_playlist_t *) malloc(sizeof(LIBMTP_playlist_t));
if (new == NULL) {
return NULL;
}
new->playlist_id = 0;
new->parent_id = 0;
new->storage_id = 0;
new->name = NULL;
new->tracks = NULL;
new->no_tracks = 0;
new->next = NULL;
return new;
}
/**
* This destroys a playlist metadata structure and deallocates the memory
* used by it, including any strings. Never use a track metadata
* structure again after calling this function on it.
* @param playlist the playlist metadata to destroy.
* @see LIBMTP_new_playlist_t()
*/
void LIBMTP_destroy_playlist_t(LIBMTP_playlist_t *playlist)
{
if (playlist == NULL) {
return;
}
if (playlist->name != NULL)
free(playlist->name);
if (playlist->tracks != NULL)
free(playlist->tracks);
free(playlist);
return;
}
/**
* This function returns a list of the playlists available on the
* device. Typical usage:
*
* <pre>
* </pre>
*
* @param device a pointer to the device to get the playlist listing from.
* @return a playlist list on success, else NULL. If there are no playlists
* on the device, NULL will be returned as well.
* @see LIBMTP_Get_Playlist()
*/
LIBMTP_playlist_t *LIBMTP_Get_Playlist_List(LIBMTP_mtpdevice_t *device)
{
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
const int REQ_SPL = FLAG_PLAYLIST_SPL(ptp_usb);
PTPParams *params = (PTPParams *) device->params;
LIBMTP_playlist_t *retlists = NULL;
LIBMTP_playlist_t *curlist = NULL;
uint32_t i;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0) {
flush_handles(device);
}
for (i = 0; i < params->nrofobjects; i++) {
LIBMTP_playlist_t *pl;
PTPObject *ob;
uint16_t ret;
ob = ¶ms->objects[i];
// Ignore stuff that isn't playlists
// For Samsung players we must look for the .spl extension explicitly since
// playlists are not stored as playlist objects.
if ( REQ_SPL && is_spl_playlist(&ob->oi) ) {
// Allocate a new playlist type
pl = LIBMTP_new_playlist_t();
spl_to_playlist_t(device, &ob->oi, ob->oid, pl);
}
else if ( ob->oi.ObjectFormat != PTP_OFC_MTP_AbstractAudioVideoPlaylist ) {
continue;
}
else {
// Allocate a new playlist type
pl = LIBMTP_new_playlist_t();
// Try to look up proper name, else use the oi->Filename field.
pl->name = get_string_from_object(device, ob->oid, PTP_OPC_Name);
if (pl->name == NULL) {
pl->name = strdup(ob->oi.Filename);
}
pl->playlist_id = ob->oid;
pl->parent_id = ob->oi.ParentObject;
pl->storage_id = ob->oi.StorageID;
// Then get the track listing for this playlist
ret = ptp_mtp_getobjectreferences(params, pl->playlist_id, &pl->tracks, &pl->no_tracks);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Playlist_List(): "
"could not get object references.");
pl->tracks = NULL;
pl->no_tracks = 0;
}
}
// Add playlist to a list that will be returned afterwards.
if (retlists == NULL) {
retlists = pl;
curlist = pl;
} else {
curlist->next = pl;
curlist = pl;
}
// Call callback here if we decide to add that possibility...
}
return retlists;
}
/**
* This function retrieves an individual playlist from the device.
* @param device a pointer to the device to get the playlist from.
* @param plid the unique ID of the playlist to retrieve.
* @return a valid playlist metadata post or NULL on failure.
* @see LIBMTP_Get_Playlist_List()
*/
LIBMTP_playlist_t *LIBMTP_Get_Playlist(LIBMTP_mtpdevice_t *device, uint32_t const plid)
{
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
const int REQ_SPL = FLAG_PLAYLIST_SPL(ptp_usb);
PTPParams *params = (PTPParams *) device->params;
PTPObject *ob;
LIBMTP_playlist_t *pl;
uint16_t ret;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0) {
flush_handles(device);
}
ret = ptp_object_want (params, plid, PTPOBJECT_OBJECTINFO_LOADED, &ob);
if (ret != PTP_RC_OK)
return NULL;
// For Samsung players we must look for the .spl extension explicitly since
// playlists are not stored as playlist objects.
if ( REQ_SPL && is_spl_playlist(&ob->oi) ) {
// Allocate a new playlist type
pl = LIBMTP_new_playlist_t();
spl_to_playlist_t(device, &ob->oi, ob->oid, pl);
return pl;
}
// Ignore stuff that isn't playlists
else if ( ob->oi.ObjectFormat != PTP_OFC_MTP_AbstractAudioVideoPlaylist ) {
return NULL;
}
// Allocate a new playlist type
pl = LIBMTP_new_playlist_t();
pl->name = get_string_from_object(device, ob->oid, PTP_OPC_Name);
if (pl->name == NULL) {
pl->name = strdup(ob->oi.Filename);
}
pl->playlist_id = ob->oid;
pl->parent_id = ob->oi.ParentObject;
pl->storage_id = ob->oi.StorageID;
// Then get the track listing for this playlist
ret = ptp_mtp_getobjectreferences(params, pl->playlist_id, &pl->tracks, &pl->no_tracks);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Playlist(): Could not get object references.");
pl->tracks = NULL;
pl->no_tracks = 0;
}
return pl;
}
/**
* This function creates a new abstract list such as a playlist
* or an album.
*
* @param device a pointer to the device to create the new abstract list
* on.
* @param name the name of the new abstract list.
* @param artist the artist of the new abstract list or NULL.
* @param genre the genre of the new abstract list or NULL.
* @param parenthandle the handle of the parent or 0 for no parent
* i.e. the root folder.
* @param objectformat the abstract list type to create.
* @param suffix the ".foo" (4 characters) suffix to use for the virtual
* "file" created by this operation.
* @param newid a pointer to a variable that will hold the new object
* ID if this call is successful.
* @param tracks an array of tracks to associate with this list.
* @param no_tracks the number of tracks in the list.
* @return 0 on success, any other value means failure.
*/
static int create_new_abstract_list(LIBMTP_mtpdevice_t *device,
char const * const name,
char const * const artist,
char const * const composer,
char const * const genre,
uint32_t const parenthandle,
uint32_t const storageid,
uint16_t const objectformat,
char const * const suffix,
uint32_t * const newid,
uint32_t const * const tracks,
uint32_t const no_tracks)
{
unsigned int i;
int supported = 0;
uint16_t ret;
uint16_t *properties = NULL;
uint32_t propcnt = 0;
uint32_t store;
uint32_t localph = parenthandle;
uint8_t nonconsumable = 0x00U; /* By default it is consumable */
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
char fname[256];
//uint8_t data[2];
// NULL check
if (!name) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): list name was NULL, using default name \"Unknown\"");
return -1;
}
if (storageid == 0) {
// I'm just guessing that an abstract list may require 512 bytes
store = get_suggested_storage_id(device, 512, localph);
} else {
store = storageid;
}
// Check if we can create an object of this type
for ( i=0; i < params->deviceinfo.ImageFormats_len; i++ ) {
if (params->deviceinfo.ImageFormats[i] == objectformat) {
supported = 1;
break;
}
}
if (!supported) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): player does not support this abstract type");
LIBMTP_ERROR("Unsupported abstract list type: %04x\n", objectformat);
return -1;
}
// add the new suffix if it isn't there
fname[0] = '\0';
if (strlen(name) > strlen(suffix)) {
char const * const suff = &name[strlen(name)-strlen(suffix)];
if (!strcmp(suff, suffix)) {
// Home free.
strncpy(fname, name, sizeof(fname));
}
}
// If it didn't end with "<suffix>" then add that here.
if (fname[0] == '\0') {
strncpy(fname, name, sizeof(fname)-strlen(suffix)-1);
strcat(fname, suffix);
fname[sizeof(fname)-1] = '\0';
}
if (ptp_operation_issupported(params, PTP_OC_MTP_SendObjectPropList) &&
!FLAG_BROKEN_SEND_OBJECT_PROPLIST(ptp_usb)) {
MTPProperties *props = NULL;
MTPProperties *prop = NULL;
int nrofprops = 0;
*newid = 0x00000000U;
ret = ptp_mtp_getobjectpropssupported(params, objectformat, &propcnt, &properties);
for (i=0;i<propcnt;i++) {
PTPObjectPropDesc opd;
ret = ptp_mtp_getobjectpropdesc(params, properties[i], objectformat, &opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): "
"could not get property description.");
} else if (opd.GetSet) {
switch (properties[i]) {
case PTP_OPC_ObjectFileName:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_ObjectFileName;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(fname);
if (FLAG_ONLY_7BIT_FILENAMES(ptp_usb)) {
strip_7bit_from_utf8(prop->propval.str);
}
break;
case PTP_OPC_ProtectionStatus:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_ProtectionStatus;
prop->datatype = PTP_DTC_UINT16;
prop->propval.u16 = 0x0000U; /* Not protected */
break;
case PTP_OPC_NonConsumable:
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_NonConsumable;
prop->datatype = PTP_DTC_UINT8;
prop->propval.u8 = nonconsumable;
break;
case PTP_OPC_Name:
if (name != NULL) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_Name;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(name);
}
break;
case PTP_OPC_AlbumArtist:
if (artist != NULL) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_AlbumArtist;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(artist);
}
break;
case PTP_OPC_Artist:
if (artist != NULL) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_Artist;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(artist);
}
break;
case PTP_OPC_Composer:
if (composer != NULL) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_Composer;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(composer);
}
break;
case PTP_OPC_Genre:
if (genre != NULL) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_Genre;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(genre);
}
break;
case PTP_OPC_DateModified:
// Tag with current time if that is supported
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
prop = ptp_get_new_object_prop_entry(&props,&nrofprops);
prop->ObjectHandle = *newid;
prop->property = PTP_OPC_DateModified;
prop->datatype = PTP_DTC_STR;
prop->propval.str = get_iso8601_stamp();
}
break;
}
}
ptp_free_objectpropdesc(&opd);
}
free(properties);
ret = ptp_mtp_sendobjectproplist(params, &store, &localph, newid,
objectformat, 0, props, nrofprops);
/* Free property list */
ptp_destroy_object_prop_list(props, nrofprops);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "create_new_abstract_list(): Could not send object property list.");
if (ret == PTP_RC_AccessDenied) {
add_ptp_error_to_errorstack(device, ret, "ACCESS DENIED.");
}
return -1;
}
// now send the blank object
ret = ptp_sendobject(params, NULL, 0);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "create_new_abstract_list(): Could not send blank object data.");
return -1;
}
} else if (ptp_operation_issupported(params,PTP_OC_SendObjectInfo)) {
PTPObjectInfo new_object;
new_object.Filename = fname;
if (FLAG_ONLY_7BIT_FILENAMES(ptp_usb)) {
strip_7bit_from_utf8(new_object.Filename);
}
// At one point this had to be one
new_object.ObjectCompressedSize = 0;
new_object.ObjectFormat = objectformat;
// Create the object
ret = ptp_sendobjectinfo(params, &store, &localph, newid, &new_object);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "create_new_abstract_list(): Could not send object info (the playlist itself).");
if (ret == PTP_RC_AccessDenied) {
add_ptp_error_to_errorstack(device, ret, "ACCESS DENIED.");
}
return -1;
}
// NOTE: don't destroy new_object objectinfo afterwards - the strings it contains are
// not copies.
#if 0
/*
* At one time we had to send this one blank data byte.
* If we didn't, the handle will not be created and thus there is
* no playlist. Possibly this was masking some bug, so removing it
* now.
*/
data[0] = '\0';
data[1] = '\0';
ret = ptp_sendobject(params, data, 1);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "create_new_abstract_list(): Could not send blank object data.");
return -1;
}
#endif
// set the properties one by one
ret = ptp_mtp_getobjectpropssupported(params, objectformat, &propcnt, &properties);
for (i=0;i<propcnt;i++) {
PTPObjectPropDesc opd;
ret = ptp_mtp_getobjectpropdesc(params, properties[i], objectformat, &opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): "
"could not get property description.");
} else if (opd.GetSet) {
switch (properties[i]) {
case PTP_OPC_Name:
if (name != NULL) {
ret = set_object_string(device, *newid, PTP_OPC_Name, name);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): could not set entity name.");
return -1;
}
}
break;
case PTP_OPC_AlbumArtist:
if (artist != NULL) {
ret = set_object_string(device, *newid, PTP_OPC_AlbumArtist, artist);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): could not set entity album artist.");
return -1;
}
}
break;
case PTP_OPC_Artist:
if (artist != NULL) {
ret = set_object_string(device, *newid, PTP_OPC_Artist, artist);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): could not set entity artist.");
return -1;
}
}
break;
case PTP_OPC_Composer:
if (composer != NULL) {
ret = set_object_string(device, *newid, PTP_OPC_Composer, composer);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): could not set entity composer.");
return -1;
}
}
break;
case PTP_OPC_Genre:
if (genre != NULL) {
ret = set_object_string(device, *newid, PTP_OPC_Genre, genre);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): could not set entity genre.");
return -1;
}
}
break;
case PTP_OPC_DateModified:
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
ret = set_object_string(device, *newid, PTP_OPC_DateModified, get_iso8601_stamp());
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "create_new_abstract_list(): could not set date modified.");
return -1;
}
}
break;
}
}
ptp_free_objectpropdesc(&opd);
}
free(properties);
}
if (no_tracks > 0) {
// Add tracks to the list as object references.
ret = ptp_mtp_setobjectreferences (params, *newid, (uint32_t *) tracks, no_tracks);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "create_new_abstract_list(): could not add tracks as object references.");
return -1;
}
}
add_object_to_cache(device, *newid);
return 0;
}
/**
* This updates the metadata and track listing
* for an abstract list.
* @param device a pointer to the device that the abstract list
* resides on.
* @param name the name of the abstract list.
* @param artist the artist of the abstract list or NULL.
* @param genre the genre of the abstract list or NULL.
* @param objecthandle the object to be updated.
* @param objectformat the abstract list type to update.
* @param tracks an array of tracks to associate with this list.
* @param no_tracks the number of tracks in the list.
* @return 0 on success, any other value means failure.
*/
static int update_abstract_list(LIBMTP_mtpdevice_t *device,
char const * const name,
char const * const artist,
char const * const composer,
char const * const genre,
uint32_t const objecthandle,
uint16_t const objectformat,
uint32_t const * const tracks,
uint32_t const no_tracks)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
uint16_t *properties = NULL;
uint32_t propcnt = 0;
unsigned int i;
// First see which properties can be set
// i.e only try to update this metadata for object tags that exist on the current player.
ret = ptp_mtp_getobjectpropssupported(params, objectformat, &propcnt, &properties);
if (ret != PTP_RC_OK) {
// Just bail out for now, nothing is ever set.
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not retrieve supported object properties.");
return -1;
}
if (ptp_operation_issupported(params,PTP_OC_MTP_SetObjPropList) &&
!FLAG_BROKEN_SET_OBJECT_PROPLIST(ptp_usb)) {
MTPProperties *props = NULL;
MTPProperties *prop = NULL;
int nrofprops = 0;
for (i=0;i<propcnt;i++) {
PTPObjectPropDesc opd;
ret = ptp_mtp_getobjectpropdesc(params, properties[i], objectformat, &opd);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not get property description.");
} else if (opd.GetSet) {
switch (properties[i]) {
case PTP_OPC_Name:
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = objecthandle;
prop->property = PTP_OPC_Name;
prop->datatype = PTP_DTC_STR;
if (name != NULL)
prop->propval.str = strdup(name);
break;
case PTP_OPC_AlbumArtist:
if (artist != NULL) {
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = objecthandle;
prop->property = PTP_OPC_AlbumArtist;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(artist);
}
break;
case PTP_OPC_Artist:
if (artist != NULL) {
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = objecthandle;
prop->property = PTP_OPC_Artist;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(artist);
}
break;
case PTP_OPC_Composer:
if (composer != NULL) {
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = objecthandle;
prop->property = PTP_OPC_Composer;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(composer);
}
break;
case PTP_OPC_Genre:
if (genre != NULL) {
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = objecthandle;
prop->property = PTP_OPC_Genre;
prop->datatype = PTP_DTC_STR;
prop->propval.str = strdup(genre);
}
break;
case PTP_OPC_DateModified:
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
// Tag with current time if that is supported
prop = ptp_get_new_object_prop_entry(&props, &nrofprops);
prop->ObjectHandle = objecthandle;
prop->property = PTP_OPC_DateModified;
prop->datatype = PTP_DTC_STR;
prop->propval.str = get_iso8601_stamp();
}
break;
default:
break;
}
}
ptp_free_objectpropdesc(&opd);
}
// proplist could be NULL if we can't write any properties
if (props != NULL) {
ret = ptp_mtp_setobjectproplist(params, props, nrofprops);
ptp_destroy_object_prop_list(props, nrofprops);
if (ret != PTP_RC_OK) {
// TODO: return error of which property we couldn't set
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set object property list.");
free(properties);
return -1;
}
}
} else if (ptp_operation_issupported(params,PTP_OC_MTP_SetObjectPropValue)) {
for (i=0;i<propcnt;i++) {
switch (properties[i]) {
case PTP_OPC_Name:
// Update title
ret = set_object_string(device, objecthandle, PTP_OPC_Name, name);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set title.");
}
break;
case PTP_OPC_AlbumArtist:
// Update album artist
ret = set_object_string(device, objecthandle, PTP_OPC_AlbumArtist, artist);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set album artist name.");
}
break;
case PTP_OPC_Artist:
// Update artist
ret = set_object_string(device, objecthandle, PTP_OPC_Artist, artist);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set artist name.");
}
break;
case PTP_OPC_Composer:
// Update composer
ret = set_object_string(device, objecthandle, PTP_OPC_Composer, composer);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set composer name.");
}
break;
case PTP_OPC_Genre:
// Update genre (but only if valid)
if(genre) {
ret = set_object_string(device, objecthandle, PTP_OPC_Genre, genre);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set genre.");
}
}
break;
case PTP_OPC_DateModified:
// Update date modified
if (!FLAG_CANNOT_HANDLE_DATEMODIFIED(ptp_usb)) {
char *tmpdate = get_iso8601_stamp();
ret = set_object_string(device, objecthandle, PTP_OPC_DateModified, tmpdate);
if (ret != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"could not set modification date.");
}
free(tmpdate);
}
break;
default:
break;
}
}
} else {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "update_abstract_list(): "
"Your device doesn't seem to support any known way of setting metadata.");
free(properties);
return -1;
}
// Then the object references...
ret = ptp_mtp_setobjectreferences (params, objecthandle, (uint32_t *) tracks, no_tracks);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "update_abstract_list(): could not add tracks as object references.");
free(properties);
return -1;
}
free(properties);
update_metadata_cache(device, objecthandle);
return 0;
}
/**
* This routine creates a new playlist based on the metadata
* supplied. If the <code>tracks</code> field of the metadata
* contains a track listing, these tracks will be added to the
* playlist.
* @param device a pointer to the device to create the new playlist on.
* @param metadata the metadata for the new playlist. If the function
* exits with success, the <code>playlist_id</code> field of this
* struct will contain the new playlist ID of the playlist.
* <ul>
* <li><code>metadata->parent_id</code> should be set to the parent
* (e.g. folder) to store this track in. Since some
* devices are a bit picky about where files
* are placed, a default folder will be chosen if libmtp
* has detected one for the current filetype and this
* parameter is set to 0. If this is 0 and no default folder
* can be found, the file will be stored in the root folder.
* <li><code>metadata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this track in. Setting this to 0 will store
* the track on the primary storage.
* </ul>
* @return 0 on success, any other value means failure.
* @see LIBMTP_Update_Playlist()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Create_New_Playlist(LIBMTP_mtpdevice_t *device,
LIBMTP_playlist_t * const metadata)
{
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
uint32_t localph = metadata->parent_id;
// Use a default folder if none given
if (localph == 0) {
if (device->default_playlist_folder != 0)
localph = device->default_playlist_folder;
else
localph = device->default_music_folder;
}
metadata->parent_id = localph;
// Samsung needs its own special type of playlists
if(FLAG_PLAYLIST_SPL(ptp_usb)) {
return playlist_t_to_spl(device, metadata);
}
// Just create a new abstract audio/video playlist...
return create_new_abstract_list(device,
metadata->name,
NULL,
NULL,
NULL,
localph,
metadata->storage_id,
PTP_OFC_MTP_AbstractAudioVideoPlaylist,
get_playlist_extension(ptp_usb),
&metadata->playlist_id,
metadata->tracks,
metadata->no_tracks);
}
/**
* This routine updates a playlist based on the metadata
* supplied. If the <code>tracks</code> field of the metadata
* contains a track listing, these tracks will be added to the
* playlist in place of those already present, i.e. the
* previous track listing will be deleted. For Samsung devices the
* playlist id (metadata->playlist_id) is likely to change.
* @param device a pointer to the device to create the new playlist on.
* @param metadata the metadata for the playlist to be updated.
* notice that the field <code>playlist_id</code>
* must contain the appropriate playlist ID. Playlist ID
* be modified to a new playlist ID by the time the
* function returns since edit-in-place is not always possible.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Create_New_Playlist()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Update_Playlist(LIBMTP_mtpdevice_t *device,
LIBMTP_playlist_t * const metadata)
{
// Samsung needs its own special type of playlists
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
if(FLAG_PLAYLIST_SPL(ptp_usb)) {
return update_spl_playlist(device, metadata);
}
return update_abstract_list(device,
metadata->name,
NULL,
NULL,
NULL,
metadata->playlist_id,
PTP_OFC_MTP_AbstractAudioVideoPlaylist,
metadata->tracks,
metadata->no_tracks);
}
/**
* This creates a new album metadata structure and allocates memory
* for it. Notice that if you add strings to this structure they
* will be freed by the corresponding <code>LIBMTP_destroy_album_t</code>
* operation later, so be careful of using strdup() when assigning
* strings.
*
* @return a pointer to the newly allocated metadata structure.
* @see LIBMTP_destroy_album_t()
*/
LIBMTP_album_t *LIBMTP_new_album_t(void)
{
LIBMTP_album_t *new = (LIBMTP_album_t *) malloc(sizeof(LIBMTP_album_t));
if (new == NULL) {
return NULL;
}
new->album_id = 0;
new->parent_id = 0;
new->storage_id = 0;
new->name = NULL;
new->artist = NULL;
new->composer = NULL;
new->genre = NULL;
new->tracks = NULL;
new->no_tracks = 0;
new->next = NULL;
return new;
}
/**
* This recursively deletes the memory for an album structure
*
* @param album structure to destroy
* @see LIBMTP_new_album_t()
*/
void LIBMTP_destroy_album_t(LIBMTP_album_t *album)
{
if (album == NULL) {
return;
}
if (album->name != NULL)
free(album->name);
if (album->artist != NULL)
free(album->artist);
if (album->composer != NULL)
free(album->composer);
if (album->genre != NULL)
free(album->genre);
if (album->tracks != NULL)
free(album->tracks);
free(album);
return;
}
/**
* This function maps and copies a property onto the album metadata if applicable.
*/
static void pick_property_to_album_metadata(LIBMTP_mtpdevice_t *device,
MTPProperties *prop, LIBMTP_album_t *alb)
{
switch (prop->property) {
case PTP_OPC_Name:
if (prop->propval.str != NULL)
alb->name = strdup(prop->propval.str);
else
alb->name = NULL;
break;
case PTP_OPC_AlbumArtist:
if (prop->propval.str != NULL) {
// This should take precedence over plain "Artist"
if (alb->artist != NULL)
free(alb->artist);
alb->artist = strdup(prop->propval.str);
} else
alb->artist = NULL;
break;
case PTP_OPC_Artist:
if (prop->propval.str != NULL) {
// Only use of AlbumArtist is not set
if (alb->artist == NULL)
alb->artist = strdup(prop->propval.str);
} else
alb->artist = NULL;
break;
case PTP_OPC_Composer:
if (prop->propval.str != NULL)
alb->composer = strdup(prop->propval.str);
else
alb->composer = NULL;
break;
case PTP_OPC_Genre:
if (prop->propval.str != NULL)
alb->genre = strdup(prop->propval.str);
else
alb->genre = NULL;
break;
}
}
/**
* This function retrieves the album metadata for an album
* given by a unique ID.
* @param device a pointer to the device to get the track metadata off.
* @param alb an album metadata metadata set to fill in.
*/
static void get_album_metadata(LIBMTP_mtpdevice_t *device,
LIBMTP_album_t *alb)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
uint32_t i;
MTPProperties *prop;
PTPObject *ob;
/*
* If we have a cached, large set of metadata, then use it!
*/
ret = ptp_object_want(params, alb->album_id, PTPOBJECT_MTPPROPLIST_LOADED, &ob);
if (ob->mtpprops) {
prop = ob->mtpprops;
for (i=0;i<ob->nrofmtpprops;i++,prop++)
pick_property_to_album_metadata(device, prop, alb);
} else {
uint16_t *props = NULL;
uint32_t propcnt = 0;
// First see which properties can be retrieved for albums
ret = ptp_mtp_getobjectpropssupported(params, PTP_OFC_MTP_AbstractAudioAlbum, &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "get_album_metadata(): call to ptp_mtp_getobjectpropssupported() failed.");
// Just bail out for now, nothing is ever set.
return;
} else {
for (i=0;i<propcnt;i++) {
switch (props[i]) {
case PTP_OPC_Name:
alb->name = get_string_from_object(device, ob->oid, PTP_OPC_Name);
break;
case PTP_OPC_AlbumArtist:
if (alb->artist != NULL)
free(alb->artist);
alb->artist = get_string_from_object(device, ob->oid, PTP_OPC_AlbumArtist);
break;
case PTP_OPC_Artist:
if (alb->artist == NULL)
alb->artist = get_string_from_object(device, ob->oid, PTP_OPC_Artist);
break;
case PTP_OPC_Composer:
alb->composer = get_string_from_object(device, ob->oid, PTP_OPC_Composer);
break;
case PTP_OPC_Genre:
alb->genre = get_string_from_object(device, ob->oid, PTP_OPC_Genre);
break;
default:
break;
}
}
free(props);
}
}
}
/**
* This function returns a list of the albums available on the
* device.
*
* @param device a pointer to the device to get the album listing from.
* @return an album list on success, else NULL. If there are no albums
* on the device, NULL will be returned as well.
* @see LIBMTP_Get_Album()
*/
LIBMTP_album_t *LIBMTP_Get_Album_List(LIBMTP_mtpdevice_t *device)
{
// Read all storage devices
return LIBMTP_Get_Album_List_For_Storage(device, 0);
}
/**
* This function returns a list of the albums available on the
* device. You can filter on the storage ID.
*
* @param device a pointer to the device to get the album listing from.
* @param storage_id ID of device storage (if null, all storages)
*
* @return an album list on success, else NULL. If there are no albums
* on the device, NULL will be returned as well.
* @see LIBMTP_Get_Album()
*/
LIBMTP_album_t *LIBMTP_Get_Album_List_For_Storage(LIBMTP_mtpdevice_t *device, uint32_t const storage_id)
{
PTPParams *params = (PTPParams *) device->params;
LIBMTP_album_t *retalbums = NULL;
LIBMTP_album_t *curalbum = NULL;
uint32_t i;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0)
flush_handles(device);
for (i = 0; i < params->nrofobjects; i++) {
LIBMTP_album_t *alb;
PTPObject *ob;
uint16_t ret;
ob = ¶ms->objects[i];
// Ignore stuff that isn't an album
if ( ob->oi.ObjectFormat != PTP_OFC_MTP_AbstractAudioAlbum )
continue;
// Ignore stuff that isn't into the storage device
if ((storage_id != 0) && (ob->oi.StorageID != storage_id ))
continue;
// Allocate a new album type
alb = LIBMTP_new_album_t();
alb->album_id = ob->oid;
alb->parent_id = ob->oi.ParentObject;
alb->storage_id = ob->oi.StorageID;
// Fetch supported metadata
get_album_metadata(device, alb);
// Then get the track listing for this album
ret = ptp_mtp_getobjectreferences(params, alb->album_id, &alb->tracks, &alb->no_tracks);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Album_List(): Could not get object references.");
alb->tracks = NULL;
alb->no_tracks = 0;
}
// Add album to a list that will be returned afterwards.
if (retalbums == NULL) {
retalbums = alb;
curalbum = alb;
} else {
curalbum->next = alb;
curalbum = alb;
}
}
return retalbums;
}
/**
* This function retrieves an individual album from the device.
* @param device a pointer to the device to get the album from.
* @param albid the unique ID of the album to retrieve.
* @return a valid album metadata or NULL on failure.
* @see LIBMTP_Get_Album_List()
*/
LIBMTP_album_t *LIBMTP_Get_Album(LIBMTP_mtpdevice_t *device, uint32_t const albid)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
PTPObject *ob;
LIBMTP_album_t *alb;
// Get all the handles if we haven't already done that
if (params->nrofobjects == 0)
flush_handles(device);
ret = ptp_object_want(params, albid, PTPOBJECT_OBJECTINFO_LOADED, &ob);
if (ret != PTP_RC_OK)
return NULL;
// Ignore stuff that isn't an album
if (ob->oi.ObjectFormat != PTP_OFC_MTP_AbstractAudioAlbum)
return NULL;
// Allocate a new album type
alb = LIBMTP_new_album_t();
alb->album_id = ob->oid;
alb->parent_id = ob->oi.ParentObject;
alb->storage_id = ob->oi.StorageID;
// Fetch supported metadata
get_album_metadata(device, alb);
// Then get the track listing for this album
ret = ptp_mtp_getobjectreferences(params, alb->album_id, &alb->tracks, &alb->no_tracks);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Album: Could not get object references.");
alb->tracks = NULL;
alb->no_tracks = 0;
}
return alb;
}
/**
* This routine creates a new album based on the metadata
* supplied. If the <code>tracks</code> field of the metadata
* contains a track listing, these tracks will be added to the
* album.
* @param device a pointer to the device to create the new album on.
* @param metadata the metadata for the new album. If the function
* exits with success, the <code>album_id</code> field of this
* struct will contain the new ID of the album.
* <ul>
* <li><code>metadata->parent_id</code> should be set to the parent
* (e.g. folder) to store this track in. Since some
* devices are a bit picky about where files
* are placed, a default folder will be chosen if libmtp
* has detected one for the current filetype and this
* parameter is set to 0. If this is 0 and no default folder
* can be found, the file will be stored in the root folder.
* <li><code>metadata->storage_id</code> should be set to the
* desired storage (e.g. memory card or whatever your device
* presents) to store this track in. Setting this to 0 will store
* the track on the primary storage.
* </ul>
* @return 0 on success, any other value means failure.
* @see LIBMTP_Update_Album()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Create_New_Album(LIBMTP_mtpdevice_t *device,
LIBMTP_album_t * const metadata)
{
uint32_t localph = metadata->parent_id;
// Use a default folder if none given
if (localph == 0) {
if (device->default_album_folder != 0)
localph = device->default_album_folder;
else
localph = device->default_music_folder;
}
metadata->parent_id = localph;
// Just create a new abstract album...
return create_new_abstract_list(device,
metadata->name,
metadata->artist,
metadata->composer,
metadata->genre,
localph,
metadata->storage_id,
PTP_OFC_MTP_AbstractAudioAlbum,
".alb",
&metadata->album_id,
metadata->tracks,
metadata->no_tracks);
}
/**
* This creates a new sample data metadata structure and allocates memory
* for it. Notice that if you add strings to this structure they
* will be freed by the corresponding <code>LIBMTP_destroy_sampledata_t</code>
* operation later, so be careful of using strdup() when assigning
* strings.
*
* @return a pointer to the newly allocated metadata structure.
* @see LIBMTP_destroy_sampledata_t()
*/
LIBMTP_filesampledata_t *LIBMTP_new_filesampledata_t(void)
{
LIBMTP_filesampledata_t *new = (LIBMTP_filesampledata_t *) malloc(sizeof(LIBMTP_filesampledata_t));
if (new == NULL) {
return NULL;
}
new->height=0;
new->width = 0;
new->data = NULL;
new->duration = 0;
new->size = 0;
return new;
}
/**
* This destroys a file sample metadata type.
* @param sample the file sample metadata to be destroyed.
*/
void LIBMTP_destroy_filesampledata_t(LIBMTP_filesampledata_t * sample)
{
if (sample == NULL) {
return;
}
if (sample->data != NULL) {
free(sample->data);
}
free(sample);
}
/**
* This routine figures out whether a certain filetype supports
* representative samples (small thumbnail images) or not. This
* typically applies to JPEG files, MP3 files and Album abstract
* playlists, but in theory any filetype could support representative
* samples.
* @param device a pointer to the device which is to be examined.
* @param filetype the fileype to examine, and return the representative sample
* properties for.
* @param sample this will contain a new sample type with the fields
* filled in with suitable default values. For example, the
* supported sample type will be set, the supported height and
* width will be set to max values if it is an image sample,
* and duration will also be given some suitable default value
* which should not be exceeded on audio samples. If the
* device does not support samples for this filetype, this
* pointer will be NULL. If it is not NULL, the user must
* destroy this struct with <code>LIBMTP_destroy_filesampledata_t()</code>
* after use.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Send_Representative_Sample()
* @see LIBMTP_Create_New_Album()
*/
int LIBMTP_Get_Representative_Sample_Format(LIBMTP_mtpdevice_t *device,
LIBMTP_filetype_t const filetype,
LIBMTP_filesampledata_t ** sample)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
uint16_t *props = NULL;
uint32_t propcnt = 0;
unsigned int i;
// TODO: Get rid of these when we can properly query the device.
int support_data = 0;
int support_format = 0;
int support_height = 0;
int support_width = 0;
int support_duration = 0;
int support_size = 0;
PTPObjectPropDesc opd_height;
PTPObjectPropDesc opd_width;
PTPObjectPropDesc opd_format;
PTPObjectPropDesc opd_duration;
PTPObjectPropDesc opd_size;
// Default to no type supported.
*sample = NULL;
ret = ptp_mtp_getobjectpropssupported(params, map_libmtp_type_to_ptp_type(filetype), &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Representative_Sample_Format(): could not get object properties.");
return -1;
}
/*
* TODO: when walking through these object properties, make calls to
* a new function in ptp.h/ptp.c that can send the command
* PTP_OC_MTP_GetObjectPropDesc to get max/min values of the properties
* supported.
*/
for (i = 0; i < propcnt; i++) {
switch(props[i]) {
case PTP_OPC_RepresentativeSampleData:
support_data = 1;
break;
case PTP_OPC_RepresentativeSampleFormat:
support_format = 1;
break;
case PTP_OPC_RepresentativeSampleSize:
support_size = 1;
break;
case PTP_OPC_RepresentativeSampleHeight:
support_height = 1;
break;
case PTP_OPC_RepresentativeSampleWidth:
support_width = 1;
break;
case PTP_OPC_RepresentativeSampleDuration:
support_duration = 1;
break;
default:
break;
}
}
free(props);
if (support_data && support_format && support_height && support_width && !support_duration) {
// Something that supports height and width and not duration is likely to be JPEG
LIBMTP_filesampledata_t *retsam = LIBMTP_new_filesampledata_t();
/*
* Populate the sample format with the first supported format
*
* TODO: figure out how to pass back more than one format if more are
* supported by the device.
*/
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleFormat, map_libmtp_type_to_ptp_type(filetype), &opd_format);
retsam->filetype = map_ptp_type_to_libmtp_type(opd_format.FORM.Enum.SupportedValue[0].u16);
ptp_free_objectpropdesc(&opd_format);
/* Populate the maximum image height */
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleWidth, map_libmtp_type_to_ptp_type(filetype), &opd_width);
retsam->width = opd_width.FORM.Range.MaximumValue.u32;
ptp_free_objectpropdesc(&opd_width);
/* Populate the maximum image width */
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleHeight, map_libmtp_type_to_ptp_type(filetype), &opd_height);
retsam->height = opd_height.FORM.Range.MaximumValue.u32;
ptp_free_objectpropdesc(&opd_height);
/* Populate the maximum size */
if (support_size) {
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleSize, map_libmtp_type_to_ptp_type(filetype), &opd_size);
retsam->size = opd_size.FORM.Range.MaximumValue.u32;
ptp_free_objectpropdesc(&opd_size);
}
*sample = retsam;
} else if (support_data && support_format && !support_height && !support_width && support_duration) {
// Another qualified guess
LIBMTP_filesampledata_t *retsam = LIBMTP_new_filesampledata_t();
/*
* Populate the sample format with the first supported format
*
* TODO: figure out how to pass back more than one format if more are
* supported by the device.
*/
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleFormat, map_libmtp_type_to_ptp_type(filetype), &opd_format);
retsam->filetype = map_ptp_type_to_libmtp_type(opd_format.FORM.Enum.SupportedValue[0].u16);
ptp_free_objectpropdesc(&opd_format);
/* Populate the maximum duration */
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleDuration, map_libmtp_type_to_ptp_type(filetype), &opd_duration);
retsam->duration = opd_duration.FORM.Range.MaximumValue.u32;
ptp_free_objectpropdesc(&opd_duration);
/* Populate the maximum size */
if (support_size) {
ptp_mtp_getobjectpropdesc (params, PTP_OPC_RepresentativeSampleSize, map_libmtp_type_to_ptp_type(filetype), &opd_size);
retsam->size = opd_size.FORM.Range.MaximumValue.u32;
ptp_free_objectpropdesc(&opd_size);
}
*sample = retsam;
}
return 0;
}
/**
* This routine sends representative sample data for an object.
* This uses the RepresentativeSampleData property of the album,
* if the device supports it. The data should be of a format acceptable
* to the player (for iRiver and Creative, this seems to be JPEG) and
* must not be too large. (for a Creative, max seems to be about 20KB.)
* Check by calling LIBMTP_Get_Representative_Sample_Format() to get
* maximum size, dimensions, etc..
* @param device a pointer to the device which the object is on.
* @param id unique id of the object to set artwork for.
* @param pointer to LIBMTP_filesampledata_t struct containing data
* @return 0 on success, any other value means failure.
* @see LIBMTP_Get_Representative_Sample()
* @see LIBMTP_Get_Representative_Sample_Format()
* @see LIBMTP_Create_New_Album()
*/
int LIBMTP_Send_Representative_Sample(LIBMTP_mtpdevice_t *device,
uint32_t const id,
LIBMTP_filesampledata_t *sampledata)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTP_USB *ptp_usb = (PTP_USB*) device->usbinfo;
PTPPropertyValue propval;
PTPObject *ob;
uint32_t i;
uint16_t *props = NULL;
uint32_t propcnt = 0;
int supported = 0;
// get the file format for the object we're going to send representative data for
ret = ptp_object_want (params, id, PTPOBJECT_OBJECTINFO_LOADED, &ob);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Send_Representative_Sample(): could not get object info.");
return -1;
}
// check that we can send representative sample data for this object format
ret = ptp_mtp_getobjectpropssupported(params, ob->oi.ObjectFormat, &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Send_Representative_Sample(): could not get object properties.");
return -1;
}
for (i = 0; i < propcnt; i++) {
if (props[i] == PTP_OPC_RepresentativeSampleData) {
supported = 1;
break;
}
}
if (!supported) {
free(props);
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Send_Representative_Sample(): object type doesn't support RepresentativeSampleData.");
return -1;
}
free(props);
// Go ahead and send the data
propval.a.count = sampledata->size;
propval.a.v = malloc(sizeof(PTPPropertyValue) * sampledata->size);
for (i = 0; i < sampledata->size; i++) {
propval.a.v[i].u8 = sampledata->data[i];
}
ret = ptp_mtp_setobjectpropvalue(params,id,PTP_OPC_RepresentativeSampleData,
&propval,PTP_DTC_AUINT8);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Send_Representative_Sample(): could not send sample data.");
free(propval.a.v);
return -1;
}
free(propval.a.v);
/* Set the height and width if the sample is an image, otherwise just
* set the duration and size */
switch(sampledata->filetype) {
case LIBMTP_FILETYPE_JPEG:
case LIBMTP_FILETYPE_JFIF:
case LIBMTP_FILETYPE_TIFF:
case LIBMTP_FILETYPE_BMP:
case LIBMTP_FILETYPE_GIF:
case LIBMTP_FILETYPE_PICT:
case LIBMTP_FILETYPE_PNG:
if (!FLAG_BROKEN_SET_SAMPLE_DIMENSIONS(ptp_usb)) {
// For images, set the height and width
set_object_u32(device, id, PTP_OPC_RepresentativeSampleHeight, sampledata->height);
set_object_u32(device, id, PTP_OPC_RepresentativeSampleWidth, sampledata->width);
}
break;
default:
// For anything not an image, set the duration and size
set_object_u32(device, id, PTP_OPC_RepresentativeSampleDuration, sampledata->duration);
set_object_u32(device, id, PTP_OPC_RepresentativeSampleSize, sampledata->size);
break;
}
return 0;
}
/**
* This routine gets representative sample data for an object.
* This uses the RepresentativeSampleData property of the album,
* if the device supports it.
* @param device a pointer to the device which the object is on.
* @param id unique id of the object to get data for.
* @param pointer to LIBMTP_filesampledata_t struct to receive data
* @return 0 on success, any other value means failure.
* @see LIBMTP_Send_Representative_Sample()
* @see LIBMTP_Get_Representative_Sample_Format()
* @see LIBMTP_Create_New_Album()
*/
int LIBMTP_Get_Representative_Sample(LIBMTP_mtpdevice_t *device,
uint32_t const id,
LIBMTP_filesampledata_t *sampledata)
{
uint16_t ret;
PTPParams *params = (PTPParams *) device->params;
PTPPropertyValue propval;
PTPObject *ob;
uint32_t i;
uint16_t *props = NULL;
uint32_t propcnt = 0;
int supported = 0;
// get the file format for the object we're going to send representative data for
ret = ptp_object_want (params, id, PTPOBJECT_OBJECTINFO_LOADED, &ob);
if (ret != PTP_RC_OK) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_Representative_Sample(): could not get object info.");
return -1;
}
// check that we can store representative sample data for this object format
ret = ptp_mtp_getobjectpropssupported(params, ob->oi.ObjectFormat, &propcnt, &props);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Representative_Sample(): could not get object properties.");
return -1;
}
for (i = 0; i < propcnt; i++) {
if (props[i] == PTP_OPC_RepresentativeSampleData) {
supported = 1;
break;
}
}
if (!supported) {
free(props);
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL, "LIBMTP_Get_Representative_Sample(): object type doesn't support RepresentativeSampleData.");
return -1;
}
free(props);
// Get the data
ret = ptp_mtp_getobjectpropvalue(params,id,PTP_OPC_RepresentativeSampleData,
&propval,PTP_DTC_AUINT8);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Get_Representative_Sample(): could not get sample data.");
return -1;
}
// Store it
sampledata->size = propval.a.count;
sampledata->data = malloc(sizeof(PTPPropertyValue) * propval.a.count);
for (i = 0; i < propval.a.count; i++) {
sampledata->data[i] = propval.a.v[i].u8;
}
free(propval.a.v);
// Get the other properties
sampledata->width = get_u32_from_object(device, id, PTP_OPC_RepresentativeSampleWidth, 0);
sampledata->height = get_u32_from_object(device, id, PTP_OPC_RepresentativeSampleHeight, 0);
sampledata->duration = get_u32_from_object(device, id, PTP_OPC_RepresentativeSampleDuration, 0);
sampledata->filetype = map_ptp_type_to_libmtp_type(
get_u16_from_object(device, id, PTP_OPC_RepresentativeSampleFormat, LIBMTP_FILETYPE_UNKNOWN));
return 0;
}
/**
* Retrieve the thumbnail for a file.
* @param device a pointer to the device to get the thumbnail from.
* @param id the object ID of the file to retrieve the thumbnail for.
* @return 0 on success, any other value means failure.
*/
int LIBMTP_Get_Thumbnail(LIBMTP_mtpdevice_t *device, uint32_t const id,
unsigned char **data, unsigned int *size)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
ret = ptp_getthumb(params, id, data, size);
if (ret == PTP_RC_OK)
return 0;
return -1;
}
int LIBMTP_GetPartialObject(LIBMTP_mtpdevice_t *device, uint32_t const id,
uint64_t offset, uint32_t maxbytes,
unsigned char **data, unsigned int *size)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
LIBMTP_file_t *mtpfile = LIBMTP_Get_Filemetadata(device, id);
if (!mtpfile) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_GetPartialObject: could not find mtpfile");
*size = 0;
return -1;
}
/* Some devices do not like reading over the end and hang instead of progressing */
if (offset >= mtpfile->filesize) {
*size = 0;
LIBMTP_destroy_file_t (mtpfile);
return 0;
}
if (offset + maxbytes > mtpfile->filesize) {
maxbytes = mtpfile->filesize - offset;
}
/* do not need it anymore */
LIBMTP_destroy_file_t (mtpfile);
/* The MTP stack of Samsung Galaxy devices has a mysterious bug in
* GetPartialObject. When GetPartialObject is invoked to read the
* last bytes of a file and the amount of data to read is such that
* the last USB packet sent in the reply matches exactly the USB 2.0
* packet size, then the Samsung Galaxy device hangs, resulting in a
* timeout error.
* As a workaround, we read one less byte instead of reaching the
* end of the file, forcing the caller to perform an additional read
* to get the last byte (i.e. the final read that would fail is
* replaced with two partial reads that succeed).
*/
if ((params->device_flags & DEVICE_FLAG_SAMSUNG_OFFSET_BUG) &&
(maxbytes % PTP_USB_BULK_HS_MAX_PACKET_LEN_READ) == (PTP_USB_BULK_HS_MAX_PACKET_LEN_READ - PTP_USB_BULK_HDR_LEN)) {
maxbytes--;
}
if (!ptp_operation_issupported(params, PTP_OC_ANDROID_GetPartialObject64)) {
if (!ptp_operation_issupported(params, PTP_OC_GetPartialObject)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_GetPartialObject: PTP_OC_GetPartialObject not supported");
return -1;
}
if (offset >> 32 != 0) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_GetPartialObject: PTP_OC_GetPartialObject only supports 32bit offsets");
return -1;
}
ret = ptp_getpartialobject(params, id, (uint32_t)offset, maxbytes, data, size);
} else {
ret = ptp_android_getpartialobject64(params, id, offset, maxbytes, data, size);
}
if (ret == PTP_RC_OK)
return 0;
return -1;
}
int LIBMTP_SendPartialObject(LIBMTP_mtpdevice_t *device, uint32_t const id,
uint64_t offset, unsigned char *data, unsigned int size)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_operation_issupported(params, PTP_OC_ANDROID_SendPartialObject)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_SendPartialObject: PTP_OC_ANDROID_SendPartialObject not supported");
return -1;
}
ret = ptp_android_sendpartialobject(params, id, offset, data, size);
if (ret == PTP_RC_OK)
return 0;
return -1;
}
int LIBMTP_BeginEditObject(LIBMTP_mtpdevice_t *device, uint32_t const id)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_operation_issupported(params, PTP_OC_ANDROID_BeginEditObject)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_BeginEditObject: PTP_OC_ANDROID_BeginEditObject not supported");
return -1;
}
ret = ptp_android_begineditobject(params, id);
if (ret == PTP_RC_OK)
return 0;
return -1;
}
int LIBMTP_EndEditObject(LIBMTP_mtpdevice_t *device, uint32_t const id)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_operation_issupported(params, PTP_OC_ANDROID_EndEditObject)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_EndEditObject: PTP_OC_ANDROID_EndEditObject not supported");
return -1;
}
ret = ptp_android_endeditobject(params, id);
if (ret == PTP_RC_OK) {
// update cached object properties if metadata cache exists
update_metadata_cache(device, id);
return 0;
}
return -1;
}
int LIBMTP_TruncateObject(LIBMTP_mtpdevice_t *device, uint32_t const id,
uint64_t offset)
{
PTPParams *params = (PTPParams *) device->params;
uint16_t ret;
if (!ptp_operation_issupported(params, PTP_OC_ANDROID_TruncateObject)) {
add_error_to_errorstack(device, LIBMTP_ERROR_GENERAL,
"LIBMTP_TruncateObject: PTP_OC_ANDROID_TruncateObject not supported");
return -1;
}
ret = ptp_android_truncate(params, id, offset);
if (ret == PTP_RC_OK)
return 0;
return -1;
}
/**
* This routine updates an album based on the metadata
* supplied. If the <code>tracks</code> field of the metadata
* contains a track listing, these tracks will be added to the
* album in place of those already present, i.e. the
* previous track listing will be deleted.
* @param device a pointer to the device to create the new album on.
* @param metadata the metadata for the album to be updated.
* notice that the field <code>album_id</code>
* must contain the appropriate album ID.
* @return 0 on success, any other value means failure.
* @see LIBMTP_Create_New_Album()
* @see LIBMTP_Delete_Object()
*/
int LIBMTP_Update_Album(LIBMTP_mtpdevice_t *device,
LIBMTP_album_t const * const metadata)
{
return update_abstract_list(device,
metadata->name,
metadata->artist,
metadata->composer,
metadata->genre,
metadata->album_id,
PTP_OFC_MTP_AbstractAudioAlbum,
metadata->tracks,
metadata->no_tracks);
}
/**
* Dummy function needed to interface to upstream
* ptp.c/ptp.h files.
*/
void ptp_nikon_getptpipguid (unsigned char* guid) {
return;
}
/**
* Add an object to cache.
* @param device the device which may have a cache to which the object should be added.
* @param object_id the object to add to the cache.
*/
static void add_object_to_cache(LIBMTP_mtpdevice_t *device, uint32_t object_id)
{
PTPParams *params = (PTPParams *)device->params;
uint16_t ret;
ret = ptp_add_object_to_cache(params, object_id);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "add_object_to_cache(): couldn't add object to cache");
}
}
/**
* Update cache after object has been modified
* @param device the device which may have a cache to which the object should be updated.
* @param object_id the object to update.
*/
static void update_metadata_cache(LIBMTP_mtpdevice_t *device, uint32_t object_id)
{
PTPParams *params = (PTPParams *)device->params;
ptp_remove_object_from_cache(params, object_id);
add_object_to_cache(device, object_id);
}
/**
* Issue custom (e.g. vendor specific) operation (without data phase)
* @param device a pointer to the device to send custom operation to.
* @param code operation code to send.
* @param n_param number of parameters passed.
* @param ... uint32_t operation specific parameters.
*/
int LIBMTP_Custom_Operation(LIBMTP_mtpdevice_t *device, uint16_t code, int n_param, ...)
{
PTPParams *params = (PTPParams *) device->params;
PTPContainer ptp;
va_list args;
uint16_t ret;
int i;
ptp.Code = code;
ptp.Nparam = n_param;
va_start(args, n_param);
for (i = 0; i < n_param; i++)
(&ptp.Param1)[i] = va_arg(args, uint32_t);
va_end(args);
ret = ptp_transaction_new(params, &ptp, PTP_DP_NODATA, 0, NULL);
if (ret != PTP_RC_OK) {
add_ptp_error_to_errorstack(device, ret, "LIBMTP_Custom_Operation(): failed to execute operation.");
return -1;
}
return 0;
}
|