Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vidl2_dshow_istream_params_esf Class Reference

#include <vidl2_dshow_istream_params_esf.h>

List of all members.

Detailed Description

Param struct for DirectShow input streams using Euresys Source Filter.

Enables the configuration of DirectShow Euresys source filters (IESFilter) through the IESFProperties and IESFCompression interfaces.

Example Usage: 

   vidl2_dshow_istream = vidl2_dshow_istream(vidl2_dshow_istream_params()
                                             .set_xxx(xxx));

Definition at line 36 of file vidl2_dshow_istream_params_esf.h.

Public Member Functions

 vidl2_dshow_istream_params_esf ()
 Constructor - default.
void configure_filter (const CComPtr< IBaseFilter > &source)
 Configure the source filter based on the parameters.
vidl2_dshow_istream_params_esf & set_properties (const vcl_map< vcl_string, vcl_string > &props)
 Set properties from a map(string,value).
bool register_in_rot ()
bool run_when_ready ()
vcl_string save_graph_to ()
vcl_string device_name ()
vcl_string output_filename ()
GUID target_output_format ()
vidl2_dshow_istream_params_esf & set_register_in_rot (bool)
vidl2_dshow_istream_params_esf & set_run_when_ready (bool)
vidl2_dshow_istream_params_esf & set_save_graph_to (const vcl_string &)
vidl2_dshow_istream_params_esf & set_device_name (const vcl_string &)
vidl2_dshow_istream_params_esf & set_output_filename (const vcl_string &)
vidl2_dshow_istream_params_esf & set_target_output_format (GUID)
vidl2_dshow_istream_params_esf & set_video_standard (ESF_VIDEO_STANDARD, bool)
vidl2_dshow_istream_params_esf & set_resolution (ESF_RESOLUTION, long, long)
vidl2_dshow_istream_params_esf & set_capture_region_size (long, long)
vidl2_dshow_istream_params_esf & set_capture_region_pos (long, long)
vidl2_dshow_istream_params_esf & set_output_format (GUID)
vidl2_dshow_istream_params_esf & set_capture_rate (double)
vidl2_dshow_istream_params_esf & set_brightness (long)
vidl2_dshow_istream_params_esf & set_contrast (long)
vidl2_dshow_istream_params_esf & set_saturation (long)
vidl2_dshow_istream_params_esf & set_bitrate_control (ESF_BITRATECONTROL)
vidl2_dshow_istream_params_esf & set_average_bitrate (long)
vidl2_dshow_istream_params_esf & set_video_quality (long)
vidl2_dshow_istream_params_esf & set_gop_structure (ESF_GOPSTRUCTURE)
vidl2_dshow_istream_params_esf & set_gop_size (long)

Static Public Member Functions

static void print_parameter_help (const vcl_string &name)
 Print a list of parameters and proper value ranges.
static void print_parameter_help (const CComPtr< IBaseFilter > &filter)
 Print a list of parameters and proper value ranges.

Private Types

enum  esf_property {
  esf_property_video_standard = 0, esf_property_resolution, esf_property_capture_region_size, esf_property_capture_region_pos,
  esf_property_output_format, esf_property_capture_rate, esf_property_brightness, esf_property_contrast,
  esf_property_saturation, esf_property_bitrate_control, esf_property_average_bitrate, esf_property_video_quality,
  esf_property_gop_structure, esf_property_gop_size, esf_property_enum_size
}

Private Attributes

vcl_bitset< esf_property_enum_size > is_property_changed_
 Flag param to be used in configure_filter.
bool register_in_rot_
 Enable remote graph viewing with GraphEdit.
bool run_when_ready_
 Immediately run graph after creating it, else wait for run command.
vcl_string save_graph_to_
 Write the filter graph to filename 'save_graph_to_'.
vcl_string device_name_
 Device name.
vcl_string output_filename_
 If non-empty create file writing section in the filter_graph.
GUID target_output_format_
 Target output format, as returned by current_frame.
ESF_VIDEO_STANDARD video_standard_
bool is_monochrome_
ESF_RESOLUTION resolution_
long width_
long height_
long capture_region_size_x_
long capture_region_size_y_
long capture_region_pos_x_
long capture_region_pos_y_
GUID output_format_
double capture_rate_
long brightness_
long contrast_
long saturation_
ESF_BITRATECONTROL bitrate_control_
long average_bitrate_
long video_quality_
ESF_GOPSTRUCTURE gop_structure_
long gop_size_

