fix conflicts and merge with master
[ardour.git] / libs / ardour / export_handler.cc
index 5da8ac9211e122073a3aa3a4c28e861787f37ccc..5710ecc45213624d2749bff190b5c41903cb3608 100644 (file)
 
 #include "ardour/export_handler.h"
 
+#include <glib/gstdio.h>
 #include <glibmm.h>
 #include <glibmm/convert.h>
 
 #include "pbd/convert.h"
-#include "pbd/filesystem.h"
 
-#include "ardour/ardour.h"
-#include "ardour/configuration.h"
 #include "ardour/export_graph_builder.h"
 #include "ardour/export_timespan.h"
 #include "ardour/export_channel_configuration.h"
 #include "ardour/export_status.h"
 #include "ardour/export_format_specification.h"
 #include "ardour/export_filename.h"
-#include "ardour/export_failed.h"
 
 #include "i18n.h"
 
@@ -106,7 +103,6 @@ ExportHandler::ExportHandler (Session & session)
   , session (session)
   , graph_builder (new ExportGraphBuilder (session))
   , export_status (session.get_export_status ())
-  , realtime (false)
   , normalizing (false)
   , cue_tracknum (0)
   , cue_indexnum (0)
@@ -115,37 +111,38 @@ ExportHandler::ExportHandler (Session & session)
 
 ExportHandler::~ExportHandler ()
 {
-       // TODO remove files that were written but not finsihed
+       // TODO remove files that were written but not finished
 }
 
+/** Add an export to the `to-do' list */
 bool
 ExportHandler::add_export_config (ExportTimespanPtr timespan, ExportChannelConfigPtr channel_config,
                                   ExportFormatSpecPtr format, ExportFilenamePtr filename,
                                   BroadcastInfoPtr broadcast_info)
 {
        FileSpec spec (channel_config, format, filename, broadcast_info);
-       ConfigPair pair (timespan, spec);
-       config_map.insert (pair);
+       config_map.insert (make_pair (timespan, spec));
 
        return true;
 }
 
 void
-ExportHandler::do_export (bool rt)
+ExportHandler::do_export ()
 {
        /* Count timespans */
 
        export_status->init();
        std::set<ExportTimespanPtr> timespan_set;
        for (ConfigMap::iterator it = config_map.begin(); it != config_map.end(); ++it) {
-               timespan_set.insert (it->first);
-               export_status->total_frames += it->first->get_length();
+               bool new_timespan = timespan_set.insert (it->first).second;
+               if (new_timespan) {
+                       export_status->total_frames += it->first->get_length();
+               }
        }
        export_status->total_timespans = timespan_set.size();
 
        /* Start export */
 
-       realtime = rt;
        start_timespan ();
 }
 
@@ -160,13 +157,22 @@ ExportHandler::start_timespan ()
                return;
        }
 
+       /* finish_timespan pops the config_map entry that has been done, so
+          this is the timespan to do this time
+       */
        current_timespan = config_map.begin()->first;
+       
+       export_status->total_frames_current_timespan = current_timespan->get_length();
+       export_status->timespan_name = current_timespan->name();
+       export_status->processed_frames_current_timespan = 0;
 
        /* Register file configurations to graph builder */
 
+       /* Here's the config_map entries that use this timespan */
        timespan_bounds = config_map.equal_range (current_timespan);
        graph_builder->reset ();
        graph_builder->set_current_timespan (current_timespan);
