PHP Classes
elePHPant
Icontem

File: README.rst

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Vladimir Gorej  >  FFmpeg PHP  >  README.rst  >  Download  
File: README.rst
Role: Documentation
Content type: text/plain
Description: README file
Class: FFmpeg PHP
Manipulate video files using the ffmpeg program
Author: By
Last change: PEAR release preparations.
Date: 11 months ago
Size: 2,841 bytes
 

Contents

Class file image Download
FFmpegPHP 2.7.0
===============

FFmpegPHP is a pure OO PHP port of ffmpeg-php (written in C). It adds an easy to use,
object-oriented API for accessing and retrieving information from video and audio files.
It has methods for returning frames from movie files as images that can be manipulated
using PHP image functions. This works well for automatically creating thumbnail images from movies.
FFmpegPHP is also useful for reporting the duration and bitrate of audio files (mp3, wma...).
FFmpegPHP can access many of the video formats supported by ffmpeg (mov, avi, mpg, wmv...) 


Requirements
------------

- PHP 5.3 and higher
- ffmpeg or ffprobe


Tests
-----

**Tested environment**

- Xubuntu Linux 12.04.2 LTS precise 64-bit
- ffmpeg version N-37798-gcd1c12b
- PHPUnit 3.7.18
- PHP 5.3.10


**Running tests**

To run the test install phpunit (http://www.phpunit.de/) and run: ::

 $ phpunit --bootstrap test/bootstrap.php test/


Installation
------------

You can easily install FFmpegPHP via PEAR framework: ::

 $ sudo pear channel-discover pear.codescale.net
 $ sudo pear install codescale/FFmpegPHP2

or download package from github.com: ::

 $ wget http://github.com/char0n/ffmpeg-php/tarball/master

or to install via composer (http://getcomposer.org/) place the following in your composer.json file: ::

 {
    "require": {
        "codescale/ffmpeg-php": "dev-master"
    }
 }


Using FFmpegPHP
---------------

Package installed via PEAR channel: ::

 require_once 'FFmpegPHP2/FFmpegAutoloader.php';

Package downloaded from github.com and unpacked into certain directory: ::

 require_once 'PATH_TO_YOUR_DIRECTORY/FFmpegAutoloader.php';
 

Author
------

| char0n (VladimĂ­r Gorej, CodeScale s.r.o.)
| email: gorej@codescale.net
| web: http://www.codescale.net

Documentation
-------------

FFmpegPHP documentation can be build from source code 
using PhpDocumentor with following commnad: ::

 $ phpdoc -o HTML:Smarty:HandS -d . -t docs


Generating package.xml
----------------------
First temporarily remove .git/ directory from project root. It causes *pfm* not to work correctly.
::

 $ pear install PEAR_PackageFileManager2
 $ pear install PEAR_PackageFileManager_Cli
 $ pfm
 $ pear package package.xml
 $ pear install/upgrade ./{PACKAGE_NAME} # Verify is package is installable

Create *test.php* with contents and verify installation was successful:::

 <?php
 require_once 'FFmpegPHP2/FFmpegAutoloader.php';

And run the file with:::

 $ php test.php


References
----------

- http://github.com/CodeScaleInc/ffmpeg-php
- http://www.phpclasses.org/package/5977-PHP-Manipulate-video-files-using-the-ffmpeg-program.html
- http://freshmeat.net/projects/ffmpegphp
- http://www.codescale.net/en/community/#ffmpegphp
- http://pear.codescale.net/
- http://www.phpdoc.org/
- http://www.phpunit.de/
- http://pear.php.net/