collective.transcode.star

Transcoding support for Plone video files, using collective.transcode.daemon

Project Description

Introduction

collective.transcode.* or transcode.star for short, is a suite of modules that provide transcoding services to Plone sites.

Both the naming scheme and the basic design priciples were inspired by collective.blog.star. Namely:

  • Be modular. Not everyone wants everything your software has to offer.
  • Be flexible. Don't assume that people want to use your software in one way.
  • Be simplistic. If there is a simple way of doing it, do it that way.
  • Be Ploneish. Plone already has 90% of what we need built in. Use it.

It works out of the box with standard Plone Files, providing transcoding services to web friendly formats (mp4, ogv) when uploading video content. Additionally, a jpeg thumbnail is being extracted from the 5th second of the videos and a flowplayer viewlet pointing to the produced mp4 file will be displayed inside the IAboveContentBody viewlet manager when transcoding is complete.

Transcode.star can be easily configured through the Plone Control Panel to work with any custom AT content type, as long as there is a File field in the schema. In the Transcode Settings panel you can enter a new line in the supported portal types, following the format customPortalType:fileFieldName where customPortalType the name of your portal_type and fileFieldName the name of the file field that you need transcoding for.

Support for Dexterity content types is planned for the coming versions.

For the transcoding to work you need to start the transcodedaemon instance provided in the buildout.

If your transcoding needs are high, you can configure several transcode daemons in a load balanced setup. Transcode.star will select the daemon with the minimum transcoding queue length.

All communication between transcode.star and transcode.daemon is encrypted using symmetric encryption by the pycrypto module so that the transcode server(s) transcode videos sent by the Plone site only, preventing abuse by third parties. Also extra care has been taken to transcode videos in private state (typical senario for a Plone site, when users upload a file) by using the same secure channel.

Requirements

Apart from what is assembled by the buildout, the following dependencies must be installed manually for the transcoding scripts to work:

  • ffmpeg with x264 support
  • ffmpeg2theora

In Ubuntu 10.04 you can install the above using the following commands:

sudo wget --output-document=/etc/apt/sources.list.d/medibuntu.list \
http://www.medibuntu.org/sources.list.d/$(lsb_release -cs).list
sudo apt-get --quiet update && sudo apt-get --yes --quiet \
--allow-unauthenticated install medibuntu-keyring
sudo apt-get --quiet update
sudo aptitude install build-essential libavcodec-unstripped-52 ffmpeg \
ffmpeg2theora

Installation

Plone 4.x

python2.6 bootstrap.py
./bin/buildout

Usage

Start zeo:

./bin/zeoserver start

Start the transcode daemon:

./bin/transcodedaemon start # or fg to start it in the foreground

Start the worker instance:

./bin/worker start

Start Zope:

./bin/instance start

Add a new Plone site, go to the Install Products Form and install transcode.star A new control panel screen called "Transcode Settings" will be available. You can use it to configure the supported profiles, the supported mime_types and the portal_types and respective fields that you need transcoding for. If you have changed the secret key in your buildout make sure you enter the new key here as well.

Then simply add a new object (File by default) and upload a file with a mimetype in the supported mimetypes. If you are running transcodedaemon and zope in the foreground you will be able to see the transcoding process taking place. When the transcoding is complete, refresh your content type's view page and you should see a flowplayer instance above your content loaded with the mp4 version of your video.

For production deployments make sure you change the secret key in buildout.cfg and in the Transcode Settings Panel.

Also, when using in production make sure that the transcoded files are served directly by Apache instead of Twisted.

Credits

Contributors

  • Dimitris Moraitis, unweb.me
  • Christos Psaltis, unweb.me
  • Markos Gogoulos, unweb.me
  • Mike Muzurakis, unweb.me
  • Anna Helme, sagaponic.net
  • Giacomo Spettoli, redomino.com
  • Rok Garbas, garbas.si

Changelog

0.21 (2013-01-30)

  • fix permission issue for site managers [mgogoulos]
  • hide manage footer on embed view [mgogoulos]
  • remove stats from embedded videos [clopy]

0.20 (2012-12-04)

  • update transcodedaemon and scripts [dimo]
  • update unisubs widget files [mgogoulos, dimo]

0.19 (2012-11-17)

  • add download links & share button [dimo]
  • support variable dimensions on embed [dimo]
  • fix embed styling [clopy]
  • use local js files for universal subtitles widget [dimo, mgogoulos]
  • add support for universal subtitles [dimo, clopy, mgogoulos]
  • fix unauthorized access when transcoding private videos [clopy]
  • delete transcoded videos when deleting a video [mgogoulos]
  • fix plone.app.async on utility and remove deprecated patch [mgogoulos]

