Tidy up test film naming.
[dcpomatic.git] / src / lib / config.h
index 64bcf4d86d9ca0c7d7155f5c79af60832692c3fb..840dcdaef7a5ebcea32f0c5bd680c6ab0de1b878 100644 (file)
@@ -28,7 +28,7 @@
 #include <boost/shared_ptr.hpp>
 #include <sigc++/signal.h>
 
-class Server;
+class ServerDescription;
 class Screen;
 class Scaler;
 class Filter;
@@ -54,7 +54,6 @@ public:
        /** @return index of colour LUT to use when converting RGB to XYZ.
         *  0: sRGB
         *  1: Rec 709
-        *  2: DC28
         */
        int colour_lut_index () const {
                return _colour_lut_index;
@@ -66,7 +65,7 @@ public:
        }
 
        /** @return J2K encoding servers to use */
-       std::vector<Server*> servers () const {
+       std::vector<ServerDescription*> servers () const {
                return _servers;
        }
 
@@ -82,18 +81,22 @@ public:
                return _reference_filters;
        }
 
+       /** @return The IP address of a TMS that we can copy DCPs to */
        std::string tms_ip () const {
                return _tms_ip;
        }
 
+       /** @return The path on a TMS that we should write DCPs to */
        std::string tms_path () const {
                return _tms_path;
        }
 
+       /** @return User name to log into the TMS with */
        std::string tms_user () const {
                return _tms_user;
        }
 
+       /** @return Password to log into the TMS with */
        std::string tms_password () const {
                return _tms_password;
        }
@@ -127,7 +130,7 @@ public:
        }
 
        /** @param s New list of servers */
-       void set_servers (std::vector<Server*> s) {
+       void set_servers (std::vector<ServerDescription*> s) {
                _servers = s;
                Changed ();
        }
@@ -147,21 +150,25 @@ public:
                Changed ();
        }
 
+       /** @param i IP address of a TMS that we can copy DCPs to */
        void set_tms_ip (std::string i) {
                _tms_ip = i;
                Changed ();
        }
 
+       /** @param p Path on a TMS that we should write DCPs to */
        void set_tms_path (std::string p) {
                _tms_path = p;
                Changed ();
        }
 
+       /** @param u User name to log into the TMS with */
        void set_tms_user (std::string u) {
                _tms_user = u;
                Changed ();
        }
 
+       /** @param p Password to log into the TMS with */
        void set_tms_password (std::string p) {
                _tms_password = p;
                Changed ();
@@ -185,26 +192,26 @@ private:
         *  (see colour_lut_index ())
         */
        int _colour_lut_index;
-       /** bandwidth for J2K files in Mb/s */
+       /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
 
        /** J2K encoding servers to use */
-       std::vector<Server *> _servers;
-
+       std::vector<ServerDescription *> _servers;
        /** Screen definitions */
        std::vector<boost::shared_ptr<Screen> > _screens;
-
        /** Scaler to use for the "A" part of A/B comparisons */
        Scaler const * _reference_scaler;
-
        /** Filters to use for the "A" part of A/B comparisons */
        std::vector<Filter const *> _reference_filters;
-
+       /** The IP address of a TMS that we can copy DCPs to */
        std::string _tms_ip;
+       /** The path on a TMS that we should write DCPs to */
        std::string _tms_path;
+       /** User name to log into the TMS with */
        std::string _tms_user;
+       /** Password to log into the TMS with */
        std::string _tms_password;
-
+       /** Our sound processor */
        SoundProcessor const * _sound_processor;
 
        /** Singleton instance, or 0 */