From 4d477cd144c8df2b3791b60f15337448292066fe Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Sun, 6 Feb 2005 18:00:00 +0100 Subject: =?UTF-8?q?Version=201.3.20=20-=20Fixed=20displaying=20the=20"Audi?= =?UTF-8?q?o"=20menu=20with=20the=20"Green"=20button=20from=20the=20"Main"?= =?UTF-8?q?=20menu=20=20=20in=20case=20there=20is=20only=20one=20audio=20t?= =?UTF-8?q?rack=20(thanks=20to=20Sascha=20Volkenandt=20for=20reporting=20?= =?UTF-8?q?=20=20this=20one).=20-=20Now=20setting=20primaryDevice=20=3D=20?= =?UTF-8?q?NULL=20before=20deleting=20the=20devices=20in=20cDevice::Shutdo?= =?UTF-8?q?wn()=20=20=20to=20avoid=20problems=20in=20case=20other=20thread?= =?UTF-8?q?s=20access=20it=20(thanks=20to=20Wolfgang=20Rohdewald=20for=20?= =?UTF-8?q?=20=20pointing=20this=20out).=20-=20Fixed=20a=20buffer=20overfl?= =?UTF-8?q?ow=20in=20case=20a=20station=20defines=20all=2032=20audio=20PID?= =?UTF-8?q?s=20(thanks=20to=20=20=20Christian=20Jacobsen=20for=20reporting?= =?UTF-8?q?=20this=20one).=20-=20Fixed=20masking=20SubStreamType=20in=20cD?= =?UTF-8?q?evice::PlayPesPacket()=20(thanks=20to=20Werner=20Fink=20=20=20f?= =?UTF-8?q?or=20pointing=20out=20this=20one).=20-=20The=20new=20function?= =?UTF-8?q?=20cPlugin::Stop()=20shall=20be=20used=20to=20stop=20any=20back?= =?UTF-8?q?ground=20activities=20=20=20of=20a=20plugin.=20Previously=20thi?= =?UTF-8?q?s=20was=20done=20in=20the=20plugin's=20destructor,=20but=20it?= =?UTF-8?q?=20is=20=20=20better=20to=20do=20this=20in=20a=20dedicated=20fu?= =?UTF-8?q?nction=20that=20can=20be=20called=20early=20when=20shutting=20?= =?UTF-8?q?=20=20down.=20-=20Moved=20the=20call=20to=20SetAudioChannel(0)?= =?UTF-8?q?=20into=20cDevice::ClrAvailableTracks()=20to=20have=20it=20=20?= =?UTF-8?q?=20executed=20also=20when=20starting=20a=20replay.=20-=20Comple?= =?UTF-8?q?ted=20the=20Danish=20OSD=20texts=20(thanks=20to=20Mogens=20Elne?= =?UTF-8?q?ff).=20-=20Completed=20the=20French=20OSD=20texts=20(thanks=20t?= =?UTF-8?q?o=20Olivier=20Jacques).=20-=20The=20new=20setup=20option=20"OSD?= =?UTF-8?q?/Channel=20info=20time"=20can=20be=20used=20to=20define=20the?= =?UTF-8?q?=20time=20after=20=20=20which=20the=20channel=20display=20is=20?= =?UTF-8?q?removed=20if=20no=20key=20has=20been=20pressed=20(thanks=20to?= =?UTF-8?q?=20=20=20Olivier=20Jacques).=20-=20Modified=20cDolbyRepacker=20?= =?UTF-8?q?to=20make=20sure=20PES=20packets=20don't=20exceed=20the=20reque?= =?UTF-8?q?sted=20length=20=20=20(thanks=20to=20Reinhard=20Nissl).=20-=20F?= =?UTF-8?q?ixed=20several=20memory=20leaks=20that=20were=20introduced=20th?= =?UTF-8?q?rough=20the=20use=20of=20cString=20(thanks=20=20=20to=20Stefan?= =?UTF-8?q?=20Huelswitt=20for=20reporting=20these).=20-=20Added=20CMD=5FSP?= =?UTF-8?q?U=5FCHG=5FCOLCON=20to=20cDvbSpuDecoder::setTime()=20(thanks=20t?= =?UTF-8?q?o=20Marco=20Schl=C3=BC=C3=9Fler).=20-=20Making=20sure=20the=20c?= =?UTF-8?q?urrent=20audio=20track=20is=20actually=20one=20of=20the=20ones?= =?UTF-8?q?=20available=20in=20a=20=20=20recording=20(thanks=20to=20Sascha?= =?UTF-8?q?=20Volkenandt=20for=20reporting=20a=20problem=20when=20starting?= =?UTF-8?q?=20=20=20replay=20of=20a=20recording=20that=20has=20no=20Dolby?= =?UTF-8?q?=20Digital=20audio=20after=20switching=20to=20a=20channel=20=20?= =?UTF-8?q?=20that=20has=20DD=20and=20selecting=20the=20DD=20audio=20track?= =?UTF-8?q?).=20-=20Removed=20'flags'=20from=20tTrackId=20(thought=20we=20?= =?UTF-8?q?would=20need=20this,=20but=20apparently=20we=20don't).=20-=20Ma?= =?UTF-8?q?king=20sure=20the=20"Mute"=20and=20"Volume+/-"=20keys=20don't?= =?UTF-8?q?=20interfere=20with=20digital=20audio.=20-=20Fixed=20the=20"pre?= =?UTF-8?q?=201.3.19"=20compatibility=20mode=20for=20old=20Dolby=20Digital?= =?UTF-8?q?=20recordings=20(thanks=20=20=20to=20Werner=20Fink=20for=20poin?= =?UTF-8?q?ting=20out=20that=20this=20can=20be=20triggered=20in=20the=20de?= =?UTF-8?q?fault=20branch).=20-=20Calling=20pesAssembler->Reset()=20in=20c?= =?UTF-8?q?Device::AttachPlayer()=20to=20avoid=20problems=20with=20=20=20r?= =?UTF-8?q?esidual=20data=20in=20replay=20and=20Transfer=20Mode=20(thanks?= =?UTF-8?q?=20to=20Werner=20Fink=20for=20pointing=20this=20=20=20out).=20-?= =?UTF-8?q?=20Added=20MPEG1=20replay=20capability=20to=20cPesAssembler=20(?= =?UTF-8?q?thanks=20to=20Stefan=20Huelswitt).?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- PLUGINS.html | 59 +++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 39 insertions(+), 20 deletions(-) (limited to 'PLUGINS.html') diff --git a/PLUGINS.html b/PLUGINS.html index e8f456a..df6d0fa 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -14,18 +14,18 @@ Copyright © 2004 Klaus Schmidinger
www.cadsoft.de/vdr

-
  -Important modifications introduced in version 1.3.7 are marked like this. -
-
  +
  Important modifications introduced in version 1.3.8 are marked like this.
-
  +
  Important modifications introduced in version 1.3.18 are marked like this.
-
  +
  Important modifications introduced in version 1.3.19 are marked like this.
+
  +Important modifications introduced in version 1.3.20 are marked like this. +

VDR provides an easy to use plugin interface that allows additional functionality to be added to the program by implementing a dynamically loadable library file. @@ -58,6 +58,9 @@ structures and allows it to hook itself into specific areas to perform special a

  • Command line arguments
  • Command line help
  • Getting started +
      +
  • Shutting down +
  • Main menu entry
  • User interaction
  • Housekeeping @@ -75,10 +78,8 @@ structures and allows it to hook itself into specific areas to perform special a
  • Receivers
  • Filters
  • The On Screen Display -
     
  • Skins
  • Themes -
  • Devices
  • Dolby Digital
  • Remote Control @@ -304,8 +305,11 @@ Constructing a plugin object shall not have any side effects or produce any outp since VDR, for instance, has to create the plugin objects in order to get their command line help - and after that immediately destroys them again.

    -The destructor has to clean up any data created by the plugin, and has to -take care that any threads the plugin may have created will be stopped. +The destructor has to clean up any data created by the plugin. +
      +Any threads the plugin may have created shall be stopped in the +Stop() function. +

    Of course, if your plugin doesn't define any member variables that need to be initialized (and deleted), you don't need to implement either of these functions. @@ -500,6 +504,25 @@ VDR to exit. If the plugin doesn't implement any background functionality or internationalized texts, it doesn't need to implement either of these functions. +
      +

    Shutting down

    + +
    Stop it, right there!

    + +If a plugin performs any background tasks, it shall implement the function + +

    +virtual void Stop(void);
+

    + +in which it shall stop them. +

    +The Stop() function will only be called if a previous call to the +Start() function of that plugin has +returned true. The Stop() functions are called in the reverse order +as the Start() functions were called. +

    +

    Main menu entry

    Today's special is...

    @@ -1021,7 +1044,7 @@ public: Take a look at the files player.h and dvbplayer.c to see how VDR implements its own player for the VDR recordings.

    -
      +
      To play the actual data, the player needs to call its member function 

    @@ -1044,7 +1067,7 @@ bool DevicePoll(cPoller &Poller, int TimeoutMs = 0);
 
 to determine whether the device is ready for further data.
 
    
-
     
+
     
 By default all audio track handling is done by the device a player is
 attached to.
 If the player can provide more than a single audio track, and has special
@@ -1181,7 +1204,7 @@ public:
   };
 
 cMyReceiver::cMyReceiver(int Pid)
