MistServer  2.5.3-Pro-19-gf5e75b1 ( Generic_64)
Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes
Mist::OutRaw Class Reference

#include <output_raw.h>

Inheritance diagram for Mist::OutRaw:
Mist::Output Mist::InOutBase

Public Member Functions

 OutRaw (Socket::Connection &conn)
 
 ~OutRaw ()
 
void bufferFinalize (unsigned long tid)
 Wraps up the buffering of a shared memory data page. More...
 
void bufferLivePacket (JSON::Value &packet)
 Buffers a live packet to a page. More...
 
void bufferLivePacket (DTSC::Packet &packet)
 Buffers a live packet to a page. More...
 
void bufferNext (DTSC::Packet &pack)
 Buffers the next packet on the currently opened page. More...
 
void bufferNext (JSON::Value &pack)
 Buffers the next packet on the currently opened page. More...
 
void bufferRemove (unsigned long tid, unsigned long pageNumber)
 Removes a fully buffered page. More...
 
bool bufferStart (unsigned long tid, unsigned long pageNumber)
 
bool closeOutputFileForRecording ()
 
long unsigned int getMainSelectedTrack ()
 Returns the ID of the main selected track, or 0 if no tracks are selected. More...
 
virtual void initialize ()
 
void initiateMeta ()
 Opens a shared memory page for the stream metadata. More...
 
virtual void onFail ()
 Called when stream initialization has failed. More...
 
virtual bool onFinish ()
 
virtual void onRecord ()
 
virtual void onRequest ()
 
bool openOutputFileForRecording ()
 
virtual void prepareNext ()
 
void reconnect ()
 Connects or reconnects to the stream. More...
 
virtual void requestHandler ()
 
int run ()
 
void seek (unsigned long long pos)
 Prepares all tracks from selectedTracks for seeking to the specified ms position. More...
 
bool seek (unsigned int tid, unsigned long long pos, bool getNextKey=false)
 
void selectDefaultTracks ()
 
void sendHeader ()
 
void sendNext ()
 
void setBlocking (bool blocking)
 
void stats ()
 
void stop ()
 Clears the buffer, sets parseData to false, and generally makes not very much happen at all. More...
 
void updateMeta ()
 

Static Public Member Functions

static void init (Util::Config *cfg)
 
static bool listenMode ()
 

Data Fields

std::string reqUrl
 

Static Public Attributes

static JSON::Value capa = JSON::Value()
 

Protected Member Functions

void continueNegotiate (unsigned long tid)
 
virtual std::string getConnectedBinHost ()
 
virtual std::string getConnectedHost ()
 
unsigned int getKeyForTime (long unsigned int trackId, long long timeStamp)
 
bool recording ()
 

Protected Attributes

std::map< int, DTSCPageDatabookKeeping
 
bool completeKeysOnly
 Bool if we send whole keys only, so the metadata is complete and the output knows in advance what will be sent. More...
 
unsigned int crc
 Checksum, if any, for usage in the stats. More...
 
bool isBlocking
 If true, indicates that myConn is blocking. More...
 
bool isInitialized
 If false, triggers initialization if parseData is true. More...
 
unsigned int maxSkipAhead
 Maximum ms that we will go ahead of the intended timestamps. More...
 
unsigned int minSkipAhead
 Minimum ms that we will go ahead of the intended timestamps. More...
 
Socket::ConnectionmyConn
 Connection to the client. More...
 
DTSC::Meta myMeta
 Stores either the input or output metadata. More...
 
negotiationProxy nProxy
 
int outputFileDescriptor
 
bool parseData
 If true, triggers initalization if not already done, sending of header, sending of packets. More...
 
unsigned int realTime
 Playback speed in ms of data per second. eg: 0 is infinite, 1000 real-time, 5000 is 0.2X speed, 500 = 2X speed. More...
 
std::set< unsigned long > selectedTracks
 Stores the track id's that are either selected for playback or input. More...
 
bool sentHeader
 If false, triggers sendHeader if parseData is true. More...
 
bool standAlone
 
IPC::sharedClient statsPage
 Shared memory used for statistics reporting. More...
 
std::string streamName
 
DTSC::Packet thisPacket
 
