106ea87205
...which was introduced with3ead3ad52f"Gradually typed Link" to distinguish the new, typed versions from the old, untyped ones, but is no longer necessary since382eb1a23c"remove untyped Link<>" removed the old versions. Change-Id: I494025df486a16a45861fcd8192dfe0275b1103c
348 lines
15 KiB
C++
348 lines
15 KiB
C++
/* -*- 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 "soundhandler.hxx"
|
|
|
|
#include <unotools/mediadescriptor.hxx>
|
|
|
|
#include <com/sun/star/io/XInputStream.hpp>
|
|
#include <com/sun/star/frame/DispatchResultState.hpp>
|
|
|
|
#include <comphelper/sequenceashashmap.hxx>
|
|
#include <rtl/ustrbuf.hxx>
|
|
|
|
#include <cppuhelper/queryinterface.hxx>
|
|
#include <cppuhelper/typeprovider.hxx>
|
|
#include <cppuhelper/factory.hxx>
|
|
#include <cppuhelper/supportsservice.hxx>
|
|
|
|
namespace avmedia{
|
|
|
|
|
|
// XInterface, XTypeProvider, XServiceInfo
|
|
|
|
|
|
void SAL_CALL SoundHandler::acquire() throw()
|
|
{
|
|
/* Don't use mutex in methods of XInterface! */
|
|
OWeakObject::acquire();
|
|
}
|
|
|
|
void SAL_CALL SoundHandler::release() throw()
|
|
{
|
|
/* Don't use mutex in methods of XInterface! */
|
|
OWeakObject::release();
|
|
}
|
|
|
|
css::uno::Any SAL_CALL SoundHandler::queryInterface( const css::uno::Type& aType ) throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
/* Attention: Don't use mutex or guard in this method!!! Is a method of XInterface. */
|
|
/* Ask for my own supported interfaces ...*/
|
|
css::uno::Any aReturn( ::cppu::queryInterface( aType,
|
|
static_cast< css::lang::XTypeProvider* >(this),
|
|
static_cast< css::lang::XServiceInfo* >(this),
|
|
static_cast< css::frame::XNotifyingDispatch* >(this),
|
|
static_cast< css::frame::XDispatch* >(this),
|
|
static_cast< css::document::XExtendedFilterDetection* >(this)));
|
|
/* If searched interface not supported by this class ... */
|
|
if ( !aReturn.hasValue() )
|
|
{
|
|
/* ... ask baseclass for interfaces! */
|
|
aReturn = OWeakObject::queryInterface( aType );
|
|
}
|
|
/* Return result of this search. */
|
|
return aReturn;
|
|
}
|
|
|
|
css::uno::Sequence< sal_Int8 > SAL_CALL SoundHandler::getImplementationId() throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
return css::uno::Sequence<sal_Int8>();
|
|
}
|
|
|
|
css::uno::Sequence< css::uno::Type > SAL_CALL SoundHandler::getTypes() throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
/* Optimize this method ! */
|
|
/* We initialize a static variable only one time. */
|
|
/* And we don't must use a mutex at every call! */
|
|
/* For the first call; pTypeCollection is NULL - */
|
|
/* for the second call pTypeCollection is different from NULL! */
|
|
static ::cppu::OTypeCollection* pTypeCollection = nullptr ;
|
|
if ( pTypeCollection == nullptr )
|
|
{
|
|
/* Ready for multithreading; get global mutex for first call of this method only! see before */
|
|
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
|
|
/* Control these pointer again ... it can be, that another instance will be faster then these! */
|
|
if ( pTypeCollection == nullptr )
|
|
{
|
|
/* Create a static typecollection ... */
|
|
static ::cppu::OTypeCollection aTypeCollection
|
|
(
|
|
cppu::UnoType<css::lang::XTypeProvider>::get(),
|
|
cppu::UnoType<css::lang::XServiceInfo>::get(),
|
|
cppu::UnoType<css::frame::XNotifyingDispatch>::get(),
|
|
cppu::UnoType<css::frame::XDispatch>::get(),
|
|
cppu::UnoType<css::document::XExtendedFilterDetection>::get()
|
|
);
|
|
/* ... and set his address to static pointer! */
|
|
pTypeCollection = &aTypeCollection ;
|
|
}
|
|
}
|
|
return pTypeCollection->getTypes();
|
|
}
|
|
|
|
#define IMPLEMENTATIONNAME_SOUNDHANDLER OUString("com.sun.star.comp.framework.SoundHandler")
|
|
|
|
/*===========================================================================================================*/
|
|
/* XServiceInfo */
|
|
/*===========================================================================================================*/
|
|
OUString SAL_CALL SoundHandler::getImplementationName() throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
return IMPLEMENTATIONNAME_SOUNDHANDLER;
|
|
}
|
|
|
|
// XServiceInfo
|
|
sal_Bool SAL_CALL SoundHandler::supportsService( const OUString& sServiceName ) throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
return cppu::supportsService(this, sServiceName);
|
|
}
|
|
|
|
// XServiceInfo
|
|
css::uno::Sequence< OUString > SAL_CALL SoundHandler::getSupportedServiceNames() throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
return { "com.sun.star.frame.ContentHandler" };
|
|
}
|
|
|
|
/*-************************************************************************************************************
|
|
@short standard ctor
|
|
@descr These initialize a new instance of this class with needed information for work.
|
|
|
|
@seealso using at owner
|
|
|
|
@param "xFactory", reference to service manager for creation of new services
|
|
@onerror Show an assertion and do nothing else.
|
|
@threadsafe yes
|
|
*//*-*************************************************************************************************************/
|
|
SoundHandler::SoundHandler()
|
|
// Init baseclasses first
|
|
: ThreadHelpBase ( )
|
|
, ::cppu::OWeakObject ( )
|
|
// Init member
|
|
, m_bError ( false )
|
|
, m_aUpdateIdle ( "avmedia SoundHandler Update" )
|
|
{
|
|
m_aUpdateIdle.SetIdleHdl(LINK(this, SoundHandler, implts_PlayerNotify));
|
|
}
|
|
|
|
/*-************************************************************************************************************
|
|
@short standard dtor
|
|
*//*-*************************************************************************************************************/
|
|
SoundHandler::~SoundHandler()
|
|
{
|
|
if (m_xListener.is())
|
|
{
|
|
css::frame::DispatchResultEvent aEvent;
|
|
aEvent.State = css::frame::DispatchResultState::FAILURE;
|
|
m_xListener->dispatchFinished(aEvent);
|
|
m_xListener.clear();
|
|
}
|
|
}
|
|
|
|
/*-************************************************************************************************************
|
|
@interface css::frame::XDispatch
|
|
|
|
@short try to load audio file
|
|
@descr This method try to load given audio file by URL and play it. We use vcl/Sound class to do that.
|
|
Playing of sound is asynchron every time.
|
|
|
|
@attention We must hold us alive by ourself ... because we use async. vcl sound player ... but playing is started
|
|
in async interface call "dispatch()" too. And caller forget us immediately. But then our uno ref count
|
|
will decreased to 0 and will die. The only solution is to use own reference to our implementation.
|
|
But we do it for really started jobs only and release it during call back of vcl.
|
|
|
|
@seealso class vcl/Sound
|
|
@seealso method implts_PlayerNotify()
|
|
|
|
@param "aURL" , URL to dispatch.
|
|
@param "lArguments", list of optional arguments.
|
|
@onerror We do nothing.
|
|
@threadsafe yes
|
|
*//*-*************************************************************************************************************/
|
|
void SAL_CALL SoundHandler::dispatchWithNotification(const css::util::URL& aURL ,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lDescriptor,
|
|
const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException, std::exception)
|
|
{
|
|
// SAFE {
|
|
const ::osl::MutexGuard aLock( m_aLock );
|
|
|
|
utl::MediaDescriptor aDescriptor(lDescriptor);
|
|
|
|
{
|
|
//close streams otherwise on windows we can't reopen the file in the
|
|
//media player when we pass the url to directx as it'll already be open
|
|
css::uno::Reference< css::io::XInputStream > xInputStream =
|
|
aDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_INPUTSTREAM(),
|
|
css::uno::Reference< css::io::XInputStream >());
|
|
if (xInputStream.is()) xInputStream->closeInput();
|
|
}
|
|
|
|
// If player currently used for other dispatch() requests ...
|
|
// cancel it by calling stop()!
|
|
m_aUpdateIdle.Stop();
|
|
if (m_xPlayer.is())
|
|
{
|
|
if (m_xPlayer->isPlaying())
|
|
m_xPlayer->stop();
|
|
m_xPlayer.clear();
|
|
}
|
|
|
|
// Try to initialize player.
|
|
m_xListener = xListener;
|
|
try
|
|
{
|
|
m_bError = false;
|
|
m_xPlayer.set( avmedia::MediaWindow::createPlayer( aURL.Complete, aDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_REFERRER(), OUString()) ), css::uno::UNO_QUERY_THROW );
|
|
// OK- we can start async playing ...
|
|
// Count this request and initialize self-holder against dying by uno ref count ...
|
|
m_xSelfHold.set(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY);
|
|
m_xPlayer->start();
|
|
m_aUpdateIdle.SetPriority( SchedulerPriority::LOWER );
|
|
m_aUpdateIdle.Start();
|
|
}
|
|
catch( css::uno::Exception& e )
|
|
{
|
|
m_bError = true;
|
|
(void)e;
|
|
m_xPlayer.clear();
|
|
}
|
|
|
|
// } SAFE
|
|
}
|
|
|
|
void SAL_CALL SoundHandler::dispatch( const css::util::URL& aURL ,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
dispatchWithNotification(aURL, lArguments, css::uno::Reference< css::frame::XDispatchResultListener >());
|
|
}
|
|
|
|
/*-************************************************************************************************************
|
|
@interface css::document::XExtendedFilterDetection
|
|
|
|
@short try to detect file (given as argument included in "lDescriptor")
|
|
@descr We try to detect, if given file could be handled by this class and is a well known one.
|
|
If it is - we return right internal type name - otherwise we return nothing!
|
|
So call can search for another detect service and ask him too.
|
|
|
|
@attention a) We don't need any mutex here ... because we don't use any member!
|
|
b) Don't use internal player instance "m_pPlayer" to detect given sound file!
|
|
It's not necessary to do that ... and we can use temp. variable to do the same.
|
|
This way is easy - we don't must synchronize it with currently played sounds!
|
|
Another reason to do so ... We are a listener on our internal ma_Player object.
|
|
If you would call "IsSoundFile()" on this instance, he would call us back and
|
|
we make some unnecessary things ...
|
|
@param "lDescriptor", description of file to detect
|
|
@return Internal type name which match this file ... or nothing if it is unknown.
|
|
|
|
@onerror We return nothing.
|
|
@threadsafe yes
|
|
*//*-*************************************************************************************************************/
|
|
OUString SAL_CALL SoundHandler::detect( css::uno::Sequence< css::beans::PropertyValue >& lDescriptor ) throw( css::uno::RuntimeException, std::exception )
|
|
{
|
|
// Our default is "nothing". So we can return it, if detection failed or file type is really unknown.
|
|
OUString sTypeName;
|
|
|
|
// Analyze given descriptor to find filename or input stream or ...
|
|
utl::MediaDescriptor aDescriptor(lDescriptor);
|
|
OUString sURL = aDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_URL(), OUString());
|
|
OUString sReferer = aDescriptor.getUnpackedValueOrDefault(utl::MediaDescriptor::PROP_REFERRER(), OUString());
|
|
|
|
if (
|
|
!sURL.isEmpty() &&
|
|
(avmedia::MediaWindow::isMediaURL(sURL, sReferer))
|
|
)
|
|
{
|
|
// If the file type is supported depends on the OS, so...
|
|
// I think we can the following ones:
|
|
// a) look for given extension of url to map our type decision HARD CODED!!!
|
|
// b) return preferred type every time... it's easy :-)
|
|
sTypeName = "wav_Wave_Audio_File";
|
|
aDescriptor[utl::MediaDescriptor::PROP_TYPENAME()] <<= sTypeName;
|
|
aDescriptor >> lDescriptor;
|
|
}
|
|
|
|
// Return our decision.
|
|
return sTypeName;
|
|
}
|
|
|
|
/*-************************************************************************************************************
|
|
@short call back of sound player
|
|
@descr Our player call us back to give us some information.
|
|
We use this information to callback our might existing listener.
|
|
|
|
@seealso method dispatchWithNotification()
|
|
@return 0 every time... it doesn't matter for us.
|
|
@threadsafe yes
|
|
*//*-*************************************************************************************************************/
|
|
IMPL_LINK_NOARG(SoundHandler, implts_PlayerNotify, Idle *, void)
|
|
{
|
|
// SAFE {
|
|
::osl::ClearableMutexGuard aLock( m_aLock );
|
|
|
|
if (m_xPlayer.is() && m_xPlayer->isPlaying() && m_xPlayer->getMediaTime() < m_xPlayer->getDuration())
|
|
{
|
|
m_aUpdateIdle.Start();
|
|
return;
|
|
}
|
|
m_xPlayer.clear();
|
|
|
|
// We use m_xSelfHold to let us die ... but we must live till real finishing of this method too!!!
|
|
// So we SHOULD use another "self-holder" temp. to provide that ...
|
|
css::uno::Reference< css::uno::XInterface > xOperationHold = m_xSelfHold;
|
|
m_xSelfHold.clear();
|
|
|
|
// notify might existing listener
|
|
// And forget this listener!
|
|
// Because the corresponding dispatch was finished.
|
|
if (m_xListener.is())
|
|
{
|
|
css::frame::DispatchResultEvent aEvent;
|
|
if (!m_bError)
|
|
aEvent.State = css::frame::DispatchResultState::SUCCESS;
|
|
else
|
|
aEvent.State = css::frame::DispatchResultState::FAILURE;
|
|
m_xListener->dispatchFinished(aEvent);
|
|
m_xListener.clear();
|
|
}
|
|
|
|
// } SAFE
|
|
//release aLock before end of method at which point xOperationHold goes out of scope and pThis dies
|
|
aLock.clear();
|
|
}
|
|
|
|
} // namespace framework
|
|
|
|
|
|
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* SAL_CALL
|
|
com_sun_star_comp_framework_SoundHandler_get_implementation(css::uno::XComponentContext*,
|
|
css::uno::Sequence<css::uno::Any> const &)
|
|
{
|
|
return cppu::acquire(new avmedia::SoundHandler);
|
|
}
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|