/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GIMP_RGB_H__
#define __GIMP_RGB_H__

G_BEGIN_DECLS

/* For information look into the C source or the html documentation */


#define GIMP_TYPE_RGB               (gimp_rgb_get_type ())
#define GIMP_VALUE_HOLDS_RGB(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_RGB))

GType   gimp_rgb_get_type           (void) G_GNUC_CONST;


/*
 * GIMP_TYPE_PARAM_RGB
 */

#define GIMP_TYPE_PARAM_RGB               (gimp_param_rgb_get_type ())
#define GIMP_IS_PARAM_SPEC_RGB(pspec)     (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_RGB))

GType        gimp_param_rgb_get_type      (void) G_GNUC_CONST;

GParamSpec * gimp_param_spec_rgb          (const gchar    *name,
                                           const gchar    *nick,
                                           const gchar    *blurb,
                                           const GimpRGB  *default_value,
                                           GParamFlags     flags);


/*  RGB and RGBA color types and operations taken from LibGCK  */

typedef enum
{
  GIMP_RGB_COMPOSITE_NONE = 0,
  GIMP_RGB_COMPOSITE_NORMAL,
  GIMP_RGB_COMPOSITE_BEHIND
} GimpRGBCompositeMode;


void      gimp_rgb_set         (GimpRGB       *rgb,
                                gdouble        red,
                                gdouble        green,
                                gdouble        blue);
void      gimp_rgb_set_alpha   (GimpRGB       *rgb,
                                gdouble        alpha);

void      gimp_rgb_set_uchar   (GimpRGB       *rgb,
                                guchar         red,
                                guchar         green,
                                guchar         blue);
void      gimp_rgb_get_uchar   (const GimpRGB *rgb,
                                guchar        *red,
                                guchar        *green,
                                guchar        *blue);

gboolean  gimp_rgb_parse_name  (GimpRGB       *rgb,
                                const gchar   *name,
                                gint           len);
gboolean  gimp_rgb_parse_hex   (GimpRGB       *rgb,
                                const gchar   *hex,
                                gint           len);
gboolean  gimp_rgb_parse_css   (GimpRGB       *rgb,
                                const gchar   *css,
                                gint           len);

void      gimp_rgb_add         (GimpRGB       *rgb1,
                                const GimpRGB *rgb2);
void      gimp_rgb_subtract    (GimpRGB       *rgb1,
                                const GimpRGB *rgb2);
void      gimp_rgb_multiply    (GimpRGB       *rgb1,
                                gdouble        factor);
gdouble   gimp_rgb_distance    (const GimpRGB *rgb1,
                                const GimpRGB *rgb2);

gdouble   gimp_rgb_max         (const GimpRGB *rgb);
gdouble   gimp_rgb_min         (const GimpRGB *rgb);
void      gimp_rgb_clamp       (GimpRGB       *rgb);

void      gimp_rgb_gamma       (GimpRGB       *rgb,
 			        gdouble        gamma);

gdouble   gimp_rgb_luminance       (const GimpRGB *rgb);
guchar    gimp_rgb_luminance_uchar (const GimpRGB *rgb);

#ifndef GIMP_DISABLE_DEPRECATED
gdouble   gimp_rgb_intensity       (const GimpRGB *rgb);
guchar    gimp_rgb_intensity_uchar (const GimpRGB *rgb);
#endif

void      gimp_rgb_composite   (GimpRGB              *color1,
                                const GimpRGB        *color2,
                                GimpRGBCompositeMode  mode);

/*  access to the list of color names  */
gint      gimp_rgb_list_names  (const gchar ***names,
                                GimpRGB      **colors);


void      gimp_rgba_set        (GimpRGB       *rgba,
                                gdouble        red,
                                gdouble        green,
                                gdouble        blue,
                                gdouble        alpha);

void      gimp_rgba_set_uchar  (GimpRGB       *rgba,
                                guchar         red,
                                guchar         green,
                                guchar         blue,
                                guchar         alpha);
void      gimp_rgba_get_uchar  (const GimpRGB *rgba,
                                guchar        *red,
                                guchar        *green,
                                guchar        *blue,
                                guchar        *alpha);

gboolean  gimp_rgba_parse_css  (GimpRGB       *rgba,
                                const gchar   *css,
                                gint           len);

void      gimp_rgba_add        (GimpRGB       *rgba1,
                                const GimpRGB *rgba2);
void      gimp_rgba_subtract   (GimpRGB       *rgba1,
                                const GimpRGB *rgba2);
void      gimp_rgba_multiply   (GimpRGB       *rgba,
                                gdouble        factor);

gdouble   gimp_rgba_distance   (const GimpRGB *rgba1,
			        const GimpRGB *rgba2);



/*  Map RGB to intensity  */

/*
 * The weights to compute true CIE luminance from linear red, green
 * and blue, as defined by the ITU-R Recommendation BT.709, "Basic
 * Parameter Values for the HDTV Standard for the Studio and for
 * International Programme Exchange" (1990). Also suggested in the
 * sRGB colorspace specification by the W3C.
 */

#define GIMP_RGB_LUMINANCE_RED    (0.2126)
#define GIMP_RGB_LUMINANCE_GREEN  (0.7152)
#define GIMP_RGB_LUMINANCE_BLUE   (0.0722)

#define GIMP_RGB_LUMINANCE(r,g,b) ((r) * GIMP_RGB_LUMINANCE_RED   + \
			           (g) * GIMP_RGB_LUMINANCE_GREEN + \
			           (b) * GIMP_RGB_LUMINANCE_BLUE)


#ifndef GIMP_DISABLE_DEPRECATED

/*
 * The coefficients below properly computed luminance for monitors
 * having phosphors that were contemporary at the introduction of NTSC
 * television in 1953. They are still appropriate for computing video
 * luma. However, these coefficients do not accurately compute
 * luminance for contemporary monitors. The use of these definitions
 * is deprecated.
 */

#define GIMP_RGB_INTENSITY_RED    (0.30)
#define GIMP_RGB_INTENSITY_GREEN  (0.59)
#define GIMP_RGB_INTENSITY_BLUE   (0.11)

#define GIMP_RGB_INTENSITY(r,g,b) ((r) * GIMP_RGB_INTENSITY_RED   + \
			           (g) * GIMP_RGB_INTENSITY_GREEN + \
			           (b) * GIMP_RGB_INTENSITY_BLUE)

#endif


G_END_DECLS

#endif  /* __GIMP_RGB_H__ */
