File: stream_session.hpp

package info (click to toggle)
snapcast 0.34.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,252 kB
  • sloc: cpp: 40,067; python: 3,260; sh: 455; makefile: 16
file content (201 lines) | stat: -rw-r--r-- 6,385 bytes parent folder | download
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
/***
    This file is part of snapcast
    Copyright (C) 2014-2025  Johannes Pohl

    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 3 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, see <http://www.gnu.org/licenses/>.
***/

#pragma once


// local headers
#include "authinfo.hpp"
#include "common/message/message.hpp"
#include "streamreader/stream_manager.hpp"

// 3rd party headers
#include <boost/asio/any_io_executor.hpp>
#include <boost/asio/buffer.hpp>
#include <boost/asio/strand.hpp>

// standard headers
#include <deque>
#include <memory>
#include <mutex>
#include <sstream>
#include <string>
#include <vector>



class StreamSession;

/// Write result callback function type
using WriteHandler = std::function<void(boost::system::error_code ec, std::size_t length)>;

/// Interface: callback for a received message.
class StreamMessageReceiver
{
public:
    /// message received callback
    virtual void onMessageReceived(const std::shared_ptr<StreamSession>& connection, const msg::BaseMessage& baseMessage, char* buffer) = 0;
    /// disonnect callback
    virtual void onDisconnect(StreamSession* connection) = 0;
};


/// A reference-counted non-modifiable buffer class.
class shared_const_buffer
{
    /// the message
    struct Message
    {
        std::vector<char> data;           ///< data
        bool is_pcm_chunk;                ///< is it a PCM chunk
        message_type type;                ///< message type
        chronos::time_point_clk rec_time; ///< recording time
    };

public:
    /// c'tor
    explicit shared_const_buffer(msg::BaseMessage& message)
    {
        tv t;
        message.sent = t;
        const msg::PcmChunk* pcm_chunk = dynamic_cast<const msg::PcmChunk*>(&message);
        message_ = std::make_shared<Message>();
        message_->type = message.type;
        message_->is_pcm_chunk = (pcm_chunk != nullptr);
        if (message_->is_pcm_chunk)
            message_->rec_time = pcm_chunk->start();

        std::ostringstream oss;
        message.serialize(oss);
        std::string s = oss.str();
        message_->data = std::vector<char>(s.begin(), s.end());
        buffer_ = boost::asio::buffer(message_->data);
    }

    /// const buffer.
    using value_type = boost::asio::const_buffer;
    /// const buffer iterator
    using const_iterator = const boost::asio::const_buffer*;

    /// begin iterator
    const boost::asio::const_buffer* begin() const
    {
        return &buffer_;
    }

    /// end iterator
    const boost::asio::const_buffer* end() const
    {
        return &buffer_ + 1;
    }

    /// the payload
    const Message& message() const
    {
        return *message_;
    }

    /// set write callback
    void setWriteHandler(WriteHandler&& handler)
    {
        handler_ = std::move(handler);
    }

    /// get write callback
    const WriteHandler& getWriteHandler() const
    {
        return handler_;
    }

    /// is the buffer sent?
    bool on_air{false};

private:
    std::shared_ptr<Message> message_;
    boost::asio::const_buffer buffer_;
    WriteHandler handler_;
};


/// Endpoint for a connected client.
/**
 * Endpoint for a connected client.
 * Messages are sent to the client with the "send" method.
 * Received messages from the client are passed to the StreamMessageReceiver callback
 */
class StreamSession : public std::enable_shared_from_this<StreamSession>
{
public:
    /// c'tor. Received message from the client are passed to StreamMessageReceiver
    StreamSession(const boost::asio::any_io_executor& executor, const ServerSettings& server_settings, StreamMessageReceiver* receiver);
    /// d'tor
    virtual ~StreamSession() = default;

    /// @return the IP of the connected streaming client
    virtual std::string getIP() = 0;

    /// Start the StreamSession, e.g. start reading and processing data
    virtual void start() = 0;
    /// Stop the StreamSession
    virtual void stop() = 0;

    /// Set the message receiver to @p receiver
    void setMessageReceiver(StreamMessageReceiver* receiver)
    {
        messageReceiver_ = receiver;
    }

protected:
    /// Send data @p buffer to the streaming client, result is returned in the callback @p handler
    virtual void sendAsync(const shared_const_buffer& buffer, WriteHandler&& handler) = 0;

public:
    /// Sends a message to the client (asynchronous)
    void send(const msg::message_ptr& message, WriteHandler&& handler = nullptr);

    /// Sends a message to the client (asynchronous)
    void send(shared_const_buffer const_buf, WriteHandler&& handler = nullptr);

    /// Max playout latency. No need to send PCM data that is older than bufferMs
    void setBufferMs(size_t bufferMs);

    /// Client id of the session
    std::string clientId;

    /// Set the sessions PCM stream
    void setPcmStream(streamreader::PcmStreamPtr pcmStream);
    /// Get the sessions PCM stream
    const streamreader::PcmStreamPtr pcmStream() const;

    /// Authentication info attached to this session
    AuthInfo authinfo;

protected:
    /// Send next message from "messages_"
    void sendNext();

    msg::BaseMessage baseMessage_;                             ///< base message buffer
    std::vector<char> buffer_;                                 ///< buffer
    size_t base_msg_size_;                                     ///< size of a base message
    StreamMessageReceiver* messageReceiver_;                   ///< message receiver
    size_t bufferMs_;                                          ///< buffer size in [ms]
    streamreader::PcmStreamPtr pcm_stream_;                    ///< the sessions PCM stream
    boost::asio::strand<boost::asio::any_io_executor> strand_; ///< strand to sync IO on
    std::deque<shared_const_buffer> messages_;                 ///< messages to be sent
    mutable std::mutex mutex_;                                 ///< protect pcm_stream_
};