vdr  2.4.0
Public Member Functions | Static Public Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
cRecordings Class Reference

#include <recording.h>

Collaboration diagram for cRecordings:
[legend]

Public Member Functions

 cRecordings (bool Deleted=false)
 
virtual ~cRecordings ()
 
void ResetResume (const char *ResumeFileName=NULL)
 
void ClearSortNames (void)
 
const cRecordingGetById (int Id) const
 
cRecordingGetById (int Id)
 
const cRecordingGetByName (const char *FileName) const
 
cRecordingGetByName (const char *FileName)
 
void Add (cRecording *Recording)
 
void AddByName (const char *FileName, bool TriggerUpdate=true)
 
void DelByName (const char *FileName)
 
void UpdateByName (const char *FileName)
 
int TotalFileSizeMB (void) const
 
double MBperMinute (void) const
 
int PathIsInUse (const char *Path) const
 
int GetNumRecordingsInPath (const char *Path) const
 
bool MoveRecordings (const char *OldPath, const char *NewPath)
 
- Public Member Functions inherited from cList< cRecording >
 cList (const char *NeedsLocking=NULL)
 
const cRecordingGet (int Index) const
 
cRecordingGet (int Index)
 
const cRecordingFirst (void) const
 
cRecordingFirst (void)
 
const cRecordingLast (void) const
 
cRecordingLast (void)
 
const cRecordingPrev (const cRecording *Object) const
 
cRecordingPrev (const cRecording *Object)
 
const cRecordingNext (const cRecording *Object) const
 
cRecordingNext (const cRecording *Object)
 
- Public Member Functions inherited from cListBase
virtual ~cListBase ()
 
bool Lock (cStateKey &StateKey, bool Write=false, int TimeoutMs=0) const
 
void SetSyncStateKey (cStateKey &StateKey)
 
void SetUseGarbageCollector (void)
 
void SetExplicitModify (void)
 
void SetModified (void)
 
void Add (cListObject *Object, cListObject *After=NULL)
 
void Ins (cListObject *Object, cListObject *Before=NULL)
 
void Del (cListObject *Object, bool DeleteObject=true)
 
virtual void Move (int From, int To)
 
void Move (cListObject *From, cListObject *To)
 
virtual void Clear (void)
 
bool Contains (const cListObject *Object) const
 
const cListObjectGet (int Index) const
 
cListObjectGet (int Index)
 
int Count (void) const
 
void Sort (void)
 

Static Public Member Functions

static const cRecordingsGetRecordingsRead (cStateKey &StateKey, int TimeoutMs=0)
 
static cRecordingsGetRecordingsWrite (cStateKey &StateKey, int TimeoutMs=0)
 
static const cRecordingsGetDeletedRecordingsRead (cStateKey &StateKey, int TimeoutMs=0)
 
static cRecordingsGetDeletedRecordingsWrite (cStateKey &StateKey, int TimeoutMs=0)
 
static void Update (bool Wait=false)
 
static void TouchUpdate (void)
 
static bool NeedsUpdate (void)
 

Static Private Member Functions

static const char * UpdateFileName (void)
 

Static Private Attributes

static cRecordings recordings
 
static cRecordings deletedRecordings
 
static int lastRecordingId = 0
 
static char * updateFileName = NULL
 
static time_t lastUpdate = 0
 
static cVideoDirectoryScannerThreadvideoDirectoryScannerThread = NULL
 

Additional Inherited Members

- Protected Member Functions inherited from cListBase
 cListBase (const char *NeedsLocking=NULL)
 
- Protected Attributes inherited from cListBase
cListObjectobjects
 
cListObjectlastObject
 
int count
 
cStateLock stateLock
 
const char * needsLocking
 
bool useGarbageCollector
 

Detailed Description

Definition at line 225 of file recording.h.

Constructor & Destructor Documentation

◆ cRecordings()

cRecordings::cRecordings ( bool  Deleted = false)

Definition at line 1480 of file recording.c.

◆ ~cRecordings()

cRecordings::~cRecordings ( )
virtual

Definition at line 1485 of file recording.c.

References videoDirectoryScannerThread.

Member Function Documentation

◆ Add()

void cRecordings::Add ( cRecording Recording)

