Gnash  0.8.11dev
Public Member Functions | Static Public Attributes
gnash::media::FLVParser Class Reference

The FLVParser class parses FLV streams. More...

#include <FLVParser.h>

Inheritance diagram for gnash::media::FLVParser:
gnash::media::MediaParser

List of all members.

Public Member Functions

 FLVParser (std::auto_ptr< IOChannel > lt)
 Create an FLV parser reading input from the given IOChannel.
 ~FLVParser ()
 Kills the parser...
virtual bool seek (boost::uint32_t &)
 Seeks to the closest possible position the given position, and returns the new position.
virtual bool parseNextChunk ()
 Parse next chunk of input.
boost::uint64_t getBytesLoaded () const
 Return number of bytes parsed so far.
bool indexingCompleted () const
 Return true of indexing is completed.
virtual void fetchMetaTags (OrderedMetaTags &tags, boost::uint64_t ts)
 Retrieve any parsed metadata tags up to a specified timestamp.
- Public Member Functions inherited from gnash::media::MediaParser
 MediaParser (std::auto_ptr< IOChannel > stream)
virtual ~MediaParser ()
DSOEXPORT boost::uint64_t getBufferLength () const
 Returns mininum length of available buffers in milliseconds.
DSOEXPORT bool isBufferEmpty () const
 Return true if both audio and video buffers are empty.
DSOEXPORT boost::uint64_t getBufferTime () const
 Return the time we want the parser thread to maintain in the buffer.
DSOEXPORT void setBufferTime (boost::uint64_t t)
 Set the time we want the parser thread to maintain in the buffer.
DSOEXPORT bool nextFrameTimestamp (boost::uint64_t &ts) const
 Get timestamp of the next frame available, if any.
DSOEXPORT bool nextVideoFrameTimestamp (boost::uint64_t &ts) const
 Get timestamp of the video frame which would be returned on nextVideoFrame.
DSOEXPORT std::auto_ptr
< EncodedVideoFrame
nextVideoFrame ()
 Returns the next video frame in the parsed buffer, advancing video cursor.
DSOEXPORT bool nextAudioFrameTimestamp (boost::uint64_t &ts) const
 Get timestamp of the audio frame which would be returned on nextAudioFrame.
DSOEXPORT std::auto_ptr
< EncodedAudioFrame
nextAudioFrame ()
 Returns the next audio frame in the parsed buffer, advancing audio cursor.
VideoInfogetVideoInfo ()
 Returns a VideoInfo class about the videostream.
AudioInfogetAudioInfo ()
 Returns a AudioInfo class about the audiostream.
bool parsingCompleted () const
 Return true of parsing is completed.
boost::uint64_t getBytesTotal () const
 Return total number of bytes in input.
virtual boost::optional< Id3InfogetId3Info () const
 Get ID3 data from the parsed stream if it exists.

Static Public Attributes

static const size_t paddingBytes = 8
 The size of padding for all buffers that might be read by FFMPEG.

Additional Inherited Members

- Public Types inherited from gnash::media::MediaParser
typedef std::multimap
< boost::uint64_t,
boost::shared_ptr
< SimpleBuffer > > 
MetaTags
 A container for executable MetaTags contained in media streams.
typedef std::vector
< MetaTags::mapped_type > 
OrderedMetaTags
- Protected Member Functions inherited from gnash::media::MediaParser
void startParserThread ()
 }@
void stopParserThread ()
 Stop the parser thread.
void clearBuffers ()
 Clear the a/v buffers.
void pushEncodedAudioFrame (std::auto_ptr< EncodedAudioFrame > frame)
 Push an encoded audio frame to buffer.
void pushEncodedVideoFrame (std::auto_ptr< EncodedVideoFrame > frame)
 Push an encoded video frame to buffer.
void parserLoop ()
bool parserThreadKillRequested () const
void waitIfNeeded (boost::mutex::scoped_lock &qMutexLock)
void wakeupParserThread ()
bool bufferFull () const
 Method to check if buffer is full w/out locking the _qMutex.
