commands restructured to be const vectors

Co-authored-by: Moritz Martinius <mm@cloudprinters.de>
Reviewed-on: #10

.clang-format

@@ -41,7 +41,7 @@ BreakBeforeBinaryOperators: None
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializers: BeforeColon
 BreakInheritanceList: BeforeColon
-ColumnLimit: 100
+ColumnLimit: 120
 CompactNamespaces: false
 ContinuationIndentWidth: 4
 Cpp11BracedListStyle: true

.gitea/workflows/build.yaml

@@ -14,7 +14,7 @@ jobs:
       - name: install meson
         run: apt-get -yq install meson
       - name: Install build dependencies
-        run: apt-get -yq install libusb-1.0-0-dev libspdlog-dev libpango1.0-dev libcairo2-dev gcovr
+        run: apt-get -yq install libusb-1.0-0-dev libspdlog-dev libfmt-dev libpango1.0-dev libcairo2-dev gcovr
       - name: setup builddir
         run: meson setup builddir -Db_coverage=true
       - name: build all targets

.gitignore

@@ -6,6 +6,7 @@ subprojects/*
 coverageReport/
 
 # Files
+ptprnt.log
 !subprojects/*.wrap
 .vscode/*
 !.vscode/c_cpp_properties.json

.vscode/settings.json

@@ -85,5 +85,9 @@
   },
   "clang-tidy.buildPath": "builddir/",
   "clangd.onConfigChanged": "restart",
-  "C_Cpp.default.compileCommands": "builddir/compile_commands.json"
+  "C_Cpp.default.compileCommands": "/home/moritz/src/ptouch-prnt/builddir/compile_commands.json",
+  "gcovViewer.buildDirectories": [
+    "/home/moritz/Projekte/ptouch-prnt/builddir"
+  ],
+  "C_Cpp.default.configurationProvider": "mesonbuild.mesonbuild"
 }

README.md

@@ -19,7 +19,7 @@ pacman -S libusb spdlog pango cairo meson gcovr
 
 Install dependencies on Debian/Ubuntu
 ``` bash
-apt-get install libusb-1.0-0-dev libspdlog-dev libpango1.0-dev libcairo2-dev meson gcovr
+apt-get install libusb-1.0-0-dev libspdlog-dev libfmt-dev libpango1.0-dev libcairo2-dev meson gcovr
 ```
 
 ## Build

generate_coverage.sh

@@ -2,6 +2,7 @@
 
 SCRIPT_PATH="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 HTML_COV_PATH="coverageReport/html"
+XML_COV_PATH="coverageReport/xml"
 HTML_START_FILE="index.html"
 
 echo "Generating Coverage report for ptouch-prnt"
@@ -12,10 +13,15 @@ ninja -C builddir test
 mkdir -p ${HTML_COV_PATH}
 gcovr --html --html-details --html-syntax-highlighting --filter src --output ${HTML_COV_PATH}/${HTML_START_FILE}
 
+mkdir -p ${XML_COV_PATH}
+gcovr --xml-pretty --filter src --output ${XML_COV_PATH}/cov.xml
+
 if [ $? ] 
 then
   echo "Coverage report successful generated!"
   echo "Open: file://${SCRIPT_PATH}/${HTML_COV_PATH}/${HTML_START_FILE}"
 else
   echo "Error generating coverage report!"
-fi
+fi
+
+rm *.gcov

meson.build

@@ -1,11 +1,12 @@
 project('ptprnt', 'cpp',
     version: 'v0.1.0-'+run_command('git', 'rev-parse',  '--short', 'HEAD', check: true).stdout().strip(),
     license: 'GPLv3',
-    default_options : ['c_std=c11', 'cpp_std=c++17']    
+    default_options : ['c_std=c11', 'cpp_std=c++20', 'b_sanitize=none', 'b_lto=true', 'b_lto_mode=thin', 'b_thinlto_cache=true']    
 )
 
 usb_dep = dependency('libusb-1.0')
 log_dep = dependency('spdlog')
+fmt_dep = dependency('fmt')
 pangocairo_dep = dependency('pangocairo')
 
 # CLI11 
@@ -23,7 +24,7 @@ ptprnt_exe = executable(
     'ptprnt', 
     'src/main.cpp',
     install: true,
-    dependencies : [usb_dep, log_dep, pangocairo_dep, cli11_dep],
+    dependencies : [usb_dep, log_dep, fmt_dep, pangocairo_dep, cli11_dep],
     include_directories: incdir,
     sources: [ptprnt_srcs],
     cpp_args : ['-DPROJ_VERSION="'+meson.project_version()+'"'],

src/P700Printer.cpp

@@ -30,14 +30,14 @@
 #include <vector>
 
 #include "graphics/Bitmap.hpp"
-#include "graphics/Image.hpp"
+#include "graphics/Label.hpp"
 #include "graphics/Monochrome.hpp"
 #include "libusb.h"
 #include "libusbwrap/LibUsbTypes.hpp"
 #include "spdlog/fmt/bin_to_hex.h"
 
 // as long as DRYRUN is defined, no data is actually send to the printer, we need to save some tape ;)
-//#define DRYRUN
+#define DRYRUN
 
 namespace ptprnt::printer {
 
@@ -66,15 +66,14 @@ const PrinterInfo P700Printer::getPrinterInfo() {
 
 const PrinterStatus P700Printer::getPrinterStatus() {
     using namespace std::chrono_literals;
-    std::vector<uint8_t> getStatusCmd({0x1b, 0x69, 0x53});  // status info request
-    send(getStatusCmd);
+    send(p700::commands::GET_STATUS);
 
     int tx    = 0;
     int tries = 0;
     std::vector<uint8_t> recvBuf(32);
     while (tries++ < MAX_TRIES_GET_STATUS) {
         std::this_thread::sleep_for(100ms);
-        mUsbHndl->bulkTransfer(commands["printerinfo"][0], recvBuf, &tx, 0);
+        mUsbHndl->bulkTransfer(p700::commands::INFO[0], recvBuf, &tx, 0);
     }
 
     return PrinterStatus{.tapeWidthMm = recvBuf[10]};
@@ -122,21 +121,23 @@ bool P700Printer::detachUsbDevice() {
 }
 
 bool P700Printer::printBitmap(const graphics::Bitmap<graphics::ALPHA8>& bitmap) {
-    auto bm = graphics::Bitmap<graphics::ALPHA8>(512, 128);
-    {
-        auto img = graphics::Image();
-        bm.setPixels(std::vector<uint8_t>(img.getRaw(), img.getRaw() + 512 * 128));
+#ifdef DRYRUN
+    SPDLOG_DEBUG("DRYRUN enabled");
+    for (unsigned int lineNo = 0; lineNo < bitmap.getHeight(); lineNo++) {
+        auto line     = bitmap.getLine(lineNo);
+        auto monoLine = graphics::Monochrome(*line);
+        monoLine.visualize();
     }
+#endif
 
-    send(commands["rasterstart"]);
-
+    send(p700::commands::RASTER_START);
     std::vector<uint8_t> rastercmd(4);
     rastercmd[0] = 0x47;
     rastercmd[1] = 0x00;  // size +1
     rastercmd[2] = 0x00;
     rastercmd[3] = 0x00;  // size -1
-    for (unsigned int i = 0; i < bm.getWidth(); i++) {
-        auto bmcol = bm.getCol(i);
+    for (unsigned int i = 0; i < bitmap.getWidth(); i++) {
+        auto bmcol = bitmap.getCol(i);
         if (!bmcol) {
             spdlog::error("Out of bounds bitmap access");
             break;
@@ -151,22 +152,23 @@ bool P700Printer::printBitmap(const graphics::Bitmap<graphics::ALPHA8>& bitmap)
         buf[1] = col.size() + 1;
         buf[3] = col.size() - 1;
         if (!send(buf)) {
+            spdlog::error("Error sending buffer to printer");
             break;
         };
     }
 
-    send(commands["eject"]);
+    send(p700::commands::EJECT);
     return true;
 }
 
 bool P700Printer::printText(const std::string& text, uint16_t fontSize) {
-    send(commands["lf"]);
-    send(commands["ff"]);
-    send(commands["eject"]);
+    send(p700::commands::LF);
+    send(p700::commands::FF);
+    send(p700::commands::EJECT);
     return true;
 }
 
-bool P700Printer::send(std::vector<uint8_t>& data) {
+bool P700Printer::send(const std::vector<uint8_t>& data) {
 
     if (mUsbHndl == nullptr || data.size() > 128) {
         spdlog::error("Invalid device handle or invalid data.");
@@ -182,12 +184,11 @@ bool P700Printer::send(std::vector<uint8_t>& data) {
     }
 #else
     tx = data.size();
-    spdlog::debug("USB raw data(len {}): {}", data.size(), spdlog::to_hex(data));
+    spdlog::info("USB raw data(len {}): {}", data.size(), spdlog::to_hex(data));
 #endif
 
     if (tx != static_cast<int>(data.size())) {
-        spdlog::error("Could not transfer all data via USB bulk transfer. Only send {} of {} bytes",
-                      tx, data.size());
+        spdlog::error("Could not transfer all data via USB bulk transfer. Only sent {} of {} bytes", tx, data.size());
         return false;
     }
 

src/P700Printer.hpp

@@ -17,6 +17,7 @@
 
  */
 
