struct opj_j2k: remove unused fields, and add some documentation
[openjpeg.git] / src / lib / openjp2 / function_list.c
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 #include "opj_includes.h"
33
34 /**
35  * Default size of the validation list, if not sufficient, data will be reallocated with a double size.
36  */
37 #define OPJ_VALIDATION_SIZE 10
38
39 opj_procedure_list_t *  opj_procedure_list_create()
40 {
41     /* memory allocation */
42     opj_procedure_list_t * l_validation = (opj_procedure_list_t *) opj_calloc(1,
43                                           sizeof(opj_procedure_list_t));
44     if (! l_validation) {
45         return 00;
46     }
47     /* initialization */
48     l_validation->m_nb_max_procedures = OPJ_VALIDATION_SIZE;
49     l_validation->m_procedures = (opj_procedure*)opj_calloc(OPJ_VALIDATION_SIZE,
50                                  sizeof(opj_procedure));
51     if (! l_validation->m_procedures) {
52         opj_free(l_validation);
53         return 00;
54     }
55     return l_validation;
56 }
57
58 void  opj_procedure_list_destroy(opj_procedure_list_t * p_list)
59 {
60     if (! p_list) {
61         return;
62     }
63     /* initialization */
64     if (p_list->m_procedures) {
65         opj_free(p_list->m_procedures);
66     }
67     opj_free(p_list);
68 }
69
70 OPJ_BOOL opj_procedure_list_add_procedure(opj_procedure_list_t *
71         p_validation_list, opj_procedure p_procedure, opj_event_mgr_t* p_manager)
72 {
73
74     assert(p_manager != NULL);
75
76     if (p_validation_list->m_nb_max_procedures ==
77             p_validation_list->m_nb_procedures) {
78         opj_procedure * new_procedures;
79
80         p_validation_list->m_nb_max_procedures += OPJ_VALIDATION_SIZE;
81         new_procedures = (opj_procedure*)opj_realloc(
82                              p_validation_list->m_procedures,
83                              p_validation_list->m_nb_max_procedures * sizeof(opj_procedure));
84         if (! new_procedures) {
85             opj_free(p_validation_list->m_procedures);
86             p_validation_list->m_nb_max_procedures = 0;
87             p_validation_list->m_nb_procedures = 0;
88             opj_event_msg(p_manager, EVT_ERROR,
89                           "Not enough memory to add a new validation procedure\n");
90             return OPJ_FALSE;
91         } else {
92             p_validation_list->m_procedures = new_procedures;
93         }
94     }
95     p_validation_list->m_procedures[p_validation_list->m_nb_procedures] =
96         p_procedure;
97     ++p_validation_list->m_nb_procedures;
98
99     return OPJ_TRUE;
100 }
101
102 OPJ_UINT32 opj_procedure_list_get_nb_procedures(opj_procedure_list_t *
103         p_validation_list)
104 {
105     return p_validation_list->m_nb_procedures;
106 }
107
108 opj_procedure* opj_procedure_list_get_first_procedure(opj_procedure_list_t *
109         p_validation_list)
110 {
111     return p_validation_list->m_procedures;
112 }
113
114 void opj_procedure_list_clear(opj_procedure_list_t * p_validation_list)
115 {
116     p_validation_list->m_nb_procedures = 0;
117 }