libs/canvas/canvas/image.h

   1 /*
   2     Copyright (C) 2013 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef __CANVAS_IMAGE__
  20 #define __CANVAS_IMAGE__
  21
  22 #include <stdint.h>
  23 #include <boost/shared_ptr.hpp>
  24 #include <boost/shared_array.hpp>
  25
  26 #include "canvas/item.h"
  27
  28 namespace ArdourCanvas {
  29
  30 class Image : public Item
  31 {
  32 public:
  33     Image (Group *, Cairo::Format, int width, int height);
  34
  35     struct Data {
  36         Data (boost::shared_array<uint8_t> d, int w, int h, int s, Cairo::Format fmt)
  37                 : data (d)
  38                 , width (w)
  39                 , height (h)
  40                 , stride (s)
  41                 , format (fmt)
  42         {}
  43
  44         boost::shared_array<uint8_t> data;
  45         int width;
  46         int height;
  47         int stride;
  48         Cairo::Format format;
  49     };
  50
  51     /**
  52      * Returns a shared_ptr to a Data object that can be used to
  53      * write image data to. The Data object will contain a pointer
  54      * to the buffer, along with image properties that may be
  55      * useful during the data writing.
  56      *
  57      * Can be called from any thread BUT ..
  58      *
  59      * ... to avoid collisions with Image deletion, some synchronization method
  60      * may be required or the use of shared_ptr<Image> or similar.
  61      */
  62     boost::shared_ptr<Data> get_image ();
  63
  64     /**
  65      * Queues a Data object to be used to redraw this Image item
  66      * at the earliest possible opportunity.
  67      *
  68      * May be called from any thread BUT ...
  69      *
  70      * ... to avoid collisions with Image deletion, some synchronization method
  71      * may be required or the use of shared_ptr<Image> or similar.
  72      */
  73     void put_image (boost::shared_ptr<Data>);
  74
  75     void render (Rect const &, Cairo::RefPtr<Cairo::Context>) const;
  76     void compute_bounding_box () const;
  77
  78 private:
  79     Cairo::Format            _format;
  80     int                      _width;
  81     int                      _height;
  82     int                      _data;
  83     mutable boost::shared_ptr<Data>  _current;
  84     boost::shared_ptr<Data>  _pending;
  85     mutable bool             _need_render;
  86     mutable Cairo::RefPtr<Cairo::Surface> _surface;
  87
  88     void accept_data ();
  89     PBD::Signal0<void> DataReady;
  90     PBD::ScopedConnectionList data_connections;
  91 };
  92
  93 }
  94 #endif