+       handle_duplicate_format_extensions();
        for (ConfigMap::iterator it = timespan_bounds.first; it != timespan_bounds.second; ++it) {
                // Filenames can be shared across timespans
                FileSpec & spec = it->second;
@@ -179,7 +185,28 @@ ExportHandler::start_timespan ()
        normalizing = false;
        session.ProcessExport.connect_same_thread (process_connection, boost::bind (&ExportHandler::process, this, _1));
        process_position = current_timespan->get_start();
-       session.start_audio_export (process_position, realtime);
+       session.start_audio_export (process_position);
+}
+
+void
+ExportHandler::handle_duplicate_format_extensions()
+{
+       typedef std::map<std::string, int> ExtCountMap;
+
+       ExtCountMap counts;
+       for (ConfigMap::iterator it = timespan_bounds.first; it != timespan_bounds.second; ++it) {
+               counts[it->second.format->extension()]++;
+       }
+
+       bool duplicates_found = false;
+       for (ExtCountMap::iterator it = counts.begin(); it != counts.end(); ++it) {
+               if (it->second > 1) { duplicates_found = true; }
+       }
+
+       // Set this always, as the filenames are shared...
+       for (ConfigMap::iterator it = timespan_bounds.first; it != timespan_bounds.second; ++it) {
+               it->second.filename->include_format_name = duplicates_found;
+       }
 }
 
 int
@@ -207,18 +234,30 @@ ExportHandler::process_timespan (framecnt_t frames)
        if (last_cycle) {
                frames_to_read = end - process_position;
                export_status->stop = true;
-               normalizing = true;
        } else {
                frames_to_read = frames;
        }
 
        process_position += frames_to_read;
        export_status->processed_frames += frames_to_read;
-       export_status->progress = (float) export_status->processed_frames / export_status->total_frames;
+       export_status->processed_frames_current_timespan += frames_to_read;
 
        /* Do actual processing */
+       int ret = graph_builder->process (frames_to_read, last_cycle);
 
-       return graph_builder->process (frames_to_read, last_cycle);
+       /* Start normalizing if necessary */
+       if (last_cycle) {
+               normalizing = graph_builder->will_normalize();
+               if (normalizing) {
+                       export_status->total_normalize_cycles = graph_builder->get_normalize_cycle_count();
+                       export_status->current_normalize_cycle = 0;
+               } else {
+                       finish_timespan ();
+                       return 0;
+               }
+       }
+
+       return ret;
 }
 
 int
@@ -231,6 +270,8 @@ ExportHandler::process_normalize ()
                export_status->normalizing = true;
        }
 
+       export_status->current_normalize_cycle++;
+
        return 0;
 }
 
@@ -375,10 +416,10 @@ ExportHandler::export_cd_marker_file (ExportTimespanPtr timespan, ExportFormatSp
 
        } catch (std::exception& e) {
                error << string_compose (_("an error occured while writing a TOC/CUE file: %1"), e.what()) << endmsg;
-               ::unlink (filepath.c_str());
+               ::g_unlink (filepath.c_str());
        } catch (Glib::Exception& e) {
                error << string_compose (_("an error occured while writing a TOC/CUE file: %1"), e.what()) << endmsg;
-               ::unlink (filepath.c_str());
+               ::g_unlink (filepath.c_str());
        }
 }
 
