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 e5625d415b5662f8e7885102d9058e1513eb1914..8c2001c174ee31e963e7c67b8670a324ccfb891f 100644 (file)
--- a/src/wx/audio_dialog.h
+++ b/src/wx/audio_dialog.h
@@ -18,31 +18,40 @@
 
 */
 
-#include "lib/film.h"
+
 #include "lib/audio_analysis.h"
+#include "lib/constants.h"
+#include "lib/film_property.h"
 #include "lib/playlist.h"
-#include "lib/warnings.h"
-DCPOMATIC_DISABLE_WARNINGS
+#include <dcp/warnings.h>
+LIBDCP_DISABLE_WARNINGS
 #include <wx/wx.h>
-DCPOMATIC_ENABLE_WARNINGS
-#include <boost/shared_ptr.hpp>
+LIBDCP_ENABLE_WARNINGS
 #include <boost/signals2.hpp>
 
+
 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, boost::shared_ptr<Film> film, boost::weak_ptr<FilmViewer> viewer, boost::shared_ptr<Content> content = boost::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);
+       bool Show (bool show = true) override;
 
        void set_cursor (boost::optional<dcpomatic::DCPTime> time, boost::optional<float> db);
 
 private:
-       void film_change (ChangeType, int);
+       void film_change(ChangeType, FilmProperty);
        void content_change (ChangeType, int);
        void channel_clicked (wxCommandEvent &);
        void type_clicked (wxCommandEvent &);
@@ -50,14 +59,14 @@ private:
        void try_to_load_analysis ();
        void analysis_finished ();
        void setup_statistics ();
+       void show_or_hide_channel_checkboxes ();
 
-       boost::shared_ptr<AudioAnalysis> _analysis;
-       boost::weak_ptr<Film> _film;
-       boost::weak_ptr<FilmViewer> _viewer;
+       std::shared_ptr<AudioAnalysis> _analysis;
+       std::weak_ptr<Film> _film;
        /** content to analyse, or 0 to analyse all the film's content */
-       boost::weak_ptr<Content> _content;
+       std::weak_ptr<Content> _content;
        int _channels;
-       boost::shared_ptr<const Playlist> _playlist;
+       std::shared_ptr<const Playlist> _playlist;
        wxStaticText* _cursor;
        AudioPlot* _plot;
        wxStaticText* _sample_peak;
@@ -65,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;