{"id":16964977,"url":"https://github.com/propensive/hallucination","last_synced_at":"2025-04-05T15:45:54.008Z","repository":{"id":217497476,"uuid":"744027519","full_name":"propensive/hallucination","owner":"propensive","description":"A library for working with images in Scala","archived":false,"fork":false,"pushed_at":"2025-02-04T08:15:19.000Z","size":2129,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T20:49:18.479Z","etag":null,"topics":["bitmap-images","bmp","gif","images","jpeg","jpg","png","raster-graphics","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/propensive.png","metadata":{"files":{"readme":".github/readme.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-16T13:45:22.000Z","updated_at":"2025-02-04T08:15:22.000Z","dependencies_parsed_at":"2024-04-10T18:01:06.213Z","dependency_job_id":"dc234740-9a6c-41fb-9db2-250ca0a79a5e","html_url":"https://github.com/propensive/hallucination","commit_stats":null,"previous_names":["propensive/hallucination"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhallucination","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhallucination/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhallucination/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fhallucination/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/hallucination/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361598,"owners_count":20926642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitmap-images","bmp","gif","images","jpeg","jpg","png","raster-graphics","scala"],"created_at":"2024-10-13T23:44:44.911Z","updated_at":"2025-04-05T15:45:53.984Z","avatar_url":"https://github.com/propensive.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg alt=\"GitHub Workflow\" src=\"https://img.shields.io/github/actions/workflow/status/propensive/hallucination/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/hallucination/actions)\n[\u003cimg src=\"https://img.shields.io/discord/633198088311537684?color=8899f7\u0026label=DISCORD\u0026style=for-the-badge\" height=\"24\"\u003e](https://discord.com/invite/MBUrkTgMnA)\n\u003cimg src=\"/doc/images/github.png\" valign=\"middle\"\u003e\n\n# Hallucination\n\n__A library for working with images in Scala__\n\nImages are commonplace in many programming environments, so they ought to be as\neasy to work with as text. _Hallucination_ aspires to make this possible.\n\n## Features\n\n- simple immutable API for reading and writing image files\n- supports standard Java ImageIO formats: GIF, JPEG, BMP and PNG\n- read directly from any [Turbulence](https://github.com/propensive/turbulence) source\n- access image metadata and individual pixel colors\n\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\nAll terms and types are define in the `hallucination` package, and can be used with:\n```scala\nimport hallucination.*\n```\n\n### Reading images\n\nTo read an image of a known type, the `read` method of its codec object should\nbe used. Currently, four codecs are defined:\n - `Png`\n - `Gif`\n - `Jpeg`, and\n - `Bmp`\n\nThe source of the image may be any source that can be read as `Bytes` by\nTurbulence, for example:\n```scala\nimport galilei.*\n\nval image = Png.read(% / p\"home\" / p\"work\" / p\"image.png\")\n```\n\nThe resultant value will be an instance of `Image[Png]`, that is, an `Image`\nparameterized with the erased phantom type `Png`.\n\nIt's possible to use Turbulence's `readAs` method to read an `Image[?]` from a\nsource of `Bytes`, for example:\n```scala\nimport turbulence.*\nimport hellenism.*\n\nval icon = (Classpath / p\"icon.bmp\").readAs[Image[Bmp]]\n```\n\n### Accessing `Image` data\n\nThe width and height of the image are available through the `width` and\n`height` methods of `Image[?]`.\n\nThe color of the pixel at given coordinates within the image can be accessed,\nas an `Rgb24` value, using `Image`'s `apply` method, i.e. `image(x, y)`.\n\n\n\n## Status\n\nHallucination is classified as __embryotic__. For reference, Soundness projects are\ncategorized into one of the following five stability levels:\n\n- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity\n- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns\n- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement\n- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later\n- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated\n\nProjects at any stability level, even _embryonic_ projects, can still be used,\nas long as caution is taken to avoid a mismatch between the project's stability\nlevel and the required stability and maintainability of your own project.\n\nHallucination is designed to be _small_. Its entire source code currently consists\nof 92 lines of code.\n\n## Building\n\nHallucination will ultimately be built by Fury, when it is published. In the\nmeantime, two possibilities are offered, however they are acknowledged to be\nfragile, inadequately tested, and unsuitable for anything more than\nexperimentation. They are provided only for the necessity of providing _some_\nanswer to the question, \"how can I try Hallucination?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Hallucination's build\n   structure, dependencies and source location; the file format should be short\n   and quite intuitive. Copy the sources into a source directory in your own\n   project, then repeat (recursively) for each of the dependencies.\n\n   The sources are compiled against the latest nightly release of Scala 3.\n   There should be no problem to compile the project together with all of its\n   dependencies in a single compilation.\n\n2. *Build with [Wrath](https://github.com/propensive/wrath/)*\n\n   Wrath is a bootstrapping script for building Hallucination and other projects in\n   the absence of a fully-featured build tool. It is designed to read the `fury`\n   file in the project directory, and produce a collection of JAR files which can\n   be added to a classpath, by compiling the project and all of its dependencies,\n   including the Scala compiler itself.\n   \n   Download the latest version of\n   [`wrath`](https://github.com/propensive/wrath/releases/latest), make it\n   executable, and add it to your path, for example by copying it to\n   `/usr/local/bin/`.\n\n   Clone this repository inside an empty directory, so that the build can\n   safely make clones of repositories it depends on as _peers_ of `hallucination`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Hallucination's dependencies.\n\n   If the build was successful, the compiled JAR files can be found in the\n   `.wrath/dist` directory.\n\n## Contributing\n\nContributors to Hallucination are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/hallucination/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Hallucination\neasier.\n\nPlease __do not__ contact project maintainers privately with questions unless\nthere is a good reason to keep them private. While it can be tempting to\nrepsond to such questions, private answers cannot be shared with a wider\naudience, and it can result in duplication of effort.\n\n## Author\n\nHallucination was designed and developed by Jon Pretty, and commercial support and\ntraining on all aspects of Scala 3 is available from [Propensive\nO\u0026Uuml;](https://propensive.com/).\n\n\n\n## Name\n\nAn _hallucination_ is a sensation of something appearing real, but existing\nonly in ones mind. An image is a visual hallucination.\n\nIn general, Soundness project names are always chosen with some rationale,\nhowever it is usually frivolous. Each name is chosen for more for its\n_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no\nbias towards names with positive or \"nice\" meanings—since many of the libraries\nperform some quite unpleasant tasks.\n\nNames should be English words, though many are obscure or archaic, and it\nshould be noted how willingly English adopts foreign words. Names are generally\nof Greek or Latin origin, and have often arrived in English via a romance\nlanguage.\n\n## Logo\n\nHallucination's logo is a simplistic eye, the organ that is stimulated by images.\n\n## License\n\nHallucination is copyright \u0026copy; 2025 Jon Pretty \u0026 Propensive O\u0026Uuml;, and\nis made available under the [Apache 2.0 License](/license.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fhallucination","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Fhallucination","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fhallucination/lists"}