slideshow/source/engine/animationnodes/animationaudionode.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: animationaudionode.hxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef INCLUDED_SLIDESHOW_ANIMATIONAUDIONODE_HXX
  31 #define INCLUDED_SLIDESHOW_ANIMATIONAUDIONODE_HXX
  32
  33 #include "basecontainernode.hxx"
  34 #include "soundplayer.hxx"
  35 #include "com/sun/star/animations/XAnimationNode.hpp"
  36 #include "com/sun/star/animations/XAudio.hpp"
  37
  38 namespace slideshow {
  39 namespace internal {
  40
  41 /** Audio node.
  42
  43     This animation node contains an audio effect. Duration and
  44     start/stop behaviour is affected by the referenced audio
  45     file.
  46 */
  47 class AnimationAudioNode : public BaseNode, public AnimationEventHandler
  48 {
  49 public:
  50     AnimationAudioNode(
  51         ::com::sun::star::uno::Reference<
  52         ::com::sun::star::animations::XAnimationNode> const& xNode,
  53         ::boost::shared_ptr<BaseContainerNode> const& pParent,
  54         NodeContext const& rContext );
  55
  56 protected:
  57     virtual void dispose();
  58
  59 private:
  60     virtual void activate_st();
  61     virtual void deactivate_st( NodeState eDestState );
  62     virtual bool hasPendingAnimation() const;
  63
  64     /// overriden, because we need to deal with STOPAUDIO commands
  65     virtual bool handleAnimationEvent( const AnimationNodeSharedPtr& rNode );
  66
  67 private:
  68     ::com::sun::star::uno::Reference<
  69         ::com::sun::star::animations::XAudio >  mxAudioNode;
  70     ::rtl::OUString                             maSoundURL;
  71     mutable SoundPlayerSharedPtr                mpPlayer;
  72
  73     void createPlayer() const;
  74     void resetPlayer() const;
  75 };
  76
  77 } // namespace internal
  78 } // namespace slideshow
  79
  80 #endif /* INCLUDED_SLIDESHOW_ANIMATIONAUDIONODE_HXX */