gfx/thebes/gfxSharedImageSurface.h

   1 // vim:set ts=4 sts=4 sw=4 et cin:
   2 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Nokia Corporation code.
  17  *
  18  * The Initial Developer of the Original Code is Nokia Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Oleg Romashin <romaxa@gmail.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef GFX_SHARED_IMAGESURFACE_H
  40 #define GFX_SHARED_IMAGESURFACE_H
  41
  42 #include "mozilla/ipc/Shmem.h"
  43 #include "mozilla/ipc/SharedMemory.h"
  44
  45 #include "gfxASurface.h"
  46 #include "gfxImageSurface.h"
  47
  48 class THEBES_API gfxSharedImageSurface : public gfxImageSurface {
  49     typedef mozilla::ipc::SharedMemory SharedMemory;
  50     typedef mozilla::ipc::Shmem Shmem;
  51
  52 public:
  53     /**
  54      * Init must be called after ctor
  55      */
  56     gfxSharedImageSurface();
  57
  58     /**
  59      * Create shared image from external Shmem
  60      * Shmem must be initialized by this class
  61      */
  62     gfxSharedImageSurface(const Shmem &aShmem);
  63
  64     ~gfxSharedImageSurface();
  65
  66     /**
  67      * Initialize shared image surface
  68      * @param aAllocator The pointer to protocol class which has AllocShmem method
  69      * @param aSize The size of the buffer
  70      * @param aFormat Format of the data
  71      * @see gfxImageFormat
  72      */
  73     template<class ShmemAllocator>
  74     bool Init(ShmemAllocator *aAllocator,
  75               const gfxIntSize& aSize,
  76               gfxImageFormat aFormat,
  77               SharedMemory::SharedMemoryType aShmType = SharedMemory::TYPE_BASIC)
  78     {
  79         mSize = aSize;
  80         mFormat = aFormat;
  81         mStride = ComputeStride();
  82         if (!aAllocator->AllocShmem(GetAlignedSize(),
  83                                     aShmType, &mShmem))
  84             return false;
  85
  86         return InitSurface(PR_TRUE);
  87     }
  88
  89     /* Gives Shmem data, which can be passed to IPDL interfaces */
  90     Shmem& GetShmem() { return mShmem; }
  91
  92     // This can be used for recognizing normal gfxImageSurface as SharedImage
  93     static PRBool IsSharedImage(gfxASurface *aSurface);
  94
  95 private:
  96     size_t GetAlignedSize();
  97     bool InitSurface(PRBool aUpdateShmemInfo);
  98
  99     Shmem mShmem;
 100 };
 101
 102 #endif /* GFX_SHARED_IMAGESURFACE_H */