MythTV  master
Public Member Functions | Protected Member Functions | Friends | List of all members
FileRingBuffer Class Reference

#include <fileringbuffer.h>

Inheritance diagram for FileRingBuffer:
Inheritance graph
[legend]
Collaboration diagram for FileRingBuffer:
Collaboration graph
[legend]

Public Member Functions

 ~FileRingBuffer ()
 
bool IsOpen (void) const override
 Returns true if open for either reading or writing. More...
 
long long GetReadPosition (void) const override
 Returns how far into the file we have read. More...
 
bool OpenFile (const QString &lfilename, uint retry_ms=kDefaultOpenTimeout) override
 Opens a file for reading. More...
 
bool ReOpen (QString newFilename="") override
 
- Public Member Functions inherited from RingBuffer
virtual ~RingBuffer ()=0
 Deletes. More...
 
void SetWriteBufferSize (int newSize)
 
void SetWriteBufferMinWriteSize (int newMinSize)
 Calls ThreadedFileWriter::SetWriteBufferMinWriteSize(int) More...
 
void SetOldFile (bool is_old)
 Tell RingBuffer if this is an old file or not. More...
 
void UpdateRawBitrate (uint raw_bitrate)
 Set the raw bit rate, to allow RingBuffer adjust effective bitrate. More...
 
void UpdatePlaySpeed (float play_speed)
 Set the play speed, to allow RingBuffer adjust effective bitrate. More...
 
void EnableBitrateMonitor (bool enable)
 
void SetBufferSizeFactors (bool estbitrate, bool matroska)
 Tells RingBuffer that the raw bitrate may be innacurate and the underlying container is matroska, both of which may require a larger buffer size. More...
 
void SetWaitForWrite (void)
 
QString GetSafeFilename (void)
 
QString GetFilename (void) const
 Returns name of file used by this RingBuffer. More...
 
QString GetSubtitleFilename (void) const
 
QString GetLastError (void) const
 
bool GetCommsError (void) const
 
void ResetCommsError (void)
 
bool GetStopReads (void) const
 Returns value of stopreads. More...
 
bool isPaused (void) const
 Returns false iff read-ahead is not running and read-ahead is not paused. More...
 
QString GetDecoderRate (void)
 
QString GetStorageRate (void)
 
QString GetAvailableBuffer (void)
 
uint GetBufferSize (void)
 
long long GetWritePosition (void) const
 Returns how far into a ThreadedFileWriter file we have written. More...
 
long long GetRealFileSize (void) const
 Returns the size of the file we are reading/writing, or -1 if the query fails. More...
 
bool IsNearEnd (double fps, uint vvf) const
 
virtual bool IsStreamed (void)
 
virtual bool IsSeekingAllowed (void)
 
virtual bool IsBookmarkAllowed (void)
 
virtual int BestBufferSize (void)
 
RingBufferType GetType () const
 
int GetReadBufAvail () const
 Returns number of bytes available for reading from buffer. More...
 
bool SetReadInternalMode (bool mode)
 
bool IsReadInternalMode (void)
 
bool IsDisc (void) const
 
bool IsDVD (void) const
 
bool IsBD (void) const
 
const DVDRingBufferDVD (void) const
 
const BDRingBufferBD (void) const
 
DVDRingBufferDVD (void)
 
BDRingBufferBD (void)
 
virtual bool StartFromBeginning (void)
 
virtual void IgnoreWaitStates (bool)
 
virtual bool IsInMenu (void) const
 
virtual bool IsInStillFrame (void) const
 
virtual bool IsInDiscMenuOrStillFrame (void) const
 
virtual bool HandleAction (const QStringList &, int64_t)
 
int Read (void *buf, int count)
 This is the public method for reading from a file, it calls the appropriate read method if the file is remote or buffered, or a BD/DVD. More...
 
int Peek (void *buf, int count)
 
void Reset (bool full=false, bool toAdjust=false, bool resetInternal=false)
 Resets the read-ahead thread and our position in the file. More...
 
long long Seek (long long pos, int whence, bool has_lock=false)
 Seeks to a particular position in the file. More...
 
void Pause (void)
 Pauses the read-ahead thread. More...
 
void Unpause (void)
 Unpauses the read-ahead thread. More...
 
void WaitForPause (void)
 Waits for Pause(void) to take effect. More...
 
void Start (void)
 Starts the read-ahead thread. More...
 
void StopReads (void)
 ???? More...
 
void StartReads (void)
 ???? More...
 
bool LiveMode (void) const
 Returns true if this RingBuffer has been assigned a LiveTVChain. More...
 
void SetLiveMode (LiveTVChain *chain)
 Assigns a LiveTVChain to this RingBuffer. More...
 
void IgnoreLiveEOF (bool ignore)
 Tells RingBuffer whether to ignore the end-of-file. More...
 
int Write (const void *buf, uint count)
 Writes buffer to ThreadedFileWriter::Write(const void*,uint) More...
 
bool IsIOBound (void) const
 
void WriterFlush (void)
 Calls ThreadedFileWriter::Flush(void) More...
 
