VideoManager Class Reference

Public Member Functions
	VideoManager ()
	hasFFMPEG ()
	open ($file)
	getFrameWidth ()
	getFrameHeight ()
	getFrameRate ()
	getFrame ($idx)
	saveFrame ($offset, $out)
	makeMultipleTwo ($value)
	thumbnailLink ($video_id, $size)
	Returns the URI that can be used to access the specified thumbnail of a video at the given size. More...
	imageLink ($video_id)
	renderThumbnail ($video_id, $size=0, $width=0, $height=0)
	Renders the Image specified by the image_id at the specified size. More...

Static Public Member Functions
static	setDefaults ()
static	onInitialize ()
static	getVideoFolder ()
static	getVideoURI ($video)
static	formatVideoURI ($video)
static	upgradeComponent ($version)
static	displayVideoGallery ($identifier, &$continue)
	Event handler to display an image gallery from the specified identifier. More...
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	deleteGallery ($gallery)
	When deleting a video gallery, we must also delete all videos linked to the gallery and any downloads of those videos. More...
static	videoGalleryTabs ($key)
static	enumerateItems ($items)
	Enumerate the Image Gallery objects. More...
static	registerTaxonomyClasses ($classes)

Public Attributes
	$movieFile = null

Detailed Description

Definition at line 41 of file video_manager.inc.

Member Function Documentation

deleteGallery()

static VideoManager::deleteGallery (   $gallery )

static

When deleting a video gallery, we must also delete all videos linked to the gallery and any downloads of those videos.

Parameters

obj

$gallery

class VideoGallery

Definition at line 497 of file video_manager.inc.

     {
          $tx = new DataTransaction();
          
          try
          {
               $videos = $gallery->Videos();
               
               if(count($videos))
               {
                    $download = new VideoDownload();
                    foreach($videos as $video)
                    {
                         $download->joinTransaction($tx);
                         $video->joinTransaction($tx);
                         $download->delete("WHERE video_id={$video->video_id}");
                         $video->delete();
                    }
               }
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }         
     }

deleteUser()

