9.1/sources/libs/nvstreammux/include/nvstreammux.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NVSTREAMMUX_H__
#define __NVSTREAMMUX_H__
 
#include <chrono>
#include <unordered_map>
#include <map>
#include <list>
#include "nvbufsurface.h"
#include "nvstreammux_batch.h"
#include "nvstreammux_debug.h"
 
//G_BEGIN_DECLS
 
typedef struct _GstNvStreamMux GstNvStreamMux;
typedef struct _GstNvStreamMuxClass GstNvStreamMuxClass;
 
/*
 * @brief low level helper for core logic, this is agnostic of gstreamer
 * or any other wrapper on higher level
 */
 
class NvStreamMux
{
 
 
    public :
 
        NvStreamMux(SourcePad * srcpad, INvStreammuxDebug* a_debug_iface=nullptr) : inputs(), src_pad(srcpad), cv(), cv_throttle_wait(), mutex(), mutex_throttle_wait()
        {
            batch = NULL;
 
            stop_task = false;
            num_queues_empty = 0;
            num_sources_idle = 0;
            pads_got_eos_and_empty_in_q = 0;
            num_pads_eos = 0;
            cur_frame_pts = 0;
            state = SOURCE_STATE_IDLE;
            num_surfaces_per_frame = 1;
            all_pads_eos = false;
            extra_throttle_wait_time = std::chrono::microseconds(0);
            got_first_buffer = false;
            synch_buffer = nullptr;
            debug_iface = a_debug_iface;
        }
 
    /*
         * @brief functions to maintain internal variables based on config
         */
        void set_policy(BatchPolicyConfig cfg)
        {
            batch_policy = BatchPolicy(cfg, &inputs, debug_iface);
            batch_policy.total_buf_available = 0;
            batch_policy.set_synch_buffer_iface(synch_buffer);
        }
        void set_frame_num_reset_on_eos(bool reset)
        {
            frame_num_reset_on_eos = reset;
        }
        void set_frame_num_reset_on_stream_reset(bool reset)
        {
            frame_num_reset_on_stream_reset = reset;
        }
 
        /*
         * @brief acquire lock on mux
         */
        virtual void lock()
        {
            mutex.lock();
        };
 
        /*
         * @brief release lock on mux
         */
        virtual void unlock()
        {
            mutex.unlock();
        };
 
        /*
         * @brief release lock on mux
         */
        virtual void wait(){};
 
        /*
         * @brief release lock on mux
         */
        virtual void notify_all();
 
        /*
         * @brief get_pad for specified pad id
         * @param pad_id, id of pad to lookup
         * @return pointer to SinkPad object for the pad_id
         */
        SinkPad * get_pad(unsigned int pad_id);
 
        /*
         * @brief add_pad for specified pad id
         * @param pad_id, id of pad to lookup
         * @return pointer to SinkPad object for the pad_id
         */
        void add_pad(unsigned int id, SinkPad * pad);
 
        /*
         * @brief 
         * @param pad_id, id of pad to lookup
         * @param  mime_type [IN]
         * @return NA
         */
        void update_pad_mimetype(unsigned int id, PAD_MIME_TYPE mime_type);
 
        /*
         * @brief 
         * @param  id [IN] id of pad to lookup
         * @return The configured mime type for the sinkpad at pad_id==id
         */
        PAD_MIME_TYPE get_pad_mimetype(unsigned int id);
 
        /*
         * @brief get_pad for specified pad id
         * @param pad_id, id of pad to lookup
         * @return pointer to SinkPad object for the pad_id
         */
        void remove_pad(unsigned int id);
 
        /*
         * @brief Construct the NvStreamMux from config, this would typically
         * come from a high level config file
         */
        //virtual  update_source(SINK_EVENT event, unsigned long source_id);
 
 
        /*
         * @brief handle the eos event on pad
         * @param event [IN] sink event
         * @param source_id[IN] id of source, in deepstream app pad_id
         * of gstreamer
         * source pad is same as this id
         * @param EventWrapper [IN] event coming on sink pad
         *
         */
        virtual bool  handle_eos(SINK_EVENT et, unsigned int source_id, EventWrapper * event);
 
    /*
         * @brief handle the eos event on pad for cascaded muxers
         * @param event [IN] sink event
         * @param source_id[IN] id of source, in deepstream app pad_id
         * of gstreamer
         * source pad is same as this id
         * @param EventWrapper [IN] event coming on sink pad
         *
         */
        virtual bool  handle_eos_cascaded(SINK_EVENT et, unsigned int source_id, EventWrapper * event);
        /*
         * @brief handle the segment event on pad
         * @param event [IN] sink event
         * @param source_id[IN] id of source, in deepstream app pad_id
         * of gstreamer
         * source pad is same as this id
         * @param EventWrapper [IN] event coming on sink pad
         *
         */
        virtual bool  handle_segment(SINK_EVENT et, unsigned int source_id, EventWrapper * event);
 
        /*
         * @brief handle the GST_NVEVENT_STREAM_RESET event on pad
         * @param event [IN] sink event
         * @param source_id[IN] id of source, in deepstream app pad_id
         * of gstreamer
         * source pad is same as this id
         * @param EventWrapper [IN] event coming on sink pad
         *
         */
        virtual bool  handle_stream_reset(SINK_EVENT et, unsigned int source_id, EventWrapper * event);
 
