aboutsummaryrefslogtreecommitdiff
path: root/youtube_dl/postprocessor/common.py
diff options
context:
space:
mode:
authorPhilipp Hagemeister <phihag@phihag.de>2014-01-07 05:59:22 +0100
committerPhilipp Hagemeister <phihag@phihag.de>2014-01-07 05:59:22 +0100
commit496c19234c3c1b50c6ad0c6a8aa0cbe09d54cea5 (patch)
tree78b5049103489ab8775dd9a1381045aca449a87c /youtube_dl/postprocessor/common.py
parent4f81667d76dca6844b454dde61352f7d889237c0 (diff)
downloadyoutube-dl-496c19234c3c1b50c6ad0c6a8aa0cbe09d54cea5.tar.xz
Split postprocessor package into multiple modules
Diffstat (limited to 'youtube_dl/postprocessor/common.py')
-rw-r--r--youtube_dl/postprocessor/common.py49
1 files changed, 49 insertions, 0 deletions
diff --git a/youtube_dl/postprocessor/common.py b/youtube_dl/postprocessor/common.py
new file mode 100644
index 000000000..788f94d02
--- /dev/null
+++ b/youtube_dl/postprocessor/common.py
@@ -0,0 +1,49 @@
+from ..utils import PostProcessingError
+
+
+class PostProcessor(object):
+ """Post Processor class.
+
+ PostProcessor objects can be added to downloaders with their
+ add_post_processor() method. When the downloader has finished a
+ successful download, it will take its internal chain of PostProcessors
+ and start calling the run() method on each one of them, first with
+ an initial argument and then with the returned value of the previous
+ PostProcessor.
+
+ The chain will be stopped if one of them ever returns None or the end
+ of the chain is reached.
+
+ PostProcessor objects follow a "mutual registration" process similar
+ to InfoExtractor objects.
+ """
+
+ _downloader = None
+
+ def __init__(self, downloader=None):
+ self._downloader = downloader
+
+ def set_downloader(self, downloader):
+ """Sets the downloader for this PP."""
+ self._downloader = downloader
+
+ def run(self, information):
+ """Run the PostProcessor.
+
+ The "information" argument is a dictionary like the ones
+ composed by InfoExtractors. The only difference is that this
+ one has an extra field called "filepath" that points to the
+ downloaded file.
+
+ This method returns a tuple, the first element of which describes
+ whether the original file should be kept (i.e. not deleted - None for
+ no preference), and the second of which is the updated information.
+
+ In addition, this method may raise a PostProcessingError
+ exception if post processing fails.
+ """
+ return None, information # by default, keep file and do nothing
+
+
+class AudioConversionError(PostProcessingError):
+ pass