Member Enumeration Documentation

enum vidl2_dshow_istream_params_esf::esf_property [private]
 

Enumerator:
esf_property_video_standard 
esf_property_resolution 
esf_property_capture_region_size 
esf_property_capture_region_pos 
esf_property_output_format 
esf_property_capture_rate 
esf_property_brightness 
esf_property_contrast 
esf_property_saturation 
esf_property_bitrate_control 
esf_property_average_bitrate 
esf_property_video_quality 
esf_property_gop_structure 
esf_property_gop_size 
esf_property_enum_size 

Definition at line 90 of file vidl2_dshow_istream_params_esf.h.

Constructor & Destructor Documentation

vidl2_dshow_istream_params_esf::vidl2_dshow_istream_params_esf (   ) 
 

Constructor - default.

Definition at line 557 of file vidl2_dshow_istream_params_esf.cxx.

Member Function Documentation

void vidl2_dshow_istream_params_esf::configure_filter (  const CComPtr< IBaseFilter > &  source  ) 
 

Configure the source filter based on the parameters.

Definition at line 565 of file vidl2_dshow_istream_params_esf.cxx.

vcl_string vidl2_dshow_istream_params_esf::device_name (   )  [inline]
 

Definition at line 60 of file vidl2_dshow_istream_params_esf.h.

vcl_string vidl2_dshow_istream_params_esf::output_filename (   )  [inline]
 

Definition at line 61 of file vidl2_dshow_istream_params_esf.h.

void vidl2_dshow_istream_params_esf::print_parameter_help (  const CComPtr< IBaseFilter > &  filter  )  [static]
 

Print a list of parameters and proper value ranges.

Definition at line 672 of file vidl2_dshow_istream_params_esf.cxx.

void vidl2_dshow_istream_params_esf::print_parameter_help (  const vcl_string &  name  )  [static]
 

Print a list of parameters and proper value ranges.

Definition at line 658 of file vidl2_dshow_istream_params_esf.cxx.

bool vidl2_dshow_istream_params_esf::register_in_rot (   )  [inline]
 

Definition at line 57 of file vidl2_dshow_istream_params_esf.h.

bool vidl2_dshow_istream_params_esf::run_when_ready (   )  [inline]
 

Definition at line 58 of file vidl2_dshow_istream_params_esf.h.

vcl_string vidl2_dshow_istream_params_esf::save_graph_to (   )  [inline]
 

Definition at line 59 of file vidl2_dshow_istream_params_esf.h.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_average_bitrate (  long   ) 
 

Definition at line 985 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_bitrate_control (  ESF_BITRATECONTROL   ) 
 

Definition at line 977 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_brightness (  long   ) 
 

Definition at line 954 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_capture_rate (  double   ) 
 

Definition at line 946 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_capture_region_pos (  long  ,
long 
) 
 

Definition at line 929 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_capture_region_size (  long  ,
long 
) 
 

Definition at line 920 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_contrast (  long   ) 
 

Definition at line 961 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_device_name (  const vcl_string &   ) 
 

Definition at line 878 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_gop_size (  long   ) 
 

Definition at line 1009 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_gop_structure (  ESF_GOPSTRUCTURE   ) 
 

Definition at line 1001 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_output_filename (  const vcl_string &   ) 
 

Definition at line 885 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_output_format (  GUID   ) 
 

Definition at line 938 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_properties (  const vcl_map< vcl_string, vcl_string > &  props  ) 
 

Set properties from a map(string,value).

See also:
mul/mbl/mbl_read_props.h

Definition at line 746 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_register_in_rot (  bool   ) 
 

Definition at line 857 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_resolution (  ESF_RESOLUTION  ,
long  ,
long 
) 
 

Definition at line 909 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_run_when_ready (  bool   ) 
 

Definition at line 864 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_saturation (  long   ) 
 

Definition at line 969 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_save_graph_to (  const vcl_string &   ) 
 

Definition at line 871 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_target_output_format (  GUID   ) 
 

Definition at line 892 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_video_quality (  long   ) 
 

