gst/audiovisualizers/gstbaseaudiovisualizer.h

   1 /* GStreamer
   2  * Copyright (C) <2011> Stefan Kost <ensonic@users.sf.net>
   3  *
   4  * gstbaseaudiovisualizer.c: base class for audio visualisation elements
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GST_BASE_AUDIO_VISUALIZER_H__
  22 #define __GST_BASE_AUDIO_VISUALIZER_H__
  23
  24 #include <gst/gst.h>
  25 #include <gst/base/gstbasetransform.h>
  26
  27 #include <gst/video/video.h>
  28 #include <gst/audio/audio.h>
  29 #include <gst/base/gstadapter.h>
  30
  31 G_BEGIN_DECLS
  32 #define GST_TYPE_BASE_AUDIO_VISUALIZER            (gst_base_audio_visualizer_get_type())
  33 #define GST_BASE_AUDIO_VISUALIZER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_AUDIO_VISUALIZER,GstBaseAudioVisualizer))
  34 #define GST_BASE_AUDIO_VISUALIZER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_AUDIO_VISUALIZER,GstBaseAudioVisualizerClass))
  35 #define GST_IS_SYNAESTHESIA(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_AUDIO_VISUALIZER))
  36 #define GST_IS_SYNAESTHESIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_AUDIO_VISUALIZER))
  37 typedef struct _GstBaseAudioVisualizer GstBaseAudioVisualizer;
  38 typedef struct _GstBaseAudioVisualizerClass GstBaseAudioVisualizerClass;
  39
  40 typedef void (*GstBaseAudioVisualizerShaderFunc)(GstBaseAudioVisualizer *scope, const guint8 *s, guint8 *d);
  41
  42 /**
  43  * GstBaseAudioVisualizerShader:
  44  * @GST_BASE_AUDIO_VISUALIZER_SHADER_NONE: no shading
  45  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE: plain fading
  46  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_UP: fade and move up
  47  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_DOWN: fade and move down
  48  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_LEFT: fade and move left
  49  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_RIGHT: fade and move right
  50  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_OUT: fade and move horizontally out
  51  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_IN: fade and move horizontally in
  52  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_OUT: fade and move vertically out
  53  * @GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_IN: fade and move vertically in
  54  *
  55  * Different types of supported background shading functions.
  56  */
  57 typedef enum {
  58   GST_BASE_AUDIO_VISUALIZER_SHADER_NONE,
  59   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE,
  60   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_UP,
  61   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_DOWN,
  62   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_LEFT,
  63   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_RIGHT,
  64   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_OUT,
  65   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_HORIZ_IN,
  66   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_OUT,
  67   GST_BASE_AUDIO_VISUALIZER_SHADER_FADE_AND_MOVE_VERT_IN
  68 } GstBaseAudioVisualizerShader;
  69
  70 struct _GstBaseAudioVisualizer
  71 {
  72   GstElement parent;
  73
  74   /* pads */
  75   GstPad *srcpad, *sinkpad;
  76
  77   GstAdapter *adapter;
  78   GstBuffer *inbuf;
  79   guint8 *pixelbuf;
  80
  81   GstBaseAudioVisualizerShader shader_type;
  82   GstBaseAudioVisualizerShaderFunc shader;
  83   guint32 shade_amount;
  84
  85   guint64 next_ts;              /* the timestamp of the next frame */
  86   guint64 frame_duration;
  87   guint bpf;                    /* bytes per frame */
  88   guint bps;                    /* bytes per sample */
  89   guint spf;                    /* samples per video frame */
  90   guint req_spf;                /* min samples per frame wanted by the subclass */
  91
  92   /* video state */
  93   GstVideoFormat video_format;
  94   gint fps_n, fps_d;
  95   gint width;
  96   gint height;
  97   gint channels;
  98
  99   /* audio state */
 100   gint sample_rate;
 101   gint rate;
 102
 103   /* configuration mutex */
 104   GMutex *config_lock;
 105 };
 106
 107 struct _GstBaseAudioVisualizerClass
 108 {
 109   GstElementClass parent_class;
 110
 111   /* virtual function, called whenever the format changes */
 112   gboolean (*setup) (GstBaseAudioVisualizer * scope);
 113
 114   /* virtual function for rendering a frame */
 115   gboolean (*render) (GstBaseAudioVisualizer * scope, GstBuffer * audio, GstBuffer * video);
 116 };
 117
 118 GType gst_base_audio_visualizer_get_type (void);
 119
 120 G_END_DECLS
 121 #endif /* __GST_BASE_AUDIO_VISUALIZER_H__ */