bool wantRequest
 If true, waits for a request. More...
 

Static Protected Attributes

static Util::Configconfig = NULL
 

Constructor & Destructor Documentation

Mist::OutRaw::OutRaw ( Socket::Connection conn)
Mist::OutRaw::~OutRaw ( )

Member Function Documentation

void Mist::InOutBase::bufferFinalize ( unsigned long  tid)
inherited

Wraps up the buffering of a shared memory data page.

Registers the data page on the track index page as well

Parameters
tidThe trackid of the page to finalize
void Mist::InOutBase::bufferLivePacket ( JSON::Value packet)
inherited

Buffers a live packet to a page.

Handles both buffering and creation of new pages

Initiates/continues negotiation with the buffer as well

Parameters
packetThe packet to buffer
void Mist::InOutBase::bufferLivePacket ( DTSC::Packet packet)
inherited

Buffers a live packet to a page.

Handles both buffering and creation of new pages

Initiates/continues negotiation with the buffer as well

Parameters
packetThe packet to buffer
void Mist::InOutBase::bufferNext ( DTSC::Packet pack)
inherited

Buffers the next packet on the currently opened page.

Parameters
packThe packet to buffer
void Mist::InOutBase::bufferNext ( JSON::Value pack)
inherited

Buffers the next packet on the currently opened page.

Parameters
packThe packet to buffer
Note
Internally calls bufferNext(DTSC::Packet & pack)
void Mist::InOutBase::bufferRemove ( unsigned long  tid,
unsigned long  pageNumber 
)
inherited

Removes a fully buffered page.

Does not do anything if the process is not standalone, in this case the master process will have an overloaded version of this function.

Parameters
tidThe trackid to remove the page from
pageNumberThe number of the page to remove
bool Mist::InOutBase::bufferStart ( unsigned long  tid,
unsigned long  pageNumber 
)
inherited
bool Mist::Output::closeOutputFileForRecording ( )
inherited
void Mist::InOutBase::continueNegotiate ( unsigned long  tid)
protectedinherited
std::string Mist::Output::getConnectedBinHost ( )
protectedvirtualinherited

Reimplemented in Mist::HTTPOutput.

std::string Mist::Output::getConnectedHost ( )
protectedvirtualinherited

Reimplemented in Mist::HTTPOutput.

unsigned int Mist::Output::getKeyForTime ( long unsigned int  trackId,
long long  timeStamp 
)
protectedinherited
long unsigned int Mist::Output::getMainSelectedTrack ( )
inherited

Returns the ID of the main selected track, or 0 if no tracks are selected.

The main track is the first video track, if any, and otherwise the first other track.

void Mist::OutRaw::init ( Util::Config cfg)
static
void Mist::Output::initialize ( )
virtualinherited
Trigger:
The "CONN_PLAY" trigger is stream-specific, and is ran when an active connection first opens a stream.

Its payload is:

streamname
connected client host
output handler name
request URL (if any)

The "USER_NEW" trigger is stream-specific, and is ran when a new user first opens a stream. Segmented protcols are unduplicated over the duration of the statistics log (~10 minutes), true streaming protocols (RTMP, RTSP) are not deduplicated as no duplication ever takes place. Its payload is:

streamname
connected client host
User agent checksum (CRC32 of User-agent string)
output handler name
request URL (if any)

Reimplemented in Mist::OutDashMP4.

void Mist::InOutBase::initiateMeta ( )
inherited

Opens a shared memory page for the stream metadata.

Assumes myMeta contains the metadata to write.

static bool Mist::Output::listenMode ( )
inlinestaticinherited
void Mist::Output::onFail ( )
virtualinherited

Called when stream initialization has failed.

The standard implementation will set isInitialized to false and close the client connection, thus causing the process to exit cleanly.

Reimplemented in Mist::HTTPOutput, and Mist::OutHTTP.

virtual bool Mist::Output::onFinish ( )
inlinevirtualinherited

Reimplemented in Mist::OutProgressiveOGG, and Mist::OutJSON.

virtual void Mist::Output::onRecord ( )
inlinevirtualinherited

Reimplemented in Mist::HTTPOutput.