@@ -405,27 +446,20 @@ ExportHandler::write_cue_header (CDMarkerStatus & status)
 {
        string title = status.timespan->name().compare ("Session") ? status.timespan->name() : (string) session.name();
 
-       status.out << "REM Cue file generated by Ardour" << endl;
-       status.out << "TITLE \"" << title << "\"" << endl;
-
-       /*  The cue sheet syntax has originally five file types:
-               WAVE     : 44.1 kHz, 16 Bit (little endian)
-               AIFF     : 44.1 kHz, 16 Bit (big endian)
-               BINARY   : 44.1 kHz, 16 Bit (little endian)
-               MOTOROLA : 44.1 kHz, 16 Bit (big endian)
-               MP3
-
-               We want to use cue sheets not only as CD images but also as general playlyist
-               format, thus for WAVE and AIFF we don't care if it's really 44.1 kHz/16 Bit, the
-               soundfile's header shows it anyway.  But for the raw formats, i.e. BINARY
-               and MOTOROLA we do care, because no header would tell us about a different format.
-
-               For all other formats we just make up our own file type.  MP3 is not supported
-               at the moment.
+       status.out << "REM Cue file generated by " << PROGRAM_NAME << endl;
+       status.out << "TITLE " << cue_escape_cdtext (title) << endl;
+
+       /*  The original cue sheet sepc metions five file types
+               WAVE, AIFF,
+               BINARY   = "header-less" audio (44.1 kHz, 16 Bit, little endian),
+               MOTOROLA = "header-less" audio (44.1 kHz, 16 Bit, big endian),
+               and MP3
+               
+               We try to use these file types whenever appropriate and 
+               default to our own names otherwise.
        */
-
        status.out << "FILE \"" << Glib::path_get_basename(status.filename) << "\" ";
-       if (!status.format->format_name().compare ("WAV")) {
+       if (!status.format->format_name().compare ("WAV")  || !status.format->format_name().compare ("BWF")) {
                status.out  << "WAVE";
        } else if (status.format->format_id() == ExportFormatBase::F_RAW &&
                   status.format->sample_format() == ExportFormatBase::SF_16 &&
@@ -437,7 +471,7 @@ ExportHandler::write_cue_header (CDMarkerStatus & status)
                        status.out << "MOTOROLA";
                }
        } else {
-               // AIFF should return "AIFF"
+               // no special case for AIFF format it's name is already "AIFF"
                status.out << status.format->format_name();
        }
        status.out << endl;
@@ -450,7 +484,7 @@ ExportHandler::write_toc_header (CDMarkerStatus & status)
 
        status.out << "CD_DA" << endl;
        status.out << "CD_TEXT {" << endl << "  LANGUAGE_MAP {" << endl << "    0 : EN" << endl << "  }" << endl;
-       status.out << "  LANGUAGE 0 {" << endl << "    TITLE " << cd_marker_file_escape_string (title) << endl ;
+       status.out << "  LANGUAGE 0 {" << endl << "    TITLE " << toc_escape_cdtext (title) << endl ;
        status.out << "    PERFORMER \"\"" << endl << "  }" << endl << "}" << endl;
 }
 
@@ -476,18 +510,18 @@ ExportHandler::write_track_info_cue (CDMarkerStatus & status)
 
        if (status.marker->cd_info.find("isrc") != status.marker->cd_info.end())  {
                status.out << "    ISRC " << status.marker->cd_info["isrc"] << endl;
-
        }
+
        if (status.marker->name() != "") {
-               status.out << "    TITLE " << cd_marker_file_escape_string (status.marker->name()) << endl;
+               status.out << "    TITLE " << cue_escape_cdtext (status.marker->name()) << endl;
        }
 
        if (status.marker->cd_info.find("performer") != status.marker->cd_info.end()) {
-               status.out << "    PERFORMER " <<  cd_marker_file_escape_string (status.marker->cd_info["performer"]) << endl;
+               status.out <<  "    PERFORMER " << cue_escape_cdtext (status.marker->cd_info["performer"]) << endl;
        }
 
        if (status.marker->cd_info.find("composer") != status.marker->cd_info.end()) {
-               status.out << "    SONGWRITER " << cd_marker_file_escape_string (status.marker->cd_info["composer"])  << endl;
+               status.out << "    SONGWRITER " << cue_escape_cdtext (status.marker->cd_info["composer"]) << endl;
        }
 
        if (status.track_position != status.track_start_frame) {
@@ -524,17 +558,18 @@ ExportHandler::write_track_info_toc (CDMarkerStatus & status)
                status.out << "ISRC \"" << status.marker->cd_info["isrc"] << "\"" << endl;
        }
 
-       status.out << "CD_TEXT {" << endl << "  LANGUAGE 0 {" << endl << "     TITLE "
-                  << cd_marker_file_escape_string (status.marker->name()) << endl;
+       status.out << "CD_TEXT {" << endl << "  LANGUAGE 0 {" << endl;
+       status.out << "     TITLE " << toc_escape_cdtext (status.marker->name()) << endl;
        
