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
  70             /** destroy the object
  71              */
  72             ~ViewMediaShape();
  73
  74             /// Forbid copy construction
  75             ViewMediaShape(const ViewMediaShape&) = delete;
  76             /// Forbid copy assignment
  77             ViewMediaShape& operator=(const ViewMediaShape&) = delete;
  78
  79             /** Query the associated view layer of this shape
  80              */
  81             const ViewLayerSharedPtr& getViewLayer() const;
  82
  83             // animation methods
  84
  85
  86             /** Notify the ViewShape that an animation starts now
  87
  88                 This method enters animation mode on the associate
  89                 target view. The shape can be animated in parallel on
  90                 different views.
  91              */
  92             void startMedia();
  93
  94             /** Notify the ViewShape that it is no longer animated
  95
  96                 This methods ends animation mode on the associate
  97                 target view
  98              */
  99             void endMedia();
 100
 101             /** Notify the ViewShape that it should pause playback
 102
 103                 This methods pauses animation on the associate
 104                 target view. The content stays visible (for video)
 105              */
 106             void pauseMedia();
 107
 108             /** Set current time of media.
 109
 110             @param fTime
 111             Local media time that should now be presented, in seconds.
 112              */
 113             void setMediaTime(double fTime);
 114
 115             void setLooping(bool bLooping);
 116
 117             // render methods
 118
 119
 120             /** Render the ViewShape
 121
 122                 This method renders the ViewMediaShape on the associated view.
 123
 124                 @param rBounds
 125                 The current media shape bounds
 126
 127                 @return whether the rendering finished successfully.
 128             */
 129             bool render( const ::basegfx::B2DRectangle& rBounds ) const;
 130
 131             /** Resize the ViewShape
 132
 133                 This method updates the ViewMediaShape size on the
 134                 associated view. It does not render.
 135
 136                 @param rBounds
 137                 The current media shape bounds
 138
 139                 @return whether the resize finished successfully.
 140             */
 141             bool resize( const ::basegfx::B2DRectangle& rNewBounds ) const;
 142
 143         private:
 144
 145             bool implInitialize( const ::basegfx::B2DRectangle& rBounds );
 146             void implSetMediaProperties( const css::uno::Reference< css::beans::XPropertySet >& rxProps );
 147             void implInitializeMediaPlayer( const OUString& rMediaURL, const OUString& rMimeType );
 148             void implInitializePlayerWindow( const ::basegfx::B2DRectangle& rBounds,
 149                                              const css::uno::Sequence< css::uno::Any >& rVCLDeviceParams );
 150             ViewLayerSharedPtr                    mpViewLayer;
 151             VclPtr< SystemChildWindow >           mpMediaWindow;
 152             mutable css::awt::Point               maWindowOffset;
 153             mutable ::basegfx::B2DRectangle       maBounds;
 154
 155             css::uno::Reference< css::drawing::XShape >       mxShape;
 156             css::uno::Reference< css::media::XPlayer >        mxPlayer;
 157             css::uno::Reference< css::media::XPlayerWindow >  mxPlayerWindow;
 158             css::uno::Reference< css::uno::XComponentContext> mxComponentContext;
 159             bool                                              mbIsSoundEnabled;
 160         };
 161
 162         typedef ::std::shared_ptr< ViewMediaShape > ViewMediaShapeSharedPtr;
 163
 164 }
 165
 166 #endif // INCLUDED_SLIDESHOW_SOURCE_ENGINE_SHAPES_VIEWMEDIASHAPE_HXX
 167
 168 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */