You are here

video_filter.module in Video Filter 5.2

File

video_filter.module
View source
<?php

require_once "video_filter.codecs.inc";

/**
 * Implementation of hook_filter().
 */
function video_filter_filter($op, $delta = 0, $format = -1, $text = '') {
  switch ($op) {
    case 'list':
      return array(
        0 => t('Video Filter'),
      );
    case 'description':
      return t('Substitutes [video:URL] with embedded HTML.');
    case 'process':
      return video_filter_process($text, $format);
    case 'settings':
      return video_filter_settings($format);
    default:
      return $text;
  }
}

/**
 * Implementation of hook_filter_tips().
 */
function video_filter_filter_tips($delta, $format, $long = FALSE) {
  if ($long) {
    $codecs = module_invoke_all('codec_info');
    $supported = array();
    $instructions = array();
    foreach ($codecs as $codec) {
      $supported[] = $codec['name'];
      $instructions[] = $codec['instructions'] != '' ? '<li>' . $codec['name'] . ':<br/>' . $codec['instructions'] . '</li>' : '';
    }
    return t('
      <p><strong>Video Filter</strong></p>
      <p>You may insert videos from popular video sites by using a simple tag <code>[video:URL]</code>.</p>
      <p>Examples:</p>
      <ul>
        <li>Single video:<br /><code>[video:http://www.youtube.com/watch?v=uN1qUeId]</code></li>
        <li>Random video out of multiple:<br /><code>[video:http://www.youtube.com/watch?v=uN1qUeId1,http://www.youtube.com/watch?v=uN1qUeId2]</code></li>
        <li>Override default autoplay setting: <code>[video:http://www.youtube.com/watch?v=uN1qUeId autoplay:1]</code></li>
        <li>Override default width and height:<br /><code>[video:http://www.youtube.com/watch?v=uN1qUeId width:X height:Y]</code></li>
        <li>Align the video:<br /><code>[video:http://www.youtube.com/watch?v=uN1qUeId align:right]</code></li>
      </ul>
      <p>Supported sites: @codecs.</p>
      <p>Special instructions:</p>
      <small>Some codecs need special input. You\'ll find those instructions here.</small>
      <ul>!instructions</ul>', array(
      '@codecs' => implode(', ', $supported),
      '!instructions' => implode('', $instructions),
    ));
  }
  else {
    return t('You may insert videos with [video:URL]');
  }
}
function video_filter_process($text, $format = -1) {
  if (preg_match_all('/\\[video(\\:(.+))?( .+)?\\]/isU', $text, $matches_code)) {
    foreach ($matches_code[0] as $ci => $code) {
      $video = array(
        'source' => $matches_code[2][$ci],
        'width' => variable_get('video_filter_width_' . $format, 400),
        'height' => variable_get('video_filter_height_' . $format, 400),
        'autoplay' => variable_get('video_filter_autoplay_' . $format, 0),
        'related' => variable_get('video_filter_related_' . $format, 1),
      );

      // Insert default values to this settings array so we don't get any "Undefined index" warnings from PHP.
      $video += array(
        'ratio' => 0,
        'control_bar_height' => 0,
        'align' => NULL,
      );

      // Pick random out of multiple sources separated by ','
      if (strstr($video['source'], ',')) {
        $sources = explode(',', $video['source']);
        $random = array_rand($sources, 1);
        $video['source'] = $sources[$random];
      }

      // Load all codecs
      $codecs = module_invoke_all('codec_info');

      // Find codec
      foreach ($codecs as $codec_name => $codec) {
        if (!is_array($codec['regexp'])) {
          $codec['regexp'] = array(
            $codec['regexp'],
          );
        }

        // Try different regular expressions
        foreach ($codec['regexp'] as $delta => $regexp) {
          if (preg_match($regexp, $video['source'], $matches)) {
            $video['codec'] = $codec;
            $video['codec']['delta'] = $delta;
            $video['codec']['matches'] = $matches;
            $video['codec']['codec_name'] = $codec_name;

            // used in theme function
            $video['codec']['control_bar_height'] = 0;

            // default
            break 2;
          }
        }
      }

      // Codec found
      if ($video['codec']) {

        // Override default attributes
        if ($matches_code[3][$ci] && preg_match_all('/\\s+([a-zA-Z_]+)\\:(\\s+)?([0-9\\/]+)/i', $matches_code[3][$ci], $matches_attributes)) {
          foreach ($matches_attributes[0] as $ai => $attribute) {
            $video[$matches_attributes[1][$ai]] = $matches_attributes[2][$ai];
          }
        }

        // Use configured ratio if present, use that from the codec otherwise
        $ratio = 0;
        if ($video['ratio'] && preg_match('/(\\d+)\\/(\\d+)/', $video['ratio'], $tratio)) {

          //validate given ratio parameter
          $ratio = $tratio[1] / $tratio[2];
        }
        else {
          $ratio = $video['codec']['ratio'];
        }

        // Default value for control bar height
        $control_bar_height = 0;
        if ($video['control_bar_height']) {

          // respect control_bar_height option if present
          $control_bar_height = $video['control_bar_height'];
        }
        elseif ($video['codec']['control_bar_height']) {

          // respect setting provided by codec otherwise
          $control_bar_height = $video['codec']['control_bar_height'];
        }

        // Resize to fit within width and height repecting aspect ratio
        if ($ratio) {
          $scale_factor = min(array(
            $video['height'] - $control_bar_height,
            $video['width'] / $ratio,
          ));
          $video['height'] = round($scale_factor + $control_bar_height);
          $video['width'] = round($scale_factor * $ratio);
        }
        $video['autoplay'] = (bool) $video['autoplay'];
        $video['align'] = in_array($video['align'], array(
          'left',
          'right',
          'center',
        )) ? $video['align'] : NULL;
        $replacement = $video['codec']['callback']($video);

        // Invalid format
      }
      else {
        $replacement = '<!-- VIDEO FILTER - INVALID CODEC IN: ' . $code . ' -->';
      }
      $text = str_replace($code, $replacement, $text);
    }
  }
  return $text;
}
function video_filter_settings($format) {
  $form['video_filter'] = array(
    '#type' => 'fieldset',
    '#title' => t('Video filter'),
    '#collapsible' => TRUE,
  );
  $form['video_filter']['video_filter_width_' . $format] = array(
    '#type' => 'textfield',
    '#title' => t('Default width setting'),
    '#default_value' => variable_get('video_filter_width_' . $format, 400),
    '#maxlength' => 4,
  );
  $form['video_filter']['video_filter_height_' . $format] = array(
    '#type' => 'textfield',
    '#title' => t('Default height setting'),
    '#default_value' => variable_get('video_filter_height_' . $format, 400),
    '#maxlength' => 4,
  );
  $form['video_filter']['video_filter_autoplay_' . $format] = array(
    '#type' => 'radios',
    '#title' => t('Default autoplay setting'),
    '#description' => t('Not all video formats support this setting.'),
    '#default_value' => variable_get('video_filter_autoplay_' . $format, 1),
    '#options' => array(
      0 => t('No'),
      1 => t('Yes'),
    ),
  );
  $form['video_filter']['video_filter_related_' . $format] = array(
    '#type' => 'radios',
    '#title' => t('Related videos setting'),
    '#description' => t('Show "related videos"? Not all video formats support this setting.'),
    '#default_value' => variable_get('video_filter_related_' . $format, 1),
    '#options' => array(
      0 => t('No'),
      1 => t('Yes'),
    ),
  );
  return $form;
}

/**
 * Wrapper that calls the theme function.
 */
function video_filter_flash($video, $params = array()) {
  return theme('video_filter_flash', $video, $params);
}

/**
 * Function that outputs the <object> element.
 *
 * @ingroup themeable
 */
function theme_video_filter_flash($video, $params) {
  $output = '';
  $output .= '<object type="application/x-shockwave-flash" ';
  if ($video['align']) {
    $output .= 'style="float:' . $video['align'] . '" ';
  }
  $output .= 'width="' . $video['width'] . '" height="' . $video['height'] . '" data="' . $video['source'] . '">' . "\n";
  $defaults = array(
    'movie' => $video['source'],
    'wmode' => 'transparent',
    'allowFullScreen' => 'true',
  );
  $params = array_merge($defaults, is_array($params) && count($params) ? $params : array());
  foreach ($params as $name => $value) {
    $output .= '  <param name="' . $name . '" value="' . $value . '" />' . "\n";
  }
  $output .= '</object>' . "\n";
  return $output;
}

Functions

Namesort descending Description
theme_video_filter_flash Function that outputs the <object> element.
video_filter_filter Implementation of hook_filter().
video_filter_filter_tips Implementation of hook_filter_tips().
video_filter_flash Wrapper that calls the theme function.
video_filter_process
video_filter_settings