video_compress.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2009-2024 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:
 *
 * 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. 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.
 */
 
#ifndef __video_compress_h
#define __video_compress_h
 
#include "types.h"
 
#define VIDEO_COMPRESS_ABI_VERSION 12
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct compress_state;
struct module;
 
//
// Begins external API for video compression use
//
typedef struct module *(*compress_init_t)(struct module *parent,
                const char *cfg);
// documented at definition
void show_compress_help(bool full);
// documented at definition
int compress_init(struct module *parent, const char *config_string, struct compress_state **);
void compress_done(struct compress_state *);
#ifdef __cplusplus
}
#endif
#ifdef __cplusplus
#include <memory>
// documented at definition
void compress_frame(struct compress_state *, std::shared_ptr<video_frame>);
// documented at definition
std::shared_ptr<video_frame> compress_pop(struct compress_state *);
 
//
// Begins API for individual video compression modules
//
#include <list>
#include <string>
#include <vector>
 
typedef  std::shared_ptr<video_frame> (*compress_frame_t)(struct module *state, std::shared_ptr<video_frame> frame);
 
typedef  std::shared_ptr<video_frame> (*compress_tile_t)(struct module *state, std::shared_ptr<video_frame> in_frame);
 
typedef void (*compress_frame_async_push_t)(struct module *state, std::shared_ptr<video_frame> in_frame);
 
typedef  std::shared_ptr<video_frame> (*compress_frame_async_pop_t)(struct module *state);
 
typedef void (*compress_tile_async_push_t)(struct module *state, std::shared_ptr<video_frame> in_frame);
 
typedef  std::shared_ptr<video_frame> (*compress_tile_async_pop_t)(struct module *state);
 
struct module_option{
        std::string display_name; //Name displayed to user
        std::string display_desc; //Description displayed to user
        std::string placeholder_text; //Displayed placeholder text if opt is a line edit
 
        /* internal name of option, options that are used in the same way should
         * have the same key (e.g. both bitrate for libavcodec and quality for jpeg
         * should have the same key). This allows using different labels displayed
         * to user */
        std::string key;
        std::string opt_str; //Option string to pass to ug (e.g. ":bitrate=")
 
        bool is_boolean; //If true, GUI shows a checkbox instead of text edit
};
 
struct encoder{
        std::string name;
        std::string opt_str;
};
 
struct codec{
        std::string name;
        std::vector<encoder> encoders;
        int priority;
};
 
struct compress_module_info{
        std::string name;
        std::vector<module_option> opts;
        std::vector<codec> codecs;
};
 
struct video_compress_info {
        const char        * name;         
        compress_init_t     init_func;           
 
        compress_frame_t    compress_frame_func; 
 
        compress_tile_t     compress_tile_func;  
 
        compress_frame_async_push_t compress_frame_async_push_func; 
        compress_frame_async_pop_t compress_frame_async_pop_func; 
 
        compress_tile_async_push_t compress_tile_async_push_func; 
        compress_tile_async_pop_t compress_tile_async_pop_func; 
 
        compress_module_info (*get_module_info)();
};
 
#endif // __cplusplus
 
#endif /* __video_compress_h */
 // end of video_compress