02d05671ed7459188a0bf16868be379c29274150
[libdcp.git] / asdcplib / src / JP2K_Codestream_Parser.cpp
1 /*
2 Copyright (c) 2004-2009, John Hurst
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
7 are met:
8 1. Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright
11    notice, this list of conditions and the following disclaimer in the
12    documentation and/or other materials provided with the distribution.
13 3. The name of the author may not be used to endorse or promote products
14    derived from this software without specific prior written permission.
15
16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 /*! \file    Codestream_Parser.cpp
28     \version $Id: JP2K_Codestream_Parser.cpp,v 1.7 2009/04/09 19:16:49 msheby Exp $
29     \brief   AS-DCP library, JPEG 2000 codestream essence reader implementation
30 */
31
32 #include <KM_fileio.h>
33 #include <AS_DCP.h>
34 #include <JP2K.h>
35 #include <assert.h>
36 #include <KM_log.h>
37 using Kumu::DefaultLogSink;
38
39 //------------------------------------------------------------------------------------------
40
41 class ASDCP::JP2K::CodestreamParser::h__CodestreamParser
42 {
43   ASDCP_NO_COPY_CONSTRUCT(h__CodestreamParser);
44
45 public:
46   PictureDescriptor  m_PDesc;
47   Kumu::FileReader   m_File;
48
49   h__CodestreamParser()
50   {
51     memset(&m_PDesc, 0, sizeof(m_PDesc));
52     m_PDesc.EditRate = Rational(24,1);
53     m_PDesc.SampleRate = m_PDesc.EditRate;
54   }
55
56   ~h__CodestreamParser() {}
57
58   Result_t OpenReadFrame(const char* filename, FrameBuffer& FB)
59   {
60     ASDCP_TEST_NULL_STR(filename);
61     m_File.Close();
62     Result_t result = m_File.OpenRead(filename);
63
64     if ( ASDCP_SUCCESS(result) )
65       {
66         Kumu::fsize_t file_size = m_File.Size();
67
68         if ( FB.Capacity() < file_size )
69           {
70             DefaultLogSink().Error("FrameBuf.Capacity: %u frame length: %u\n", FB.Capacity(), (ui32_t)file_size);
71             return RESULT_SMALLBUF;
72           }
73       }
74
75     ui32_t read_count;
76
77     if ( ASDCP_SUCCESS(result) )
78       result = m_File.Read(FB.Data(), FB.Capacity(), &read_count);
79
80     if ( ASDCP_SUCCESS(result) )
81       FB.Size(read_count);
82
83     if ( ASDCP_SUCCESS(result) )
84       {
85         byte_t start_of_data = 0; // out param
86         result = ParseMetadataIntoDesc(FB, m_PDesc, &start_of_data);
87
88         if ( ASDCP_SUCCESS(result) )
89           FB.PlaintextOffset(start_of_data);
90       }
91
92     return result;
93   }
94 };
95
96 ASDCP::Result_t
97 ASDCP::JP2K::ParseMetadataIntoDesc(const FrameBuffer& FB, PictureDescriptor& PDesc, byte_t* start_of_data)
98 {
99   Result_t result = RESULT_OK;
100   Marker NextMarker;
101   ui32_t i;
102   const byte_t* p = FB.RoData();
103   const byte_t* end_p = p + FB.Size();
104
105   while ( p < end_p && ASDCP_SUCCESS(result) )
106     {
107       result = GetNextMarker(&p, NextMarker);
108
109       if ( ASDCP_FAILURE(result) )
110         {
111           result = RESULT_RAW_ESS;
112           break;
113         }
114
115       switch ( NextMarker.m_Type )
116         {
117         case MRK_SOD:
118           if ( start_of_data != 0 )
119             *start_of_data = p - FB.RoData();
120
121           p = end_p;
122           break;
123
124         case MRK_SIZ:
125           {
126             Accessor::SIZ SIZ_(NextMarker);
127             PDesc.StoredWidth = SIZ_.Xsize();
128             PDesc.StoredHeight = SIZ_.Ysize();
129             PDesc.AspectRatio = Rational(SIZ_.Xsize(), SIZ_.Ysize());
130             PDesc.Rsize = SIZ_.Rsize();
131             PDesc.Xsize = SIZ_.Xsize();
132             PDesc.Ysize = SIZ_.Ysize();
133             PDesc.XOsize = SIZ_.XOsize();
134             PDesc.YOsize = SIZ_.YOsize();
135             PDesc.XTsize = SIZ_.XTsize();
136             PDesc.YTsize = SIZ_.YTsize();
137             PDesc.XTOsize = SIZ_.XTOsize();
138             PDesc.YTOsize = SIZ_.YTOsize();
139             PDesc.Csize = SIZ_.Csize();
140
141             if ( PDesc.Csize != 3 )
142               {
143                 DefaultLogSink().Error("Unexpected number of components: %u\n", PDesc.Csize);
144                 return RESULT_RAW_FORMAT;
145               }
146             
147             for ( i = 0; i < PDesc.Csize; i++ )
148               SIZ_.ReadComponent(i, PDesc.ImageComponents[i]);
149           }
150           break;
151
152         case MRK_COD:
153           memset(&PDesc.CodingStyleDefault, 0, sizeof(CodingStyleDefault_t));
154
155           if ( NextMarker.m_DataSize > sizeof(CodingStyleDefault_t) )
156             {
157               DefaultLogSink().Error("Unexpectedly large CodingStyle data: %u\n", NextMarker.m_DataSize);
158               return RESULT_RAW_FORMAT;
159             }
160           
161           memcpy(&PDesc.CodingStyleDefault, NextMarker.m_Data, NextMarker.m_DataSize);
162           break;
163
164         case MRK_QCD:
165           memset(&PDesc.QuantizationDefault, 0, sizeof(QuantizationDefault_t));
166
167           if ( NextMarker.m_DataSize < 16 )
168             {
169               DefaultLogSink().Error("No quantization signaled\n");
170               return RESULT_RAW_FORMAT;
171             }
172           
173           if ( NextMarker.m_DataSize > MaxDefaults )
174             {
175               DefaultLogSink().Error("Quantization Default length exceeds maximum %d\n", NextMarker.m_DataSize);
176               return RESULT_RAW_FORMAT;
177             }
178
179           memcpy(&PDesc.QuantizationDefault, NextMarker.m_Data, NextMarker.m_DataSize);
180           PDesc.QuantizationDefault.SPqcdLength = NextMarker.m_DataSize - 1;
181           break;
182         }
183     }
184
185   return result;
186 }
187
188 //------------------------------------------------------------------------------------------
189
190 ASDCP::JP2K::CodestreamParser::CodestreamParser()
191 {
192 }
193
194 ASDCP::JP2K::CodestreamParser::~CodestreamParser()
195 {
196 }
197
198 // Opens the stream for reading, parses enough data to provide a complete
199 // set of stream metadata for the MXFWriter below.
200 ASDCP::Result_t
201 ASDCP::JP2K::CodestreamParser::OpenReadFrame(const char* filename, FrameBuffer& FB) const
202 {
203   const_cast<ASDCP::JP2K::CodestreamParser*>(this)->m_Parser = new h__CodestreamParser;
204   return m_Parser->OpenReadFrame(filename, FB);
205 }
206
207 //
208 ASDCP::Result_t
209 ASDCP::JP2K::CodestreamParser::FillPictureDescriptor(PictureDescriptor& PDesc) const
210 {
211   if ( m_Parser.empty() )
212     return RESULT_INIT;
213
214   PDesc = m_Parser->m_PDesc;
215   return RESULT_OK;
216 }
217
218
219 //
220 // end Codestream_Parser.cpp
221 //