void Sync (void)
 Calls ThreadedFileWriter::Sync(void) More...
 
long long WriterSeek (long long pos, int whence, bool has_lock=false)
 Calls ThreadedFileWriter::Seek(long long,int). More...
 
bool WriterSetBlocking (bool lock=true)
 Calls ThreadedFileWriter::SetBlocking(bool) More...
 
long long SetAdjustFilesize (void)
 

Protected Member Functions

 FileRingBuffer (const QString &lfilename, bool write, bool readahead, int timeout_ms)
 
int safe_read (void *data, uint sz) override
 
int safe_read (int fd, void *data, uint sz)
 Reads data from the file-descriptor. More...
 
int safe_read (RemoteFile *rf, void *data, uint sz)
 Reads data from the RemoteFile. More...
 
long long GetRealFileSizeInternal (void) const override
 
long long SeekInternal (long long pos, int whence) override
 
- Protected Member Functions inherited from RingBuffer
 RingBuffer (RingBufferType rbtype)
 
void run (void) override
 Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...
 
void CreateReadAheadBuffer (void)
 
void CalcReadAheadThresh (void)
 Calculates fill_min, fill_threshold, and readblocksize from the estimated effective bitrate of the stream. More...
 
bool PauseAndWait (void)
 
int ReadPriv (void *buf, int count, bool peek)
 When possible reads from the read-ahead buffer, otherwise reads directly from the device. More...
 
int ReadDirect (void *buf, int count, bool peek)
 
bool WaitForReadsAllowed (void)
 
int WaitForAvail (int count, int timeout)
 
int ReadBufFree (void) const
 Returns number of bytes available for reading into buffer. More...
 
int ReadBufAvail (void) const
 Returns number of bytes available for reading from buffer. More...
 
void ResetReadAhead (long long newinternal)
 Restart the read-ahead thread at the 'newinternal' position. More...
 
void KillReadAheadThread (void)
 Stops the read-ahead thread, and waits for it to stop. More...
 
uint64_t UpdateDecoderRate (uint64_t latest=0)
 
uint64_t UpdateStorageRate (uint64_t latest=0)
 
- Protected Member Functions inherited from MThread
int exec (void)
 Enters the qt event loop. call exit or quit to exit thread. More...
 
 MThread (const QString &objectName)
 Standard constructor. More...
 
 MThread (const QString &objectName, QRunnable *runnable)
 Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop. More...
 
virtual ~MThread ()
 
void RunProlog (void)
 Sets up a thread, call this if you reimplement run(). More...
 
void RunEpilog (void)
 Cleans up a thread's resources, call this if you reimplement run(). More...
 
QThread * qthread (void)
 Returns the thread, this will always return the same pointer no matter how often you restart the thread. More...
 
void setObjectName (const QString &name)
 
QString objectName (void) const
 
void setPriority (QThread::Priority priority)
 
QThread::Priority priority (void) const
 
bool isFinished (void) const
 
bool isRunning (void) const
 
void setStackSize (uint stackSize)
 
uint stackSize (void) const
 
void exit (int retcode=0)
 Use this to exit from the thread if you are using a Qt event loop. More...
 
void start (QThread::Priority=QThread::InheritPriority)
 Tell MThread to start running the thread in the near future. More...
 
void terminate (void)
 Kill a thread unsafely. More...
 
void quit (void)
 calls exit(0) More...
 
bool wait (unsigned long time=ULONG_MAX)
 Wait for the MThread to exit, with a maximum timeout. More...
 

Friends

class RingBuffer
 

Additional Inherited Members

- Static Public Member Functions inherited from RingBuffer
static RingBufferCreate (const QString &xfilename, bool write, bool usereadahead=true, int timeout_ms=kDefaultOpenTimeout, bool stream_only=false)
 Creates a RingBuffer instance. More...
 
static QString BitrateToString (uint64_t rate, bool hz=false)
 
static void AVFormatInitNetwork (void)
 
- Static Public Attributes inherited from RingBuffer
static const int kDefaultOpenTimeout = 2000
 
static const int kLiveTVOpenTimeout = 10000
 
static QMutex subExtLock
 
static QStringList subExt
 
static QStringList subExtNoCheck
 
- Static Protected Member Functions inherited from MThread
static void setTerminationEnabled (bool enabled=true)
 
static void sleep (unsigned long time)
 
static void msleep (unsigned long time)
 
static void usleep (unsigned long time)
 
static void ThreadSetup (const QString &)
 This is to be called on startup in those few threads that haven't been ported to MThread. More...
 
static void ThreadCleanup (void)
 This is to be called on exit in those few threads that haven't been ported to MThread. More...
 
static void Cleanup (void)
 This will print out all the running threads, call exit(1) on each and then wait up to 5 seconds total for all the threads to exit. More...
 
static void GetAllThreadNames (QStringList &list)
 
static void GetAllRunningThreadNames (QStringList &list)
 
- Protected Attributes inherited from RingBuffer
RingBufferType type
 
QReadWriteLock poslock
 
long long readpos
 
long long writepos
 
long long internalreadpos
 
long long ignorereadpos
 
