Merge pull request #9 from nelinory/development

Development to Main

Author: nelinory

README.md

@@ -12,8 +12,8 @@ SupernoteSharp is an unofficial library for Supernote paper-like tablet by Ratta
 This project is heavily inspired by https://github.com/jya-dev/supernote-tool.
 
 ### Supported file formats
-- `*.note` file created on Supernote A5X/A6X (firmware Chauvet 2.8.22)
-- `*.mark` pdf annotations created on Supernote A5X/A6X (firmware Chauvet 2.8.22)
+- `*.note` file created on Supernote A5X/A6X (firmware Chauvet 2.9.24)
+- `*.mark` pdf annotations created on Supernote A5X/A6X (firmware Chauvet 2.9.24)
 
 ### Key Features - A5X/A6X models only
 - Export `*.note`/`*.mark` file structure (metadata)

SupernoteSharp/A5X_Metadata_Schema.md

@@ -16,16 +16,20 @@ header
 	"FILE_ID"
 	"FILE_RECOGN_TYPE"
 	"FILE_RECOGN_LANGUAGE"
+    "PDFSTYLE" - "none" means no PDF template is used
+    "PDFSTYLEMD5" - 0 means no PDF template is used
+    "STYLEUSAGETYPE" - 0 means normal style (IMAGE), 2 is PDF template as style (PDF)
 footer
 	"PAGEXXXX" [..] - max pages 9999
 	"TITLE_XXXX" [..]
 	"KEYWORD_XXXX" [..]
+	"COVER_X" - COVER_1 means there is cover, COVER_0 means no cover
+	"DIRTY"
 	"LINKO_XXXX" [..] - outbound links
 	"LINKI_XXXX" [..] - inbound links
-	"STYLE_XXXX" [..]
-	"COVER_1" - COVER_1 means there is cover, COVER_0 means no cover
-	"DIRTY"
 	"FILE_FEATURE"
+    "PDFSTYLELIST"
+	"STYLE_XXXX" [..]
 	keywords []
 		"KEYWORDPAGE"
 		"KEYWORDSEQNO"
@@ -72,6 +76,7 @@ pages
 	"RECOGNTYPE"
 	"RECOGNFILESTATUS"
 	"RECOGNLANGUAGE"
+	"EXTERNALLINKINFO"
 	"FIVESTAR" []
 	layers [] - max 5 layers supported
 		"LAYERTYPE"

SupernoteSharp/AssemblyInfo.cs

@@ -1,6 +1,6 @@
 using System.Reflection;
 
-[assembly: AssemblyVersion("0.6.*")]
+[assembly: AssemblyVersion("0.7.*")]
 [assembly: AssemblyTitle("SupernoteSharp")]
 [assembly: AssemblyProduct("SupernoteSharp")]
-[assembly: AssemblyCopyright("Copyright © nelinory 2023")]
+[assembly: AssemblyCopyright("Copyright © nelinory 2024")]

SupernoteSharp/Business/Converter.cs

@@ -338,9 +338,12 @@ public byte[] ConvertAll(bool vectorize = false, bool enableLinks = false)
             private byte[] CreatePdf(Dictionary<int, VectSharp.Page> pdfPages, bool enableLinks)
             {
                 // add links if requested
-                Dictionary<string, string> links = null;
+                Dictionary<string, string> links = new Dictionary<string, string>();
                 if (enableLinks == true)
-                    links = AddLinks(pdfPages);
+                {
+                    AddLinks(pdfPages, _notebook.Links, links);
+                    AddLinks(pdfPages, _notebook.TemplateLinks, links);
+                }
 
                 // create the final pdf document
                 Document pdfDocument = new Document();
@@ -353,11 +356,8 @@ private byte[] CreatePdf(Dictionary<int, VectSharp.Page> pdfPages, bool enableLi
                 }
             }
 
