video_rxtx Struct Reference

#include <video_rxtx.hpp>

Inheritance diagram for video_rxtx:

Collaboration diagram for video_rxtx:

Public Member Functions
virtual	~video_rxtx ()
virtual void	join ()
void	send (std::shared_ptr< struct video_frame >)
virtual void	set_audio_spec (const struct audio_desc *desc, int audio_rx_port, int audio_tx_port, bool ipv6)
bool	supports_receiving ()

Static Public Member Functions
static video_rxtx *	create (std::string const &name, std::map< std::string, param_u > const &)
static const char *	get_long_name (std::string const &short_name)
static void	list (bool full)
static void *	receiver_thread (void *arg)

Public Attributes
std::string	m_port_id

Protected Member Functions
	video_rxtx (std::map< std::string, param_u > const &)
void	check_sender_messages ()

Protected Attributes
struct common_opts	m_common
unsigned long long int	m_frames_sent
struct module	m_receiver_mod
int	m_rxtx_mode
struct module	m_sender_mod
bool	m_should_exit = false

Private Member Functions
virtual struct response *	process_sender_message (struct msg_sender *)
virtual void	send_frame (std::shared_ptr< video_frame >) noexcept=0
void *	sender_loop ()
void	start ()

Static Private Member Functions
static void *	sender_thread (void *args)
static void	should_exit (void *state)

Private Attributes
virtual void *(*)(void *arg)	get_receiver_thread () noexcept
struct compress_state *	m_compression = nullptr
bool	m_joined
pthread_mutex_t	m_lock
bool	m_poisoned
pthread_t	m_thread_id

Detailed Description

Definition at line 77 of file video_rxtx.hpp.

Constructor & Destructor Documentation

~video_rxtx()

video_rxtx::~video_rxtx ( )

virtual

Definition at line 115 of file video_rxtx.cpp.

                        {
        join();
        if (!m_poisoned && m_compression) {
                send(NULL);
                compress_pop(m_compression);
        }
        compress_done(m_compression);
        module_done(&m_receiver_mod);
        module_done(&m_sender_mod);
}

References compress_done(), compress_pop(), join(), m_compression, m_poisoned, m_receiver_mod, m_sender_mod, module_done(), and send().

Here is the call graph for this function:

video_rxtx()

video_rxtx::video_rxtx ( std::map< std::string, param_u > const & )

protected

Definition at line 70 of file video_rxtx.cpp.

                                                        : m_port_id("default"),
                m_rxtx_mode(params.at("rxtx_mode").i),
                m_frames_sent(0ull),
                m_common(*static_cast<struct common_opts const *>(params.at("common").cptr)),
                m_thread_id(), m_poisoned(false), m_joined(true) {
 
        module_init_default(&m_sender_mod);
        m_sender_mod.cls = MODULE_CLASS_SENDER;
        module_register(&m_sender_mod, m_common.parent);
 
        module_init_default(&m_receiver_mod);
        m_receiver_mod.cls = MODULE_CLASS_RECEIVER;
        module_register(&m_receiver_mod, m_common.parent);
 
        try {
                int ret = compress_init(&m_sender_mod, static_cast<const char *>(params.at("compression").ptr),
                                &m_compression);
                if(ret != 0) {
                        if(ret < 0) {
                                throw string("Error initializing compression.");
                        }
                        if(ret > 0) {
                                throw EXIT_SUCCESS;
                        }
                }
 
                pthread_mutex_init(&m_lock, NULL);
 
        } catch (...) {
                if (m_compression) {
                        compress_done(m_compression);
                }
 
                module_done(&m_receiver_mod);
                module_done(&m_sender_mod);
 
                throw;
        }
}

References module::cls, compress_done(), compress_init(), m_common, m_compression, m_lock, m_receiver_mod, m_sender_mod, MODULE_CLASS_RECEIVER, MODULE_CLASS_SENDER, module_done(), module_init_default(), module_register(), and common_opts::parent.

Here is the call graph for this function:

Member Function Documentation

check_sender_messages()

void video_rxtx::check_sender_messages ( )

protected

Definition at line 169 of file video_rxtx.cpp.

                                       {
        // process external messages
        struct message *msg_external;
        while((msg_external = check_message(&m_sender_mod))) {
                struct response *r = process_sender_message((struct msg_sender *) msg_external);
                free_message(msg_external, r);
        }
}

References check_message(), free_message(), m_sender_mod, and process_sender_message().

Referenced by rtp_video_rxtx::rtp_video_rxtx(), and sender_loop().

Here is the call graph for this function:

create()

video_rxtx * video_rxtx::create ( std::string const & name, std::map< std::string, param_u > const &  )

static

Definition at line 204 of file video_rxtx.cpp.

{
        auto vri = static_cast<const video_rxtx_info *>(load_library(proto.c_str(), LIBRARY_CLASS_VIDEO_RXTX, VIDEO_RXTX_ABI_VERSION));
        if (!vri) {
                return nullptr;
        }
        auto ret = vri->create(params);
        if (!ret) {
                return nullptr;
        }
        ret->start();
        return ret;
}

