Merge pull request #209 from Progi1984/issue123

Progi1984 · Progi1984 · commit 5764b5c5a5e7 · 2016-03-31T17:35:30.000+02:00
#123 : Support for Video
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,7 @@
 - ODPresentation & PowerPoint2007 & Serialized Writer : Support for Zip Adapter - @Progi1984 GH-176
 - ODPresentation & PowerPoint2007 Writer : language property to TextElement - @skrajewski & @Progi1984 GH-180
 - ODPresentation & PowerPoint2007 Writer : Add Font Support For Chart Axis - @jrking4 GH-186
+- ODPresentation & PowerPoint2007 Writer : Support for video - @Progi1984 GH-123
 - PowerPoint2007 Writer : Presentation with predefined View Type - @Progi1984 GH-120
 
 ## 0.6.0 - 2016-01-24
diff --git a/docs/index.rst b/docs/index.rst
@@ -34,6 +34,7 @@ PHPPresentation is a library written in pure PHP that provides a set of classes
    
    shapes_chart
    shapes_comment
+   shapes_media
    shapes_richtext
    shapes_table
 
diff --git a/docs/shapes.rst b/docs/shapes.rst
@@ -27,25 +27,11 @@ Example:
 		->setOffsetX(170)
 		->setOffsetY(180);
 
-Rich text
----------
-
-The Rich text has :ref:`its own page <shapes_richtext>`.
-
 Line
 ----
 
 To create a line, use `createLineShape` method of slide.
 
-Chart
------
-
-The Chart has :ref:`its own page <shapes_chart>`.
-
-Comment
--------
-
-The Comment has :ref:`its own page <shapes_comment>`.
 
 Drawing
 -------
@@ -58,8 +44,3 @@ To create a drawing, use `createDrawingShape` method of slide.
 	$drawing->setName('Unique name')
 		->setDescription('Description of the drawing')
 		->setPath('/path/to/drawing.filename');
-		
-Table
------
-
-The Table has :ref:`its own page <shapes_table>`.
diff --git a/docs/shapes_media.rst b/docs/shapes_media.rst
@@ -0,0 +1,36 @@
+.. _shapes_table:
+
+Media
+=====
+
+To create a video, create an object `Media`.
+
+Example:
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Media;
+
+    $oMedia = new Media();
+    $oMedia->setPath('file.mp4');
+    // $oMedia->setPath('file.ogv');
+    $oSlide->addShape($oMedia);
+
+You can define text and date with setters.
+
+Example:
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Media;
+
+    $oMedia = new Media();
+    $oMedia->setName('Name of the Media');
+    $oSlide->addShape($oMedia);
+
+
+Quirks
+------
+
+For PowerPoint2007 Writer, the prefered file format is MP4.
+For ODPresentation Writer, the prefered file format is OGV.
diff --git a/samples/Sample_03_Image.php b/samples/Sample_03_Image.php
@@ -4,6 +4,7 @@
 
 use PhpOffice\PhpPresentation\PhpPresentation;
 use PhpOffice\PhpPresentation\Shape\Drawing;
+use PhpOffice\PhpPresentation\Shape\Media;
 use PhpOffice\PhpPresentation\Shape\MemoryDrawing;
 
 // Create new PHPPresentation object
@@ -24,13 +25,13 @@
 echo date('H:i:s') . ' Add a drawing to the slide'.EOL;
 $shape = new MemoryDrawing();
 $shape->setName('Sample image')
-      ->setDescription('Sample image')
-      ->setImageResource($gdImage)
-      ->setRenderingFunction(MemoryDrawing::RENDERING_JPEG)
-      ->setMimeType(MemoryDrawing::MIMETYPE_DEFAULT)
-      ->setHeight(36)
-      ->setOffsetX(10)
-      ->setOffsetY(10);
+    ->setDescription('Sample image')
+    ->setImageResource($gdImage)
+    ->setRenderingFunction(MemoryDrawing::RENDERING_JPEG)
+    ->setMimeType(MemoryDrawing::MIMETYPE_DEFAULT)
+    ->setHeight(36)
+    ->setOffsetX(10)
+    ->setOffsetY(10);
 $currentSlide->addShape($shape);
 
 // Add a file drawing (GIF) to the slide