void Mist::Output::onRequest ( )
virtualinherited
bool Mist::Output::openOutputFileForRecording ( )
inherited
void Mist::Output::prepareNext ( )
virtualinherited
void Mist::Output::reconnect ( )
inherited

Connects or reconnects to the stream.

Assumes streamName class member has been set already. Will start input if not currently active, calls onFail() if this does not succeed. After assuring stream is online, clears nProxy.metaPages, then sets nProxy.metaPages[0], statsPage and nProxy.userClient to (hopefully) valid handles. Finally, calls updateMeta()

bool Mist::Output::recording ( )
protectedinherited
void Mist::Output::requestHandler ( )
virtualinherited

Reimplemented in Mist::HTTPOutput, and Mist::OutPush.

int Mist::Output::run ( )
inherited
Trigger:
The "CONN_OPEN" trigger is stream-specific, and is ran when a connection is made or passed to a new handler.

Its payload is:

streamname
connected client host
output handler name
request URL (if any)

The "CONN_CLOSE" trigger is stream-specific, and is ran when a connection closes. Its payload is:

streamname
connected client host
output handler name
request URL (if any)
Todo:
generate payload
void Mist::Output::seek ( unsigned long long  pos)
inherited

Prepares all tracks from selectedTracks for seeking to the specified ms position.

bool Mist::Output::seek ( unsigned int  tid,
unsigned long long  pos,
bool  getNextKey = false 
)
inherited
void Mist::Output::selectDefaultTracks ( )
inherited
void Mist::OutRaw::sendHeader ( )
virtual

Reimplemented from Mist::Output.

void Mist::OutRaw::sendNext ( )
virtual

Reimplemented from Mist::Output.

void Mist::Output::setBlocking ( bool  blocking)
inherited
void Mist::Output::stats ( )
inherited
void Mist::Output::stop ( )
inherited

Clears the buffer, sets parseData to false, and generally makes not very much happen at all.

void Mist::Output::updateMeta ( )
inherited

Field Documentation

std::map<int,DTSCPageData> Mist::Output::bookKeeping
protectedinherited
JSON::Value Mist::Output::capa = JSON::Value()
staticinherited
bool Mist::Output::completeKeysOnly
protectedinherited

Bool if we send whole keys only, so the metadata is complete and the output knows in advance what will be sent.

Util::Config * Mist::InOutBase::config = NULL
staticprotectedinherited
unsigned int Mist::Output::crc
protectedinherited

Checksum, if any, for usage in the stats.

bool Mist::Output::isBlocking
protectedinherited

If true, indicates that myConn is blocking.

bool Mist::Output::isInitialized
protectedinherited

If false, triggers initialization if parseData is true.

unsigned int Mist::Output::maxSkipAhead
protectedinherited

Maximum ms that we will go ahead of the intended timestamps.

unsigned int Mist::Output::minSkipAhead
protectedinherited

Minimum ms that we will go ahead of the intended timestamps.

Socket::Connection& Mist::Output::myConn
protectedinherited

Connection to the client.

DTSC::Meta Mist::InOutBase::myMeta
protectedinherited

Stores either the input or output metadata.

negotiationProxy Mist::InOutBase::nProxy
protectedinherited
int Mist::Output::outputFileDescriptor
protectedinherited
bool Mist::Output::parseData
protectedinherited

If true, triggers initalization if not already done, sending of header, sending of packets.

unsigned int Mist::Output::realTime
protectedinherited

Playback speed in ms of data per second. eg: 0 is infinite, 1000 real-time, 5000 is 0.2X speed, 500 = 2X speed.

std::string Mist::Output::reqUrl
inherited
std::set<unsigned long> Mist::InOutBase::selectedTracks
protectedinherited

Stores the track id's that are either selected for playback or input.

bool Mist::Output::sentHeader
protectedinherited

If false, triggers sendHeader if parseData is true.

bool Mist::InOutBase::standAlone
protectedinherited
IPC::sharedClient Mist::Output::statsPage
protectedinherited

Shared memory used for statistics reporting.

std::string Mist::InOutBase::streamName
protectedinherited
DTSC::Packet Mist::InOutBase::thisPacket
protectedinherited
bool Mist::Output::wantRequest
protectedinherited

If true, waits for a request.


The documentation for this class was generated from the following files: