diff options
| -rw-r--r-- | HISTORY | 13 | ||||
| -rw-r--r-- | PLUGINS.html | 125 | ||||
| -rw-r--r-- | PLUGINS/src/osddemo/COPYING | 340 | ||||
| -rw-r--r-- | PLUGINS/src/osddemo/HISTORY | 6 | ||||
| -rw-r--r-- | PLUGINS/src/osddemo/Makefile | 82 | ||||
| -rw-r--r-- | PLUGINS/src/osddemo/README | 18 | ||||
| -rw-r--r-- | PLUGINS/src/osddemo/osddemo.c | 153 | ||||
| -rw-r--r-- | menu.c | 23 | ||||
| -rw-r--r-- | menu.h | 4 | ||||
| -rwxr-xr-x | newplugin | 6 | ||||
| -rw-r--r-- | osd.c | 3 | ||||
| -rw-r--r-- | osd.h | 9 | ||||
| -rw-r--r-- | plugin.c | 4 | ||||
| -rw-r--r-- | plugin.h | 4 | ||||
| -rw-r--r-- | vdr.c | 7 |
15 files changed, 740 insertions, 57 deletions
@@ -1768,7 +1768,7 @@ Video Disk Recorder Revision History - Fixed a compiler warning regarding cMenuChannels::Del() and MenuTimers::Del() hiding the base class virtual functions. -2002-11-15: Version 1.1.17 +2002-11-24: Version 1.1.17 - Added new entries to 'ca.conf'. - Fixed closing unused PID handles (thanks to Stefan Schluenss for reporting this @@ -1777,3 +1777,14 @@ Video Disk Recorder Revision History - Fixed disabling multiple recordings on a single DVB card (comment out the definition of the macros DO_REC_AND_PLAY_ON_PRIMARY_DEVICE and DO_MULTIPLE_RECORDINGS in dvbdevice.c). +- Plugins can now have their very own OSD setup in the object they return from + a call to cPlugin::MainMenuAction(). In order to implement this, the return type + of cPlugin::MainMenuAction() had to be changed from (cOsdMenu *) to (cOsdObject *). + So in case you are compiling an existing plugin with this version of VDR and you + get an error message, simply change cOsdMenu to cOsdObject in the plugin's source + for the MainMenuAction() function. + Plugin authors who have so far (ab)used the cControl mechanism to implement their + own raw OSD should take a look at the new demo plugin 'osddemo'. It implements + a very primitive game that shows how a plugin can have its own raw OSD. Especially + look into cLineGame and see how it implements the Show() function. See also + the chapter on "User interaction" in PLUGINS.html. diff --git a/PLUGINS.html b/PLUGINS.html index e5948868..fe651303 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -13,30 +13,68 @@ separate from the core VDR source, without the need of patching the original VDR code (and all the problems of correlating various patches). <p> This document is divided into two parts, the first one describing the -<a href="#Part I - The Outside Interface"><i>outside</i> interface</a> +<a href="#Part I - The External Interface"><i>external</i> interface</a> of the plugin system, and the second one describing the -<a href="#Part II - The Inside Interface"><i>inside</i> interface</a>. -The <i>outside</i> interface handles everything necessary for a plugin to get hooked into the core +<a href="#Part II - The Internal Interface"><i>internal</i> interface</a>. +The <i>external</i> interface handles everything necessary for a plugin to get hooked into the core VDR program and present itself to the user. -The <i>inside</i> interface provides the plugin code access to VDR's internal data +The <i>internal</i> interface provides the plugin code access to VDR's internal data structures and allows it to hook itself into specific areas to perform special actions. <p> -<!--X1.1.12--><table width=100%><tr><td bgcolor=#0000AA> </td><td width=100%> -Important modifications introduced in version 1.1.12 are marked like this. -<!--X1.1.12--></td></tr></table> -<!--X1.1.13--><table width=100%><tr><td bgcolor=#00AA00> </td><td width=100%> +<!--X1.1.13--><table width=100%><tr><td bgcolor=#0000AA> </td><td width=100%> Important modifications introduced in version 1.1.13 are marked like this. <!--X1.1.13--></td></tr></table> -<!--X1.1.14--><table width=100%><tr><td bgcolor=#AA0000> </td><td width=100%> +<!--X1.1.14--><table width=100%><tr><td bgcolor=#00AA00> </td><td width=100%> Important modifications introduced in version 1.1.14 are marked like this. <!--X1.1.14--></td></tr></table> -<!--X1.1.15--><table width=100%><tr><td bgcolor=#FF0000> </td><td width=100%> +<!--X1.1.15--><table width=100%><tr><td bgcolor=#AA0000> </td><td width=100%> Important modifications introduced in version 1.1.15 are marked like this. <!--X1.1.15--></td></tr></table> +<!--X1.1.17--><table width=100%><tr><td bgcolor=#FF0000> </td><td width=100%> +Important modifications introduced in version 1.1.17 are marked like this. +<!--X1.1.17--></td></tr></table> -<a name="Part I - The Outside Interface"><hr><center><h1>Part I - The Outside Interface</h1></center> +<hr> +<h1>Table Of Contents</h1> +<ul> +<li><a href="#Part I - The External Interface">Part I - The External Interface</a> +<ul> +<li><a href="#Quick start">Quick start</a> +<li><a href="#The name of the plugin">The name of the plugin</a> +<li><a href="#The plugin directory structure">The plugin directory structure</a> +<li><a href="#Initializing a new plugin directory">Initializing a new plugin directory</a> +<li><a href="#The actual implementation">The actual implementation</a> +<li><a href="#Construction and Destruction">Construction and Destruction</a> +<li><a href="#Version number">Version number</a> +<li><a href="#Description">Description</a> +<li><a href="#Command line arguments">Command line arguments</a> +<li><a href="#Command line help">Command line help</a> +<li><a href="#Getting started">Getting started</a> +<li><a href="#Main menu entry">Main menu entry</a> +<li><a href="#User interaction">User interaction</a> +<li><a href="#Housekeeping">Housekeeping</a> +<li><a href="#Setup parameters">Setup parameters</a> +<li><a href="#The Setup menu">The Setup menu</a> +<li><a href="#Configuration files">Configuration files</a> +<li><a href="#Internationalization">Internationalization</a> +<li><a href="#Loading plugins into VDR">Loading plugins into VDR</a> +<li><a href="#Building the distribution package">Building the distribution package</a> +</ul> +<li><a href="#Part II - The Internal Interface">Part II - The Internal Interface</a> +<ul> +<li><a href="#Status monitor">Status monitor</a> +<li><a href="#Players">Players</a> +<li><a href="#Receivers">Receivers</a> +<li><a href="#The On Screen Display">The On Screen Display</a> +<li><a href="#Devices">Devices</a> +<li><a href="#Dolby Digital">Dolby Digital</a> +<li><a href="#Remote Control">Remote Control</a> +</ul> +</ul> + +<a name="Part I - The External Interface"><hr><center><h1>Part I - The External Interface</h1></center> -<hr><h2>Quick start</h2> +<a name="Quick start"><hr><h2>Quick start</h2> <center><i><b>Can't wait, can't wait!</b></i></center><p> @@ -58,7 +96,7 @@ So, for a quick demonstration of the plugin system, there is a sample plugin cal If you enjoyed this brief glimpse into VDR plugin handling, read through the rest of this document and eventually write your own VDR plugin. -<hr><h2>The name of the plugin</h2> +<a name="The name of the plugin"><hr><h2>The name of the plugin</h2> <center><i><b>Give me some I.D.!</b></i></center><p> @@ -164,7 +202,7 @@ have other plans. Add further files and maybe subdirectories to your plugin source directory as necessary. Don't forget to adapt the <tt>Makefile</tt> appropriately. -<hr><h2>The actual implementation</h2> +<a name="The actual implementation"><hr><h2>The actual implementation</h2> <center><i><b>Use the source, Luke!</b></i></center><p> @@ -231,7 +269,7 @@ and implements a file named <tt>i18n.h</tt>. To make sure it won't clash with VD <tt>i18n.h</tt> it uses the macro <tt>_I18N__H</tt> (one underline at the beginning and two replacing the dot). -<hr><h2>Construction and Destruction</h2> +<a name="Construction and Destruction"><hr><h2>Construction and Destruction</h2> <center><i><b>What goes up, must come down...</b></i></center><p> @@ -256,7 +294,7 @@ take care that any threads the plugin may have created will be stopped. 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. -<hr><h2>Version number</h2> +<a name="Version number"><hr><h2>Version number</h2> <center><i><b>Which incarnation is this?</b></i></center><p> @@ -301,7 +339,7 @@ while those with <i>odd</i> release numbers (like <tt>1.1.x</tt>, <tt>1.3.x</tt> a version number are not limited to single digits, so a version number of <tt>1.2.15</tt> would be acceptable. -<hr><h2>Description</h2> +<a name="Description"><hr><h2>Description</h2> <center><i><b>What is it that you do?</b></i></center><p> @@ -325,7 +363,7 @@ virtual const char *Description(void) Note the <tt>tr()</tt> around the <tt>DESCRIPTION</tt>, which allows the description to be <a href="#Internationalization">internationalized</a>. -<hr><h2>Command line arguments</h2> +<a name="Command line arguments"><hr><h2>Command line arguments</h2> <center><i><b>Taking orders</b></i></center><p> @@ -379,7 +417,7 @@ correctly, or <i>false</i> in case of an error. The first plugin that returns <i>false</i> from a call to its <tt>ProcessArgs()</tt> function will cause VDR to exit. -<hr><h2>Command line help</h2> +<a name="Command line help"><hr><h2>Command line help</h2> <center><i><b>Tell me about it...</b></i></center><p> @@ -434,7 +472,7 @@ write a proper error message to the log file. The first plugin that returns If the plugin doesn't implement any background functionality or internationalized texts, it doesn't need to implement this function. -<hr><h2>Main menu entry</h2> +<a name="Main menu entry"><hr><h2>Main menu entry</h2> <center><i><b>Today's special is...</b></i></center><p> @@ -462,25 +500,34 @@ The menu entries of all plugins will be inserted into VDR's main menu right after the <i>Recordings</i> item, in the same sequence as they were given in the call to VDR. -<hr><h2>User interaction</h2> +<a name="User interaction"><hr><h2>User interaction</h2> <center><i><b>It's showtime!</b></i></center><p> If the user selects the main menu entry of a plugin, VDR calls the function +<!--X1.1.17--><table width=100%><tr><td bgcolor=#FF0000> </td><td width=100%> <p><table><tr><td bgcolor=#F0F0F0><pre><br> -virtual cOsdMenu *MainMenuAction(void); +virtual cOsdObject *MainMenuAction(void); </pre></td></tr></table><p> -which can do one of two things: +which can do one of three things: <ul> <li>Return a pointer to a <tt>cOsdMenu</tt> object which will be displayed as a submenu of the main menu (just like the <i>Recordings</i> menu, for instance). That menu can then implement further functionality and, for instance, could eventually start a custom player to replay a file other than a VDR recording. +<li>Return a pointer to a <tt>cOsdObject</tt> object which will be displayed + instead of the normal menu. The derived <tt>cOsdObject</tt> can open a + <a href="#The On Screen Display">raw OSD</a> from within its <tt>Show()</tt> + function (it should not attempt to do so from within its constructor, since + at that time the OSD is still in use by the main menu). + See the 'osddemo' example that comes with VDR for a demonstration of how this + is done. <li>Perform a specific action and return <tt>NULL</tt>. In that case the main menu will be closed after calling <tt>MainMenuAction()</tt>. </ul> +<!--X1.1.17--></td></tr></table> <b> It is very important that a call to <tt>MainMenuAction()</tt> returns as soon as possible! As long as the program stays inside this function, no other user @@ -488,7 +535,7 @@ interaction is possible. If a specific action takes longer than a few seconds, the plugin should launch a separate thread to do this. </b> -<hr><h2>Housekeeping</h2> +<a name="Housekeeping"><hr><h2>Housekeeping</h2> <center><i><b>Chores, chores...</b></i></center><p> @@ -644,7 +691,7 @@ 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). -<hr><h2>Configuration files</h2> +<a name="Configuration files"><hr><h2>Configuration files</h2> <center><i><b>I want my own stuff!</b></i></center><p> @@ -832,9 +879,9 @@ vdr-hello-0.0.1.tgz in your source directory, where <tt>hello</tt> will be replaced with your actual plugin's name, and <tt>0.0.1</tt> will be your plugin's current version number. -<a name="Part II - The Inside Interface"><hr><center><h1>Part II - The Inside Interface</h1></center> +<a name="Part II - The Internal Interface"><hr><center><h1>Part II - The Internal Interface</h1></center> -<hr><h2>Status monitor</h2> +<a name="Status monitor"><hr><h2>Status monitor</h2> <center><i><b>A piece of the action</b></i></center><p> @@ -907,7 +954,7 @@ See the file <tt>status.h</tt> for detailed information on which status monitor member functions are available in <tt>cStatus</tt>. You only need to implement the functions you actually want to use. -<hr><h2>Players</h2> +<a name="Players"><hr><h2>Players</h2> <center><i><b>Play it again, Sam!</b></i></center><p> @@ -964,7 +1011,7 @@ bool DevicePoll(cPoller &Poller, int TimeoutMs = 0); </pre></td></tr></table><p> to determine whether the device is ready for further data. -<!--X1.1.13--><table width=100%><tr><td bgcolor=#00AA00> </td><td width=100%> +<!--X1.1.13--><table width=100%><tr><td bgcolor=#0000AA> </td><td width=100%> <p> If the player can provide more than a single audio track, it can implement the following functions to make them available: @@ -977,7 +1024,7 @@ virtual void SetAudioTrack(int Index); <!--X1.1.13--></td></tr></table> <p> -<!--X1.1.15--><table width=100%><tr><td bgcolor=#FF0000> </td><td width=100%> +<!--X1.1.15--><table width=100%><tr><td bgcolor=#AA0000> </td><td width=100%> If there is an additional audio track that has to be replayed with external hardware, the player shall call its member function @@ -1085,7 +1132,7 @@ enjoy additional players, since they will be able to control them with actions that they already know. If you absolutely want to do things differently, just go ahead - it's your show... -<hr><h2>Receivers</h2> +<a name="Receivers"><hr><h2>Receivers</h2> <center><i><b>Tapping into the stream...</b></i></center><p> @@ -1139,7 +1186,7 @@ cDevice::PrimaryDevice()->AttachReceiver(Receiver); If the <tt>cReceiver</tt> isn't needed any more, it may simply be <i>deleted</i> and will automatically detach itself from the <tt>cDevice</tt>. -<hr><h2>The On Screen Display</h2> +<a name="The On Screen Display"><hr><h2>The On Screen Display</h2> <center><i><b>Express yourself</b></i></center><p> @@ -1169,7 +1216,7 @@ to define an actual OSD drawing area (see VDR/osdbase.h for the declarations of these functions, and VDR/osd.c to see how VDR opens the OSD and sets up its windows and color depths). -<hr><h2>Devices</h2> +<a name="Devices"><hr><h2>Devices</h2> <center><i><b>Expanding the possibilities</b></i></center><p> @@ -1205,9 +1252,7 @@ If the new device can receive, it most likely needs to provide a way of selecting which channel it shall tune to: <p><table><tr><td bgcolor=#F0F0F0><pre><br> -<!--X1.1.12--><table width=100%><tr><td bgcolor=#0000AA> </td><td width=100%> virtual bool ProvidesSource(int Source) const; -<!--X1.1.12--></td></tr></table> virtual bool ProvidesChannel(const cChannel *Channel, int Priority = -1, bool *NeedsDetachReceivers = NULL); virtual bool SetChannelDevice(const cChannel *Channel, bool LiveView); </pre></td></tr></table><p> @@ -1215,7 +1260,7 @@ virtual bool SetChannelDevice(const cChannel *Channel, bool LiveView); These functions will be called with the desired source or channel and shall return whether this device can provide the requested source or channel and whether tuning to it was successful, repectively. -<!--X1.1.13--><table width=100%><tr><td bgcolor=#00AA00> </td><td width=100%> +<!--X1.1.13--><table width=100%><tr><td bgcolor=#0000AA> </td><td width=100%> <p> <b>Audio selection</b> <p> @@ -1262,7 +1307,7 @@ The functions to implement replaying capabilites are <p><table><tr><td bgcolor=#F0F0F0><pre><br> virtual bool HasDecoder(void) const; -<!--X1.1.14--><table width=100%><tr><td bgcolor=#AA0000> </td><td width=100%> +<!--X1.1.14--><table width=100%><tr><td bgcolor=#00AA00> </td><td width=100%> virtual bool CanReplay(void) const; <!--X1.1.14--></td></tr></table> virtual bool SetPlayMode(ePlayMode PlayMode); @@ -1324,8 +1369,8 @@ shut down (delete) all devices when the program terminates. It is therefore important that the devices are created on the heap, using the <tt>new</tt> operator! -<!--X1.1.15--><table width=100%><tr><td bgcolor=#FF0000> </td><td width=100%> -<hr><h2>Dolby Digital</h2> +<!--X1.1.15--><table width=100%><tr><td bgcolor=#AA0000> </td><td width=100%> +<a name="Dolby Digital"><hr><h2>Dolby Digital</h2> <center><i><b>"The stereo effect may only be experienced if stereo equipment is used!"</b></i></center><p> @@ -1369,7 +1414,7 @@ The <tt>Mute()</tt> and <tt>Clear()</tt> functions will be called whenever the a be muted, or any buffered data shall be cleared, respectively. <!--X1.1.15--></td></tr></table> -<hr><h2>Remote Control</h2> +<a name="Remote Control"><hr><h2>Remote Control</h2> <center><i><b>The joy of zapping!</b></i></center><p> diff --git a/PLUGINS/src/osddemo/COPYING b/PLUGINS/src/osddemo/COPYING new file mode 100644 index 00000000..5b6e7c66 --- /dev/null +++ b/PLUGINS/src/osddemo/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/PLUGINS/src/osddemo/HISTORY b/PLUGINS/src/osddemo/HISTORY new file mode 100644 index 00000000..8c9d3e1a --- /dev/null +++ b/PLUGINS/src/osddemo/HISTORY @@ -0,0 +1,6 @@ +VDR Plugin 'osddemo' Revision History +------------------------------------- + +2002-11-23: Version 0.0.1 + +- Initial revision. diff --git a/PLUGINS/src/osddemo/Makefile b/PLUGINS/src/osddemo/Makefile new file mode 100644 index 00000000..ac56d1f7 --- /dev/null +++ b/PLUGINS/src/osddemo/Makefile @@ -0,0 +1,82 @@ +# +# Makefile for a Video Disk Recorder plugin +# +# $Id: Makefile 1.1 2002/11/23 14:56:44 kls Exp $ + +# The official name of this plugin. +# This name will be used in the '-P...' option of VDR to load the plugin. +# By default the main source file also carries this name. +# +PLUGIN = osddemo + +### The version number of this plugin (taken from the main source file): + +VERSION = $(shell grep 'static const char \*VERSION *=' $(PLUGIN).c | awk '{ print $$6 }' | sed -e 's/[";]//g') + +### The C++ compiler and options: + +CXX = g++ +CXXFLAGS = -O2 -Wall -Woverloaded-virtual + +### The directory environment: + +DVBDIR = ../../../../DVB +VDRDIR = ../../.. +LIBDIR = ../../lib +TMPDIR = /tmp + +### Allow user defined options to overwrite defaults: + +-include $(VDRDIR)/Make.config + +### The version number of VDR (taken from VDR's "config.h"): + +VDRVERSION = $(shell grep 'define VDRVERSION ' $(VDRDIR)/config.h | awk '{ print $$3 }' | sed -e 's/"//g') + +### The name of the distribution archive: + +ARCHIVE = $(PLUGIN)-$(VERSION) +PACKAGE = vdr-$(ARCHIVE) + +### Includes and Defines (add further entries here): + +INCLUDES += -I$(VDRDIR)/include -I$(DVBDIR)/include + +DEFINES += -DPLUGIN_NAME_I18N='"$(PLUGIN)"' + +### The object files (add further files here): + +OBJS = $(PLUGIN).o + +### Implicit rules: + +%.o: %.c + $(CXX) $(CXXFLAGS) -c $(DEFINES) $(INCLUDES) $< + +# Dependencies: + +MAKEDEP = g++ -MM -MG +DEPFILE = .dependencies +$(DEPFILE): Makefile + @$(MAKEDEP) $(DEFINES) $(INCLUDES) $(OBJS:%.o=%.c) > $@ + +-include $(DEPFILE) + +### Targets: + +all: libvdr-$(PLUGIN).so + +libvdr-$(PLUGIN).so: $(OBJS) + $(CXX) $(CXXFLAGS) -shared $(OBJS) -o $@ + @cp $@ $(LIBDIR)/$@.$(VDRVERSION) + +dist: clean + @-rm -rf $(TMPDIR)/$(ARCHIVE) + @mkdir $(TMPDIR)/$(ARCHIVE) + @cp -a * $(TMPDIR)/$(ARCHIVE) + @tar czf $(PACKAGE).tgz -C $(TMPDIR) $(ARCHIVE) + @-rm -rf $(TMPDIR)/$(ARCHIVE) + @echo Distribution package created as $(PACKAGE).tgz + +clean: + @-rm -f $(OBJS) $(DEPFILE) *.so *.tgz core* *~ diff --git a/PLUGINS/src/osddemo/README b/PLUGINS/src/osddemo/README new file mode 100644 index 00000000..cc150aba --- /dev/null +++ b/PLUGINS/src/osddemo/README @@ -0,0 +1,18 @@ +This is a "plugin" for the Video Disk Recorder (VDR). + +Written by: Klaus Schmidinger <kls@cadsoft.de> + +Project's homepage: http://www.cadsoft.de/vdr + +Latest version available at: http://www.cadsoft.de/vdr + +See the file COPYING for license information. + +Description: + +Demonstration of how a plugin can have its very own OSD setup. + +It's a very primitive game that opens a small window in which the +user can draw lines with the Up, Down, Left and Right buttons. +The color buttons are used to switch color. +Press Ok to close the window. diff --git a/PLUGINS/src/osddemo/osddemo.c b/PLUGINS/src/osddemo/osddemo.c new file mode 100644 index 00000000..f806178d --- /dev/null +++ b/PLUGINS/src/osddemo/osddemo.c @@ -0,0 +1,153 @@ +/* + * osddemo.c: A plugin for the Video Disk Recorder + * + * See the README file for copyright information and how to reach the author. + * + * $Id: osddemo.c 1.1 2002/11/24 10:32:59 kls Exp $ + */ + +#include <vdr/plugin.h> + +static const char *VERSION = "0.0.1"; +static const char *DESCRIPTION = "Demo of arbitrary OSD setup"; +static const char *MAINMENUENTRY = "Osd Demo"; + +// --- cLineGame ------------------------------------------------------------- + +class cLineGame : public cOsdObject { +private: + cOsdBase *osd; + int x; + int y; + eDvbColor color; +public: + cLineGame(void); + ~cLineGame(); + virtual void Show(void); + virtual eOSState ProcessKey(eKeys Key); + }; + +cLineGame::cLineGame(void) +{ + osd = NULL; + x = y = 50; + color = clrRed; +} + +cLineGame::~cLineGame() +{ + delete osd; +} + +void cLineGame::Show(void) +{ + osd = cOsd::OpenRaw(100, 50); + if (osd) { + osd->Create(0, 0, 100, 200, 4); + osd->AddColor(clrBackground); + osd->AddColor(clrRed); + osd->AddColor(clrGreen); + osd->AddColor(clrYellow); + osd->AddColor(clrBlue); + osd->Clear(); + osd->Flush(); + } +} + +eOSState cLineGame::ProcessKey(eKeys Key) +{ + eOSState state = cOsdObject::ProcessKey(Key); + if (state == osUnknown) { + switch (Key & ~k_Repeat) { + case kUp: if (y > 0) y--; break; + case kDown: if (y < 196) y++; break; + case kLeft: if (x > 0) x--; break; + case kRight: if (x < 96) x++; break; + case kRed: color = clrRed; break; + case kGreen: color = clrGreen; break; + case kYellow: color = clrYellow; break; + case kBlue: color = clrBlue; break; + case kOk: return osEnd; + default: return state; + } + osd->Fill(x, y, x + 3, y + 3, color); + osd->Flush(); + state = osContinue; + } + return state; +} + +// --- cPluginOsddemo -------------------------------------------------------- + +class cPluginOsddemo : public cPlugin { +private: + // Add any member variables or functions you may need here. +public: + cPluginOsddemo(void); + virtual ~cPluginOsddemo(); + virtual const char *Version(void) { return VERSION; } + virtual const char *Description(void) { return DESCRIPTION; } + virtual const char *CommandLineHelp(void); + virtual bool ProcessArgs(int argc, char *argv[]); + virtual bool Start(void); + virtual void Housekeeping(void); + virtual const char *MainMenuEntry(void) { return MAINMENUENTRY; } + virtual cOsdObject *MainMenuAction(void); + virtual cMenuSetupPage *SetupMenu(void); + virtual bool SetupParse(const char *Name, const char *Value); + }; + +cPluginOsddemo::cPluginOsddemo(void) +{ + // Initialize any member variables here. + // DON'T DO ANYTHING ELSE THAT MAY HAVE SIDE EFFECTS, REQUIRE GLOBAL + // VDR OBJECTS TO EXIST OR PRODUCE ANY OUTPUT! +} + +cPluginOsddemo::~cPluginOsddemo() +{ + // Clean up after yourself! +} + +const char *cPluginOsddemo::CommandLineHelp(void) +{ + // Return a string that describes all known command line options. + return NULL; +} + +bool cPluginOsddemo::ProcessArgs(int argc, char *argv[]) +{ + // Implement command line argument processing here if applicable. + return true; +} + +bool cPluginOsddemo::Start(void) +{ + // Start any background activities the plugin shall perform. + return true; +} + +void cPluginOsddemo::Housekeeping(void) +{ + // Perform any cleanup or other regular tasks. +} + +cOsdObject *cPluginOsddemo::MainMenuAction(void) +{ + // Perform the action when selected from the main VDR menu. + return new cLineGame; +} + +cMenuSetupPage *cPluginOsddemo::SetupMenu(void) +{ + // Return a setup menu in case the plugin supports one. + return NULL; +} + +bool cPluginOsddemo::SetupParse(const char *Name, const char *Value) +{ + // Parse your own setup parameters and store their values. + return false; +} + +VDRPLUGINCREATOR(cPluginOsddemo); // Don't touch this! @@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: menu.c 1.224 2002/11/10 16:05:15 kls Exp $ + * $Id: menu.c 1.225 2002/11/23 14:51:24 kls Exp $ */ #include "menu.h" @@ -2176,6 +2176,8 @@ cMenuPluginItem::cMenuPluginItem(const char *Name, int Index) #define STOP_RECORDING tr(" Stop recording ") #define ON_PRIMARY_INTERFACE tr("on primary interface") +cOsdObject *cMenuMain::pluginOsdObject = NULL; + cMenuMain::cMenuMain(bool Replaying, eOSState State) :cOsdMenu("") { @@ -2195,6 +2197,13 @@ cMenuMain::cMenuMain(bool Replaying, eOSState State) } } +cOsdObject *cMenuMain::PluginOsdObject(void) +{ + cOsdObject *o = pluginOsdObject; + pluginOsdObject = NULL; + return o; +} + void cMenuMain::Set(void) { Clear(); @@ -2308,9 +2317,15 @@ eOSState cMenuMain::ProcessKey(eKeys Key) if (item) { cPlugin *p = cPluginManager::GetPlugin(item->PluginIndex()); if (p) { - cOsdMenu *menu = p->MainMenuAction(); - if (menu) - return AddSubMenu(menu); + cOsdObject *menu = p->MainMenuAction(); + if (menu) { + if (menu->IsMenu()) + return AddSubMenu((cOsdMenu *)menu); + else { + pluginOsdObject = menu; + return osPlugin; + } + } } } state = osEnd; @@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: menu.h 1.49 2002/10/27 12:04:49 kls Exp $ + * $Id: menu.h 1.50 2002/11/23 14:51:32 kls Exp $ */ #ifndef __MENU_H @@ -20,10 +20,12 @@ class cMenuMain : public cOsdMenu { private: time_t lastActivity; bool replaying; + static cOsdObject *pluginOsdObject; void Set(void); public: cMenuMain(bool Replaying, eOSState State = osUnknown); virtual eOSState ProcessKey(eKeys Key); + static cOsdObject *PluginOsdObject(void); }; class cDisplayChannel : public cOsdObject { @@ -12,7 +12,7 @@ # See the main source file 'vdr.c' for copyright information and # how to reach the author. # -# $Id: newplugin 1.11 2002/11/01 13:43:50 kls Exp $ +# $Id: newplugin 1.12 2002/11/23 15:00:35 kls Exp $ $PLUGIN_NAME = $ARGV[0] || die "Usage: newplugin <name>\n"; @@ -165,7 +165,7 @@ public: virtual bool Start(void); virtual void Housekeeping(void); virtual const char *MainMenuEntry(void) { return MAINMENUENTRY; } - virtual cOsdMenu *MainMenuAction(void); + virtual cOsdObject *MainMenuAction(void); virtual cMenuSetupPage *SetupMenu(void); virtual bool SetupParse(const char *Name, const char *Value); }; @@ -205,7 +205,7 @@ void cPlugin${PLUGIN_CLASS}::Housekeeping(void) // Perform any cleanup or other regular tasks. } -cOsdMenu *cPlugin${PLUGIN_CLASS}::MainMenuAction(void) +cOsdObject *cPlugin${PLUGIN_CLASS}::MainMenuAction(void) { // Perform the action when selected from the main VDR menu. return NULL; @@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: osd.c 1.37 2002/11/10 12:30:09 kls Exp $ + * $Id: osd.c 1.38 2002/11/16 14:20:26 kls Exp $ */ #include "osd.h" @@ -316,6 +316,7 @@ eOSState cOsdItem::ProcessKey(eKeys Key) cOsdMenu::cOsdMenu(const char *Title, int c0, int c1, int c2, int c3, int c4) { + isMenu = true; digit = 0; hasHotkeys = false; visible = false; @@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: osd.h 1.36 2002/11/10 12:28:57 kls Exp $ + * $Id: osd.h 1.37 2002/11/24 10:32:29 kls Exp $ */ #ifndef __OSD_H @@ -110,14 +110,19 @@ public: }; class cOsdObject { + friend class cOsdMenu; +private: + bool isMenu; protected: bool needsFastResponse; public: - cOsdObject(bool FastResponse = false) { needsFastResponse = FastResponse; } + cOsdObject(bool FastResponse = false) { isMenu = false; needsFastResponse = FastResponse; } virtual ~cOsdObject() {} int Width(void) { return Interface->Width(); } int Height(void) { return Interface->Height(); } bool NeedsFastResponse(void) { return needsFastResponse; } + bool IsMenu(void) { return isMenu; } + virtual void Show(void) {} virtual eOSState ProcessKey(eKeys Key) { return osUnknown; } }; @@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: plugin.c 1.7 2002/08/11 11:21:00 kls Exp $ + * $Id: plugin.c 1.8 2002/11/16 14:22:37 kls Exp $ */ #include "plugin.h" @@ -64,7 +64,7 @@ const char *cPlugin::MainMenuEntry(void) return NULL; } -cOsdMenu *cPlugin::MainMenuAction(void) +cOsdObject *cPlugin::MainMenuAction(void) { return NULL; } @@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: plugin.h 1.4 2002/05/13 15:32:14 kls Exp $ + * $Id: plugin.h 1.5 2002/11/16 14:22:24 kls Exp $ */ #ifndef __PLUGIN_H @@ -37,7 +37,7 @@ public: virtual void Housekeeping(void); virtual const char *MainMenuEntry(void); - virtual cOsdMenu *MainMenuAction(void); + virtual cOsdObject *MainMenuAction(void); virtual cMenuSetupPage *SetupMenu(void); virtual bool SetupParse(const char *Name, const char *Value); @@ -22,7 +22,7 @@ * * The project's page is at http://www.cadsoft.de/people/kls/vdr * - * $Id: vdr.c 1.132 2002/11/03 12:00:00 kls Exp $ + * $Id: vdr.c 1.133 2002/11/24 10:32:40 kls Exp $ */ #include <getopt.h> @@ -551,6 +551,11 @@ int main(int argc, char *argv[]) Interface->Info(tr("Switching primary DVB...")); cDevice::SetPrimaryDevice(Setup.PrimaryDVB); break; + case osPlugin: DELETENULL(Menu); + Menu = Temp = cMenuMain::PluginOsdObject(); + if (Menu) + Menu->Show(); + break; case osBack: case osEnd: if (Interact == Menu) DELETENULL(Menu); |