Author: duncan
Date: Mon Oct 22 03:15:53 2007
New Revision: 10021
Log:
Corrected docstrings that are not formatted correctly
Modified:
branches/rel-1-7/freevo/src/animation/base.py
branches/rel-1-7/freevo/src/animation/render.py
branches/rel-1-7/freevo/src/animation/transition.py
branches/rel-1-7/freevo/src/audio/plugins/album_tree.py
branches/rel-1-7/freevo/src/audio/plugins/mplayervis.py
branches/rel-1-7/freevo/src/tv/plugins/vbi2srt_record.py
branches/rel-1/freevo/src/animation/base.py
branches/rel-1/freevo/src/animation/render.py
branches/rel-1/freevo/src/animation/transition.py
branches/rel-1/freevo/src/audio/plugins/album_tree.py
branches/rel-1/freevo/src/audio/plugins/mplayervis.py
branches/rel-1/freevo/src/tv/plugins/vbi2srt_record.py
Modified: branches/rel-1-7/freevo/src/animation/base.py
==============================================================================
--- branches/rel-1-7/freevo/src/animation/base.py (original)
+++ branches/rel-1-7/freevo/src/animation/base.py Mon Oct 22 03:15:53 2007
@@ -39,11 +39,11 @@
Base class for animations, this should perhaps be changed to use sprites
in the future (if one decides to go with a RenderGroup model)
- @rectstyle : the rectangle defining the position on the screen (pygame)
- @fps : Desired fps
- @bg_update : update the animation with background from screen
- @bg_wait : initially wait for updated background before activating
- @bg_redraw : set background to original screen bg when finished
+ @param rectstyle : the rectangle defining the position on the screen
(pygame)
+ @param fps : Desired fps
+ @param bg_update : update the animation with background from screen
+ @param bg_wait : initially wait for updated background before activating
+ @param bg_redraw : set background to original screen bg when finished
"""
background = None # Surface Background (screen)
@@ -160,7 +160,7 @@
"""
Checks if the screen background has been damaged
- @notes: If the rect passed damages our rect, but no actual blit is done
+ @notes If the rect passed damages our rect, but no actual blit is done
on osd.screen, we'll end up with a copy of our animation in our bg.
This is BAD.
"""
Modified: branches/rel-1-7/freevo/src/animation/render.py
==============================================================================
--- branches/rel-1-7/freevo/src/animation/render.py (original)
+++ branches/rel-1-7/freevo/src/animation/render.py Mon Oct 22 03:15:53 2007
@@ -67,10 +67,10 @@
"""
This class/interface handles updating animation sprites
- @problems: How to do everything correctly so we don't end up with garbled
+ @problems How to do everything correctly so we don't end up with garbled
screens. Currently there's probably tons of problems with this.
- @notes: Perhaps we should utilize spritegroups for this, as it is supposed
+ @notes Perhaps we should utilize spritegroups for this, as it is supposed
to be optimized for this kind of stuff - pluss we get alot of code for
free.
(ex. RenderUpdates). All animations objects would need to extend the
pygame.sprite.Sprite object.
Modified: branches/rel-1-7/freevo/src/animation/transition.py
==============================================================================
--- branches/rel-1-7/freevo/src/animation/transition.py (original)
+++ branches/rel-1-7/freevo/src/animation/transition.py Mon Oct 22 03:15:53 2007
@@ -49,10 +49,10 @@
def __init__(self, surf1, surf2, mode=-1, direction='vertical', fps=25):
"""
- @surf1: Surface to blend with
- @surf2: New surface
- @mode: effect to use
- @direction: vertical/horizontal
+ @param surf1: Surface to blend with
+ @param surf2: New surface
+ @param mode: effect to use
+ @param direction: vertical/horizontal
"""
BaseAnimation.__init__(self, surf1.get_rect(), fps, bg_update=False)
Modified: branches/rel-1-7/freevo/src/audio/plugins/album_tree.py
==============================================================================
--- branches/rel-1-7/freevo/src/audio/plugins/album_tree.py (original)
+++ branches/rel-1-7/freevo/src/audio/plugins/album_tree.py Mon Oct 22
03:15:53 2007
@@ -107,7 +107,7 @@
Requires:
* pysqlite.
- Pre Installation
+ === Pre Installation ===
The sqlite-meta-database should be available.
@@ -122,16 +122,7 @@
* wait.....
* The meta database should be available now.
- Installation
-
- *Download freevo-audio-album-tree-0.x.x.tgz
- {{{
- tar -zxvf freevo-audio-album-tree-0.x.x.tgz
- cd freevo-audio-album-tree0.x.x
- python setup.py install
- }}}
-
- Configuration
+ === Configuration ===
Edit your local_config.py and add this:
@@ -176,7 +167,8 @@
| ,'alt_grouping':[None,None,None,'track']
| })
- Post Installation
+ === Post Installation ===
+
New plugins are not immediately visible on the freevo webserver.
You might want to restart the [wiki:Webserver freevo webserver] after the
Modified: branches/rel-1-7/freevo/src/audio/plugins/mplayervis.py
==============================================================================
--- branches/rel-1-7/freevo/src/audio/plugins/mplayervis.py (original)
+++ branches/rel-1-7/freevo/src/audio/plugins/mplayervis.py Mon Oct 22
03:15:53 2007
@@ -84,8 +84,8 @@
"""
Pass a message to the screen.
- @message: text to draw
- @timeout: how long to display
+ @param message: text to draw
+ @param timeout: how long to display
"""
font = skin.get_font('detachbar')
Modified: branches/rel-1-7/freevo/src/tv/plugins/vbi2srt_record.py
==============================================================================
--- branches/rel-1-7/freevo/src/tv/plugins/vbi2srt_record.py (original)
+++ branches/rel-1-7/freevo/src/tv/plugins/vbi2srt_record.py Mon Oct 22
03:15:53 2007
@@ -77,7 +77,7 @@
| 'S13' : 246250,
| 'K05' : 175500,
| 'K10' : 211000,
- | ]
+ | }
Requirements:
* vbi2srt: (http://www.linuxowl.com/vbi2srt.html)
Modified: branches/rel-1/freevo/src/animation/base.py
==============================================================================
--- branches/rel-1/freevo/src/animation/base.py (original)
+++ branches/rel-1/freevo/src/animation/base.py Mon Oct 22 03:15:53 2007
@@ -39,11 +39,11 @@
Base class for animations, this should perhaps be changed to use sprites
in the future (if one decides to go with a RenderGroup model)
- @rectstyle : the rectangle defining the position on the screen (pygame)
- @fps : Desired fps
- @bg_update : update the animation with background from screen
- @bg_wait : initially wait for updated background before activating
- @bg_redraw : set background to original screen bg when finished
+ @param rectstyle : the rectangle defining the position on the screen
(pygame)
+ @param fps : Desired fps
+ @param bg_update : update the animation with background from screen
+ @param bg_wait : initially wait for updated background before activating
+ @param bg_redraw : set background to original screen bg when finished
"""
background = None # Surface Background (screen)
Modified: branches/rel-1/freevo/src/animation/render.py
==============================================================================
--- branches/rel-1/freevo/src/animation/render.py (original)
+++ branches/rel-1/freevo/src/animation/render.py Mon Oct 22 03:15:53 2007
@@ -67,10 +67,10 @@
"""
This class/interface handles updating animation sprites
- @problems: How to do everything correctly so we don't end up with garbled
+ @problems How to do everything correctly so we don't end up with garbled
screens. Currently there's probably tons of problems with this.
- @notes: Perhaps we should utilize spritegroups for this, as it is supposed
+ @notes Perhaps we should utilize spritegroups for this, as it is supposed
to be optimized for this kind of stuff - pluss we get alot of code for
free.
(ex. RenderUpdates). All animations objects would need to extend the
pygame.sprite.Sprite object.
Modified: branches/rel-1/freevo/src/animation/transition.py
==============================================================================
--- branches/rel-1/freevo/src/animation/transition.py (original)
+++ branches/rel-1/freevo/src/animation/transition.py Mon Oct 22 03:15:53 2007
@@ -49,10 +49,10 @@
def __init__(self, surf1, surf2, mode=-1, direction='vertical', fps=25):
"""
- @surf1: Surface to blend with
- @surf2: New surface
- @mode: effect to use
- @direction: vertical/horizontal
+ @param surf1: Surface to blend with
+ @param surf2: New surface
+ @param mode: effect to use
+ @param direction: vertical/horizontal
"""
BaseAnimation.__init__(self, surf1.get_rect(), fps, bg_update=False)
Modified: branches/rel-1/freevo/src/audio/plugins/album_tree.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/album_tree.py (original)
+++ branches/rel-1/freevo/src/audio/plugins/album_tree.py Mon Oct 22
03:15:53 2007
@@ -107,7 +107,7 @@
Requires:
* pysqlite.
- Pre Installation
+ === Pre Installation ===
The sqlite-meta-database should be available.
@@ -122,16 +122,7 @@
* wait.....
* The meta database should be available now.
- Installation
-
- *Download freevo-audio-album-tree-0.x.x.tgz
- {{{
- tar -zxvf freevo-audio-album-tree-0.x.x.tgz
- cd freevo-audio-album-tree0.x.x
- python setup.py install
- }}}
-
- Configuration
+ === Configuration ===
Edit your local_config.py and add this:
@@ -176,7 +167,8 @@
| ,'alt_grouping':[None,None,None,'track']
| })
- Post Installation
+ === Post Installation ===
+
New plugins are not immediately visible on the freevo webserver.
You might want to restart the [wiki:Webserver freevo webserver] after the
Modified: branches/rel-1/freevo/src/audio/plugins/mplayervis.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/mplayervis.py (original)
+++ branches/rel-1/freevo/src/audio/plugins/mplayervis.py Mon Oct 22
03:15:53 2007
@@ -84,8 +84,8 @@
"""
Pass a message to the screen.
- @message: text to draw
- @timeout: how long to display
+ @param message: text to draw
+ @param timeout: how long to display
"""
font = skin.get_font('detachbar')
Modified: branches/rel-1/freevo/src/tv/plugins/vbi2srt_record.py
==============================================================================
--- branches/rel-1/freevo/src/tv/plugins/vbi2srt_record.py (original)
+++ branches/rel-1/freevo/src/tv/plugins/vbi2srt_record.py Mon Oct 22
03:15:53 2007
@@ -32,13 +32,15 @@
#
# -----------------------------------------------------------------------
-__author__ = 'Duncan Webb <[EMAIL PROTECTED]>'
-__doc__ = '''This module requires vbi2srt, see:
+__author__ = "Duncan Webb <[EMAIL PROTECTED]>"
+__doc__ = """
+This module requires vbi2srt, see:
http://www.linuxowl.com/vbi2srt.html
Currently only ivtv cards and teletext is supported
To use this plug-in add the following to local_conf.py
plugin.remove('tv.generic_record')
-plugin_record = plugin.activate('tv.vbi2srt_record')'''
+plugin_record = plugin.activate("tv.vbi2srt_record")
+"""
import sys, string
import random
@@ -61,6 +63,8 @@
class PluginInterface(plugin.Plugin):
"""
Record subtitles from teletext pages (IVTV cards only)
+ Also uses the PDC (Programme Delivery Control) from VPS (Video
+ Programming Signal) to start and stop the recording.
The teletext page number is taken from TV_CHANNELS, eg:
@@ -77,7 +81,7 @@
| 'S13' : 246250,
| 'K05' : 175500,
| 'K10' : 211000,
- | ]
+ | }
Requirements:
* vbi2srt: (http://www.linuxowl.com/vbi2srt.html)
@@ -123,6 +127,8 @@
rec_prog.filename =
os.path.splitext(tv_util.getProgFilename(rec_prog))[0] + '.mpeg'
_debug_('filename %s' % rec_prog.filename)
+ self.vg = self.fc.getVideoGroup(rec_prog.tunerid, False)
+
cl_options = { 'channel' : rec_prog.tunerid,
'frequency' : frequency,
'frequencyMHz' : float(frequency) / 1000,
@@ -135,7 +141,6 @@
'pdc-start' : rec_prog.pdc_start,
}
- self.vg = self.fc.getVideoGroup(rec_prog.tunerid, False)
_debug_('cl_options %s' % cl_options)
_debug_('chan_index %s' % self.fc.chan_index)
_debug_('vg.vdev %s' % self.vg.vdev)
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
