From 2bec1d5ca0aad0bc18d99ed33c1b1ce443abb699 Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Sun, 30 Jan 2005 14:23:01 +0100 Subject: [PATCH] Added cPlugin::Stop() --- HISTORY | 4 ++++ PLUGINS.html | 59 ++++++++++++++++++++++++++++++++++------------------ newplugin | 8 ++++++- plugin.c | 30 +++++++++++++++++++------- plugin.h | 8 +++++-- vdr.c | 5 +++-- 6 files changed, 82 insertions(+), 32 deletions(-) diff --git a/HISTORY b/HISTORY index e5e47abb..addafc83 100644 --- a/HISTORY +++ b/HISTORY @@ -3345,3 +3345,7 @@ Video Disk Recorder Revision History Christian Jacobsen for reporting this one). - Fixed masking SubStreamType in cDevice::PlayPesPacket() (thanks to Werner Fink for pointing out this one). +- The new function cPlugin::Stop() shall be used to stop any background activities + of a plugin. Previously this was done in the plugin's desctructor, but it is + better to do this in a dedicated function that can be called early when shutting + down. diff --git a/PLUGINS.html b/PLUGINS.html index e8f456a6..df6d0fad 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
diff --git a/newplugin b/newplugin
index 07d3f685..4a92159d 100755
--- a/newplugin
+++ b/newplugin
@@ -12,7 +12,7 @@
 # See the main source file 'vdr.c' for copyright information and
 # how to reach the author.
 #
-# $Id: newplugin 1.17 2004/10/16 12:12:43 kls Exp $
+# $Id: newplugin 1.18 2005/01/30 13:50:05 kls Exp $
 
 $PLUGIN_NAME = $ARGV[0] || die "Usage: newplugin \n";
 
@@ -164,6 +164,7 @@ public:
   virtual bool ProcessArgs(int argc, char *argv[]);
   virtual bool Initialize(void);
   virtual bool Start(void);
+  virtual void Stop(void);
   virtual void Housekeeping(void);
   virtual const char *MainMenuEntry(void) { return MAINMENUENTRY; }
   virtual cOsdObject *MainMenuAction(void);
@@ -207,6 +208,11 @@ bool cPlugin${PLUGIN_CLASS}::Start(void)
   return true;
 }
 
+void cPlugin${PLUGIN_CLASS}::Stop(void)
+{
+  // Stop any background activities the plugin shall perform.
+}
+
 void cPlugin${PLUGIN_CLASS}::Housekeeping(void)
 {
   // Perform any cleanup or other regular tasks.
diff --git a/plugin.c b/plugin.c
index a06d003c..b7ebf372 100644
--- a/plugin.c
+++ b/plugin.c
@@ -4,7 +4,7 @@
  * See the main source file 'vdr.c' for copyright information and
  * how to reach the author.
  *
- * $Id: plugin.c 1.12 2004/12/19 12:05:28 kls Exp $
+ * $Id: plugin.c 1.13 2005/01/30 14:05:20 kls Exp $
  */
 
 #include "plugin.h"
@@ -28,6 +28,7 @@ char *cPlugin::configDirectory = NULL;
 cPlugin::cPlugin(void) 
 {
   name = NULL;
+  started = false;
 }
 
 cPlugin::~cPlugin()
@@ -60,6 +61,10 @@ bool cPlugin::Start(void)
   return true;
 }
 
+void cPlugin::Stop(void)
+{
+}
+
 void cPlugin::Housekeeping(void)
 {
 }
@@ -322,6 +327,7 @@ bool cPluginManager::StartPlugins(void)
          Setup.OSDLanguage = Language;
          if (!p->Start())
             return false;
+         p->started = true;
          }
       }
   return true;
@@ -366,15 +372,25 @@ cPlugin *cPluginManager::GetPlugin(const char *Name)
   return NULL;
 }
 
-void cPluginManager::Shutdown(bool Log)
+void cPluginManager::StopPlugins(void)
+{
+  for (cDll *dll = dlls.Last(); dll; dll = dlls.Prev(dll)) {
+      cPlugin *p = dll->Plugin();
+      if (p && p->started) {
+         isyslog("stopping plugin: %s", p->Name());
+         p->Stop();
+         p->started = false;
+         }
+      }
+}
+
+void cPluginManager::Shutdown(void)
 {
   cDll *dll;
   while ((dll = dlls.Last()) != NULL) {
-        if (Log) {
-           cPlugin *p = dll->Plugin();
-           if (p)
-              isyslog("stopping plugin: %s", p->Name());
-           }
+        cPlugin *p = dll->Plugin();
+        if (p)
+           isyslog("deleting plugin: %s", p->Name());
         dlls.Del(dll);
         }
 }
diff --git a/plugin.h b/plugin.h
index 2d1cf5d0..3d56b175 100644
--- a/plugin.h
+++ b/plugin.h
@@ -4,7 +4,7 @@
  * See the main source file 'vdr.c' for copyright information and
  * how to reach the author.
  *
- * $Id: plugin.h 1.7 2004/04/30 13:46:21 kls Exp $
+ * $Id: plugin.h 1.8 2005/01/30 14:03:48 kls Exp $
  */
 
 #ifndef __PLUGIN_H
@@ -19,9 +19,11 @@
 
 class cPlugin {
   friend class cDll;
+  friend class cPluginManager;
 private:
   static char *configDirectory;
   const char *name;
+  bool started;
   void SetName(const char *s);
 public:
   cPlugin(void);
@@ -35,6 +37,7 @@ public:
   virtual bool ProcessArgs(int argc, char *argv[]);
   virtual bool Initialize(void);
   virtual bool Start(void);
+  virtual void Stop(void);
   virtual void Housekeeping(void);
 
   virtual const char *MainMenuEntry(void);
@@ -85,7 +88,8 @@ public:
   static bool HasPlugins(void);
   static cPlugin *GetPlugin(int Index);
   static cPlugin *GetPlugin(const char *Name);
-  void Shutdown(bool Log = false);
+  void StopPlugins(void);
+  void Shutdown(void);
   };
 
 #endif //__PLUGIN_H
diff --git a/vdr.c b/vdr.c
index d1f8c4ae..6b2ac379 100644
--- a/vdr.c
+++ b/vdr.c
@@ -22,7 +22,7 @@
  *
  * The project's page is at http://www.cadsoft.de/vdr
  *
- * $Id: vdr.c 1.200 2005/01/14 16:50:39 kls Exp $
+ * $Id: vdr.c 1.201 2005/01/30 14:15:50 kls Exp $
  */
 
 #include 
@@ -928,6 +928,7 @@ int main(int argc, char *argv[])
 
 Exit:
 
+  PluginManager.StopPlugins();
   cRecordControls::Shutdown();
   cCutter::Stop();
   delete Menu;
@@ -941,7 +942,7 @@ Exit:
   Setup.CurrentVolume  = cDevice::CurrentVolume();
   Setup.Save();
   cDevice::Shutdown();
-  PluginManager.Shutdown(true);
+  PluginManager.Shutdown();
   ReportEpgBugFixStats();
   if (WatchdogTimeout > 0)
      dsyslog("max. latency time %d seconds", MaxLatencyTime);