recording.h

Go to the documentation of this file.

/*
 * recording.h: Recording file handling
 *
 * See the main source file 'vdr.c' for copyright information and
 * how to reach the author.
 *
 * $Id: recording.h 5.21 2026/02/03 11:40:56 kls Exp $
 */
 
#ifndef __RECORDING_H
#define __RECORDING_H
 
#include <time.h>
#include "channels.h"
#include "config.h"
#include "epg.h"
#include "thread.h"
#include "timers.h"
#include "tools.h"
#include "remux.h"
 
#define FOLDERDELIMCHAR '~'
 
extern int DirectoryPathMax;
extern int DirectoryNameMax;
extern bool DirectoryEncoding;
extern int InstanceId;
 
enum eRecordingUsage {
  ruNone     = 0x0000, // the recording is currently unused
  ruTimer    = 0x0001, // the recording is currently written to by a timer
  ruReplay   = 0x0002, // the recording is being replayed
  // mutually exclusive:
  ruCut      = 0x0004, // the recording is being cut
  ruMove     = 0x0008, // the recording is being moved
  ruCopy     = 0x0010, // the recording is being copied
  // mutually exclusive:
  ruSrc      = 0x0020, // the recording is the source of a cut, move or copy process
  ruDst      = 0x0040, // the recording is the destination of a cut, move or copy process
  //
  ruPending  = 0x0080, // the recording is pending a cut, move or copy process
  ruCanceled = 0x8000, // the operation has been canceled, waiting for cleanup
  };
 
void RemoveDeletedRecordings(void);
void AssertFreeDiskSpace(int Priority = 0, bool Force = false);
 
class cResumeFile {
private:
  char *fileName;
  time_t fileTime;
  int index;
  bool isPesRecording;
public:
  cResumeFile(const char *FileName, bool IsPesRecording);
  ~cResumeFile();
  time_t FileTime(void);
  int Index(void);
  int Read(void);
  bool Save(int Index);
  void Reset(void);
  void Delete(void);
  };
 
class cRecordingInfo {
  friend class cRecording;
private:
  time_t modified;
  tChannelID channelID;
  char *channelName;
  const cEvent *event;
  cEvent *ownEvent;
  char *aux;
  double framesPerSecond;
  uint16_t frameWidth;
  uint16_t frameHeight;
  eScanType scanType;
  eAspectRatio aspectRatio;
  int priority;
  int lifetime;
  char *fileName;
  int errors;
  int tmpErrors;
  cRecordingInfo(const cChannel *Channel = NULL, const cEvent *Event = NULL);
  bool Read(FILE *f, bool Force = false);
public:
  cRecordingInfo(const char *FileName);
  ~cRecordingInfo();
  tChannelID ChannelID(void) const { return channelID; }
  const char *ChannelName(void) const { return channelName; }
  const cEvent *GetEvent(void) const { return event; }
  const char *Title(void) const { return event->Title(); }
  const char *ShortText(void) const { return event->ShortText(); }
  const char *Description(void) const { return event->Description(); }
  const cComponents *Components(void) const { return event->Components(); }
  const char *Aux(void) const { return aux; }
  double FramesPerSecond(void) const { return framesPerSecond; }
  int Priority(void) const { return priority; }
  int Lifetime(void) const { return lifetime; }
  uint16_t FrameWidth(void) const { return frameWidth; }
  uint16_t FrameHeight(void) const { return frameHeight; }
  eScanType ScanType(void) const { return scanType; }
  char ScanTypeChar(void) const { return ScanTypeChars[scanType]; }
  eAspectRatio AspectRatio(void) const { return aspectRatio; }
  const char *AspectRatioText(void) const { return AspectRatioTexts[aspectRatio]; }
  cString FrameParams(void) const;
  void SetFramesPerSecond(double FramesPerSecond);
  void SetPriority(int Priority);
  void SetLifetime(int Lifetime);
  void SetFrameParams(uint16_t FrameWidth, uint16_t FrameHeight, eScanType ScanType, eAspectRatio AspectRatio);
  void SetFileName(const char *FileName);
  int Errors(void) const { return errors; } // returns -1 if undefined
  int TmpErrors(void) const { return tmpErrors; } // returns -1 if undefined
  void SetErrors(int Errors, int TmpErrors = 0);
  bool Write(FILE *f, const char *Prefix = "") const;
  bool Read(bool Force = false);
  bool Write(void) const;
  void SetData(const char *Title, const char *ShortText, const char *Description);
  void SetAux(const char *Aux);
  };
 