+#include <spdlog/spdlog.h>
 #include <sys/types.h>
 
 #include <map>
@@ -30,13 +31,23 @@
 #pragma once
 
 namespace ptprnt::printer {
+namespace p700::commands {
+const cmd_T GET_STATUS{0x1b, 0x69, 0x53};
+const cmd_T RASTER_START{0x1b, 0x69, 0x7a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
+const cmd_T INFO{0x1b, 0x69, 0x7a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
+const cmd_T PACKBITSON{0x02};
+const cmd_T LF{0x5a};
+const cmd_T FF{0x0c};
+const cmd_T EJECT{0x1a};
+const cmd_T PRINTER_INFO{0x81};
+}  // namespace p700::commands
 
 constexpr uint8_t MAX_TRIES_GET_STATUS = 10;
 
 class P700Printer : public ::ptprnt::IPrinterDriver {
    public:
     P700Printer() = default;
-    ~P700Printer();
+    ~P700Printer() override;
 
     // delete copy ctor and assignment
     P700Printer(const P700Printer&)            = default;
@@ -58,7 +69,7 @@ class P700Printer : public ::ptprnt::IPrinterDriver {
     bool printText(const std::string& text, uint16_t fontSize) override;
 
    private:
-    bool send(std::vector<uint8_t>& data);
+    bool send(const std::vector<uint8_t>& data);
     bool init();
 
     std::shared_ptr<libusbwrap::IUsbDevice> mUsbHndl{nullptr};
@@ -67,17 +78,8 @@ class P700Printer : public ::ptprnt::IPrinterDriver {
                                        .name       = "Brother P-touch P700",
                                        .version    = "v1.0",
                                        .vid        = 0x04f9,
-                                       .pid        = 0x2061};
-    std::map<std::string, std::vector<uint8_t>> commands{
-        {"rasterstart",
-         {0x1b, 0x69, 0x61,
-          0x01}},  // unique for P700, other printers have the 2 byte set to 0x52 instead of 0x61
-        {"info", {0x1b, 0x69, 0x7a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}},
-        {"packbitson", {0x02}},
-        {"lf", {0x5a}},
-        {"ff", {0x0c}},
-        {"eject", {0x1a}},
-        {"printerinfo", {0x81}}};
+                                       .pid        = 0x2061,
+                                       .pixelLines = 128};
 };
 
 }  // namespace ptprnt::printer

src/PtouchPrint.cpp

@@ -16,18 +16,32 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
  */
+#include <cstdint>
 
-#include "PtouchPrint.hpp"
+#include "graphics/Monochrome.hpp"
+#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE
+#define SPDLOG_DEBUG_ON
+#define SPDLOG_TRACE_ON
 
 #include <CLI/App.hpp>
+#include <fmt/core.h>
 #include <spdlog/common.h>
+#include <spdlog/details/synchronous_factory.h>
+#include <spdlog/logger.h>
+#include <spdlog/sinks/base_sink.h>
+#include <spdlog/sinks/basic_file_sink.h>
+#include <spdlog/sinks/stdout_color_sinks.h>
 #include <spdlog/spdlog.h>
 
 #include <functional>
+#include <memory>
+#include <vector>
 
 #include "CLI/Option.hpp"
 #include "P700Printer.hpp"
+#include "PtouchPrint.hpp"
 #include "graphics/Bitmap.hpp"
+#include "graphics/Label.hpp"
 #include "libusbwrap/UsbDeviceFactory.hpp"
 
 namespace ptprnt {
@@ -45,9 +59,9 @@ int PtouchPrint::init(int argc, char** argv) {
     }
 
     if (mVerboseFlag) {
-        setupLogger(spdlog::level::trace);
+        setupLogger(spdlog::level::debug);
     } else {
-        setupLogger(spdlog::level::critical);
+        setupLogger(spdlog::level::warn);
     }
 
     if (!mUsbDeviceFactory.init()) {
@@ -59,10 +73,12 @@ int PtouchPrint::init(int argc, char** argv) {
 }
 
 int PtouchPrint::run() {
+    SPDLOG_DEBUG("ptprnt version {}", mVersionString);
+    SPDLOG_TRACE("testing trace");
     auto numFoundPrinters = getCompatiblePrinters();
     if (numFoundPrinters == 0) {
         spdlog::error(
-            "No compatible printers found, please make sure if they are turned on and connected");
+            "No compatible printers found, please make sure that they are turned on and connected");
         return -1;
     } else if (numFoundPrinters > 1) {
         spdlog::warn("Found more than one compatible printer. Currently not supported.");
@@ -76,15 +92,29 @@ int PtouchPrint::run() {
             "Found more than one device of the same printer on bus. Currently not supported");
         return -1;
     }
-    printer->attachUsbDevice(devices[0]);
+    printer->attachUsbDevice(std::move(devices[0]));
     auto status = printer->getPrinterStatus();
     spdlog::info("Detected tape width is {}mm", status.tapeWidthMm);
-    auto bm = ptprnt::graphics::Bitmap<ptprnt::graphics::ALPHA8>(512, 128);
-    //printer->printBitmap(bm);
-    //printer->printText("wurst", 1);
+
+    if (0 == mCommands.size()) {
+        spdlog::warn("No command specified, nothing to do...");
+        return 0;
+    }
 
     for (auto& cmd : mCommands) {
-        std::cout << cmd.second << std::endl;
+        SPDLOG_DEBUG("Command: {}", cmd.second);
+        if (cmd.first == CliCmdType::Text) {
+            auto label{graphics::Label()};
+            label.create(cmd.second, printer->getPrinterInfo().pixelLines);
+            auto bm = graphics::Bitmap<graphics::ALPHA8>(label.getLayoutWidth(),
+                                                         printer->getPrinterInfo().pixelLines);
+            if (!bm.setPixels(label.getRaw())) {
+                spdlog::error("Non-matching bitmap size");
+                return -1;
+            }
+            label.writeToPng("salat.png");
+            //printer->printBitmap(bm);
+        }
     }
 
     return 0;
@@ -93,10 +123,10 @@ int PtouchPrint::run() {
 unsigned int PtouchPrint::getCompatiblePrinters() {
     auto usbDevs = mUsbDeviceFactory.findAllDevices();
 
-    for (auto usbDev : usbDevs) {
+    for (auto& usbDev : usbDevs) {
         auto foundPrinterIt =
             std::find_if(mCompatiblePrinters.begin(), mCompatiblePrinters.end(),
-                         [usbDev](const std::shared_ptr<ptprnt::IPrinterDriver>& printer) {
+                         [&usbDev](const std::shared_ptr<ptprnt::IPrinterDriver>& printer) {
                              return printer->getPid() == usbDev->getPid() &&
                                     printer->getVid() == usbDev->getVid();
                          });
@@ -113,13 +143,27 @@ unsigned int PtouchPrint::getCompatiblePrinters() {
 }
 
 void PtouchPrint::setupLogger(spdlog::level::level_enum lvl) {
-    spdlog::set_level(lvl);
-    spdlog::debug("Starting ptprnt {}", mVersionString);
+    auto consoleSink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
+    consoleSink->set_level(lvl);
+    if (spdlog::level::level_enum::debug == lvl || spdlog::level::level_enum::trace == lvl) {
+        // This will enable file and line number for debug and trace macros
+        consoleSink->set_pattern("%^%L:%$ %v (%s:%#)");
+    } else {
+        consoleSink->set_pattern("%^%L:%$ %v");
+    }
+
+    auto fileSink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("ptprnt.log", true);
+    fileSink->set_level(spdlog::level::trace);
+    fileSink->set_pattern("%Y-%m-%d %H:%m:%S:%e [pid:%P tid:%t] [%^%l%$] %v (%@)");
+    std::vector<spdlog::sink_ptr> sinks{consoleSink, fileSink};
+    auto logger = std::make_shared<spdlog::logger>("default_logger", sinks.begin(), sinks.end());
+    logger->set_level(spdlog::level::trace);
+    spdlog::set_default_logger(logger);
 }
 
 void PtouchPrint::setupCliParser() {
     auto printVersion = [this](std::size_t) {
-        std::cout << "ptprnt version: " << mVersionString << std::endl;
+        fmt::print("ptprnt version: {}\n", mVersionString);
     };
 
     // General options

src/graphics/Bitmap.cpp

@@ -22,6 +22,7 @@
 #include <algorithm>
 #include <spdlog/spdlog.h>
 
+#include <iostream>
 #include <iterator>
 #include <optional>
 #include <vector>
@@ -32,19 +33,20 @@ Bitmap<T>::Bitmap(uint16_t width, uint16_t height)
     : mWidth{width}, mHeight{height}, mPixels(width * height) {}
 
 template <class T>
-uint16_t Bitmap<T>::getWidth() {
+[[nodiscard]] uint16_t Bitmap<T>::getWidth() const {
     return mWidth;
 }
 
 template <class T>
-uint16_t Bitmap<T>::getHeight() {
+[[nodiscard]] uint16_t Bitmap<T>::getHeight() const {
     return mHeight;
 }
 
 template <class T>
 bool Bitmap<T>::setPixels(const std::vector<T>& pixels) {
     if (pixels.size() != mPixels.size()) {
-        spdlog::error("Invalid pixel buffer size.");
+        spdlog::error("Invalid pixel buffer size (got {} vs. {} bitmap size).", pixels.size(),
+                      mPixels.size());
         return false;
     }
 
@@ -53,12 +55,12 @@ bool Bitmap<T>::setPixels(const std::vector<T>& pixels) {
 }
 
 template <class T>
-std::vector<T> Bitmap<T>::getPixelsCpy() {
+[[nodiscard]] std::vector<T> Bitmap<T>::getPixelsCpy() const {
     return mPixels;
 }
 
 template <class T>
-std::optional<std::vector<T>> Bitmap<T>::getLine(uint16_t line) {
+[[nodiscard]] std::optional<std::vector<T>> Bitmap<T>::getLine(uint16_t line) const {
     if (line >= mHeight) {
         // out of bound
         return std::nullopt;
@@ -70,7 +72,7 @@ std::optional<std::vector<T>> Bitmap<T>::getLine(uint16_t line) {
 }
 
 template <class T>
-std::optional<std::vector<T>> Bitmap<T>::getCol(uint16_t col) {
+[[nodiscard]] std::optional<std::vector<T>> Bitmap<T>::getCol(uint16_t col) const {
     if (col >= mWidth) {
         // out of bound
         return std::nullopt;

src/graphics/Bitmap.hpp

@@ -39,12 +39,18 @@ class Bitmap {
     Bitmap(uint16_t width, uint16_t height);
     ~Bitmap() = default;
 
-    uint16_t getWidth();
-    uint16_t getHeight();
+    Bitmap(const Bitmap&)            = default;
+    Bitmap& operator=(const Bitmap&) = default;
+    Bitmap(Bitmap&&)                 = default;
+    Bitmap& operator=(Bitmap&&)      = default;
+
+    [[nodiscard]] uint16_t getWidth() const;
+    [[nodiscard]] uint16_t getHeight() const;
     bool setPixels(const std::vector<T>& pixels);
-    std::vector<T> getPixelsCpy();
-    std::optional<std::vector<T>> getLine(uint16_t line);
-    std::optional<std::vector<T>> getCol(uint16_t col);
+    [[nodiscard]] std::vector<T> getPixelsCpy() const;
+    [[nodiscard]] std::optional<std::vector<T>> getLine(uint16_t line) const;
+    [[nodiscard]] std::optional<std::vector<T>> getCol(uint16_t col) const;
+    void visualize() const;
 
    private:
     uint16_t mWidth;

src/graphics/Image.cpp

@@ -1,57 +0,0 @@
-/* 
-    ptrnt - print labels on linux
-    Copyright (C) 2023  Moritz Martinius
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
- */
-
-#include "Image.hpp"
-
-#include <string>
-
-#include "pango/pango-font.h"
-
-namespace ptprnt::graphics {
-Image::Image() {
-    mSurface         = cairo_image_surface_create(CAIRO_FORMAT_A8, 512, 128);
-    cairo_t* cr      = cairo_create(mSurface);
-    mFontDescription = pango_font_description_new();
-    pango_font_description_set_family(mFontDescription, "sans");
-    pango_font_description_set_weight(mFontDescription, PANGO_WEIGHT_SEMIBOLD);
-    pango_font_description_set_size(mFontDescription, 60 * PANGO_SCALE);
-
-    std::string printThis("Mist 💩");
-
-    mLayout = pango_cairo_create_layout(cr);
-    pango_layout_set_font_description(mLayout, mFontDescription);
-    pango_layout_set_text(mLayout, printThis.c_str(), -1);
-
-    cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
-    cairo_move_to(cr, 0.0, 94.0);
-    pango_cairo_show_layout_line(cr, pango_layout_get_line(mLayout, 0));
-
-    cairo_surface_write_to_png(mSurface, "hello.png");
-}
-
-uint8_t* Image::getRaw() {
-    cairo_surface_flush(mSurface);
-    return cairo_image_surface_get_data(mSurface);
-}
-
-Image::~Image() {
-    g_object_unref(mLayout);
-    pango_font_description_free(mFontDescription);
-}
-}  // namespace ptprnt::graphics

src/graphics/Image.hpp

@@ -1,38 +0,0 @@
-/* 
-    ptrnt - print labels on linux
-    Copyright (C) 2023  Moritz Martinius
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
- */
-
-#pragma once
-
-#include <pango/pangocairo.h>
-
-#include <cstdint>
-
-namespace ptprnt::graphics {
-class Image {
-   public:
-    Image();
-    ~Image();
-    uint8_t* getRaw();
-
-   private:
-    PangoLayout* mLayout;
-    PangoFontDescription* mFontDescription;
-    cairo_surface_t* mSurface;
-};
-}  // namespace ptprnt::graphics

src/graphics/Label.cpp

@@ -0,0 +1,105 @@
+/* 
+    ptrnt - print labels on linux
+    Copyright (C) 2023  Moritz Martinius
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+ */
+
+#include "graphics/Label.hpp"
+
+#include <algorithm>
+#include <spdlog/spdlog.h>
+
+#include <cassert>
+#include <cstddef>
+#include <iostream>  // remove me
+#include <string>
+#include <vector>
+
+#include "cairo.h"
+#include "pango/pango-context.h"
+#include "pango/pango-font.h"
+#include "pango/pango-fontmap.h"
+#include "pango/pango-layout.h"
+#include "pango/pango-types.h"
+#include "pango/pangocairo.h"
+
+namespace ptprnt::graphics {
+Label::Label()
+    : mPangoCtx(pango_font_map_create_context(pango_cairo_font_map_get_default())),
+      mPangoLyt(pango_layout_new(mPangoCtx)),
+      mPangoFontDesc(pango_font_description_from_string("Noto sans 32")) {}
+
+std::vector<uint8_t> Label::getRaw() {
+    assert(mSurface != nullptr);
+    size_t len = mPrinterHeight * mLayoutWidth;
+
+    cairo_surface_flush(mSurface);
+    auto data = cairo_image_surface_get_data(mSurface);
+    return {data, data + len};
+}
+
+uint8_t Label::getNumLines(std::string_view strv) {
+    return std::count(strv.begin(), strv.end(), '\n');
+}
+
+int Label::getLayoutHeight() {
+    return mLayoutHeight;
+}
+
+int Label::getLayoutWidth() {
+    return mLayoutWidth;
+}
+
+void Label::create(const std::string& labelText, const uint16_t heightPixel) {
+    mPrinterHeight = heightPixel;
+    pango_layout_set_single_paragraph_mode(mPangoLyt, true);
+    pango_layout_set_height(mPangoLyt, getNumLines(labelText) * -1);
+    pango_layout_set_alignment(mPangoLyt, PANGO_ALIGN_CENTER);
+    pango_layout_set_font_description(mPangoLyt, mPangoFontDesc);
+    pango_context_load_font(mPangoCtx, mPangoFontDesc);
+    pango_layout_set_text(mPangoLyt, labelText.c_str(), static_cast<int>(labelText.length()));
+
+    pango_layout_get_size(mPangoLyt, &mLayoutWidth, &mLayoutHeight);
+
+    mLayoutWidth /= PANGO_SCALE;
+    mLayoutHeight /= PANGO_SCALE;
+
+    SPDLOG_DEBUG("Layout width: {}, height: {}", mLayoutWidth, mLayoutHeight);
+
+    mSurface    = cairo_image_surface_create(CAIRO_FORMAT_A8, mLayoutWidth, mPrinterHeight);
+    cairo_t* cr = cairo_create(mSurface);
+    pango_cairo_show_layout(cr, mPangoLyt);
+
+    cairo_set_source_rgb(cr, 0.0, 0.0, 0.0);
+    cairo_surface_flush(mSurface);
+    cairo_destroy(cr);
+}
+
+void Label::writeToPng(const std::string& file) {
+    if (mSurface) {
+        cairo_surface_flush(mSurface);
+        cairo_surface_write_to_png(mSurface, file.c_str());
+    }
+}
+
+Label::~Label() {
+    SPDLOG_DEBUG("Image dtor...");
+    pango_font_description_free(mPangoFontDesc);
+    g_object_unref(mPangoCtx);
+    g_object_unref(mPangoLyt);
+    cairo_surface_destroy(mSurface);
+}
+}  // namespace ptprnt::graphics

src/graphics/Label.hpp

@@ -0,0 +1,64 @@
+/* 
+    ptrnt - print labels on linux
+    Copyright (C) 2023  Moritz Martinius
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+ */
+
+#pragma once
+
+#include <pango/pangocairo.h>
+
+#include <cstdint>
+#include <string>
+#include <vector>
+
+#include "cairo.h"
+#include "pango/pango-font.h"
+#include "pango/pango-types.h"
+
+namespace ptprnt::graphics {
+
+constexpr const char* DEFAULT_FONT_FAMILY = "sans";
+constexpr const uint8_t DEFAULT_FONT_SIZE = 32;
+
+class Label {
+   public:
+    Label();
+    ~Label();
+
+    Label(const Label&)            = delete;
+    Label& operator=(const Label&) = delete;
+    Label(Label&&)                 = delete;
+    Label& operator=(Label&&)      = delete;
+
+    std::vector<uint8_t> getRaw();
+    void create(const std::string& labelText, const uint16_t heightPixel);
+    void writeToPng(const std::string& file);
+    int getLayoutWidth();
+    int getLayoutHeight();
+
+   private:
+    // methods
+    uint8_t getNumLines(std::string_view str);
+    // members
+    PangoContext* mPangoCtx{nullptr};
+    PangoLayout* mPangoLyt{nullptr};
+    PangoFontDescription* mPangoFontDesc{nullptr};
+    cairo_surface_t* mSurface{nullptr};
+    int mLayoutWidth = 0, mLayoutHeight = 0;
+    int mPrinterHeight = 0;
+};
+}  // namespace ptprnt::graphics

src/graphics/Monochrome.cpp

@@ -21,7 +21,9 @@
 
 #include <cmath>
 
-#include <cstdint>
+#include <cstdio>
+#include <cstdlib>
+#include <iostream>
 #include <vector>
 
 namespace ptprnt::graphics {
@@ -41,9 +43,9 @@ std::vector<uint8_t> Monochrome::get() {
 
     unsigned int outIndex = 0;
 
-    for (unsigned int byteNum = 0; byteNum < mPixels.size(); byteNum += 8) {
-        for (unsigned int bitNo = 0; bitNo < 8; bitNo++) {
-            if (mPixels[byteNum + bitNo] > mThreshhold) {
+    for (unsigned int byteNo = 0; byteNo < mPixels.size(); byteNo += 8) {
+        for (unsigned int bitNo = 0; bitNo <= 7 && (byteNo + bitNo < mPixels.size()); bitNo++) {
+            if (mPixels[byteNo + bitNo] > mThreshhold) {
                 outPixels[outIndex] |= (1 << (7 - bitNo));
             } else {
                 outPixels[outIndex] &= ~(1 << (7 - bitNo));
@@ -56,4 +58,20 @@ std::vector<uint8_t> Monochrome::get() {
     }
     return outPixels;
 }
+
+void Monochrome::visualize() {
+    auto mono = get();
+    for (unsigned char pix : mono) {
+        std::cout << ((pix & (1 << 7)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 6)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 5)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 4)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 3)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 2)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 1)) == 0 ? "." : "x");
+        std::cout << ((pix & (1 << 0)) == 0 ? "." : "x");
+    }
+    std::cout << std::endl;
+}
+
 }  // namespace ptprnt::graphics

src/graphics/Monochrome.hpp

@@ -31,11 +31,12 @@ class Monochrome {
 
     void setThreshold(uint8_t);
     void invert(bool shouldInvert);
+    void visualize();
     std::vector<uint8_t> get();
 
    private:
     const std::vector<uint8_t>& mPixels;
-    uint8_t mThreshhold = 127;
+    uint8_t mThreshhold = UINT8_MAX / 2;
     bool mShouldInvert  = false;
 };
 }  // namespace ptprnt::graphics

src/hello.txt

@@ -0,0 +1,7 @@
+{
+  "text" : " Hello",
+  "font" : "FreeSans 32",
+  "single-paragraph" : true,
+  "alignment" : "center",
+  "height" : 0
+}

src/interface/IPrinterDriver.hpp

@@ -27,9 +27,9 @@
 #include "libusbwrap/interface/IUsbDevice.hpp"
 
 namespace ptprnt {
-
 class IPrinterDriver {
    public:
+    virtual ~IPrinterDriver()                                                     = default;
     virtual const std::string_view getDriverName()                                = 0;
     virtual const std::string_view getName()                                      = 0;
     virtual const std::string_view getVersion()                                   = 0;

src/interface/IPrinterTypes.hpp

@@ -21,6 +21,7 @@
 
 #include <cstdint>
 #include <string_view>
+#include <vector>
 
 namespace ptprnt {
 
@@ -30,6 +31,7 @@ struct PrinterInfo {
     std::string_view version    = "";
     uint16_t vid                = 0x00;
     uint16_t pid                = 0x00;
+    uint16_t pixelLines         = 0;
 };
 
 struct PrinterStatus {
@@ -37,4 +39,6 @@ struct PrinterStatus {
     unsigned int tapeWidthMm    = 0.0;
 };
 
+using cmd_T = std::vector<uint8_t>;
+
 }  // namespace ptprnt

src/libusbwrap/UsbDevice.cpp

@@ -27,12 +27,13 @@
 #include "libusbwrap/interface/IUsbDevice.hpp"
 
 namespace libusbwrap {
-UsbDevice::UsbDevice(libusb_context* ctx, libusb_device* dev) : mLibusbCtx(ctx), mLibusbDev(dev) {
+UsbDevice::UsbDevice(libusb_context* ctx, usbDevice_ptr dev)
+    : mLibusbCtx(ctx), mLibusbDev(std::move(dev)) {
     if (mLibusbCtx == nullptr || mLibusbDev == nullptr) {
         throw std::invalid_argument("ctx or device are nullptr");
     }
 
-    libusb_get_device_descriptor(dev, &mLibusbDevDesc);
+    libusb_get_device_descriptor(mLibusbDev.get(), &mLibusbDevDesc);
 }
 
 UsbDevice::~UsbDevice() {
@@ -44,7 +45,7 @@ UsbDevice::~UsbDevice() {
 }
 
 bool UsbDevice::open() {
-    int openStatus = libusb_open(mLibusbDev, &mLibusbDevHandle);
+    int openStatus = libusb_open(mLibusbDev.get(), &mLibusbDevHandle);
     if (openStatus != 0) {
         mLastError = static_cast<Error>(openStatus);
         return false;
@@ -113,15 +114,15 @@ const uint16_t UsbDevice::getPid() {
 }
 
 const device::Speed UsbDevice::getSpeed() {
-    return static_cast<device::Speed>(libusb_get_device_speed(mLibusbDev));
+    return static_cast<device::Speed>(libusb_get_device_speed(mLibusbDev.get()));
 }
 
 const uint8_t UsbDevice::getBusNumber() {
-    return libusb_get_bus_number(mLibusbDev);
+    return libusb_get_bus_number(mLibusbDev.get());
 }
 
 const uint8_t UsbDevice::getPortNumber() {
-    return libusb_get_port_number(mLibusbDev);
+    return libusb_get_port_number(mLibusbDev.get());
 }
 
 const Error UsbDevice::getLastError() {

src/libusbwrap/UsbDevice.hpp

@@ -27,14 +27,27 @@
 #include "libusbwrap/interface/IUsbDevice.hpp"
 
 namespace libusbwrap {
+
+struct usbDevice_deleter {
+    void operator()(libusb_device* dev_ptr) const {
+        if (nullptr != dev_ptr) {
+            libusb_unref_device(dev_ptr);
+        }
+    }
+};
+
+using usbDevice_ptr = std::unique_ptr<libusb_device, usbDevice_deleter>;
+
 class UsbDevice : public IUsbDevice {
    public:
-    UsbDevice(libusb_context* ctx, libusb_device* dev);
-    ~UsbDevice();
+    explicit UsbDevice(libusb_context* ctx, usbDevice_ptr dev);
+    ~UsbDevice() override;
 
     // delete copy ctor and assignment
-    UsbDevice(const UsbDevice&)      = delete;
-    UsbDevice& operator=(UsbDevice&) = delete;
+    UsbDevice(const UsbDevice&)            = delete;
+    UsbDevice& operator=(const UsbDevice&) = delete;
+    UsbDevice(UsbDevice&&)                 = delete;
+    UsbDevice& operator=(UsbDevice&&)      = delete;
 
     bool open() override;
     void close() override;
@@ -59,9 +72,9 @@ class UsbDevice : public IUsbDevice {
 
    private:
     libusb_context* mLibusbCtx{nullptr};
-    libusb_device* mLibusbDev{nullptr};
+    usbDevice_ptr mLibusbDev{nullptr};
     libusb_device_handle* mLibusbDevHandle{nullptr};
-    libusb_device_descriptor mLibusbDevDesc;
+    libusb_device_descriptor mLibusbDevDesc{0};
     std::atomic<bool> mIsOpen = false;
     Error mLastError          = Error::SUCCESS;
 };

src/libusbwrap/UsbDeviceFactory.cpp

@@ -20,9 +20,11 @@
 #include "libusbwrap/UsbDeviceFactory.hpp"
 
 #include <spdlog/spdlog.h>
+#include <sys/types.h>
 
 #include <memory>
 #include <optional>
+#include <vector>
 
 #include "libusb.h"
 #include "libusbwrap/UsbDevice.hpp"
@@ -31,49 +33,56 @@
 namespace libusbwrap {
 
 UsbDeviceFactory::~UsbDeviceFactory() {
-    if (mDeviceListInitialized) {
-        libusb_free_device_list(mLibusbDeviceList, 1);
+    if (mLibusbCtx) {
+        libusb_exit(mLibusbCtx);
     }
-}
+};
 
-std::vector<std::shared_ptr<IUsbDevice>> UsbDeviceFactory::findAllDevices() {
+std::vector<std::unique_ptr<IUsbDevice>> UsbDeviceFactory::findAllDevices() {
     refreshDeviceList();
     return buildMaskedDeviceVector(0x0, 0x0, 0x0, 0x0);
 }
 
-std::vector<std::shared_ptr<IUsbDevice>> UsbDeviceFactory::findDevices(uint16_t vid, uint16_t pid) {
+std::vector<std::unique_ptr<IUsbDevice>> UsbDeviceFactory::findDevices(uint16_t vid, uint16_t pid) {
     refreshDeviceList();
-    return buildMaskedDeviceVector(0xffff, 0xffff, vid, pid);
+    return buildMaskedDeviceVector(LIBUSB_BITMASK_ALL, LIBUSB_BITMASK_ALL, vid, pid);
 }
 
-int UsbDeviceFactory::refreshDeviceList() {
-    int ret = libusb_get_device_list(mLibusbCtx, &mLibusbDeviceList);
+ssize_t UsbDeviceFactory::refreshDeviceList() {
+    libusb_device** list{nullptr};
+
+    ssize_t ret = libusb_get_device_list(mLibusbCtx, &list);
+    mLibusbDeviceList.clear();
     if (ret < 0) {
         spdlog::error("Error enumarating USB devices");
     } else if (ret == 0) {
         spdlog::warn("No USB devices found");
     }
-    mDeviceListInitialized = true;
+
+    for (ssize_t i = 0; i < ret; i++) {
+        mLibusbDeviceList.emplace_back(list[i]);
+    }
+
+    libusb_free_device_list(list, false);
     return ret;
 }
 
-std::vector<std::shared_ptr<IUsbDevice>> UsbDeviceFactory::buildMaskedDeviceVector(uint16_t vidMask,
+std::vector<std::unique_ptr<IUsbDevice>> UsbDeviceFactory::buildMaskedDeviceVector(uint16_t vidMask,
                                                                                    uint16_t pidMask,
                                                                                    uint16_t vid,
                                                                                    uint16_t pid) {
-    std::vector<std::shared_ptr<IUsbDevice>> matchedDevices;
+    std::vector<std::unique_ptr<IUsbDevice>> matchedDevices;
     // see libusb/examples/listdevs.c
-    int i                  = 0;
-    libusb_device* currDev = nullptr;
-    while ((currDev = mLibusbDeviceList[i++]) != nullptr) {
-        struct libusb_device_descriptor currDevDesc;
-        int ret = libusb_get_device_descriptor(currDev, &currDevDesc);
+    for (auto& currDev : mLibusbDeviceList) {
+        struct libusb_device_descriptor currDevDesc {};
+
+        int ret = libusb_get_device_descriptor(currDev.get(), &currDevDesc);
         if (ret < 0) {
             continue;
         }
         if (((currDevDesc.idVendor & vidMask) == vid) &&
             ((currDevDesc.idProduct & pidMask) == pid)) {
-            matchedDevices.push_back(std::make_shared<UsbDevice>(mLibusbCtx, currDev));
+            matchedDevices.push_back(std::make_unique<UsbDevice>(mLibusbCtx, std::move(currDev)));
         }
     }
     return matchedDevices;

src/libusbwrap/UsbDeviceFactory.hpp

@@ -19,9 +19,16 @@
 
 #pragma once
 
+#include <cstdint>
+
+#include "libusb.h"
+#include "libusbwrap/UsbDevice.hpp"
 #include "libusbwrap/interface/IUsbDeviceFactory.hpp"
 
 namespace libusbwrap {
+
+constexpr const uint16_t LIBUSB_BITMASK_ALL = 0xffff;
+
 class UsbDeviceFactory : public IUsbDeviceFactory {
    public:
     UsbDeviceFactory() = default;
@@ -39,7 +46,7 @@ class UsbDeviceFactory : public IUsbDeviceFactory {
      * 
      * @return std::vector<std::shared_ptr<IUsbDevice>> Vector of all detected USB devices
      */
-    std::vector<std::shared_ptr<IUsbDevice>> findAllDevices() override;
+    std::vector<std::unique_ptr<IUsbDevice>> findAllDevices() override;
     /**
      * @brief Gets all devices with certain vid/pid combination. 
      *        If only one device of certain type is connected, vector is usually only one element
@@ -48,17 +55,17 @@ class UsbDeviceFactory : public IUsbDeviceFactory {
      * @param pid ProductId of the devices to find
      * @return std::vector<std::shared_ptr<IUsbDevice>> Vector of detected USB devices based on vid/pid
      */
-    std::vector<std::shared_ptr<IUsbDevice>> findDevices(uint16_t vid, uint16_t pid) override;
+    std::vector<std::unique_ptr<IUsbDevice>> findDevices(uint16_t vid, uint16_t pid) override;
 
    private:
     // methods
-    int refreshDeviceList();
-    std::vector<std::shared_ptr<IUsbDevice>> buildMaskedDeviceVector(uint16_t vidMask,
+    ssize_t refreshDeviceList();
+    std::vector<std::unique_ptr<IUsbDevice>> buildMaskedDeviceVector(uint16_t vidMask,
                                                                      uint16_t pidMask, uint16_t vid,
                                                                      uint16_t pid);
     // members
     libusb_context* mLibusbCtx{nullptr};
-    libusb_device** mLibusbDeviceList{};
+    std::vector<usbDevice_ptr> mLibusbDeviceList{};
     bool mDeviceListInitialized = false;
 };
 }  // namespace libusbwrap

src/libusbwrap/interface/IUsbDevice.hpp

@@ -24,8 +24,9 @@ enum class Speed {
 
 class IUsbDevice {
    public:
-    virtual bool open()  = 0;
-    virtual void close() = 0;
+    virtual ~IUsbDevice() = default;
+    virtual bool open()   = 0;
+    virtual void close()  = 0;
 
     // libusb wrappers
     virtual bool detachKernelDriver(int interfaceNo) = 0;

src/libusbwrap/interface/IUsbDeviceFactory.hpp

@@ -9,7 +9,8 @@
 namespace libusbwrap {
 class IUsbDeviceFactory {
    public:
-    virtual std::vector<std::shared_ptr<IUsbDevice>> findAllDevices()                        = 0;
-    virtual std::vector<std::shared_ptr<IUsbDevice>> findDevices(uint16_t vid, uint16_t pid) = 0;
+    virtual ~IUsbDeviceFactory()                                      = default;
+    virtual std::vector<std::unique_ptr<IUsbDevice>> findAllDevices() = 0;
+    virtual std::vector<std::unique_ptr<IUsbDevice>> findDevices(uint16_t vid, uint16_t pid) = 0;
 };
 }  // namespace libusbwrap

src/meson.build

@@ -9,14 +9,14 @@ ptprnt_hpps = files (
     'P700Printer.hpp',
     'PtouchPrint.hpp',
     'graphics/Bitmap.hpp',
-    'graphics/Image.hpp',
+    'graphics/Label.hpp',
     'graphics/Monochrome.hpp'
 )
 
 ptprnt_srcs = files (
     'PtouchPrint.cpp',
     'P700Printer.cpp',
-    'graphics/Image.cpp',
+    'graphics/Label.cpp',
     'graphics/Bitmap.cpp',
     'graphics/Monochrome.cpp',
     'libusbwrap/UsbDeviceFactory.cpp',

tests/label_test/label_test.cpp

@@ -17,12 +17,12 @@
 
  */
 
-#include "graphics/Image.hpp"
+#include "graphics/Label.hpp"
 
 #include <gtest/gtest.h>
 
 #include <optional>
 
-TEST(basic_test, Image_smokeTest_succeeds) {
-    auto im = ptprnt::graphics::Image();
+TEST(basic_test, Label_smokeTest_succeeds) {
+    auto im = ptprnt::graphics::Label();
 }

tests/meson.build

@@ -1,5 +1,5 @@
 tests = [['bitmap_test', 'bitmap_test_exe', ptprnt_srcs + ['bitmap_test/bitmap_test.cpp']],
-         ['image_test', 'image_test_exe', ptprnt_srcs +['image_test/image_test.cpp']],
+         ['label_test', 'label_test_exe', ptprnt_srcs +['label_test/label_test.cpp']],
          ['monochrome_test', 'monochrome_test_exe', ptprnt_srcs +['monochrome_test/monochrome_test.cpp']]
         ]