video_display.h

Go to the documentation of this file.

 
/* Copyright (c) 2001-2003 University of Southern California
 * Copyright (c) 2005-2023 CESNET z.s.p.o.
 *
 * 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_DISPLAY_H
#define _VIDEO_DISPLAY_H
 
#include "types.h"
 
#ifndef __cplusplus
#include <limits.h> // LLONG_MAX
#include <stdbool.h>
#else
#include <climits>  // LLONG_MAX
#endif // ! defined __cplusplus
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
#define DISPLAY_FLAG_AUDIO_EMBEDDED (1<<1)
#define DISPLAY_FLAG_AUDIO_AESEBU (1<<2)
#define DISPLAY_FLAG_AUDIO_ANALOG (1<<3)
 
#define DISPLAY_FLAG_AUDIO_ANY (DISPLAY_FLAG_AUDIO_EMBEDDED | DISPLAY_FLAG_AUDIO_AESEBU | DISPLAY_FLAG_AUDIO_ANALOG)
struct audio_frame;
struct module;
struct video_frame;
 
struct multi_sources_supp_info {
        bool val;
        struct display *(*fork_display)(void *state);
        void *state;
};
 
enum display_property {
        // getters
        DISPLAY_PROPERTY_CODECS = 0, 
        DISPLAY_PROPERTY_RGB_SHIFT = 1, 
        DISPLAY_PROPERTY_BUF_PITCH = 2, 
        DISPLAY_PROPERTY_VIDEO_MODE = 3, 
        DISPLAY_PROPERTY_SUPPORTED_IL_MODES = 4, 
        DISPLAY_PROPERTY_SUPPORTS_MULTI_SOURCES = 5, 
        DISPLAY_PROPERTY_AUDIO_FORMAT = 6, 
};
 
#define PITCH_DEFAULT -1 
 
enum display_prop_vid_mode {
        DISPLAY_PROPERTY_VIDEO_MERGED         = 0, 
        DISPLAY_PROPERTY_VIDEO_SEPARATE_TILES = 1, 
        DISPLAY_PROPERTY_VIDEO_SEPARATE_3D    = 2, 
};
 
#define VIDEO_DISPLAY_ABI_VERSION 21
 
#define DISPLAY_NO_GENERIC_FPS_INDICATOR ((const char *) 0x00)
 
struct video_display_info {
        device_probe_func         probe;
        void                   *(*init) (struct module *parent, const char *fmt, unsigned int flags);
        void                    (*run) (void *state);                                               
        void                    (*done) (void *state);
        struct video_frame     *(*getf) (void *state);
        bool                    (*putf) (void *state, struct video_frame *frame, long long timeout_ns);
        bool                    (*reconfigure_video)(void *state, struct video_desc desc);
        bool                    (*ctl_property)(void *state, int property, void *val, size_t *len);
        void                    (*put_audio_frame) (void *state, const struct audio_frame *frame);  
        bool                    (*reconfigure_audio) (void *state, int quant_samples, int channels, 
                        int sample_rate);
        const char             *generic_fps_indicator_prefix; 
};
 
/* 
 * Interface to initialize displays, and playout video
 *
 */
struct display;
struct module;
 
void                     list_video_display_devices(bool full);
int                      initialize_video_display(struct module *parent,
                /* not_null */ const char *requested_display, /* not_null */ const char *fmt,
                unsigned int flags, const char *postprocess, /* not_null */ struct display **out);
bool                     display_needs_mainloop(struct display *d);
void                     display_run_mainloop(struct display *d);
void                     display_run_new_thread(struct display *d);
void                     display_join(struct display *d);
void                     display_done(struct display *d);
struct video_frame      *display_get_frame(struct display *d);
 
#define PUTF_DISCARD  (-1LL)
#define PUTF_NONBLOCK   0LL
#define PUTF_BLOCKING   LLONG_MAX
 
// documented at definition
bool                     display_put_frame(struct display *d, struct video_frame *frame, long long timeout_ns);
bool                     display_reconfigure(struct display *d, struct video_desc desc, enum video_mode mode);
bool                     display_ctl_property(struct display *d, int property, void *val, size_t *len);
void                     display_put_audio_frame(struct display *d, const struct audio_frame *frame);
bool                     display_reconfigure_audio(struct display *d, int quant_samples, int channels, int sample_rate);
 // end of display_audio
 
struct video_frame *get_splashscreen(void);
const char         *get_audio_conn_flag_name(int audio_init_flag);
 
#ifdef __cplusplus
}
#endif // __cplusplus
 
#endif /* _VIDEO_DISPLAY_H */
 
 // end of display