More player debugging for butler video-full states.
[dcpomatic.git] / src / lib / filter.h
index 66ecc4308355ba19c55cd4fa91a2ffbc8d4619d7..455b271a2c7b8b18c94f9d8258d1a2eab4654ad2 100644 (file)
@@ -1,24 +1,25 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 /** @file src/filter.h
- *  @brief A class to describe one of FFmpeg's video or post-processing filters.
+ *  @brief A class to describe one of FFmpeg's video or audio filters.
  */
 
 #ifndef DCPOMATIC_FILTER_H
@@ -29,7 +30,7 @@
 #include <vector>
 
 /** @class Filter
- *  @brief A class to describe one of FFmpeg's video filters.
+ *  @brief A class to describe one of FFmpeg's video or audio filters.
  *
  *  We don't support FFmpeg's post-processing filters here as they cannot cope with greater than
  *  8bpp.  FFmpeg quantizes e.g. yuv422p10le down to yuv422p before running such filters, which
@@ -38,7 +39,7 @@
 class Filter : public boost::noncopyable
 {
 public:
-       Filter (std::string, std::string, std::string, std::string);
+       Filter (std::string i, std::string n, std::string c, std::string f);
 
        /** @return our id */
        std::string id () const {
@@ -50,19 +51,19 @@ public:
                return _name;
        }
 
-       /** @return string for a FFmpeg video filter descriptor */
-       std::string vf () const {
-               return _vf;
+       /** @return string for a FFmpeg filter descriptor */
+       std::string ffmpeg () const {
+               return _ffmpeg;
        }
-       
+
        std::string category () const {
                return _category;
        }
-       
+
        static std::vector<Filter const *> all ();
-       static Filter const * from_id (std::string);
+       static Filter const * from_id (std::string d);
        static void setup_filters ();
-       static std::string ffmpeg_string (std::vector<Filter const *> const &);
+       static std::string ffmpeg_string (std::vector<Filter const *> const & filters);
 
 private:
 
@@ -71,8 +72,8 @@ private:
        /** user-visible name */
        std::string _name;
        std::string _category;
-       /** string for a FFmpeg video filter descriptor */
-       std::string _vf;
+       /** string for a FFmpeg filter descriptor */
+       std::string _ffmpeg;
 
        /** all available filters */
        static std::vector<Filter const *> _filters;