17df7f35dade3fc17b577e481031af24ffe2eb8c
[cubemap] / stream.h
1 #ifndef _STREAM_H
2 #define _STREAM_H 1
3
4 // Representation of a single, muxed (we only really care about bytes/blocks) stream.
5 // Fed by Input, sent out by Server (to Client).
6
7 #include <stddef.h>
8 #include <stdint.h>
9 #include <sys/types.h>
10 #include <sys/uio.h>
11 #include <deque>
12 #include <mutex>
13 #include <string>
14 #include <vector>
15
16 class StreamProto;
17 struct Client;
18
19 struct Stream {
20         // Must be in sync with StreamConfig::Encoding.
21         enum Encoding { STREAM_ENCODING_RAW = 0, STREAM_ENCODING_METACUBE };
22
23         Stream(const std::string &stream_id, size_t backlog_size, size_t prebuffering_bytes, Encoding encoding, Encoding src_encoding);
24         ~Stream();
25
26         // Serialization/deserialization.
27         Stream(const StreamProto &serialized, int data_fd);
28         StreamProto serialize();
29
30         // Changes the backlog size, restructuring the data as needed.
31         void set_backlog_size(size_t new_size);
32
33         // Mutex protecting <queued_data> and <queued_data_last_starting_point>.
34         // Note that if you want to hold both this and the owning server's
35         // <mutex> you will need to take <mutex> before this one.
36         mutable std::mutex queued_data_mutex;
37
38         std::string url;
39
40         // The HTTP response header, without the trailing double newline.
41         std::string http_header;
42
43         // The video stream header (if any).
44         std::string stream_header;
45
46         // What encoding we apply to the outgoing data (usually raw, but can also
47         // be Metacube, for reflecting to another Cubemap instance).
48         Encoding encoding;
49
50         // What encoding we expect the incoming data to be in (usually Metacube).
51         Encoding src_encoding;
52
53         // The stream data itself, stored in a circular buffer.
54         //
55         // We store our data in a file, so that we can send the data to the
56         // kernel only once (with write()). We then use sendfile() for each
57         // client, which effectively zero-copies it out of the kernel's buffer
58         // cache. This is significantly more efficient than doing write() from
59         // a userspace memory buffer, since the latter makes the kernel copy
60         // the same data from userspace many times.
61         int data_fd;
62
63         // How many bytes <data_fd> can hold (the buffer size).
64         size_t backlog_size;
65
66         // How many bytes we need to have in the backlog before we start
67         // sending (in practice, we will then send all of them at once,
68         // and then start sending at the normal rate thereafter).
69         // This is basically to force a buffer on the client, which can help
70         // if the client expects us to be able to fill up the buffer much
71         // faster than realtime (ie., it expects a static file).
72         size_t prebuffering_bytes;
73
74         // How many bytes this stream have received. Can very well be larger
75         // than <backlog_size>, since the buffer wraps.
76         size_t bytes_received = 0;
77
78         // A list of points in the stream that is suitable to start new clients at
79         // (after having sent the header). Empty if no such point exists yet.
80         std::deque<size_t> suitable_starting_points;
81         
82         // Clients that are in SENDING_DATA, but that we don't listen on,
83         // because we currently don't have any data for them.
84         // See put_client_to_sleep() and wake_up_all_clients().
85         std::vector<Client *> sleeping_clients;
86
87         // Clients that we recently got data for (when they were in
88         // <sleeping_clients>).
89         std::vector<Client *> to_process;
90
91         // Maximum pacing rate for the stream.
92         uint32_t pacing_rate = ~0U;
93
94         // Queued data, if any. Protected by <queued_data_mutex>.
95         // The data pointers in the iovec are owned by us.
96         struct DataElement {
97                 iovec data;
98                 uint16_t metacube_flags;
99         };
100         std::vector<DataElement> queued_data;
101
102         // Put client to sleep, since there is no more data for it; we will on
103         // longer listen on POLLOUT until we get more data. Also, it will be put
104         // in the list of clients to wake up when we do.
105         void put_client_to_sleep(Client *client);
106
107         // Add more data to <queued_data>, adding Metacube headers if needed.
108         // Does not take ownership of <data>.
109         void add_data_deferred(const char *data, size_t bytes, uint16_t metacube_flags);
110
111         // Add queued data to the stream, if any.
112         // You should hold the owning Server's <mutex>.
113         void process_queued_data();
114
115 private:
116         Stream(const Stream& other);
117
118         // Adds data directly to the stream file descriptor, without adding headers or
119         // going through <queued_data>.
120         // You should hold the owning Server's <mutex>, and probably call
121         // remove_obsolete_starting_points() afterwards.
122         void add_data_raw(const std::vector<DataElement> &data);
123
124         // Remove points from <suitable_starting_points> that are no longer
125         // in the backlog.
126         // You should hold the owning Server's <mutex>.
127         void remove_obsolete_starting_points();
128 };
129
130 #endif  // !defined(_STREAM_H)