Add comment about AudioDialog.

[dcpomatic.git] / src / wx / audio_dialog.h

diff --git a/src/wx/audio_dialog.h b/src/wx/audio_dialog.h
index a202ad65b1d6be3ef0bf9c81be3cd51730b13caf..8c2001c174ee31e963e7c67b8670a324ccfb891f 100644 (file)
--- a/src/wx/audio_dialog.h
+++ b/src/wx/audio_dialog.h
@@ -20,7 +20,8 @@
 
 
 #include "lib/audio_analysis.h"
-#include "lib/film.h"
+#include "lib/constants.h"
+#include "lib/film_property.h"
 #include "lib/playlist.h"
 #include <dcp/warnings.h>
 LIBDCP_DISABLE_WARNINGS
@@ -30,21 +31,27 @@ LIBDCP_ENABLE_WARNINGS
 
 
 class AudioPlot;
+class CheckBox;
 class FilmViewer;
 class Film;
 
 
+/** @class AudioDialog
+ *  @brief Dialog to display audio analysis.
+ *
+ *  This can be used for the whole DCP, or a specific piece of content if one is passed into the constructor.
+ */
 class AudioDialog : public wxDialog
 {
 public:
-       AudioDialog (wxWindow* parent, std::shared_ptr<Film> film, std::weak_ptr<FilmViewer> viewer, std::shared_ptr<Content> content = std::shared_ptr<Content>());
+       AudioDialog(wxWindow* parent, std::shared_ptr<Film> film, FilmViewer& viewer, std::shared_ptr<Content> content = std::shared_ptr<Content>());
 
        bool Show (bool show = true) override;
 
        void set_cursor (boost::optional<dcpomatic::DCPTime> time, boost::optional<float> db);
 
 private:
-       void film_change (ChangeType, Film::Property);
+       void film_change(ChangeType, FilmProperty);
        void content_change (ChangeType, int);
        void channel_clicked (wxCommandEvent &);
        void type_clicked (wxCommandEvent &);
@@ -56,7 +63,6 @@ private:
 
        std::shared_ptr<AudioAnalysis> _analysis;
        std::weak_ptr<Film> _film;
-       std::weak_ptr<FilmViewer> _viewer;
        /** content to analyse, or 0 to analyse all the film's content */
        std::weak_ptr<Content> _content;
        int _channels;
@@ -68,8 +74,8 @@ private:
        wxStaticText* _integrated_loudness;
        wxStaticText* _loudness_range;
        wxStaticText* _leqm;
-       wxCheckBox* _channel_checkbox[MAX_DCP_AUDIO_CHANNELS];
-       wxCheckBox* _type_checkbox[AudioPoint::COUNT];
+       CheckBox* _channel_checkbox[MAX_DCP_AUDIO_CHANNELS];
+       CheckBox* _type_checkbox[AudioPoint::COUNT];
        wxSlider* _smoothing;
        boost::signals2::scoped_connection _film_connection;
        boost::signals2::scoped_connection _film_content_connection;