svx/source/svdraw/svdomedia.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column:100 -*- */
   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 <config_features.h>
  21
  22 #include <svx/svdomedia.hxx>
  23
  24 #include <rtl/ustring.hxx>
  25 #include <rtl/ustrbuf.hxx>
  26 #include <sal/log.hxx>
  27
  28 #include <ucbhelper/content.hxx>
  29 #include <comphelper/processfactory.hxx>
  30 #include <comphelper/storagehelper.hxx>
  31
  32 #include <vcl/svapp.hxx>
  33
  34 #include <svx/svdmodel.hxx>
  35 #include <svx/dialmgr.hxx>
  36 #include <svx/strings.hrc>
  37 #include <svx/sdr/contact/viewcontactofsdrmediaobj.hxx>
  38 #include <avmedia/mediawindow.hxx>
  39 #include <tools/diagnose_ex.h>
  40
  41 using namespace ::com::sun::star;
  42
  43
  44 struct SdrMediaObj::Impl
  45 {
  46     ::avmedia::MediaItem                  m_MediaProperties;
  47     // Note: the temp file is read only, until it is deleted!
  48     // It may be shared between multiple documents in case of copy/paste,
  49     // hence the shared_ptr.
  50     std::shared_ptr< ::avmedia::MediaTempFile >  m_pTempFile;
  51     uno::Reference< graphic::XGraphic >   m_xCachedSnapshot;
  52     OUString m_LastFailedPkgURL;
  53 };
  54
  55 SdrMediaObj::SdrMediaObj(SdrModel& rSdrModel)
  56 :   SdrRectObj(rSdrModel)
  57     ,m_xImpl( new Impl )
  58 {
  59 }
  60
  61 SdrMediaObj::SdrMediaObj(
  62     SdrModel& rSdrModel,
  63     const tools::Rectangle& rRect)
  64 :   SdrRectObj(rSdrModel, rRect)
  65     ,m_xImpl( new Impl )
  66 {
  67 }
  68
  69 SdrMediaObj::~SdrMediaObj()
  70 {
  71 }
  72
  73 bool SdrMediaObj::HasTextEdit() const
  74 {
  75     return false;
  76 }
  77
  78 std::unique_ptr<sdr::contact::ViewContact> SdrMediaObj::CreateObjectSpecificViewContact()
  79 {
  80     return std::make_unique<sdr::contact::ViewContactOfSdrMediaObj>( *this );
  81 }
  82
  83 void SdrMediaObj::TakeObjInfo( SdrObjTransformInfoRec& rInfo ) const
  84 {
  85     rInfo.bMoveAllowed = true;
  86     rInfo.bResizeFreeAllowed = true;
  87     rInfo.bResizePropAllowed = true;
  88     rInfo.bRotateFreeAllowed = false;
  89     rInfo.bRotate90Allowed = false;
  90     rInfo.bMirrorFreeAllowed = false;
  91     rInfo.bMirror45Allowed = false;
  92     rInfo.bMirror90Allowed = false;
  93     rInfo.bTransparenceAllowed = false;
  94     rInfo.bShearAllowed = false;
  95     rInfo.bEdgeRadiusAllowed = false;
  96     rInfo.bNoOrthoDesired = false;
  97     rInfo.bNoContortion = false;
  98     rInfo.bCanConvToPath = false;
  99     rInfo.bCanConvToPoly = false;
 100     rInfo.bCanConvToContour = false;
 101     rInfo.bCanConvToPathLineToArea = false;
 102     rInfo.bCanConvToPolyLineToArea = false;
 103 }
 104
 105 SdrObjKind SdrMediaObj::GetObjIdentifier() const
 106 {
 107     return OBJ_MEDIA;
 108 }
 109
 110 OUString SdrMediaObj::TakeObjNameSingul() const
 111 {
 112     OUStringBuffer sName(SvxResId(STR_ObjNameSingulMEDIA));
 113
 114     OUString aName(GetName());
 115
 116     if (!aName.isEmpty())
 117     {
 118         sName.append(' ');
 119         sName.append('\'');
 120         sName.append(aName);
 121         sName.append('\'');
 122     }
 123
 124     return sName.makeStringAndClear();
 125 }
 126
 127 OUString SdrMediaObj::TakeObjNamePlural() const
 128 {
 129     return SvxResId(STR_ObjNamePluralMEDIA);
 130 }
 131
 132 SdrMediaObj* SdrMediaObj::CloneSdrObject(SdrModel& rTargetModel) const
 133 {
 134     return CloneHelper< SdrMediaObj >(rTargetModel);
 135 }
 136
 137 SdrMediaObj& SdrMediaObj::operator=(const SdrMediaObj& rObj)
 138 {
 139     if( this == &rObj )
 140         return *this;
 141     SdrRectObj::operator=( rObj );
 142
 143     m_xImpl->m_pTempFile = rObj.m_xImpl->m_pTempFile; // before props
 144     setMediaProperties( rObj.getMediaProperties() );
 145     m_xImpl->m_xCachedSnapshot = rObj.m_xImpl->m_xCachedSnapshot;
 146     return *this;
 147 }
 148
 149 uno::Reference< graphic::XGraphic > const & SdrMediaObj::getSnapshot() const
 150 {
 151 #if HAVE_FEATURE_AVMEDIA
 152     if( !m_xImpl->m_xCachedSnapshot.is() )
 153     {
 154         OUString aRealURL = m_xImpl->m_MediaProperties.getTempURL();
 155         if( aRealURL.isEmpty() )
 156             aRealURL = m_xImpl->m_MediaProperties.getURL();
 157         m_xImpl->m_xCachedSnapshot = avmedia::MediaWindow::grabFrame( aRealURL, m_xImpl->m_MediaProperties.getReferer(), m_xImpl->m_MediaProperties.getMimeType());
 158     }
 159 #endif
 160     return m_xImpl->m_xCachedSnapshot;
 161 }
 162
 163 void SdrMediaObj::AdjustToMaxRect( const tools::Rectangle& rMaxRect, bool bShrinkOnly /* = false */ )
 164 {
 165     Size aSize( Application::GetDefaultDevice()->PixelToLogic(
 166                     static_cast< sdr::contact::ViewContactOfSdrMediaObj& >( GetViewContact() ).getPreferredSize(),
 167                     MapMode(MapUnit::Map100thMM)) );
 168     Size aMaxSize( rMaxRect.GetSize() );
 169
 170     if( aSize.IsEmpty() )
 171         return;
 172
 173     Point aPos( rMaxRect.TopLeft() );
 174
 175     // if graphic is too large, fit it to the page
 176     if ( (!bShrinkOnly                          ||
 177          ( aSize.Height() > aMaxSize.Height() ) ||
 178          ( aSize.Width()  > aMaxSize.Width()  ) )&&
 179          aSize.Height() && aMaxSize.Height() )
 180     {
 181         float fGrfWH =  static_cast<float>(aSize.Width()) /
 182                         static_cast<float>(aSize.Height());
 183         float fWinWH =  static_cast<float>(aMaxSize.Width()) /
 184                         static_cast<float>(aMaxSize.Height());
 185
 186         // scale graphic to page size
 187         if ( fGrfWH < fWinWH )
 188         {
 189             aSize.setWidth( static_cast<tools::Long>(aMaxSize.Height() * fGrfWH) );
 190             aSize.setHeight( aMaxSize.Height() );
 191         }
 192         else if ( fGrfWH > 0.F )
 193         {
 194             aSize.setWidth( aMaxSize.Width() );
 195             aSize.setHeight( static_cast<tools::Long>(aMaxSize.Width() / fGrfWH) );
 196         }
 197
 198         aPos = rMaxRect.Center();
 199     }
 200
 201     if( bShrinkOnly )
 202         aPos = maRect.TopLeft();
 203
 204     aPos.AdjustX( -(aSize.Width() / 2) );
 205     aPos.AdjustY( -(aSize.Height() / 2) );
 206     SetLogicRect( tools::Rectangle( aPos, aSize ) );
 207 }
 208
 209 void SdrMediaObj::setURL( const OUString& rURL, const OUString& rReferer, const OUString& rMimeType )
 210 {
 211     ::avmedia::MediaItem aURLItem;
 212 #if HAVE_FEATURE_AVMEDIA
 213     if( !rMimeType.isEmpty() )
 214         m_xImpl->m_MediaProperties.setMimeType(rMimeType);
 215     aURLItem.setURL( rURL, "", rReferer );
 216 #else
 217     (void) rMimeType;
 218     (void) rURL;
 219     (void) rReferer;
 220 #endif
 221     setMediaProperties( aURLItem );
 222 }
 223
 224 const OUString& SdrMediaObj::getURL() const
 225 {
 226 #if HAVE_FEATURE_AVMEDIA
 227     return m_xImpl->m_MediaProperties.getURL();
 228 #else
 229 static OUString ret;
 230     return ret;
 231 #endif
 232 }
 233
 234 void SdrMediaObj::setMediaProperties( const ::avmedia::MediaItem& rState )
 235 {
 236     mediaPropertiesChanged( rState );
 237     static_cast< sdr::contact::ViewContactOfSdrMediaObj& >( GetViewContact() ).executeMediaItem( getMediaProperties() );
 238 }
 239
 240 const ::avmedia::MediaItem& SdrMediaObj::getMediaProperties() const
 241 {
 242     return m_xImpl->m_MediaProperties;
 243 }
 244
 245 uno::Reference<io::XInputStream> SdrMediaObj::GetInputStream() const
 246 {
 247     if (!m_xImpl->m_pTempFile)
 248     {
 249         SAL_WARN("svx", "this is only intended for embedded media");
 250         return nullptr;
 251     }
 252     ucbhelper::Content tempFile(m_xImpl->m_pTempFile->m_TempFileURL,
 253                 uno::Reference<ucb::XCommandEnvironment>(),
 254                 comphelper::getProcessComponentContext());
 255     return tempFile.openStream();
 256 }
 257
 258 void SdrMediaObj::SetInputStream(uno::Reference<io::XInputStream> const& xStream)
 259 {
 260     if (m_xImpl->m_pTempFile || m_xImpl->m_LastFailedPkgURL.isEmpty())
 261     {
 262         SAL_WARN("svx", "this is only intended for embedded media");
 263         return;
 264     }
 265
 266     OUString tempFileURL;
 267     const bool bSuccess(
 268         ::avmedia::CreateMediaTempFile(
 269             xStream,
 270             tempFileURL,
 271             ""));
 272
 273     if (bSuccess)
 274     {
 275         m_xImpl->m_pTempFile = std::make_shared<::avmedia::MediaTempFile>(tempFileURL);
 276 #if HAVE_FEATURE_AVMEDIA
 277         m_xImpl->m_MediaProperties.setURL(
 278             m_xImpl->m_LastFailedPkgURL, tempFileURL, "");
 279 #endif
 280     }
 281     m_xImpl->m_LastFailedPkgURL.clear(); // once only
 282 }
 283
 284 /// copy a stream from XStorage to temp file
 285 #if HAVE_FEATURE_AVMEDIA
 286 static bool lcl_HandlePackageURL(
 287     OUString const & rURL,
 288     const SdrModel& rModel,
 289     OUString & o_rTempFileURL)
 290 {
 291     ::comphelper::LifecycleProxy sourceProxy;
 292     uno::Reference<io::XInputStream> xInStream;
 293     try {
 294         xInStream = rModel.GetDocumentStream(rURL, sourceProxy);
 295     }
 296     catch (container::NoSuchElementException const&)
 297     {
 298         SAL_INFO("svx", "not found: '" << rURL << "'");
 299         return false;
 300     }
 301     catch (uno::Exception const&)
 302     {
 303         TOOLS_WARN_EXCEPTION("svx", "");
 304         return false;
 305     }
 306     if (!xInStream.is())
 307     {
 308         SAL_WARN("svx", "no stream?");
 309         return false;
 310     }
 311     // Make sure the temporary copy has the same file name extension as the original media file
 312     // (like .mp4). That seems to be important for some AVFoundation APIs. For random extension-less
 313     // file names, they don't seem to even bother looking inside the file.
 314     sal_Int32 nLastDot = rURL.lastIndexOf('.');
 315     sal_Int32 nLastSlash = rURL.lastIndexOf('/');
 316     OUString sDesiredExtension;
 317     if (nLastDot > nLastSlash && nLastDot+1 < rURL.getLength())
 318         sDesiredExtension = rURL.copy(nLastDot);
 319     return ::avmedia::CreateMediaTempFile(xInStream, o_rTempFileURL, sDesiredExtension);
 320 }
 321 #endif
 322
 323 void SdrMediaObj::mediaPropertiesChanged( const ::avmedia::MediaItem& rNewProperties )
 324 {
 325     bool bBroadcastChanged = false;
 326 #if HAVE_FEATURE_AVMEDIA
 327     const AVMediaSetMask nMaskSet = rNewProperties.getMaskSet();
 328
 329     // use only a subset of MediaItem properties for own properties
 330     if( AVMediaSetMask::MIME_TYPE & nMaskSet )
 331         m_xImpl->m_MediaProperties.setMimeType( rNewProperties.getMimeType() );
 332
 333     if( ( AVMediaSetMask::URL & nMaskSet ) &&
 334         ( rNewProperties.getURL() != getURL() ))
 335     {
 336         m_xImpl->m_xCachedSnapshot.clear();
 337         OUString const& url(rNewProperties.getURL());
 338         if (url.startsWithIgnoreAsciiCase("vnd.sun.star.Package:"))
 339         {
 340             if (   !m_xImpl->m_pTempFile
 341                 || (m_xImpl->m_pTempFile->m_TempFileURL !=
 342                                 rNewProperties.getTempURL()))
 343             {
 344                 OUString tempFileURL;
 345                 const bool bSuccess(
 346                     lcl_HandlePackageURL(
 347                         url,
 348                         getSdrModelFromSdrObject(),
 349                         tempFileURL));
 350
 351                 if (bSuccess)
 352                 {
 353                     m_xImpl->m_pTempFile =
 354                             std::make_shared<::avmedia::MediaTempFile>(tempFileURL);
 355                     m_xImpl->m_MediaProperties.setURL(url, tempFileURL, "");
 356                 }
 357                 else // this case is for Clone via operator=
 358                 {
 359                     m_xImpl->m_pTempFile.reset();
 360                     m_xImpl->m_MediaProperties.setURL("", "", "");
 361                     // UGLY: oox import also gets here, because unlike ODF
 362                     // getDocumentStorage() is not the imported file...
 363                     m_xImpl->m_LastFailedPkgURL = url;
 364                 }
 365             }
 366             else
 367             {
 368                 m_xImpl->m_MediaProperties.setURL(url,
 369                         rNewProperties.getTempURL(), "");
 370             }
 371         }
 372         else
 373         {
 374             m_xImpl->m_pTempFile.reset();
 375             m_xImpl->m_MediaProperties.setURL(url, "", rNewProperties.getReferer());
 376         }
 377         bBroadcastChanged = true;
 378     }
 379
 380     if( AVMediaSetMask::LOOP & nMaskSet )
 381         m_xImpl->m_MediaProperties.setLoop( rNewProperties.isLoop() );
 382
 383     if( AVMediaSetMask::MUTE & nMaskSet )
 384         m_xImpl->m_MediaProperties.setMute( rNewProperties.isMute() );
 385
 386     if( AVMediaSetMask::VOLUMEDB & nMaskSet )
 387         m_xImpl->m_MediaProperties.setVolumeDB( rNewProperties.getVolumeDB() );
 388
 389     if( AVMediaSetMask::ZOOM & nMaskSet )
 390         m_xImpl->m_MediaProperties.setZoom( rNewProperties.getZoom() );
 391 #else
 392     (void) rNewProperties;
 393 #endif
 394
 395     if( bBroadcastChanged )
 396     {
 397         SetChanged();
 398         BroadcastObjectChange();
 399     }
 400 }
 401
 402 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */