Update doc and layout

docs/source/Recipes.rst

@@ -1,15 +1,19 @@
-PHP FFMpeg Recipes
+Recipes
-==================
+=======
 
 Initializing FFMpeg
 -------------------
 
 In the examples  we will show you, we assume we work in an environnment where
 FFMpeg has been initialized to ``$ffmpeg`` var ; there are two ways to
-initialize the environment :
+initialize the environment.
 
-Loading FFMpeg automatically
+PHP-FFMpeg supports both ``avconv`` and legacy ``ffmpeg``. If both are installed 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+on your system, ``avconv`` will be loaded in priority. Please read the dedicated 
+chapter below if you want to load ``FFMpeg``.
+
+Load FFMpeg automatically
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The easiest way to initialize ``FMpeg`` it is to call the loader ; this will
 look in your PATH environment variable to find ffmpeg/avconv binary :
@@ -30,8 +34,8 @@ look in your PATH environment variable to find ffmpeg/avconv binary :
     $ffmpeg = FFMpeg::load($logger);
 
 .. note:: FFMpeg and FFProbe both requires a logger with gives feedback about
-    what's happening. By passing a NullHandler to the logger, you disable the
+    what's happening. By passing a NullHandler to the logger, you will disable 
-    logging system.
+    the log system.
 
 
 Use custom binary
@@ -44,10 +48,19 @@ You can also initialize with a custom path to the binary :
     <?php
     $ffmpeg = new FFMpeg('/usr/local/src/ffmpeg/bin/ffmpeg', $logger);
 
-
 Defining formats
 ----------------
 
+Two base format interface are given by PHP-FFMpeg : ``FFMpeg\Format\Audio`` and
+``FFMpeg\Format\Video``. ``Video`` is an extension of ``Audio``.
+By implementing one of these interface, you're ready to encode a video.
+
+But you format can implement more than these interfaces ; PHP-FFMpeg provides a 
+set of interfaces to transcode, resize and resample audio / video.
+
+PHP-FFMpeg also provides a set of default audio and video usefull formats for
+web usages.
+
 Encode a video
 ^^^^^^^^^^^^^^
 
@@ -68,11 +81,11 @@ target file `file.ogv` :
         ->encode($oggFormat, 'file.ogv')
         ->close();
 
-.. note: ``FFmpeg`` methods always return the object itself so you can chain
+.. note:: ``FFmpeg`` methods always return the object itself so you can chain
     multiple methods.
 
-Create HTML5 videos
+Encode for HTML5
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^
 
 PHP-FFMpeg provides three video format out of the box : HTML5 video formats.
 These formats are available as these objects :
@@ -106,17 +119,200 @@ These formats are available as these objects :
         ->encode($oggFormat, 'file.ogv')
         ->close();
 