0.18 (2012-07-23)

  • init mediaelementjs player in an iOS friendly way [dimo]

0.17 (2012-07-12)

  • transcode jobs executed asynchronously if plone.app.async is available [dimo, mgogoulos]
  • update to Plone 4.2 [dimo]
  • drop support for Plone 3.x [dimo]

0.16 (2012-04-11)

  • move embed favicon code to embed.pt [clopy]
  • open unisubs share link in new tab [clopy]

0.15 (2012-03-28)

  • Fix subtitle selection on embedded videos [clopy]
  • Add 'view on original site logo' for embeded videos [mgogoulos]

0.14 (2012-01-05)

  • add video/x-matroska to supported mimetypes [dimo]
  • improve embed view display & fix embed dimensions [dimo]
  • warn when skipping transcoding due to unsupported mimetype [dimo]
  • embed view should use the dimensions of the parent iframe [dimo]
  • look for thumbnail in content type first [dimo]

0.13 (2011-12-21)

  • preload video metadata, fixes universal subtitles widget display issue [dimo]

0.12 (2011-12-18)

  • improve embed view styling [dimo]

0.11 (2011-12-17)

  • bug fix in controlpanel's interface [giacomos]
  • moved repo to github [garbas]
  • use html5/mediaelementjs for video playback, drop flowplayer [dimo, clopy, cpsaltis]
  • update buildout, transcoding scripts, add ffmpeg [cpsaltis, dimo]
  • enable switching to hi/low quality [dimo, clopy]
  • provide embed code [dimo, clopy]
  • track transcoding progress [dimo]
  • support opensubtitles [dimo, clopy]

0.10 (2011-05-10)

  • update bootstrap.py [dimo]

0.9 (2011-03-29)

  • pin plone.app.registry to 1.0b2 in Plone 3 buildout - thanks to Daniel Marks for reporting [dimo]

0.8 (2011-03-10)

  • add option to specify transcode profiles when adding jobs to transcode tool
  • remove of unused html5 options

0.7 (2010-11-25)

  • Remove PasteScript dependency from setup.py which was causing problems in dependent packages [dimo]
  • use transcode daemon 0.7

0.6 (2010-10-21)

  • use transcode daemon 0.6, prevents possible pycrypto version conflict [dimo]

0.5 (2010-10-09)

  • delete transcoded video files when the respective content objects are deleted from the portal [clopy, dimo]
  • prevent deletion of TranscodeTool on reinstallation in Plone 3.x [clopy]
  • collective.transcode.burnstation support [clopy, dimo, cpsaltis, provetza]

0.4 (2010-08-04)

  • use transcode.daemon 0.4 and simplify the buildout [dimo]

0.3 (2010-07-31)

  • workaround for plone.app.blob issue with unicode filenames [dimo]
  • fix forced retranscoding for pending requests [dimo]

0.2 (2010-07-23)

  • First public release [dimo]

Download

Self-Certification

[ ] Internationalized

[ ] Unit tests

[X] End-user documentation

[X] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[ ] Installs and uninstalls cleanly

[X] Code structure follows best practice

Current Release
collective.transcode.star 0.21

Released Jan 30, 2013

Download file Get collective.transcode.star for all platforms
collective.transcode.star-0.21.zip
If you are using Plone 3.2 or higher, you probably want to install this product with buildout. See our tutorial on installing add-on products with buildout for more information.

All Releases

Version Released Description Compatibility Licenses Status
0.9 Mar 26, 2011 pin plone.app.registry to 1.0b2 in Plone 3 buildout - thanks to Daniel Marks for reporting More about this release…
Plone 4
Plone 3
GPL final
0.6 Oct 31, 2010 uses transcode daemon 0.6 & prevents possible pycrypto version conflict More about this release…
Plone 4
Plone 3
GPL final
0.5 Oct 10, 2010 added delete hooks, fixed reinstallation issue on Plone 3.x More about this release…
Plone 4
Plone 3
GPL final
0.4 Aug 05, 2010 Use collective.transcode.daemon 0.4 which simplifies the buildout More about this release…
Plone 4
Plone 3
GPL final
0.21 Jan 30, 2013 More about this release… GPL final
0.20 Dec 04, 2012 More about this release… GPL final
0.19 Nov 17, 2012 More about this release… GPL final
0.18 Jul 23, 2012 More about this release… GPL final
0.17 Jul 13, 2012 More about this release… GPL final
0.16 Apr 11, 2012 More about this release… GPL final