slideshow/source/engine/shapes/viewmediashape.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_VIEWMEDIASHAPE_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_VIEWMEDIASHAPE_HXX
  22
  23 #include <basegfx/range/b2drectangle.hxx>
  24 #include <com/sun/star/awt/Point.hpp>
  25 #include <com/sun/star/drawing/XShape.hpp>
  26
  27 #include <memory>
  28 #include <vcl/vclptr.hxx>
  29
  30 #include <viewlayer.hxx>
  31
  32 class SystemChildWindow;
  33
  34 namespace com::sun::star {
  35     namespace drawing {
  36         class XShape;
  37     }
  38     namespace media {
  39         class XPlayer;
  40         class XPlayerWindow;
  41     }
  42     namespace uno {
  43         class XComponentContext;
  44     }
  45     namespace beans{
  46         class XPropertySet;
  47     }
  48 }
  49
  50 namespace slideshow::internal
  51     {
  52         /** This class is the viewable representation of a draw
  53             document's media object, associated to a specific View
  54
  55             The class is able to render the associated media shape on
  56             View implementations.
  57          */
  58         class ViewMediaShape final
  59         {
  60         public:
  61             /** Create a ViewMediaShape for the given View
  62
  63                 @param rView
  64                 The associated View object.
  65              */
  66             ViewMediaShape( const ViewLayerSharedPtr&                                  rViewLayer,
  67                             css::uno::Reference< css::drawing::XShape >          xShape,
  68                             css::uno::Reference< css::uno::XComponentContext >   xContext,
  69                             const OUString&                                      aFallbackDir );
  70
  71             /** destroy the object
  72              */
  73             ~ViewMediaShape();
  74
  75             /// Forbid copy construction
  76             ViewMediaShape(const ViewMediaShape&) = delete;
  77             /// Forbid copy assignment
  78             ViewMediaShape& operator=(const ViewMediaShape&) = delete;
  79
  80             /** Query the associated view layer of this shape
  81              */
  82             const ViewLayerSharedPtr& getViewLayer() const;
  83
  84             // animation methods
  85
  86
  87             /** Notify the ViewShape that an animation starts now
  88
  89                 This method enters animation mode on the associate
  90                 target view. The shape can be animated in parallel on
  91                 different views.
  92              */
  93             void startMedia();
  94
  95             /** Notify the ViewShape that it is no longer animated
  96
  97                 This methods ends animation mode on the associate
  98                 target view
  99              */
 100             void endMedia();
 101
 102             /** Notify the ViewShape that it should pause playback
 103
 104                 This methods pauses animation on the associate
 105                 target view. The content stays visible (for video)
 106              */
 107             void pauseMedia();
 108
 109             /** Set current time of media.
 110
 111             @param fTime
 112             Local media time that should now be presented, in seconds.
 113              */
 114             void setMediaTime(double fTime);
 115
 116             void setLooping(bool bLooping);
 117
 118             // render methods
 119
 120
 121             /** Render the ViewShape
 122
 123                 This method renders the ViewMediaShape on the associated view.
 124
 125                 @param rBounds
 126                 The current media shape bounds
 127
 128                 @return whether the rendering finished successfully.
 129             */
 130             bool render( const ::basegfx::B2DRectangle& rBounds ) const;
 131
 132             /** Resize the ViewShape
 133
 134                 This method updates the ViewMediaShape size on the
 135                 associated view. It does not render.
 136
 137                 @param rBounds
 138                 The current media shape bounds
 139
 140                 @return whether the resize finished successfully.
 141             */
 142             bool resize( const ::basegfx::B2DRectangle& rNewBounds ) const;
 143
 144         private:
 145
 146             bool implInitialize( const ::basegfx::B2DRectangle& rBounds );
 147             void implSetMediaProperties( const css::uno::Reference< css::beans::XPropertySet >& rxProps );
 148             void implInitializeMediaPlayer( const OUString& rMediaURL, const OUString& rMimeType );
 149             void implInitializePlayerWindow( const ::basegfx::B2DRectangle& rBounds,
 150                                              const css::uno::Sequence< css::uno::Any >& rVCLDeviceParams );
 151             ViewLayerSharedPtr                    mpViewLayer;
 152             VclPtr< SystemChildWindow >           mpMediaWindow;
 153             mutable css::awt::Point               maWindowOffset;
 154             mutable ::basegfx::B2DRectangle       maBounds;
 155
 156             css::uno::Reference< css::drawing::XShape >       mxShape;
 157             css::uno::Reference< css::media::XPlayer >        mxPlayer;
 158             css::uno::Reference< css::media::XPlayerWindow >  mxPlayerWindow;
 159             css::uno::Reference< css::uno::XComponentContext> mxComponentContext;
 160             bool                                              mbIsSoundEnabled;
 161             OUString                                          maFallbackDir;
 162         };
 163
 164         typedef ::std::shared_ptr< ViewMediaShape > ViewMediaShapeSharedPtr;
 165
 166 }
 167
 168 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_VIEWMEDIASHAPE_HXX
 169
 170 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */