annotate OrthancFramework/Sources/Images/JpegWriter.h @ 4181:b416b6bf129b

clarification of sdk doc about deadlocks
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 08 Sep 2020 09:16:33 +0200
parents bf7b9edf6b81
children 7112a8af0b63
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1654
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
10 * the License, or (at your option) any later version.
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
15 * Lesser General Public License for more details.
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4063
diff changeset
19 * <http://www.gnu.org/licenses/>.
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
2379
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
25 #if !defined(ORTHANC_ENABLE_JPEG)
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
26 # error The macro ORTHANC_ENABLE_JPEG must be defined
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
27 #endif
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
28
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
29 #if ORTHANC_ENABLE_JPEG != 1
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
30 # error JPEG support must be enabled to include this file
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
31 #endif
4900688827a8 reorganization in CMake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
32
1916
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
33 #include "IImageWriter.h"
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 namespace Orthanc
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
4063
e00f3d089991 shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
37 class ORTHANC_PUBLIC JpegWriter : public IImageWriter
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
1916
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
39 protected:
2699
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes
am@osimis.io
parents: 2447
diff changeset
40 #if ORTHANC_SANDBOXED == 0
1916
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
41 virtual void WriteToFileInternal(const std::string& filename,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
42 unsigned int width,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
43 unsigned int height,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
44 unsigned int pitch,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
45 PixelFormat format,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
46 const void* buffer);
2699
52217dc47a4e new image/pam MIME TYPE supported in /instances/../frames/../image-uint8... routes
am@osimis.io
parents: 2447
diff changeset
47 #endif
1916
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
48
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
49 virtual void WriteToMemoryInternal(std::string& jpeg,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
50 unsigned int width,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
51 unsigned int height,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
52 unsigned int pitch,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
53 PixelFormat format,
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
54 const void* buffer);
5bcf721bde4f IImageWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1915
diff changeset
55
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 private:
1654
3727a09e7b53 fix some icc warnings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1612
diff changeset
57 uint8_t quality_;
1602
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 public:
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 JpegWriter() : quality_(90)
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 }
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 void SetQuality(uint8_t quality);
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 uint8_t GetQuality() const
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 {
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 return quality_;
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 }
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 };
292bce3f54ed JpegWriter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 }