/usr/include/ccrtp/rtp.h is in libccrtp-dev 2.0.9-2.2+b2.
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 | // Copyright (C) 1999-2005 Open Source Telecom Corporation.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free software
// library without restriction. Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License. This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// ccRTP. If you copy code from other releases into a copy of GNU
// ccRTP, as the General Public License permits, the exception does
// not apply to the code that you add in this way. To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU ccRTP, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//
/**
* @file rtp.h
*
* @short Generic and audio/video profile specific RTP interface of
* ccRTP.
*
* The classes and types in this header provide general RTP
* functionality (following RFC 3550) as well as audio/video RTP
* profile specific functionality (following RFC 3551).
**/
#ifndef CCXX_RTP_RTP_H_
#define CCXX_RTP_RTP_H_
#include <ccrtp/cqueue.h>
#include <ccrtp/channel.h>
NAMESPACE_COMMONCPP
/**
* @defgroup sessions RTP sessions.
* @{
**/
/**
* @class RTPSessionBase
*
* Generic RTP protocol stack for exchange of realtime data. This
* stack uses the concept of packet send and receive queues to schedule
* and buffer outgoing packets and to arrange or reorder incoming packets
* as they arrive.
*
* This is a template class that allows customization of two aspects:
* the underlying network and the control protocol. The RTPDataChannel
* and RTCPChannel template parameters specify the socket types to
* use. The ServiceQueue template parameter specify which packet queue
* is used.
*
* RTPSessionBase objects do not have any threading policy, thus
* allowing to customize this aspect in derived classes (see
* SingleThreadRTPSession or RTPSessionPoolBase).
*
* @author David Sugar <dyfet@ostel.com>
* @short RTP protocol stack based on Common C++.
**/
template <class RTPDataChannel = DualRTPUDPIPv4Channel,
class RTCPChannel = DualRTPUDPIPv4Channel,
class ServiceQueue = AVPQueue>
class __EXPORT TRTPSessionBase : public ServiceQueue
{
public:
/**
* Builds a session waiting for packets in a host address.
*
* @param ia Network address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
* */
TRTPSessionBase(const InetHostAddress& ia, tpport_t dataPort,
tpport_t controlPort, uint32 membersSize,
RTPApplication& app) :
ServiceQueue(membersSize,app)
{ build(ia,dataPort,controlPort); }
/**
* Builds a session with the specified ssrc identifier for the
* local source.
*
* @param ssrc SSRC identifier for the local source.
* @param ia Network address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
**/
TRTPSessionBase(uint32 ssrc,
const InetHostAddress& ia,
tpport_t dataPort, tpport_t controlPort,
uint32 membersSize, RTPApplication& app):
ServiceQueue(ssrc,membersSize,app)
{ build(ia,dataPort,controlPort); }
/**
* Builds a session waiting for packets in a multicast address.
* TODO: ssrc constructor for multicast!
*
* @param ia Multicast address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
* @param iface Index (from 0 to n) of network interface to join to
* multicast group.
**/
TRTPSessionBase(const InetMcastAddress& ia, tpport_t dataPort,
tpport_t controlPort, uint32 membersSize,
RTPApplication& app, uint32 iface) :
ServiceQueue(membersSize,app)
{ build(ia,dataPort,controlPort,iface); }
/**
* Builds a session waiting for packets in a multicast
* address, with the specified ssrc identifier for the local
* source.
*
* @param ssrc SSRC identifier for the local source.
* @param ia Multicast address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
* @param iface Index (from 0 to n) of network interface to join to
* multicast group.
**/
TRTPSessionBase(uint32 ssrc,
const InetMcastAddress& ia, tpport_t dataPort,
tpport_t controlPort, uint32 membersSize,
RTPApplication& app, uint32 iface) :
ServiceQueue(ssrc,membersSize,app)
{ build(ia,dataPort,controlPort,iface); }
virtual size_t dispatchBYE(const std::string &str)
{
return QueueRTCPManager::dispatchBYE(str);
}
/**
* Set the value of the TTL field in the sent packets.
*
* @param ttl Time To Live
* @return error code from the socket operation
*/
inline Socket::Error
setMcastTTL(uint8 ttl)
{
Socket::Error error = dso->setMulticast(true);
if ( error ) return error;
error = dso->setTimeToLive(ttl);
if ( error ) return error;
error = cso->setMulticast(true);
if ( error ) return error;
return cso->setTimeToLive(ttl);
}
inline virtual
~TRTPSessionBase()
{
endSocket();
}
inline RTPDataChannel *getDSO(void)
{return dso;}
protected:
/**
* @param timeout maximum timeout to wait, in microseconds
*/
inline bool
isPendingData(microtimeout_t timeout)
{ return dso->isPendingRecv(timeout); }
InetHostAddress
getDataSender(tpport_t *port = NULL) const
{ return dso->getSender(port); }
inline size_t
getNextDataPacketSize() const
{ return dso->getNextPacketSize(); }
/**
* Receive data from the data channel/socket.
*
* @param buffer Memory region to read to.
* @param len Maximum number of octets to get.
* @param na Source network address.
* @param tp Source transport port.
* @return Number of octets actually read.
*/
inline size_t
recvData(unsigned char* buffer, size_t len,
InetHostAddress& na, tpport_t& tp)
{ na = dso->getSender(tp); return dso->recv(buffer, len); }
inline void
setDataPeer(const InetAddress &host, tpport_t port)
{ dso->setPeer(host,port); }
/**
* @param buffer memory region to write from
* @param len number of octets to write
*/
inline size_t
sendData(const unsigned char* const buffer, size_t len)
{ return dso->send(buffer, len); }
inline SOCKET getDataRecvSocket() const
{ return dso->getRecvSocket(); }
/**
* @param timeout maximum timeout to wait, in microseconds
* @return whether there are packets waiting to be picked
*/
inline bool
isPendingControl(microtimeout_t timeout)
{ return cso->isPendingRecv(timeout); }
InetHostAddress
getControlSender(tpport_t *port = NULL) const
{ return cso->getSender(port); }
/**
* Receive data from the control channel/socket.
*
* @param buffer Buffer where to get data.
* @param len Maximum number of octets to get.
* @param na Source network address.
* @param tp Source transport port.
* @return Number of octets actually read.
**/
inline size_t
recvControl(unsigned char *buffer, size_t len,
InetHostAddress& na, tpport_t& tp)
{ na = cso->getSender(tp); return cso->recv(buffer,len); }
inline void
setControlPeer(const InetAddress &host, tpport_t port)
{ cso->setPeer(host,port); }
/**
* @return number of octets actually written
* @param buffer
* @param len
*/
inline size_t
sendControl(const unsigned char* const buffer, size_t len)
{ return cso->send(buffer,len); }
inline SOCKET getControlRecvSocket() const
{ return cso->getRecvSocket(); }
/**
* Join a multicast group.
*
* @param ia address of the multicast group
* @return error code from the socket operation
*/
inline Socket::Error
joinGroup(const InetMcastAddress& ia, uint32 iface)
{
Socket::Error error = dso->setMulticast(true);
if ( error ) return error;
error = dso->join(ia,iface);
if ( error ) return error;
error = cso->setMulticast(true);
if ( error ) {
dso->drop(ia);
return error;
}
error = cso->join(ia,iface);
if ( error ) {
dso->drop(ia);
return error;
}
return Socket::errSuccess;
}
/**
* Leave a multicast group.
*
* @param ia address of the multicast group
* @return error code from the socket operation
*/
inline Socket::Error
leaveGroup(const InetMcastAddress& ia)
{
Socket::Error error = dso->setMulticast(false);
if ( error ) return error;
error = dso->leaveGroup(ia);
if ( error ) return error;
error = cso->setMulticast(false);
if ( error ) return error;
return cso->leaveGroup(ia);
}
inline void
endSocket()
{
if (dso) {
dso->endSocket();
delete dso;
}
dso = NULL;
if (cso) {
cso->endSocket();
delete cso;
}
cso = NULL;
}
private:
void
build(const InetHostAddress& ia, tpport_t dataPort,
tpport_t controlPort)
{
if ( 0 == controlPort ) {
dataBasePort = even_port(dataPort);
controlBasePort = dataBasePort + 1;
} else {
dataBasePort = dataPort;
controlBasePort = controlPort;
}
dso = new RTPDataChannel(ia,dataBasePort);
cso = new RTCPChannel(ia,controlBasePort);
}
void
build(const InetMcastAddress& ia, tpport_t dataPort,
tpport_t controlPort, uint32 iface)
{
if ( 0 == controlPort ) {
dataBasePort = even_port(dataPort);
controlBasePort = dataBasePort + 1;
} else {
dataBasePort = dataPort;
controlBasePort = controlPort;
}
dso = new RTPDataChannel(InetHostAddress("0.0.0.0"),dataBasePort);
cso = new RTCPChannel(InetHostAddress("0.0.0.0"),controlBasePort);
joinGroup(ia,iface);
}
/**
* Ensure a port number is odd. If it is an even number, return
* the next lower (odd) port number.
*
* @param port number to filter
* @return filtered (odd) port number
*/
inline tpport_t
odd_port(tpport_t port)
{ return (port & 0x01)? (port) : (port - 1); }
/**
* Ensure a port number is even. If it is an odd number, return
* the next lower (even) port number.
*
* @param port number to filter
* @return filtered (even) port number
*/
inline tpport_t
even_port(tpport_t port)
{ return (port & 0x01)? (port - 1) : (port); }
tpport_t dataBasePort;
tpport_t controlBasePort;
protected:
RTPDataChannel* dso;
RTCPChannel* cso;
friend class RTPSessionBaseHandler;
};
/**
* @class SingleThreadRTPSession
*
* This template class adds the threading aspect to the RTPSessionBase
* template in one of the many possible ways. It inherits from a
* single execution thread that schedules sending of outgoing packets
* and receipt of incoming packets.
*
* @author Federico Montesino Pouzols <fedemp@altern.org>
**/
template
<class RTPDataChannel = DualRTPUDPIPv4Channel,
class RTCPChannel = DualRTPUDPIPv4Channel,
class ServiceQueue = AVPQueue>
class __EXPORT SingleThreadRTPSession :
protected Thread,
public TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>
{
public:
SingleThreadRTPSession(const InetHostAddress& ia,
tpport_t dataPort = DefaultRTPDataPort,
tpport_t controlPort = 0,
int pri = 0,
uint32 memberssize =
MembershipBookkeeping::defaultMembersHashSize,
RTPApplication& app = defaultApplication()
#if defined(_MSC_VER) && _MSC_VER >= 1300
);
#else
):
Thread(pri),
TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>
(ia,dataPort,controlPort,memberssize,app)
{ }
#endif
SingleThreadRTPSession(uint32 ssrc, const InetHostAddress& ia,
tpport_t dataPort = DefaultRTPDataPort,
tpport_t controlPort = 0,
int pri = 0,
uint32 memberssize =
MembershipBookkeeping::defaultMembersHashSize,
RTPApplication& app = defaultApplication()
#if defined(_MSC_VER) && _MSC_VER >= 1300
);
#else
):
Thread(pri),
TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>
(ssrc, ia,dataPort,controlPort,memberssize,app)
{ }
#endif
SingleThreadRTPSession(const InetMcastAddress& ia,
tpport_t dataPort = DefaultRTPDataPort,
tpport_t controlPort = 0,
int pri = 0,
uint32 memberssize =
MembershipBookkeeping::defaultMembersHashSize,
RTPApplication& app = defaultApplication(),
uint32 iface = 0
#if defined(_MSC_VER) && _MSC_VER >= 1300
);
#else
):
Thread(pri),
TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>
(ia,dataPort,controlPort,memberssize,app,iface)
{ }
#endif
SingleThreadRTPSession(uint32 ssrc, const InetMcastAddress& ia,
tpport_t dataPort = DefaultRTPDataPort,
tpport_t controlPort = 0,
int pri = 0,
uint32 memberssize =
MembershipBookkeeping::defaultMembersHashSize,
RTPApplication& app = defaultApplication(),
uint32 iface = 0
#if defined(_MSC_VER) && _MSC_VER >= 1300
);
#else
):
Thread(pri),
TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>
(ssrc,ia,dataPort,controlPort,memberssize,app,iface)
{ }
#endif
~SingleThreadRTPSession()
{
if (isRunning()) {
disableStack(); Thread::join();
}
}
#if defined(_MSC_VER) && _MSC_VER >= 1300
virtual void startRunning();
#else
/**
* Activate stack and start service thread.
**/
void
startRunning()
{ enableStack(); Thread::start(); }
#endif
protected:
inline void disableStack(void)
{TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::disableStack();}
inline void enableStack(void)
{TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::enableStack();}
inline microtimeout_t getSchedulingTimeout(void)
{return TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::getSchedulingTimeout();}
inline void controlReceptionService(void)
{TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::controlReceptionService();}
inline void controlTransmissionService(void)
{TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::controlTransmissionService();}
inline timeval getRTCPCheckInterval(void)
{return TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::getRTCPCheckInterval();}
inline size_t dispatchDataPacket(void)
{return TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::dispatchDataPacket();}
#if defined(_MSC_VER) && _MSC_VER >= 1300
virtual void run(void);
virtual void timerTick(void);
virtual bool isPendingData(microtimeout_t timeout);
#else
virtual void timerTick(void)
{return;}
virtual bool isPendingData(microtimeout_t timeout)
{return TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::isPendingData(timeout);}
/**
* Single runnable method for this RTP stacks, schedules
* outgoing and incoming RTP data and RTCP packets.
**/
virtual void run(void)
{
microtimeout_t timeout = 0;
while ( ServiceQueue::isActive() ) {
if ( timeout < 1000 ){ // !(timeout/1000)
timeout = getSchedulingTimeout();
}
controlReceptionService();
controlTransmissionService();
microtimeout_t maxWait =
timeval2microtimeout(getRTCPCheckInterval());
// make sure the scheduling timeout is
// <= the check interval for RTCP
// packets
timeout = (timeout > maxWait)? maxWait : timeout;
if ( timeout < 1000 ) { // !(timeout/1000)
dispatchDataPacket();
timerTick();
} else {
if ( isPendingData(timeout/1000) ) {
if (ServiceQueue::isActive()) { // take in only if active
takeInDataPacket();
}
}
timeout = 0;
}
}
dispatchBYE("GNU ccRTP stack finishing.");
// Thread::exit();
}
#endif
inline size_t takeInDataPacket(void)
{return TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::takeInDataPacket();}
inline size_t dispatchBYE(const std::string &str)
{return TRTPSessionBase<RTPDataChannel,RTCPChannel,ServiceQueue>::dispatchBYE(str);}
};
/**
* @typedef RTPSession
*
* Uses two pairs of sockets for RTP data and RTCP
* transmission/reception.
*
* @short UDP/IPv4 RTP Session scheduled by one thread of execution.
**/
typedef SingleThreadRTPSession<> RTPSession;
/**
* @typedef RTPSocket
*
* Alias for RTPSession.
**/
typedef RTPSession RTPSocket;
/**
* @typedef SymmetricRTPSession
*
* Uses one pair of sockets, (1) for RTP data and (2) for RTCP
* transmission/reception.
*
* @short Symmetric UDP/IPv4 RTP session scheduled by one thread of execution.
**/
typedef SingleThreadRTPSession<SymmetricRTPChannel,
SymmetricRTPChannel> SymmetricRTPSession;
#ifdef CCXX_IPV6
/**
* @class RTPSessionBaseIPV6
*
* Generic RTP protocol stack for exchange of realtime data. This
* stack uses the concept of packet send and receive queues to schedule
* and buffer outgoing packets and to arrange or reorder incoming packets
* as they arrive.
*
* This is a template class that allows customization of two aspects:
* the underlying network and the control protocol. The RTPDataChannel
* and RTCPChannel template parameters specify the socket types to
* use. The ServiceQueue template parameter specify which packet queue
* is used.
*
* RTPSessionBase objects do not have any threading policy, thus
* allowing to customize this aspect in derived classes (see
* SingleThreadRTPSession or RTPSessionPoolBase).
*
* @author David Sugar <dyfet@ostel.com>
* @short RTP protocol stack based on Common C++.
**/
template <class RTPDataChannel = DualRTPUDPIPv6Channel,
class RTCPChannel = DualRTPUDPIPv6Channel,
class ServiceQueue = AVPQueue>
class __EXPORT TRTPSessionBaseIPV6 : public ServiceQueue
{
public:
/**
* Builds a session waiting for packets in a host address.
*
* @param ia Network address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
* */
TRTPSessionBaseIPV6(const IPV6Host& ia, tpport_t dataPort,
tpport_t controlPort, uint32 membersSize,
RTPApplication& app) :
ServiceQueue(membersSize,app)
{ build(ia,dataPort,controlPort); }
/**
* Builds a session with the specified ssrc identifier for the
* local source.
*
* @param ssrc SSRC identifier for the local source.
* @param ia Network address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
**/
TRTPSessionBaseIPV6(uint32 ssrc,
const IPV6Host& ia,
tpport_t dataPort, tpport_t controlPort,
uint32 membersSize, RTPApplication& app):
ServiceQueue(ssrc,membersSize,app)
{ build(ia,dataPort,controlPort); }
/**
* Builds a session waiting for packets in a multicast address.
* TODO: ssrc constructor for multicast!
*
* @param ia Multicast address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
* @param iface Index (from 0 to n) of network interface to join to
* multicast group.
**/
TRTPSessionBaseIPV6(const IPV6Multicast& ia, tpport_t dataPort,
tpport_t controlPort, uint32 membersSize,
RTPApplication& app, uint32 iface) :
ServiceQueue(membersSize,app)
{ build(ia,dataPort,controlPort,iface); }
/**
* Builds a session waiting for packets in a multicast
* address, with the specified ssrc identifier for the local
* source.
*
* @param ssrc SSRC identifier for the local source.
* @param ia Multicast address this socket is to be bound.
* @param dataPort Transport port the data socket is to be bound.
* @param controlPort Transport port the control socket is to be bound.
* @param membersSize Initial size of the membership table.
* @param app Application this session is associated to.
* @param iface Index (from 0 to n) of network interface to join to
* multicast group.
**/
TRTPSessionBaseIPV6(uint32 ssrc,
const IPV6Multicast& ia, tpport_t dataPort,
tpport_t controlPort, uint32 membersSize,
RTPApplication& app, uint32 iface) :
ServiceQueue(ssrc,membersSize,app)
{ build(ia,dataPort,controlPort,iface); }
virtual size_t dispatchBYE(const std::string &str)
{
return QueueRTCPManager::dispatchBYE(str);
}
inline virtual
~TRTPSessionBaseIPV6()
{
endSocket();
}
inline RTPDataChannel *getDSO(void)
{return dso;}
protected:
/**
* @param timeout maximum timeout to wait, in microseconds
*/
inline bool
isPendingData(microtimeout_t timeout)
{ return dso->isPendingRecv(timeout); }
inline IPV6Host
getDataSender(tpport_t *port = NULL) const
{ return dso->getSender(port); }
inline size_t
getNextDataPacketSize() const
{ return dso->getNextPacketSize(); }
/**
* Receive data from the data channel/socket.
*
* @param buffer Memory region to read to.
* @param len Maximum number of octets to get.
* @param na Source network address.
* @param tp Source transport port.
* @return Number of octets actually read.
*/
inline size_t
recvData(unsigned char* buffer, size_t len,
IPV6Host& na, tpport_t& tp)
{ na = dso->getSender(tp); return dso->recv(buffer, len); }
inline void
setDataPeerIPV6(const IPV6Host &host, tpport_t port)
{ dso->setPeer(host,port); }
/**
* @param buffer memory region to write from
* @param len number of octets to write
*/
inline size_t
sendDataIPV6(const unsigned char* const buffer, size_t len)
{ return dso->send(buffer, len); }
inline SOCKET getDataRecvSocket() const
{ return dso->getRecvSocket(); }
/**
* @param timeout maximum timeout to wait, in microseconds
* @return whether there are packets waiting to be picked
*/
inline bool
isPendingControl(microtimeout_t timeout)
{ return cso->isPendingRecv(timeout); }
inline IPV6Host
getControlSender(tpport_t *port = NULL) const
{ return cso->getSender(port); }
/**
* Receive data from the control channel/socket.
*
* @param buffer Buffer where to get data.
* @param len Maximum number of octets to get.
* @param na Source network address.
* @param tp Source transport port.
* @return Number of octets actually read.
**/
inline size_t
recvControl(unsigned char *buffer, size_t len,
IPV6Host& na, tpport_t& tp)
{ na = cso->getSender(tp); return cso->recv(buffer,len); }
inline void
setControlPeerIPV6(const IPV6Host &host, tpport_t port)
{ cso->setPeer(host,port); }
/**
* @return number of octets actually written
* @param buffer
* @param len
*/
inline size_t
sendControl(const unsigned char* const buffer, size_t len)
{ return cso->send(buffer,len); }
inline SOCKET getControlRecvSocket() const
{ return cso->getRecvSocket(); }
inline void
endSocket()
{
dso->endSocket();
cso->endSocket();
if (dso) delete dso;
dso = NULL;
if (cso) delete cso;
cso = NULL;
}
private:
void
build(const IPV6Host& ia, tpport_t dataPort,
tpport_t controlPort)
{
if ( 0 == controlPort ) {
dataBasePort = even_port(dataPort);
controlBasePort = dataBasePort + 1;
} else {
dataBasePort = dataPort;
controlBasePort = controlPort;
}
dso = new RTPDataChannel(ia,dataBasePort);
cso = new RTCPChannel(ia,controlBasePort);
}
void
build(const IPV6Multicast& ia, tpport_t dataPort,
tpport_t controlPort, uint32 iface)
{
if ( 0 == controlPort ) {
dataBasePort = even_port(dataPort);
controlBasePort = dataBasePort + 1;
} else {
dataBasePort = dataPort;
controlBasePort = controlPort;
}
dso = new RTPDataChannel(IPV6Host("0.0.0.0"),dataBasePort);
cso = new RTCPChannel(IPV6Host("0.0.0.0"),controlBasePort);
joinGroup(ia,iface);
}
/**
* Join a multicast group.
*
* @param ia address of the multicast group
* @return error code from the socket operation
*/
inline Socket::Error
joinGroup(const IPV6Multicast& ia, uint32 iface)
{
Socket::Error error = dso->setMulticast(true);
if ( error ) return error;
error = dso->join(ia,iface);
if ( error ) return error;
error = cso->setMulticast(true);
if ( error ) {
dso->drop(ia);
return error;
}
error = cso->join(ia,iface);
if ( error ) {
dso->drop(ia);
return error;
}
return Socket::errSuccess;
}
/**
* Leave a multicast group.
*
* @param ia address of the multicast group
* @return error code from the socket operation
*/
inline Socket::Error
leaveGroup(const IPV6Multicast& ia)
{
Socket::Error error = dso->setMulticast(false);
if ( error ) return error;
error = dso->leaveGroup(ia);
if ( error ) return error;
error = cso->setMulticast(false);
if ( error ) return error;
return cso->leaveGroup(ia);
}
/**
* Set the value of the TTL field in the sent packets.
*
* @param ttl Time To Live
* @return error code from the socket operation
*/
inline Socket::Error
setMcastTTL(uint8 ttl)
{
Socket::Error error = dso->setMulticast(true);
if ( error ) return error;
error = dso->setTimeToLive(ttl);
if ( error ) return error;
error = cso->setMulticast(true);
if ( error ) return error;
return cso->setTimeToLive(ttl);
}
/**
* Ensure a port number is odd. If it is an even number, return
* the next lower (odd) port number.
*
* @param port number to filter
* @return filtered (odd) port number
*/
inline tpport_t
odd_port(tpport_t port)
{ return (port & 0x01)? (port) : (port - 1); }
/**
* Ensure a port number is even. If it is an odd number, return
* the next lower (even) port number.
*
* @param port number to filter
* @return filtered (even) port number
*/
inline tpport_t
even_port(tpport_t port)
{ return (port & 0x01)? (port - 1) : (port); }
tpport_t dataBasePort;
tpport_t controlBasePort;
protected:
RTPDataChannel* dso;
RTCPChannel* cso;
friend class RTPSessionBaseHandler;
};
/**
* @class SingleThreadRTPSessionIPV6
*
* This template class adds the threading aspect to the RTPSessionBase
* template in one of the many possible ways. It inherits from a
* single execution thread that schedules sending of outgoing packets
* and receipt of incoming packets.
*
* @author David Sugar <dyfet@gnutelephony.org>
**/
template
<class RTPDataChannel = DualRTPUDPIPv6Channel,
class RTCPChannel = DualRTPUDPIPv6Channel,
class ServiceQueue = AVPQueue>
class __EXPORT SingleThreadRTPSessionIPV6 :
protected Thread,
public TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>
{
public:
SingleThreadRTPSessionIPV6(const IPV6Host& ia,
tpport_t dataPort = DefaultRTPDataPort,
tpport_t controlPort = 0,
int pri = 0,
uint32 memberssize =
MembershipBookkeeping::defaultMembersHashSize,
RTPApplication& app = defaultApplication()
#if defined(_MSC_VER) && _MSC_VER >= 1300
);
#else
):
Thread(pri),
TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>
(ia,dataPort,controlPort,memberssize,app)
{ }
#endif
SingleThreadRTPSessionIPV6(const IPV6Multicast& ia,
tpport_t dataPort = DefaultRTPDataPort,
tpport_t controlPort = 0,
int pri = 0,
uint32 memberssize =
MembershipBookkeeping::defaultMembersHashSize,
RTPApplication& app = defaultApplication(),
uint32 iface = 0
#if defined(_MSC_VER) && _MSC_VER >= 1300
);
#else
):
Thread(pri),
TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>
(ia,dataPort,controlPort,memberssize,app,iface)
{ }
#endif
~SingleThreadRTPSessionIPV6()
{
if (isRunning()) {
disableStack(); Thread::join();
}
}
#if defined(_MSC_VER) && _MSC_VER >= 1300
virtual void startRunning();
#else
/**
* Activate stack and start service thread.
**/
void
startRunning()
{ enableStack(); Thread::start(); }
#endif
protected:
inline void enableStack(void)
{TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::enableStack();}
inline void disableStack(void)
{TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::disableStack();}
inline microtimeout_t getSchedulingTimeout(void)
{return TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::getSchedulingTimeout();}
inline void controlReceptionService(void)
{TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::controlReceptionService();}
inline void controlTransmissionService(void)
{TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::controlTransmissionService();}
inline timeval getRTCPCheckInterval(void)
{return TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::getRTCPCheckInterval();}
inline size_t dispatchDataPacket(void)
{return TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::dispatchDataPacket();}
#if defined(_MSC_VER) && _MSC_VER >= 1300
virtual void run(void);
virtual void timerTick(void);
virtual bool isPendingData(microtimeout_t timeout);
#else
virtual void timerTick(void)
{return;}
virtual bool isPendingData(microtimeout_t timeout)
{return TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::isPendingData(timeout);}
/**
* Single runnable method for this RTP stacks, schedules
* outgoing and incoming RTP data and RTCP packets.
**/
virtual void run(void)
{
microtimeout_t timeout = 0;
while ( ServiceQueue::isActive() ) {
if ( timeout < 1000 ){ // !(timeout/1000)
timeout = getSchedulingTimeout();
}
controlReceptionService();
controlTransmissionService();
microtimeout_t maxWait =
timeval2microtimeout(getRTCPCheckInterval());
// make sure the scheduling timeout is
// <= the check interval for RTCP
// packets
timeout = (timeout > maxWait)? maxWait : timeout;
if ( timeout < 1000 ) { // !(timeout/1000)
dispatchDataPacket();
timerTick();
} else {
if ( isPendingData(timeout/1000) ) {
takeInDataPacket();
}
timeout = 0;
}
}
dispatchBYE("GNU ccRTP stack finishing.");
Thread::exit();
}
#endif
inline size_t takeInDataPacket(void)
{return TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::takeInDataPacket();}
inline size_t dispatchBYE(const std::string &str)
{return TRTPSessionBaseIPV6<RTPDataChannel,RTCPChannel,ServiceQueue>::dispatchBYE(str);}
};
/**
* @typedef RTPSession
*
* Uses two pairs of sockets for RTP data and RTCP
* transmission/reception.
*
* @short UDP/IPv6 RTP Session scheduled by one thread of execution.
**/
typedef SingleThreadRTPSessionIPV6<> RTPSessionIPV6;
/**
* @typedef RTPSocket
*
* Alias for RTPSession.
**/
typedef RTPSessionIPV6 RTPSocketIPV6;
/**
* @typedef SymmetricRTPSession
*
* Uses one pair of sockets, (1) for RTP data and (2) for RTCP
* transmission/reception.
*
* @short Symmetric UDP/IPv6 RTP session scheduled by one thread of execution.
**/
typedef SingleThreadRTPSessionIPV6<SymmetricRTPChannelIPV6,
SymmetricRTPChannelIPV6> SymmetricRTPSessionIPV6;
#endif
/** @}*/ // sessions
END_NAMESPACE
#endif //CCXX_RTP_RTP_H_
/** EMACS **
* Local variables:
* mode: c++
* c-basic-offset: 8
* End:
*/
|