Improve error diagnostic in timed text parser
[asdcplib.git] / src / TimedText_Parser.cpp
index 2519669a43ed04b90cd67602fdbb9375914c2a7f..ff53e6748c1776434756c42656c485ee4ad62681 100644 (file)
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2007-2009, John Hurst
+Copyright (c) 2007-2014, John Hurst
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -44,50 +44,65 @@ const char* c_dcst_namespace_name = "http://www.smpte-ra.org/schemas/428-7/2007/
 //------------------------------------------------------------------------------------------
 
 
+ASDCP::TimedText::LocalFilenameResolver::LocalFilenameResolver() {}
+ASDCP::TimedText::LocalFilenameResolver::~LocalFilenameResolver() {}
 
-class FilenameResolver : public ASDCP::TimedText::IResourceResolver
+//
+Result_t
+ASDCP::TimedText::LocalFilenameResolver::OpenRead(const std::string& dirname)
 {
-  std::string m_Dirname;
-
-  FilenameResolver();
-  bool operator==(const FilenameResolver&);
+  if ( PathIsDirectory(dirname) )
+    {
+      m_Dirname = dirname;
+      return RESULT_OK;
+    }
 
-public:
-  FilenameResolver(const std::string& dirname)
-  {
-    if ( PathIsDirectory(dirname) )
-      {
-       m_Dirname = dirname;
-       return;
-      }
+  DefaultLogSink().Error("Path '%s' is not a directory, defaulting to '.'\n", dirname.c_str());
+  m_Dirname = ".";
+  return RESULT_FALSE;
+}
 
-    DefaultLogSink().Error("Path '%s' is not a directory, defaulting to '.'\n", dirname.c_str());
-    m_Dirname = ".";
-  }
+//
+Result_t
+ASDCP::TimedText::LocalFilenameResolver::ResolveRID(const byte_t* uuid, TimedText::FrameBuffer& FrameBuf) const
+{
+  Result_t result = RESULT_NOT_FOUND;
+  char buf[64];
+  UUID RID(uuid);
+  PathList_t found_list;
 
-  //
-  Result_t ResolveRID(const byte_t* uuid, TimedText::FrameBuffer& FrameBuf) const
-  {
-    FileReader Reader;
-    char buf[64];
-    UUID RID(uuid);
-    std::string filename = m_Dirname + "/" + RID.EncodeHex(buf, 64);
-    DefaultLogSink().Debug("retrieving resource %s from file %s\n", buf, filename.c_str());
+#ifndef KM_WIN32
+  // TODO, fix this for win32 (needs regex)
+  FindInPath(PathMatchRegex(RID.EncodeHex(buf, 64)), m_Dirname, found_list);
+#endif
 
-    Result_t result = Reader.OpenRead(filename.c_str());
+  if ( found_list.size() == 1 )
+    {
+      FileReader Reader;
+      DefaultLogSink().Debug("Retrieving resource %s from file %s\n", buf, found_list.front().c_str());
 
-    if ( KM_SUCCESS(result) )
-      {
-       ui32_t read_count = 0;
-       result = Reader.Read(FrameBuf.Data(), FrameBuf.Capacity(), &read_count);
+      result = Reader.OpenRead(found_list.front().c_str());
 
-       if ( KM_SUCCESS(result) )
-         FrameBuf.Size(read_count);
-      }
+      if ( KM_SUCCESS(result) )
+       {
+         ui32_t read_count, read_size = Reader.Size();
+         result = FrameBuf.Capacity(read_size);
+      
+         if ( KM_SUCCESS(result) )
+           result = Reader.Read(FrameBuf.Data(), read_size, &read_count);
+
+         if ( KM_SUCCESS(result) )
+           FrameBuf.Size(read_count);
+       }
+    }
+  else if ( ! found_list.empty() )
+    {
+      DefaultLogSink().Error("More than one file in %s matches %s.\n", m_Dirname.c_str(), buf);
+      result = RESULT_RAW_FORMAT;
+    }
 
-    return result;
-  }
-};
+  return result;
+}
 
 //------------------------------------------------------------------------------------------
 
