gnu-social/plugins/VideoThumbnails/VideoThumbnailsPlugin.php
2021-07-16 19:44:33 +01:00

114 lines
4.2 KiB
PHP

<?php
/**
* GNU social - a federating social network
*
* Plugin to make thumbnails of video files with ffmpeg/avconv
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Plugin
* @package GNUsocial
* @author Mikael Nordfeldth <mmn@hethane.se>
* @copyright 2014 Free Software Foundation http://fsf.org
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link https://www.gnu.org/software/social/
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/*
* Dependencies:
* ffmpeg/avconv (external program call)
* php5-gd
*
* Todo:
* Make sure we support ffmpeg too, so we're not super Debian oriented.
*
* Video support will depend on your ffmpeg/avconv.
*/
class VideoThumbnailsPlugin extends Plugin
{
const PLUGIN_VERSION = '2.0.0';
/*
* This function should only extract an image from the video stream
* and disregard any cropping or scaling in the resulting file, as
* that will be handled in the core thumbnail algorithm.
*/
public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null)
{
// The calling function might accidentally pass application/ogg videos.
// If that's a problem, let's fix it in the calling function.
if ($media !== 'video' || empty($file->filename)) {
return true;
}
try {
// Exception thrown if no thumbnail found
$thumb = File_thumbnail::byFile($file, false);
$imgPath = $thumb->getPath();
// If getPath didn't throw an exception, we have a working locally stored thumbnail
return false;
} catch (NoResultException $e) {
// Alright, no thumbnail found, so let's create one.
} catch (InvalidFilenameException $e) {
// I guess this means $thumb->filename is null? Shouldn't happen because $file->filename is not null, so delete it
$thumb->delete();
} catch (FileNotFoundException $e) {
// Thumb file was not found, let's delete it.
$thumb->delete();
}
// Let's save our frame to a temporary file. If we fail, remove it.
$tmp_imgPath = tempnam(sys_get_temp_dir(), 'socialthumb-');
$cmd = null;
if (shell_exec('which ffmpeg')) {
$cmd = 'ffmpeg';
} elseif (shell_exec('which avconv')) {
$cmd = 'avconv';
} else {
common_log(LOG_ERR, 'Neither ffmpeg nor avconv was found in your PATH. Cannot create video thumbnail.');
return true;
}
$fullcmd = $cmd.' -y -i '.escapeshellarg($file->getPath()).' -vcodec mjpeg -vframes 1 -f image2 -an '.escapeshellarg($tmp_imgPath);
common_debug(__METHOD__ . ' executing: '._ve($fullcmd));
$result = exec($fullcmd);
if (!getimagesize($tmp_imgPath)) {
common_debug('exec of "avconv" produced a bad/nonexisting image it seems');
@unlink($tmp_imgPath);
return true;
}
$imgPath = $tmp_imgPath;
return false;
}
public function onPluginVersion(array &$versions): bool
{
$versions[] = array('name' => 'Video Thumbnails',
'version' => self::PLUGIN_VERSION,
'author' => 'Mikael Nordfeldth',
'homepage' => 'https://www.gnu.org/software/social/',
'rawdescription' =>
// TRANS: Plugin description.
_m('Video thumbnail preview support.'));
return true;
}
}