From a4246cfd9aa7f3c5a02145815a1e26dcace09327 Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Sun, 28 Jul 2002 11:29:32 +0200 Subject: Fixed PID handling for cReceiver --- PLUGINS.html | 90 ++++++++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 67 insertions(+), 23 deletions(-) (limited to 'PLUGINS.html') diff --git a/PLUGINS.html b/PLUGINS.html index 3d450c25..2a66e88d 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -12,7 +12,7 @@ This interface allows programmers to develop additional functionality for VDR co separate from the core VDR source, without the need of patching the original VDR code (and all the problems of correlating various patches).

-
  +
  This document is divided into two parts, the first one describing the outside interface of the plugin system, and the second one describing the @@ -23,18 +23,18 @@ The inside interface provides the plugin code access to VDR's internal da structures and allows it to hook itself into specific areas to perform special actions.

-
  -Important modifications introduced in version 1.1.2 are marked like this. -
-
  +
  Important modifications introduced in version 1.1.3 are marked like this.
-
  +
  Important modifications introduced in version 1.1.4 are marked like this.
-
  +
  Important modifications introduced in version 1.1.5 are marked like this.
+
  +Important modifications introduced in version 1.1.6 are marked like this. +

Part I - The Outside Interface

@@ -131,15 +131,12 @@ from the web, it will typically have a name like

and will unpack into a directory named

-
  hello-0.0.1 -

To use the plugins and plugins-clean targets from the VDR Makefile you need to unpack such an archive into the VDR/PLUGINS/src directory and create a symbolic link with the basic plugin name, as in -
  



 ln -s hello-0.0.1 hello

@@ -149,7 +146,6 @@ of only lowercase characters and digits, it will only follow the symbolic links, should lead to the current version of the plugin you want to use. This way you can have several different versions of a plugin source (like hello-0.0.1 and hello-0.0.2) and define which one to actually use through the symbolic link. -

Initializing a new plugin directory

@@ -422,11 +418,9 @@ If a plugin implements a function that runs in the background (presumably in a thread of its own), or wants to make use of internationalization, it needs to implement the function -
  



 virtual bool Start(void);

-

which is called once for each plugin at program startup. Inside this function the plugin must set up everything necessary to perform @@ -434,12 +428,10 @@ its task. This may, for instance, be a thread that collects data from the DVB stream, which is later presented to the user via a function that is available from the main menu.

-
  A return value of false indicates that something has gone wrong and the plugin will not be able to perform its task. In that case, the plugin should write a proper error message to the log file. The first plugin that returns false from its Start() function will cause VDR to exit. -

If the plugin doesn't implement any background functionality or internationalized texts, it doesn't need to implement this function. @@ -498,7 +490,6 @@ interaction is possible. If a specific action takes longer than a few seconds, the plugin should launch a separate thread to do this. -
 

Housekeeping

Chores, chores...

@@ -523,7 +514,6 @@ as possible! As long as the program stays inside this function, no other user interaction is possible. If a specific action takes longer than a few seconds, the plugin should launch a separate thread to do this. -

Setup parameters

@@ -656,7 +646,6 @@ You can first assign the temporary values to the global variables and then do th your setup parameters and use that one to copy all parameters with one single statement (like VDR does with its cSetup class). -
 

Configuration files

I want my own stuff!

@@ -711,7 +700,6 @@ plugin class, by writing 



 const char *MyConfigDir = cPlugin::ConfigDirectory();

-

Internationalization

@@ -826,7 +814,7 @@ and display their help and/or version information in addition to its own output. If you want to make your plugin available to other VDR users, you'll need to make a package that can be easily distributed. -
  +
  The Makefile that has been created by the call to newplugin provides the target dist, which does this for you. @@ -848,7 +836,7 @@ vdr-hello-0.0.1.tgz in your source directory, where hello will be replaced with your actual plugin's name, and 0.0.1 will be your plugin's current version number. -
  +
 

Part II - The Inside Interface

Status monitor

@@ -925,7 +913,7 @@ member functions are available in cStatus. You only need to implement the functions you actually want to use.
-
  +
 

Players

Play it again, Sam!

@@ -1076,7 +1064,63 @@ that they already know. If you absolutely want to do things differently, just go ahead - it's your show...

-
  +
  +

Receivers

+ +
Tapping into the stream...

+ +In order to receive any kind of data from a cDevice, a plugin must set up an +object derived from the cReceiver class: + +



+#include <vdr/receiver.h>
+
+class cMyReceiver : public cReceiver, cThread {
+protected:
+  virtual void Activate(bool On);
+  virtual void Receive(uchar *Data, int Length);
+public:
+  cMyReceiver(int Pid);
+  };
+
+cMyReceiver::cMyReceiver(int Pid)
+:cReceiver(0, -1, 1, Pid)
+{
+}
+
+void cMyReceiver::Activate(bool On)
+{
+  // start your own thread for processing the received data
+}
+
+void cMyReceiver::Receive(uchar *Data, int Length)
+{
+  // buffer the data for processing in a separate thread
+}
+

+ +See the comments in VDR/receiver.h for details about the various +member functions of cReceiver. +

+The above example sets up a receiver that wants to receive data from only one +PID (for example the Teletext PID). In order to not interfere with other recording +operations, it sets its priority to -1 (any negative value will allow +a cReceiver to be detached from its cDevice at any time. +

+Once a cReceiver has been created, it needs to be attached to +a cDevice: + +



+cMyReceiver *Receiver = new cMyReceiver(123);
+
+cDevice::PrimaryDevice()->AttachReceiver(Receiver);
+

+ +If the cReceiver isn't needed any more, it may simply be deleted +and will automatically detach itself from the cDevice. +

+ +
 

The On Screen Display

Express yourself

-- cgit v1.2.3