PHP Classes

File: src/PHPVideoToolkit/Format.php

Recommend this page to a friend!
  Classes of Oliver Lillie  >  PHP Video Toolkit  >  src/PHPVideoToolkit/Format.php  >  Download  
File: src/PHPVideoToolkit/Format.php
Role: Class source
Content type: text/plain
Description: Class source
Class: PHP Video Toolkit
Manipulate and convert videos with ffmpeg program
Author: By
Last change: updated copy right years and a incorrect version number
updated version number in class files
Date: 8 years ago
Size: 20,078 bytes
 

Contents

Class file image Download
<?php /** * This file is part of the PHP Video Toolkit v2 package. * * @author Oliver Lillie (aka buggedcom) <publicmail@buggedcom.co.uk> * @license Dual licensed under MIT and GPLv2 * @copyright Copyright (c) 2008-2014 Oliver Lillie <http://www.buggedcom.co.uk> * @package PHPVideoToolkit V2 * @version 2.1.1 * @uses ffmpeg http://ffmpeg.sourceforge.net/ */ namespace PHPVideoToolkit; /** * @access public * @author Oliver Lillie * @package default */ class Format extends FfmpegParser { protected $_format; protected $_type; protected $_media_object; protected $_format_to_command; protected $_additional_commands; protected $_removed_commands; public function __construct($input_output_type, Config $config=null) { parent::__construct($config); $this->setType($input_output_type); $this->_additional_commands = array(); $this->_removed_commands = array(); $this->_media_object = null; $this->_format = array( 'quality' => null, 'format' => null, 'strictness' => null, 'preset_options_file' => null, 'threads' => null, ); $this->_format_to_command = array( 'quality' => '-qscale <setting>', 'format' => '-f <setting>', 'strictness' => '-strict <setting>', 'preset_options_file' => '-fpre <setting>', 'threads' => '-threads <setting>', ); // add default input/output commands if($input_output_type === 'output') { $this->setThreads(1) ->setStrictness('experimental') ->setQualityVsStreamabilityBalanceRatio(4); } else if($input_output_type === 'input') { } else { throw new Exception('Unrecognised input/output type "'.$input_output_type.'" set in \\PHPVideoToolkit\\Format::__construct'); } } /** * Gets a default format for the related path. * If a default format is not found then the fallback_format_class is used. * * @access public * @author Oliver Lillie * @package default * @param $path * @param $config Config * @param $fallback_format_class * @param $type * @return Format */ public static function getFormatFor($path, $config, $fallback_format_class='Format', $type='output') { if(in_array($type, array('input', 'output')) === false) { throw new Exception('Unrecognised format type "'.$type.'".'); } $format = null; $ext = pathinfo($path, PATHINFO_EXTENSION); if(empty($ext) === false) { $format = Extensions::toBestGuessFormat($ext); } // check the requested class exists $class_name = '\\PHPVideoToolkit\\'.$fallback_format_class.(empty($format) === false ? '_'.ucfirst(strtolower($format)) : ''); if(class_exists($class_name) === false) { $requested_class_name = $class_name; $class_name = '\\PHPVideoToolkit\\'.$fallback_format_class; if(class_exists($class_name) === false) { throw new Exception('Requested default format class does not exist, "'.($requested_class_name === $class_name ? $class_name : $requested_class_name.'" and "'.$class_name.'"').'".'); } } // check that it extends from the base Format class. if($class_name !== '\\PHPVideoToolkit\\Format' && is_subclass_of($class_name, '\\PHPVideoToolkit\\Format') === false) { throw new Exception('The class "'.$class_name.'" is not a subclass of \\PHPVideoToolkit\\Format.'); } return new $class_name($type, $config); } protected function _setFilter($format_key, FilterAbstract $filter) { if(isset($this->_format[$format_key]) === false) { throw new Exception('Unknown format key uncountered when setting a filter.'); } if($this->_format[$format_key] === null) { $this->_format[$format_key] = array(); } return array_push($this->_format[$format_key], $filter)-1; } /** * undocumented function * * @access public * @author Oliver Lillie * @return void */ public function getFormatOptions() { return $this->_format; } /** * undocumented function * * @access public * @author Oliver Lillie * @param Media $media * @return void */ public function setMedia(Media $media) { $this->_media_object = $media; return $this; } /** * undocumented function * * @access public * @author Oliver Lillie * @param string $setting_name * @return void */ protected function _blockSetOnInputFormat($setting_name) { if($this->_type === 'input') { $backtrace = debug_backtrace(); throw new Exception('The '.$setting_name.' cannot be set on an input \\'.get_class($backtrace[1]['object']).'::'.$backtrace[1]['function'].'.'); } } /** * undocumented function * * @access public * @author Oliver Lillie * @return void */ public function updateFormatOptions(&$save_path) { if(empty($this->_media_object) === true) { throw new Exception('Unable to update format options as a Media object has not been set through '.get_class($this).'::setMedia'); } return $this; } /** * Builds a returnable command string for the give options and additional commands. * * @access public * @author Oliver Lillie * @return string */ public function getCommandString() { $commands = $this->getCommandsHash(); $command_string = ''; if(empty($commands) === false) { array_walk($commands, function(&$value, $key) { $value = $key.' '.$value; }); $command_string = implode(' ', $commands); } return $command_string; } /** * Builds a returnable command string for the give options and additional commands. * * @access public * @author Oliver Lillie * @return string */ public function getCommandsHash() { $commands = array(); $mapped_commands = array_values($this->_mapFormatToCommands()); $additional_commands = $this->_getAdditionalCommands(); $merged_commands = array_merge($commands, $mapped_commands, $additional_commands); $commands = array(); if(empty($merged_commands) === false) { foreach ($merged_commands as $command) { if(preg_match('/^([^\s]+)\s+(.*)/', $command, $matches) > 0) { // check to see if we have the special "audio/video filters". // if so then they must be grouped together in order to be sent. // TODO decouple this into their own class if($matches[1] === '-af' || $matches[1] === '-vf') { if(isset($commands[$matches[1]]) === false) { $commands[$matches[1]] = array(); } array_push($commands[$matches[1]], $matches[2]); } else { $commands[$matches[1]] = trim($matches[2]); } } else { $commands[$command] = ''; } } } // post process the special cases for filters // TODO decouple into own classes. if(isset($commands['-vf']) === true) { $commands['-vf'] = implode(',', $commands['-vf']); } if(isset($commands['-af']) === true) { $commands['-af'] = implode(',', $commands['-af']); } return $commands; } /** * Builds the additional commands. * * @access public * @author Oliver Lillie * @return array */ protected function _getAdditionalCommands() { $commands = array(); if(empty($this->_additional_commands) === false) { foreach ($this->_additional_commands as $option => $value) { array_push($commands, $option.' '.$value); } } return $commands; } /** * Maps the supplied format options to those in the Format->_format_to_command array. * * @access protected * @author Oliver Lillie * @return array */ protected function _mapFormatToCommands() { $options = array(); foreach ($this->_format as $option => $value) { // if the value is explicitly null or false we ignore it as it has not been set. // if the value is to be set but not be ignored then it should be set as an empty string, ie ''; if($value === null || $value === false) { continue; } if(isset($this->_format_to_command[$option]) === false) { throw new Exception('Unable to map format option to command option as the command option does not exist in the map.'); } // get the full command option string $full_command = $this->_format_to_command[$option]; if(empty($full_command) === true) { continue; } // if the command is an array, that means it has differing options depending on whether or not // this is an input or output format. if(is_array($full_command) === true) { $full_command = $full_command[$this->_type]; } // now just the main command so we can ignore it if found in the additional supplied commands // list of the list of commands to ignore. preg_match('/^([^\s]+)/', $full_command, $matches); $command_name = $matches[1]; // if we've been set this command as an additional command, the additional command takes precedent if(isset($this->_additional_commands[$command_name]) === true) { continue; } // do we have to "remove" / ignore any commands? if(isset($this->_removed_commands[$command_name]) === true) { continue; } // otherwise if the value is an array, that means we have multiple options to replace into the command if(is_array($value) === true) { $find = array_keys($value); array_walk($find, function(&$value, $key) { $value = '<'.$value.'>'; }); $command = str_replace($find, $value, $full_command); } // otherwise, it's jsut a <setting> that is to be replaced else { $command = str_replace('<setting>', $value, $full_command); } $options[$option] = $command; } return $options; } /** * Adds additional commands that will be added to the formatted command string * that is returned from the format object. Any command options added here take * precendence over those set in the Format->_format array * * @access public * @author Oliver Lillie * @param string $option * @param string $arg * @return void */ public function addCommand($option, $arg) { $this->_additional_commands[$option] = $arg; } public function removeCommand() { } /** * Sets the format type, either input or output * * @access public * @author Oliver Lillie * @param string $type * @return void */ public function setType($type) { // validate input if(in_array($type, array('input', 'output')) === true) { $this->_type = $type; return $this; } throw new Exception('Unrecognised format "'.$format.'" set in \\PHPVideoToolkit\\'.get_class($this).'::setFormat'); } /** * A preset file contains a sequence of option=value pairs, one for each line, specifying a sequence of options * which would be awkward to specify on the command line. Lines starting with the hash (’#’) character are ignored * and are used to provide comments. Check the ‘presets’ directory in the FFmpeg source tree for examples. * * @access public * @author Oliver Lillie * @link http://ffmpeg.org/ffmpeg.html#toc-Preset-files * @param string $preset_file_path * @return void */ public function setPresetOptionsFile($preset_file_path) { if($preset_file_path === null) { $this->_format['preset_options_file'] = null; return $this; } $preset_file_path = realpath($preset_file_path); if($preset_file_path === false || is_file($preset_file_path) === false) { throw new Exception('Preset options file "'.$preset_file_path.'" set in \\PHPVideoToolkit\\'.get_class($this).'::setPresetOptionsFile does not exist.'); } else if(is_readable($preset_file_path) === false) { throw new Exception('Preset preset options file "'.$preset_file_path.'" set in \\PHPVideoToolkit\\'.get_class($this).'::setPresetOptionsFile is not readable.'); } $this->_format['preset_options_file'] = $preset_file_path; return $this; } /** * Sets the output strictness (-strictness) determining what level of stable funcitonality is used. * By default "experimental" is used/ * * @access public * @author Oliver Lillie * @param string $strictness * @return void */ public function setStrictness($strictness) { if($strictness === null) { $this->_format['strictness'] = null; return $this; } if(in_array($strictness, array('very', 'strict', 'normal', 'unofficial', 'experimental')) === true) { $this->_format['strictness'] = $strictness; return $this; } throw new Exception('Unrecognised strictness "'.$strictness.'" set in \\PHPVideoToolkit\\'.get_class($this).'::setStrictness'); } /** * Sets the output format of the ffmpeg process. * * @access public * @author Oliver Lillie * @param string $format * @return void */ public function setFormat($format) { // TODO work out what can be input and what can't be inputed if($format === null) { $this->_format['format'] = null; return $this; } // validate input $valid_formats = array_keys($this->getFormats()); if(in_array($format, $valid_formats) === true) { // check to see if segmenting has been requested. If it has warn of the Media::split function instead. if($format === 'segment') { throw new Exception('You cannot set the format to segment, please use instead the function \\PHPVideoToolkit\\Media::segment.'); } $this->_format['format'] = $format; return $this; } throw new Exception('Unrecognised format "'.$format.'" set in \\PHPVideoToolkit\\'.get_class($this).'::setFormat'); } /** * undocumented function * * @access public * @author Oliver Lillie * @param string $threads * @return void */ public function setThreads($threads) { $this->_blockSetOnInputFormat('thread level'); if($threads === null) { $this->_format['threads'] = null; return $this; } if($threads < 1 || $threads > 64) { throw new InvalidArgumentException('Invalid `threads` value; the value must fit in range 1 - 64.'); } $this->_format['threads'] = (int) $threads; return $this; } /** * undocumented function * * @access public * @author Oliver Lillie * @see http://www.kilobitspersecond.com/2007/05/24/ffmpeg-quality-comparison/ * @param string $qscale * @return void */ public function setQualityVsStreamabilityBalanceRatio($qscale) { $this->_blockSetOnInputFormat('quality stream ability balance ratio (qscale)'); if($qscale === null) { $this->_format['quality'] = null; return $this; } if($qscale < 1 || $qscale > 31) { throw new InvalidArgumentException('Invalid quality stream ability balance ratio (qscale) value; the value must fit in range 1 - 31.'); } $this->_format['quality'] = (int) $qscale; return $this; } }