        /*
         * @brief handle the FLUSH_STOP event on pad
         * @param event [IN] sink event
         * @param source_id[IN] id of source, in deepstream app pad_id
         * of gstreamer
         * source pad is same as this id
         * @param EventWrapper [IN] event coming on sink pad
         *
         */
        virtual bool  handle_flush_stop(SINK_EVENT et, unsigned int source_id, EventWrapper * event);
 
        /*
         * @brief add sink pad
         * @param pad [IN] the pad to be added
         */
        virtual void add_sink(SinkPad  * pad){};
 
        /*
         * @brief remove sink pad
         * @param pad [IN] the pad to be added
         */
        virtual void remove_sink(SinkPad pad){};
 
        /*
         * @brief add buffer to sink pad
         * @param pad [IN] the pad to be added
         * @param buffer [IN] the buffer to be added
         */
        //virtual  void add_buffer(SinkPad * pad, BufferWrapper * buffer);
        virtual  void add_buffer(unsigned int pad_id, BufferWrapper * buffer);
 
        /*
         * @brief task for processing queued buffers and events,
         * according to batching configuration
         * @param pad [IN] the pad to be added
         * @param buffer [IN] the buffer to be added
         */
        bool   push_loop(NvDsBatchBufferWrapper * out_buf, NvDsBatchMeta *);
 
        /*
         * @brief function to push the buffer out of mux to designated SourcePad
         * @param out_buf [IN] the batch to be pushed
         * @param src_pad  [IN] the to push to
         * @return true on successfully pushing the batch buffer on src_pad;
         *         false otherwise
         */
        bool    push_batch(NvDsBatchBufferWrapper * out_buf, SourcePad * src_pad);
 
        /*
         * @brief function to push events out of mux
         */
 
        void    push_events();
 
 
        /*
         * @brief function to copy the individual buffers and metadata to batch
         * @param out_buf [IN] the batch buffer
         * @param buffer [IN] the metadata
         * @return the total number of buffers copied
         */
        unsigned int    copy_batch(NvDsBatchBufferWrapper * out_buf, NvDsBatchMeta *);
 
    /*
         * @brief functions to calculate play duration, called while processing 
     * relevant gstreamer events
         * @return void
         */
        void    handle_pause_play();
        void    handle_play_pause();
        void    handle_ready_pause();
 
    /*
         * @brief functions called to process gstreamer event 
     * GST_STATE_CHANGE_READY_TO_PAUSED
         * @return void
         */
        void    handle_stop();
        void    reset_stop();
 
 
    /*
         * @brief function to set value of frame_duration_nsec
         * @param offset [IN] value to be set
         */
        void    set_frame_duration(unsigned long);
 
    /*
         * @brief function to set value of cur_frame_pts
         * @param offset [IN] value to be set
         */
    void    set_pts_offset(gulong offset);
 
    /*
         * @brief function to get current state of PAD
         * @param sinkPad [IN] SinkPad Pointer
         * @param SOURCE_STATE [OUT] State of sinkpad
         */
    SOURCE_STATE get_pad_state(SinkPad* sinkPad);
 
        void set_batch_size(unsigned int size);
 
        void set_batch_push_timeout(unsigned int timeout);
 
        unsigned int get_batch_size();
       
        unsigned int get_config_batch_size();
 
        void set_num_surfaces_per_frame(unsigned int num);
 
        unsigned int get_num_surfaces_per_frame();
       
        void set_all_pads_eos(bool eos);
 
        void reset_pad(SinkPad* pad);
 
        bool get_all_pads_eos();
 
        void set_synch_buffer_iface(ISynchronizeBuffer* synch_buffer_iface);
 
        NanoSecondsType get_min_fps_duration();
 
        unsigned int get_source_id_with_earliest_buffer();
 
        unsigned int get_remaining_unbatched_buffers_from_all_sources();
 
        void apply_throttle(bool stop_when_input_buffer=false);
 
    private :
        std::unordered_map<unsigned int, SinkPad *> inputs;
        SourcePad * src_pad;
        SOURCE_STATE state;
        unsigned int num_queues_empty;
        unsigned int num_sources_idle;
        unsigned int pads_got_eos_and_empty_in_q;
        unsigned int num_pads_eos;
        unsigned int num_surfaces;
        std::condition_variable cv;
        std::condition_variable cv_throttle_wait;
        std::mutex              mutex;
        std::mutex              mutex_throttle_wait;
        Batch * batch;
        /*
         * @brief map of sources for a priority
         */
        std::multimap<int, int> sources;
        TimePoint current_play_start_time;
        TimePoint last_pause_time;
        NanoSecondsType accum_play_dur;
        unsigned long frame_duration_nsec;
        unsigned long cur_frame_pts;
        bool stop_task;
        NanoSecondsType extra_throttle_wait_time;
 
        BatchPolicy  batch_policy;
        unsigned int num_surfaces_per_frame;
        bool all_pads_eos;
        bool got_first_buffer;
        bool frame_num_reset_on_eos = false;
        bool frame_num_reset_on_stream_reset = false;
        INvStreammuxDebug* debug_iface;
 
    public:
        ISynchronizeBuffer* synch_buffer;
};
 
//G_END_DECLS
#endif