+       status.out << "     PERFORMER ";
        if (status.marker->cd_info.find("performer") != status.marker->cd_info.end()) {
-               status.out << "     PERFORMER " << cd_marker_file_escape_string (status.marker->cd_info["performer"]);
+               status.out << toc_escape_cdtext (status.marker->cd_info["performer"]) << endl;
        } else {
-               status.out << "     PERFORMER \"\"";
+               status.out << "\"\"" << endl;
        }
        
        if (status.marker->cd_info.find("composer") != status.marker->cd_info.end()) {
-               status.out  << "     COMPOSER " << cd_marker_file_escape_string (status.marker->cd_info["composer"]) << endl;
+               status.out  << "     SONGWRITER " << toc_escape_cdtext (status.marker->cd_info["composer"]) << endl;
        }
 
        if (status.marker->cd_info.find("isrc") != status.marker->cd_info.end()) {
@@ -548,7 +583,7 @@ ExportHandler::write_track_info_toc (CDMarkerStatus & status)
        status.out << "  }" << endl << "}" << endl;
 
        frames_to_cd_frames_string (buf, status.track_position);
-       status.out << "FILE " << cd_marker_file_escape_string (status.filename) << ' ' << buf;
+       status.out << "FILE " << toc_escape_filename (status.filename) << ' ' << buf;
 
        frames_to_cd_frames_string (buf, status.track_duration);
        status.out << buf << endl;
@@ -595,19 +630,22 @@ ExportHandler::frames_to_cd_frames_string (char* buf, framepos_t when)
 }
 
 std::string
-ExportHandler::cd_marker_file_escape_string (const std::string& txt)
+ExportHandler::toc_escape_cdtext (const std::string& txt)
 {
        Glib::ustring check (txt);
        std::string out;
+       std::string latin1_txt;
        char buf[5];
 
-       if (!check.is_ascii()) {
-               throw Glib::ConvertError (Glib::ConvertError::NO_CONVERSION, string_compose (_("Cannot convert %1 to Latin-1 text"), txt));
+       try {
+               latin1_txt = Glib::convert (txt, "ISO-8859-1", "UTF-8");
+       } catch (Glib::ConvertError& err) {
+               throw Glib::ConvertError (err.code(), string_compose (_("Cannot convert %1 to Latin-1 text"), txt));
        }
 
        out = '"';
 
-       for (std::string::const_iterator c = txt.begin(); c != txt.end(); ++c) {
+       for (std::string::const_iterator c = latin1_txt.begin(); c != latin1_txt.end(); ++c) {
 
                if ((*c) == '"') {
                        out += "\\\"";
@@ -616,7 +654,7 @@ ExportHandler::cd_marker_file_escape_string (const std::string& txt)
                } else if (isprint (*c)) {
                        out += *c;
                } else {
-                       snprintf (buf, sizeof (buf), "\\%03o", *c);
+                       snprintf (buf, sizeof (buf), "\\%03o", (int) (unsigned char) *c);
                        out += buf;
                }
        }
@@ -626,4 +664,48 @@ ExportHandler::cd_marker_file_escape_string (const std::string& txt)
        return out;
 }
 
+std::string
+ExportHandler::toc_escape_filename (const std::string& txt)
+{
+       std::string out;
+
+       out = '"';
+
+       // We iterate byte-wise not character-wise over a UTF-8 string here,
+       // because we only want to translate backslashes and double quotes
+       for (std::string::const_iterator c = txt.begin(); c != txt.end(); ++c) {
+
+               if (*c == '"') {
+                       out += "\\\"";
+               } else if (*c == '\\') {
+                       out += "\\134";
+               } else {
+                       out += *c;
+               }
+       }
+       
+       out += '"';
+
+       return out;
+}
+
+std::string
+ExportHandler::cue_escape_cdtext (const std::string& txt)
+{
+       std::string latin1_txt;
+       std::string out;
+       
+       try {
+               latin1_txt = Glib::convert (txt, "ISO-8859-1", "UTF-8");
+       } catch (Glib::ConvertError& err) {
+               throw Glib::ConvertError (err.code(), string_compose (_("Cannot convert %1 to Latin-1 text"), txt));
+       }
+       
+       // does not do much mor than UTF-8 to Latin1 translation yet, but
+       // that may have to change if cue parsers in burning programs change 
+       out = '"' + latin1_txt + '"';
+
+       return out;
+}
+
 } // namespace ARDOUR