Current Release
This documentation covers the latest release of Islandora 7.x. For the very latest in Islandora, we recommend Islandora 8.

Skip to end of metadata
Go to start of metadata

Overview

The Islandora Video Solution Pack is used to ingest digital videos into Fedora. It supports creation of derivatives in various different video formats, and requires the server-side installation of accompanying codecs to enable this functionality. It can also be configured to stream the video to a player window on-site using JWPlayer.

Dependencies

  • Islandora
  • Tuque
  • FFmpeg is required if TN, MKV or MP4 derivatives are to be created on the same server as Islandora. Compilation guides: UbuntuCentOS
  • ffmpeg2Theora (optional) is only necessary if OGG Theora video derivatives are to be created on the same server as Islandora (Instructions).
  • The Islandora Video.js player is required to play videos in a video object's 'View' tab.

FFmpeg versions that have been tested:

  • 1.1.4 It can be downloaded here
  • 2.8.11-0ubuntu0.16.04.1 from Ubuntu 16.04 Package Management

FFmpeg sample compile flags: --prefix=/usr/local/stow/ffmpeg-1.1.4 --enable-gpl --enable-version3 --enable-nonfree --enable-postproc --enable-libopencore-amrnb --enable-libopencore-amrwb --enable-libdc1394 --enable-libfaac --enable-libgsm --enable-libmp3lame --enable-libopenjpeg --enable-libschroedinger --enable-libspeex --enable-libtheora --enable-libvorbis --enable-libvpx --enable-libx264 --enable-libxvid

 remove the --enable-x11grab flag on the ffmpeg configure.

Downloads

Release Notes and Downloads

Installation

This installation can be very tricky, and possibly the most difficult of all components of the Islandora stack. Please see this post regarding past installs on the Islandora Google Group for details: https://groups.google.com/forum/#!topic/islandora/wuOjmRTY5Rs

Configuration

