/usr/include/gstreamermm-1.0/gstreamermm/query.h is in libgstreamermm-1.0-dev 1.4.3+dfsg-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GSTREAMERMM_QUERY_H
#define _GSTREAMERMM_QUERY_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* gstreamermm - a C++ wrapper for gstreamer
*
* Copyright 2008 The gstreamermm Development Team
*
* 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.1 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., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gst/gst.h>
#include <gstreamermm/miniobject.h>
#include <gstreamermm/structure.h>
#include <gstreamermm/format.h>
#include <gstreamermm/caps.h>
#include <gstreamermm/pad.h>
#include <gstreamermm/allocator.h>
#include <glibmm/arrayhandle.h>
namespace Glib
{
template<typename T>
Glib::RefPtr<T> wrap_query_derived(GstQuery* object, bool take_copy = false)
{
if(take_copy && object)
gst_query_ref(object);
// See the comment at the top of this file, if you want to know why the cast works.
return Glib::RefPtr<T>(reinterpret_cast<T*>(object));
}
}
namespace Gst
{
#define FLAG(name) GST_QUERY_TYPE_##name
/** @addtogroup gstreamermmEnums gstreamermm Enums and Flags */
/**
* @var BufferingMode BUFFERING_STREAM
* A small amount of data is buffered.
*
* @var BufferingMode BUFFERING_DOWNLOAD
* The stream is being downloaded.
*
* @var BufferingMode BUFFERING_TIMESHIFT
* The stream is being downloaded in a ringbuffer.
*
* @var BufferingMode BUFFERING_LIVE
* The stream is a live stream.
*
* @enum BufferingMode
*
* The different types of buffering methods.
* @ingroup gstreamermmEnums
*/
enum BufferingMode
{
BUFFERING_STREAM,
BUFFERING_DOWNLOAD,
BUFFERING_TIMESHIFT,
BUFFERING_LIVE
};
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::BufferingMode> : public Glib::Value_Enum<Gst::BufferingMode>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/**
* @var QueryType QUERY_UNKNOWN
* Unknown query type.
*
* @var QueryType QUERY_POSITION
* Current position in stream.
*
* @var QueryType QUERY_DURATION
* Total duration of the stream.
*
* @var QueryType QUERY_LATENCY
* Latency of stream.
*
* @var QueryType QUERY_JITTER
* Current jitter of stream.
*
* @var QueryType QUERY_RATE
* Current rate of the stream.
*
* @var QueryType QUERY_SEEKING
* Seeking capabilities.
*
* @var QueryType QUERY_SEGMENT
* Segment start/stop positions.
*
* @var QueryType QUERY_CONVERT
* Convert values between formats.
*
* @var QueryType QUERY_FORMATS
* Query supported formats for convert.
*
* @var QueryType QUERY_BUFFERING
* Query available media for efficient seeking.
*
* @var QueryType QUERY_CUSTOM
* A custom application or element defined query.
*
* @var QueryType QUERY_URI
* Query the URI of the source or sink.
*
* @var QueryType QUERY_ALLOCATION
* The buffer allocation properties.
*
* @var QueryType QUERY_SCHEDULING
* The scheduling properties.
*
* @var QueryType QUERY_ACCEPT_CAPS
* The accept caps query.
*
* @var QueryType QUERY_CAPS
* The caps query.
*
* @var QueryType QUERY_DRAIN
* Wait till all serialized data is consumed downstream.
*
* @var QueryType QUERY_CONTEXT
* Query the pipeline-local context from downstream or upstream (since 1.2).
*
* @enum QueryType
*
* Standard predefined Query types
* @ingroup gstreamermmEnums
* @par Bitwise operators:
* <tt>%QueryType operator|(QueryType, QueryType)</tt><br>
* <tt>%QueryType operator&(QueryType, QueryType)</tt><br>
* <tt>%QueryType operator^(QueryType, QueryType)</tt><br>
* <tt>%QueryType operator~(QueryType)</tt><br>
* <tt>%QueryType& operator|=(QueryType&, QueryType)</tt><br>
* <tt>%QueryType& operator&=(QueryType&, QueryType)</tt><br>
* <tt>%QueryType& operator^=(QueryType&, QueryType)</tt><br>
*/
enum QueryType
{
QUERY_UNKNOWN = GST_QUERY_MAKE_TYPE (0, 0),
QUERY_POSITION = GST_QUERY_MAKE_TYPE (10, FLAG(BOTH)),
QUERY_DURATION = GST_QUERY_MAKE_TYPE (20, FLAG(BOTH)),
QUERY_LATENCY = GST_QUERY_MAKE_TYPE (30, FLAG(BOTH)),
QUERY_JITTER = GST_QUERY_MAKE_TYPE (40, FLAG(BOTH)),
QUERY_RATE = GST_QUERY_MAKE_TYPE (50, FLAG(BOTH)),
QUERY_SEEKING = GST_QUERY_MAKE_TYPE (60, FLAG(BOTH)),
QUERY_SEGMENT = GST_QUERY_MAKE_TYPE (70, FLAG(BOTH)),
QUERY_CONVERT = GST_QUERY_MAKE_TYPE (80, FLAG(BOTH)),
QUERY_FORMATS = GST_QUERY_MAKE_TYPE (90, FLAG(BOTH)),
QUERY_BUFFERING = GST_QUERY_MAKE_TYPE (110, FLAG(BOTH)),
QUERY_CUSTOM = GST_QUERY_MAKE_TYPE (120, FLAG(BOTH)),
QUERY_URI = GST_QUERY_MAKE_TYPE (130, FLAG(BOTH)),
QUERY_ALLOCATION = GST_QUERY_MAKE_TYPE (140, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
QUERY_SCHEDULING = GST_QUERY_MAKE_TYPE (150, FLAG(UPSTREAM)),
QUERY_ACCEPT_CAPS = GST_QUERY_MAKE_TYPE (160, FLAG(BOTH)),
QUERY_CAPS = GST_QUERY_MAKE_TYPE (170, FLAG(BOTH)),
QUERY_DRAIN = GST_QUERY_MAKE_TYPE (180, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)),
QUERY_CONTEXT = GST_QUERY_MAKE_TYPE (190, FLAG(BOTH))
};
/** @ingroup gstreamermmEnums */
inline QueryType operator|(QueryType lhs, QueryType rhs)
{ return static_cast<QueryType>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline QueryType operator&(QueryType lhs, QueryType rhs)
{ return static_cast<QueryType>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline QueryType operator^(QueryType lhs, QueryType rhs)
{ return static_cast<QueryType>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline QueryType operator~(QueryType flags)
{ return static_cast<QueryType>(~static_cast<unsigned>(flags)); }
/** @ingroup gstreamermmEnums */
inline QueryType& operator|=(QueryType& lhs, QueryType rhs)
{ return (lhs = static_cast<QueryType>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup gstreamermmEnums */
inline QueryType& operator&=(QueryType& lhs, QueryType rhs)
{ return (lhs = static_cast<QueryType>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup gstreamermmEnums */
inline QueryType& operator^=(QueryType& lhs, QueryType rhs)
{ return (lhs = static_cast<QueryType>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::QueryType> : public Glib::Value_Flags<Gst::QueryType>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/**
* @var QueryTypeFlags QUERY_TYPE_UPSTREAM
* Set if the query can travel upstream.
*
* @var QueryTypeFlags QUERY_TYPE_DOWNSTREAM
* Set if the query can travel downstream.
*
* @var QueryTypeFlags QUERY_TYPE_SERIALIZED
* Set if the query should be serialized with data flow.
*
* @enum QueryTypeFlags
*
* Gst::QueryTypeFlags indicate the aspects of the different Gst::QueryType
* values. You can get the type flags of a Gst::QueryType with the
* Gst::Query::type_get_flags() function.
* @ingroup gstreamermmEnums
* @par Bitwise operators:
* <tt>%QueryTypeFlags operator|(QueryTypeFlags, QueryTypeFlags)</tt><br>
* <tt>%QueryTypeFlags operator&(QueryTypeFlags, QueryTypeFlags)</tt><br>
* <tt>%QueryTypeFlags operator^(QueryTypeFlags, QueryTypeFlags)</tt><br>
* <tt>%QueryTypeFlags operator~(QueryTypeFlags)</tt><br>
* <tt>%QueryTypeFlags& operator|=(QueryTypeFlags&, QueryTypeFlags)</tt><br>
* <tt>%QueryTypeFlags& operator&=(QueryTypeFlags&, QueryTypeFlags)</tt><br>
* <tt>%QueryTypeFlags& operator^=(QueryTypeFlags&, QueryTypeFlags)</tt><br>
*/
enum QueryTypeFlags
{
QUERY_TYPE_UPSTREAM = 1 << 0,
QUERY_TYPE_DOWNSTREAM = 1 << 1,
QUERY_TYPE_SERIALIZED = 1 << 2
};
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags operator|(QueryTypeFlags lhs, QueryTypeFlags rhs)
{ return static_cast<QueryTypeFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags operator&(QueryTypeFlags lhs, QueryTypeFlags rhs)
{ return static_cast<QueryTypeFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags operator^(QueryTypeFlags lhs, QueryTypeFlags rhs)
{ return static_cast<QueryTypeFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags operator~(QueryTypeFlags flags)
{ return static_cast<QueryTypeFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags& operator|=(QueryTypeFlags& lhs, QueryTypeFlags rhs)
{ return (lhs = static_cast<QueryTypeFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags& operator&=(QueryTypeFlags& lhs, QueryTypeFlags rhs)
{ return (lhs = static_cast<QueryTypeFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup gstreamermmEnums */
inline QueryTypeFlags& operator^=(QueryTypeFlags& lhs, QueryTypeFlags rhs)
{ return (lhs = static_cast<QueryTypeFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::QueryTypeFlags> : public Glib::Value_Flags<Gst::QueryTypeFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/**
* @var SchedulingFlags SCHEDULING_FLAG_SEEKABLE
* If seeking is possible.
*
* @var SchedulingFlags SCHEDULING_FLAG_SEQUENTIAL
* If sequential access is recommended.
*
* @var SchedulingFlags SCHEDULING_FLAG_BANDWIDTH_LIMITED
* If bandwidth is limited and buffering possible (since 1.2).
*
* @enum SchedulingFlags
*
* The different scheduling flags.
* @ingroup gstreamermmEnums
* @par Bitwise operators:
* <tt>%SchedulingFlags operator|(SchedulingFlags, SchedulingFlags)</tt><br>
* <tt>%SchedulingFlags operator&(SchedulingFlags, SchedulingFlags)</tt><br>
* <tt>%SchedulingFlags operator^(SchedulingFlags, SchedulingFlags)</tt><br>
* <tt>%SchedulingFlags operator~(SchedulingFlags)</tt><br>
* <tt>%SchedulingFlags& operator|=(SchedulingFlags&, SchedulingFlags)</tt><br>
* <tt>%SchedulingFlags& operator&=(SchedulingFlags&, SchedulingFlags)</tt><br>
* <tt>%SchedulingFlags& operator^=(SchedulingFlags&, SchedulingFlags)</tt><br>
*/
enum SchedulingFlags
{
SCHEDULING_FLAG_SEEKABLE = (1 << 0),
SCHEDULING_FLAG_SEQUENTIAL = (1 << 1),
SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2)
};
/** @ingroup gstreamermmEnums */
inline SchedulingFlags operator|(SchedulingFlags lhs, SchedulingFlags rhs)
{ return static_cast<SchedulingFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline SchedulingFlags operator&(SchedulingFlags lhs, SchedulingFlags rhs)
{ return static_cast<SchedulingFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline SchedulingFlags operator^(SchedulingFlags lhs, SchedulingFlags rhs)
{ return static_cast<SchedulingFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup gstreamermmEnums */
inline SchedulingFlags operator~(SchedulingFlags flags)
{ return static_cast<SchedulingFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup gstreamermmEnums */
inline SchedulingFlags& operator|=(SchedulingFlags& lhs, SchedulingFlags rhs)
{ return (lhs = static_cast<SchedulingFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup gstreamermmEnums */
inline SchedulingFlags& operator&=(SchedulingFlags& lhs, SchedulingFlags rhs)
{ return (lhs = static_cast<SchedulingFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup gstreamermmEnums */
inline SchedulingFlags& operator^=(SchedulingFlags& lhs, SchedulingFlags rhs)
{ return (lhs = static_cast<SchedulingFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::SchedulingFlags> : public Glib::Value_Flags<Gst::SchedulingFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
#undef FLAG
namespace Enums
{
/** Gets a printable name for the given query type.
*
* @param query The query type.
* @return The name of the query.
*/
Glib::ustring get_name(QueryType type);
/** Gets the Gst::QueryTypeFlags associated with @type.
*
* @param type a Gst::QueryType.
* @return a Gst::QueryTypeFlags;
*/
Gst::QueryTypeFlags get_flags(QueryType type);
/** Gets the unique quark for the given query type.
*
* @param query The query type.
* @return The quark associated with the query type.
*/
Glib::QueryQuark get_quark(QueryType type);
} //namespace Enums
/** A class used to perform queries on pads and elements.
*
* Queries can be performed on pads (gst_pad_query()) and elements
* (gst_element_query()). Please note that some queries might need a running
* pipeline to work.
*
* Queries can be created using the gst_query_new_*() functions.
* Query values can be set using gst_query_set_*(), and parsed using
* gst_query_parse_*() helpers.
*
* The following example shows how to query the duration of a pipeline:
*
* @code
* Glib::RefPtr<Gst::Query> query = Gst::QueryDuration::create(Gst::FORMAT_TIME);
* bool res = pipeline->query(query);
* if(res)
* {
* gint64 duration = Glib::RefPtr<Gst::QueryDuration>::cast_dynamic(query)->parse();
* ...
* }
* @endcode
*/
class Query : public MiniObject
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef Query CppObjectType;
typedef GstQuery BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
/** Increment the reference count for this object.
* You should never need to do this manually - use the object via a RefPtr instead.
*/
void reference() const;
/** Decrement the reference count for this object.
* You should never need to do this manually - use the object via a RefPtr instead.
*/
void unreference() const;
///Provides access to the underlying C instance.
GstQuery* gobj();
///Provides access to the underlying C instance.
const GstQuery* gobj() const;
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GstQuery* gobj_copy() const;
protected:
// Do not derive this. Gst::Query can neither be constructed nor deleted.
Query();
void operator delete(void*, std::size_t);
private:
// noncopyable
Query(const Query&);
Query& operator=(const Query&);
public:
/** Makes a writable query from the given query.
* @return A Gst::Query (possibly the same pointer) that is writable.
*/
Glib::RefPtr<Gst::Query> create_writable();
// A copy is taken so that the original is not freed by the wrapper.
/** Get the structure of a query.
*
* @return The Gst::Structure of the query. The structure is
* still owned by the query and will therefore be freed when the query
* is unreffed.
*/
Gst::Structure get_structure() const;
/** Constructs a new query object for querying the buffering status of
* a stream.
*
* Free-function: gst_query_unref
*
* @param format The default Gst::Format for the new query.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_buffering(Gst::Format format);
/** Constructs a new query object for querying the allocation properties.
*
* Free-function: gst_query_unref
*
* @param caps The negotiated caps.
* @param need_pool Return a pool.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_allocation(Glib::RefPtr<Gst::Caps> caps, bool need_pool);
/** Constructs a new query URI query object. Use unref()
* when done with it. An URI query is used to query the current URI
* that is used by the source or sink.
*
* Free-function: gst_query_unref
*
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_uri();
/** Constructs a new query object for querying the scheduling properties.
*
* Free-function: gst_query_unref
*
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_scheduling();
/** Constructs a new query object for querying the drain state.
*
* Free-function: gst_query_unref
*
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_drain();
/** Constructs a new custom query object. Use unref()
* when done with it.
*
* Free-function: gst_query_unref
*
* @param type The query type.
* @param structure A structure for the query.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_custom(Gst::QueryType type, const Gst::Structure& structure);
/** Constructs a new convert query object. Use unref()
* when done with it. A convert query is used to ask for a conversion between
* one format and another.
*
* Free-function: gst_query_unref
*
* @param src_format The source Gst::Format for the new query.
* @param value The value to convert.
* @param dest_format The target Gst::Format.
* @return A Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_convert(Gst::Format format, gint64 value, Gst::Format dest_format);
/** Constructs a new query stream position query object. Use unref()
* when done with it. A position query is used to query the current position
* of playback in the streams, in some format.
*
* Free-function: gst_query_unref
*
* @param format The default Gst::Format for the new query.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_position(Gst::Format format);
/** Constructs a new stream duration query object to query in the given format.
* Use unref() when done with it. A duration query will give the
* total length of the stream.
*
* Free-function: gst_query_unref
*
* @param format The Gst::Format for this duration query.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_duration(Gst::Format format);
/** Constructs a new latency query object.
* Use unref() when done with it. A latency query is usually performed
* by sinks to compensate for additional latency introduced by elements in the
* pipeline.
*
* Free-function: gst_query_unref
*
* @return A Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_latency();
/** Constructs a new query object for querying seeking properties of
* the stream.
*
* Free-function: gst_query_unref
*
* @param format The default Gst::Format for the new query.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_seeking(Gst::Format format);
/** Constructs a new query object for querying formats of
* the stream.
*
* Free-function: gst_query_unref
*
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_formats();
/** Constructs a new segment query object. Use unref()
* when done with it. A segment query is used to discover information about the
* currently configured segment for playback.
*
* Free-function: gst_query_unref
*
* @param format The Gst::Format for the new query.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_segment(Gst::Format format);
/** Constructs a new query object for querying the caps.
*
* The CAPS query should return the allowable caps for a pad in the context
* of the element's state, its link to other elements, and the devices or files
* it has opened. These caps must be a subset of the pad template caps. In the
* <tt>0</tt> state with no links, the CAPS query should ideally return the same caps
* as the pad template. In rare circumstances, an object property can affect
* the caps returned by the CAPS query, but this is discouraged.
*
* For most filters, the caps returned by CAPS query is directly affected by the
* allowed caps on other pads. For demuxers and decoders, the caps returned by
* the srcpad's getcaps function is directly related to the stream data. Again,
* the CAPS query should return the most specific caps it reasonably can, since this
* helps with autoplugging.
*
* The @a filter is used to restrict the result caps, only the caps matching
* @a filter should be returned from the CAPS query. Specifying a filter might
* greatly reduce the amount of processing an element needs to do.
*
* Free-function: gst_query_unref
*
* @param filter A filter.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_caps(Glib::RefPtr<Gst::Caps> filter);
/** Constructs a new query object for querying if @a caps are accepted.
*
* Free-function: gst_query_unref
*
* @param caps A fixed Gst::Caps.
* @return A new Gst::Query.
*/
static Glib::RefPtr<Gst::Query> create_accept_caps(Glib::RefPtr<Gst::Caps> filter);
/** Get the Gst::QueryType of the query.
*/
QueryType get_query_type() const;
/** Copies the given query using the copy function of the parent Gst::Structure.
*
* Free-function: gst_query_unref
*
* @return A new copy of @a q.
*/
Glib::RefPtr<Gst::Query> copy();
protected:
// This method is used in the create() methods to convert a wrapped GstQuery
// to one of the more specific Gst::Query types.
template <class QueryType>
static inline Glib::RefPtr<QueryType> wrap(GstQuery* query,
bool take_copy = false);
};
//TODO: Modify create methods of derived Query classes to return
//Glib::RefPtr<...> to the derived class and not just Gst::Query. Must deal
//with GstStructure immutability problem (bug #510301) first because casting
//Glib::RefPtrs references the objects which causes problems when GStreamer API
//tries to modify the GstStructures of the objects.
/** A custom application query object. See create() for more details.
*/
class QueryApplication : public Query
{
public:
/** Constructs a new custom application query object. The Gst::Query may be
* used by applications in their own way. Please note that a custom
* Gst::QueryType must be used in order for the returned Gst::Query to
* actually be a Gst::QueryApplication type.
* @param type The query type.
* @param structure A structure for the query.
* @return The new Gst::QueryApplication.
*/
static Glib::RefPtr<Gst::QueryApplication>
create(QueryType type, const Gst::Structure& structure);
};
/** A convert query object. See create() for more details.
*/
class QueryConvert : public Query
{
public:
/** Constructs a new convert query object. A convert query is used to ask
* for a conversion between one format and another.
* @param src_format The source Gst::Format for the new query.
* @param value The value to convert.
* @param dest_format The target Gst::Format.
* @return The new Gst::QueryConvert.
*/
static Glib::RefPtr<Gst::QueryConvert>
create(Format src_format, gint64 value, Format dest_format);
/** Answer a convert query by setting the requested values.
* @param src_format The source Gst::Format.
* @param src_value The source value.
* @param dest_format The destination Gst::Format.
* @param dest_value The destination value.
*/
void set(Format src_format, gint64 src_value, Format dest_format, gint64 dest_value);
/** Parse a convert query answer. Use the other parse() methods for parsing
* individual values.
* @param src_format The storage for the Gst::Format of the source value.
* @param src_value The storage for the source value.
* @param dest_format The storage for the Gst::Format of the destination.
* value.
* @param dest_value The storage for the destination value.
*/
void parse(Format& src_format, gint64& src_value, Format& dest_format, gint64& dest_value) const;
/** Parse the destination format and value of a convert query answer.
* @param dest_format The storage for the Gst::Format of the destination
* value.
* @param dest_value The storage for the destination value.
*/
void parse(Format& dest_format, gint64& dest_value) const;
/** Parse the source format of a convert query answer, returning the format.
* @return The Gst::Format of the source value.
*/
Format parse_src_format() const;
/** Parse the source value of a convert query answer returning, the value.
* @return The source value.
*/
gint64 parse_src_value() const;
/** Parse the destination format of a convert query answer, returning the
* format.
* @return The Gst::Format of the destination value.
*/
Format parse_dest_format() const;
/** Parse the destination value of a convert query answer, returning the
* value.
* @return The destination value.
*/
gint64 parse_dest_value() const;
};
/** A stream position query object. See create() for more details.
*/
class QueryPosition : public Query
{
public:
/** Constructs a new query stream position query object. A position query is
* used to query the current position of playback in the streams, in some
* format.
* @param format The default Gst::Format for the new query.
* @return The new Gst::QueryPosition.
*/
static Glib::RefPtr<Gst::QueryPosition> create(Format format);
/** Answer a position query by setting the requested value in the given
* format.
* @param format The requested Gst::Format.
* @param position The position to set.
*/
void set(Format format, gint64 position);
/** Parse a position query, writing the format into format, and the position
* into @a position. Use the other parse() methods for parsing individual
* values.
* @param format The storage for the Gst::Format of the position values.
* @param position The storage for the current position.
*/
void parse(Format& format, gint64& position) const;
/** Parse the position of a position query, returning the position.
* @return The current position of the position query.
*/
gint64 parse() const;
/** Parse the format of a position query, returning the format.
* @return The the Gst::Format of the position values.
*/
Format parse_format() const;
};
/** A stream duration query object. See create() for more details.
*/
class QueryDuration : public Query
{
public:
/** Constructs a new stream duration query object to query in the given
* format. A duration query will give the total length of the stream.
* @param format The Gst::Format for this duration query.
* @return The new Gst::QueryDuration.
*/
static Glib::RefPtr<Gst::QueryDuration> create(Format format);
/** Answer a duration query by setting the requested value in the given
* format.
* @param format The Gst::Format for the duration.
* @param duration The duration of the stream.
*/
void set(Format format, gint64 duration);
/** Parse a duration query answer. Write the format of the duration into
* @a format, and the value into @a duration. Use the other parse() methods
* for parsing individual values.
* @param format The storage for the Gst::Format of the duration value.
* @param duration The storage for the total duration.
*/
void parse(Format& format, gint64& duration) const;
/** Parse a duration query answer, returning the duration.
* @return The total duration.
*/
gint64 parse() const;
/** Parse a duration query answer, returning the format of the duration.
* @return The Gst::Format of the duration value.
*/
Format parse_format() const;
};
/** A latency query object. See create() for more details.
*/
class QueryLatency : public Query
{
public:
/** Constructs a new latency query object. A latency query is usually
* performed by sinks to compensate for additional latency introduced by
* elements in the pipeline.
* @return The new Gst::QueryLatency.
*/
static Glib::RefPtr<Gst::QueryLatency> create();
/** Answer a latency query by setting the requested values in the given
* format.
* @param live If there is a live element upstream.
* @param min_latency The minimal latency of the live element.
* @param max_latency The maximal latency of the live element.
*/
void set(bool live, ClockTime min_latency, ClockTime max_latency);
/** Parse a latency query answer. Use the other parse() methods for parsing
* individual values.
* @param live Storage for live.
* @param min_latency The storage for the min latency.
* @param max_latency The storage for the max latency.
*/
void parse(bool& live, ClockTime& min_latency, ClockTime& max_latency) const;
/** Parse a latency query answer, returning the live status.
* @return the live satus.
*/
bool parse_live() const;
/** Parse a latency query answer, returning the minimum latency.
* @return The minimum latency.
*/
ClockTime parse_min() const;
/** Parse a latency query answer, returning the maximum latency.
* @return The maximum latency.
*/
ClockTime parse_max() const;
};
/** A seeking query object. See create() for more details.
*/
class QuerySeeking : public Query
{
public:
/** Constructs a new query object for querying seeking properties of the
* stream.
* @param format The default Gst::Format for the new query.
* @return The new Gst::QuerySeeking.
*/
static Glib::RefPtr<Gst::QuerySeeking> create(Format format);
/** Set the seeking query result fields in query.
* @param format The format to set for @a the segment_start and
* @a segment_end values.
* @param seekable The seekable flag to set.
* @param segment_start The segment_start to set.
* @param segment_end The segment_end to set.
*/
void set(Format format, bool seeakable, gint64 segment_start, gint64 segment_end);
/** Parse a seeking query, writing the format into format, and other results
* into the passed parameters. Use the other parse() methods for parsing
* individual values.
* @param format The storage location for the foramt.
* @param seekable The storage location for the seekable flag.
* @param segment_start The storage location for the segment start value.
* @param segment_end The storage location for the segment end.
*/
void parse(Format& format, bool& seekable, gint64& segment_start, gint64& segment_end) const;
/** Parse a seeking query, returning the format.
* @return The format.
*/
Format parse_format() const;
/** Parse a seeking query, returning the seekable status.
* @return The seekable flag.
*/
bool parse_seekable() const;
/** Parse a seeking query, returning the segment start value.
* @return The segment start.
*/
gint64 parse_start() const;
/** Parse a seeking query, returning the segment end value.
* @return The segment end.
*/
gint64 parse_end() const;
};
/** A formats query object. See create() for more details.
*/
class QueryFormats : public Query
{
public:
/** Constructs a new query object for querying formats of the stream.
* @return The new Gst::QueryFormats.
*/
static Glib::RefPtr<Gst::QueryFormats> create();
/** Set the formats query result fields. All the formats in the array are
* used.
* @param formats An array containing Gst::Format values.
*/
void set(const Glib::ArrayHandle<Format>& formats);
/** Set the formats query result fields using only @a n_formats from @a
* formats. The number of formats passed in the formats array must be
* greater than or equal to @a n_formats.
* @param n_formats The number of formats to set.
* @param formats An array containing at least @a n_formats Gst::Format
* values.
*/
void set(int n_formats, const Glib::ArrayHandle<Format>& formats);
/** Parse and return the number of formats in the formats query.
* @return The number of formats in this query.
*/
guint parse_length() const;
/** Parse the format query and return the @a nth format from it. If the list
* contains less elements than @a nth, Gst::FORMAT_UNDEFINED will be
* returned.
* @param nth The index of the format to return.
* @return the @a nth format or Gst::FORMAT_UNDEFINED.
*/
Format parse(guint nth) const;
};
/** A new segment query object. See create() for more details.
*/
class QuerySegment : public Query
{
public:
/** Constructs a new segment query object. A segment query is used to
* discover information about the currently configured segment for playback.
* @param format The Gst::Format for the new query.
* @return The new Gst::QuerySegment.
*/
static Glib::RefPtr<Gst::QuerySegment> create(Format format);
/** Answer a segment query by setting the requested values. The normal
* playback segment of a pipeline is 0 to duration at the default rate of
* 1.0. If a seek was performed on the pipeline to play a different segment,
* this query will return the range specified in the last seek.
*
* @a start_value and @a stop_value will respectively contain the configured
* playback range start and stop values expressed in @a format. The values
* are always between 0 and the duration of the media and @a start_value <=
* @a stop_value. @a rate will contain the playback rate. For negative
* rates, playback will actually happen from @a stop_value to @a start_value.
*
* @param rate The rate of the segment.
* @param format The Gst::Format of the segment values (@a start_value and
* @a stop_value).
* @param start_value The start value.
* @param stop_value The stop value.
*/
void set(double rate, Format format, gint64 start_value, gint64 stop_value);
/** Parse a segment query answer. See set() for an explanation of the
* function arguments. Use the other parse() methods to parse individual
* values.
*
* @param rate The storage for the rate of the segment.
* @param format The storage for the Gst::Format of the values.
* @param start_value The storage for the start value.
* @param stop_value The storage for the stop value.
*/
void parse(double& rate, Format& format, gint64& start_value, gint64& stop_value) const;
/** Parse a segment query answer, returning the rate. See set() for an
* explanation of the function arguments.
* @return The rate of the segment.
*/
double parse_rate() const;
/** Parse a segment query answer, returning the format. See set() for an
* explanation of the function arguments.
* @return The Gst::Format of the start and stop values.
*/
Format parse_format() const;
/** Parse a segment query answer, returning the start value. See set() for
* an explanation of the function arguments.
* @return The start value.
*/
gint64 parse_start() const;
/** Parse a segment query answer, returning the stop value. See set() for
* an explanation of the function arguments.
* @return The stop value.
*/
gint64 parse_stop() const;
};
/** A new buffering query object. See create() for more details.
*/
class QueryBuffering : public Query
{
public:
/** Constructs a new query object for querying the buffering status of a
* stream.
* @param format The default Gst::Format for the new query.
* @return The new Gst::QueryBuffering.
*/
static Glib::RefPtr<Gst::QueryBuffering> create(Format format);
/** Set the percentage of buffered data. This is a value between 0 and 100.
* The @a busy indicator is true when the buffering is in progress.
* @param busy If buffering is busy.
* @param percent A buffering percent.
*/
void set(bool busy, int percent);
/** Get the busy flag and percentage of the buffered data. The percent is a
* value between 0 and 100. The busy indicator is true when the buffering
* is in progress. Use the other parse() methods to parse individual
* values.
* @param busy The location to store the buffering busy flag.
* @param percent The location to store the buffering percent.
*/
void parse(bool& busy, int& percent) const;
/** Get the busy flag of the buffered data. The busy indicator is true when
* the buffering is in progress.
* @return The buffering busy flag.
*/
bool parse_busy() const;
/** Get the percentage of the buffered data. The percent is a value between
* 0 and 100.
* @return The buffering percent.
*/
int parse_percent() const;
/** Configures the buffering stats values in query.
* @param mode A buffering mode.
* @param avg_in The average input rate.
* @param avg_out The average output rate.
* @param buffering_left Amount of buffering time left.
*/
void set(BufferingMode mode, int avg_in, int avg_out, gint64 buffering_left);
/** Extracts the buffering stats values from the query. Use the other
* parse() methods to parse individual values.
* @param mode The location to store the buffering mode.
* @param avg_in The location to store the average input rate.
* @param avg_out The location to store the average output rate.
* @param buffering_left The location to store the amount of buffering time
* left.
*/
void parse(BufferingMode& mode, int& avg_in, int& avg_out, gint64 buffering_left) const;
/** Extracts the buffering mode from the query.
* @return The the buffering mode.
*/
BufferingMode parse_mode() const;
/** Extracts the average input rate from the query.
* @return The average input rate.
*/
int parse_input_rate() const;
/** Extracts the average output rate from the query.
* @return The average output rate.
*/
int parse_output_rate() const;
/** Extracts the buffering time left from the query.
* @return The the amount of buffering time left.
*/
gint64 parse_time_left() const;
/** Set the available query result fields in query.
* @param format The format to set for the start and stop values.
* @param start The start to set.
* @param stop The stop to set.
* @param estimated_total Estimated total amount of download time.
*/
void set(Format format, gint64 start, gint64 stop, gint64 estimated_total);
/** Parse the query, writing the format into format, and other
* results into the passed parameters. Use the other parse() methods to
* parse individual values.
* @param format The location to store the format.
* @param start The location to store the start.
* @param stop The location to store the stop.
* @param estimated_total The location to store the estimated total amount
* of download time.
*/
void parse(Format& format, gint64& start, gint64& stop, gint64& estimated_total) const;
/** Parse the query, returning the format.
* @return The format.
*/
Format parse_format() const;
/** Parse the query, returning the start range value.
* @return The start value.
*/
gint64 parse_start() const;
/** Parse the query, returning the stop range value.
* @return The stop value.
*/
gint64 parse_stop() const;
/** Parse the query, returning the estimated total amount of download time.
* @return The estimated total amount of download time.
*/
gint64 parse_total_time() const;
/** Retrieve the number of values currently stored in the
* buffered-ranges array of the query's structure.
* @return the range array size as a guint.
*/
guint get_n_buffering_ranges() const;
/** Set the buffering-ranges array field in @query. The current last
* start position of the array should be inferior to @start.
* @param start start position of the range.
* @param stop stop position of the range.
* @return a bool indicating if the range was added or not.
*/
bool add_buffering_range(gint64 start, gint64 stop);
/** Parse an available query and get the start and stop values stored
* at the @index of the buffered ranges array.
* @param index position in the buffered-ranges array to read.
* @param start the start position to set, or NULL.
* @param stop the stop position to set, or NULL.
* @return a bool indicating if the parsing succeeded.
*/
bool parse_nth_buffering_range(guint index, gint64& start, gint64& stop) const;
};
/** A new caps query object. See create() for more details.
*/
class QueryCaps : public Query
{
public:
/** Constructs a new query object for querying the caps.
*
* The CAPS query should return the allowable caps for a pad in the context
* of the element's state, its link to other elements, and the devices or files
* it has opened. These caps must be a subset of the pad template caps. In the
* NULL state with no links, the CAPS query should ideally return the same caps
* as the pad template. In rare circumstances, an object property can affect
* the caps returned by the CAPS query, but this is discouraged.
* For most filters, the caps returned by CAPS query is directly affected by the
* allowed caps on other pads. For demuxers and decoders, the caps returned by
* the srcpad's getcaps function is directly related to the stream data. Again,
* the CAPS query should return the most specific caps it reasonably can, since this
* helps with autoplugging.
*
* The @filter is used to restrict the result caps, only the caps matching
* @filter should be returned from the CAPS query. Specifying a filter might
* greatly reduce the amount of processing an element needs to do.
* @param filter a filter.
* @return The new Gst::QureyCaps.
*/
static Glib::RefPtr<Gst::QueryCaps>
create(const Glib::RefPtr<Gst::Caps>& filter);
/** Get the filter from the caps @query. The caps remains valid as long as
* @query remains valid.
* @return caps filter.
*/
Glib::RefPtr<Gst::Caps> parse() const;
/** Get the caps result from @query. The caps remains valid as long as
* @query remains valid.
* @return a pointer to the caps.
*/
Glib::RefPtr<Gst::Caps> parse_caps_result() const;
/** Set the @caps result in @query.
* @param caps a pointer to the caps.
*/
void set_caps_result(const Glib::RefPtr<Gst::Caps>& caps);
};
/** A new scheduling query object. See create() for more details.
*/
class QueryScheduling : public Query
{
public:
/** Constructs a new query object for querying the scheduling properties.
* @return A new Gst::QueryScheduling.
*/
static Glib::RefPtr<Gst::QueryScheduling>
create();
/** Set the scheduling properties.
* @param flags Gst::SchedulingFlags.
* @param minsize the suggested minimum size of pull requests.
* @param maxsize the suggested maximum size of pull requests.
* @param align the suggested alignment of pull requests.
*/
void parse(Gst::SchedulingFlags& flags, gint& minsize, gint& maxsize, gint& align) const;
/** Set the scheduling properties.
* @param flags Gst::SchedulingFlags.
* @param minsize the suggested minimum size of pull requests.
* @param maxsize the suggested maximum size of pull requests.
* @param align the suggested alignment of pull requests.
*/
void set(Gst::SchedulingFlags flags, gint minsize, gint maxsize, gint align);
/** Add @mode as aone of the supported scheduling modes to @query.
* @param a Gst::PadMode.
*/
void add_scheduling_mode(Gst::PadMode mode);
/** Retrieve the number of values currently stored in the
* scheduling mode array of the query's structure.
* @return the scheduling mode array size as a @guint.
*/
guint get_n_scheduling_modes() const;
/** Parse an available query and get the scheduling mode
* at @index of the scheduling modes array.
* @param index position in the scheduling modes array to read
* @return a Gst::PadMode of the scheduling mode at @index.
*/
Gst::PadMode parse_nth_scheduling_mode(guint index) const;
/** Check if @query has scheduling mode set.
* @param mode the scheduling mode.
* @return true when @mode is in the list of scheduling modes.
*/
bool has_scheduling_mode(Gst::PadMode mode) const;
/** Check if @query has scheduling mode set and @flags is set in
* query scheduling flags.
* @param mode the scheduling mode.
* @param flags Gst::SchedulingFlags.
*/
bool has_scheduling_mode_with_flags(Gst::PadMode mode, Gst::SchedulingFlags flags) const;
};
/** A new scheduling query object. See create() for more details.
*/
class QueryAllocation : public Query
{
public:
/** Constructs a new query object for querying the allocation properties.
* @param caps the negotiated caps.
* @param need_pool return a pool.
* @return a new Gst::Query.
*/
static Glib::RefPtr<Gst::QueryAllocation>
create(const Glib::RefPtr<Gst::Caps>& caps, bool need_pool);
/** Parse an allocation query, writing the requested caps in @caps and
* whether a pool is needed in @need_pool, if the respective parameters
* are non-NULL.
* @param caps the Gst::Caps.
* @param need_pool whether a Gst::BufferPool is needed.
*/
void parse(Glib::RefPtr<Gst::Caps>& caps, bool& need_pool) const;
/** Retrieve the number of values currently stored in the
* pool array of the query's structure.
* @return the pool array size as a guint.
*/
guint get_n_allocation_pools() const;
/** Remove the allocation pool at @index of the allocation pool array.
* @param index position in the allocation pool array to remove.
*/
void remove_nth_allocation_pool(guint index);
/** Add @allocator and its @params as a supported memory allocator.
* @param allocator the memory allocator.
* @param params a Gst::AllocationParams.
*/
void add_allocation_param(const Glib::RefPtr<Gst::Allocator>& allocator, const Gst::AllocationParams& params);
/** Retrieve the number of values currently stored in the
* allocator params array of the query's structure.
*
* If no memory allocator is specified, the downstream element can handle
* the default memory allocator. The first memory allocator in the query
* should be generic and allow mapping to system memory, all following
* allocators should be ordered by preference with the preferred one first.
* @return the allocator array size as guint.
*/
guint get_n_allocation_params() const;
/** Parse an available query and get the alloctor and its params
* at @index of the allocator array.
* @param index position in the allocator array to read.
* @param allocator variable to hold the result.
* @param params parameters for the allocator.
*/
void parse_nth_allocation_param(guint index, Glib::RefPtr<Gst::Allocator>& allocator, Gst::AllocationParams& params) const;
/** Parse an available query and get the alloctor and its params
* at @index of the allocator array.
* @param index position in the allocator array to set.
* @param allocator new allocator to set.
* @param params parameters for the allocator.
*/
void set_nth_allocation_param(guint index, const Glib::RefPtr<Gst::Allocator>& allocator, const Gst::AllocationParams& params);
/** Remove the allocation param at @index of the allocation param array.
* @param index position in the allocation param array to remove
*/
void remove_nth_allocation_param(guint index);
/** Add @api with @params as one of the supported metadata API to @query.
* @param api the metadata API.
* @param params API specific parameters.
*/
void add_allocation_meta(GType api, const Gst::Structure& params);
/** Retrieve the number of values currently stored in the
* meta API array of the query's structure.
* @return the metadata API array size as a guint.
*/
guint get_n_allocation_metas() const;
/** Parse an available query and get the metadata API
* at @index of the metadata API array.
* @param index position in the metadata API array to read.
* @param params API specific flags.
*/
GType parse_nth_allocation_meta(guint index, Gst::Structure& params) const;
/** Remove the metadata API at @index of the metadata API array.
* @param index positon in the metadata API array to remove.
*/
void remove_nth_allocation_meta(guint index);
/** Check if @query has metadata @api set. When this function returns TRUE,
* @index will contain the index where the requested API and the flags can be
* found.
* @param api the metadata API.
* @param index the index
* @return true when @api is in the list of metadata.
*/
bool find_allocation_meta(GType api, guint& index) const;
};
/** A new uri query object. See create() for more details.
*/
class QueryUri : public Query
{
public:
/** Constructs a new query URI query object. Use gst_query_unref()
* when done with it. An URI query is used to query the current URI
* that is used by the source or sink.
* @return a new Gst::Query.
*/
static Glib::RefPtr<Gst::QueryUri> create();
/** Parse an URI query, writing the URI into @uri as a newly
* allocated string, if the respective parameters are non-NULL.
* Free the string with g_free() after usage.
* @return the storage for the current URI.
*/
Glib::ustring parse() const;
/** Answer a URI query by setting the requested URI.
* @param uri the URI to set.
*/
void set(const Glib::ustring& uri);
/** Answer a URI query by setting the requested URI redirection.
* @param uri the URI to set.
*/
void set_uri_redirection(const Glib::ustring& uri);
/** Parse an URI query, return URI, if the respective parameters.
* @return the storage for the redirect URI (may be empty).
*/
Glib::ustring parse_uri_redirection() const;
};
/** A new accept caps query object. See create() for more details.
*/
class QueryAcceptCaps : public Query
{
public:
/** Constructs a new query object for querying if @caps are accepted.
* @return a new Gst::Query.
*/
static Glib::RefPtr<Gst::QueryAcceptCaps> create(const Glib::RefPtr<Gst::Caps>& caps);
/** Get the caps from @query. The caps remains valid as long as @query remains
* valid.
* @return a caps.
*/
Glib::RefPtr<Gst::Caps> parse_accept_caps() const;
/** Parse the result from @query and store in @result.
* @return location for the result.
*/
bool parse_accept_caps_result() const;
/** Set @result as the result for the @query.
* @param result the result to set.
*/
void set_accept_caps_result(bool result);
};
} //namespace Gst
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gst::Query
*/
Glib::RefPtr<Gst::Query> wrap(GstQuery* object, bool take_copy = false);
} // namespace Glib
#endif /* _GSTREAMERMM_QUERY_H */
|