gstreamer/gst/camerabin/gstcamerabin.h
René Stadler e2438e6cf1 camerabin: rename function and variable names, update documentation
Get rid of user_* prefix internally, use app_* instead.
2010-04-13 12:00:31 -03:00

200 lines
5.5 KiB
C

/*
* GStreamer
* Copyright (C) 2008 Nokia Corporation <multimedia@maemo.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library 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 Library 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 __GST_CAMERABIN_H__
#define __GST_CAMERABIN_H__
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <gst/gstbin.h>
#include <gst/interfaces/photography.h>
#include "gstcamerabin-enum.h"
#include "camerabinimage.h"
#include "camerabinvideo.h"
G_BEGIN_DECLS
/* #defines don't like whitespacey bits */
#define GST_TYPE_CAMERABIN \
(gst_camerabin_get_type())
#define GST_CAMERABIN(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CAMERABIN,GstCameraBin))
#define GST_CAMERABIN_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CAMERABIN,GstCameraBinClass))
#define GST_IS_CAMERABIN(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CAMERABIN))
#define GST_IS_CAMERABIN_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CAMERABIN))
typedef struct _GstCameraBin GstCameraBin;
typedef struct _GstCameraBinClass GstCameraBinClass;
/**
* GstCameraBin:
*
* The opaque #GstCameraBin structure.
*/
struct _GstCameraBin
{
GstPipeline parent;
/* private */
GString *filename;
gint mode; /* MODE_IMAGE or MODE_VIDEO */
GstCameraBinFlags flags;
gboolean stop_requested; /* TRUE if capturing stop needed */
gboolean paused; /* TRUE if capturing paused */
/* Resolution of the buffers configured to camerabin */
gint width;
gint height;
/* Frames per second configured to camerabin */
gint fps_n;
gint fps_d;
/* Image capture resolution */
gint image_capture_width;
gint image_capture_height;
/* Image tags are collected here first before sending to imgbin */
GstTagList *event_tags;
/* Caps applied to capsfilters when taking still image */
GstCaps *image_capture_caps;
/* Caps applied to capsfilters when in view finder mode */
GstCaps *view_finder_caps;
/* Caps that videosrc supports */
GstCaps *allowed_caps;
/* Caps used to create preview image */
GstCaps *preview_caps;
/* Caps used to create video preview image */
GstCaps *video_preview_caps;
/* The digital zoom (from 100% to 1000%) */
gint zoom;
/* concurrency control */
GMutex *capture_mutex;
GCond *cond;
gboolean capturing;
gboolean eos_handled;
/* pad names for output and input selectors */
GstPad *pad_src_view;
GstPad *pad_view_src;
GstPad *pad_src_img;
GstPad *pad_src_vid;
GstPad *pad_view_vid;
GstPad *pad_src_queue;
GstElement *img_queue; /* queue for decoupling capture from
image-postprocessing and saving */
GstElement *imgbin; /* bin that holds image capturing elements */
GstElement *vidbin; /* bin that holds video capturing elements */
GstElement *active_bin; /* image or video bin that is currently in use */
GstElement *preview_pipeline; /* pipeline for creating preview images */
GstElement *video_preview_pipeline; /* pipeline for creating video preview image */
GstBuffer *video_preview_buffer; /* buffer for storing video preview */
/* source elements */
GstElement *src_vid_src;
GstElement *src_filter;
GstElement *src_zoom_crop;
GstElement *src_zoom_scale;
GstElement *src_zoom_filter;
GstElement *src_out_sel;
/* view finder elements */
GstElement *view_in_sel;
GstElement *aspect_filter;
GstElement *view_scale;
GstElement *view_sink;
/* Application configurable elements */
GstElement *app_vid_src;
GstElement *app_vf_sink;
GstElement *app_video_filter;
/* Night mode handling */
gboolean night_mode;
gint pre_night_fps_n;
gint pre_night_fps_d;
/* Cache the photography interface settings */
GstPhotoSettings photo_settings;
/* Buffer probe id for captured image handling */
gulong image_captured_id;
/* Optional base crop for frames. Used to crop frames e.g.
due to wrong aspect ratio, before the crop related to zooming. */
gint base_crop_top;
gint base_crop_bottom;
gint base_crop_left;
gint base_crop_right;
};
/**
* GstCameraBinClass:
*
* The #GstCameraBin class structure.
*/
struct _GstCameraBinClass
{
GstPipelineClass parent_class;
/* action signals */
void (*capture_start) (GstCameraBin * camera);
void (*capture_stop) (GstCameraBin * camera);
void (*capture_pause) (GstCameraBin * camera);
void (*set_video_resolution_fps) (GstCameraBin * camera, gint width,
gint height, gint fps_n, gint fps_d);
void (*set_image_resolution) (GstCameraBin * camera, gint width, gint height);
/* signals (callback) */
gboolean (*img_done) (GstCameraBin * camera, const gchar * filename);
};
/**
* GstCameraBinMode:
* @MODE_IMAGE: image capture
* @MODE_VIDEO: video capture
*
* Capture mode to use.
*/
typedef enum
{
MODE_IMAGE = 0,
MODE_VIDEO
} GstCameraBinMode;
GType gst_camerabin_get_type (void);
G_END_DECLS
#endif /* #ifndef __GST_CAMERABIN_H__ */