QReadWriteLock rbrlock
 
int rbrpos
 
QReadWriteLock rbwlock
 
int rbwpos
 
volatile bool stopreads
 
QReadWriteLock rwlock
 
QString safefilename
 
QString filename
 
QString subtitlefilename
 
QString lastError
 
ThreadedFileWritertfw
 
int fd2
 
bool writemode
 
RemoteFileremotefile
 
uint bufferSize
 
bool low_buffers
 
bool fileismatroska
 
bool unknownbitrate
 
bool startreadahead
 
char * readAheadBuffer
 
bool readaheadrunning
 
bool reallyrunning
 
bool request_pause
 
bool paused
 
bool ateof
 
bool waitforwrite
 
bool beingwritten
 
bool readsallowed
 
bool readsdesired
 
volatile bool recentseek
 
bool setswitchtonext
 
uint rawbitrate
 
float playspeed
 
int fill_threshold
 
int fill_min
 
int readblocksize
 
int wanttoread
 
int numfailures
 
bool commserror
 
bool oldfile
 
LiveTVChainlivetvchain
 
bool ignoreliveeof
 
long long readAdjust
 
int readOffset
 
bool readInternalMode
 
bool bitrateMonitorEnabled
 
QMutex decoderReadLock
 
QMap< qint64, uint64_t > decoderReads
 
QMutex storageReadLock
 
QMap< qint64, uint64_t > storageReads
 
QWaitCondition generalWait
 Condition to signal that the read ahead thread is running. More...
 
- Protected Attributes inherited from MThread
MThreadInternalm_thread
 
QRunnable * m_runnable
 
bool m_prolog_executed
 
bool m_epilog_executed
 
- Static Protected Attributes inherited from MThread
static const int kDefaultStartTimeout
 

Detailed Description

Definition at line 7 of file fileringbuffer.h.

Constructor & Destructor Documentation

◆ ~FileRingBuffer()

FileRingBuffer::~FileRingBuffer ( )

Definition at line 89 of file fileringbuffer.cpp.

◆ FileRingBuffer()

FileRingBuffer::FileRingBuffer ( const QString &  lfilename,
bool  write,
bool  readahead,
int  timeout_ms 
)
protected

Definition at line 45 of file fileringbuffer.cpp.

Member Function Documentation

◆ IsOpen()

bool FileRingBuffer::IsOpen ( void  ) const
overridevirtual

Returns true if open for either reading or writing.

Implements RingBuffer.

Definition at line 431 of file fileringbuffer.cpp.

◆ GetReadPosition()

long long FileRingBuffer::GetReadPosition ( void  ) const
overridevirtual

Returns how far into the file we have read.

Implements RingBuffer.

Definition at line 590 of file fileringbuffer.cpp.

◆ OpenFile()

bool FileRingBuffer::OpenFile ( const QString &  lfilename,
uint  retry_ms = kDefaultOpenTimeout 
)
overridevirtual

Opens a file for reading.

Parameters
lfilenameName of file to read
retry_msHow many ms to retry reading the file after the first try before giving up.

Implements RingBuffer.

Definition at line 182 of file fileringbuffer.cpp.

Referenced by FileRingBuffer().

◆ ReOpen()

bool FileRingBuffer::ReOpen ( QString  newFilename = "")
overridevirtual

Reimplemented from RingBuffer.

Definition at line 402 of file fileringbuffer.cpp.

◆ safe_read() [1/3]

int FileRingBuffer::safe_read ( void *  data,
uint  sz 
)
inlineoverrideprotectedvirtual

Implements RingBuffer.

Definition at line 28 of file fileringbuffer.h.

◆ safe_read() [2/3]

int FileRingBuffer::safe_read ( int  fd,
void *  data,
uint  sz 
)
protected

Reads data from the file-descriptor.

This will re-read the file forever until the end-of-file is reached or the buffer is full.

Parameters
fdIgnored. The File descriptor to read is now stored as part of the RingBuffer parent structure.
dataPointer to where data will be written
szNumber of bytes to read
Returns
Returns number of bytes read

Definition at line 451 of file fileringbuffer.cpp.

◆ safe_read() [3/3]

int FileRingBuffer::safe_read ( RemoteFile rf,
void *  data,
uint  sz 
)
protected

Reads data from the RemoteFile.

Parameters
rfRemoteFile to read from
dataPointer to where data will be written
szNumber of bytes to read
Returns
Returns number of bytes read

Definition at line 568 of file fileringbuffer.cpp.

◆ GetRealFileSizeInternal()

long long FileRingBuffer::GetRealFileSizeInternal ( void  ) const
overrideprotectedvirtual

Reimplemented from RingBuffer.

Definition at line 598 of file fileringbuffer.cpp.

◆ SeekInternal()

long long FileRingBuffer::SeekInternal ( long long  pos,
int  whence 
)
overrideprotectedvirtual

Implements RingBuffer.

Definition at line 625 of file fileringbuffer.cpp.

Friends And Related Function Documentation

◆ RingBuffer

friend class RingBuffer
friend

Definition at line 11 of file fileringbuffer.h.


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