- Static Protected Member Functions inherited from gnash::media::MediaParser
static void parserLoopStarter (MediaParser *mp)
- Protected Attributes inherited from gnash::media::MediaParser
std::auto_ptr< VideoInfo_videoInfo
 Subclasses must set the following variables:
std::auto_ptr< AudioInfo_audioInfo
 Info about the audio stream (if any)
bool _parsingComplete
 Whether the parsing is complete or not.
boost::uint64_t _bytesLoaded
 Number of bytes loaded.
std::auto_ptr< IOChannel_stream
 The stream used to access the file.
boost::mutex _streamMutex
boost::uint64_t _bufferTime
boost::mutex _bufferTimeMutex
std::auto_ptr< boost::thread > _parserThread
boost::barrier _parserThreadStartBarrier
boost::mutex _parserThreadKillRequestMutex
bool _parserThreadKillRequested
boost::condition _parserThreadWakeup
boost::mutex _qMutex
 mutex protecting access to the a/v encoded frames queues
boost::mutex _bytesLoadedMutex
 Mutex protecting _bytesLoaded (read by main, set by parser)
bool _seekRequest

Detailed Description

The FLVParser class parses FLV streams.


Constructor & Destructor Documentation

gnash::media::FLVParser::FLVParser ( std::auto_ptr< IOChannel lt)

Create an FLV parser reading input from the given IOChannel.

Parameters:
ltIOChannel to use for input. Ownership transferred.

References gnash::media::MediaParser::startParserThread().

gnash::media::FLVParser::~FLVParser ( )

Kills the parser...

References gnash::media::MediaParser::stopParserThread().


Member Function Documentation

void gnash::media::FLVParser::fetchMetaTags ( OrderedMetaTags tags,
boost::uint64_t  ts 
)
virtual

Retrieve any parsed metadata tags up to a specified timestamp.

This copies pointers to a SimpleBuffer of AMF data from _metaTags, then removes those pointers from the MetaTags map. Any metadata later than the timestamp is kept until fetchMetaTags is called again (or the dtor is called).

Parameters:
tsThe latest timestamp to retrieve metadata for.
tagsThis is filled with shared pointers to metatags in timestamp order. Ownership of the data is shared. It is destroyed automatically along with the last owner.

Reimplemented from gnash::media::MediaParser.

References gnash::key::_1, and second.

boost::uint64_t gnash::media::FLVParser::getBytesLoaded ( ) const
virtual

Return number of bytes parsed so far.

Reimplemented from gnash::media::MediaParser.

References gnash::media::MediaParser::_bytesLoaded, and gnash::media::MediaParser::_bytesLoadedMutex.

bool gnash::media::FLVParser::indexingCompleted ( ) const
inlinevirtual

Return true of indexing is completed.

If this function returns false, parseNextChunk will be called even when buffers are full. Parsers supporting indexing separated from parsing should override this method and have parseNextChunk figure if they only need to index or to parse based on bufferFull.

Reimplemented from gnash::media::MediaParser.

bool gnash::media::FLVParser::parseNextChunk ( )
virtual

Parse next chunk of input.

The implementations are required to parse a small chunk of input, so to avoid blocking too much if parsing conditions change (ie: seek or destruction requested)

When LOAD_MEDIA_IN_A_SEPARATE_THREAD is defined, this should never be called by users (consider protected).

Implements gnash::media::MediaParser.

References gnash::media::MediaParser::bufferFull().

bool gnash::media::FLVParser::seek ( boost::uint32_t &  time)
virtual

Seeks to the closest possible position the given position, and returns the new position.

Parameters:
timeinput/output parameter, input requests a time, output return the actual time seeked to.
Returns:
true if the seek was valid, false otherwise.

Implements gnash::media::MediaParser.

References gnash::media::MediaParser::_parsingComplete, gnash::media::MediaParser::_seekRequest, gnash::media::MediaParser::_streamMutex, and gnash::media::MediaParser::clearBuffers().


Member Data Documentation

const size_t gnash::media::FLVParser::paddingBytes = 8
static

The size of padding for all buffers that might be read by FFMPEG.

This possibly also applies to other media handlers (gst). Ideally this would be taken from the current Handler, but we don't know about it here.


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