PhysicalCameraView.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Widgets
File: PhysicalCameraView
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#if NDEVR_VIEWPORT
#include <NDEVR/CameraView.h>
#include <NDEVR/ViewportFactory.h>
#include <NDEVR/QCustomStackedWidget.h>
#include <NDEVR/Camera.h>
#include <NDEVR/Pointer.h>
#include <NDEVR/ApplicationOptions.h>
#include <NDEVR/TranslatedString.h>
#include <NDEVR/File.h>
QT_BEGIN_NAMESPACE
namespace Ui { class PhysicalCameraViewUI; }
QT_END_NAMESPACE
namespace NDEVR
{
    class Toolbar;
    class Button;
    class Ruler;
    class InfoPipe;
    class WindowContainer;
    class QCustomStackedWidget;
    class TimeSpan;
    class PhysicalCameraViewFactory;
    class CameraRulerMenu;
    class QCustomSlider;
    class DESIGN_WIDGETS_API PhysicalCameraView : public CameraView
    {
        Q_OBJECT
    public:
        enum ViewMode
        {
              e_loading     
            , e_error       
            , e_camera      
        };

        struct OutputCodec
        {
            String id;              
            TranslatedString name;  
        };

        struct OutputMux
        {
            String id;              
            TranslatedString name;  
        };

