1 /* libgnomecanvas/gnome-canvas-waveview.h: GnomeCanvas item for displaying wave data
3 * Copyright (C) 2001 Paul Davis <pbd@op.net>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #ifndef __GNOME_CANVAS_WAVEVIEW_H__
23 #define __GNOME_CANVAS_WAVEVIEW_H__
27 #include <libgnomecanvas/libgnomecanvas.h>
31 /* Wave viewer item for canvas.
34 #define GNOME_TYPE_CANVAS_WAVEVIEW (gnome_canvas_waveview_get_type ())
35 #define GNOME_CANVAS_WAVEVIEW(obj) (GTK_CHECK_CAST ((obj), GNOME_TYPE_CANVAS_WAVEVIEW, GnomeCanvasWaveView))
36 #define GNOME_CANVAS_WAVEVIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GNOME_TYPE_CANVAS_WAVEVIEW, GnomeCanvasWaveViewClass))
37 #define GNOME_IS_CANVAS_WAVEVIEW(obj) (GTK_CHECK_TYPE ((obj), GNOME_TYPE_CANVAS_WAVEVIEW))
38 #define GNOME_IS_CANVAS_WAVEVIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GNOME_TYPE_CANVAS_WAVEVIEW))
39 #define GNOME_CANVAS_WAVEVIEW_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GNOME_TYPE_CANVAS_WAVEVIEW, GnomeCanvasWaveViewClass))
41 typedef struct _GnomeCanvasWaveView GnomeCanvasWaveView;
42 typedef struct _GnomeCanvasWaveViewClass GnomeCanvasWaveViewClass;
43 typedef struct _GnomeCanvasWaveViewChannelInfo GnomeCanvasWaveViewChannelInfo;
44 typedef struct _GnomeCanvasWaveViewCacheEntry GnomeCanvasWaveViewCacheEntry;
45 typedef struct _GnomeCanvasWaveViewCache GnomeCanvasWaveViewCache;
47 /* XXX this needs to be synced with ardour/source.h PeakData */
49 struct _GnomeCanvasWaveViewCacheEntry
55 struct _GnomeCanvasWaveViewCache
57 GnomeCanvasWaveViewCacheEntry* data;
64 GnomeCanvasWaveViewCache* gnome_canvas_waveview_cache_new ();
65 void gnome_canvas_waveview_cache_destroy (GnomeCanvasWaveViewCache*);
67 void gnome_canvas_waveview_set_gradient_waveforms (int);
69 typedef gulong (*waveview_length_function_t)(void*);
70 typedef gulong (*waveview_sourcefile_length_function_t)(void*, double);
71 typedef void (*waveview_gain_curve_function_t)(void *arg, double start, double end, float* vector, gint64 veclen);
72 typedef void (*waveview_peak_function_t)(void*,gulong,gulong,gulong,gpointer,guint32,double);
74 struct _GnomeCanvasWaveView
78 GnomeCanvasWaveViewCache *cache;
79 gboolean cache_updater;
84 waveview_peak_function_t peak_function;
85 waveview_length_function_t length_function;
86 waveview_sourcefile_length_function_t sourcefile_length_function;
87 waveview_gain_curve_function_t gain_curve_function;
90 /** x-axis: samples per canvas unit. */
91 double samples_per_unit;
93 /** y-axis: amplitude_above_axis.
95 * the default is that an (scaled, normalized -1.0 ... +1.0) amplitude of 1.0
96 * corresponds to the top of the area assigned to the waveview.
98 * larger values will expand the vertical scale, cutting off the peaks/troughs.
99 * smaller values will decrease the vertical scale, moving peaks/troughs toward
100 * the middle of the area assigned to the waveview.
102 double amplitude_above_axis;
118 /* These are updated by the update() routine
119 to optimize the render() routine, which may
120 be called several times after a single update().
127 unsigned char wave_r, wave_g, wave_b, wave_a;
128 unsigned char clip_r, clip_g, clip_b, clip_a;
129 unsigned char fill_r, fill_g, fill_b, fill_a;
131 uint32_t region_start;
132 int32_t reload_cache_in_render;
135 struct _GnomeCanvasWaveViewClass {
136 GnomeCanvasItemClass parent_class;
139 GType gnome_canvas_waveview_get_type (void) G_GNUC_CONST;
143 #endif /* __GNOME_CANVAS_WAVEVIEW_H__ */