plugins/VideoThumbnails/VideoThumbnailsPlugin.php

   1 <?php
   2 /**
   3  * GNU social - a federating social network
   4  *
   5  * Plugin to make thumbnails of video files with avconv
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   GNUsocial
  24  * @author    Mikael Nordfeldth <mmn@hethane.se>
  25  * @copyright 2014 Free Software Foundation http://fsf.org
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      https://www.gnu.org/software/social/
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /*
  33  * Dependencies:
  34  *  avconv (external program call)
  35  *  php5-gd
  36  *
  37  * Todo:
  38  *  Make sure we support ffmpeg too, so we're not super Debian oriented.
  39  *
  40  * Video support will depend on your avconv.
  41  */
  42
  43 class VideoThumbnailsPlugin extends Plugin
  44 {
  45     /*
  46      * This function should only extract an image from the video stream
  47      * and disregard any cropping or scaling in the resulting file, as
  48      * that will be handled in the core thumbnail algorithm.
  49      */
  50     public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null)
  51     {
  52         // The calling function might accidentally pass application/ogg videos.
  53         // If that's a problem, let's fix it in the calling function.
  54         if ($media !== 'video' || empty($file->filename)) {
  55             return true;
  56         }
  57
  58         // Let's save our frame to a temporary file. If we fail, remove it.
  59         $imgPath = tempnam(sys_get_temp_dir(), 'socialthumb-');
  60
  61         $result = exec('avconv -i '.escapeshellarg($file->getPath()).' -vcodec mjpeg -vframes 1 -f image2 -an '.escapeshellarg($imgPath));
  62
  63         if (!getimagesize($imgPath)) {
  64             common_debug('exec of "avconv" produced a bad/nonexisting image it seems');
  65             @unlink($imgPath);
  66             $imgPath = null;    // pretend we didn't touch it
  67             return true;
  68         }
  69         return false;
  70     }
  71
  72     public function onPluginVersion(array &$versions)
  73     {
  74         $versions[] = array('name' => 'Video Thumbnails',
  75                             'version' => GNUSOCIAL_VERSION,
  76                             'author' => 'Mikael Nordfeldth',
  77                             'homepage' => 'https://www.gnu.org/software/social/',
  78                             'rawdescription' =>
  79                             // TRANS: Plugin description.
  80                             _m('Video thumbnail preview support.'));
  81         return true;
  82     }
  83 }
  84