You are here

Home » API reference » Video 6

video_render.php in Video 6

Same filename and directory in other branches
  1. 5 plugins/video_ffmpeg_helper/video_render.php
  2. 6.2 plugins/video_ffmpeg_helper/video_render.php

Renders a video. This script is called concurrently by video_scheduler.php This script has to be launched with "php video_render.php nid vid" If you are not using sites/default/settings.php as your settings file, add an optional parameter for the drupal site url: "php video_render.php nid vid http://example.com/" or "php video_render.php nid vid http://example.org/drupal/"

@author Fabio Varesano <fvaresano at yahoo dot it> porting to Drupal 6 @author Heshan Wanigasooriya <heshan at heidisoft.com><heshanmw@gmail.com> @todo

File

plugins/video_ffmpeg_helper/video_render.php
View source 
<?php

/**
 * @file
 * Renders a video. This script is called concurrently by video_scheduler.php
 * This script has to be launched with "php video_render.php nid vid"
 * If you are not using sites/default/settings.php as your settings file, 
 * add an optional parameter for the drupal site url:
 * "php video_render.php nid vid http://example.com/" or
 * "php video_render.php nid vid http://example.org/drupal/"
 *
 * @author Fabio Varesano <fvaresano at yahoo dot it>
 * porting to Drupal 6
 * @author Heshan Wanigasooriya <heshan at heidisoft.com><heshanmw@gmail.com>
 * @todo
 */

/**
 * video_scheduler.php configuration
*/

// set to the ffmpeg executable
define('VIDEO_RENDERING_FFMPEG_PATH', '/usr/bin/ffmpeg');

// set to the temp file path.

//IMPORTANT: the user who runs this script must have permissions to create files there. If this is not the case the default php temporary folder will be used.
define('VIDEO_RENDERING_TEMP_PATH', '/tmp/video');

// number of conversion jobs active at the same time
define('VIDEO_RENDERING_FFMPEG_INSTANCES', 5);

// nice value to append at the beginning of the command
define('VIDEO_RENDERING_NICE', 'nice -n 19');

/**
 * video_scheduler.php configuration ends.
 * DO NOT EDIT BELOW THIS LINE
*/

/**
 * Define some constants
*/
define('VIDEO_RENDERING_PENDING', 1);
define('VIDEO_RENDERING_ACTIVE', 5);
define('VIDEO_RENDERING_COMPLETE', 10);
define('VIDEO_RENDERING_FAILED', 20);
if (isset($_SERVER['argv'][3])) {
  $url = parse_url($_SERVER['argv'][3]);
  $_SERVER['SCRIPT_NAME'] = $url['path'];
  $_SERVER['HTTP_HOST'] = $url['host'];
}
module_load_include('/includes/bootstrap.inc', 'video_render', 'includes/bootstrap');

// disable error reporting for bootstrap process
error_reporting(E_ERROR);

// let's bootstrap: we will be able to use drupal apis
drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);

// enable full error reporting again
error_reporting(E_ALL);

