tdf#87794: Media Playback Panel

Change-Id: I2ad02ea031c2a1f558f76bd4c5dd816e400c5269
Reviewed-on: https://gerrit.libreoffice.org/27363
Reviewed-by: Yousuf Philips <philipz85@hotmail.com>
Tested-by: Yousuf Philips <philipz85@hotmail.com>
Reviewed-by: Katarina Behrens <Katarina.Behrens@cib.de>

6 files changed, 461 insertions, 0 deletions

diff --git a/svx/Library_svx.mk b/svx/Library_svx.mk
index 919f721c480e..9c09ed0624c0 100644
--- a/svx/Library_svx.mk
+++ b/svx/Library_svx.mk
@@ -41,6 +41,7 @@ $(eval $(call gb_Library_add_defs,svx,\
 $(eval $(call gb_Library_set_precompiled_header,svx,$(SRCDIR)/svx/inc/pch/precompiled_svx))
 
 $(eval $(call gb_Library_use_libraries,svx,\
+    avmedia\
     basegfx \
     sb \
     comphelper \
@@ -200,6 +201,7 @@ $(eval $(call gb_Library_add_exception_objects,svx,\
     svx/source/sidebar/line/LinePropertyPanelBase \
     svx/source/sidebar/line/LineWidthValueSet \
     svx/source/sidebar/line/LineWidthPopup \
+    svx/source/sidebar/media/MediaPlaybackPanel \
     svx/source/sidebar/possize/PosSizePropertyPanel \
     svx/source/sidebar/possize/SidebarDialControl \
     svx/source/sidebar/shapes/DefaultShapesPanel \
diff --git a/svx/UIConfig_svx.mk b/svx/UIConfig_svx.mk
index bb1bda38d500..502e8801881a 100644
--- a/svx/UIConfig_svx.mk
+++ b/svx/UIConfig_svx.mk
@@ -45,6 +45,7 @@ $(eval $(call gb_UIConfig_add_uifiles,svx,\
 	svx/uiconfig/ui/headfootformatpage \
 	svx/uiconfig/ui/imapdialog \
 	svx/uiconfig/ui/linkwarndialog \
+	svx/uiconfig/ui/mediaplayback \
 	svx/uiconfig/ui/namespacedialog \
 	svx/uiconfig/ui/optgridpage \
 	svx/uiconfig/ui/paralinespacingcontrol \
diff --git a/svx/source/sidebar/PanelFactory.cxx b/svx/source/sidebar/PanelFactory.cxx
index d64ee5c4c9f0..97817e0283fb 100644
--- a/svx/source/sidebar/PanelFactory.cxx
+++ b/svx/source/sidebar/PanelFactory.cxx
@@ -26,6 +26,7 @@
 #include "line/LinePropertyPanel.hxx"
 #include "possize/PosSizePropertyPanel.hxx"
 #include "shapes/DefaultShapesPanel.hxx"
+#include "media/MediaPlaybackPanel.hxx"
 #include "GalleryControl.hxx"
 #include "EmptyPanel.hxx"
 #include <sfx2/sidebar/SidebarPanelBase.hxx>
@@ -172,6 +173,10 @@ Reference<ui::XUIElement> SAL_CALL PanelFactory::createUIElement (
     {
         pControl = DefaultShapesPanel::Create(pParentWindow, xFrame);
     }
+    else if (rsResourceURL.endsWith("/MediaPlaybackPanel"))
+    {
+        pControl = MediaPlaybackPanel::Create(pParentWindow, xFrame, pBindings);
+    }
     else if (rsResourceURL.endsWith("/GalleryPanel"))
     {
         pControl.reset(VclPtr<GalleryControl>::Create(pBindings, pParentWindow));
diff --git a/svx/source/sidebar/media/MediaPlaybackPanel.cxx b/svx/source/sidebar/media/MediaPlaybackPanel.cxx
new file mode 100644
index 000000000000..f35304c40d75
--- /dev/null
+++ b/svx/source/sidebar/media/MediaPlaybackPanel.cxx
@@ -0,0 +1,199 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#include "MediaPlaybackPanel.hxx"
+#include <vcl/outdev.hxx>
+#include <avmedia/mediawindow.hxx>
+#include <avmedia/mediaplayer.hxx>
+#include <svtools/miscopt.hxx>
+#include <avmedia/mediaitem.hxx>
+#include <sfx2/sfxsids.hrc>
+#include <sfx2/dispatch.hxx>
+#include <avmedia/MediaControlBase.hxx>
+
+using ::rtl::OUString;
+using namespace avmedia;
+
+namespace svx { namespace sidebar {
+
+MediaPlaybackPanel::MediaPlaybackPanel (
+    vcl::Window* pParent,
+    const css::uno::Reference<css::frame::XFrame>& rxFrame,
+    SfxBindings* pBindings)
+    : PanelLayout(pParent, "MediaPlaybackPanel", "svx/ui/mediaplayback.ui", rxFrame),
+    MediaControlBase(),
+    maMediaController(SID_AVMEDIA_TOOLBOX, *pBindings, *this),
+    maIdle("MediaPlaybackPanel"),
+    mpBindings(pBindings)
+{
+    get(mpTimeEdit, "timeedit");
+    get(mpPlayToolBox, "playtoolbox");
+    get(mpMuteToolBox, "mutetoolbox");
+    get(mpTimeSlider, "timeslider");
+    get(mpVolumeSlider, "volumeslider");
+    get(mpZoomListBox, "zoombox");
+    Initialize();
+}
+
+VclPtr< vcl::Window > MediaPlaybackPanel::Create(
+    vcl::Window* pParent,
+    const Reference< XFrame >& rxFrame,
+    SfxBindings* pBindings)
+{
+    if (pParent == nullptr)
+        throw lang::IllegalArgumentException("no parent Window given to MediaPlaybackPanel::Create", nullptr, 0);
+    if ( ! rxFrame.is())
+        throw lang::IllegalArgumentException("no XFrame given to MediaPlaybackPanel::Create", nullptr, 1);
+    if (pBindings == nullptr)
+        throw lang::IllegalArgumentException("no SfxBindings given to MediaPlaybackPanel::Create", nullptr, 2);
+
+    return VclPtr<MediaPlaybackPanel>::Create(
+                pParent,
+                rxFrame,
+                pBindings);
+}
+
+MediaPlaybackPanel::~MediaPlaybackPanel()
+{
+    disposeOnce();
+}
+
+void MediaPlaybackPanel::Initialize()
+{
+    InitializeWidgets();
+    mpVolumeSlider->SetSlideHdl(LINK(this, MediaPlaybackPanel, VolumeSlideHdl));
+    mpPlayToolBox->SetSelectHdl(LINK(this, MediaPlaybackPanel, PlayToolBoxSelectHdl));
+    mpMuteToolBox->SetSelectHdl(LINK(this, MediaPlaybackPanel, PlayToolBoxSelectHdl));
+    mpTimeSlider->SetSlideHdl(LINK(this, MediaPlaybackPanel, SeekHdl));
+
+    maIdle.SetPriority( SchedulerPriority::HIGHEST );
+    maIdle.SetIdleHdl( LINK( this, MediaPlaybackPanel, TimeoutHdl ) );
+    maIdle.Start();
+    mpBindings->Invalidate(SID_AVMEDIA_TOOLBOX);
+}
+
+void MediaPlaybackPanel::dispose()
+{
+    mpTimeEdit.disposeAndClear();
+    PanelLayout::dispose();
+}
+
+void MediaPlaybackPanel::NotifyItemUpdate(
+    const sal_uInt16 nSID,
+    const SfxItemState eState,
+    const SfxPoolItem* pState,
+    const bool bIsEnabled)
+{
+    (void)bIsEnabled;
+    if( nSID == SID_AVMEDIA_TOOLBOX )
+    {
+        if(eState >= SfxItemState::DEFAULT)
+        {
+            mpMediaItem.reset(pState ? static_cast< MediaItem* >(pState->Clone()) : nullptr);
+            Update();
+        }
+    }
+}
+
+void MediaPlaybackPanel::UpdateToolBoxes(MediaItem aMediaItem)
+{
+    mpPlayToolBox->Disable();
+    avmedia::MediaControlBase::UpdateToolBoxes(aMediaItem);
+}
+
+void MediaPlaybackPanel::Update()
+{
+    UpdateToolBoxes( *mpMediaItem );
+    UpdateTimeSlider( *mpMediaItem );
+    UpdateVolumeSlider( *mpMediaItem );
+    UpdateTimeField( *mpMediaItem, mpMediaItem->getTime() );
+}
+
+IMPL_LINK_NOARG_TYPED( MediaPlaybackPanel, VolumeSlideHdl, Slider*, void)
+{
+    MediaItem aItem(SID_AVMEDIA_TOOLBOX);
+    aItem.setVolumeDB( static_cast< sal_Int16 > (mpVolumeSlider->GetThumbPos()));
+    mpBindings->GetDispatcher()->ExecuteList(SID_AVMEDIA_TOOLBOX, SfxCallMode::RECORD, { &aItem });
+}
+
+IMPL_LINK_NOARG_TYPED( MediaPlaybackPanel, SeekHdl, Slider*, void)
+{
+    MediaItem aItem(SID_AVMEDIA_TOOLBOX);
+    aItem.setState( MediaState::Pause );
+    aItem.setTime( mpTimeSlider->GetThumbPos() * mpMediaItem->getDuration() / AVMEDIA_TIME_RANGE);
+    mpBindings->GetDispatcher()->ExecuteList(SID_AVMEDIA_TOOLBOX, SfxCallMode::RECORD, { &aItem });
+    mpBindings->Invalidate(SID_AVMEDIA_TOOLBOX);
+}
+
+IMPL_LINK_NOARG_TYPED( MediaPlaybackPanel, TimeoutHdl, Idle*, void)
+{
+    mpBindings->Invalidate(SID_AVMEDIA_TOOLBOX);
+}
+
+IMPL_LINK_TYPED( MediaPlaybackPanel, PlayToolBoxSelectHdl, ToolBox*, pControl, void)
+{
+    MediaItem aItem(SID_AVMEDIA_TOOLBOX);
+    switch(pControl->GetCurItemId())
+    {
+        case AVMEDIA_TOOLBOXITEM_PLAY:
+        {
+            aItem.setState( MediaState::Play );
+
+            if( mpMediaItem->getTime() == mpMediaItem->getDuration() )
+                aItem.setTime( 0.0 );
+            else
+                aItem.setTime( mpMediaItem->getTime());
+        }
+        break;
+
+        case AVMEDIA_TOOLBOXITEM_PAUSE:
+        {
+            aItem.setState( MediaState::Pause );
+        }
+        break;
+
+        case AVMEDIA_TOOLBOXITEM_STOP:
+        {
+            aItem.setState( MediaState::Stop );
+            aItem.setTime( 0.0 );
+        }
+        break;
+
+        case AVMEDIA_TOOLBOXITEM_MUTE:
+        {
+            aItem.setMute( !mpMuteToolBox->IsItemChecked( AVMEDIA_TOOLBOXITEM_MUTE ) );
+        }
+        break;
+
+        case AVMEDIA_TOOLBOXITEM_LOOP:
+        {
+            aItem.setLoop( !mpPlayToolBox->IsItemChecked( AVMEDIA_TOOLBOXITEM_LOOP ) );
+        }
+        break;
+        default: break;
+    }
+    if(aItem.getMaskSet() != AVMediaSetMask::NONE)
+    {
+        mpBindings->GetDispatcher()->ExecuteList(SID_AVMEDIA_TOOLBOX, SfxCallMode::RECORD, { &aItem } );
+        mpBindings->Invalidate(SID_AVMEDIA_TOOLBOX);
+    }
+}
+
+} } // end of namespace svx::sidebar
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/svx/source/sidebar/media/MediaPlaybackPanel.hxx b/svx/source/sidebar/media/MediaPlaybackPanel.hxx
new file mode 100644
index 000000000000..0a4bd5ebf441
--- /dev/null
+++ b/svx/source/sidebar/media/MediaPlaybackPanel.hxx
@@ -0,0 +1,84 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef INCLUDED_SD_SOURCE_SIDEBAR_MEDIAPLAYBACKPANEL_HXX
+#define INCLUDED_SD_SOURCE_SIDEBAR_MEDIAPLAYBACKPANEL_HXX
+
+#include <vcl/ctrl.hxx>
+#include <com/sun/star/frame/XFrame.hpp>
+
+#include <svx/sidebar/PanelLayout.hxx>
+#include <vcl/layout.hxx>
+#include <vcl/slider.hxx>
+#include <vcl/toolbox.hxx>
+#include <avmedia/mediaitem.hxx>
+#include <sfx2/bindings.hxx>
+#include <sfx2/sidebar/ControllerItem.hxx>
+#include <avmedia/MediaControlBase.hxx>
+
+using namespace css;
+using namespace ::com::sun::star::uno;
+using namespace ::com::sun::star::frame;
+
+namespace svx { namespace sidebar {
+
+/** This panel provides media playback control in document
+*/
+class MediaPlaybackPanel
+    : public PanelLayout,
+    public ::sfx2::sidebar::ControllerItem::ItemUpdateReceiverInterface,
+    public ::avmedia::MediaControlBase
+{
+public:
+    MediaPlaybackPanel (
+        vcl::Window* pParent,
+        const css::uno::Reference<css::frame::XFrame>& rxFrame,
+        SfxBindings* pBindings);
+    static VclPtr<vcl::Window> Create(
+        vcl::Window* pParent,
+        const css::uno::Reference<css::frame::XFrame>& rxFrame,
+        SfxBindings* pBindings);
+    virtual ~MediaPlaybackPanel();
+    virtual void dispose() override;
+
+protected:
+    virtual void UpdateToolBoxes(avmedia::MediaItem aMediaItem) override;
+
+private:
+    std::unique_ptr< ::avmedia::MediaItem > mpMediaItem;
+    ::sfx2::sidebar::ControllerItem         maMediaController;
+    Idle            maIdle;
+    SfxBindings*    mpBindings;
+    void Initialize();
+    void Update();
+    virtual void NotifyItemUpdate( const sal_uInt16 nSID,
+                                    const SfxItemState eState,
+                                    const SfxPoolItem* pState,
+                                    const bool bIsEnabled) override;
+    DECL_LINK_TYPED(PlayToolBoxSelectHdl, ToolBox*, void);
+    DECL_LINK_TYPED(VolumeSlideHdl, Slider*, void);
+    DECL_LINK_TYPED(SeekHdl, Slider*, void);
+    DECL_LINK_TYPED(TimeoutHdl, Idle*, void);
+};
+
+
+} } // end of namespace svx::sidebar
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
\ No newline at end of file
diff --git a/svx/uiconfig/ui/mediaplayback.ui b/svx/uiconfig/ui/mediaplayback.ui
new file mode 100644
index 000000000000..2209bb24333a
--- /dev/null
+++ b/svx/uiconfig/ui/mediaplayback.ui
@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated with glade 3.16.1 -->
+<interface>
+  <requires lib="gtk+" version="3.10"/>
+  <object class="GtkGrid" id="MediaPlaybackPanel">
+    <property name="visible">True</property>
+    <property name="can_focus">False</property>
+    <property name="border_width">6</property>
+    <child>
+      <object class="GtkGrid" id="grid1">
+        <property name="visible">True</property>
+        <property name="can_focus">False</property>
+        <property name="halign">center</property>
+        <property name="border_width">6</property>
+        <property name="column_spacing">7</property>
+        <property name="row_homogeneous">True</property>
+        <child>
+          <object class="GtkLabel" id="label1">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="halign">end</property>
+            <property name="label" translatable="yes">Playback:</property>
+          </object>
+          <packing>
+            <property name="left_attach">0</property>
+            <property name="top_attach">0</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkLabel" id="label2">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="halign">end</property>
+            <property name="label" translatable="yes">Seek:</property>
+          </object>
+          <packing>
+            <property name="left_attach">0</property>
+            <property name="top_attach">1</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkLabel" id="label3">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="halign">end</property>
+            <property name="label" translatable="yes">Volume:</property>
+          </object>
+          <packing>
+            <property name="left_attach">0</property>
+            <property name="top_attach">3</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkScale" id="timeslider">
+            <property name="width_request">150</property>
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="round_digits">1</property>
+            <property name="digits">2</property>
+            <property name="draw_value">False</property>
+          </object>
+          <packing>
+            <property name="left_attach">1</property>
+            <property name="top_attach">1</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkComboBox" id="zoombox">
+            <property name="width_request">150</property>
+            <property name="can_focus">False</property>
+            <property name="tooltip_text" translatable="yes">View</property>
+          </object>
+          <packing>
+            <property name="left_attach">1</property>
+            <property name="top_attach">4</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkEntry" id="timeedit:border">
+            <property name="width_request">150</property>
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="editable">False</property>
+            <property name="xalign">0.5</property>
+          </object>
+          <packing>
+            <property name="left_attach">1</property>
+            <property name="top_attach">2</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkToolbar" id="playtoolbox">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+            <property name="halign">center</property>
+          </object>
+          <packing>
+            <property name="left_attach">1</property>
+            <property name="top_attach">0</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkToolbar" id="mutetoolbox">
+            <property name="visible">True</property>
+            <property name="can_focus">False</property>
+          </object>
+          <packing>
+            <property name="left_attach">2</property>
+            <property name="top_attach">3</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <object class="GtkScale" id="volumeslider">
+            <property name="width_request">150</property>
+            <property name="visible">True</property>
+            <property name="can_focus">True</property>
+            <property name="opacity">0.98999999999999999</property>
+            <property name="draw_value">False</property>
+          </object>
+          <packing>
+            <property name="left_attach">1</property>
+            <property name="top_attach">3</property>
+            <property name="width">1</property>
+            <property name="height">1</property>
+          </packing>
+        </child>
+        <child>
+          <placeholder/>
+        </child>
+        <child>
+          <placeholder/>
+        </child>
+        <child>
+          <placeholder/>
+        </child>
+        <child>
+          <placeholder/>
+        </child>
+        <child>
+          <placeholder/>
+        </child>
+        <child>
+          <placeholder/>
+        </child>
+      </object>
+      <packing>
+        <property name="left_attach">0</property>
+        <property name="top_attach">0</property>
+        <property name="width">1</property>
+        <property name="height">1</property>
+      </packing>
+    </child>
+  </object>
+</interface>