Functions | |
| cpl_recipeconfig * | cpl_recipeconfig_new (void) |
| Create a new recipe configuration object. | |
| void | cpl_recipeconfig_delete (cpl_recipeconfig *self) |
| Delete a recipe configuration object. | |
| void | cpl_recipeconfig_clear (cpl_recipeconfig *self) |
| Clear a recipe configuration object. | |
| const char ** | cpl_recipeconfig_get_tags (const cpl_recipeconfig *self) |
| Get the list of supported configuration tags. | |
| int | cpl_recipeconfig_set_tags (cpl_recipeconfig *self, const cpl_framedata *data) |
| Set the list of configuration tags. | |
| int | cpl_recipeconfig_set_tag (cpl_recipeconfig *self, const char *tag, int min_count, int max_count) |
| Set a configuration tag. | |
| const char ** | cpl_recipeconfig_get_inputs (const cpl_recipeconfig *self, const char *tag) |
| Get the input configuration for a given tag. | |
| int | cpl_recipeconfig_set_inputs (cpl_recipeconfig *self, const char *tag, const cpl_framedata *data) |
| Set the input configuration for a given tag. | |
| int | cpl_recipeconfig_set_input (cpl_recipeconfig *self, const char *tag, const char *input, int min_count, int max_count) |
| Add the configuration for the given input and configuration tag. | |
| const char ** | cpl_recipeconfig_get_outputs (const cpl_recipeconfig *self, const char *tag) |
| Get the output configuration for a given tag. | |
| int | cpl_recipeconfig_set_outputs (cpl_recipeconfig *self, const char *tag, const char **data) |
| Set the output configuration for a given tag. | |
| int | cpl_recipeconfig_set_output (cpl_recipeconfig *self, const char *tag, const char *output) |
| Add an output frame tag for the given configuration tag. | |
| int | cpl_recipeconfig_get_min_count (const cpl_recipeconfig *self, const char *tag, const char *input) |
| Get the minimum number of frames for the given configuration and tag. | |
| int | cpl_recipeconfig_get_max_count (const cpl_recipeconfig *self, const char *tag, const char *input) |
| Get the maximum number of frames for the given configuration and tag. | |
| int | cpl_recipeconfig_is_required (const cpl_recipeconfig *self, const char *tag, const char *input) |
| Check whether a frame with the given tag is required. | |
For each input frame extra information, for instance, whether a particular frame type is a required or optional recipe input, or how many frames of a certain type are at least needed, can also be stored.
The information for the individual recipe configurations and also for the individual frames can be accessed by means of a unique string identifier for the configuration and the frame respectively. This string identifier is called configuration tag in the former, and frame tag in the latter case. In particular, the configuration tag is a frame tag too, namely the frame tag of the recipe's "primary" input, or trigger frame.
The recipe configuration object stores a separate configuration for each of the different frame types, indicated by its tag, it is able to process. Each of these configurations can be retrieved, using the appropriate configuration tag as a key.
In the same way the information about individual frames can be retrieved from the selected configuration.
#include <cpl_recipeconfig.h>
|
|
Clear a recipe configuration object.
|
|
|
Delete a recipe configuration object.
|
|
||||||||||||
|
Get the input configuration for a given tag.
The function retrieves the list of input frame tags stored in the recipe configuration for the configuration tag tag from the configuration object self.
In case the input configuration for the tag tag is empty, i.e. no input frame tag has been added the function still returns a C string array. In this case the first element is set to
The returned array and each of its elements must be deallocated using cpl_free() if they are no longer used. The array is |
|
||||||||||||||||
|
Get the maximum number of frames for the given configuration and tag.
The function queries the recipe configuration self for the configuration tag tag, searches this configuration for the frame tag input and returns the maximum number of frames required for this frame type. If the same string is passed as tag and input, the settings for the frame with tag tag are returned. |
|
||||||||||||||||
|
Get the minimum number of frames for the given configuration and tag.
The function queries the recipe configuration self for the configuration tag tag, searches this configuration for the frame tag input and returns the minimum number of frames required for this frame type. If the same string is passed as tag and input, the settings for the frame with tag tag are returned. |
|
||||||||||||
|
Get the output configuration for a given tag.
The function retrieves the list of all possible output frame tags stored in the recipe configuration object self for the configuration tag tag.
In case the output configuration for the tag tag is empty, i.e. no output frame tag has been added the function still returns a C string array. In this case the first element is set to
The returned array and each of its elements must be deallocated using cpl_free() if they are no longer used. The array is |
|
|
Get the list of supported configuration tags.
The function retrieves the list of configuration tags stored in the recipe configuration object self. The frame tags are returned as the elements of an array of C strings. The last element of the array is a
In case the recipe configuration object is empty, i.e. no configuration tag has been added, or cpl_recipeconfig_clear() has been called for this object, the function still returns the C string array. In this case the first element is set to If the returned list is not used any more each element, and the array itself must be deallocated using cpl_free(). |
|
||||||||||||||||
|
Check whether a frame with the given tag is required.
The function queries the recipe configuration self for the configuration tag tag and searches this configuration for the frame tag input. It returns the maximum number of frames required for this frame type. If the same string is passed as tag and input, the settings for the frame with tag tag are returned. |
|
|
Create a new recipe configuration object.
|
|
||||||||||||||||||||||||
|
Add the configuration for the given input and configuration tag.
The function sets the configuration for the input frame tag input of the configuration associated with the tag tag in the recipe configuration object self. The minimum and maximum number of frames of this input frame tag are given using the min_count and max_count arguments. Using a value of Before an input configuration can be set using this function, the configuration tag tag must have been added to self previously using cpl_recipeconfig_set_tag() or cpl_recipeconfig_set_tags().
|
|
||||||||||||||||
|
Set the input configuration for a given tag.
The function sets the input configuration for the tag tag in the recipe configuration object self. The minimum and maximum number of frames of this tag can be given using the arguments min_count and max_count. Using a value of
The function sets the configuration data for each input tag specified in the array data, until a tag set to Before an input configuration can be set using this function, the configuration tag tag must have been added to self previously using cpl_recipeconfig_set_tag() or cpl_recipeconfig_set_tags().
|
|
||||||||||||||||
|
Add an output frame tag for the given configuration tag.
The function adds the output frame tag ouput to the configuration associated with the tag tag in the recipe configuration object self. Before an output frame tag can be set using this function, the configuration tag tag must have been added to self previously, using cpl_recipeconfig_set_tag() or cpl_recipeconfig_set_tags().
|
|
||||||||||||||||
|
Set the output configuration for a given tag.
The function sets the output configuration for the tag tag in the recipe configuration object self. The output configuration is a list of all possible frame tags which could result from the execution of the corresponding recipe.
The function stores each output frame tag found in the array data, until an array element set to Before an output configuration can be set using this function, the configuration tag tag must have been added to self previously using cpl_recipeconfig_set_tag() or cpl_recipeconfig_set_tags().
|
|
||||||||||||||||||||
|
Set a configuration tag.
The function creates a configuration for the configuration tag tag and adds it to the recipe configuration object self. The minimum and maximum number of frames of this tag can be given using the arguments min_count and max_count. Using a value of |
|
||||||||||||
|
Set the list of configuration tags.
The function is a convenience function to allow an initialization of a recipe configuration from static data. The configuration tags to be stored are taken from the frame data array data and are added to the recipe configuration self. The configuration tag is copied to self. In addition the tags can be configured using the remaining members of the frame data structures of data. The function adds each configuration tag found in the array data to the configuration self, until a configuration tag set to NULL is reached. The array data must be terminated by such an entry, which indicates the end of the array. |
1.4.6