2013-11-23 03:36:07 +00:00
|
|
|
/*
|
|
|
|
The MIT License (MIT)
|
|
|
|
|
2014-12-31 12:32:09 +00:00
|
|
|
Copyright (c) 2013-2015 winlin
|
2013-11-23 03:36:07 +00:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
|
|
this software and associated documentation files (the "Software"), to deal in
|
|
|
|
the Software without restriction, including without limitation the rights to
|
|
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
|
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
|
|
subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
|
|
copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
|
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
|
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
|
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
2014-12-03 11:09:59 +00:00
|
|
|
#ifndef SRS_PROTOCOL_BUFFER_HPP
|
|
|
|
#define SRS_PROTOCOL_BUFFER_HPP
|
2013-11-23 03:36:07 +00:00
|
|
|
|
|
|
|
/*
|
2015-01-23 02:07:20 +00:00
|
|
|
#include <srs_rtmp_buffer.hpp>
|
2013-11-23 03:36:07 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include <srs_core.hpp>
|
|
|
|
|
2015-01-23 02:07:20 +00:00
|
|
|
#include <srs_rtmp_io.hpp>
|
2014-12-04 05:43:55 +00:00
|
|
|
#include <srs_core_performance.hpp>
|
2015-01-22 10:13:33 +00:00
|
|
|
#include <srs_kernel_buffer.hpp>
|
2014-12-04 03:29:47 +00:00
|
|
|
|
2014-12-04 05:43:55 +00:00
|
|
|
#ifdef SRS_PERF_MERGED_READ
|
2014-12-03 11:27:27 +00:00
|
|
|
/**
|
|
|
|
* to improve read performance, merge some packets then read,
|
|
|
|
* when it on and read small bytes, we sleep to wait more data.,
|
|
|
|
* that is, we merge some data to read together.
|
|
|
|
* @see https://github.com/winlinvip/simple-rtmp-server/issues/241
|
|
|
|
*/
|
|
|
|
class IMergeReadHandler
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
IMergeReadHandler();
|
|
|
|
virtual ~IMergeReadHandler();
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* when read from channel, notice the merge handler to sleep for
|
|
|
|
* some small bytes.
|
|
|
|
* @remark, it only for server-side, client srs-librtmp just ignore.
|
|
|
|
*/
|
2014-12-03 14:39:25 +00:00
|
|
|
virtual void on_read(ssize_t nread) = 0;
|
2014-12-03 11:27:27 +00:00
|
|
|
};
|
2014-12-04 05:43:55 +00:00
|
|
|
#endif
|
2014-12-03 11:27:27 +00:00
|
|
|
|
2013-11-23 03:36:07 +00:00
|
|
|
/**
|
|
|
|
* the buffer provices bytes cache for protocol. generally,
|
|
|
|
* protocol recv data from socket, put into buffer, decode to RTMP message.
|
2015-03-18 08:34:27 +00:00
|
|
|
* Usage:
|
|
|
|
* ISrsBufferReader* r = ......;
|
|
|
|
* SrsFastBuffer* fb = ......;
|
|
|
|
* fb->grow(r, 1024);
|
|
|
|
* char* header = fb->read_slice(100);
|
|
|
|
* char* payload = fb->read_payload(924);
|
2013-11-23 03:36:07 +00:00
|
|
|
*/
|
2014-12-04 05:43:55 +00:00
|
|
|
// TODO: FIXME: add utest for it.
|
2014-12-04 03:32:32 +00:00
|
|
|
class SrsFastBuffer
|
2013-11-23 03:36:07 +00:00
|
|
|
{
|
|
|
|
private:
|
2014-12-04 05:43:55 +00:00
|
|
|
#ifdef SRS_PERF_MERGED_READ
|
2014-12-03 11:27:27 +00:00
|
|
|
// the merged handler
|
|
|
|
bool merged_read;
|
|
|
|
IMergeReadHandler* _handler;
|
2014-12-04 05:43:55 +00:00
|
|
|
#endif
|
2014-12-04 05:05:13 +00:00
|
|
|
// the user-space buffer to fill by reader,
|
|
|
|
// which use fast index and reset when chunk body read ok.
|
|
|
|
// @see https://github.com/winlinvip/simple-rtmp-server/issues/248
|
|
|
|
// ptr to the current read position.
|
|
|
|
char* p;
|
|
|
|
// ptr to the content end.
|
|
|
|
char* end;
|
|
|
|
// ptr to the buffer.
|
|
|
|
// buffer <= p <= end <= buffer+nb_buffer
|
2014-12-03 06:27:36 +00:00
|
|
|
char* buffer;
|
2015-03-18 08:34:27 +00:00
|
|
|
// the size of buffer.
|
2014-12-03 13:46:47 +00:00
|
|
|
int nb_buffer;
|
2013-11-23 03:36:07 +00:00
|
|
|
public:
|
2014-12-04 03:32:32 +00:00
|
|
|
SrsFastBuffer();
|
|
|
|
virtual ~SrsFastBuffer();
|
2014-12-04 10:21:04 +00:00
|
|
|
public:
|
2015-03-06 03:36:26 +00:00
|
|
|
/**
|
|
|
|
* get the size of current bytes in buffer.
|
|
|
|
*/
|
|
|
|
virtual int size();
|
|
|
|
/**
|
|
|
|
* get the current bytes in buffer.
|
|
|
|
* @remark user should use read_slice() if possible,
|
|
|
|
* the bytes() is used to test bytes, for example, to detect the bytes schema.
|
|
|
|
*/
|
|
|
|
virtual char* bytes();
|
2014-12-04 10:21:04 +00:00
|
|
|
/**
|
|
|
|
* create buffer with specifeid size.
|
2015-03-18 08:34:27 +00:00
|
|
|
* @param buffer the size of buffer. ignore when smaller than SRS_MAX_SOCKET_BUFFER.
|
2014-12-04 10:21:04 +00:00
|
|
|
* @remark when MR(SRS_PERF_MERGED_READ) disabled, always set to 8K.
|
|
|
|
* @remark when buffer changed, the previous ptr maybe invalid.
|
|
|
|
* @see https://github.com/winlinvip/simple-rtmp-server/issues/241
|
|
|
|
*/
|
|
|
|
virtual void set_buffer(int buffer_size);
|
2013-11-23 03:36:07 +00:00
|
|
|
public:
|
2014-06-07 13:09:46 +00:00
|
|
|
/**
|
2014-12-04 05:05:13 +00:00
|
|
|
* read 1byte from buffer, move to next bytes.
|
|
|
|
* @remark assert buffer already grow(1).
|
2014-06-07 13:09:46 +00:00
|
|
|
*/
|
2014-12-04 05:05:13 +00:00
|
|
|
virtual char read_1byte();
|
2014-06-07 13:09:46 +00:00
|
|
|
/**
|
2014-12-04 05:05:13 +00:00
|
|
|
* read a slice in size bytes, move to next bytes.
|
|
|
|
* user can use this char* ptr directly, and should never free it.
|
2015-03-18 08:34:27 +00:00
|
|
|
* @remark user can use the returned ptr util grow(size),
|
|
|
|
* for the ptr returned maybe invalid after grow(x).
|
2014-06-07 13:09:46 +00:00
|
|
|
*/
|
2014-12-04 05:05:13 +00:00
|
|
|
virtual char* read_slice(int size);
|
2014-06-07 13:09:46 +00:00
|
|
|
/**
|
2014-12-04 05:05:13 +00:00
|
|
|
* skip some bytes in buffer.
|
|
|
|
* @param size the bytes to skip. positive to next; negative to previous.
|
|
|
|
* @remark assert buffer already grow(size).
|
2015-03-06 03:36:26 +00:00
|
|
|
* @remark always use read_slice to consume bytes, which will reset for EOF.
|
|
|
|
* while skip never consume bytes.
|
2014-06-07 13:09:46 +00:00
|
|
|
*/
|
2014-12-04 05:05:13 +00:00
|
|
|
virtual void skip(int size);
|
2013-11-23 03:36:07 +00:00
|
|
|
public:
|
2014-06-07 13:09:46 +00:00
|
|
|
/**
|
|
|
|
* grow buffer to the required size, loop to read from skt to fill.
|
|
|
|
* @param reader, read more bytes from reader to fill the buffer to required size.
|
2014-06-07 14:23:17 +00:00
|
|
|
* @param required_size, loop to fill to ensure buffer size to required.
|
|
|
|
* @return an int error code, error if required_size negative.
|
|
|
|
* @remark, we actually maybe read more than required_size, maybe 4k for example.
|
2014-06-07 13:09:46 +00:00
|
|
|
*/
|
|
|
|
virtual int grow(ISrsBufferReader* reader, int required_size);
|
2014-12-03 11:27:27 +00:00
|
|
|
public:
|
2014-12-04 05:43:55 +00:00
|
|
|
#ifdef SRS_PERF_MERGED_READ
|
2014-12-03 11:27:27 +00:00
|
|
|
/**
|
|
|
|
* to improve read performance, merge some packets then read,
|
|
|
|
* when it on and read small bytes, we sleep to wait more data.,
|
|
|
|
* that is, we merge some data to read together.
|
|
|
|
* @param v true to ename merged read.
|
|
|
|
* @param handler the handler when merge read is enabled.
|
|
|
|
* @see https://github.com/winlinvip/simple-rtmp-server/issues/241
|
2015-03-05 13:45:01 +00:00
|
|
|
* @remark the merged read is optional, ignore if not specifies.
|
2014-12-03 11:27:27 +00:00
|
|
|
*/
|
2014-12-04 07:43:37 +00:00
|
|
|
virtual void set_merge_read(bool v, IMergeReadHandler* handler);
|
2014-12-04 05:43:55 +00:00
|
|
|
#endif
|
2013-11-23 03:36:07 +00:00
|
|
|
};
|
|
|
|
|
2014-08-02 14:18:39 +00:00
|
|
|
#endif
|