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	getTargetMimeTypes ()
	Get desired target mime types. More...
static	getSourceMimeTypes ()
static	supportsImageExtraction (string $a_mime)
	Check if mime type supports image extraction. More...
static	exec (string $args)
	Execute ffmpeg. 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 Public Attributes
static array	$last_return = array()
static array	$formats

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 ilObjMediaCastGUI\editCastItemObject(), and ilDclMobRecordFieldModel\parseValue().

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

Here is the caller graph for this function:

exec()

static ilFFmpeg::exec ( string  $args )

static

Execute ffmpeg.

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

References ilShellUtil\execQuoted().

                                             : array
    {
        return ilShellUtil::execQuoted(self::getCmd(), $args);
    }

Here is the call graph for this function:

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 144 of file class.ilFFmpeg.php.

References ilShellUtil\escapeShellArg().

Referenced by ilDclMobRecordFieldModel\parseValue(), and ilObjMediaObject\uploadVideoPreviewPic().

     : 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:

getCmd()

static ilFFmpeg::getCmd ( )

staticprivate

Get ffmpeg command.

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

                                    : string
    {
        return PATH_TO_FFMPEG;
    }

getLastReturnValues()

static ilFFmpeg::getLastReturnValues ( )

static

Get last return values.

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

Referenced by ilObjMediaCastGUI\extractPreviewImageObject(), and ilObjMediaObject\uploadVideoPreviewPic().

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

Here is the caller graph for this function:

getSourceMimeTypes()

static ilFFmpeg::getSourceMimeTypes ( )

static

Returns

string[]

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

References Vendor\Package\$f, and $formats.

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

getTargetMimeTypes()

static ilFFmpeg::getTargetMimeTypes ( )

static

Get desired target mime types.

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

References Vendor\Package\$f, and $formats.

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

supportsImageExtraction()

static ilFFmpeg::supportsImageExtraction ( string  $a_mime )

static

Check if mime type supports image extraction.

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

Referenced by ilObjMediaCastGUI\editCastItemObject(), 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:

• Services/MediaObjects/classes/class.ilFFmpeg.php