-            private Dictionary<string, string> AddLinks(Dictionary<int, VectSharp.Page> pdfPages)
+            private Dictionary<string, string> AddLinks(Dictionary<int, VectSharp.Page> pdfPages, List<Link> noteLinks, Dictionary<string, string> links)
             {
-                List<Link> noteLinks = _notebook.Links;
-                Dictionary<string, string> links = new Dictionary<string, string>();
-
                 foreach (KeyValuePair<int, VectSharp.Page> kvp in pdfPages)
                 {
                     // get all outbound links for the current page
@@ -369,7 +369,7 @@ private Dictionary<string, string> AddLinks(Dictionary<int, VectSharp.Page> pdfP
                     List<Link> webLinks = outboundLinks.Where(x => x.Type == (int)LinkType.Web).ToList();
                     foreach (Link webLink in webLinks)
                     {
-                        string webLinkTag = $"WebLink_{webLink.Metadata["LINKBITMAP"]}";
+                        string webLinkTag = $"WebLink_{webLink.Bitmap}";
                         string webLinkUrl = Encoding.UTF8.GetString(System.Convert.FromBase64String(webLink.FilePath));
 
                         kvp.Value.Graphics.StrokeRectangle(webLink.Rect.left, webLink.Rect.top, webLink.Rect.width, webLink.Rect.height,
@@ -392,8 +392,8 @@ private Dictionary<string, string> AddLinks(Dictionary<int, VectSharp.Page> pdfP
                             // each internal link is a pair of outbound and inbound, they have the same timestamp and rect coordinates
                             Link targetLink = noteLinks.Where(x => x.InOut == (int)LinkDirection.In && x.Timestamp == sourceLink.Timestamp && x.Rect.Equals(sourceLink.Rect)).FirstOrDefault();
 
-                            string sourceLinkTag = $"SourceLink_{sourceLink.Metadata["LINKBITMAP"]}";
-                            string targetLinkTag = $"TargetLink_{targetLink.Metadata["LINKBITMAP"]}";
+                            string sourceLinkTag = $"SourceLink_{sourceLink.Bitmap}";
+                            string targetLinkTag = $"TargetLink_{targetLink.Bitmap}";
 
                             pdfPages[sourceLink.PageNumber].Graphics.StrokeRectangle(sourceLink.Rect.left, sourceLink.Rect.top, sourceLink.Rect.width, sourceLink.Rect.height,
                                                                                                 Colour.FromRgba(0, 0, 0, 0), tag: sourceLinkTag);

SupernoteSharp/Business/Decoder.cs

@@ -146,14 +146,12 @@ internal class RattaRleDecoder : IBaseDecoder
                     Queue<(byte, int)> waiting = new Queue<(byte, int)>();
                     while (true)
                     {
-                        byte colorcode = bin.MoveNext() ? bin.Current : (byte)0;
-                        int length = bin.MoveNext() ? bin.Current : 0;
+                        bin.MoveNext();
+                        byte colorcode = bin.Current;
+                        bin.MoveNext();
+                        int length = bin.Current;
                         bool dataPushed = false;
 
-                        // we reach the end of the enumeration due to colorcode being 0
-                        if (colorcode == 0)
-                            break;
-
                         if (holder.Item2 > 0)
                         {
                             (byte prevColorcode, int prevLength) = holder;

SupernoteSharp/Business/Parser.cs

@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text;
 
 namespace SupernoteSharp.Business
 {
@@ -104,6 +105,25 @@ public Notebook LoadNotebook(FileStream fileStream, Policy policy)
                 int recognTextAddress = metadata.Pages[i].ContainsKey("RECOGNTEXT") == true ? Int32.Parse((string)metadata.Pages[i]["RECOGNTEXT"]) : 0;
                 if (recognTextAddress > 0)
                     notebook.Pages[i].RecognText = GetContentAtAddress(fileStream, recognTextAddress);
+
+                // attach external link info
+                int externalLinkInfoAddress = metadata.Pages[i].ContainsKey("EXTERNALLINKINFO") == true ? Int32.Parse((string)metadata.Pages[i]["EXTERNALLINKINFO"]) : 0;
+                if (externalLinkInfoAddress > 0)
+                    notebook.Pages[i].ExternalLinkInfo = GetContentAtAddress(fileStream, externalLinkInfoAddress);
+            }
+
+            // attach template link data
+            List<Page> pagesWithTemplateLinks = notebook.Pages.Where(x => x.ExternalLinkInfo != null).ToList();
+            foreach (Page page in pagesWithTemplateLinks)
+            {
+                // ExternalLinkInfo contains multiple links separated by a '|' character
+                string[] links = Encoding.UTF8.GetString(page.ExternalLinkInfo).Split("|", StringSplitOptions.RemoveEmptyEntries);
+                foreach (string link in links)
+                {
+                    // each link properties are separated by a ',' character
+                    string[] linkProperties = link.Split(",", StringSplitOptions.RemoveEmptyEntries);
+                    notebook.TemplateLinks.AddRange(GetTemplateLink(linkProperties, notebook.FileId));
+                }
             }
 
             return notebook;
@@ -142,20 +162,11 @@ private List<int> GetPageNumberFromFooterProperty(Dictionary<string, object> foo
             IEnumerable<string> propertyKeys = footer.Keys.Where(p => p.StartsWith(propertyPrefix));
             foreach (string property in propertyKeys)
             {
-                if (footer[property].GetType() != typeof(string))
-                {
-                    // TODO: Need Supernote A5 test note
-                    /*
-                    if type(footer[k]) == list:
-                        for _ in range(len(footer[k])):
-                            page_numbers.append(int(k[6:10]) - 1)
-                    else:
-                        page_numbers.append(int(k[6:10]) - 1) # e.g. get '0123' from 'TITLE_01234567'                   
-                    */
-                    throw new NotImplementedException();
-                }
+                // get '0123' from 'TITLE_01234567' or 'LINKI_01234567' or 'LINKO_01234567'
+                if (footer[property] is List<string> itemList)
+                    pageNumbers.AddRange(itemList.Select(p => Convert.ToInt32(property.Substring(6, 4))));
                 else
-                    pageNumbers.Add(Int32.Parse(property.Substring(6, 4))); // get '0123' from 'TITLE_01234567'
+                    pageNumbers.Add(Int32.Parse(property.Substring(6, 4)));
             }
 
             return pageNumbers;
@@ -182,5 +193,47 @@ private List<int> GetBitmapAddress(Metadata metadata, int pageNumber)
 
             return bitmapAddresses;
         }
+
+        private List<Link> GetTemplateLink(string[] templateLink, string fileId)
+        {
+            List<Link> templateLinks = new List<Link>();
+
+            Dictionary<string, object> metadata = new Dictionary<string, object>
+            {
+                ["LINKRECT"] = $"{Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[3]))}," +
+                                $"{Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[4]))}," +
+                                $"{Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[5]))}," +
+                                $"{Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[6]))}",
+                ["LINKTYPE"] = Int32.Parse(Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[7]))) == 0 ? ((Int32)LinkType.Page).ToString() : ((Int32)LinkType.Web).ToString(),
+                ["LINKINOUT"] = ((Int32)LinkDirection.Out).ToString(),
+                ["LINKBITMAP"] = DateTime.Now.Ticks.ToString(),
+                ["LINKTIMESTAMP"] = DateTime.Now.Ticks.ToString(),
+                ["LINKFILE"] = templateLink[8],
+                ["LINKFILEID"] = fileId,
+                ["PAGEID"] = Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[1]))
+            };
+
+            Link linkOut = new Link(metadata)
+            {
+                PageNumber = Int32.Parse(Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[0]))) - 1 // link indexes are not 0 based
+            };
+
+            templateLinks.Add(linkOut);
+
+            // in case we are building template page links, we need to ensure we have both IN and OUT links
+            // they are the same structure, with the exception of the LINKINOUT attribute
+            if (linkOut.Type == (Int32)LinkType.Page)
+            {
+                metadata["LINKINOUT"] = ((Int32)LinkDirection.In).ToString();
+                Link linkIn = new Link(metadata)
+                {
+                    PageNumber = Int32.Parse(Encoding.UTF8.GetString(Convert.FromBase64String(templateLink[2]))) - 1 // link indexes are not 0 based
+                };
+
+                templateLinks.Add(linkIn);
+            }
+
+            return templateLinks;
+        }
     }
 }

