remove incorrect/out of date comment
[ardour.git] / libs / ardour / export_handler.cc
index ec89f270ca832534d212b04ab0f01c9fa872e100..f53f270918fba0c572b912331f73d6ecf25f1dc2 100644 (file)
@@ -20,7 +20,7 @@
 
 #include "ardour/export_handler.h"
 
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 #include <glibmm.h>
 #include <glibmm/convert.h>
 
@@ -118,7 +118,7 @@ ExportHandler::ExportHandler (Session & session)
 
 ExportHandler::~ExportHandler ()
 {
-       // TODO remove files that were written but not finished
+       graph_builder->cleanup (export_status->aborted () );
 }
 
 /** Add an export to the `to-do' list */
@@ -168,7 +168,7 @@ ExportHandler::start_timespan ()
           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;
@@ -305,7 +305,18 @@ ExportHandler::finish_timespan ()
                        export_cd_marker_file (current_timespan, fmt, filename, CDMarkerTOC);
                }
 
+               if (fmt->with_mp4chaps()) {
+                       export_cd_marker_file (current_timespan, fmt, filename, MP4Chaps);
+               }
+
                if (fmt->tag()) {
+                       /* close file first, otherwise TagLib enounters an ERROR_SHARING_VIOLATION
+                        * The process cannot access the file because it is being used.
+                        *
+                        * TODO: check Umlauts and encoding in filename.
+                        * TagLib eventually calls CreateFileA(),
+                        */
+                       graph_builder->reset ();
                        AudiofileTagger::tag_file(filename, *SessionMetadata::Metadata());
                }
 
@@ -363,7 +374,7 @@ ExportHandler::finish_timespan ()
                                        open_uri(path.c_str());  // open the soundcloud website to the new file
                                }
                        } else {
-                               error << _("upload to Soundcloud failed.  Perhaps your email or password are incorrect?\n") << endmsg;
+                               error << _("upload to Soundcloud failed. Perhaps your email or password are incorrect?\n") << endmsg;
                        }
                        delete soundcloud_uploader;
                }
@@ -403,17 +414,17 @@ ExportHandler::export_cd_marker_file (ExportTimespanPtr timespan, ExportFormatSp
                        track_func = &ExportHandler::write_track_info_cue;
                        index_func = &ExportHandler::write_index_info_cue;
                        break;
+               case MP4Chaps:
+                       header_func = &ExportHandler::write_mp4ch_header;
+                       track_func = &ExportHandler::write_track_info_mp4ch;
+                       index_func = &ExportHandler::write_index_info_mp4ch;
+                       break;
                default:
                        return;
                }
 
                CDMarkerStatus status (filepath, timespan, file_format, filename);
 
-               if (!status.out) {
-                       error << string_compose(_("Editor: cannot open \"%1\" as export file for CD marker file"), filepath) << endmsg;
-                       return;
-               }
-
                (this->*header_func) (status);
 
                /* Get locations and sort */