class cRecording : public cListObject {
  friend class cRecordings;
private:
  int id;
  mutable cResumeFile *resume;
  mutable char *titleBuffer;
  mutable char *sortBufferName;
  mutable char *sortBufferTime;
  mutable char *fileName;
  mutable char *name;
  mutable int fileSizeMB;
  mutable int numFrames;
  int channel;
  int instanceId;
  bool isPesRecording;
  mutable int isOnVideoDirectoryFileSystem; // -1 = unknown, 0 = no, 1 = yes
  cRecordingInfo *info;
  cRecording(const cRecording&); // can't copy cRecording
  cRecording &operator=(const cRecording &); // can't assign cRecording
  static char *StripEpisodeName(char *s, bool Strip);
  char *SortName(void) const;
  void ClearSortName(void);
  void SetId(int Id); // should only be set by cRecordings
  time_t start;
  time_t deleted;
public:
  cRecording(cTimer *Timer, const cEvent *Event);
  cRecording(const char *FileName);
  virtual ~cRecording() override;
  int Id(void) const { return id; }
  time_t Start(void) const { return start; }
  int Priority(void) const { return info->Priority(); }
  int Lifetime(void) const { return info->Lifetime(); }
  time_t Deleted(void) const { return deleted; }
  bool RetentionExpired(void) const;
  void SetDeleted(void);
  virtual int Compare(const cListObject &ListObject) const override;
  bool IsInPath(const char *Path) const;
  cString Folder(void) const;
  cString BaseName(void) const;
  const char *Name(void) const { return name; }
  const char *FileName(void) const;
  const char *Title(char Delimiter = ' ', bool NewIndicator = false, int Level = -1) const;
  cRecordingInfo *Info(void) const { return info; }
  const char *PrefixFileName(char Prefix);
  int HierarchyLevels(void) const;
  void ResetResume(void) const;
  void DeleteResume(void) const;
  double FramesPerSecond(void) const { return info->FramesPerSecond(); }
  int NumFrames(void) const;
  int NumFramesAfterEdit(void) const;
  int LengthInSeconds(void) const;
  int LengthInSecondsAfterEdit(void) const;
  int FileSizeMB(void) const;
  int GetResume(void) const;
  time_t GetLastReplayTime(void) const;
  bool IsNew(void) const { return GetResume() <= 0; }
  bool IsEdited(void) const;
  bool IsPesRecording(void) const { return isPesRecording; }
  bool IsOnVideoDirectoryFileSystem(void) const;
  bool HasMarks(void) const;
  bool DeleteMarks(void);
  void ReadInfo(bool Force = false);
  bool WriteInfo(const char *OtherFileName = NULL);
  void SetStartTime(time_t Start);
  bool ChangePriorityLifetime(int NewPriority, int NewLifetime);
  bool ChangeName(const char *NewName);
  bool Delete(void);
  bool Remove(void);
  bool Undelete(void);
  int IsInUse(void) const;
  };
 
class cVideoDirectoryScannerThread;
 
