ilFFmpeg Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilFFmpeg:

Static Public Member Functions
static	enabled ()
	Checks, whether FFmpeg support is enabled (path is set in the setup) More...
static	getSourceMimeTypes ()
static	supportsImageExtraction (string $a_mime)
	Check if mime type supports image extraction. More...
static	getLastReturnValues ()
	Get last return values. More...
static	extractImage (string $a_file, string $a_target_filename, string $a_target_dir="", int $a_sec=1)
	Extract image from video file. More...
static	extractPNGFromVideoInZip (string $zip, string $path, int $sec=1)

Static Public Attributes
static array	$last_return = array()
static array	$formats

Static Protected Member Functions
static	exec (string $args)
static	escapeShellArg (string $a_arg)

Static Private Member Functions
static	getCmd ()
	Get ffmpeg command. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning FFmpeg wrapper

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilFFmpeg.php.

Member Function Documentation

enabled()

static ilFFmpeg::enabled ( )

static

Checks, whether FFmpeg support is enabled (path is set in the setup)

Definition at line 61 of file class.ilFFmpeg.php.

Referenced by ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\Video\GUIService\addPreviewExtractionToToolbar(), and ilDclMobRecordFieldModel\parseValue().

                                    : bool
    {
        if (defined("PATH_TO_FFMPEG") && PATH_TO_FFMPEG != "") {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

escapeShellArg()

static ilFFmpeg::escapeShellArg ( string  $a_arg )

staticprotected

Definition at line 121 of file class.ilFFmpeg.php.

                                                           : string
    {
        setlocale(
            LC_CTYPE,
            "UTF8",
            "en_US.UTF-8"
        ); // fix for PHP escapeshellcmd bug. See: http://bugs.php.net/bug.php?id=45132
        // see also ilias bug 5630
        return escapeshellarg($a_arg);
    }

exec()

static ilFFmpeg::exec ( string  $args )

staticprotected

Definition at line 104 of file class.ilFFmpeg.php.

                                                : array
    {
        $win = (stripos(php_uname(), "win") === 0);
        $cmd = self::getCmd();
        if ($win && str_contains($cmd, " ") && $cmd[0] !== '"') {
            $cmd = '"' . $cmd . '"';
            if ($args) {
                $cmd .= " " . $args;
            }
        } elseif ($args) {
            $cmd .= " " . $args;
        }
        $arr = [];
        exec($cmd, $arr);
        return $arr;
    }

extractImage()

static ilFFmpeg::extractImage ( string  $a_file, string  $a_target_filename, string  $a_target_dir = "", int  $a_sec = 1  )

static

Extract image from video file.

Parameters

string	$a_file	source file (full path included)
string	$a_target_dir	target directory (no trailing "/")
string	$a_target_filename	target file name (no path!)
int	$a_sec

Returns

string new file (full path)

Exceptions

ilFFmpegException

Definition at line 151 of file class.ilFFmpeg.php.

References ilShellUtil\escapeShellArg().

Referenced by ilDclMobRecordFieldModel\parseValue().

     : string {
        $spi = pathinfo($a_file);

        // use source directory if no target directory is passed
        $target_dir = ($a_target_dir != "")
            ? $a_target_dir
            : $spi['dirname'];

        $target_file = $target_dir . "/" . $a_target_filename;

        $sec = $a_sec;
        $cmd = "-y -i " . ilShellUtil::escapeShellArg(
            $a_file
        ) . " -r 1 -f image2 -vframes 1 -ss " . $sec . " " . ilShellUtil::escapeShellArg($target_file);
        $ret = self::exec($cmd . " 2>&1");
        self::$last_return = $ret;

        if (is_file($target_file)) {
            return $target_file;
        } else {
            throw new ilFFmpegException("It was not possible to extract an image from " . basename($a_file) . ".");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

extractPNGFromVideoInZip()

static ilFFmpeg::extractPNGFromVideoInZip ( string  $zip, string  $path, int  $sec = 1  )

static

Definition at line 180 of file class.ilFFmpeg.php.

References ilFileUtils\ilTempnam().

Referenced by ILIAS\MediaObjects\MediaObjectManager\generatePreview().

     : string {
        $zip = self::escapeShellArg($zip);
        $path = self::escapeShellArg("/" . $path);
        $tfile = ilFileUtils::ilTempnam();
        $tmp_file = self::escapeShellArg($tfile);

        $command1 = "unzip -p $zip $path > $tmp_file";
        shell_exec($command1);
        $command2 = "ffmpeg -i $tmp_file -f image2 -vframes 1 -ss $sec -vcodec png pipe:1";

        $ret = (string) shell_exec($command2);
        unlink($tfile);
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCmd()

static ilFFmpeg::getCmd ( )

staticprivate

Get ffmpeg command.

Definition at line 99 of file class.ilFFmpeg.php.

                                    : string
    {
        return PATH_TO_FFMPEG;
    }

getLastReturnValues()

static ilFFmpeg::getLastReturnValues ( )

static

Get last return values.

Definition at line 136 of file class.ilFFmpeg.php.

Referenced by ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\Video\GUIService\handleExtractionRequest().

                                                : ?array
    {
        return self::$last_return;
    }

Here is the caller graph for this function:

getSourceMimeTypes()

static ilFFmpeg::getSourceMimeTypes ( )

static

Returns

string[]

Definition at line 72 of file class.ilFFmpeg.php.

References Vendor\Package\$f.

                                               : array
    {
        $ttypes = array();
        foreach (self::$formats as $k => $f) {
            if ($f["source"] == true) {
                $ttypes[] = $k;
            }
        }
        return $ttypes;
    }

supportsImageExtraction()

static ilFFmpeg::supportsImageExtraction ( string  $a_mime )

static

Check if mime type supports image extraction.

Definition at line 86 of file class.ilFFmpeg.php.

Referenced by ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\Video\GUIService\addPreviewExtractionToToolbar(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\Extract\Video\GUIService\checkPreviewPossible(), and ilDclMobRecordFieldModel\parseValue().

     : bool {
        if (in_array($a_mime, self::getSourceMimeTypes(), true)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

Field Documentation

$formats

array ilFFmpeg::$formats

static

Initial value:

= array(
        "video/3pgg" => array(
            "source" => true,
            "target" => false
            ),
        "video/x-flv" => array(
            "source" => true,
            "target" => false
            ),
        "video/mp4" => array(
            "source" => true,
            "target" => true,
            "parameters" => "-vcodec libx264 -strict experimental -acodec aac -sameq -ab 56k -ar 48000",
            "suffix" => "mp4"
            ),
        "video/webm" => array(
            "source" => true,
            "target" => true,
            "parameters" => "-strict experimental -vcodec libvpx -acodec vorbis -ac 2 -sameq -ab 56k -ar 48000",
            "suffix" => "webm"
            )
        )

Definition at line 34 of file class.ilFFmpeg.php.

$last_return

array ilFFmpeg::$last_return = array()

static

Definition at line 25 of file class.ilFFmpeg.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/MediaObjects/classes/class.ilFFmpeg.php