uimage.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2011, Gostai S.A.S.
 *
 * This software is provided "as is" without warranty of any kind,
 * either expressed or implied, including but not limited to the
 * implied warranties of fitness for a particular purpose.
 *
 * See the LICENSE file for more information.
 */

#ifndef URBI_UIMAGE_HH
# define URBI_UIMAGE_HH

# include <libport/cstdlib>
# include <urbi/export.hh>

namespace urbi
{

  /*---------------.
  | UImageFormat.  |
  `---------------*/

  enum UImageFormat
  {
    IMAGE_UNKNOWN = 0,
    IMAGE_RGB = 1,     
    IMAGE_YCbCr = 2,   
    IMAGE_YUV = 2,     
    IMAGE_JPEG = 3,    
    IMAGE_PPM = 4,     
    IMAGE_YUV422 = 5,  
    IMAGE_GREY8 = 6,   
    IMAGE_GREY4 = 7,   
    IMAGE_YUV411_PLANAR=8, 
    IMAGE_NV12=9,      
    IMAGE_YUV420_PLANAR=10, 
  };


  // Parse an image format string.
  URBI_SDK_API UImageFormat parse_image_format(const std::string&);

  // Conversion to string.
  URBI_SDK_API const char* format_string(UImageFormat f);



  /*---------.
  | UImage.  |
  `---------*/

  class URBI_SDK_API UImage
  {
  public:
    static UImage make();

    void init();

    const char* format_string() const;

    unsigned char* data;
    size_t size;
    size_t width, height;

    UImageFormat imageFormat;

  private:
    friend class UBinary;
    // The UBinary headers.
    std::string headers_() const;
  };

} // end namespace urbi

#endif // ! URBI_UIMAGE_HH