• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2017-2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CLHOG_H
25 #define ARM_COMPUTE_CLHOG_H
26 
27 #include "arm_compute/core/CL/ICLHOG.h"
28 #include "arm_compute/core/CL/OpenCL.h"
29 #include "arm_compute/core/HOGInfo.h"
30 #include "arm_compute/core/Types.h"
31 
32 #include <cstdint>
33 
34 namespace arm_compute
35 {
36 /** OpenCL implementation of HOG data-object */
37 class CLHOG : public ICLHOG
38 {
39 public:
40     /** Default constructor */
41     CLHOG();
42     /** Allocate the HOG descriptor using the given HOG's metadata
43      *
44      * @param[in] input HOG's metadata used to allocate the HOG descriptor
45      */
46     void init(const HOGInfo &input);
47 
48     /** Enqueue a map operation of the allocated buffer.
49      *
50      * @param[in] blocking If true, then the mapping will be ready to use by the time
51      *                     this method returns, else it is the caller's responsibility
52      *                     to flush the queue and wait for the mapping operation to have completed.
53      */
54     void map(bool blocking = true);
55     using ICLHOG::map;
56 
57     /** Enqueue an unmap operation of the allocated and mapped buffer.
58      *
59      * @note This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before
60      *       the memory is accessed by the device.
61      */
62     void unmap();
63     using ICLHOG::unmap;
64 
65     // Inherited method overridden:
66     void              free() override;
67     const HOGInfo    *info() const override;
68     const cl::Buffer &cl_buffer() const override;
69 
70 protected:
71     // Inherited methods overridden:
72     uint8_t *do_map(cl::CommandQueue &q, bool blocking) override;
73     void do_unmap(cl::CommandQueue &q) override;
74 
75 private:
76     HOGInfo    _info;
77     cl::Buffer _buffer;
78 };
79 }
80 #endif /* ARM_COMPUTE_CLHOG_H */
81