References video_rxtx_info::create, LIBRARY_CLASS_VIDEO_RXTX, load_library(), start(), and VIDEO_RXTX_ABI_VERSION.

Referenced by recompress_output_port::recompress_output_port(), hd_rum_decompress_init(), main(), and vidcap_ug_input_init().

Here is the call graph for this function:

get_long_name()

const char * video_rxtx::get_long_name ( std::string const & short_name )

static

Definition at line 146 of file video_rxtx.cpp.

                                                               {
        auto vri = static_cast<const video_rxtx_info *>(load_library(short_name.c_str(), LIBRARY_CLASS_VIDEO_RXTX, VIDEO_RXTX_ABI_VERSION));
        if (vri) {
                return vri->long_name;
        } else {
                return "";
        }
}

References LIBRARY_CLASS_VIDEO_RXTX, load_library(), and VIDEO_RXTX_ABI_VERSION.

Referenced by main().

Here is the call graph for this function:

join()

void video_rxtx::join ( )

virtual

If overriden, childern must call also video_rxtx::join()

Reimplemented in h264_rtp_video_rxtx, and ultragrid_rtp_video_rxtx.

Definition at line 136 of file video_rxtx.cpp.

                      {
        if (m_joined) {
                return;
        }
        send(NULL); // pass poisoned pill
        pthread_join(m_thread_id, NULL);
        unregister_should_exit_callback(m_common.parent, video_rxtx::should_exit, this);
        m_joined = true;
}

References m_common, m_joined, m_thread_id, common_opts::parent, send(), should_exit(), and unregister_should_exit_callback().

Referenced by ~video_rxtx(), h264_rtp_video_rxtx::join(), and ultragrid_rtp_video_rxtx::join().

Here is the call graph for this function:

list()

void video_rxtx::list ( bool full )

static

Definition at line 218 of file video_rxtx.cpp.

{
        printf("Available TX protocols:\n");
        list_modules(LIBRARY_CLASS_VIDEO_RXTX, VIDEO_RXTX_ABI_VERSION, full);
}

References LIBRARY_CLASS_VIDEO_RXTX, list_modules(), and VIDEO_RXTX_ABI_VERSION.

Referenced by parse_protocol().

Here is the call graph for this function:

process_sender_message()

virtual struct response * video_rxtx::process_sender_message ( struct msg_sender * )

inlineprivatevirtual

Reimplemented in rtp_video_rxtx.

Definition at line 115 of file video_rxtx.hpp.

                                                                             {
                return NULL;
        }

Referenced by check_sender_messages().

receiver_thread()

static void * video_rxtx::receiver_thread ( void * arg )

inlinestatic

Definition at line 82 of file video_rxtx.hpp.

                                                {
                video_rxtx *rxtx = static_cast<video_rxtx *>(arg);
                return rxtx->get_receiver_thread()(arg);
        }

References get_receiver_thread.

Referenced by hd_rum_decompress_init(), main(), and vidcap_ug_input_init().

send()

void video_rxtx::send

(

std::shared_ptr< struct video_frame >

frame

)

Definition at line 155 of file video_rxtx.cpp.

                                                   {
        if (!frame && m_poisoned) {
                return;
        }
        compress_frame(m_compression, frame);
        if (!frame) {
                m_poisoned = true;
        }
}

References compress_frame(), frame, m_compression, and m_poisoned.

Referenced by ~video_rxtx(), and join().

Here is the call graph for this function:

send_frame()

virtual void video_rxtx::send_frame ( std::shared_ptr< video_frame > )

privatepure virtualnoexcept

Implemented in h264_rtp_video_rxtx, h264_sdp_video_rxtx, ihdtv_video_rxtx, loopback_video_rxtx, sage_video_rxtx, and ultragrid_rtp_video_rxtx.

Referenced by sender_loop().

sender_loop()

void * video_rxtx::sender_loop ( )

private

Definition at line 178 of file video_rxtx.cpp.

                              {
        set_thread_name(__func__);
        struct video_desc saved_vid_desc;
 
        memset(&saved_vid_desc, 0, sizeof(saved_vid_desc));
 
        while(1) {
                check_sender_messages();
 
                shared_ptr<video_frame> tx_frame;
 
                tx_frame = compress_pop(m_compression);
                if (!tx_frame) {
                        break;
                }
 
                export_video(m_common.exporter, tx_frame.get());
 
                send_frame(std::move(tx_frame));
                m_frames_sent += 1;
        }
 
        check_sender_messages();
        return NULL;
}

References check_sender_messages(), compress_pop(), export_video(), common_opts::exporter, m_common, m_compression, m_frames_sent, send_frame(), and set_thread_name().

Referenced by sender_thread().

Here is the call graph for this function:

sender_thread()

void * video_rxtx::sender_thread ( void * args )

staticprivate

Definition at line 165 of file video_rxtx.cpp.

                                          {
        return static_cast<video_rxtx *>(args)->sender_loop();
}

References sender_loop().

Referenced by start().

Here is the call graph for this function:

set_audio_spec()

void video_rxtx::set_audio_spec ( const struct audio_desc * desc, int audio_rx_port, int audio_tx_port, bool ipv6 )

virtual