@@ -97,6 +112,7 @@ class ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser
 {
   XMLElement  m_Root;
   ResourceTypeMap_t m_ResourceTypes;
+  Result_t OpenRead();
 
   ASDCP_NO_COPY_CONSTRUCT(h__SubtitleParser);
 
@@ -104,7 +120,7 @@ public:
   std::string m_Filename;
   std::string m_XMLDoc;
   TimedTextDescriptor  m_TDesc;
-  mem_ptr<FilenameResolver> m_DefaultResolver;
+  mem_ptr<LocalFilenameResolver> m_DefaultResolver;
 
   h__SubtitleParser() : m_Root("**ParserRoot**")
   {
@@ -116,12 +132,16 @@ public:
   TimedText::IResourceResolver* GetDefaultResolver()
   {
     if ( m_DefaultResolver.empty() )
-      m_DefaultResolver = new FilenameResolver(PathDirname(m_Filename));
-    
+      {
+       m_DefaultResolver = new LocalFilenameResolver();
+       m_DefaultResolver->OpenRead(PathDirname(m_Filename));
+      }
+
     return m_DefaultResolver;
   }
 
-  Result_t OpenRead(const char* filename);
+  Result_t OpenRead(const std::string& filename);
+  Result_t OpenRead(const std::string& xml_doc, const std::string& filename);
   Result_t ReadAncillaryResource(const byte_t* uuid, FrameBuffer& FrameBuf, const IResourceResolver& Resolver) const;
 };
 
@@ -131,7 +151,12 @@ get_UUID_from_element(XMLElement* Element, UUID& ID)
 {
   assert(Element);
   const char* p = Element->GetBody().c_str();
-  if ( strncmp(p, "urn:uuid:", 9) == 0 )    p += 9;
+
+  if ( strncmp(p, "urn:uuid:", 9) == 0 )
+    {
+      p += 9;
+    }
+  
   return ID.DecodeHex(p);
 }
 
@@ -139,40 +164,56 @@ get_UUID_from_element(XMLElement* Element, UUID& ID)
 bool
 get_UUID_from_child_element(const char* name, XMLElement* Parent, UUID& outID)
 {
-  assert(name); assert(Parent);
+  assert(name);
+  assert(Parent);
   XMLElement* Child = Parent->GetChildWithName(name);
-  if ( Child == 0 )    return false;
+
+  if ( Child == 0 )
+    {
+      return false;
+    }
+
   return get_UUID_from_element(Child, outID);
 }
 
 //
-static ASDCP::Rational
-decode_rational(const char* str_rat)
+Result_t
+ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const std::string& filename)
 {
-  assert(str_rat);
-  ui32_t Num = atoi(str_rat);
-  ui32_t Den = 0;
+  Result_t result = ReadFileIntoString(filename, m_XMLDoc);
 
-  const char* den_str = strrchr(str_rat, ' ');
-  if ( den_str != 0 )
-    Den = atoi(den_str+1);
+  if ( KM_SUCCESS(result) )
+    result = OpenRead();
 
-  return ASDCP::Rational(Num, Den);
+  m_Filename = filename;
+  return result;
 }
 
 //
 Result_t
-ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* filename)
+ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const std::string& xml_doc, const std::string& filename)
 {
-  Result_t result = ReadFileIntoString(filename, m_XMLDoc);
+  m_XMLDoc = xml_doc;
 
-  if ( KM_FAILURE(result) )
-    return result;
+  if ( filename.empty() )
+    {
+      m_Filename = "<string>";
+    }
+  else
+    {
+      m_Filename = filename;
+    }
+
+  return OpenRead();
+}
 
