video_capture.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2005-2024 CESNET
 * Copyright (c) 2002 University of Southern California
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. 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.
 * 
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 * 
 *      This product includes software developed by the University of Southern
 *      California Information Sciences Institute. This product also includes
 *      software developed by CESNET z.s.p.o.
 * 
 * 4. Neither the name of the University, Institute, 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.
 */
 
#ifndef _VIDEO_CAPTURE_H_
#define _VIDEO_CAPTURE_H_
 
#ifdef __cplusplus
#include <cstddef>
#else
#include <stdbool.h>
#include <stddef.h>
#endif
 
#include "types.h"
#include "video_capture_params.h"
 
#define VIDEO_CAPTURE_ABI_VERSION 13
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
struct audio_frame;
 
#define VIDCAP_INIT_OK                   0  
#define VIDCAP_INIT_NOERR                1  
#define VIDCAP_INIT_FAIL               (-1) 
#define VIDCAP_INIT_AUDIO_NOT_SUPPORTED (-2) 
 
#define VIDCAP_NO_GENERIC_FPS_INDICATOR NULL
 
struct video_capture_info {
        device_probe_func probe;
        int                    (*init) (struct vidcap_params *param, void **state);
        void                   (*done) (void *state);
        struct video_frame    *(*grab) (void *state, struct audio_frame **audio);
        const char             *generic_fps_indicator_prefix; 
};
 
struct module;
struct vidcap;
 
void                     list_video_capture_devices(bool);
int initialize_video_capture(struct module *parent,
                struct vidcap_params *params,
                struct vidcap **state);
void                     vidcap_done(struct vidcap *state);
struct video_frame      *vidcap_grab(struct vidcap *state, struct audio_frame **audio);
const char              *vidcap_get_fps_print_prefix(struct vidcap *state);
 
#ifdef __cplusplus
}
#endif // __cplusplus
 
#endif // _VIDEO_CAPTURE_H_