@@ -439,8 +450,8 @@ ExportHandler::export_cd_marker_file (ExportTimespanPtr timespan, ExportFormatSp
 
                /* Start actual marker stuff */
 
-               framepos_t last_end_time = timespan->get_start(), last_start_time = timespan->get_start();
-               status.track_position = last_start_time - timespan->get_start();
+               framepos_t last_end_time = timespan->get_start();
+               status.track_position = 0;
 
                for (i = temp.begin(); i != temp.end(); ++i) {
 
@@ -471,20 +482,17 @@ ExportHandler::export_cd_marker_file (ExportTimespanPtr timespan, ExportFormatSp
                                if (nexti != temp.end()) {
                                        status.track_duration = (*nexti)->start() - last_end_time;
 
-                                       last_start_time = (*i)->start();
                                        last_end_time = (*nexti)->start();
                                } else {
                                        // this was the last marker, use timespan end
                                        status.track_duration = timespan->get_end() - last_end_time;
 
-                                       last_start_time = (*i)->start();
                                        last_end_time = timespan->get_end();
                                }
                        } else {
                                // range
                                status.track_duration = (*i)->end() - last_end_time;
 
-                               last_start_time = (*i)->start();
                                last_end_time = (*i)->end();
                        }
 
@@ -503,17 +511,22 @@ ExportHandler::export_cd_marker_file (ExportTimespanPtr timespan, ExportFormatSp
 string
 ExportHandler::get_cd_marker_filename(std::string filename, CDMarkerFormat format)
 {
-       /* do not strip file suffix because there may be more than one format, 
+       /* do not strip file suffix because there may be more than one format,
           and we do not want the CD marker file from one format to overwrite
           another (e.g. foo.wav.cue > foo.aiff.cue)
        */
 
        switch (format) {
-         case CDMarkerTOC:
+       case CDMarkerTOC:
                return filename + ".toc";
-         case CDMarkerCUE:
+       case CDMarkerCUE:
                return filename + ".cue";
-         default:
+       case MP4Chaps:
+       {
+               unsigned lastdot = filename.find_last_of('.');
+               return filename.substr(0,lastdot) + ".chapters.txt";
+       }
+       default:
                return filename + ".marker"; // Should not be reached when actually creating a file
        }
 }
@@ -523,16 +536,31 @@ ExportHandler::write_cue_header (CDMarkerStatus & status)
 {
        string title = status.timespan->name().compare ("Session") ? status.timespan->name() : (string) session.name();
 
+       // Album metadata
+       string barcode      = SessionMetadata::Metadata()->barcode();
+       string album_artist = SessionMetadata::Metadata()->album_artist();
+       string album_title  = SessionMetadata::Metadata()->album();
+
        status.out << "REM Cue file generated by " << PROGRAM_NAME << endl;
+
+       if (barcode != "")
+               status.out << "CATALOG " << barcode << endl;
+
+       if (album_artist != "")
+               status.out << "PERFORMER " << cue_escape_cdtext (album_artist) << endl;
+
+       if (album_title != "")
+               title = album_title;
+
        status.out << "TITLE " << cue_escape_cdtext (title) << endl;
 
-       /*  The original cue sheet sepc metions five file types
+       /*  The original cue sheet spec mentions 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 
+
+               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) << "\" ";
@@ -559,10 +587,28 @@ ExportHandler::write_toc_header (CDMarkerStatus & status)
 {
        string title = status.timespan->name().compare ("Session") ? status.timespan->name() : (string) session.name();
 
+       // Album metadata
+       string barcode      = SessionMetadata::Metadata()->barcode();
+       string album_artist = SessionMetadata::Metadata()->album_artist();
+       string album_title  = SessionMetadata::Metadata()->album();
+
+       if (barcode != "")
+               status.out << "CATALOG \"" << barcode << "\"" << endl;
+
+       if (album_title != "")
+               title = album_title;
+
        status.out << "CD_DA" << endl;
        status.out << "CD_TEXT {" << endl << "  LANGUAGE_MAP {" << endl << "    0 : EN" << endl << "  }" << endl;
        status.out << "  LANGUAGE 0 {" << endl << "    TITLE " << toc_escape_cdtext (title) << endl ;
-       status.out << "    PERFORMER \"\"" << endl << "  }" << endl << "}" << endl;
+       status.out << "    PERFORMER " << toc_escape_cdtext (album_artist) << endl;
+       status.out << "  }" << endl << "}" << endl;
+}
+
+void
+ExportHandler::write_mp4ch_header (CDMarkerStatus & status)
+{
+       status.out << "00:00:00.000 Intro" << endl;
 }
 
 void
@@ -637,14 +683,14 @@ ExportHandler::write_track_info_toc (CDMarkerStatus & status)
 
        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 << toc_escape_cdtext (status.marker->cd_info["performer"]) << endl;
        } else {
                status.out << "\"\"" << endl;
        }
-       
+
        if (status.marker->cd_info.find("composer") != status.marker->cd_info.end()) {
                status.out  << "     SONGWRITER " << toc_escape_cdtext (status.marker->cd_info["composer"]) << endl;
        }
@@ -669,6 +715,14 @@ ExportHandler::write_track_info_toc (CDMarkerStatus & status)
        status.out << "START" << buf << endl;
 }
 
+void ExportHandler::write_track_info_mp4ch (CDMarkerStatus & status)
+{
+       gchar buf[18];
+
+       frames_to_chapter_marks_string(buf, status.track_start_frame);
+       status.out << buf << " " << status.marker->name() << endl;
+}
+
 void
 ExportHandler::write_index_info_cue (CDMarkerStatus & status)
 {
@@ -691,6 +745,11 @@ ExportHandler::write_index_info_toc (CDMarkerStatus & status)
        status.out << "INDEX" << buf << endl;
 }
 
+void
+ExportHandler::write_index_info_mp4ch (CDMarkerStatus & status)
+{
+}
+
 void
 ExportHandler::frames_to_cd_frames_string (char* buf, framepos_t when)
 {
@@ -706,6 +765,23 @@ ExportHandler::frames_to_cd_frames_string (char* buf, framepos_t when)
        sprintf (buf, " %02d:%02d:%02d", mins, secs, frames);
 }
 
+void
+ExportHandler::frames_to_chapter_marks_string (char* buf, framepos_t when)
+{
+       framecnt_t remainder;
+       framecnt_t fr = session.nominal_frame_rate();
+       int hours, mins, secs, msecs;
+
+       hours = when / (3600 * fr);
+       remainder = when - (hours * 3600 * fr);
+       mins = remainder / (60 * fr);
+       remainder -= mins * 60 * fr;
+       secs = remainder / fr;
+       remainder -= secs * fr;
+       msecs = (remainder * 1000) / fr;
+       sprintf (buf, "%02d:%02d:%02d.%03d", hours, mins, secs, msecs);
+}
+
 std::string
 ExportHandler::toc_escape_cdtext (const std::string& txt)
 {
@@ -735,7 +811,7 @@ ExportHandler::toc_escape_cdtext (const std::string& txt)
                        out += buf;
                }
        }
-       
+
        out += '"';
 
        return out;
@@ -760,7 +836,7 @@ ExportHandler::toc_escape_filename (const std::string& txt)
                        out += *c;
                }
        }
-       
+
        out += '"';
 
        return out;
@@ -771,15 +847,15 @@ 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 
+       // that may have to change if cue parsers in burning programs change
        out = '"' + latin1_txt + '"';
 
        return out;