-
     
+
     
 :cReceiver(0, -1, Pid)
 
    
 {
@@ -1267,7 +1290,6 @@ and will automatically detach itself from the cDevice.
 
    
 See VDR/eit.c or VDR/pat.c to learn how to process filter data.
 
-
     
 
    The On Screen Display
    
 
 
    Window to the world
    
@@ -1360,7 +1382,7 @@ public:
   virtual cSkinDisplayMenu *DisplayMenu(void);
   virtual cSkinDisplayReplay *DisplayReplay(bool ModeOnly);
   virtual cSkinDisplayVolume *DisplayVolume(void);
-
     
+
     
   virtual cSkinDisplayMessage *DisplayTrack(int NumTracks, const char * const *Tracks);
 
    
   virtual cSkinDisplayMessage *DisplayMessage(void);
@@ -1382,7 +1404,7 @@ new cMySkin;
 in the Start() function of your plugin.
 Do not delete this object, it will be automatically deleted when the program ends.
 
    
-
     
+
     
 In order to be able to easily identify plugins that implement a skin it is recommended
 that the name of such a plugin should be
 
@@ -1441,7 +1463,6 @@ osd->DrawText(x, y, s, Theme.Color(clrButtonRedFg), Theme.Color(clrButtonRedB
 By default this will use the colors that have been defined in the respective
 THEME_CLR() line, but may be overwritten through user supplied theme
 files (see man vdr(5) for information about the format of a theme file).
-
    
 
 
    Devices
    
 
@@ -1493,7 +1514,7 @@ repectively.
 If the device can provide more than a single audio track, it can implement the
 following function to make them available:
 
-
     
+
     
 
     virtual void SetAudioTrackDevice(eTrackType Type);
 virtual int GetAudioChannelDevice(void);
@@ -1584,7 +1605,6 @@ handle section data.
 
    
 On Screen Display
 
    
-
     
 If your device provides On Screen Display (OSD) capabilities (which every device
 that is supposed to be used as a primary device should do), it shall implement
 an "OSD provider" class, derived from cOsdProvider, which, when its CreateOsd()
@@ -1618,7 +1638,6 @@ in any way. All it needs to make sure is that the OSD will be visible to the
 user - whether this goes through OSD facilities of the physical device (like
 a "full featured" DVB card) or through a graphics adapter that overlays its
 output with the video signal, doesn't matter.
-
    
 
 
    
 Initializing new devices
-- 
cgit v1.2.3