YARP
Yet Another Robot Platform
H264Carrier.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 
6 #ifndef H264CARRIER_INC
7 #define H264CARRIER_INC
8 
9 #include <yarp/os/Carrier.h>
10 #include <yarp/os/Face.h>
11 #include "H264Decoder.h"
12 
13 
33 class H264Carrier :
34  public yarp::os::Carrier
35 {
36 private:
37  std::string envelope;
38  h264Decoder_cfgParamters cfgParams;
39 public:
41  {}
42 
43  Carrier *create() const override
44  {
45  return new H264Carrier();
46  }
47 
48  std::string getName() const override;
49 
50  bool isConnectionless() const override;
51 
52  bool canAccept() const override;
53 
54  bool canOffer() const override;
55 
56  bool isTextMode() const override;
57 
58  bool canEscape() const override;
59 
60  void handleEnvelope(const std::string& envelope) override;
61 
62  bool requireAck() const override;
63 
64  bool supportReply() const override;
65 
66  bool isLocal() const override;
67 
68  // this is important - flips expected flow of messages
69  bool isPush() const override;
70 
71  std::string toString() const override;
72 
73  void getHeader(yarp::os::Bytes& header) const override;
74 
75  bool checkHeader(const yarp::os::Bytes& header) override;
76 
77  void setParameters(const yarp::os::Bytes& header) override;
78 
79 
80  // Now, the initial hand-shaking
81 
82  bool prepareSend(yarp::os::ConnectionState& proto) override;
83 
84  bool sendHeader(yarp::os::ConnectionState& proto) override;
85 
87 
88  bool expectExtraHeader(yarp::os::ConnectionState& proto) override;
89 
90  bool respondToHeader(yarp::os::ConnectionState& proto) override;
91 
92  bool expectReplyToHeader(yarp::os::ConnectionState& proto) override;
93 
94  bool isActive() const override;
95 
96 
97  // Payload time!
98 
99  bool write(yarp::os::ConnectionState& proto, yarp::os::SizedWriter& writer) override;
100 
101  bool reply(yarp::os::ConnectionState& proto, yarp::os::SizedWriter& writer) override;
102 
103  virtual bool sendIndex(yarp::os::ConnectionState& proto, yarp::os::SizedWriter& writer);
104 
105  bool expectIndex(yarp::os::ConnectionState& proto) override;
106 
107  bool sendAck(yarp::os::ConnectionState& proto) override;
108 
109  bool expectAck(yarp::os::ConnectionState& proto) override;
110 
111  std::string getBootstrapCarrierName() const override;
112 
113  yarp::os::Face* createFace() const override;
114 
115 };
116 
117 #endif
A carrier for receiving frames compressed in h264 over rtp.
Definition: H264Carrier.h:35
bool respondToHeader(yarp::os::ConnectionState &proto) override
Respond to the header.
bool canEscape() const override
Check if carrier can encode administrative messages, as opposed to just user data.
Definition: H264Carrier.cpp:46
std::string getName() const override
Get the name of this connection type ("tcp", "mcast", "shmem", ...)
Definition: H264Carrier.cpp:21
bool write(yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer) override
Write a message.
bool expectSenderSpecifier(yarp::os::ConnectionState &proto) override
Expect the name of the sending port.
void handleEnvelope(const std::string &envelope) override
Carriers that do not distinguish data from administrative headers (i.e.
Definition: H264Carrier.cpp:51
bool isPush() const override
Check if carrier is "push" or "pull" style.
Definition: H264Carrier.cpp:72
bool expectIndex(yarp::os::ConnectionState &proto) override
Expect a message header, if there is one for this carrier.
virtual bool sendIndex(yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer)
bool isConnectionless() const override
Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp).
Definition: H264Carrier.cpp:26
Carrier * create() const override
Factory method.
Definition: H264Carrier.h:43
bool expectExtraHeader(yarp::os::ConnectionState &proto) override
Receive any carrier-specific header.
bool isTextMode() const override
Check if carrier is textual in nature.
Definition: H264Carrier.cpp:41
bool supportReply() const override
This flag is used by YARP to determine whether the connection can carry RPC traffic,...
Definition: H264Carrier.cpp:61
std::string toString() const override
Get name of carrier.
Definition: H264Carrier.cpp:77
void setParameters(const yarp::os::Bytes &header) override
Configure this carrier based on the first 8 bytes of the connection.
Definition: H264Carrier.cpp:91
bool prepareSend(yarp::os::ConnectionState &proto) override
Perform any initialization needed before writing on a connection.
bool isLocal() const override
Check if carrier operates within a single process.
Definition: H264Carrier.cpp:66
bool isActive() const override
Check if carrier is alive and error free.
void getHeader(yarp::os::Bytes &header) const override
Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to se...
Definition: H264Carrier.cpp:82
bool reply(yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer) override
bool canOffer() const override
Check if writing is implemented for this carrier.
Definition: H264Carrier.cpp:36
std::string getBootstrapCarrierName() const override
Get the name of the carrier that should be used prior to handshaking, if a port is registered with th...
bool sendHeader(yarp::os::ConnectionState &proto) override
Write a header appropriate to the carrier to the connection, followed by any carrier-specific data.
bool requireAck() const override
Check if carrier has flow control, requiring sent messages to be acknowledged by recipient.
Definition: H264Carrier.cpp:56
bool checkHeader(const yarp::os::Bytes &header) override
Given the first 8 bytes received on a connection, decide if this is the right carrier type to use for...
Definition: H264Carrier.cpp:86
bool expectReplyToHeader(yarp::os::ConnectionState &proto) override
Process reply to header, if one is expected for this carrier.
bool canAccept() const override
Check if reading is implemented for this carrier.
Definition: H264Carrier.cpp:31
bool sendAck(yarp::os::ConnectionState &proto) override
Send an acknowledgement, if needed for this carrier.
bool expectAck(yarp::os::ConnectionState &proto) override
Receive an acknowledgement, if expected for this carrier.
yarp::os::Face * createFace() const override
Create new Face object that the carrier needs.
A simple abstraction for a block of bytes.
Definition: Bytes.h:25
A base class for connection types (tcp, mcast, shmem, ...) which are called carriers in YARP.
Definition: Carrier.h:45
The basic state of a connection - route, streams in use, etc.
The initial point-of-contact with a port.
Definition: Face.h:21
Minimal requirements for an efficient Writer.
Definition: SizedWriter.h:33