// allow execution only from the command line!
if (empty($_SERVER['REQUEST_METHOD'])) {
  if ($_SERVER['argc'] < 3) {

    // check for command line arguments
    watchdog('video_render', 'Incorrect parameters to the video_render.php script.', WATCHDOG_ERROR);
    print t('Incorrect parameters');
  }
  else {
    video_render_main();
  }
}
else {
  print t('This script is only executable from the command line.');
  die;
}
print "\n";
function video_render_main() {

  // get parameters passed from command line
  $nid = $_SERVER['argv'][1];
  $vid = $_SERVER['argv'][2];

  // set the status to active
  _video_render_job_change_status($nid, $vid, VIDEO_RENDERING_ACTIVE);

  // load the job object
  $job = _video_render_load_job($nid, $vid, VIDEO_RENDERING_ACTIVE);
  if ($job == NULL) {
    watchdog('video_render', 'video_render.php has been called with an invalid job resource. exiting.');
    die;
  }
  $command = _video_render_get_command($job);

  //print('executing ' . $command); die;
  watchdog('video_render', 'executing: ' . $command);

  //execute the command
  ob_start();
  passthru($command . " 2>&1", $command_return);
  $command_output = ob_get_contents();
  ob_end_clean();

  //print $command_output;
  if (!file_exists($job->convfile) || !filesize($job->convfile)) {
    watchdog('video_render', 'video conversion failed. ffmpeg reported the following output: ' . $command_output, WATCHDOG_ERROR);
    _video_render_set_video_encoded_fid($job->nid, $job->vid, -1);
    _video_render_job_change_status($job->nid, $job->vid, VIDEO_RENDERING_FAILED);
  }
  else {

    // move the video to the definitive location
    $file = array(
      'filename' => basename($job->origfile . ".flv"),
      'filemime' => 'application/octet-stream',
      // is there something better???
      'filesize' => filesize($job->convfile),
      'filepath' => $job->convfile,
      'nid' => $job->nid,
    );
    $file = (object) $file;

    //print_r($file);

    //$dest_dir = variable_get('video_upload_default_path', 'videos') .'/';

    // the above no more works as token supports - use dirname
    $dest_dir = dirname($job->origfile) . '/';
    if (file_copy($file, $dest_dir)) {
      $file->fid = db_next_id('{files}_fid');

      //print_r($file);
      db_query("INSERT INTO {files} (fid, nid, filename, filepath, filemime, filesize) VALUES (%d, %d, '%s', '%s', '%s', %d)", $file->fid, $job->nid, $file->filename, $file->filepath, $file->filemime, $file->filesize);
      db_query("INSERT INTO {upload} (fid, vid, list, description) VALUES (%d, %d, %d, '%s')", $file->fid, $job->vid, $file->list, $file->description);

      // update the video table
      db_query('UPDATE {video} SET vidfile = "%s", videox = %d, videoy = %d WHERE nid=%d AND vid=%d', "", $job->calculatedx, $job->calculatedy, $job->nid, $job->vid);

      // update the video_encoded_fid in video serial data
      _video_render_set_video_encoded_fid($job->nid, $job->vid, $file->fid);
      _video_render_job_change_status($job->nid, $job->vid, VIDEO_RENDERING_COMPLETE);
      watchdog('video_render', 'successfully converted %orig to %dest', array(
        '%orig' => $job->origfile,
        '%dest' => $file->filepath,
      ));

      // delete the temp file
      unlink($job->convfile);
    }
    else {

      // get the username of the process owner
      $ownerarray = posix_getpwuid(posix_getuid());
      $owner = $ownerarray['name'];

      // get the username of the destination folder owner
      $fownerarray = posix_getpwuid(fileowner($dest_dir));
      $fowner = $fownerarray['name'];

      // get destination folder permissions
      $perms = substr(sprintf('%o', fileperms($dest_dir)), -4);
      watchdog('video_render', 'error moving video %vid_file with nid = %nid to %dir the final directory. Check folder permissions.<br />The script was run by %uname .<br />The folder owner is %fowner .<br />The folder permissions are %perms .', array(
        '%vid_file' => $job->origfile,
        '%nid' => $job->nid,
        '%dir' => $dest_dir,
        '%uname' => $owner,
        '%fowner' => $fowner,
        '%perms' => $perms,
      ), WATCHDOG_ERROR);
      _video_render_set_video_encoded_fid($job->nid, $job->vid, -1);
      _video_render_job_change_status($job->nid, $job->vid, VIDEO_RENDERING_FAILED);
    }
  }
}

