OpenJPEG  2.5.0
sparse_array.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) 2017, IntoPix SA <contact@intopix.com>
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 #ifndef OPJ_SPARSE_ARRAY_H
35 #define OPJ_SPARSE_ARRAY_H
36 
51 
54 
66 
71 
81  OPJ_UINT32 x0,
82  OPJ_UINT32 y0,
83  OPJ_UINT32 x1,
84  OPJ_UINT32 y1);
85 
103  OPJ_UINT32 x0,
104  OPJ_UINT32 y0,
105  OPJ_UINT32 x1,
106  OPJ_UINT32 y1,
107  OPJ_INT32* dest,
108  OPJ_UINT32 dest_col_stride,
109  OPJ_UINT32 dest_line_stride,
110  OPJ_BOOL forgiving);
111 
112 
130  OPJ_UINT32 x0,
131  OPJ_UINT32 y0,
132  OPJ_UINT32 x1,
133  OPJ_UINT32 y1,
134  const OPJ_INT32* src,
135  OPJ_UINT32 src_col_stride,
136  OPJ_UINT32 src_line_stride,
137  OPJ_BOOL forgiving);
138 
141 #endif /* OPJ_SPARSE_ARRAY_H */
opj_sparse_array_int32::block_count_hor
OPJ_UINT32 block_count_hor
Definition: sparse_array.c:40
opj_sparse_array_is_region_valid
OPJ_BOOL opj_sparse_array_is_region_valid(const opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1)
Returns whether region bounds are valid (non empty and within array bounds)
Definition: sparse_array.c:95
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_sparse_array_int32_read
OPJ_BOOL opj_sparse_array_int32_read(const opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1, OPJ_INT32 *dest, OPJ_UINT32 dest_col_stride, OPJ_UINT32 dest_line_stride, OPJ_BOOL forgiving)
Read the content of a rectangular region of the sparse array into a user buffer.
Definition: sparse_array.c:311
opj_uint_ceildiv
static INLINE OPJ_UINT32 opj_uint_ceildiv(OPJ_UINT32 a, OPJ_UINT32 b)
Divide an integer and round upwards.
Definition: opj_intmath.h:170
opj_sparse_array_int32::block_height
OPJ_UINT32 block_height
Definition: sparse_array.c:39
opj_sparse_array_is_region_valid
OPJ_BOOL opj_sparse_array_is_region_valid(const opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1)
Returns whether region bounds are valid (non empty and within array bounds)
Definition: sparse_array.c:95
opj_sparse_array_int32::data_blocks
OPJ_INT32 ** data_blocks
Definition: sparse_array.c:42
OPJ_BOOL
int OPJ_BOOL
Definition: openjpeg.h:116
OPJ_SIZE_T
size_t OPJ_SIZE_T
Definition: openjpeg.h:139
opj_includes.h
opj_sparse_array_int32::block_width
OPJ_UINT32 block_width
Definition: sparse_array.c:38
OPJ_INT32
int32_t OPJ_INT32
Definition: openjpeg.h:131
OPJ_RESTRICT
#define OPJ_RESTRICT
Definition: opj_includes.h:121
opj_uint_min
static INLINE OPJ_UINT32 opj_uint_min(OPJ_UINT32 a, OPJ_UINT32 b)
Get the minimum of two integers.
Definition: opj_intmath.h:65
OPJ_TRUE
#define OPJ_TRUE
Definition: openjpeg.h:117
opj_sparse_array_int32::height
OPJ_UINT32 height
Definition: sparse_array.c:37
opj_sparse_array_int32_free
void opj_sparse_array_int32_free(opj_sparse_array_int32_t *sa)
Frees a sparse array.
Definition: sparse_array.c:81
opj_free
void opj_free(void *ptr)
Deallocates or frees a memory block.
Definition: opj_malloc.c:246
opj_sparse_array_int32
Definition: sparse_array.c:35
opj_sparse_array_int32_free
void opj_sparse_array_int32_free(opj_sparse_array_int32_t *sa)
Frees a sparse array.
Definition: sparse_array.c:81
opj_sparse_array_int32_write
OPJ_BOOL opj_sparse_array_int32_write(opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1, const OPJ_INT32 *src, OPJ_UINT32 src_col_stride, OPJ_UINT32 src_line_stride, OPJ_BOOL forgiving)
Write the content of a rectangular region into the sparse array from a user buffer.
Definition: sparse_array.c:330
opj_sparse_array_int32_read
OPJ_BOOL opj_sparse_array_int32_read(const opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1, OPJ_INT32 *dest, OPJ_UINT32 dest_col_stride, OPJ_UINT32 dest_line_stride, OPJ_BOOL forgiving)
Read the content of a rectangular region of the sparse array into a user buffer.
Definition: sparse_array.c:311
opj_sparse_array_int32::block_count_ver
OPJ_UINT32 block_count_ver
Definition: sparse_array.c:41
opj_sparse_array_int32_write
OPJ_BOOL opj_sparse_array_int32_write(opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1, const OPJ_INT32 *src, OPJ_UINT32 src_col_stride, OPJ_UINT32 src_line_stride, OPJ_BOOL forgiving)
Write the content of a rectangular region into the sparse array from a user buffer.
Definition: sparse_array.c:330
OPJ_UINT32
uint32_t OPJ_UINT32
Definition: openjpeg.h:132
opj_sparse_array_int32_create
opj_sparse_array_int32_t * opj_sparse_array_int32_create(OPJ_UINT32 width, OPJ_UINT32 height, OPJ_UINT32 block_width, OPJ_UINT32 block_height)
Creates a new sparse array.
Definition: sparse_array.c:45
OPJ_FALSE
#define OPJ_FALSE
Definition: openjpeg.h:118
opj_sparse_array_int32_create
opj_sparse_array_int32_t * opj_sparse_array_int32_create(OPJ_UINT32 width, OPJ_UINT32 height, OPJ_UINT32 block_width, OPJ_UINT32 block_height)
Creates a new sparse array.
Definition: sparse_array.c:45
opj_sparse_array_int32::width
OPJ_UINT32 width
Definition: sparse_array.c:36
opj_sparse_array_int32_read_or_write
static OPJ_BOOL opj_sparse_array_int32_read_or_write(const opj_sparse_array_int32_t *sa, OPJ_UINT32 x0, OPJ_UINT32 y0, OPJ_UINT32 x1, OPJ_UINT32 y1, OPJ_INT32 *buf, OPJ_UINT32 buf_col_stride, OPJ_UINT32 buf_line_stride, OPJ_BOOL forgiving, OPJ_BOOL is_read_op)
Definition: sparse_array.c:105