dlib.image.fthread source code

1 /*
2 Copyright (c) 2013-2021 Timur Gafarov
3 
4 Boost Software License - Version 1.0 - August 17th, 2003
5 
6 Permission is hereby granted, free of charge, to any person or organization
7 obtaining a copy of the software and accompanying documentation covered by
8 this license (the "Software") to use, reproduce, display, distribute,
9 execute, and transmit the Software, and to prepare derivative works of the
10 Software, and to permit third-parties to whom the Software is furnished to
11 do so, all subject to the following:
12 
13 The copyright notices in the Software and this entire statement, including
14 the above license grant, this restriction and the following disclaimer,
15 must be included in all copies of the Software, in whole or in part, and
16 all derivative works of the Software, unless such copies or derivative
17 works are solely in the form of machine-executable object code generated by
18 a source language processor.
19 
20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
23 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
24 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
25 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 DEALINGS IN THE SOFTWARE.
27 */
28 
29 /**
30  * Threaded image filtering
31  *
32  * Copyright: Timur Gafarov 2013-2021.
33  * License: $(LINK2 boost.org/LICENSE_1_0.txt, Boost License 1.0).
34  * Authors: Timur Gafarov
35  */
36 module dlib.image.fthread;
37 
38 import dlib.core.memory;
39 import dlib.core.thread;
40 import dlib.image.image;
41 
42 /**
43  * An object that applies a filter function to an image in a separate thread
44  */
45 class FilteringThread
46 {
47     Thread thread;
48     protected SuperImage image;
49     protected SuperImage output;
50 
51     this(SuperImage img)
52     {
53         thread = New!Thread(&threadFunc);
54         image = img;
55         output = img;
56     }
57 
58     ~this()
59     {
60         Delete(thread);
61     }
62 
63     void threadFunc()
64     {
65         run();
66     }
67 
68     SuperImage filtered()
69     {
70         thread.start();
71         while(thread.isRunning)
72             onRunning();
73         onFinished();
74         return output;
75     }
76 
77     /// Called in a second thread. Override it
78     void run() {}
79     
80     /// Called in main thread in a loop while second thread is running. Override it
81     void onRunning() {}
82     
83     /// Called in main thread once when second thread finishes. Override it
84     void onFinished() {}
85 }