class cRecordings : public cList<cRecording> {
private:
  static cRecordings recordings;
  static cRecordings deletedRecordings;
  static int lastRecordingId;
  static char *updateFileName;
  static time_t lastUpdate;
  static cVideoDirectoryScannerThread *videoDirectoryScannerThread;
  static const char *UpdateFileName(void);
public:
  cRecordings(bool Deleted = false);
  virtual ~cRecordings() override;
  static const cRecordings *GetRecordingsRead(cStateKey &StateKey, int TimeoutMs = 0) { return recordings.Lock(StateKey, false, TimeoutMs) ? &recordings : NULL; }
  static cRecordings *GetRecordingsWrite(cStateKey &StateKey, int TimeoutMs = 0) { return recordings.Lock(StateKey, true, TimeoutMs) ? &recordings : NULL; }
  static const cRecordings *GetDeletedRecordingsRead(cStateKey &StateKey, int TimeoutMs = 0) { return deletedRecordings.Lock(StateKey, false, TimeoutMs) ? &deletedRecordings : NULL; }
  static cRecordings *GetDeletedRecordingsWrite(cStateKey &StateKey, int TimeoutMs = 0) { return deletedRecordings.Lock(StateKey, true, TimeoutMs) ? &deletedRecordings : NULL; }
  static void Update(bool Wait = false);
  static void TouchUpdate(void);
  static bool NeedsUpdate(void);
  void ResetResume(const char *ResumeFileName = NULL);
  void ClearSortNames(void);
  const cRecording *GetById(int Id) const;
  cRecording *GetById(int Id) { return const_cast<cRecording *>(static_cast<const cRecordings *>(this)->GetById(Id)); };
  const cRecording *GetByName(const char *FileName) const;
  cRecording *GetByName(const char *FileName) { return const_cast<cRecording *>(static_cast<const cRecordings *>(this)->GetByName(FileName)); }
  void Add(cRecording *Recording);
  void AddByName(const char *FileName, bool TriggerUpdate = true);
  [[deprecated("use explicit locking, deleting etc.")]] 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);
  };
 
// Provide lock controlled access to the list:
 
DEF_LIST_LOCK(Recordings);
DEF_LIST_LOCK2(Recordings, DeletedRecordings);
 
// These macros provide a convenient way of locking the global recordings list
// and making sure the lock is released as soon as the current scope is left
// (note that these macros wait forever to obtain the lock!):
 
#define LOCK_RECORDINGS_READ  USE_LIST_LOCK_READ(Recordings)
#define LOCK_RECORDINGS_WRITE USE_LIST_LOCK_WRITE(Recordings)
#define LOCK_DELETEDRECORDINGS_READ  USE_LIST_LOCK_READ2(Recordings, DeletedRecordings)
#define LOCK_DELETEDRECORDINGS_WRITE USE_LIST_LOCK_WRITE2(Recordings, DeletedRecordings)
 
class cRecordingsHandlerEntry;
 
class cRecordingsHandler : public cThread {
private:
  cMutex mutex;
  cList<cRecordingsHandlerEntry> operations;
  bool finished;
  bool error;
  cRecordingsHandlerEntry *Get(const char *FileName);
protected:
  virtual void Action(void) override;
public:
  cRecordingsHandler(void);
  virtual ~cRecordingsHandler() override;
  bool Add(int Usage, const char *FileNameSrc, const char *FileNameDst = NULL);
  void Del(const char *FileName);
  void DelAll(void);
  int GetUsage(const char *FileName);
  int GetRequiredDiskSpaceMB(const char *FileName = NULL);
  bool Finished(bool &Error);
  };
 
extern cRecordingsHandler RecordingsHandler;
 
#define DEFAULTFRAMESPERSECOND 25.0
 
class cMark : public cListObject {
  friend class cMarks; // for sorting
private:
  double framesPerSecond;
  int position;
  cString comment;
public:
  cMark(int Position = 0, const char *Comment = NULL, double FramesPerSecond = DEFAULTFRAMESPERSECOND);
  virtual ~cMark() override;
  int Position(void) const { return position; }
  const char *Comment(void) const { return comment; }
  void SetPosition(int Position) { position = Position; }
  void SetComment(const char *Comment) { comment = Comment; }
  cString ToText(void);
  bool Parse(const char *s);
  bool Save(FILE *f);
  };
 