-.. note: Use PHP-MP4Box to make it compatible with pseudo stream !
+.. note:: Use PHP-MP4Box to make it compatible with pseudo stream !
 
 Create your own media type
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+It is very easy to define the media type you want as target. All you need to 
+do is implement the ``FFMpeg\Format\Video`` interface
+
+.. code-block:: php
+
+    <?php
+    namespace Foo\Bar;
+
+    use FFMpeg\Format\Video;
+
+    class MyFormat implements Video
+    {
+        public function getKiloBitrate()
+        {
+            return 1500;
+        }
+
+        public function getExtraParams()
+        {
+            return '';
+        }
+    }
+
+    $format = new MyFormat();
+
+    $ffmpeg->open('Video.mpeg')
+        ->encode($format, 'file.mp4')
+        ->close();
+
+PHP-FFmpeg brings more interfaces for your video formats : 
+ - ``FFMpeg\Format\Video\Resamplable``
+ - ``FFMpeg\Format\Video\Resizable``
+ - ``FFMpeg\Format\Video\Transcodable`` 
+ - ``FFMpeg\Format\Video\Interactive``
+
+.. note:: You can combine these features in one video format.
+
+Advanced media type
+^^^^^^^^^^^^^^^^^^^
+
+This section present basic usage of the different interfaces. You can combine 
+them in your own format.
+
+Resizable
++++++++++
+
+This interface provide an easy way to resize a video
+The example below resizes a video by half.
+
+.. code-block:: php
+
+    <?php
+    namespace Foo\Bar;
+
+    use FFMpeg\Format\Dimension;
+    use FFMpeg\Format\Video\Resizable;
+
+    class MyFormat implements Resizable
+    {
+        public function getComputedDimensions($originalWidth, $originalHeight)
+        {
+            return new Dimension(round($originalWidth / 2), round($originalHeight / 2));
+        }
+
+    }
+
+    $format = new MyFormat();
+
+    $ffmpeg->open('Video.mpeg')
+        ->encode($format, 'file.mp4')
+        ->close();
+
+
+Resamplable
++++++++++++
+
+This interface provide an easy way to resample a video
+The example below resample the video at 15 frame per second with a keyframe 
+every 30 image.
+
+.. code-block:: php
+
+    <?php
+    namespace Foo\Bar;
+
+    use FFMpeg\Format\Video\Resamplable;
+
+    class MyFormat implements Resamplable
+    {
+        public function getFrameRate()
+        {
+            return 15;
+        }
+
+        public function getGOPSize()
+        {
+            return 30;
+        }
+
+    }
+
+    $format = new MyFormat();
+
+    $ffmpeg->open('Video.mpeg')
+        ->encode($format, 'file.mp4')
+        ->close();
+
+Interactive
++++++++++++
+
+This interface provide a method to list available codec for the format
+The example below provide a format object listing available videocodec for
+flash video.
+
+.. code-block:: php
+
+    <?php
+    namespace Foo\Bar;
+
+    use FFMpeg\Format\Video\Interactive;
+
+    class MyFormat implements Interactive
+    {
         
+        public function getVideoCodec()
+        {
+            return 'libx264';
+        }
+
+        public function getAvailableVideoCodecs()
+        {
+            return array('libx264', 'flv');
+        }
+    }
+
+    $format = new MyFormat();
+
+    $ffmpeg->open('Video.mpeg')
+        ->encode($format, 'file.mp4')
+        ->close();
+
+Adding custom commandline options
++++++++++++++++++++++++++++++++++
+
+If you need to add custom FFmpeg command line option, you can use the 
+``FFMpeg\Format\Audio::getExtraParams`` method.
+As Video extends Audio, it is also available in any format.
+
+The following example shows a getExtraParams usage for aac encoding. With the
+latest FFMPeg version, aac encoding can be executed with command parameters
+``-strict experimental``. Here is what happens if you do not add this extra
+parameter : 
+
+.. code-block:: php
+
+    <?php
+    namespace Foo\Bar;
+
+    use FFMpeg\Format\Audio\Transcodable;
+    use FFMpeg\Format\Video;
+
+    class MyFormat implements Video, Transcodable
+    {
+        
+        public function getAudioCodec()
+        {
+            return 'aac';
+        }
+
+        public function getKiloBitrate()
+        {
+            return 128;
+        }
+
+        public function getExtraParams()
+        {
+            return '-strict experimental';
+        }
+    }
+
+    $format = new MyFormat();
+
+    $ffmpeg->open('Video.mp4')
+        ->encode($format, 'output-aac.mp4')
+        ->close();
+
+
 
 FFProbe recipes
 ---------------
 
 
-create HTML5 videos
-^^^^^^^^^^^^^^^^^^^
-

docs/source/_themes/Alchemy/layout.html

@@ -169,7 +169,9 @@
 
             <div class="row-fluid">
                 <div class="span4">
-                    <img src="{{ pathto('_static/img/project.png', 1) }}"/>
+                    <div style="width:160px;margin:0 auto">
+                        <img style="width:100%;margin:20px 0;" src="{{ pathto('_static/img/project.png', 1) }}"/>
+                    </div>
                 	{{ sidebar() }}
                 </div>
                 <div class="span8">

docs/source/_themes/Alchemy/static/bootstrapCustom.css

@@ -1,4 +1,4 @@
-h2{
+h1, h2, h3, h4, h5, h6{
  padding: 40px 0 5px;
 }
 

docs/source/index.rst

@@ -90,7 +90,7 @@ Basic Usage
 Recipes
 -------
 
-You'll find usefull recipes in our recipe guide
+You'll find usefull recipes in our :doc:`Recipes`
 
 Handling Exceptions
 -------------------