plugins/VideoThumbnails/VideoThumbnailsPlugin.php

   1 <?php
   2 /**
   3  * GNU social - a federating social network
   4  *
   5  * Plugin to make thumbnails of video files with ffmpeg/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  *  ffmpeg/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 ffmpeg/avconv.
  41  */
  42
  43 class VideoThumbnailsPlugin extends Plugin
  44 {
  45     const PLUGIN_VERSION = '2.0.0';
  46
  47     /*
  48      * This function should only extract an image from the video stream
  49      * and disregard any cropping or scaling in the resulting file, as
  50      * that will be handled in the core thumbnail algorithm.
  51      */
  52     public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null)
  53     {
  54         // The calling function might accidentally pass application/ogg videos.
  55         // If that's a problem, let's fix it in the calling function.
  56         if ($media !== 'video' || empty($file->filename)) {
  57             return true;
  58         }
  59
  60         try {
  61             // Exception thrown if no thumbnail found
  62             $thumb = File_thumbnail::byFile($file, false);
  63             $imgPath = $thumb->getPath();
  64             // If getPath didn't throw an exception, we have a working locally stored thumbnail
  65             return false;
  66         } catch (NoResultException $e) {
  67             // Alright, no thumbnail found, so let's create one.
  68         } catch (InvalidFilenameException $e) {
  69             // I guess this means $thumb->filename is null? Shouldn't happen because $file->filename is not null, so delete it
  70             $thumb->delete();
  71         } catch (FileNotFoundException $e) {
  72             // Thumb file was not found, let's delete it.
  73             $thumb->delete();
  74         }
  75
  76         // Let's save our frame to a temporary file. If we fail, remove it.
  77         $tmp_imgPath = tempnam(sys_get_temp_dir(), 'socialthumb-');
  78
  79         $cmd = null;
  80         if (shell_exec('which ffmpeg')) {
  81             $cmd = 'ffmpeg';
  82         } elseif (shell_exec('which avconv')) {
  83             $cmd = 'avconv';
  84         } else {
  85             common_log(LOG_ERR, 'Neither ffmpeg nor avconv was found in your PATH. Cannot create video thumbnail.');
  86             return true;
  87         }
  88         $fullcmd = $cmd.' -y -i '.escapeshellarg($file->getPath()).' -vcodec mjpeg -vframes 1 -f image2 -an '.escapeshellarg($tmp_imgPath);
  89         common_debug(__METHOD__ . ' executing: '._ve($fullcmd));
  90         $result = exec($fullcmd);
  91
  92         if (!getimagesize($tmp_imgPath)) {
  93             common_debug('exec of "avconv" produced a bad/nonexisting image it seems');
  94             @unlink($tmp_imgPath);
  95             return true;
  96         }
  97         $imgPath = $tmp_imgPath;
  98         return false;
  99     }
 100
 101     public function onPluginVersion(array &$versions)
 102     {
 103         $versions[] = array('name' => 'Video Thumbnails',
 104                             'version' => self::PLUGIN_VERSION,
 105                             'author' => 'Mikael Nordfeldth',
 106                             'homepage' => 'https://www.gnu.org/software/social/',
 107                             'rawdescription' =>
 108                             // TRANS: Plugin description.
 109                             _m('Video thumbnail preview support.'));
 110         return true;
 111     }
 112 }
 113