slideshow/source/engine/animationnodes/animationaudionode.cxx

   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 #include <sal/config.h>
  21
  22 #include <com/sun/star/lang/NoSupportException.hpp>
  23
  24 #include <eventqueue.hxx>
  25 #include "animationaudionode.hxx"
  26 #include <delayevent.hxx>
  27 #include <tools.hxx>
  28 #include "nodetools.hxx"
  29
  30 using namespace com::sun::star;
  31
  32 namespace slideshow {
  33 namespace internal {
  34
  35 AnimationAudioNode::AnimationAudioNode(
  36     const uno::Reference< animations::XAnimationNode >& xNode,
  37     const BaseContainerNodeSharedPtr&                   rParent,
  38     const NodeContext&                                  rContext )
  39     : BaseNode( xNode, rParent, rContext ),
  40       mxAudioNode( xNode, uno::UNO_QUERY_THROW ),
  41       maSoundURL(),
  42       mpPlayer()
  43 {
  44     mxAudioNode->getSource() >>= maSoundURL;
  45
  46     OSL_ENSURE( !maSoundURL.isEmpty(),
  47                 "could not extract sound source URL/empty URL string" );
  48
  49     ENSURE_OR_THROW( getContext().mxComponentContext.is(),
  50                       "Invalid component context" );
  51 }
  52
  53 void AnimationAudioNode::dispose()
  54 {
  55     resetPlayer();
  56     mxAudioNode.clear();
  57     BaseNode::dispose();
  58 }
  59
  60 void AnimationAudioNode::activate_st()
  61 {
  62     createPlayer();
  63
  64     AnimationEventHandlerSharedPtr aHandler(
  65         std::dynamic_pointer_cast<AnimationEventHandler>( getSelf() ) );
  66     OSL_ENSURE( aHandler,
  67                 "could not cast self to AnimationEventHandler?" );
  68     getContext().mrEventMultiplexer.addCommandStopAudioHandler( aHandler );
  69
  70     if (mpPlayer && mpPlayer->startPlayback())
  71     {
  72         // TODO(F2): Handle end time attribute, too
  73         if( getXAnimationNode()->getDuration().hasValue() )
  74         {
  75             scheduleDeactivationEvent();
  76         }
  77         else
  78         {
  79             // no node duration. Take inherent media time, then
  80             auto self(getSelf());
  81             scheduleDeactivationEvent(
  82                 makeDelay( [self] () { self->deactivate(); },
  83                            mpPlayer->getDuration(),
  84                            "AnimationAudioNode::deactivate with delay") );
  85         }
  86     }
  87     else
  88     {
  89         // deactivate ASAP:
  90         auto self(getSelf());
  91         scheduleDeactivationEvent(
  92             makeEvent( [self] () { self->deactivate(); },
  93                                     "AnimationAudioNode::deactivate without delay") );
  94     }
  95 }
  96
  97 // TODO(F2): generate deactivation event, when sound
  98 // is over
  99
 100 // libc++ and MSVC std::bind doesn't cut it here, and it's not possible to use
 101 // a lambda because the preprocessor thinks that comma in capture list
 102 // separates macro parameters
 103 struct NotifyAudioStopped
 104 {
 105     EventMultiplexer & m_rEventMultiplexer;
 106     ::std::shared_ptr<BaseNode> m_pSelf;
 107     NotifyAudioStopped(EventMultiplexer & rEventMultiplexer,
 108             ::std::shared_ptr<BaseNode> const& pSelf)
 109         : m_rEventMultiplexer(rEventMultiplexer), m_pSelf(pSelf) { }
 110
 111     void operator()()
 112     {
 113         m_rEventMultiplexer.notifyAudioStopped(m_pSelf);
 114     }
 115 };
 116
 117 void AnimationAudioNode::deactivate_st( NodeState /*eDestState*/ )
 118 {
 119     AnimationEventHandlerSharedPtr aHandler(
 120         std::dynamic_pointer_cast<AnimationEventHandler>( getSelf() ) );
 121     OSL_ENSURE( aHandler,
 122                 "could not cast self to AnimationEventHandler?" );
 123     getContext().mrEventMultiplexer.removeCommandStopAudioHandler( aHandler );
 124
 125     // force-end sound
 126     if (mpPlayer)
 127     {
 128         mpPlayer->stopPlayback();
 129         resetPlayer();
 130     }
 131
 132     // notify _after_ state change:
 133     getContext().mrEventQueue.addEvent(
 134         makeEvent( NotifyAudioStopped(getContext().mrEventMultiplexer, getSelf()),
 135                    "AnimationAudioNode::notifyAudioStopped") );
 136 }
 137
 138 bool AnimationAudioNode::hasPendingAnimation() const
 139 {
 140     // force slide to use the animation framework
 141     // (otherwise, a single sound on the slide would
 142     // not be played).
 143     return true;
 144 }
 145
 146 void AnimationAudioNode::createPlayer() const
 147 {
 148     if (mpPlayer)
 149         return;
 150
 151     try
 152     {
 153         mpPlayer = SoundPlayer::create( getContext().mrEventMultiplexer,
 154                                         maSoundURL,
 155                                         getContext().mxComponentContext );
 156     }
 157     catch( lang::NoSupportException& )
 158     {
 159         // catch possible exceptions from SoundPlayer,
 160         // since being not able to playback the sound
 161         // is not a hard error here (remainder of the
 162         // animations should still work).
 163     }
 164 }
 165
 166 void AnimationAudioNode::resetPlayer() const
 167 {
 168     if (mpPlayer)
 169     {
 170         mpPlayer->stopPlayback();
 171         mpPlayer->dispose();
 172         mpPlayer.reset();
 173     }
 174 }
 175
 176 bool AnimationAudioNode::handleAnimationEvent(
 177     const AnimationNodeSharedPtr& /*rNode*/ )
 178 {
 179     // TODO(F2): for now we support only STOPAUDIO events.
 180     deactivate();
 181     return true;
 182 }
 183
 184 } // namespace internal
 185 } // namespace presentation
 186
 187 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */