Initial import of ModeLib

.gitattributes

+c/** gitlab-language=c linguist-language=c linguist-detectable=true
+h/** gitlab-language=c linguist-language=c linguist-detectable=true

.gitignore

+/Makefile.d
+/o/
+/objs/
+/oz/

LICENSE

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

+# Makefile for ModeLib
+
+COMPONENT     = ModeLib
+OBJS          = common mdfsupport
+CDFLAGS       = -DDODEBUG=1
+
+include CLibrary
+
+# Dynamic dependencies:

Mk,fd7

+Dir <Obey$Dir>
+amu all_libs THROWBACK=-throwback

MkClean,fd7

+Dir <Obey$Dir>
+amu clean
+stripdepnd

MkExport,fd7

+Dir <Obey$Dir>
+amu export_hdrs
+amu export_libs THROWBACK=-throwback

VersionNum

+/* (0.01)
+ *
+ * This file is automatically maintained by srccommit, do not edit manually.
+ *
+ */
+#define Module_MajorVersion_CMHG        0.01
+#define Module_MinorVersion_CMHG
+#define Module_Date_CMHG                12 Jul 2022
+
+#define Module_MajorVersion             "0.01"
+#define Module_Version                  1
+#define Module_MinorVersion             ""
+#define Module_Date                     "12 Jul 2022"
+
+#define Module_ApplicationDate          "12-Jul-22"
+
+#define Module_ComponentName            "ModeLib"
+
+#define Module_FullVersion              "0.01"
+#define Module_HelpVersion              "0.01 (12 Jul 2022)"
+#define Module_LibraryVersionInfo       "0:1"

c/common

+#include "ModeLib.h"
+
+#include <stdlib.h>
+#include <string.h>
+
+bool new_monitordescription(MonitorDescriptionRef *description, const char *name)
+{
+    MonitorDescriptionRef md;
+
+    md = (MonitorDescriptionRef) calloc(1, sizeof(MonitorDescription));
+    if (md == NULL)
+    {
+        return false;
+    }
+
+    strncpy(md->name, name, sizeof(md->name));
+    md->name[sizeof(md->name) - 1] = 0;
+
+    md->output_format = -1; /* Output format */
+    md->external_clock = -1; /* External clock not present */
+    md->modelist = NULL; /* Empty initially */
+    md->audio_formats = NULL; /* Empty initially */
+
+    *description = md;
+
+    return true;
+}
+
+void free_monitordescription(MonitorDescriptionRef description)
+{
+    ModeDescriptionRef md;
+    md = description->modelist;
+    while (md)
+    {
+        ModeDescriptionRef td = md;
+        md = md->next;
+        free(td);
+    }
+    if (description->audio_formats)
+    {
+        free(description->audio_formats);
+    }
+    free(description);
+}
+
+void compute_modedescription(ModeDescriptionRef md)
+{
+    uint32_t vtot, htot;
+    int pn;
+    ModeDef *mp = &md->definition.timings; /* for terseness! */
+    for (htot = 0, vtot = 0, pn = 0; pn < FR__COUNT; ++pn)
+    {
+        htot += mp->hpar[pn];
+        vtot += mp->vpar[pn];
+    }
+    md->line_hz = mp->pixel_khz * 1000 / htot;  /* compute line frequency in Hz */
+    md->frame_mhz = md->line_hz * 1000 / vtot; /* frame frequency in milliHz, high-prec */
+    if (mp->interlaced)
+    {
+        md->frame_mhz /= 2; /* if interlaced, one frame is 2 fields */
+    }
+    md->frame_hz = (md->frame_mhz + 500) / 1000; /* & low-prec for user integer Hz matching */
+}

h/ModeLib

+/* Copyright 2016 Castle Technology Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* ModeLib.h */
+
+#ifndef MODELIB_H
+#define MODELIB_H
+
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdint.h>
+
+/*
+ * Monitor & modes description as loaded from ModeInfo file: note,
+ * this does not include pixel depth.
+ */
+#define MAXMONITORNAME     31 /* arbitrary, but careful not to overrun Display Manager title bar */
+#define MAXMODENAME        31 /* arbitrary, but careful not to clip Display Manager menu width */
+#define MAXERRORSTR        31 /* must be at least */
+
+typedef struct modelib_error {
+    int code;
+    int lineno;
+    char extra[MAXERRORSTR];
+} modelib_error;
+
+#define MODELIB_ERR_NOSPACE        1    /* RMA allocation failed */
+#define MODELIB_ERR_INCONSISTENT   2    /* Inconsistent parameters for mode '%1' in file %0 */
+#define MODELIB_ERR_EOF            3    /* Unexpected end of file at line %1 of file %0 */
+#define MODELIB_ERR_EXPCHAR        4    /* Character '%2' was expected at line %1 of file %0 */
+#define MODELIB_ERR_VALUEOVF       5    /* Overlarge value for parameter at line %1 of file %0 */
+#define MODELIB_ERR_EXTRAINPUT     6    /* Extraneous trailing input at line %1 of file %0 */
+#define MODELIB_ERR_EXPNUM         7    /* Number expected at line %1 of file %0 */
+#define MODELIB_ERR_EXPKEY         8    /* Keyword %2 was expected at line %1 of file %0 */
+#define MODELIB_ERR_REPKEY         9    /* Keyword %2 repeated at line %1 of file %0 */
+#define MODELIB_ERR_NOMODENAME    10    /* No mode_name field in mode ending at line %1 of file %0 */
+#define MODELIB_ERR_INCOMPLETE    11    /* Incomplete definition for mode '%2' in file %0 */
+#define MODELIB_ERR_UNKNOWNPAR    12    /* Unknown parameter name at line %1 of file %0 */
+#define MODELIB_ERR_WRONGCONTEXT  13    /* Wrong context for keyword '%2' at line %1 of file %0 */
+#define MODELIB_ERR_UNKNOWNFMT    14    /* Unknown file format code at line %1 of file %0 */
+#define MODELIB_ERR_BLANKMONTITLE 15    /* Blank monitor title given at line %1 of file %0 */
+#define MODELIB_ERR_DUPMODENAME   16    /* Duplicate mode name '%1' in file %0 */
+#define MODELIB_ERR_NOMODES       17    /* No mode definitions found in file %0 */
+#define MODELIB_ERR_INVALIDPAR    18    /* Invalid parameter value at line %1 of file %0 */
+#define MODELIB_ERR_VALUEOVF2     19    /* Overlarge value for parameter */
+
+/*
+ * The 6 field framing parameters for each direction, horizontal and
+ * vertical.  In horizontal case, the parameters are measured in VIDC
+ * pixel times; for vertical, VIDC raster times.
+ */
+#define FR_SYNC         0               /* sync pulse width */
+#define FR_BPCH         1               /* back porch */
+#define FR_BDR1         2               /* top (V) / left (H) border height/width */
+#define FR_DISP         3               /* active data display height/width  */
+#define FR_BDR2         4               /* bottom (V) / right (H) border height/width */
+#define FR_FPCH         5               /* front porch */
+#define FR__COUNT       6               /* how many parameters altogether */
+
+typedef struct
+{
+    uint32_t xres;                      /* User quoted xres (may differ from hpar[FR_DISP], especially in interlaced modes) */
+    uint32_t yres;                      /* User quoted yres (may differ from vpar[FR_DISP], ... */
+    uint16_t hpar[FR__COUNT];           /* H. framing in pixel times */
+    uint16_t vpar[FR__COUNT];           /* V. framing in raster times */
+    uint32_t pixel_khz;                 /* pixel rate in kHz */
+    uint32_t external_clock;            /* rate of external clock in kHz (use it instead of VCO), or -1 */
+    uint8_t  syncpol;                   /* sync polarity code (0..3 for now) */
+    uint8_t  interlaced;                /* whether mode is interlaced using two seperate framebuffers (0 or 1) */
+    uint8_t  freq, spare2;              /* explicit padding so struct is N*4 bytes long */
+} ModeDef; /* Abbreviated form, without the name */
+
+typedef struct
+{
+    char    name[MAXMODENAME+1];
+    ModeDef timings;
+} ModeDefinition;
+
+/* As stored internally by ScreenModes module */
+typedef struct mode_description_
+{
+    struct mode_description_ *next;     /* in list built during file parsing */
+    ModeDefinition definition;          /* as extracted from the file */
+    /* The following are computed once the mode definition is read in from the file */
+    uint32_t line_hz;                   /* line rate in Hz (for diagnostics only) */
+    uint32_t frame_hz:8;                /* frame rate in Hz, for user frame rate selection */
+    uint32_t frame_mhz:24;              /* also in mHz (millihertz), for more precise cmp */
+    uint8_t  priority;                  /* Bits 0-2 = 'Parameter type' from? (EDID 1.4 Section 5) */
+                                        /*            0 = Undefined (MDF or something which overrides all else) */
+                                        /*            1 = Preferred Timing Mode from base EDID */
+                                        /*            2 = Detailed Timing Mode in the base EDID */
+                                        /*            3 = Any detailed timing modes in extension blocks */
+                                        /*            4 = Any optional 3-byte CVT codes in the base EDID or extension block */
+                                        /*            5 = Standard Timings listed in base EDID or extension blocks */
+                                        /*            6 = Additional timing mode information: Established Timings I, II, III, */
+                                        /*                default GTF, GTF secondary curve and CVT */
+                                        /*            7 = Base VIDEO MODE (defined as 640 x 480 x 60Hz). */
+} ModeDescription, *ModeDescriptionRef;
+
+/* Audio format information extracted from EDID */
+typedef struct
+{
+    uint8_t format_code;                /* As per CEA 861-D */
+    uint8_t max_channels;
+    uint8_t sample_rates;               /* Byte #2 of short audio descriptor */
+    uint8_t format_specific;            /* Byte #3 of short audio descriptor */
+} AudioFormat;
+
+/* Description of a monitor & its associated modes */
+typedef struct
+{
+    char name[MAXMONITORNAME+1];
+    ModeDescriptionRef modelist;
+    uint32_t dpms_state;                /* value specified by DPMS_state keyword, or 0 if none */
+    uint32_t lcd_support;               /* 0=>modefile is CRT, 1=>LCD single-panel, 2=>LCD dual panel [WT13-01-95] */
+    uint32_t external_clock;            /* rate of external clock in kHz (use it instead of VCO) */
+    uint32_t output_format;             /* 0=analogue, 1=digital */
+
+    AudioFormat *audio_formats;         /* (Optional) list of supported audio formats */
+    int      audio_format_count;        /* Length of list */
+    uint8_t  speaker_mask;              /* (Optional) speaker mask (as per CEA 861-D) */
+    bool     speaker_mask_provided;
+} MonitorDescription, *MonitorDescriptionRef;
+
+bool new_monitordescription(MonitorDescriptionRef *description, const char *name);
+void free_monitordescription(MonitorDescriptionRef description);
+void compute_modedescription(ModeDescriptionRef md);
+
+modelib_error *parse_modefile(modelib_error *err, FILE *handle, MonitorDescriptionRef *description);
+
+#endif
+
+/* EOF ModeLib.h */

h/util

+/* Copyright 2016 Castle Technology Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* util.h */
+
+#ifndef UTIL_H
+#define UTIL_H
+
+#ifndef DODEBUG
+#define DODEBUG 0
+#endif
+
+#if DODEBUG
+#define IFDEBUG    if (!1) {} else
+#else
+#define IFDEBUG    if (1) {} else
+#endif
+
+#endif
+
+/* EOF util.h */