include/avmedia/mediaitem.hxx

   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 #ifndef INCLUDED_AVMEDIA_MEDIAITEM_HXX
  21 #define INCLUDED_AVMEDIA_MEDIAITEM_HXX
  22
  23 #include <svl/poolitem.hxx>
  24 #include <com/sun/star/media/ZoomLevel.hpp>
  25 #include <avmedia/avmediadllapi.h>
  26 #include <memory>
  27 #include <string_view>
  28
  29 #include <o3tl/typed_flags_set.hxx>
  30
  31 namespace com::sun::star::embed { class XStorage; }
  32 namespace com::sun::star::frame { class XModel; }
  33 namespace com::sun::star::io { class XInputStream; }
  34 namespace com::sun::star::io { class XStream; }
  35 class Graphic;
  36
  37 enum class AVMediaSetMask
  38 {
  39     NONE        = 0x000,
  40     STATE       = 0x001,
  41     DURATION    = 0x002,
  42     TIME        = 0x004,
  43     LOOP        = 0x008,
  44     MUTE        = 0x010,
  45     VOLUMEDB    = 0x020,
  46     ZOOM        = 0x040,
  47     URL         = 0x080,
  48     MIME_TYPE   = 0x100,
  49     GRAPHIC     = 0x200,
  50     ALL         = 0x3ff,
  51 };
  52 namespace o3tl
  53 {
  54     template<> struct typed_flags<AVMediaSetMask> : is_typed_flags<AVMediaSetMask, 0x3ff> {};
  55 }
  56
  57
  58 namespace avmedia
  59 {
  60
  61
  62 enum class MediaState
  63 {
  64     Stop, Play, Pause
  65 };
  66
  67
  68 class AVMEDIA_DLLPUBLIC MediaItem final : public SfxPoolItem
  69 {
  70 public:
  71                             static SfxPoolItem* CreateDefault();
  72
  73     explicit                MediaItem( sal_uInt16 i_nWhich = 0,
  74                                        AVMediaSetMask nMaskSet = AVMediaSetMask::NONE );
  75                             MediaItem( const MediaItem& rMediaItem );
  76     virtual                 ~MediaItem() override;
  77
  78     virtual bool            operator==( const SfxPoolItem& ) const override;
  79     virtual MediaItem*      Clone( SfxItemPool* pPool = nullptr ) const override;
  80     virtual bool            GetPresentation( SfxItemPresentation ePres,
  81                                                  MapUnit eCoreUnit,
  82                                                  MapUnit ePresUnit,
  83                                                  OUString&  rText,
  84                                                  const IntlWrapper& rIntl ) const override;
  85     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  86     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  87
  88     void                    merge( const MediaItem& rMediaItem );
  89
  90     AVMediaSetMask          getMaskSet() const;
  91
  92     void                    setState( MediaState eState );
  93     MediaState              getState() const;
  94
  95     void                    setDuration( double fDuration );
  96     double                  getDuration() const;
  97
  98     void                    setTime( double fTime );
  99     double                  getTime() const;
 100
 101     void                    setLoop( bool bLoop );
 102     bool                    isLoop() const;
 103
 104     void                    setMute( bool bMute );
 105     bool                    isMute() const;
 106
 107     void                    setVolumeDB( sal_Int16 nDB );
 108     sal_Int16               getVolumeDB() const;
 109
 110     void                    setZoom( ::css::media::ZoomLevel eZoom );
 111     ::css::media::ZoomLevel getZoom() const;
 112
 113     void                    setURL( const OUString& rURL,
 114                                     const OUString& rTempURL,
 115                                     const OUString& rReferer);
 116     const OUString&         getURL() const;
 117
 118     void                    setMimeType( const OUString& rMimeType );
 119     OUString                getMimeType() const;
 120     void setGraphic(const Graphic& rGraphic);
 121     Graphic getGraphic() const;
 122     const OUString&         getTempURL() const;
 123
 124     const OUString&         getReferer() const;
 125
 126 private:
 127
 128     struct Impl;
 129     std::unique_ptr<Impl> m_pImpl;
 130 };
 131
 132 typedef ::avmedia::MediaItem avmedia_MediaItem;
 133
 134 bool AVMEDIA_DLLPUBLIC EmbedMedia(
 135         const ::css::uno::Reference< ::css::frame::XModel>& xModel,
 136         const OUString& rSourceURL,
 137         OUString & o_rEmbeddedURL,
 138         ::css::uno::Reference<::css::io::XInputStream> const& xInputStream =
 139             ::css::uno::Reference<::css::io::XInputStream>());
 140
 141 bool AVMEDIA_DLLPUBLIC CreateMediaTempFile(
 142         ::css::uno::Reference<::css::io::XInputStream> const& xInStream,
 143         OUString& o_rTempFileURL,
 144         std::u16string_view rDesiredExtension);
 145
 146 OUString GetFilename(OUString const& rSourceURL);
 147
 148 ::css::uno::Reference< ::css::io::XStream> CreateStream(
 149     const ::css::uno::Reference< ::css::embed::XStorage>& xStorage, const OUString& rFilename);
 150
 151 struct AVMEDIA_DLLPUBLIC MediaTempFile
 152 {
 153     OUString const m_TempFileURL;
 154     MediaTempFile(OUString const& rURL)
 155         : m_TempFileURL(rURL)
 156     {}
 157     ~MediaTempFile();
 158 };
 159
 160 }
 161
 162 #endif
 163
 164 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */