This graph shows which files directly or indirectly include this file:

Macros
Initialization Flags
Copyright (c) 2013-2023 CESNET, z. s. p. o All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of CESNET nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#define	VIDCAP_FLAG_AUDIO_AESEBU (1u<<2u)
	AES/EBU audio.

#define	VIDCAP_FLAG_AUDIO_ANALOG (1u<<3u)
	(balanced) analog audio

#define	VIDCAP_FLAG_AUDIO_ANY (VIDCAP_FLAG_AUDIO_EMBEDDED \| VIDCAP_FLAG_AUDIO_AESEBU \| VIDCAP_FLAG_AUDIO_ANALOG)

#define	VIDCAP_FLAG_AUDIO_EMBEDDED (1u<<1u)
	HD-SDI embedded audio.

Functions
Vidcap Parameters Handling Functions
void	vidcap_params_add_flags (struct vidcap_params *params, unsigned int flags)

struct vidcap_params *	vidcap_params_allocate (void)

struct vidcap_params *	vidcap_params_allocate_next (struct vidcap_params *params)

struct vidcap_params *	vidcap_params_copy (const struct vidcap_params *params)

void	vidcap_params_free_struct (struct vidcap_params *params)

const char *	vidcap_params_get_capture_filter (const struct vidcap_params *params)

const char *	vidcap_params_get_driver (const struct vidcap_params *params)

unsigned int	vidcap_params_get_flags (const struct vidcap_params *params)

const char *	vidcap_params_get_fmt (const struct vidcap_params *params)

const char *	vidcap_params_get_name (const struct vidcap_params *params)

struct vidcap_params *	vidcap_params_get_next (const struct vidcap_params *params)

struct vidcap_params *	vidcap_params_get_nth (struct vidcap_params *params, int index)

struct module *	vidcap_params_get_parent (const struct vidcap_params *params)

void	vidcap_params_set_capture_filter (struct vidcap_params params, const char req_capture_filter)

void	vidcap_params_set_device (struct vidcap_params params, const char config)

void	vidcap_params_set_driver (struct vidcap_params params, const char driver)

void	vidcap_params_set_flags (struct vidcap_params *params, unsigned int flags)

void	vidcap_params_set_parent (struct vidcap_params params, struct module mod)

Detailed Description

Author: Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

video_capture_params is basically intended as a linked list of video capture parameters. It is used for structured capturers like aggregate or switcher, which work as a master and initialize its slaves. The structure is used to hold individual devices' parameters (namely per-device capture filter).

Definition in file video_capture_params.h.

Macro Definition Documentation

◆ VIDCAP_FLAG_AUDIO_AESEBU

#define VIDCAP_FLAG_AUDIO_AESEBU (1u<<2u)

AES/EBU audio.

Definition at line 56 of file video_capture_params.h.

Referenced by vidcap_state_aja::vidcap_state_aja(), audio_capture_get_vidcap_flags(), decklink_cap_configure_audio(), and setup_audio().

◆ VIDCAP_FLAG_AUDIO_ANALOG

#define VIDCAP_FLAG_AUDIO_ANALOG (1u<<3u)

(balanced) analog audio

Definition at line 57 of file video_capture_params.h.

Referenced by vidcap_state_aja::vidcap_state_aja(), audio_capture_get_vidcap_flags(), and decklink_cap_configure_audio().

◆ VIDCAP_FLAG_AUDIO_ANY

#define VIDCAP_FLAG_AUDIO_ANY (VIDCAP_FLAG_AUDIO_EMBEDDED | VIDCAP_FLAG_AUDIO_AESEBU | VIDCAP_FLAG_AUDIO_ANALOG)

◆ VIDCAP_FLAG_AUDIO_EMBEDDED

#define VIDCAP_FLAG_AUDIO_EMBEDDED (1u<<1u)

HD-SDI embedded audio.

Definition at line 55 of file video_capture_params.h.

Referenced by vidcap_state_aja::vidcap_state_aja(), audio_capture_get_vidcap_flags(), decklink_cap_configure_audio(), initialize_import(), setup_audio(), vidcap_dvs_init(), vidcap_testcard2_init(), and wait_for_channel().

Function Documentation

◆ vidcap_params_add_flags()

void vidcap_params_add_flags	(	struct vidcap_params *	params,
		unsigned int	flags )

Definition at line 208 of file video_capture_params.cpp.

{
        params->flags |= flags;
}

References flags.

Referenced by parse_audio_capture().

◆ vidcap_params_allocate()

struct vidcap_params * vidcap_params_allocate ( void )

@brier Allocates blank vidcap_params structure.

Definition at line 117 of file video_capture_params.cpp.

{
        return (struct vidcap_params *) calloc(1, sizeof(struct vidcap_params));
}

Referenced by test_video_capture(), vidcap_params_allocate_next(), and vidcap_screen_win_init().

◆ vidcap_params_allocate_next()

struct vidcap_params * vidcap_params_allocate_next ( struct vidcap_params * curr )

@brier Allocates blank vidcap_params structure.

Follows curr struct in the virtual list.

Parameters

curr	structure to be appended after

Returns: pointer to newly created structure

Definition at line 129 of file video_capture_params.cpp.

{
        curr->next = vidcap_params_allocate();
        return curr->next;
}

References vidcap_params::next, and vidcap_params_allocate().

Referenced by adjust_params(), and parse_options_internal().

Here is the call graph for this function:

◆ vidcap_params_copy()

struct vidcap_params * vidcap_params_copy ( const struct vidcap_params * params )

Creates deep copy of vidcap_params structure.

Definition at line 255 of file video_capture_params.cpp.

{
        if (!params)
                return NULL;
 
        struct vidcap_params *ret = (struct vidcap_params *) calloc(1, sizeof(struct vidcap_params));
 
        if (params->driver)
                ret->driver = strdup(params->driver);
        if (params->fmt)
                ret->fmt = strdup(params->fmt);
        if (params->requested_capture_filter)
                ret->requested_capture_filter =
                        strdup(params->requested_capture_filter);
        if (params->name)
                ret->name = strdup(params->name);
        if (params->flags)
                ret->flags = params->flags;
 
        ret->next = NULL; // there is high probability that the pointer will be invalid
 
        return ret;
}

References vidcap_params::driver, vidcap_params::flags, vidcap_params::fmt, vidcap_params::name, vidcap_params::next, and vidcap_params::requested_capture_filter.

Referenced by parse(), and vidcap_screen_linux_init().

◆ vidcap_params_free_struct()

void vidcap_params_free_struct ( struct vidcap_params * buf )

Frees all members of the given structure as well as its members.

Parameters

[in] buf structure to be feed

Definition at line 284 of file video_capture_params.cpp.

{
        if (!buf)
                return;
 
        free(buf->driver);
        free(buf->fmt);
        free(buf->requested_capture_filter);
        free(buf->name);
 
        free(buf);
}

References vidcap_params::driver, vidcap_params::fmt, vidcap_params::name, and vidcap_params::requested_capture_filter.

Referenced by ug_options::~ug_options(), test_video_capture(), vidcap_screen_linux_init(), vidcap_screen_win_init(), and vidcap_swmix_done().

◆ vidcap_params_get_capture_filter()

const char * vidcap_params_get_capture_filter ( const struct vidcap_params * params )

Definition at line 198 of file video_capture_params.cpp.

{
        return params->requested_capture_filter;
}

Referenced by initialize_video_capture(), and parse_options_internal().

◆ vidcap_params_get_driver()

const char * vidcap_params_get_driver ( const struct vidcap_params * params )

Returns: capture driver name (eg. decklink), not NULL if vidcap_params_set_device() called

Definition at line 216 of file video_capture_params.cpp.

{
        return params->driver;
}

Referenced by adjust_params(), grab_worker(), initialize_video_capture(), main(), parse(), slave_worker(), vidcap_aggregate_init(), vidcap_gpustitch_init(), and vidcap_switcher_init().

◆ vidcap_params_get_flags()

unsigned int vidcap_params_get_flags ( const struct vidcap_params * params )

◆ vidcap_params_get_fmt()

const char * vidcap_params_get_fmt ( const struct vidcap_params * params )

Returns: capture configuration, not NULL if vidcap_params_set_device() called

Definition at line 224 of file video_capture_params.cpp.

{
        return params->fmt;
}