-  if ( ! m_Root.ParseString(m_XMLDoc.c_str()) )
+//
+Result_t
+ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead()
+{
+  if ( ! m_Root.ParseString(m_XMLDoc) )
     return RESULT_FORMAT;
 
-  m_Filename = filename;
   m_TDesc.EncodingName = "UTF-8"; // the XML parser demands UTF-8
   m_TDesc.ResourceList.clear();
   m_TDesc.ContainerDuration = 0;
@@ -180,16 +221,18 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* file
 
   if ( ns == 0 )
     {
-      DefaultLogSink(). Warn("Document has no namespace name, assuming %s\n", c_dcst_namespace_name);
+      DefaultLogSink(). Warn("Document has no namespace name, assuming \"%s\".\n", c_dcst_namespace_name);
       m_TDesc.NamespaceName = c_dcst_namespace_name;
     }
   else
-    m_TDesc.NamespaceName = ns->Name();
+    {
+      m_TDesc.NamespaceName = ns->Name();
+    }
 
   UUID DocID;
   if ( ! get_UUID_from_child_element("Id", &m_Root, DocID) )
     {
-      DefaultLogSink(). Error("Id element missing from input document\n");
+      DefaultLogSink(). Error("Id element missing from input document.\n");
       return RESULT_FORMAT;
     }
 
@@ -198,15 +241,32 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* file
 
   if ( EditRate == 0 )
     {
-      DefaultLogSink(). Error("EditRate element missing from input document\n");
+      DefaultLogSink().Error("EditRate element missing from input document.\n");
       return RESULT_FORMAT;
     }
 
-  m_TDesc.EditRate = decode_rational(EditRate->GetBody().c_str());
+  if ( ! DecodeRational(EditRate->GetBody().c_str(), m_TDesc.EditRate) )
+    {
+      DefaultLogSink().Error("Error decoding edit rate value: \"%s\"\n", EditRate->GetBody().c_str());
+      return RESULT_FORMAT;
+    }
 
-  if ( m_TDesc.EditRate != EditRate_24 && m_TDesc.EditRate != EditRate_48 )
+  if ( m_TDesc.EditRate != EditRate_23_98
+       && m_TDesc.EditRate != EditRate_24
+       && m_TDesc.EditRate != EditRate_25
+       && m_TDesc.EditRate != EditRate_30
+       && m_TDesc.EditRate != EditRate_48
+       && m_TDesc.EditRate != EditRate_50
+       && m_TDesc.EditRate != EditRate_60
+       && m_TDesc.EditRate != EditRate_96
+       && m_TDesc.EditRate != EditRate_100
+       && m_TDesc.EditRate != EditRate_120
+       && m_TDesc.EditRate != EditRate_192
+       && m_TDesc.EditRate != EditRate_200
+       && m_TDesc.EditRate != EditRate_240 )
     {
-      DefaultLogSink(). Error("EditRate must be 24/1 or 48/1\n");
+      DefaultLogSink(). Error("Unexpected EditRate: %d/%d\n",
+                             m_TDesc.EditRate.Numerator, m_TDesc.EditRate.Denominator);
       return RESULT_FORMAT;
     }
 
@@ -233,6 +293,7 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* file
   // list of images
   ElementList ImageList;
   m_Root.GetChildrenWithName("Image", ImageList);
+  std::set<Kumu::UUID> visited_items;
 
   for ( Elem_i i = ImageList.begin(); i != ImageList.end(); i++ )
     {
@@ -243,11 +304,15 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* file
          return RESULT_FORMAT;
        }
 
-      TimedTextResourceDescriptor TmpResource;
-      memcpy(TmpResource.ResourceID, AssetID.Value(), UUIDlen);
-      TmpResource.Type = MT_PNG;
-      m_TDesc.ResourceList.push_back(TmpResource);
-      m_ResourceTypes.insert(ResourceTypeMap_t::value_type(UUID(TmpResource.ResourceID), MT_PNG));
+      if ( visited_items.find(AssetID) == visited_items.end() )
+       {
+         TimedTextResourceDescriptor TmpResource;
+         memcpy(TmpResource.ResourceID, AssetID.Value(), UUIDlen);
+         TmpResource.Type = MT_PNG;
+         m_TDesc.ResourceList.push_back(TmpResource);
+         m_ResourceTypes.insert(ResourceTypeMap_t::value_type(UUID(TmpResource.ResourceID), MT_PNG));
+         visited_items.insert(AssetID);
+       }
     }
 
   // Calculate the timeline duration.
@@ -267,11 +332,11 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* file
       return RESULT_FORMAT;
     }
 
