annotate OrthancFramework/Sources/DicomParsing/MemoryBufferTranscoder.cpp @ 5011:c014ab79fca5

fixed /move documentation + improved error reporting
author Alain Mazy <am@osimis.io>
date Tue, 31 May 2022 09:36:00 +0200
parents 43e613a7756b
children 0ea402b4d901
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
4870
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * 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: 4044
diff changeset
9 * 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: 4044
diff changeset
10 * 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: 4044
diff changeset
11 * the License, or (at your option) any later version.
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * 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: 4044
diff changeset
16 * Lesser General Public License for more details.
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * 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: 4044
diff changeset
19 * 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: 4044
diff changeset
20 * <http://www.gnu.org/licenses/>.
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "../PrecompiledHeaders.h"
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "MemoryBufferTranscoder.h"
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
4304
50b0c69b653a continued abi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4273
diff changeset
27 #include "../Logging.h"
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include "../OrthancException.h"
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include "FromDcmtkBridge.h"
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
3929
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
31 #if !defined(NDEBUG) // For debugging
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
32 # include "ParsedDicomFile.h"
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
33 #endif
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
34
4304
50b0c69b653a continued abi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4273
diff changeset
35
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 namespace Orthanc
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 {
3929
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
38 static void CheckTargetSyntax(const std::string& transcoded,
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
39 const std::set<DicomTransferSyntax>& allowedSyntaxes)
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
40 {
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
41 #if !defined(NDEBUG)
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
42 // Debug mode
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
43 ParsedDicomFile parsed(transcoded);
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
44
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
45 DicomTransferSyntax a, b;
4507
b4c58795f3a8 widening the use of DicomTransferSyntax enum
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
46 if (!const_cast<const ParsedDicomFile&>(parsed).LookupTransferSyntax(b) ||
3929
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
47 !FromDcmtkBridge::LookupOrthancTransferSyntax(a, parsed.GetDcmtkObject()) ||
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
48 a != b ||
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
49 allowedSyntaxes.find(a) == allowedSyntaxes.end())
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
50 {
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
51 throw OrthancException(
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
52 ErrorCode_Plugin,
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
53 "DEBUG - The transcoding plugin has not written to one of the allowed transfer syntaxes");
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
54 }
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
55 #endif
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
56 }
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
57
7dc5e7e0045d simplifying MemoryBufferTranscoder::Transcode() interface
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3910
diff changeset
58
3944
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
59 bool MemoryBufferTranscoder::Transcode(DicomImage& target,
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
60 DicomImage& source,
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
61 const std::set<DicomTransferSyntax>& allowedSyntaxes,
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
62 bool allowNewSopInstanceUid)
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
63 {
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
64 target.Clear();
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
65
3946
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
66 #if !defined(NDEBUG)
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
67 // Don't run this code in release mode, as it implies parsing the DICOM file
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
68 DicomTransferSyntax sourceSyntax;
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
69 if (!FromDcmtkBridge::LookupOrthancTransferSyntax(sourceSyntax, source.GetParsed()))
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
70 {
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
71 LOG(ERROR) << "Unsupport transfer syntax for transcoding";
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
72 return false;
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
73 }
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
74
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
75 const std::string sourceSopInstanceUid = GetSopInstanceUid(source.GetParsed());
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
76 #endif
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
77
3944
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
78 std::string buffer;
3951
5fe8c6d3212e removed useless information "hasSopInstanceUidChanged"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3946
diff changeset
79 if (TranscodeBuffer(buffer, source.GetBufferData(), source.GetBufferSize(),
5fe8c6d3212e removed useless information "hasSopInstanceUidChanged"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3946
diff changeset
80 allowedSyntaxes, allowNewSopInstanceUid))
3944
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
81 {
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
82 CheckTargetSyntax(buffer, allowedSyntaxes); // For debug only
3946
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
83
3944
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
84 target.AcquireBuffer(buffer);
3946
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
85
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
86 #if !defined(NDEBUG)
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
87 // Only run the sanity check in debug mode
3951
5fe8c6d3212e removed useless information "hasSopInstanceUidChanged"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3946
diff changeset
88 CheckTranscoding(target, sourceSyntax, sourceSopInstanceUid,
3946
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
89 allowedSyntaxes, allowNewSopInstanceUid);
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
90 #endif
1f33ed7f82e6 automatic test of transcoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3945
diff changeset
91
3944
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
92 return true;
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
93 }
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
94 else
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
95 {
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
96 return false;
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
97 }
aae045f802f4 preparing simplified interface for IDicomTranscoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3930
diff changeset
98 }
3893
7a5fa8f307e9 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 }