◆ AddByName()

void cRecordings::AddByName ( const char *  FileName,
bool  TriggerUpdate = true 
)

Definition at line 1553 of file recording.c.

References Add(), GetByName(), and TouchUpdate().

Referenced by cRecordingsHandlerEntry::Active(), and cRecordingsHandlerEntry::Cleanup().

◆ ClearSortNames()

void cRecordings::ClearSortNames ( void  )

Definition at line 1670 of file recording.c.

References cList< cRecording >::First(), and cList< cRecording >::Next().

◆ DelByName()

void cRecordings::DelByName ( const char *  FileName)

◆ GetById() [1/2]

const cRecording * cRecordings::GetById ( int  Id) const

Definition at line 1527 of file recording.c.

References cList< cRecording >::First(), and cList< cRecording >::Next().

◆ GetById() [2/2]

cRecording* cRecordings::GetById ( int  Id)
inline

Definition at line 263 of file recording.h.

References GetById().

Referenced by GetById().

◆ GetByName() [1/2]

const cRecording * cRecordings::GetByName ( const char *  FileName) const

◆ GetByName() [2/2]

cRecording* cRecordings::GetByName ( const char *  FileName)
inline

Definition at line 265 of file recording.h.

References GetByName().

Referenced by GetByName().

◆ GetDeletedRecordingsRead()

static const cRecordings* cRecordings::GetDeletedRecordingsRead ( cStateKey StateKey,
int  TimeoutMs = 0 
)
inlinestatic

Gets the list of deleted recordings for read access.

See cTimers::GetTimersRead() for details.

Definition at line 243 of file recording.h.

References deletedRecordings, and cListBase::Lock().

◆ GetDeletedRecordingsWrite()

static cRecordings* cRecordings::GetDeletedRecordingsWrite ( cStateKey StateKey,
int  TimeoutMs = 0 
)
inlinestatic

Gets the list of deleted recordings for write access.

See cTimers::GetTimersWrite() for details.

Definition at line 246 of file recording.h.

References deletedRecordings, and cListBase::Lock().

◆ GetNumRecordingsInPath()

int cRecordings::GetNumRecordingsInPath ( const char *  Path) const

Returns the total number of recordings in the given Path, including all sub-folders of Path.

If Path is NULL or an empty string, the entire video directory is checked.

Definition at line 1632 of file recording.c.

References cList< cRecording >::First(), and cList< cRecording >::Next().

◆ GetRecordingsRead()

static const cRecordings* cRecordings::GetRecordingsRead ( cStateKey StateKey,
int  TimeoutMs = 0 
)
inlinestatic

Gets the list of recordings for read access.

See cTimers::GetTimersRead() for details.

Definition at line 237 of file recording.h.

References cListBase::Lock(), and recordings.

Referenced by cSVDRPServer::CmdPLAY(), cMenuRecordingEdit::RefreshRecording(), cMenuRecording::RefreshRecording(), cMenuFolder::Set(), and cMenuRecordings::Set().

◆ GetRecordingsWrite()

static cRecordings* cRecordings::GetRecordingsWrite ( cStateKey StateKey,
int  TimeoutMs = 0 
)
inlinestatic

Gets the list of recordings for write access.

See cTimers::GetTimersWrite() for details.

Definition at line 240 of file recording.h.

References cListBase::Lock(), and recordings.

Referenced by cMenuRecordingEdit::ApplyChanges(), cMenuRecordings::Delete(), and cMenuRecordings::Set().

◆ MBperMinute()

double cRecordings::MBperMinute ( void  ) const

Returns the average data rate (in MB/min) of all recordings, or -1 if this value is unknown.

Definition at line 1601 of file recording.c.

References cList< cRecording >::First(), LIMIT_SECS_PER_MB_RADIO, and cList< cRecording >::Next().

◆ MoveRecordings()

bool cRecordings::MoveRecordings ( const char *  OldPath,
const char *  NewPath 
)

Moves all recordings in OldPath to NewPath.

Returns true if all recordings were successfully moved. As soon as the operation fails for one recording, the whole action is aborted and false will be returned. Any recordings that have been successfully moved thus far will keep their new name. If OldPath and NewPath are on different file systems, the recordings will be moved in a background process and this function returns true if all recordings have been successfully added to the RecordingsHandler.