class cMarks : public cConfig<cMark> {
private:
  cString recordingFileName;
  cString fileName;
  double framesPerSecond;
  bool isPesRecording;
  time_t nextUpdate;
  time_t lastFileTime;
  time_t lastChange;
public:
  cMarks(void): cConfig<cMark>("Marks") {};
  static cString MarksFileName(const cRecording *Recording);
  static bool DeleteMarksFile(const cRecording *Recording);
  bool Load(const char *RecordingFileName, double FramesPerSecond = DEFAULTFRAMESPERSECOND, bool IsPesRecording = false);
  bool Update(void);
  bool Save(void);
  void Align(void);
  void Sort(void);
  void Add(int Position);
  const cMark *Get(int Position) const;
  const cMark *GetPrev(int Position) const;
  const cMark *GetNext(int Position) const;
  const cMark *GetNextBegin(const cMark *EndMark = NULL) const;
  const cMark *GetNextEnd(const cMark *BeginMark) const;
  int GetNumSequences(void) const;
  int GetFrameAfterEdit(int Frame, int LastFrame) const;
  cMark *Get(int Position) { return const_cast<cMark *>(static_cast<const cMarks *>(this)->Get(Position)); }
  cMark *GetPrev(int Position) { return const_cast<cMark *>(static_cast<const cMarks *>(this)->GetPrev(Position)); }
  cMark *GetNext(int Position) { return const_cast<cMark *>(static_cast<const cMarks *>(this)->GetNext(Position)); }
  cMark *GetNextBegin(const cMark *EndMark = NULL) { return const_cast<cMark *>(static_cast<const cMarks *>(this)->GetNextBegin(EndMark)); }
  cMark *GetNextEnd(const cMark *BeginMark) { return const_cast<cMark *>(static_cast<const cMarks *>(this)->GetNextEnd(BeginMark)); }
  };
 
class cErrors : public cVector<int> {
  };
 
#define RUC_BEFORERECORDING  "before"
#define RUC_STARTRECORDING   "started"
#define RUC_AFTERRECORDING   "after"
#define RUC_EDITINGRECORDING "editing"
#define RUC_EDITEDRECORDING  "edited"
#define RUC_DELETERECORDING  "deleted"
#define RUC_RENAMEDRECORDING "renamed" // same directory, only the base name is changed
#define RUC_MOVEDRECORDING   "moved"   // different directory (and maybe base name), or "copy" to other filesystem + delete original (triggers copying->copied->deleted)
#define RUC_COPYINGRECORDING "copying"
#define RUC_COPIEDRECORDING  "copied"
 
class cRecordingUserCommand {
private:
  static const char *command;
public:
  static void SetCommand(const char *Command) { command = Command; }
  static void InvokeCommand(const char *State, const char *RecordingFileName, const char *SourceFileName = NULL);
  };
 
// The maximum size of a single frame (up to HDTV 1920x1080):
#define MAXFRAMESIZE  (KILOBYTE(1024) / TS_SIZE * TS_SIZE) // multiple of TS_SIZE to avoid breaking up TS packets
 
// The maximum file size is limited by the range that can be covered
// with a 40 bit 'unsigned int', which is 1TB. The actual maximum value
// used is 6MB below the theoretical maximum, to have some safety (the
// actual file size may be slightly higher because we stop recording only
// before the next independent frame, to have a complete Group Of Pictures):
#define MAXVIDEOFILESIZETS  1048570 // MB
#define MAXVIDEOFILESIZEPES    2000 // MB
#define MINVIDEOFILESIZE        100 // MB
#define MAXVIDEOFILESIZEDEFAULT MAXVIDEOFILESIZEPES
 
struct tIndexTs;
class cIndexFileGenerator;
 
