di_manager.h

// di_manager.h - Function declarations for managing drawing-instruction primitives
//
// Copyright (c) 2023 Curtis Whitley
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// 

#pragma once

#include <vector>
#include <map>
#include "rom/lldesc.h"
#include "di_video_buffer.h"
#include "di_primitive_group.h"

class DiManager {
    public:
    // Construct a drawing-instruction manager, which handles multiple drawing primitives.
    DiManager();

    // Destroy the manager and its child primitives.
    ~DiManager();

    // Create various types of drawing primitives.
    DiPrimitive* create_point(int32_t x, int32_t y, uint8_t color);
    DiPrimitive* create_line(int32_t x1, int32_t y1, int32_t x2, int32_t y2, uint8_t color);
    DiPrimitive* create_solid_rectangle(int32_t x, int32_t y, uint32_t width, uint32_t height, uint8_t color);
    DiPrimitive* create_triangle(int32_t x1, int32_t y1, int32_t x2, int32_t y2, int32_t x3, int32_t y3, uint8_t color);
    //DiPrimitiveGroup* create_group();

    // Setup and run the main loop to do continuous drawing.
    // For the demo, the loop never ends.
    void IRAM_ATTR run();

    protected:
    // Structures used to support DMA for video.
    volatile lldesc_t *        m_dma_descriptor; // [DMA_TOTAL_DESCR]
    volatile DiVideoBuffer *   m_video_buffer; // [NUM_ACTIVE_BUFFERS]
    volatile DiVideoScanLine * m_front_porch;
    volatile DiVideoBuffer *   m_vertical_sync;
    volatile DiVideoScanLine * m_back_porch;

    std::map<DiPrimitive*, bool> m_primitives; // Top-level primitives (which might include groups)
    std::vector<DiPrimitive*> m_groups[NUM_VERTICAL_GROUPS]; // Vertical scan groups (for optimizing paint calls)

    // Setup the DMA stuff.
    void initialize();

    // Run the main loop.
    void IRAM_ATTR loop();

    // Clear the primitive data, etc.
    void clear();

    // Attach a top-level primitive to the manager. This could be a group (or not).
    void add_primitive(DiPrimitive* prim);

    // Remove a top-level primitive from the manager.
    void remove_primitive(DiPrimitive* prim);

    // Draw all primitives that belong to the active scan line group.
    void IRAM_ATTR draw_primitives(DiPaintParams* params);

    // Update things like X,Y coordinates, adding/removing primitives, etc.
    void IRAM_ATTR on_vertical_blank();

    // Setup a single DMA descriptor.
    void init_dma_descriptor(volatile DiVideoScanLine* vbuf, uint32_t descr_index);

    // Setup a pair of DMA descriptors.
    void init_dma_descriptor(volatile DiVideoBuffer* vbuf, uint32_t descr_index);

    // Create some sample demo primitives.
    void create_samples();
};