Definition at line 1642 of file recording.c.

References dsyslog, cList< cRecording >::First(), cList< cRecording >::Next(), cString::sprintf(), and TouchUpdate().

◆ NeedsUpdate()

bool cRecordings::NeedsUpdate ( void  )
static

Definition at line 1507 of file recording.c.

References LastModifiedTime(), lastUpdate, and UpdateFileName().

Referenced by main(), and TouchUpdate().

◆ PathIsInUse()

int cRecordings::PathIsInUse ( const char *  Path) const

Checks whether any recording in the given Path is currently in use and therefore the whole Path shall not be tampered with.

Returns 0 (ruNone) if no recording is in use. See cRecording::IsInUse() for details about the possible non-zero return values. If several recordings in the Path are currently in use, the return value will be the combination of all individual recordings' flags. If Path is NULL or an empty string, the entire video directory is checked.

Definition at line 1622 of file recording.c.

References cList< cRecording >::First(), cList< cRecording >::Next(), and ruNone.

◆ ResetResume()

void cRecordings::ResetResume ( const char *  ResumeFileName = NULL)

Definition at line 1662 of file recording.c.

References cList< cRecording >::First(), and cList< cRecording >::Next().

◆ TotalFileSizeMB()

int cRecordings::TotalFileSizeMB ( void  ) const

Definition at line 1590 of file recording.c.

References cList< cRecording >::First(), and cList< cRecording >::Next().

◆ TouchUpdate()

void cRecordings::TouchUpdate ( void  )
static

Touches the '.update' file in the video directory, so that other instances of VDR that access the same video directory can be triggered to update their recordings list.

This function is 'const', because it doesn't actually modify the list of recordings.

Definition at line 1499 of file recording.c.

References lastUpdate, NeedsUpdate(), TouchFile(), and UpdateFileName().

Referenced by cRecordingsHandlerEntry::Active(), AddByName(), cMenuRecordingEdit::ApplyChanges(), DelByName(), and MoveRecordings().

◆ Update()

void cRecordings::Update ( bool  Wait = false)
static

Triggers an update of the list of recordings, which will run as a separate thread if Wait is false.

If Wait is true, the function returns only after the update has completed.

Definition at line 1515 of file recording.c.

References cThread::Active(), deletedRecordings, lastUpdate, recordings, cCondWait::SleepMs(), cThread::Start(), and videoDirectoryScannerThread.

Referenced by AssertFreeDiskSpace(), and main().

◆ UpdateByName()

void cRecordings::UpdateByName ( const char *  FileName)

Definition at line 1584 of file recording.c.

References GetByName().

◆ UpdateFileName()

const char * cRecordings::UpdateFileName ( void  )
staticprivate

Definition at line 1492 of file recording.c.

References AddDirectory(), cVideoDirectory::Name(), and updateFileName.

Referenced by NeedsUpdate(), and TouchUpdate().

Member Data Documentation

◆ deletedRecordings

cRecordings cRecordings::deletedRecordings
staticprivate

Definition at line 228 of file recording.h.

Referenced by GetDeletedRecordingsRead(), GetDeletedRecordingsWrite(), and Update().

◆ lastRecordingId

int cRecordings::lastRecordingId = 0
staticprivate

Definition at line 229 of file recording.h.

Referenced by Add().

◆ lastUpdate

time_t cRecordings::lastUpdate = 0
staticprivate

Definition at line 231 of file recording.h.

Referenced by NeedsUpdate(), TouchUpdate(), and Update().

◆ recordings

cRecordings cRecordings::recordings
staticprivate

Definition at line 227 of file recording.h.

Referenced by GetRecordingsRead(), GetRecordingsWrite(), and Update().

◆ updateFileName

char * cRecordings::updateFileName = NULL
staticprivate

Definition at line 230 of file recording.h.

Referenced by UpdateFileName().

◆ videoDirectoryScannerThread

cVideoDirectoryScannerThread * cRecordings::videoDirectoryScannerThread = NULL
staticprivate

Definition at line 232 of file recording.h.

Referenced by Update(), and ~cRecordings().


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