static VideoManager::deleteUser (   $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj

$user

- class SiteUser or custom user class

Definition at line 449 of file video_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component video is deleting objects dependent on user_id {$user_id}", 3);
     
          $tx = new DataTransaction();
          
          try
          {
               $galleries = Query::create(VideoGallery, "WHERE owner_id=:owner_id")
                    ->bind(":owner_id", $user_id)
                    ->execute();
               
               if(count($galleries))
               {
                    foreach($galleries as $gallery)
                    {
                         $gallery->joinTransaction($tx);
                         VideoManager::deleteGallery($gallery);
                    }
               }
               
               $video = new Video();
               $video->joinTransaction($tx);
               $video->delete("WHERE user_id={$user_id}");
               
               $download = new VideoDownload();
               $download->joinTransaction($tx);
               $download->delete("WHERE user_id={$user_id}");
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
          
          return $user;
     }

displayVideoGallery()

static VideoManager::displayVideoGallery (   $identifier, &  $continue  )

static

Event handler to display an image gallery from the specified identifier.

Parameters

string	$identifier	the identifier to match
boolean	$continue	returns whether to continue processing this event

Definition at line 409 of file video_manager.inc.

     {
          try
          {
               $gallery = Query::create(VideoGallery, "WHERE identifier=:i")
                                   ->bind(":i", $identifier)
                                   ->executeSingle();
                                   
               $page = ComponentPage::findByIdentifier("video_gallery", "WHERE enabled=1");
               $_GET["gallery_id"] = $gallery->video_gallery_id;
          
               $pageView = new ComponentPageView($page);
          
               $page_role = $page->role;
               
               if (!checkRole($page->role))
               {
                    LoginManager::storeRedirectPage();
                    redirect("/login");
               }
               
               echo $pageView->drawView();
               
               $continue = false;
          }
          catch(DataNotFoundException $e)
          {
               
          }
          
          return $identifier;
     }

enumerateItems()

static VideoManager::enumerateItems (   $items )

static

Enumerate the Image Gallery objects.

Parameters

$items

collection that the ImageGallery items are returned in

Definition at line 542 of file video_manager.inc.

     {
          $galleries = Query::create(VideoGallery, "ORDER BY gallery_name")->execute();
          
          $items["Video Galleries"] = $galleries;
          return $items;
     }

formatVideoURI()

static VideoManager::formatVideoURI (   $video )

static

Definition at line 158 of file video_manager.inc.

     {
          echo VideoManager::getVideoURI($video);
     }

getFrame()

VideoManager::getFrame

(

$idx

)

Definition at line 274 of file video_manager.inc.

     {
          return $this->ffmpeg->getFrame($idx);
     }

getFrameHeight()

VideoManager::getFrameHeight

(

)

Definition at line 254 of file video_manager.inc.

     {
          foreach($this->movieInfo->streams as $stream)
          {
               if ($stream->codec_type == "video") return $stream->height;
          }
          
          throw new FakoliException("Failed to locate video stream in file");   
     }

getFrameRate()

VideoManager::getFrameRate

(

)

Definition at line 264 of file video_manager.inc.

     {
          foreach($this->movieInfo->streams as $stream)
          {
               if ($stream->codec_type == "video") return $stream->r_frame_rate;
          }
          
          throw new FakoliException("Failed to locate video stream in file");   
     }

getFrameWidth()

VideoManager::getFrameWidth

(

)

Definition at line 244 of file video_manager.inc.

     {
          foreach($this->movieInfo->streams as $stream)
          {
               if ($stream->codec_type == "video") return $stream->width;
          }
          
          throw new FakoliException("Failed to locate video stream in file");
     }

getVideoFolder()

static VideoManager::getVideoFolder ( )

static

Definition at line 102 of file video_manager.inc.

     {
          global $config;
          
          $location = Settings::getValue("video", "video_upload_location");
          $folder = Settings::getValue("video", "video_folder");
          
          if ($location == "Other")
          {
               $dir = sanitizePath(Settings::getValue("video", "video_upload_other_location") . DIRECTORY_SEPARATOR . $folder);
               trace($dir, 3);
               if (!file_exists($dir))
               {
                    //throw new FakoliException("Video Folder does not exist");
               }
          }
          else if ($location == "Web Folder")
          {
               $dir = $config['homedir']. DIRECTORY_SEPARATOR . $folder;
               if (!file_exists($dir))
               {
                    throw new FakoliException("Video Folder does not exist");
               }
          }
          else
          {
               $dir = $config['uploadbase']. DIRECTORY_SEPARATOR . $folder;
               if (!file_exists($dir))
               {
                    if (!mkdir($dir))
                    {
                         throw new FakoliException("Could not create video upload folder");
                    }
               }
          }
          
          return $dir;
     }

getVideoURI()

static VideoManager::getVideoURI (   $video )

static

Definition at line 141 of file video_manager.inc.

     {
          
          $location = Settings::getValue("video", "video_upload_location");
          
          if ($location == "Web Folder")
          {
               $folder = Settings::getValue("video", "video_folder");           
               $gallery = $video->VideoGallery();
               return "/".$folder."/gallery_".$video->video_gallery_id."/".$video->video_file;
          }
          else
          {
               return "/action/video/stream?video_id=".$video->video_id;
          }
     }    

hasFFMPEG()

VideoManager::hasFFMPEG

(

)

Definition at line 202 of file video_manager.inc.

     {
          $path = Settings::getValue("video", "ffmpeg_path");
          
          if (!$path) 
          {
               trace("FFMPEG: path not set", 3);
               return false;
          }
          
          $ffmpeg = $this->getExecutablePath("ffmpeg");
          if (!file_exists($ffmpeg)) 
          {
               trace("FFMPEG: no executable at $ffmpeg", 3);
               return false;
          }
          
          $ffprobe = $this->getExecutablePath("ffprobe");
          if (!file_exists($ffprobe)) 
          {
               trace("FFMPEG: no executable at $ffprobe", 3);
               return false;
          }
          
          trace("FFMPEG: executables detected in correct location", 3);
          
          return true;
     }

imageLink()

VideoManager::imageLink

(

$video_id

)

Definition at line 304 of file video_manager.inc.

     {
          return "/action/video/show?image_id=$video_id";
     }

makeMultipleTwo()

VideoManager::makeMultipleTwo

(

$value

)

Definition at line 288 of file video_manager.inc.

     {
          return intval($value) >> 1 << 1;
     }

onInitialize()

static VideoManager::onInitialize ( )

static

Definition at line 65 of file video_manager.inc.

     {
          global $isAction;
          global $isResource;
          
          global $html_editor_extra_buttons;
          global $script;
          global $styles;
          
          $html_editor_extra_buttons[] =
                    array("name"   =>   "video_picker",
                           "image" =>   "/fakoli/images/video_button.png", 
                           "tooltip"    =>   "Insert Video",
                           "handler"    =>   "videoPicker");
               
          $useHTML5 = Settings::getValue("video", "use_HTML5_video");
          $useFlash = Settings::getValue("video", "use_flash_video");
          $flowPlayerScript = Settings::getValue("video", "flowplayer_script");
          
          if ($isAction || $isResource) return;
          
          if ($useHTML5)
          {
               $styles = "<link href='//vjs.zencdn.net/4.12/video-js.css' rel='stylesheet'>" . $styles;
               $script = "<script src='//vjs.zencdn.net/4.12/video.js'></script>" . $script;        
          }
          
          if ($useFlash && $flowPlayerScript)
          {
               $script .= "<script type='text/javascript' src='$flowPlayerScript'></script>\n";
          }
          
          $flowPlayer = Settings::getValue("video", "flowplayer_player");
          
          $script .= "<script type='text/javascript'>\nvar flowplayerPath = '$flowPlayer';\n</script>\n";
     }

open()

VideoManager::open

(

$file

)

Definition at line 231 of file video_manager.inc.

     {
          trace("Opening video '$file'", 3);
          
          if (!file_exists($file))
          {
               throw new FakoliException("File not found");
          }
 
          $this->movieFile = $file;
          $this->movieInfo = json_decode($this->execute("ffprobe", "-v quiet -print_format json -show_format -show_streams {$this->movieFile}"));
     }

registerTaxonomyClasses()

static VideoManager::registerTaxonomyClasses (   $classes )

static

Definition at line 550 of file video_manager.inc.

     {
          $classes[] = Video;
          return $classes;
     }

renderThumbnail()

VideoManager::renderThumbnail	(		$video_id,
			$size = 0,
			$width = 0,
			$height = 0
	)

Renders the Image specified by the image_id at the specified size.

Note that the size is the length of the major axis, and aspect ratio is maintained. The generated image is cached after rendering to speed subsequent accesses. The image file is output with the correct HTTP headers to ensure correct interpretation by the browser.

Parameters

$image_id	the ID of the image to render
$size	the size of the major axis, in pixels
$width	the specific width of the rendered thumbnail (if $size is 0)
$height	the specific height of the rendered thumbnail (if $size and $width are 0)

Definition at line 321 of file video_manager.inc.

     {         
          global $config;
          
          $video = new Video($video_id);
 
          //AJG - default to natural size if not specified
          if (!$size && !$width && !$height) 
          {
               $width = $video->width;
               $height = $video->height;
          }
          
          $suffix = $size ? "$size" : ($width ? "{$width}w" : ($height ? "{$height}h" : ""));
          
          $dir = $video->VideoGallery()->getGalleryDirectory();
          
          $imageFile = $dir . DIRECTORY_SEPARATOR . $video->image_file;
          $cacheFile = $dir . DIRECTORY_SEPARATOR . $video->video_id . "_" . $suffix .".png";
          trace("renderThumbnail:: imageFile {$imageFile} and cacheDir {$cacheDir} and cacheFile {$cacheFile}", 3);
          
          if (!file_exists($cacheFile) || (filemtime($cacheFile) < filemtime($imageFile)))
          {
               $src = imagecreatefrompng($imageFile);
               
               // If the thumbnail hasn't been generated yet, or is out-of-date, create it.
               $fullWidth = imagesx($src);
               $fullHeight = imagesy($src);
               
               if ($size)
               {
                    if ($fullWidth > $fullHeight)
                    {
                         $newWidth = $size;
                         $newHeight = intval(($fullHeight * $size) / $fullWidth);
                         
                    }
                    else
                    {
                         $newWidth = intval(($fullWidth * $size) / $fullHeight);
                         $newHeight = $size;
                    }
               }
               else if ($width)
               {
                    $newWidth = $width;
                    $newHeight = intval(($fullHeight * $width) / $fullWidth);
               }
               else if ($height)
               {
                    $newHeight = $height;
                    $newWidth = intval(($fullWidth * $height) / $fullHeight);
               }
               else
               {
                    $newWidth = $fullWidth;
                    $newHeight = $fullHeight;
               }
               
               trace("Rendering $cacheFile @ $newWidth x $newHeight", 3);
               
               $dst = imagecreatetruecolor($newWidth, $newHeight);
               imagecopyresampled($dst, $src, 0, 0, 0, 0, $newWidth, $newHeight, $fullWidth, $fullHeight);
 
               if (file_exists($cacheFile))
               {
                    // If a previous copy of the file already exists, remove it
                    trace("renderThumbnail:: unlinking cachefile", 3);
                    unlink($cacheFile);
               }
                    
               imagepng($dst, $cacheFile);
 
               imagedestroy($dst);
               imagedestroy($src);
          }
 
          Fakoli::sendFile($cacheFile);
 
          trace("renderThumbnail:: exiting", 3);
     }

saveFrame()

VideoManager::saveFrame	(		$offset,
			$out
	)

Definition at line 279 of file video_manager.inc.

     {
          if (!$this->movieFile) throw new FakoliException("Movie File not loaded");
          $width = $this->getFrameWidth();
          $height = $this->getFrameHeight();
          
          $this->execute("ffmpeg", "-ss {$offset} -i {$this->movieFile} -t 1 -s {$width}x{$height} -f image2 {$out}");
     }

setDefaults()

static VideoManager::setDefaults ( )

static

Definition at line 50 of file video_manager.inc.

     {
          Settings::setDefaultValue("video", "video_folder", "videos", String, "Directory inside the web folder that is used to store the video files", "Video Uploads");
          Settings::setDefaultValue("video", "video_upload_location", "Web Folder", String, 
                                          "Indicate whether videos should be stored under the Web Folder or in the document upload area.".
                                          "If you do not have mod_xsendfile installed, then Web Folder is strongly recommended", 
                                          "Video Uploads", "Web Folder\nDocument Upload Folder\nOther");
          Settings::setDefaultValue("video","video_upload_other_location", "", String, "Full path to alternate video location", "Video Uploads");
          Settings::setDefaultValue("video", "use_HTML5_video", false, Boolean, "Check to enable support for HTML5 video", "Video Player", null, 1);
          Settings::setDefaultValue("video", "use_flash_video", true, Boolean, "Check to enable support for old-style FLV (requires Flowplayer Flash)", "Video Player", null, 2);
          Settings::setDefaultValue("video", "flowplayer_script", "", String, "URI for the Flowplayer script", "Video Player", null, 3);
          Settings::setDefaultValue("video", "flowplayer_player", "", String, "URI for the Flowplayer SWF file", "Video Player", null, 4);
          Settings::setDefaultValue("video", "ffmpeg_path", "", String, "Directory containing the ffmpeg binary executables", "Video Transcoder");
     }

thumbnailLink()

VideoManager::thumbnailLink	(		$video_id,
			$size
	)

Returns the URI that can be used to access the specified thumbnail of a video at the given size.

Parameters

$video_id	the ID of the video
$size	the size of the major axis in pixels

Returns

string URI that can be used in an tag to view this image.

Definition at line 299 of file video_manager.inc.

     {
          return "/action/video/thumbnail?video_id=$video_id&size=$size";
     }

upgradeComponent()

static VideoManager::upgradeComponent (   $version )

static

Definition at line 163 of file video_manager.inc.

     {
          $mgr = new VideoUpgradeManager();
          $mgr->upgrade($version);
     }

videoGalleryTabs()

static VideoManager::videoGalleryTabs (   $key )

static

Definition at line 525 of file video_manager.inc.

     {
          $tabs = array( 
                    "Gallery"           =>   "/admin/video_gallery_form",
                    "Permissions"  =>   "/admin/video_gallery_permissions",                         
                    "Videos"       =>   "/admin/videos",
                    "Statistics"   =>   "/admin/video_gallery_stats",
                    );
 
          $qs = ($key) ? "video_gallery_id=$key" : ""; 
          return new TabBar("tabs", $tabs, $qs);
     }    

VideoManager()

VideoManager::VideoManager

(

)

Definition at line 45 of file video_manager.inc.

     {
          trace("Creating VideoManager", 3);
     }

Member Data Documentation

$movieFile

VideoManager::$movieFile = null

Definition at line 43 of file video_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/video/video_manager.inc