Newer
Older
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
/**
* @file packet.hpp
* @copyright Copyright (c) 2020 University of Turku, MIT License
* @author Nicolas Pope
*/
#pragma once
#include <cstdint>
#include <vector>
#include <ftl/protocol/codecs.hpp>
#include <ftl/protocol/channels.hpp>
//#include <msgpack.hpp>
namespace ftl {
namespace protocol {
static constexpr uint8_t kAllFrames = 255;
static constexpr uint8_t kAllFramesets = 255;
static constexpr uint8_t kCurrentFTLVersion = 5;
/**
* First bytes of our file format.
*/
struct Header {
const char magic[4] = {'F','T','L','F'};
uint8_t version = kCurrentFTLVersion;
};
/**
* Version 2 header padding for potential indexing use.
*/
struct IndexHeader {
int64_t reserved[8];
};
/**
* A single network packet for the compressed video stream. It includes the raw
* data along with any block metadata required to reconstruct. The underlying
* codec may use its own blocks and packets, in which case this is essentially
* an empty wrapper around that. It is used in the encoding callback.
*/
struct Packet {
ftl::protocol::Codec codec;
uint8_t reserved=0;
uint8_t frame_count=1; // v4+ Frames included in this packet
uint8_t bitrate=0; // v4+ For multi-bitrate encoding, 0=highest
union {
uint8_t flags=0; // Codec dependent flags (eg. I-Frame or P-Frame)
uint8_t packet_count;
};
std::vector<uint8_t> data;
//MSGPACK_DEFINE(codec, reserved, frame_count, bitrate, flags, data);
};
static constexpr unsigned int kStreamCap_Static = 0x01;
static constexpr unsigned int kStreamCap_Recorded = 0x02;
static constexpr unsigned int kStreamCap_NewConnection = 0x04;
/** V4 packets have no stream flags field */
struct StreamPacketV4 {
int version=4; // FTL version, Not encoded into stream
int64_t timestamp;
uint8_t streamID; // Source number [or v4 frameset id]
uint8_t frame_number; // v4+ First frame number (packet may include multiple frames)
ftl::codecs::Channel channel; // Actual channel of this current set of packets
inline int frameNumber() const { return (version >= 4) ? frame_number : streamID; }
inline size_t frameSetID() const { return (version >= 4) ? streamID : 0; }
int64_t localTimestamp; // Not message packet / saved
unsigned int hint_capability; // Is this a video stream, for example
size_t hint_source_total; // Number of tracks per frame to expect
//MSGPACK_DEFINE(timestamp, streamID, frame_number, channel);
operator std::string() const;
};
/**
* Add timestamp and channel information to a raw encoded frame packet. This
* allows the packet to be located within a larger stream and should be sent
* or included before a frame packet structure.
*/
struct StreamPacket {
int version = kCurrentFTLVersion; // FTL version, Not encoded into stream
int64_t timestamp;
uint8_t streamID; // Source number [or v4 frameset id]
uint8_t frame_number; // v4+ First frame number (packet may include multiple frames)
ftl::codecs::Channel channel; // Actual channel of this current set of packets
uint8_t flags=0;
inline int frameNumber() const { return (version >= 4) ? frame_number : streamID; }
inline size_t frameSetID() const { return (version >= 4) ? streamID : 0; }
int64_t localTimestamp; // Not message packet / saved
unsigned int hint_capability; // Is this a video stream, for example
size_t hint_source_total; // Number of tracks per frame to expect
int retry_count = 0; // Decode retry count
unsigned int hint_peerid=0;
//MSGPACK_DEFINE(timestamp, streamID, frame_number, channel, flags);
operator std::string() const;
};
/**
* Combine both packet types into a single packet unit. This pair is always
* saved or transmitted in a stream together.
*/
struct PacketPair {
PacketPair(const StreamPacket &s, const Packet &p) : spkt(s), pkt(p) {}
const StreamPacket &spkt;
const Packet &pkt;
};
} // namespace protocol
} // namespace ftl