vdr 2.6.4
player.h
Go to the documentation of this file.
1/*
2 * player.h: The basic player interface
3 *
4 * See the main source file 'vdr.c' for copyright information and
5 * how to reach the author.
6 *
7 * $Id: player.h 5.1 2022/12/05 14:45:51 kls Exp $
8 */
9
10#ifndef __PLAYER_H
11#define __PLAYER_H
12
13#include "device.h"
14#include "osdbase.h"
15
16class cPlayer {
17 friend class cDevice;
18private:
21protected:
22 void DeviceClrAvailableTracks(bool DescriptionsOnly = false) { if (device) device->ClrAvailableTracks(DescriptionsOnly); }
23 bool DeviceSetAvailableTrack(eTrackType Type, int Index, uint16_t Id, const char *Language = NULL, const char *Description = NULL) { return device ? device->SetAvailableTrack(Type, Index, Id, Language, Description) : false; }
26 bool DevicePoll(cPoller &Poller, int TimeoutMs = 0) { return device ? device->Poll(Poller, TimeoutMs) : false; }
27 bool DeviceFlush(int TimeoutMs = 0) { return device ? device->Flush(TimeoutMs) : true; }
28 bool DeviceHasIBPTrickSpeed(void) { return device ? device->HasIBPTrickSpeed() : false; }
29 bool DeviceIsPlayingVideo(void) { return device ? device->IsPlayingVideo() : false; }
30 void DeviceTrickSpeed(int Speed, bool Forward) { if (device) device->TrickSpeed(Speed, Forward); }
31 void DeviceClear(void) { if (device) device->Clear(); }
32 void DevicePlay(void) { if (device) device->Play(); }
33 void DeviceFreeze(void) { if (device) device->Freeze(); }
34 void DeviceMute(void) { if (device) device->Mute(); }
35 void DeviceSetVideoDisplayFormat(eVideoDisplayFormat VideoDisplayFormat) { if (device) device->SetVideoDisplayFormat(VideoDisplayFormat); }
36 void DeviceStillPicture(const uchar *Data, int Length) { if (device) device->StillPicture(Data, Length); }
37 uint64_t DeviceGetSTC(void) { return device ? device->GetSTC() : -1; }
38 void Detach(void);
39 virtual void Activate(bool On) {}
40 // This function is called right after the cPlayer has been attached to
41 // (On == true) or before it gets detached from (On == false) a cDevice.
42 // It can be used to do things like starting/stopping a thread.
43 int PlayPes(const uchar *Data, int Length, bool VideoOnly = false);
44 // Sends the given PES Data to the device and returns the number of
45 // bytes that have actually been accepted by the device (or a
46 // negative value in case of an error).
47 int PlayTs(const uchar *Data, int Length, bool VideoOnly = false) { return device ? device->PlayTs(Data, Length, VideoOnly) : -1; }
48 // Sends the given TS packet to the device and returns a positive number
49 // if the packet has been accepted by the device, or a negative value in
50 // case of an error.
51public:
52 cPlayer(ePlayMode PlayMode = pmAudioVideo);
53 virtual ~cPlayer();
54 bool IsAttached(void) { return device != NULL; }
55 virtual double FramesPerSecond(void) { return DEFAULTFRAMESPERSECOND; }
56 // Returns the number of frames per second of the currently played material.
57 virtual bool GetIndex(int &Current, int &Total, bool SnapToIFrame = false) { return false; }
58 // Returns the current and total frame index, optionally snapped to the
59 // nearest I-frame.
60 virtual bool GetFrameNumber(int &Current, int &Total) { return false; }
61 // Returns the current and total frame number. In contrast to GetIndex(),
62 // this function respects the chronological order of frames, which is
63 // different from its index for streams containing B frames (e.g. H264)
64 virtual bool GetReplayMode(bool &Play, bool &Forward, int &Speed) { return false; }
65 // Returns the current replay mode (if applicable).
66 // 'Play' tells whether we are playing or pausing, 'Forward' tells whether
67 // we are going forward or backward and 'Speed' is -1 if this is normal
68 // play/pause mode, 0 if it is single speed fast/slow forward/back mode
69 // and >0 if this is multi speed mode.
70 virtual void SetAudioTrack(eTrackType Type, const tTrackId *TrackId) {}
71 // Sets the current audio track to the given value.
72 // This is just a virtual hook for players that need to do special things
73 // in order to switch audio tracks.
74 virtual void SetSubtitleTrack(eTrackType Type, const tTrackId *TrackId) {}
75 // Sets the current subtitle track to the given value.
76 // This is just a virtual hook for players that need to do special things
77 // in order to switch subtitle tracks.
78 };
79
80class cControl : public cOsdObject {
81private:
83 static cMutex mutex;
85 bool hidden;
86protected:
88public:
89 cControl(cPlayer *Player, bool Hidden = false);
90 virtual ~cControl();
91 virtual void Hide(void) = 0;
92 virtual cOsdObject *GetInfo(void);
96 virtual const cRecording *GetRecording(void);
99 virtual cString GetHeader(void);
105 virtual void ClearEditingMarks(void) {}
110 void SetPlayer(cPlayer *Player) { player = Player; }
112 bool GetIndex(int &Current, int &Total, bool SnapToIFrame = false) const { return player ? player->GetIndex(Current, Total, SnapToIFrame) : false; }
113 bool GetFrameNumber(int &Current, int &Total) const { return player ? player->GetFrameNumber(Current, Total) : false; }
114 bool GetReplayMode(bool &Play, bool &Forward, int &Speed) const { return player ? player->GetReplayMode(Play, Forward, Speed) : false; }
115 static void Launch(cControl *Control);
116 static void Attach(void);
117 static void Shutdown(void);
118#define DEPRECATED_CCONTROL 1
119#if DEPRECATED_CCONTROL
120 static cControl *Control(bool Hidden = false);
126#endif
127 static cControl *Control(cMutexLock &MutexLock, bool Hidden = false);
133 };
134
135#endif //__PLAYER_H
virtual void ClearEditingMarks(void)
Clears any editing marks this player might be showing.
Definition player.h:105
virtual cString GetHeader(void)
This can be used by players that don't play a cRecording, but rather do something completely differen...
Definition player.c:68
double FramesPerSecond(void) const
Definition player.h:111
bool GetFrameNumber(int &Current, int &Total) const
Definition player.h:113
static void Shutdown(void)
Definition player.c:108
bool GetIndex(int &Current, int &Total, bool SnapToIFrame=false) const
Definition player.h:112
static cControl * control
Definition player.h:82
virtual cOsdObject * GetInfo(void)
Returns an OSD object that displays information about the currently played programme.
Definition player.c:58
static cMutex mutex
Definition player.h:83
virtual const cRecording * GetRecording(void)
Returns the cRecording that is currently being replayed, or NULL if this player is not playing a cRec...
Definition player.c:63
virtual ~cControl()
Definition player.c:52
static void Attach(void)
Definition player.c:95
bool GetReplayMode(bool &Play, bool &Forward, int &Speed) const
Definition player.h:114
void SetPlayer(cPlayer *Player)
Definition player.h:110
bool hidden
Definition player.h:85
static cControl * Control(bool Hidden=false)
Old version of this function, for backwards compatibility with plugins.
Definition player.c:74
bool attached
Definition player.h:84
static void Launch(cControl *Control)
Definition player.c:87
virtual void Hide(void)=0
cPlayer * player
Definition player.h:87
virtual bool Poll(cPoller &Poller, int TimeoutMs=0)
Returns true if the device itself or any of the file handles in Poller is ready for further action.
Definition device.c:1395
bool SetCurrentSubtitleTrack(eTrackType Type, bool Manual=false)
Sets the current subtitle track to the given Type.
Definition device.c:1151
virtual bool IsPlayingVideo(void) const
Returns true if the currently attached player has delivered any video packets.
Definition device.h:717
virtual void Play(void)
Sets the device into play mode (after a previous trick mode).
Definition device.c:1260
virtual void TrickSpeed(int Speed, bool Forward)
Sets the device into a mode where replay is done slower.
Definition device.c:1249
virtual void Mute(void)
Turns off audio while replaying.
Definition device.c:1274
virtual void Freeze(void)
Puts the device into "freeze frame" mode.
Definition device.c:1267
virtual int64_t GetSTC(void)
Gets the current System Time Counter, which can be used to synchronize audio, video and subtitles.
Definition device.c:1244
virtual void SetVideoDisplayFormat(eVideoDisplayFormat VideoDisplayFormat)
Sets the video display format to the given one (only useful if this device has an MPEG decoder).
Definition device.c:498
virtual bool Flush(int TimeoutMs=0)
Returns true if the device's output buffers are empty, i.
Definition device.c:1400
void ClrAvailableTracks(bool DescriptionsOnly=false, bool IdsOnly=false)
Clears the list of currently available tracks.
Definition device.c:1056
virtual bool HasIBPTrickSpeed(void)
Returns true if this device can handle all frames in 'fast forward' trick speeds.
Definition device.h:749
virtual void Clear(void)
Clears all video and audio data from the device.
Definition device.c:1253
bool SetAvailableTrack(eTrackType Type, int Index, uint16_t Id, const char *Language=NULL, const char *Description=NULL)
Sets the track of the given Type and Index to the given values.
Definition device.c:1079
virtual int PlayTs(const uchar *Data, int Length, bool VideoOnly=false)
Plays the given TS packet.
Definition device.c:1597
bool SetCurrentAudioTrack(eTrackType Type)
Sets the current audio track to the given Type.
Definition device.c:1133
virtual void StillPicture(const uchar *Data, int Length)
Displays the given I-frame as a still picture.
Definition device.c:1279
bool DeviceSetCurrentAudioTrack(eTrackType Type)
Definition player.h:24
void Detach(void)
Definition player.c:34
void DeviceStillPicture(const uchar *Data, int Length)
Definition player.h:36
uint64_t DeviceGetSTC(void)
Definition player.h:37
bool DeviceSetAvailableTrack(eTrackType Type, int Index, uint16_t Id, const char *Language=NULL, const char *Description=NULL)
Definition player.h:23
virtual bool GetIndex(int &Current, int &Total, bool SnapToIFrame=false)
Definition player.h:57
virtual bool GetReplayMode(bool &Play, bool &Forward, int &Speed)
Definition player.h:64
virtual void SetAudioTrack(eTrackType Type, const tTrackId *TrackId)
Definition player.h:70
int PlayTs(const uchar *Data, int Length, bool VideoOnly=false)
Definition player.h:47
void DevicePlay(void)
Definition player.h:32
int PlayPes(const uchar *Data, int Length, bool VideoOnly=false)
Definition player.c:26
virtual bool GetFrameNumber(int &Current, int &Total)
Definition player.h:60
bool DevicePoll(cPoller &Poller, int TimeoutMs=0)
Definition player.h:26
void DeviceClrAvailableTracks(bool DescriptionsOnly=false)
Definition player.h:22
void DeviceMute(void)
Definition player.h:34
virtual double FramesPerSecond(void)
Definition player.h:55
bool IsAttached(void)
Definition player.h:54
virtual ~cPlayer()
Definition player.c:21
void DeviceSetVideoDisplayFormat(eVideoDisplayFormat VideoDisplayFormat)
Definition player.h:35
void DeviceFreeze(void)
Definition player.h:33
bool DeviceFlush(int TimeoutMs=0)
Definition player.h:27
bool DeviceHasIBPTrickSpeed(void)
Definition player.h:28
ePlayMode playMode
Definition player.h:20
bool DeviceSetCurrentSubtitleTrack(eTrackType Type)
Definition player.h:25
virtual void Activate(bool On)
Definition player.h:39
virtual void SetSubtitleTrack(eTrackType Type, const tTrackId *TrackId)
Definition player.h:74
cDevice * device
Definition player.h:19
bool DeviceIsPlayingVideo(void)
Definition player.h:29
void DeviceClear(void)
Definition player.h:31
void DeviceTrickSpeed(int Speed, bool Forward)
Definition player.h:30
eVideoDisplayFormat
Definition device.h:58
ePlayMode
Definition device.h:39
@ pmAudioVideo
Definition device.h:40
eTrackType
Definition device.h:63
#define DEFAULTFRAMESPERSECOND
Definition recording.h:352
unsigned char uchar
Definition tools.h:31