@@ -55,6 +56,18 @@
     ->setOffsetY(200);
 $currentSlide->addShape($shape);
 
+// Add a video to the slide
+$shape = new Media();
+$shape->setName('Video')
+    ->setDescription('Video')
+    ->setPath(strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' ? './resources/sintel_trailer-480p.mp4' : './resources/sintel_trailer-480p.ogv')
+    ->setResizeProportional(false)
+    ->setHeight(90)
+    ->setWidth(90)
+    ->setOffsetX(10)
+    ->setOffsetY(300);
+$currentSlide->addShape($shape);
+
 // Save file
 echo write($objPHPPresentation, basename(__FILE__, '.php'), $writers);
 if (!CLI) {
diff --git a/samples/resources/sintel_trailer-480p.mp4 b/samples/resources/sintel_trailer-480p.mp4
diff --git a/samples/resources/sintel_trailer-480p.ogv b/samples/resources/sintel_trailer-480p.ogv
diff --git a/samples/resources/sintel_trailer-480p.wmv b/samples/resources/sintel_trailer-480p.wmv
diff --git a/src/PhpPresentation/Shape/Media.php b/src/PhpPresentation/Shape/Media.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @link        https://github.com/PHPOffice/PHPPresentation
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+namespace PhpOffice\PhpPresentation\Shape;
+
+use PhpOffice\PhpPresentation\ComparableInterface;
+
+/**
+ * Media element
+ */
+class Media extends Drawing implements ComparableInterface
+{
+}
diff --git a/src/PhpPresentation/Writer/ODPresentation.php b/src/PhpPresentation/Writer/ODPresentation.php
@@ -99,17 +99,25 @@ public function save($pFilename)
         $oPresentation = $this->getPhpPresentation();
         $arrayChart = array();
 
+        $arrayFiles = array();
         $oDir = new DirectoryIterator(dirname(__FILE__).DIRECTORY_SEPARATOR.'ODPresentation');
         foreach ($oDir as $oFile) {
             if (!$oFile->isFile()) {
                 continue;
             }
-            $class = __NAMESPACE__.'\\ODPresentation\\'.$oFile->getBasename('.php');
+
+            $class = __NAMESPACE__ . '\\ODPresentation\\' . $oFile->getBasename('.php');
             $o = new \ReflectionClass($class);
 
             if ($o->isAbstract() || !$o->isSubclassOf('PhpOffice\PhpPresentation\Writer\ODPresentation\AbstractDecoratorWriter')) {
                 continue;
             }
+            $arrayFiles[$oFile->getBasename('.php')] = $o;
+        }
+
+        ksort($arrayFiles);
+
+        foreach ($arrayFiles as $o) {
             $oService = $o->newInstance();
             $oService->setZip($oZip);
             $oService->setPresentation($oPresentation);
diff --git a/src/PhpPresentation/Writer/ODPresentation/Content.php b/src/PhpPresentation/Writer/ODPresentation/Content.php
@@ -7,6 +7,7 @@
 use PhpOffice\Common\Text;
 use PhpOffice\Common\XMLWriter;
 use PhpOffice\PhpPresentation\Shape\Comment;
+use PhpOffice\PhpPresentation\Shape\Media;
 use PhpOffice\PhpPresentation\Slide;
 use PhpOffice\PhpPresentation\Shape\AbstractDrawing;
 use PhpOffice\PhpPresentation\Shape\Chart;
@@ -282,6 +283,8 @@ public function writeContent()
                     $this->writeShapeLine($objWriter, $shape);
                 } elseif ($shape instanceof Chart) {
                     $this->writeShapeChart($objWriter, $shape);
+                } elseif ($shape instanceof Media) {
+                    $this->writeShapeMedia($objWriter, $shape);
                 } elseif ($shape instanceof AbstractDrawing) {
                     $this->writeShapePic($objWriter, $shape);
                 } elseif ($shape instanceof Group) {
@@ -316,6 +319,54 @@ public function writeContent()
         return $objWriter->getData();
     }
 
+    /**
+     * Write picture
+     *
+     * @param \PhpOffice\Common\XMLWriter $objWriter
+     * @param \PhpOffice\PhpPresentation\Shape\Media $shape
+     */
+    public function writeShapeMedia(XMLWriter $objWriter, Media $shape)
+    {
+        // draw:frame
+        $objWriter->startElement('draw:frame');
+        $objWriter->writeAttribute('draw:name', $shape->getName());
+        $objWriter->writeAttribute('svg:width', Text::numberFormat(CommonDrawing::pixelsToCentimeters($shape->getWidth()), 3) . 'cm');
+        $objWriter->writeAttribute('svg:height', Text::numberFormat(CommonDrawing::pixelsToCentimeters($shape->getHeight()), 3) . 'cm');
+        $objWriter->writeAttribute('svg:x', Text::numberFormat(CommonDrawing::pixelsToCentimeters($shape->getOffsetX()), 3) . 'cm');
+        $objWriter->writeAttribute('svg:y', Text::numberFormat(CommonDrawing::pixelsToCentimeters($shape->getOffsetY()), 3) . 'cm');
+        $objWriter->writeAttribute('draw:style-name', 'gr' . $this->shapeId);
+        // draw:frame > draw:plugin
+        $objWriter->startElement('draw:plugin');
+        $objWriter->writeAttribute('xlink:href', 'Pictures/' . md5($shape->getPath()) . '.' . $shape->getExtension());
+        $objWriter->writeAttribute('xlink:type', 'simple');
+        $objWriter->writeAttribute('xlink:show', 'embed');
+        $objWriter->writeAttribute('xlink:actuate', 'onLoad');
+        $objWriter->writeAttribute('draw:mime-type', 'application/vnd.sun.star.media');
+
+        $objWriter->startElement('draw:param');
+        $objWriter->writeAttribute('draw:name', 'Loop');
+        $objWriter->writeAttribute('draw:value', 'false');
+        $objWriter->endElement();
+        $objWriter->startElement('draw:param');
+        $objWriter->writeAttribute('draw:name', 'Mute');
+        $objWriter->writeAttribute('draw:value', 'false');
+        $objWriter->endElement();
+        $objWriter->startElement('draw:param');
+        $objWriter->writeAttribute('draw:name', 'VolumeDB');
+        $objWriter->writeAttribute('draw:value', 0);
+        $objWriter->endElement();
+        $objWriter->startElement('draw:param');
+        $objWriter->writeAttribute('draw:name', 'Zoom');
+        $objWriter->writeAttribute('draw:value', 'fit');
+        $objWriter->endElement();
+
+        // draw:frame > ## draw:plugin
+        $objWriter->endElement();
+
+        // ## draw:frame
+        $objWriter->endElement();
+    }
+
     /**
      * Write picture
      *
diff --git a/src/PhpPresentation/Writer/PowerPoint2007/PptMedia.php b/src/PhpPresentation/Writer/PowerPoint2007/PptMedia.php
@@ -14,7 +14,7 @@ public function render()
     {
         for ($i = 0; $i < $this->getDrawingHashTable()->count(); ++$i) {
             $shape = $this->getDrawingHashTable()->getByIndex($i);
-            if ($shape instanceof Drawing) {
+            if ($shape instanceof Drawing || $shape instanceof Media) {
                 $imagePath     = $shape->getPath();
                 if (strpos($imagePath, 'zip://') !== false) {
                     $imagePath         = substr($imagePath, 6);
diff --git a/src/PhpPresentation/Writer/PowerPoint2007/PptSlides.php b/src/PhpPresentation/Writer/PowerPoint2007/PptSlides.php
@@ -11,6 +11,7 @@
 use PhpOffice\PhpPresentation\Shape\Drawing as ShapeDrawing;
 use PhpOffice\PhpPresentation\Shape\Group;
 use PhpOffice\PhpPresentation\Shape\Line;
+use PhpOffice\PhpPresentation\Shape\Media;
 use PhpOffice\PhpPresentation\Shape\MemoryDrawing as MemoryDrawing;
 use PhpOffice\PhpPresentation\Shape\RichText;
 use PhpOffice\PhpPresentation\Shape\RichText\BreakElement;
@@ -716,7 +717,33 @@ protected function writeShapePic(XMLWriter $objWriter, AbstractDrawing $shape, $
         $objWriter->endElement();
 
         // p:nvPr
-        $objWriter->writeElement('p:nvPr', null);
+        $objWriter->startElement('p:nvPr');
+        /**
+         * @link : https://github.com/stefslon/exportToPPTX/blob/master/exportToPPTX.m#L2128
+         */
+        if ($shape instanceof Media) {
+            // p:nvPr > a:videoFile
+            $objWriter->startElement('a:videoFile');
+            $objWriter->writeAttribute('r:link', $shape->relationId);
+            $objWriter->endElement();
+            // p:nvPr > p:extLst
+            $objWriter->startElement('p:extLst');
+            // p:nvPr > p:extLst > p:ext
+            $objWriter->startElement('p:ext');
+            $objWriter->writeAttribute('uri', '{DAA4B4D4-6D71-4841-9C94-3DE7FCFB9230}');
+            // p:nvPr > p:extLst > p:ext > p14:media
+            $objWriter->startElement('p14:media');
+            $objWriter->writeAttribute('r:embed', $shape->relationId);
+            $objWriter->writeAttribute('xmlns:p14', 'http://schemas.microsoft.com/office/powerpoint/2010/main');
+            // p:nvPr > p:extLst > p:ext > ##p14:media
+            $objWriter->endElement();
+            // p:nvPr > p:extLst > ##p:ext
+            $objWriter->endElement();
+            // p:nvPr > ##p:extLst
+            $objWriter->endElement();
+        }
+        // ##p:nvPr
+        $objWriter->endElement();
         $objWriter->endElement();
 
         // p:blipFill
@@ -736,7 +763,6 @@ protected function writeShapePic(XMLWriter $objWriter, AbstractDrawing $shape, $
 
         // p:spPr
         $objWriter->startElement('p:spPr');
-
         // a:xfrm
         $objWriter->startElement('a:xfrm');
         $objWriter->writeAttribute('rot', CommonDrawing::degreesToAngle($shape->getRotation()));
diff --git a/tests/PhpPresentation/Tests/Shape/MediaTest.php b/tests/PhpPresentation/Tests/Shape/MediaTest.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace PhpPresentation\Tests\Shape;
+
+use PhpOffice\PhpPresentation\Shape\Media;
+
+class MediaTest extends \PHPUnit_Framework_TestCase
+{
+    public function testInheritance()
+    {
+        $object = new Media();
+
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Drawing', $object);
+    }
+}
diff --git a/tests/PhpPresentation/Tests/Writer/ODPresentation/ContentTest.php b/tests/PhpPresentation/Tests/Writer/ODPresentation/ContentTest.php
@@ -18,8 +18,10 @@
 namespace PhpOffice\PhpPresentation\Tests\Writer\ODPresentation;
 
 use PhpOffice\Common\Drawing as CommonDrawing;
+use PhpOffice\Common\Text;
 use PhpOffice\PhpPresentation\PhpPresentation;
 use PhpOffice\PhpPresentation\Shape\Comment;
+use PhpOffice\PhpPresentation\Shape\Media;
 use PhpOffice\PhpPresentation\Shape\RichText\Run;
 use PhpOffice\PhpPresentation\Slide\Transition;
 use PhpOffice\PhpPresentation\Style\Alignment;
@@ -257,6 +259,47 @@ public function testListWithRichText()
         $this->assertTrue($pres->elementExists($element, 'content.xml'));
     }
 
+    public function testMedia()
+    {
+        $expectedName = 'MyName';
+        $expectedWidth = rand(1, 100);
+        $expectedHeight = rand(1, 100);
+        $expectedX = rand(1, 100);
+        $expectedY = rand(1, 100);
+
+        $oMedia = new Media();
+        $oMedia->setPath(PHPPRESENTATION_TESTS_BASE_DIR . '/resources/videos/sintel_trailer-480p.ogv')
+            ->setName($expectedName)
+            ->setResizeProportional(false)
+            ->setHeight($expectedHeight)
+            ->setWidth($expectedWidth)
+            ->setOffsetX($expectedX)
+            ->setOffsetY($expectedY);
+
+        $expectedWidth = Text::numberFormat(CommonDrawing::pixelsToCentimeters($expectedWidth), 3) . 'cm';
+        $expectedHeight = Text::numberFormat(CommonDrawing::pixelsToCentimeters($expectedHeight), 3) . 'cm';
+        $expectedX = Text::numberFormat(CommonDrawing::pixelsToCentimeters($expectedX), 3) . 'cm';
+        $expectedY = Text::numberFormat(CommonDrawing::pixelsToCentimeters($expectedY), 3) . 'cm';
+
+        $oPhpPresentation = new PhpPresentation();
+        $oSlide = $oPhpPresentation->getActiveSlide();
+        $oSlide->addShape($oMedia);
+
+        $xmlObject = TestHelperDOCX::getDocument($oPhpPresentation, 'ODPresentation');
+        $element = '/office:document-content/office:body/office:presentation/draw:page/draw:frame';
+        $this->assertTrue($xmlObject->elementExists($element, 'content.xml'));
+        $this->assertEquals($expectedName, $xmlObject->getElementAttribute($element, 'draw:name', 'content.xml'));
+        $this->assertEquals($expectedWidth, $xmlObject->getElementAttribute($element, 'svg:width', 'content.xml'));
+        $this->assertEquals($expectedHeight, $xmlObject->getElementAttribute($element, 'svg:height', 'content.xml'));
+        $this->assertEquals($expectedX, $xmlObject->getElementAttribute($element, 'svg:x', 'content.xml'));
+        $this->assertEquals($expectedY, $xmlObject->getElementAttribute($element, 'svg:y', 'content.xml'));
+        $element = '/office:document-content/office:body/office:presentation/draw:page/draw:frame/draw:plugin';
+        $this->assertTrue($xmlObject->elementExists($element, 'content.xml'));
+        $this->assertEquals('application/vnd.sun.star.media', $xmlObject->getElementAttribute($element, 'draw:mime-type', 'content.xml'));
+        $this->assertStringStartsWith('Pictures/', $xmlObject->getElementAttribute($element, 'xlink:href', 'content.xml'));
+        $this->assertStringEndsWith('ogv', $xmlObject->getElementAttribute($element, 'xlink:href', 'content.xml'));
+    }
+
     public function testNote()
     {
         $oPhpPresentation = new PhpPresentation();
diff --git a/tests/PhpPresentation/Tests/Writer/PowerPoint2007/PptSlidesTest.php b/tests/PhpPresentation/Tests/Writer/PowerPoint2007/PptSlidesTest.php
diff --git a/tests/resources/videos/sintel_trailer-480p.mp4 b/tests/resources/videos/sintel_trailer-480p.mp4
diff --git a/tests/resources/videos/sintel_trailer-480p.ogv b/tests/resources/videos/sintel_trailer-480p.ogv
