1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/************************************************************************
*
* Copyright (C) 2023-2024 IRCAD France
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <core/com/signal.hpp>
#include <core/jobs/base.hpp>
#include <io/__/service/writer.hpp>
#include <io/bitmap/writer.hpp>
// cspell:ignore nvjpeg
namespace sight::data
{
class image;
} // namespace sight::data
namespace sight::core::jobs
{
class base;
} // namespace sight::core::jobs
namespace sight::module::io::bitmap
{
/**
* @brief Bitmap Writer
*
* Service to write a bitmap to various format using sight::io::bitmap library.
*
* @copydoc sight::io::bitmap::writer
*
* @section Signals Signals
* - \b job_created(SPTR(core::jobs::base)): emitted to display a progress bar while the image is written
*
* @section XML XML Configuration
*
* @code{.xml}
<service type="sight::module::io::bitmap::writer">
<in key="data" uid="..." />
<file>...</file>
<dialog>...</dialog>
<gpu_required>true|false</gpu_required>
<mode>best|fast</mode>
</service>
@endcode
* @subsection Input Input
* - \b data [sight::data::image]: image to save.
* @subsection Configuration Configuration
* - \b file (optional): path of the file to save, if it is not defined, 'open_location_dialog()' should be called to
* define the path.
* - \b dialog(optional):
* \b description: allows to display a label in the file dialog / confirmation dialog.
* \b policy:
* - \b "never": never show the file save / extension change dialog. (DEFAULT)
* - \b "once": show only once, store the location as long as the service is started
* - \b "always": always show the location dialog / extension change dialog
* - \b gpu_required (optional): returns an error if GPU support is not enabled.
* \b mode (optional): set the mode, which defines the compression/speed ratio
* - \b "best": emphasis compression over speed
* - \b "fast": emphasis speed over compression (DEFAULT)
*/
class writer final : public sight::io::service::writer
{
public:
SIGHT_DECLARE_SERVICE(writer, sight::io::service::writer);
using job_created_signal_t = core::com::signal<void (core::jobs::base::sptr)>;
/// Trivial constructor / destructor
/// @{
writer() noexcept = default;
~writer() noexcept override = default;
/// @}
/// Show a file selection dialog
void open_location_dialog() override;
protected:
sight::io::service::path_type_t get_path_type() const override;
/// Does nothing
void starting() override;
/// Does nothing
void stopping() override;
/// Parses the configuration
void configuring() override;
/// Write the image
void updating() override;
private:
/// Retrieve the backend in the enabled backend list from the given extension
/// @param _extension the extension of the file to write
/// @return the found backend
sight::io::bitmap::backend find_backend(const std::string& _extension) const;
/// How and When display a dialog
dialog_policy m_dialog_policy {dialog_policy::never};
/// Signal emitted when job created.
job_created_signal_t::sptr m_job_created_signal {new_signal<job_created_signal_t>("job_created")};
/// Selected backend
sight::io::bitmap::backend m_selected_backend {sight::io::bitmap::backend::libtiff};
/// Enabled backends
std::map<sight::io::bitmap::backend, sight::io::bitmap::writer::mode> m_mode_by_backend {
{sight::io::bitmap::backend::libtiff, sight::io::bitmap::writer::mode::fast}
};
/// Used internally to avoid double dialog display
bool m_dialog_shown {false};
};
} // namespace sight::module::io::bitmap
|
