Some corrections in docs

Author: dschreij

README.md

@@ -1,9 +1,9 @@
 #Movie decoder for Python based on MoviePy
 
 This library allows you to play and render movies in Python. It is based on the
-(rather excellent) [MoviePy](http://zulko.github.io/moviepy/) module created by Zulko, which offers a convenient Python interface to ffmpeg. This library should hence be able to decode any format that ffmpeg supports. If ffmpeg is not found to be installed, moviepy will download it for you on first usage, which may take some time (keep an eye on that terminal/command prompt to see the download progress).
+(rather excellent) [MoviePy](http://zulko.github.io/moviepy/) module created by Zulko, which offers a convenient Python interface to ffmpeg. This library should hence be able to decode any format that ffmpeg supports. If ffmpeg is not found to be installed, moviepy will download it for you on first use, which may take some time (keep an eye on that terminal/command prompt to see the download progress).
 
-The actual rendering of each frame one will have to implement himself, but you can use the play.py module included in this repository as an example. The `play.py` file contains an example of how to play a video using OpenGL+pygame for the video rendering and pyaudio for audio playback (using pygame.mixer is also an option, but that doesn't work smoothly yet).
+One will have to implement the actual rendering of each frame himself, but you can use the play.py module included in this repository as an example. The `play.py` shows how to play a video using OpenGL+pygame for the video rendering and pyaudio for audio playback (using pygame.mixer is also an option, but that doesn't work smoothly yet).
 
 To see it run right away, you can invoke play.py with the following options:
 

docs/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = ../../_docs/media_player_mpy
+BUILDDIR      = ../../_docs/python-mediadecoder
 PDFBUILDDIR	  = /tmp
 PDF 		  = ../manual.pdf
 

docs/source/api.rst

@@ -5,8 +5,8 @@ Example player
 --------------
 
 .. automodule:: play
-	:members: videoPlayer
-	:special-members:
+	:members: VideoPlayer
+	:special-members: __init__
 
 
 Main classes
@@ -18,14 +18,14 @@ This is the main class that retrieves video and audio frames from MoviePy/ffmpeg
 You can supply Decoder with callback functions that handle stream data once it
 is available.
 
-.. automodule:: media_player.decoder
+.. automodule:: mediadecoder.decoder
 	:members:
 	:special-members: __init__
 
 Timer
 ~~~~~
 
-.. automodule:: media_player.timer
+.. automodule:: mediadecoder.timer
 	:members:
 	:special-members: __init__
 
@@ -35,60 +35,16 @@ Sound renderers
 This module contains objects that handle the audio frames supplied by Decoder.
 At the moment, the only one that is stable is the PyAudioSoundRenderer.
 
-.. automodule:: media_player.sound_renderers
-	:members:
-	:special-members: __init__
-
-
-OpenSesame specific classes
----------------------------
-These classes are for internal usage when the module is used as a plugin in 
-OpenSesame, but they can nonetheless serve as examples that demonstrate how to 
-implement rendering for various windowing toolkits (i.e. pygame, pyglet, pyopengl)
-
-
-Pygame Handler
-~~~~~~~~~~~~~~
-Serves as a base class for the Legacy and Expyriment handlers.
-
-.. automodule:: media_player.handlers.pygame_handler
-	:members:
-	:special-members: __init__
-
-OpenGL Handler
-~~~~~~~~~~~~~~
-Serves as a base class for the Psychopy and Expyriment handlers. These use
-pyglet.gl and pyOpenGL respectively, but the API difference between these is marginal.
-This permits us to use one base class for both GL implementations.
-
-.. automodule:: media_player.handlers.opengl_renderer
-	:members:
-	:special-members: __init__
-
-Legacy Handler
-~~~~~~~~~~~~~~
-Handles rendering and event processing when the legacy backend is used. The
-legacy backend only uses pygame.
-
-.. automodule:: media_player.handlers.legacy_handler
-	:members:
-	:special-members: __init__
-
-Expyriment Handler
-~~~~~~~~~~~~~~~~~~
-Handles rendering and event processing when the Expyriment backend is used.
-The expyriment backend uses pyOpenGL for stimulus presentation, and pygame for
-event processing.
+Pygame
+^^^^^^
 
-.. automodule:: media_player.handlers.expyriment_handler
+.. automodule:: mediadecoder.soundrenderers.pygamerenderer
 	:members:
 	:special-members: __init__
 
-Psychopy Handler
-~~~~~~~~~~~~~~~~
-Handles rendering and event processing when the psychopy backend is used. Psychopy
-uses `pyglet` for both frame rendering and event processing.
+Pyaudio
+^^^^^^^
 
-.. automodule:: media_player.handlers.psychopy_handler
+.. automodule:: mediadecoder.soundrenderers.pyaudiorenderer
 	:members:
 	:special-members: __init__

docs/source/conf.py

@@ -26,9 +26,8 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
-
-sys.path.insert(0, os.path.abspath("../../media_player_mpy"))
-import media_player
+sys.path.insert(0, os.path.abspath("../../"))
+import mediadecoder
 
 # -- General configuration ------------------------------------------------
 
@@ -70,7 +69,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'MoviePy Media Player'
+project = u'MoviePy Media Decoder'
 copyright = u'2016, Daniel Schreij'
 author = u'Daniel Schreij'
 
@@ -79,9 +78,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = media_player.__version__
+version = mediadecoder.__version__
 # The full version, including alpha/beta/rc tags.
-release = media_player.__version__
+release = mediadecoder.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -279,7 +278,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'moviepymediaplayer', u'Moviepy Media Player Documentation',
+    (master_doc, 'moviepymediaplayer', u'Moviepy Media Decoder Documentation',
      [author], 1)
 ]
 
@@ -293,7 +292,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'MoviepyMediaPlayer', u'Moviepy Media Player Documentation',
+    (master_doc, 'MoviepyMediaPlayer', u'Moviepy Media Decoder Documentation',
      author, 'MoviepyMediaPlayer', 'One line description of project.',
      'Miscellaneous'),
 ]

docs/source/dependencies.md

@@ -2,12 +2,11 @@
 
 This module depends on the following other libraries.
 
-- MoviePy (http://zulko.github.io/moviepy/)
-- pyAudio (https://people.csail.mit.edu/hubert/pyaudio/)
+- MoviePy (<http://zulko.github.io/moviepy/>)
+- pyaudio (<https://people.csail.mit.edu/hubert/pyaudio/>)
+- numpy (<http://www.numpy.org/>)
 
 That should be enough to get you started when you plan to implement your own rendering functions to display the video frames. If you also want to be able to view the example provided by `play.py` you furthermore need
 
-- pygame (http://www.pygame.org/)
-- pyOpenGL (http://pyopengl.sourceforge.net/)
-
-When importing as a stand alone, you may get notices that 'psychopy' or 'expyriment' were unable to be imported. Don't mind these messages because they are only relevant for when this module is used with OpenSesame.
+- pygame (<http://www.pygame.org/>)
+- pyOpenGL (<http://pyopengl.sourceforge.net/>)

docs/source/index.rst

@@ -3,13 +3,25 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-MoviePy Media Player documentation
-================================================
+Media decoder documentation
+===========================
 
-This library allows you to play and render movies in Python. It is based on the
-(rather excellent) MoviePy_ module created by Zulko, which offers a convenient Python interface to ffmpeg. This library should hence be able to render any media format that ffmpeg supports. If ffmpeg is not found to be installed, moviepy will download it for you on first usage, which may take some time (keep an eye on that terminal/command prompt to track the download progress).
+This library allows you to decode and render movies in Python. It is based on 
+the (rather excellent) MoviePy_ module created by Zulko, which offers a convenient 
+Python interface to ffmpeg. This library should hence be able to render any media 
+format that ffmpeg supports. If ffmpeg is not found, moviepy will download it for 
+you on first usage, which may take some time 
+(so keep an eye on that terminal/command prompt to track the download progress).
 
-This module is mainly designed to serve as a plugin for the OpenSesame_ experiment builder, but it also works on its own. The ``play.py`` contains an example of how to play a video using OpenGL+pygame for the video rendering and pyaudio for audio playback (using pygame.mixer is also an option, but that doesn't work smoothly yet). You can play a video by calling ``python play.py <path_to_videofile>`` from the command line.
+This library's main purpose is to decode video and/or audio files and supply the 
+user with video and audio frames depending on the playtime of the media stream. 
+The user thus has to take care of the rendering of these frames himself (although 
+modules for sound rendering are included in the package. 
+The ``play.py`` contains an example of how to play a video using OpenGL+pygame for 
+the video rendering and pyaudio for audio playback (using pygame.mixer is also an 
+option, but that doesn't work smoothly yet). You can play a video by calling 
+``python play.py <path_to_videofile>`` from the command line or 
+``python play.py -h`` to view all command line options.
 
 .. toctree::
    :maxdepth: 2
@@ -21,5 +33,4 @@ This module is mainly designed to serve as a plugin for the OpenSesame_ experime
 View on Github_
 
 .. _MoviePy: http://zulko.github.io/moviepy/
-.. _OpenSesame: http://osdoc.cogsci.nl
-.. _Github: https://github.com/dschreij/media_player_mpy
+.. _Github: https://github.com/dschreij/python-mediadecoder

mediadecoder/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.1"
+__version__ = "0.1.2"
 __author__ = "Daniel Schreij"
 __license__ = "MIT"
 

play.py

@@ -14,7 +14,7 @@
 from mediadecoder.decoder import Decoder 
 from mediadecoder.soundrenderers import *
 
-class videoPlayer():
+class VideoPlayer():
 	""" This is an example videoplayer that uses pygame+pyopengl to render a video.
 	It uses the Decoder object to decode the video- and audiostream frame by frame.
 	It shows each videoframe in a window and places the audioframes in a buffer
@@ -304,7 +304,7 @@ def pause(self):
 		sys.exit(2)
 
 	windowRes = tuple(map(int,resolution))
-	myVideoPlayer = videoPlayer(windowRes, fullscreen = args.fullscreen, 
+	myVideoPlayer = VideoPlayer(windowRes, fullscreen = args.fullscreen, 
 		soundrenderer = args.soundrenderer, loop=args.loop)
 	myVideoPlayer.load_media(args.mediafile)
 	logging.debug("Starting video")