/**
 * Set the video_encoded_fid in the video table
 * We store -1 as video_encoded_fid if the encoding failed
*/
function _video_render_set_video_encoded_fid($nid, $vid, $encoded_fid) {
  db_lock_table('video');
  $node = db_fetch_object(db_query("SELECT serialized_data FROM {video} WHERE nid = %d AND vid = %d", $nid, $vid));
  $node->serial_data = unserialize($node->serialized_data);
  $node->serial_data['video_encoded_fid'] = $encoded_fid;
  $node->serialized_data = serialize($node->serial_data);
  db_query("UPDATE {video} SET serialized_data = '%s' WHERE nid = %d AND vid = %d", $node->serialized_data, $nid, $vid);
  db_unlock_tables();
}

/**
 * Get a string cointaining the command to be executed including options
*/
function _video_render_get_command(&$job) {
  $videofile = escapeshellarg($job->origfile);

  // escape file name for safety
  $convfile = tempnam(VIDEO_RENDERING_TEMP_PATH, 'video-rendering');
  $audiobitrate = variable_get('video_ffmpeg_helper_auto_cvr_audio_bitrate', 64);
  $videobitrate = variable_get('video_ffmpeg_helper_auto_cvr_video_bitrate', 200);
  $size = _video_render_get_size($job);
  $converter = VIDEO_RENDERING_FFMPEG_PATH;
  $options = preg_replace(array(
    '/%videofile/',
    '/%convertfile/',
    '/%audiobitrate/',
    '/%size/',
    '/%videobitrate/',
  ), array(
    $videofile,
    $convfile,
    $audiobitrate,
    $size,
    $videobitrate,
  ), variable_get('video_ffmpeg_helper_auto_cvr_options', '-y -i %videofile -f flv -ar 22050 -ab %audiobitrate -s %size -b %videobitrate -qscale 1 %convertfile'));

  // set to the converted file output
  $job->convfile = $convfile;
  return VIDEO_RENDERING_NICE . " {$converter} {$options}";
}

/**
 * Calculate the converted video size basing on the width set on administration.
 * Aspect ration is maintained.
*/
function _video_render_get_size(&$job) {
  $def_width = variable_get('video_ffmpeg_helper_auto_cvr_width', 400);
  $height = $def_width * ($job->videoy / $job->videox);

  // do you remember proportions?? :-)
  $height = round($height);

  // add one if odd
  if ($height % 2) {
    $height++;
  }
  $job->calculatedx = $def_width;
  $job->calculatedy = $height;
  return $def_width . 'x' . $height;
}

/**
 * Load a job
*/
function _video_render_load_job($nid, $vid, $status) {
  $result = db_query('SELECT * FROM {video_rendering} vr INNER JOIN {node} n ON vr.vid = n.vid INNER JOIN {video} v ON n.vid = v.vid WHERE n.nid = v.nid AND vr.nid = n.nid AND vr.status = %d AND n.nid = %d AND n.vid = %d', $status, $nid, $vid);
  return db_fetch_object($result);
}

/**
 * Change the status to $status of the job having nid=$nid and vid=$vid
*/
function _video_render_job_change_status($nid, $vid, $status) {
  $result = db_query('UPDATE {video_rendering} SET status = %d WHERE nid = %d AND vid = %d', $status, $nid, $vid);
}

Functions

Namesort descending Description
video_render_main
_video_render_get_command Get a string cointaining the command to be executed including options
_video_render_get_size Calculate the converted video size basing on the width set on administration. Aspect ration is maintained.
_video_render_job_change_status Change the status to $status of the job having nid=$nid and vid=$vid
_video_render_load_job Load a job
_video_render_set_video_encoded_fid Set the video_encoded_fid in the video table We store -1 as video_encoded_fid if the encoding failed

Constants

Namesort descending Description
VIDEO_RENDERING_ACTIVE
VIDEO_RENDERING_COMPLETE
VIDEO_RENDERING_FAILED
VIDEO_RENDERING_FFMPEG_INSTANCES
VIDEO_RENDERING_FFMPEG_PATH
VIDEO_RENDERING_NICE
VIDEO_RENDERING_PENDING Define some constants
VIDEO_RENDERING_TEMP_PATH