172 lines
4.9 KiB
C
172 lines
4.9 KiB
C
/*
|
|
* Copyright (C) 2016 Glyptodon, Inc.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef GUACENC_INSTRUCTIONS_H
|
|
#define GUACENC_INSTRUCTIONS_H
|
|
|
|
#include "config.h"
|
|
#include "display.h"
|
|
|
|
/**
|
|
* A callback function which, when invoked, handles a particular Guacamole
|
|
* instruction. The opcode of the instruction is implied (as it is expected
|
|
* that there will be a 1:1 mapping of opcode to callback function), while the
|
|
* arguments for that instruction are included in the parameters given to the
|
|
* callback.
|
|
*
|
|
* @param display
|
|
* The current internal display of the Guacamole video encoder.
|
|
*
|
|
* @param argc
|
|
* The number of arguments (excluding opcode) passed to the instruction
|
|
* being handled by the callback.
|
|
*
|
|
* @param argv
|
|
* All arguments (excluding opcode) associated with the instruction being
|
|
* handled by the callback.
|
|
*
|
|
* @return
|
|
* Zero if the instruction was handled successfully, non-zero if an error
|
|
* occurs.
|
|
*/
|
|
typedef int guacenc_instruction_handler(guacenc_display* display,
|
|
int argc, char** argv);
|
|
|
|
/**
|
|
* Mapping of instruction opcode to corresponding handler function.
|
|
*/
|
|
typedef struct guacenc_instruction_handler_mapping {
|
|
|
|
/**
|
|
* The opcode of the instruction that the associated handler function
|
|
* should be invoked for.
|
|
*/
|
|
const char* opcode;
|
|
|
|
/**
|
|
* The handler function to invoke whenever an instruction having the
|
|
* associated opcode is parsed.
|
|
*/
|
|
guacenc_instruction_handler* handler;
|
|
|
|
} guacenc_instruction_handler_mapping;
|
|
|
|
/**
|
|
* Array of all opcode/handler mappings for all supported opcodes, terminated
|
|
* by an entry with a NULL opcode. All opcodes not listed here can be safely
|
|
* ignored.
|
|
*/
|
|
extern guacenc_instruction_handler_mapping guacenc_instruction_handler_map[];
|
|
|
|
/**
|
|
* Handles the instruction having the given opcode and arguments, encoding the
|
|
* result to the in-progress video.
|
|
*
|
|
* @param display
|
|
* The current internal display of the Guacamole video encoder.
|
|
*
|
|
* @param opcode
|
|
* The opcode of the instruction being handled.
|
|
*
|
|
* @param argc
|
|
* The number of arguments (excluding opcode) passed to the instruction
|
|
* being handled by the callback.
|
|
*
|
|
* @param argv
|
|
* All arguments (excluding opcode) associated with the instruction being
|
|
* handled by the callback.
|
|
*
|
|
* @return
|
|
* Zero if the instruction was handled successfully, non-zero if an error
|
|
* occurs.
|
|
*/
|
|
int guacenc_handle_instruction(guacenc_display* display,
|
|
const char* opcode, int argc, char** argv);
|
|
|
|
/**
|
|
* Handler for the Guacamole "blob" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_blob;
|
|
|
|
/**
|
|
* Handler for the Guacamole "img" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_img;
|
|
|
|
/**
|
|
* Handler for the Guacamole "end" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_end;
|
|
|
|
/**
|
|
* Handler for the Guacamole "sync" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_sync;
|
|
|
|
/**
|
|
* Handler for the Guacamole "cursor" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_cursor;
|
|
|
|
/**
|
|
* Handler for the Guacamole "copy" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_copy;
|
|
|
|
/**
|
|
* Handler for the Guacamole "transfer" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_transfer;
|
|
|
|
/**
|
|
* Handler for the Guacamole "size" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_size;
|
|
|
|
/**
|
|
* Handler for the Guacamole "rect" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_rect;
|
|
|
|
/**
|
|
* Handler for the Guacamole "cfill" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_cfill;
|
|
|
|
/**
|
|
* Handler for the Guacamole "move" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_move;
|
|
|
|
/**
|
|
* Handler for the Guacamole "shade" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_shade;
|
|
|
|
/**
|
|
* Handler for the Guacamole "dispose" instruction.
|
|
*/
|
|
guacenc_instruction_handler guacenc_handle_dispose;
|
|
|
|
#endif
|
|
|