class cIndexFile {
private:
  int f;
  cString fileName;
  int size, last;
  int lastErrorIndex;
  tIndexTs *index;
  bool isPesRecording;
  cResumeFile resumeFile;
  cErrors errors;
  cIndexFileGenerator *indexFileGenerator;
  cMutex mutex;
  void ConvertFromPes(tIndexTs *IndexTs, int Count);
  void ConvertToPes(tIndexTs *IndexTs, int Count);
  bool CatchUp(int Index = -1);
public:
  cIndexFile(const char *FileName, bool Record, bool IsPesRecording = false, bool PauseLive = false);
  [[deprecated("use cIndexFile(::cIndexFile(const char *, bool, bool, bool) instead")]]
  cIndexFile(const char *FileName, bool Record, bool IsPesRecording, bool PauseLive, bool Update)
  :cIndexFile(FileName, Record, IsPesRecording, PauseLive) {}
  ~cIndexFile();
  bool Ok(void) { return index != NULL; }
  bool Write(bool Independent, uint16_t FileNumber, off_t FileOffset, bool Errors = false, bool Missing = false);
  bool Get(int Index, uint16_t *FileNumber, off_t *FileOffset, bool *Independent = NULL, int *Length = NULL, bool *Errors = NULL, bool *Missing = NULL);
  const cErrors *GetErrors(void);
  int GetNextIFrame(int Index, bool Forward, uint16_t *FileNumber = NULL, off_t *FileOffset = NULL, int *Length = NULL);
  int GetClosestIFrame(int Index);
  int Get(uint16_t FileNumber, off_t FileOffset);
  int Last(void) { CatchUp(); return last; }
  int GetResume(void) { return resumeFile.Read(); }
  bool StoreResume(int Index) { return resumeFile.Save(Index); }
  bool IsStillRecording(void);
  void Delete(void);
  static int GetLength(const char *FileName, bool IsPesRecording = false);
  static cString IndexFileName(const char *FileName, bool IsPesRecording);
  };
 
class cFileName {
private:
  cUnbufferedFile *file;
  uint16_t fileNumber;
  char *fileName, *pFileNumber;
  bool record;
  bool blocking;
  bool isPesRecording;
public:
  cFileName(const char *FileName, bool Record, bool Blocking = false, bool IsPesRecording = false);
  ~cFileName();
  const char *Name(void) { return fileName; }
  uint16_t Number(void) { return fileNumber; }
  [[deprecated("will be removed in a future version, if your plugin uses this function, contact vdr@tvdr.de")]]
  bool GetLastPatPmtVersions(int &PatVersion, int &PmtVersion);
  cUnbufferedFile *Open(void);
  void Close(void);
  cUnbufferedFile *SetOffset(int Number, off_t Offset = 0); // yes, Number is int for easier internal calculating
  cUnbufferedFile *NextFile(void);
  };
 
class cDoneRecordings {
private:
  cString fileName;
  cStringList doneRecordings;
  void Add(const char *Title);
public:
  bool Load(const char *FileName);
  bool Save(void) const;
  void Append(const char *Title);
  bool Contains(const char *Title) const;
  };
 
extern cDoneRecordings DoneRecordingsPattern;
 
cString IndexToHMSF(int Index, bool WithFrame = false, double FramesPerSecond = DEFAULTFRAMESPERSECOND);
      // Converts the given index to a string, optionally containing the frame number.
int HMSFToIndex(const char *HMSF, double FramesPerSecond = DEFAULTFRAMESPERSECOND);
      // Converts the given string (format: "hh:mm:ss.ff") to an index.
int SecondsToFrames(int Seconds, double FramesPerSecond = DEFAULTFRAMESPERSECOND);
      // Returns the number of frames corresponding to the given number of seconds.
 
int ReadFrame(cUnbufferedFile *f, uchar *b, int Length, int Max);
 
char *ExchangeChars(char *s, bool ToFileSystem);
      // Exchanges the characters in the given string to or from a file system
      // specific representation (depending on ToFileSystem). The given string will
      // be modified and may be reallocated if more space is needed. The return
      // value points to the resulting string, which may be different from s.
 
bool GenerateIndex(const char *FileName);
[[deprecated("use GenerateIndex(const char *FileName) instead")]]
inline bool GenerateIndex(const char *FileName, bool Update) { return GenerateIndex(FileName); }
 
enum eRecordingsSortDir { rsdAscending, rsdDescending };
enum eRecordingsSortMode { rsmName, rsmTime };
extern eRecordingsSortMode RecordingsSortMode;
bool HasRecordingsSortMode(const char *Directory);
void GetRecordingsSortMode(const char *Directory);
void SetRecordingsSortMode(const char *Directory, eRecordingsSortMode SortMode);
void IncRecordingsSortMode(const char *Directory);
 
void SetRecordingTimerId(const char *Directory, const char *TimerId);
cString GetRecordingTimerId(const char *Directory);
 
int FileSizeMBafterEdit(const char *FileName);
bool EnoughFreeDiskSpaceForEdit(const char *FileName);
 
#endif //__RECORDING_H