        struct ToolButtonSettings
        {
            bool show_refresh_button = false;           
            bool show_take_image_button = true;         
            bool show_record_button = true;             
            bool show_pause_record_button = true;       
            bool show_invert_image_button = false;      
            bool show_orient_camera_button = true;      
            bool show_swap_camera_button = false;       
            bool show_moveable_button = false;          
            bool show_light_button = false;             
            bool show_light_brightness_slider = true;   
            bool show_zoom_button = true;               
            bool show_settings_button = false;          
            bool show_compass_button = false;           
        };
    protected:
        PhysicalCameraView();
        PhysicalCameraView(const DynamicPointer<Camera>& camera, QWidget* parent = nullptr);
    public:
        virtual ~PhysicalCameraView();
        virtual void updateView() override;
        virtual void setTouchTheme(bool touch_theme) override;
        virtual void setSwapMode(SwapMode mode) override;
        void setScreenshotPath(const File& file) { m_screenshot_path = file; }
        void setVideoOutputPath(const File& file);
        virtual void showToolRibbon(bool show_ribbon) override;
        virtual void resetToolRibbon() override;
        virtual void startNewRecording(StringView file_name = StringView());
        virtual void stopAndSaveRecording();
        void mouseReleaseEvent(QMouseEvent *releaseEvent) override;
        QWidget* activeWidget() const;
        void leaveEvent(QEvent* leave) override;
        bool event(QEvent* event) override;
        virtual void setIconSizeMultiplier(fltp04 multiplier) override;
        virtual void addWidget(const QPointer<QWidget>& button) override;
        virtual void removeWidget(const QPointer<QWidget>& button) override;
        void setErrorState(bool is_in_error_state);
        void setupForCaptureMode(bool capture_mode);
        void setAutoRotateCamera(bool auto_rotate);
        Button* lightButton() const;
        Button* refreshButton() const;
        Button* takeImageButton() const;
        Button* invertImageButton() const;
        void takeImage();
        void setLog(LogPtr log);
        LogPtr log() const { return m_log; }
        void setConnectingMessage(const TranslatedString& message);
        void setConnectingIcon(const StringView& image);
        void setErrorIcon(const StringView& image);
        void setScreenshotFileName(const StringView& file_name);
        virtual void setRecordingState(RecordingState recording_state);
        RecordingState recordingState() const override { return m_recording_state; }
        virtual QImage grabFramebuffer();
        virtual UUID id() const override { return m_camera->get<NDPO::guid>(); }
        virtual ConstPointer<Camera> camera() const override { return m_camera; };
        virtual DynamicPointer<Camera> camera() override  { return m_camera; };
        ToolButtonSettings buttonSettings() const { return m_tool_button_settings; };
        QWidget* stack() const;
        void setButtonSettings(const ToolButtonSettings& settings);
        void setSettingsWidget(QWidget* settings_widget, bool is_popup = false);
        void setSettingsVisible(bool visible, PopupInfo info);
        void setRecordingElapsedTime(const TimeSpan& span);
        void tryToConnect();
        File screenshotPath() const;
        File videoPath() const;
        StringView activeVideoMux() const;
        StringView activeCodec() const;
        void setLightBrightness(fltp04 percent);
        virtual QPointer<QWidget> lightingSliderWidget();
        fltp08 maxZoomOut() const;
    public:
        static void ResetSettingsToDefaults();
        static Buffer<PhysicalCameraView::OutputCodec> SupportedOutputCodecs();
        static Buffer<PhysicalCameraView::OutputMux> SupportedOutputMuxes();
    protected:
        virtual void init();
        void updateCameraRotation();
        virtual ToolButtonSettings defaultButtonSettings() const;
        virtual bool startRecord(const File& file);
        virtual bool finishRecord(File file);
        virtual bool pauseRecord(bool paused, const File& file);
        virtual bool takeImage(const File& file);
        virtual void refreshInstance() {}
        virtual File recordPath(StringView name, bool is_finished_recording) const;
        WindowContainer* windowContainer() const;
        virtual void cleanup();
        virtual int heightForWidth(int w) const override;
        virtual QSize sizeHint() const override;
        virtual QWidget* cameraToolbar() override;
        virtual bool setCameraSource(const StringView& camera_info);
        virtual void handleError();
        QCustomStackedWidget* stackedWidget() const;
        void startCamera();
        void stopCamera();
        void setupRulers();
        void updateRulers();
        void updateCameraWindowSize();
        void pause();
        void stop();
        void setMuted(bool);
        void sourceChanged();
        void networkRequestReady();
        void toggleLock();
        virtual void invertScreenColors(bool invert);
        void setExposureCompensation(int index);
        void processCapturedImage(const QPixmap& img);
        virtual void displayCurrentViewTab(QCustomStackedWidget::StackAnimationDirection = QCustomStackedWidget::e_automatic);
        void displayFinder(QCustomStackedWidget::StackAnimationDirection = QCustomStackedWidget::e_automatic);
        void displayCamera(QCustomStackedWidget::StackAnimationDirection = QCustomStackedWidget::e_automatic);
        void displayError(const TranslatedString& error, QCustomStackedWidget::StackAnimationDirection = QCustomStackedWidget::e_automatic);
        virtual QPointer<QWidget> settingsWidget();
        void keyPressEvent(QKeyEvent* event) override;
        void keyReleaseEvent(QKeyEvent* event) override;
        void closeEvent(QCloseEvent* event) override;
    signals:
        void requestLight(bool light_on);               
        void requestLightBrightness(fltp04 percent);    
    public slots:
        void windowCapturedEvent(QEvent* event);
        void setReadyForImageCapture(bool ready);
        void mediaPlayingSlot();
        void mediaEnd();
        void mediaOpening();
        void mediaStateChanged();
        void mediaStopped();
        void mediaError();
    protected:
        DynamicPointer<Camera> m_camera;                        
        Ui::PhysicalCameraViewUI *ui;                       
        WindowContainer* m_view_panel;                      
        TranslatedString m_last_error;                      
        String m_error_icon;                                
        String m_connecting_icon;                           
        String m_screenshot_file_name;                      
        String m_output_mux;                                
        String m_output_codec;                              
        TranslatedString m_connecting_message;              
        ToolButtonSettings m_tool_button_settings;          
        QPointer<QWidget> m_settings_widget;                
        QPointer<QWidget> m_brightness_slider_widget;       
        QPointer<QCustomSlider> m_brightness_slider;        
        RecordingState m_recording_state = RecordingState::e_stopped;   
        ViewMode m_view_mode = e_loading;                   
        File m_active_record_path;                          
        File m_screenshot_path;                             
        File m_video_path;                                  
        String m_file_name;                                 
        Toolbar* m_toolbar = nullptr;                       
        QTimer* m_timeout_timer = nullptr;                  
        LogPtr m_log;                                       
        Ruler* m_side_ruler = nullptr;                      
        Ruler* m_top_ruler = nullptr;                       
        Button* m_ruler_button = nullptr;                   
        QPointer<CameraRulerMenu> m_ruler_combo;            
        bool m_is_capturing_image = false;                  
        bool m_application_exiting = false;                 
        bool m_is_black_and_white = false;                  
        bool m_is_inverted_color = false;                   
        bool m_lock_controls = false;                       
        bool m_show_edge_ruler = false;                     
        bool m_show_top_ruler = false;                      
        bool m_tool_temp_showing = false;                   
        bool m_is_in_error_state = false;                   
        bool m_is_playing = false;                          
        bool m_settings_popup = true;                       
    public:
        static Dictionary<UUID, PhysicalCameraView*> s_active_logging;  
    public:
        static ApplicationOption<bool> write_video_to_memory;               
        static Resource<File> default_screenshot_folder;                    
        static Resource<File> default_video_folder;                         
        static ApplicationOption<String> default_output_mux;                
        static ApplicationOption<String> default_output_codec;              
        static ApplicationOption<uint04> default_output_fps;                
        static ApplicationOption<TimeSpan> default_buffer_time;             
        static ApplicationOption<uint04> default_output_bitrate;            
        static ApplicationOption<String> default_output_extension;          
        static ApplicationOption<String> default_camera_server_location;    
        static ApplicationOption<String> default_camera_server_password;    
        static ApplicationOption<Angle<fltp08>> default_camera_angle_offset;
    };

    class PhysicalCameraViewFactory : public ViewportFactory
    {
    public:
        virtual Buffer<PhysicalCameraView::OutputCodec> supportedOutputCodecs() { return Buffer<PhysicalCameraView::OutputCodec>(); };
        virtual Buffer<PhysicalCameraView::OutputMux> supportedOutputMuxes() { return Buffer<PhysicalCameraView::OutputMux>(); };
    };
    DESIGN_WIDGETS_T_API template class DESIGN_WIDGETS_API StringStream<PhysicalCameraView::OutputMux>;
    DESIGN_WIDGETS_T_API template class DESIGN_WIDGETS_API StringStream<PhysicalCameraView::OutputCodec>;
}
#endif