Reimplemented in h264_rtp_video_rxtx, and h264_sdp_video_rxtx.

Definition at line 225 of file video_rxtx.cpp.

{
        MSG(INFO, "video RXTX not h264_rtp, not setting audio...\n");
}

References MSG.

Referenced by set_audio_spec_to_vrxtx().

should_exit()

void video_rxtx::should_exit ( void * state )

staticprivate

Definition at line 110 of file video_rxtx.cpp.

                                        {
        video_rxtx *s = (video_rxtx *) state;
        s->m_should_exit = true;
}

References m_should_exit, and state.

Referenced by join(), and start().

start()

void video_rxtx::start ( )

private

Definition at line 126 of file video_rxtx.cpp.

                       {
        register_should_exit_callback(m_common.parent, video_rxtx::should_exit,
                                      this);
        if (pthread_create(&m_thread_id, NULL, video_rxtx::sender_thread,
                           (void *) this) != 0) {
                throw string("Unable to create sender thread!\n");
        }
        m_joined = false;
}

References m_common, m_joined, m_thread_id, common_opts::parent, register_should_exit_callback(), sender_thread(), and should_exit().

Referenced by create().

Here is the call graph for this function:

supports_receiving()

bool video_rxtx::supports_receiving ( )

inline

Definition at line 86 of file video_rxtx.hpp.

                                  {
                return get_receiver_thread() != NULL;
        }

References get_receiver_thread.

Member Data Documentation

get_receiver_thread

virtual void *(*)(void *arg) video_rxtx::get_receiver_thread() noexcept

private

Definition at line 112 of file video_rxtx.hpp.

Referenced by receiver_thread(), and supports_receiving().

m_common

struct common_opts video_rxtx::m_common

protected

Definition at line 106 of file video_rxtx.hpp.

Referenced by h264_rtp_video_rxtx::h264_rtp_video_rxtx(), ihdtv_video_rxtx::ihdtv_video_rxtx(), rtp_video_rxtx::rtp_video_rxtx(), ultragrid_rtp_video_rxtx::ultragrid_rtp_video_rxtx(), video_rxtx(), join(), ultragrid_rtp_video_rxtx::new_video_decoder(), rtp_video_rxtx::process_sender_message(), ultragrid_rtp_video_rxtx::receiver_loop(), ultragrid_rtp_video_rxtx::receiver_process_messages(), ultragrid_rtp_video_rxtx::send_frame_async(), sender_loop(), h264_sdp_video_rxtx::set_audio_spec(), and start().

m_compression

struct compress_state* video_rxtx::m_compression = nullptr

private

Definition at line 120 of file video_rxtx.hpp.

Referenced by video_rxtx(), ~video_rxtx(), send(), and sender_loop().

m_frames_sent

unsigned long long int video_rxtx::m_frames_sent

protected

Definition at line 105 of file video_rxtx.hpp.

Referenced by rtp_video_rxtx::process_sender_message(), and sender_loop().

m_joined

bool video_rxtx::m_joined

private

Definition at line 124 of file video_rxtx.hpp.

Referenced by join(), and start().

m_lock

pthread_mutex_t video_rxtx::m_lock

private

Definition at line 121 of file video_rxtx.hpp.

Referenced by video_rxtx().

m_poisoned

bool video_rxtx::m_poisoned

private

Definition at line 124 of file video_rxtx.hpp.

Referenced by ~video_rxtx(), and send().

m_port_id

std::string video_rxtx::m_port_id

Definition at line 98 of file video_rxtx.hpp.

m_receiver_mod

struct module video_rxtx::m_receiver_mod

protected

Definition at line 103 of file video_rxtx.hpp.

Referenced by video_rxtx(), ~video_rxtx(), ultragrid_rtp_video_rxtx::new_video_decoder(), and ultragrid_rtp_video_rxtx::receiver_process_messages().

m_rxtx_mode

int video_rxtx::m_rxtx_mode

protected

Definition at line 104 of file video_rxtx.hpp.

Referenced by rtp_video_rxtx::process_sender_message(), ultragrid_rtp_video_rxtx::receiver_process_messages(), and ultragrid_rtp_video_rxtx::send_frame_async().

m_sender_mod

struct module video_rxtx::m_sender_mod

protected

Definition at line 102 of file video_rxtx.hpp.

Referenced by rtp_video_rxtx::rtp_video_rxtx(), sage_video_rxtx::sage_video_rxtx(), video_rxtx(), ~video_rxtx(), and check_sender_messages().

m_should_exit

bool video_rxtx::m_should_exit = false

protected

Definition at line 107 of file video_rxtx.hpp.

Referenced by ihdtv_video_rxtx::receiver_loop(), loopback_video_rxtx::receiver_loop(), ultragrid_rtp_video_rxtx::receiver_loop(), ultragrid_rtp_video_rxtx::send_frame_async(), and should_exit().

m_thread_id

pthread_t video_rxtx::m_thread_id

private

Definition at line 123 of file video_rxtx.hpp.

Referenced by join(), and start().

---

The documentation for this struct was generated from the following files:

• src/video_rxtx.hpp
• src/video_rxtx.cpp