sparse_array.h

Go to the documentation of this file.

/*
 *    Copyright (C) 2016-2020 Grok Image Compression Inc.
 *
 *    This source code is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This source code is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 *    This source code incorporates work covered by the following copyright and
 *    permission notice:
 *
 * The copyright in this software is being made available under the 2-clauses
 * BSD License, included below. This software may be subject to other third
 * party and contributor rights, including patent rights, and no such rights
 * are granted under this license.
 *
 * Copyright (c) 2017, IntoPix SA <contact@intopix.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#pragma once
 
 
namespace grk {
 
class sparse_array {
 
public:
 
        sparse_array(uint32_t width,
                                        uint32_t height,
                                        uint32_t block_width,
                                        uint32_t block_height);
 
        ~sparse_array();
 
        bool read(uint32_t x0,
                         uint32_t y0,
                         uint32_t x1,
                         uint32_t y1,
                         int32_t* dest,
                         const uint32_t dest_col_stride,
                         const uint32_t dest_line_stride,
                         bool forgiving);
 
        bool read(grk_rect_u32 region,
                         int32_t* dest,
                         const uint32_t dest_col_stride,
                         const uint32_t dest_line_stride,
                         bool forgiving);
 
 
        bool write(uint32_t x0,
                          uint32_t y0,
                          uint32_t x1,
                          uint32_t y1,
                          const int32_t* src,
                          const uint32_t src_col_stride,
                          const uint32_t src_line_stride,
                          bool forgiving);
 
        bool alloc(              uint32_t x0,
                                                          uint32_t y0,
                                                          uint32_t x1,
                                                          uint32_t y1);
 
private:
 
        bool is_region_valid(   uint32_t x0,
                                                        uint32_t y0,
                                                        uint32_t x1,
                                                        uint32_t y1);
 
        bool read_or_write(uint32_t x0,
                                                uint32_t y0,
                                                uint32_t x1,
                                                uint32_t y1,
                                                int32_t* buf,
                                                const uint32_t buf_col_stride,
                                                const uint32_t buf_line_stride,
                                                bool forgiving,
                                                bool is_read_op);
 
        uint32_t width;
    uint32_t height;
    uint32_t block_width;
    uint32_t block_height;
    uint32_t block_count_hor;
    uint32_t block_count_ver;
    int32_t** data_blocks;
};
 
}