-  // assumes 24/1 or 48/1 as constrained above
-  assert(m_TDesc.EditRate.Denominator == 1);
+  // assumes edit rate is constrained above
+  ui32_t TCFrameRate = ( m_TDesc.EditRate == EditRate_23_98  ) ? 24 : m_TDesc.EditRate.Numerator;
 
   S12MTimecode beginTC;
-  beginTC.SetFPS(m_TDesc.EditRate.Numerator);
+  beginTC.SetFPS(TCFrameRate);
   XMLElement* StartTime = m_Root.GetChildWithName("StartTime");
 
   if ( StartTime != 0 )
@@ -279,7 +344,7 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::OpenRead(const char* file
 
   for ( ei = InstanceList.begin(); ei != InstanceList.end(); ei++ )
     {
-      S12MTimecode tmpTC((*ei)->GetAttrWithName("TimeOut"), m_TDesc.EditRate.Numerator);
+      S12MTimecode tmpTC((*ei)->GetAttrWithName("TimeOut"), TCFrameRate);
       if ( end_count < tmpTC.GetFrames() )
        end_count = tmpTC.GetFrames();
     }
@@ -315,17 +380,23 @@ ASDCP::TimedText::DCSubtitleParser::h__SubtitleParser::ReadAncillaryResource(con
 
   Result_t result = Resolver.ResolveRID(uuid, FrameBuf);
 
+  std::string resourceType;
+  if ( (*rmi).second == MT_PNG )
+    resourceType = "image/png";
+  else if ( (*rmi).second == MT_OPENTYPE )
+    resourceType = "application/x-font-opentype";
+  else
+    resourceType = "application/octet-stream";
+
   if ( KM_SUCCESS(result) )
     {
-      if ( (*rmi).second == MT_PNG )
-       FrameBuf.MIMEType("image/png");
-             
-      else if ( (*rmi).second == MT_OPENTYPE )
-       FrameBuf.MIMEType("application/x-font-opentype");
-
-      else
-       FrameBuf.MIMEType("application/octet-stream");
+      FrameBuf.MIMEType(resourceType);
     }
+  else
+    {
+      DefaultLogSink().Error("Resource not found: %s (%s)\n", TmpID.EncodeHex(buf, 64), resourceType.c_str());
+    }
+    
 
   return result;
 }
@@ -343,7 +414,7 @@ ASDCP::TimedText::DCSubtitleParser::~DCSubtitleParser()
 // Opens the stream for reading, parses enough data to provide a complete
 // set of stream metadata for the MXFWriter below.
 ASDCP::Result_t
-ASDCP::TimedText::DCSubtitleParser::OpenRead(const char* filename) const
+ASDCP::TimedText::DCSubtitleParser::OpenRead(const std::string& filename) const
 {
   const_cast<ASDCP::TimedText::DCSubtitleParser*>(this)->m_Parser = new h__SubtitleParser;
 
@@ -355,6 +426,20 @@ ASDCP::TimedText::DCSubtitleParser::OpenRead(const char* filename) const
   return result;
 }
 
+// Parses an XML document to provide a complete set of stream metadata for the MXFWriter below.
+Result_t
+ASDCP::TimedText::DCSubtitleParser::OpenRead(const std::string& xml_doc, const std::string& filename) const
+{
+  const_cast<ASDCP::TimedText::DCSubtitleParser*>(this)->m_Parser = new h__SubtitleParser;
+
+  Result_t result = m_Parser->OpenRead(xml_doc, filename);
+
+  if ( ASDCP_FAILURE(result) )
+    const_cast<ASDCP::TimedText::DCSubtitleParser*>(this)->m_Parser = 0;
+
+  return result;
+}
+
 //
 ASDCP::Result_t
 ASDCP::TimedText::DCSubtitleParser::FillTimedTextDescriptor(TimedTextDescriptor& TDesc) const
@@ -393,5 +478,5 @@ ASDCP::TimedText::DCSubtitleParser::ReadAncillaryResource(const byte_t* uuid, Fr
 
 
 //
-// end AS_DCP_timedText.cpp
+// end AS_DCP_TimedTextParser.cpp
 //