Definition at line 993 of file vidl2_dshow_istream_params_esf.cxx.

vidl2_dshow_istream_params_esf & vidl2_dshow_istream_params_esf::set_video_standard (  ESF_VIDEO_STANDARD  ,
bool 
) 
 

Definition at line 899 of file vidl2_dshow_istream_params_esf.cxx.

GUID vidl2_dshow_istream_params_esf::target_output_format (   )  [inline]
 

Definition at line 62 of file vidl2_dshow_istream_params_esf.h.

Member Data Documentation

long vidl2_dshow_istream_params_esf::average_bitrate_ [private]
 

Definition at line 148 of file vidl2_dshow_istream_params_esf.h.

ESF_BITRATECONTROL vidl2_dshow_istream_params_esf::bitrate_control_ [private]
 

Definition at line 147 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::brightness_ [private]
 

Definition at line 142 of file vidl2_dshow_istream_params_esf.h.

double vidl2_dshow_istream_params_esf::capture_rate_ [private]
 

Definition at line 141 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::capture_region_pos_x_ [private]
 

Definition at line 138 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::capture_region_pos_y_ [private]
 

Definition at line 139 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::capture_region_size_x_ [private]
 

Definition at line 136 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::capture_region_size_y_ [private]
 

Definition at line 137 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::contrast_ [private]
 

Definition at line 143 of file vidl2_dshow_istream_params_esf.h.

vcl_string vidl2_dshow_istream_params_esf::device_name_ [private]
 

Device name.

Definition at line 122 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::gop_size_ [private]
 

Definition at line 151 of file vidl2_dshow_istream_params_esf.h.

ESF_GOPSTRUCTURE vidl2_dshow_istream_params_esf::gop_structure_ [private]
 

Definition at line 150 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::height_ [private]
 

Definition at line 135 of file vidl2_dshow_istream_params_esf.h.

bool vidl2_dshow_istream_params_esf::is_monochrome_ [private]
 

Definition at line 132 of file vidl2_dshow_istream_params_esf.h.

vcl_bitset<esf_property_enum_size> vidl2_dshow_istream_params_esf::is_property_changed_ [private]
 

Flag param to be used in configure_filter.

Definition at line 110 of file vidl2_dshow_istream_params_esf.h.

vcl_string vidl2_dshow_istream_params_esf::output_filename_ [private]
 

If non-empty create file writing section in the filter_graph.

Definition at line 125 of file vidl2_dshow_istream_params_esf.h.

GUID vidl2_dshow_istream_params_esf::output_format_ [private]
 

Definition at line 140 of file vidl2_dshow_istream_params_esf.h.

bool vidl2_dshow_istream_params_esf::register_in_rot_ [private]
 

Enable remote graph viewing with GraphEdit.

Definition at line 113 of file vidl2_dshow_istream_params_esf.h.

ESF_RESOLUTION vidl2_dshow_istream_params_esf::resolution_ [private]
 

Definition at line 133 of file vidl2_dshow_istream_params_esf.h.

bool vidl2_dshow_istream_params_esf::run_when_ready_ [private]
 

Immediately run graph after creating it, else wait for run command.

Definition at line 116 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::saturation_ [private]
 

Definition at line 144 of file vidl2_dshow_istream_params_esf.h.

vcl_string vidl2_dshow_istream_params_esf::save_graph_to_ [private]
 

Write the filter graph to filename 'save_graph_to_'.

Definition at line 119 of file vidl2_dshow_istream_params_esf.h.

GUID vidl2_dshow_istream_params_esf::target_output_format_ [private]
 

Target output format, as returned by current_frame.

Definition at line 128 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::video_quality_ [private]
 

Definition at line 149 of file vidl2_dshow_istream_params_esf.h.

ESF_VIDEO_STANDARD vidl2_dshow_istream_params_esf::video_standard_ [private]
 

Definition at line 131 of file vidl2_dshow_istream_params_esf.h.

long vidl2_dshow_istream_params_esf::width_ [private]
 

Definition at line 134 of file vidl2_dshow_istream_params_esf.h.

The documentation for this class was generated from the following files:
Generated on Thu Jan 10 14:51:32 2008 for contrib/brl/bbas/vidl2 by  doxygen 1.4.4