The Islandora Video Solution pack can be configured at Administration » Islandora » Solution Pack Configuration » Video Solution Pack  (http://path.to.your.site/admin/islandora/solution_pack_config/video), and includes the following options:

Viewers

If video.js player has been correctly installed on the server, you will be able to select it as the default player. Videojs is the only player currently supported by Islandora. JW Player is no longer supported beginning with Islandora 7x-1.11. 

Paths to FFmpeg/Theora executables

For derivative creation, the Video Solution Pack needs to know the location of the binaries that perform conversion. On Unix-based systems, this can often be done by running:

whereis ffmpeg ffmpeg2theora

Check for binary package files located in folders called 'bin' (such as /usr/bin, /usr/local/bin, etc.).

Video conversion in any context is an extremely resource-heavy task that can be very taxing on the computer performing it. In the case of Islandora, when using these derivative creation options, the task is called upon and performed by the 'apache' user on the same server Islandora is running on and that users are performing other tasks with. When creating video derivatives on ingest, please consider either delaying ingest to a low-traffic period of time, or performing derivative creation on another machine altogether.

Create .mkv derivative

Creates an optional datastream with datastream ID "MKV". 

Create display mp4 locally

Most players require a datastream called "MP4". Check this option to create the MP4 datastream locally. Disable this if another server will create derivatives.

MP4 audio codec

The audio codec used by ffmpeg. If you are concerned about audio quality in your playable video derivatives, then the current best practice is to use libfdk_aac, which (due to license incompatibilities) cannot be bundled with ffmpeg. Therefore you must compile ffmpeg from source (see above) using the flag `--enable-libfdk-aac `. See https://trac.ffmpeg.org/wiki/Encode/AAC for more details.

Create OGG locally

Creating OGGs locally only exists for legacy compatibility. Unless you have a very good reason for doing so, you should not use this option. If necessary, view ffmpeg2Theora documentation for more on creating OGG derivatives.

Create thumbnail locally

Use ffmpeg to extract a thumbnail from the first section of the video file. This is much less resource-intensive than creating video derivatives, but the option exists to create these derivatives on an external server or defer them as well.

Play OBJ datastream if MP4 is not present

While the MP4 datastream is intended to be the web-friendly, playable version of the file in the 'OBJ' datastream, in some cases, the 'OBJ' datastream is perfectly web-friendly and playable. This option will play such 'OBJ' datastreams in the player in cases where there is no 'MP4' datastream.  In conjunction with the above option to (not) create display 'MP4' locally, this option will allow you to save on storage space for a collection of MP4-type objects.

Maximum file size for playing OBJ (in MB)

Large files may cause problems with players. There is an assumption that 'MP4' derivatives will not be too large to play in any web-based player, but high-quality OBJs might. This provides a size cap on the files that will be served to the player from the OBJ datastream.

 

Content Models, Prescribed Datastreams and Forms

The Video Solution Pack comes with the following objects in http://path.to.your.site/admin/islandora/solution_pack_config/solution_packs:

  • Islandora Video Content Model (islandora:sp_videoCModel)
  • Video Collection (islandora:video_collection)

A collection created using the Video Solution Pack's content model will have the following datastreams:

RELS-EXT

Default Fedora relationship metadata

MODS

MODS descriptive metadata record created during ingest

DC

Dublin Core descriptive metadata record

OBJ

The original video file ingested

TECHMDFITS technical metadata record created during ingest
TNThumbnail image pulled from a frame halfway through the video by ffmpeg
MP4MP4 derivative created during ingest by FFmpeg and sent to the Video.js viewer
MKVMKV derivative optionally created during ingest by FFmpeg

The Video Solution Pack comes with the Video MODS Form.

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

The Video Solution Pack includes an ingest/purge load test that is disabled and unusable by default. This particular solution pack was chosen for load testing due to the resource-heavy process of creating video derivatives and ingesting several potentially-massive files. To enable and use it:

  1. Make sure that the Testing module is enabled and that all prerequisites for derivative creation are satisfied for the Video Solution Pack.
  2. Edit the islandora_video.info file in this folder, removing the ; and whitespace before the line files[] = tests/islandora_video_load_test.test
  3. Create a folder in the tests/fixtures/ called load, and place as many videos in that folder as you would like to ingest. These files all must fit within the size specified by your php.ini file's maximum post size, and they must have a file extension supported by the Video Solution Pack, otherwise they will not be picked up by the load test.
  4. Clear the Drupal cache.

The video load test should now be available to use by navigating to http://path.to.your.site/admin/config/development/testing, checking 'Video Load Test' in the Islandora Video section, and then clicking 'Run tests'. The test will compare the original file to the file ingested into Fedora to see if they match.

THIS WILL NOT WORK ON OPERATING SYSTEMS THAT DO NOT SUPPORT THE PHP GLOB_BRACE FLAG (E.G. SOLARIS).

 

 

 

  • No labels

3 Comments

  1. 1. In the "Dependencies" section, in the third bullet point, the links for Ubuntu and CentOS after "Compilation guides:" could to be updated. Those two links now point to pages with redirects in them.

    2. In the the fifth bullet point, this sentence: "Islandora JWPlayer library (and the Libraries API module) or the" is an incomplete sentence and probably should be removed because it implies Islandora continues to support the JWPlayer library.

    3. Likewise, under the heading "Viewers" this sentence needs to be reworked without mentioning the "Islandora JW Player module": "Videojs and JWplayer are currently supported, but require you to install the islandora_videojs and/or islandora_jwplayer modules and libraries."

    4. Near the bottom of the page under "Development" the link "islandora_video.info" in the sentence that starts "Edit the islandora_video.info file..." doesn't link to anything at all.

    5. The screen print on this page is up-to-date and should replace the out-of-date one in the corresponding github README.md file: https://github.com/Islandora/islandora_solution_pack_video/blob/7.x/README.md

    1. Great catches! Can you please edit the page and make these changes?