git.sesse.net Git - cubemap/blob - 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 <string>
  12 #include <vector>
  13
  14 class MarkPool;
  15 class StreamProto;
  16 struct Client;
  17
  18 enum StreamStartSuitability {
  19         NOT_SUITABLE_FOR_STREAM_START,
  20         SUITABLE_FOR_STREAM_START,
  21 };
  22
  23 struct Stream {
  24         // Must be in sync with StreamConfig::Encoding.
  25         enum Encoding { STREAM_ENCODING_RAW = 0, STREAM_ENCODING_METACUBE };
  26
  27         Stream(const std::string &stream_id, size_t backlog_size, Encoding encoding);
  28         ~Stream();
  29
  30         // Serialization/deserialization.
  31         Stream(const StreamProto &serialized, int data_fd);
  32         StreamProto serialize();
  33
  34         // Changes the backlog size, restructuring the data as needed.
  35         void set_backlog_size(size_t new_size);
  36
  37         // Mutex protecting <queued_data> and <queued_data_last_starting_point>.
  38         // Note that if you want to hold both this and the owning server's
  39         // <mutex> you will need to take <mutex> before this one.
  40         mutable pthread_mutex_t queued_data_mutex;
  41
  42         std::string url;
  43
  44         // The HTTP response header, without the trailing double newline.
  45         std::string http_header;
  46
  47         // The video stream header (if any).
  48         std::string stream_header;
  49
  50         // What encoding we apply to the outgoing data (usually raw, but can also
  51         // be Metacube, for reflecting to another Cubemap instance).
  52         Encoding encoding;
  53
  54         // The stream data itself, stored in a circular buffer.
  55         //
  56         // We store our data in a file, so that we can send the data to the
  57         // kernel only once (with write()). We then use sendfile() for each
  58         // client, which effectively zero-copies it out of the kernel's buffer
  59         // cache. This is significantly more efficient than doing write() from
  60         // a userspace memory buffer, since the latter makes the kernel copy
  61         // the same data from userspace many times.
  62         int data_fd;
  63
  64         // How many bytes <data_fd> can hold (the buffer size).
  65         size_t backlog_size;
  66
  67         // How many bytes this stream have received. Can very well be larger
  68         // than <backlog_size>, since the buffer wraps.
  69         size_t bytes_received;
  70
  71         // The last point in the stream that is suitable to start new clients at
  72         // (after having sent the header). -1 if no such point exists yet.
  73         ssize_t last_suitable_starting_point;
  74
  75         // Clients that are in SENDING_DATA, but that we don't listen on,
  76         // because we currently don't have any data for them.
  77         // See put_client_to_sleep() and wake_up_all_clients().
  78         std::vector<Client *> sleeping_clients;
  79
  80         // Clients that we recently got data for (when they were in
  81         // <sleeping_clients>).
  82         std::vector<Client *> to_process;
  83
  84         // What pool to fetch marks from, or NULL.
  85         MarkPool *mark_pool;
  86
  87         // Maximum pacing rate for the stream.
  88         uint32_t pacing_rate;
  89
  90         // Queued data, if any. Protected by <queued_data_mutex>.
  91         // The data pointers in the iovec are owned by us.
  92         std::vector<iovec> queued_data;
  93
  94         // Index of the last element in queued_data that is suitable to start streaming at.
  95         // -1 if none. Protected by <queued_data_mutex>.
  96         int queued_data_last_starting_point;
  97
  98         // Put client to sleep, since there is no more data for it; we will on
  99         // longer listen on POLLOUT until we get more data. Also, it will be put
 100         // in the list of clients to wake up when we do.
 101         void put_client_to_sleep(Client *client);
 102
 103         // Add more data to <queued_data>, adding Metacube headers if needed.
 104         // Does not take ownership of <data>.
 105         void add_data_deferred(const char *data, size_t bytes, StreamStartSuitability suitable_for_stream_start);
 106
 107         // Add queued data to the stream, if any.
 108         // You should hold the owning Server's <mutex>.
 109         void process_queued_data();
 110
 111 private:
 112         Stream(const Stream& other);
 113
 114         // Adds data directly to the stream file descriptor, without adding headers or
 115         // going through <queued_data>.
 116         // You should hold the owning Server's <mutex>.
 117         void add_data_raw(const std::vector<iovec> &data);
 118 };
 119
 120 #endif  // !defined(_STREAM_H)