SupernoteSharp/Business/SupernoteXParser.cs.cs

@@ -30,8 +30,8 @@ internal override List<String> SN_SIGNATURES
                     "noteSN_FILE_VER_20210009", // Firmware version C.291
                     "noteSN_FILE_VER_20210010", // Firmware version Chauvet 2.1.6
                     "noteSN_FILE_VER_20220011", // Firmware version Chauvet 2.5.17
-                    "noteSN_FILE_VER_20220013", // Firmware version Chauvet 2.6.19
-                    "markSN_FILE_VER_20220013"  // Firmware version Chauvet 2.8.22
+                    "noteSN_FILE_VER_20220013", // Firmware version Chauvet 2.9.24
+                    "markSN_FILE_VER_20220013"  // Firmware version Chauvet 2.9.24
                 };
             }
         }
@@ -123,7 +123,7 @@ private static List<int> GetItemAddresses(Dictionary<string, object> footer, str
 
             foreach (string itemKey in itemKeys)
             {
-                if (footer[itemKey] is List<object> itemList)
+                if (footer[itemKey] is List<string> itemList)
                     itemAddresses.AddRange(itemList.Select(p => Convert.ToInt32(p)));
                 else
                     itemAddresses.Add(Convert.ToInt32(footer[itemKey]));

SupernoteSharp/Common/Enums.cs

@@ -12,4 +12,6 @@ public enum VisibilityOverlay : byte { Default, Visible, Invisible }
     public enum LinkDirection { Out = 0, In = 1 }
 
     public enum LinkType { Page = 0, File = 1, Web = 4 }
+
+    public enum StyleUsageType { Normal = 0, Pdf = 2 }
 }

SupernoteSharp/Entities/Link.cs

@@ -11,6 +11,7 @@ public class Link
         public int Position { get; private set; }
         public int Type { get; private set; }
         public int InOut { get; private set; }
+        public string Bitmap { get; private set; }
         public (int left, int top, int width, int height) Rect { get; private set; }
         public string Timestamp { get; private set; }
         public string FilePath { get; private set; }
@@ -25,6 +26,7 @@ public Link(Dictionary<string, object> metadata)
             Position = Int32.Parse(((string)metadata["LINKRECT"]).Split(',')[1]); // get top value from "left,top,width,height"
             Type = Int32.Parse((string)metadata["LINKTYPE"]);
             InOut = Int32.Parse((string)metadata["LINKINOUT"]);
+            Bitmap = (string)metadata["LINKBITMAP"];
 
             // rectangle
             string[] rectangle = ((string)metadata["LINKRECT"]).Split(',');

SupernoteSharp/Entities/Notebook.cs

@@ -12,11 +12,15 @@ public class Notebook
         public List<Keyword> Keywords { get; private set; }
         public List<Title> Titles { get; private set; }
         public List<Link> Links { get; private set; }
+        public List<Link> TemplateLinks { get; private set; }
         public List<Page> Pages { get; private set; }
         public string FileType { get; private set; }
         public string FileId { get; private set; }
         public bool IsRealtimeRecognition { get; private set; }
         public int TotalPages { get { return Pages.Count; } }
+        public string PdfStyle { get; private set; }
+        public string PdfStyleMd5 { get; private set; }
+        public StyleUsageType StyleUsageType { get; private set; }
 
         public Notebook(Metadata metadata)
         {
@@ -54,6 +58,8 @@ public Notebook(Metadata metadata)
                 }
             }
 
+            TemplateLinks = new List<Link>();
+
             Pages = new List<Page>();
             for (int i = 0; i < metadata.TotalPages; i++)
             {
@@ -63,6 +69,11 @@ public Notebook(Metadata metadata)
             FileType = (string)metadata.Header["FILE_TYPE"];
             FileId = (string)metadata.Header["FILE_ID"];
             IsRealtimeRecognition = (string)Metadata.Header["FILE_RECOGN_TYPE"] == "1";
+
+            // pdf note templates
+            PdfStyle = metadata.Header.ContainsKey("PDFSTYLE") == true ? (string)metadata.Header["PDFSTYLE"] : "none";
+            PdfStyleMd5 = metadata.Header.ContainsKey("PDFSTYLEMD5") == true ? (string)metadata.Header["PDFSTYLEMD5"] : "0";
+            StyleUsageType = metadata.Header.ContainsKey("STYLEUSAGETYPE") == true ? Enum.Parse<StyleUsageType>(metadata.Header["STYLEUSAGETYPE"].ToString()) : StyleUsageType.Normal; ;
         }
 
         public Page Page(int pageNumber)