OpenJPEG: function_list.h Source File

OpenJPEG 2.4.0

function_list.h
Go to the documentation of this file.
1 /*
2 * The copyright in this software is being made available under the 2-clauses
3 * BSD License, included below. This software may be subject to other third
4 * party and contributor rights, including patent rights, and no such rights
5 * are granted under this license.
6 *
7 * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef OPJ_FUNCTION_LIST_H
33 #define OPJ_FUNCTION_LIST_H
34
44
45 /**************************************************************************************************
46 ***************************************** FORWARD DECLARATION ************************************
47 **************************************************************************************************/
48
52 typedef void (*opj_procedure)(void);
53
57 typedef struct opj_procedure_list {
61 OPJ_UINT32 m_nb_procedures;
65 OPJ_UINT32 m_nb_max_procedures;
69 opj_procedure * m_procedures;
70
71 } opj_procedure_list_t;
72
73 /* ----------------------------------------------------------------------- */
74
80 opj_procedure_list_t * opj_procedure_list_create(void);
81
87 void opj_procedure_list_destroy(opj_procedure_list_t * p_list);
88
98 OPJ_BOOL opj_procedure_list_add_procedure(opj_procedure_list_t *
99 p_validation_list, opj_procedure p_procedure, opj_event_mgr_t* p_manager);
100
108 OPJ_UINT32 opj_procedure_list_get_nb_procedures(opj_procedure_list_t *
109 p_validation_list);
110
120 opj_procedure* opj_procedure_list_get_first_procedure(opj_procedure_list_t *
121 p_validation_list);
122
123
130 void opj_procedure_list_clear(opj_procedure_list_t * p_validation_list);
133 #endif /* OPJ_FUNCTION_LIST_H */
134
opj_procedure_list_destroy
void opj_procedure_list_destroy(opj_procedure_list_t *p_list)
Destroys a validation list.
Definition: function_list.c:58
opj_calloc
void * opj_calloc(size_t num, size_t size)
Allocate a memory block with elements initialized to 0.
Definition: opj_malloc.c:198
opj_procedure_list::m_nb_max_procedures
OPJ_UINT32 m_nb_max_procedures
The number of the array of validation procedures.
Definition: function_list.h:65
opj_procedure_list_destroy
void opj_procedure_list_destroy(opj_procedure_list_t *p_list)
Destroys a validation list.
Definition: function_list.c:58
opj_event_msg
OPJ_BOOL opj_event_msg(opj_event_mgr_t *p_event_mgr, OPJ_INT32 event_type, const char *fmt,...)
Write formatted data to a string and send the string to a user callback.
Definition: event.c:91
opj_procedure_list_t
struct opj_procedure_list opj_procedure_list_t
A list of procedures.
opj_procedure_list_get_nb_procedures
OPJ_UINT32 opj_procedure_list_get_nb_procedures(opj_procedure_list_t *p_validation_list)
Gets the number of validation procedures.
Definition: function_list.c:102
opj_event_mgr
Message handler object used for.
Definition: event.h:50
opj_procedure_list::m_procedures
opj_procedure * m_procedures
The array of procedures.
Definition: function_list.h:69
opj_procedure_list_get_nb_procedures
OPJ_UINT32 opj_procedure_list_get_nb_procedures(opj_procedure_list_t *p_validation_list)
Gets the number of validation procedures.
Definition: function_list.c:102
opj_procedure_list_create
opj_procedure_list_t * opj_procedure_list_create(void)
Creates a validation list.
Definition: function_list.c:39
opj_procedure_list::m_nb_procedures
OPJ_UINT32 m_nb_procedures
The number of validation procedures.
Definition: function_list.h:61
OPJ_BOOL
int OPJ_BOOL
Definition: openjpeg.h:110
opj_includes.h
opj_procedure_list_create
opj_procedure_list_t * opj_procedure_list_create()
Creates a validation list.
Definition: function_list.c:39
opj_procedure_list_add_procedure
OPJ_BOOL opj_procedure_list_add_procedure(opj_procedure_list_t *p_validation_list, opj_procedure p_procedure, opj_event_mgr_t *p_manager)
Adds a new validation procedure.
Definition: function_list.c:70
opj_procedure_list_get_first_procedure
opj_procedure * opj_procedure_list_get_first_procedure(opj_procedure_list_t *p_validation_list)
Gets the pointer on the first validation procedure.
Definition: function_list.c:108
opj_procedure_list_clear
void opj_procedure_list_clear(opj_procedure_list_t *p_validation_list)
Clears the list of validation procedures.
Definition: function_list.c:114
OPJ_VALIDATION_SIZE
#define OPJ_VALIDATION_SIZE
Default size of the validation list, if not sufficient, data will be reallocated with a double size.
Definition: function_list.c:37
opj_procedure_list
A list of procedures.
Definition: function_list.h:57
opj_realloc
void * opj_realloc(void *ptr, size_t new_size)
Reallocate memory blocks.
Definition: opj_malloc.c:239
OPJ_TRUE
#define OPJ_TRUE
Definition: openjpeg.h:111
opj_procedure_list_get_first_procedure
opj_procedure * opj_procedure_list_get_first_procedure(opj_procedure_list_t *p_validation_list)
Gets the pointer on the first validation procedure.
Definition: function_list.c:108
opj_free
void opj_free(void *ptr)
Deallocates or frees a memory block.
Definition: opj_malloc.c:246
opj_procedure_list_clear
void opj_procedure_list_clear(opj_procedure_list_t *p_validation_list)
Clears the list of validation procedures.
Definition: function_list.c:114
EVT_ERROR
#define EVT_ERROR
Error event type.
Definition: event.h:66
OPJ_UINT32
uint32_t OPJ_UINT32
Definition: openjpeg.h:126
OPJ_FALSE
#define OPJ_FALSE
Definition: openjpeg.h:112
opj_procedure_list_add_procedure
OPJ_BOOL opj_procedure_list_add_procedure(opj_procedure_list_t *p_validation_list, opj_procedure p_procedure, opj_event_mgr_t *p_manager)
Adds a new validation procedure.
Definition: function_list.c:70
opj_procedure
void(* opj_procedure)(void)
declare a function pointer
Definition: function_list.h:52