Referenced by grab_worker(), parse_params(), slave_worker(), vidcap_aggregate_init(), vidcap_aja_init(), vidcap_bluefish444_init(), vidcap_decklink_init(), vidcap_deltacast_dvi_init(), vidcap_deltacast_init(), vidcap_dshow_init(), vidcap_dvs_init(), vidcap_file_init(), vidcap_gpustitch_init(), vidcap_import_init(), vidcap_ndi_init(), vidcap_rtsp_init(), vidcap_screen_linux_init(), vidcap_screen_osx_init(), vidcap_screen_win_init(), vidcap_screen_x11_init(), vidcap_spout_init(), vidcap_switcher_init(), vidcap_swmix_init(), vidcap_syphon_init(), vidcap_testcard2_init(), vidcap_testcard_init(), vidcap_ug_input_init(), vidcap_v4l2_init(), and vidcap_ximea_init().

◆ vidcap_params_get_name()

const char * vidcap_params_get_name ( const struct vidcap_params * params )

Returns: <driver>[:<configuration>] as given on command-line

See also: vidcap_params_get_driver, vidcap_params_get_fmt

Definition at line 238 of file video_capture_params.cpp.

{
        return params->name;
}

Referenced by init_slave_data(), and slave_worker().

◆ vidcap_params_get_next()

struct vidcap_params * vidcap_params_get_next ( const struct vidcap_params * curr )

@brier Returns next item in virtual vidcap_params list.

Definition at line 138 of file video_capture_params.cpp.

{
        return curr->next;
}

References vidcap_params::next.

Referenced by ug_options::~ug_options(), initialize_video_capture(), parse(), vidcap_aggregate_init(), vidcap_gpustitch_init(), and vidcap_switcher_init().

◆ vidcap_params_get_nth()

struct vidcap_params * vidcap_params_get_nth	(	struct vidcap_params *	curr,
		int	index )

@brier Returns n-th item in vidcap_params list.

Definition at line 146 of file video_capture_params.cpp.

{
        struct vidcap_params *ret = curr;
        for (int i = 0; i < index; i++) {
                ret = ret->next;
                if (ret == NULL) {
                        return NULL;
                }
        }
        if (ret->driver == NULL) {
                // this is just the stopper of the list...
                return NULL;
        }
        return ret;
}

References vidcap_params::driver, and vidcap_params::next.

Referenced by vidcap_switcher_grab().

◆ vidcap_params_get_parent()

struct module * vidcap_params_get_parent ( const struct vidcap_params * params )

Definition at line 243 of file video_capture_params.cpp.

{
        return params->parent;
}

Referenced by vidcap_aggregate_init(), vidcap_dshow_init(), vidcap_file_init(), vidcap_import_init(), vidcap_screen_win_init(), vidcap_switcher_init(), vidcap_syphon_init(), and vidcap_ug_input_init().

◆ vidcap_params_set_capture_filter()

void vidcap_params_set_capture_filter	(	struct vidcap_params *	params,
		const char *	req_capture_filter )

Definition at line 192 of file video_capture_params.cpp.

{
        params->requested_capture_filter = strdup(req_capture_filter);
}

Referenced by initialize_video_capture(), and parse_options_internal().

◆ vidcap_params_set_device()

void vidcap_params_set_device	(	struct vidcap_params *	params,
		const char *	config )

Fills the structure with device config string in format either driver[:params] or alias.

Definition at line 166 of file video_capture_params.cpp.

{
        free(params->name);
        free(params->driver);
        free(params->fmt);
 
        params->name = strdup(config);
 
        if (!vidcap_dispatch_alias(params)) {
                params->driver = strdup(config);
                if (strchr(params->driver, ':')) {
                        char *delim = strchr(params->driver, ':');
                        *delim = '\0';
                        params->fmt = strdup(delim + 1);
                } else {
                        params->fmt = strdup("");
                }
        }
}

References vidcap_dispatch_alias().

Referenced by ug_options::ug_options(), adjust_params(), parse_options_internal(), test_video_capture(), and vidcap_screen_win_init().

Here is the call graph for this function:

◆ vidcap_params_set_driver()

void vidcap_params_set_driver	(	struct vidcap_params *	params,
		const char *	driver )

Definition at line 186 of file video_capture_params.cpp.

{
        free(params->driver);
        params->driver = strdup(driver);
}

References vidcap_params::driver.

Referenced by vidcap_screen_linux_init().

◆ vidcap_params_set_flags()

void vidcap_params_set_flags	(	struct vidcap_params *	params,
		unsigned int	flags )

Definition at line 203 of file video_capture_params.cpp.

{
        params->flags = flags;
}